TranslateReader

net.i2p.util.TranslateReader

All Implemented Interfaces:: Closeable, AutoCloseable, Readable

public class TranslateReaderextends FilterReader

Filters a reader, replacing the gettext-style tags described below as they are read.

Strings are tagged with _("translateme") or _("translate {0} me", "foo")

Max two parameters. String and parameters must be double-quoted (no ngettext, no tagged parameters). Escape quotes inside quote with \". Commas and spaces between args are optional. Entire tag (from '_' to ')') must be on one line. Multiple tags allowed on one line.

Also will extract strings to a dummy java file for postprocessing by xgettext - see main(String[]).

Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
private static enum
TranslateReader.S
The states of the parser, all of which may transition to START.
private static class
TranslateReader.Tagger
Hook writing the tags out as a properties file.
private static interface
TranslateReader.TagHook
Callback handling each translated string.
Field Summary
Fields
Modifier and Type
Field
Description
private final StringBuilder
_argBuf
Pending string or parameter for translation.
private final List<String>
_args
Parsed string and parameters.
private final String
_bundle
The bundle being read.
private final I2PAppContext
_ctx
The app context.
private TranslateReader.TagHook
_hook
The hook handling the tags found.
private final StringBuilder
_inBuf
Parse in progress.
private final StringBuilder
_outBuf
Parsed and translated.
private TranslateReader.S
_state
Current state of the parser.
private static final int
MAX_ARGS
Most arguments a tag may take.
Fields inherited from class FilterReader
in
Fields inherited from class Reader
lock
Constructor Summary
Constructors
Constructor
Description
TranslateReader(I2PAppContext ctx, String bundle, InputStream in)
May be null for tagging only.
TranslateReader(I2PAppContext ctx, String bundle, Reader in)
May be null for tagging only.
Method Summary
Modifier and Type
Method
Description
void
close()

private int
flushit()
Flush _inBuf to _outBuf, reset state, and return next char or -1.
static void
main(String[] args)
Do not comment out, used to extract tags as a part of the build process.
void
mark(int readLimit)

boolean
markSupported()

private int
parse()
Reads the file and passes the strings to the hook.
private int
popit()
Return next char from _outBuf or -1.
private void
pushit(char c)
Put in the pending parse buf.
int
read()

int
read(char[] cbuf, int off, int len)

boolean
ready()

void
reset()

long
skip(long n)

private static void
tag(String[] files)
Tag PO files with translation metadata.
private static void
test(String file)
Runs the reader over one file from the command line.
private void
translate()
Clear _inBuf, translate _args to _outBuf, reset state.
Methods inherited from class Reader
nullReader, of, read, read, readAllAsString, readAllLines, transferTo
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _bundle
  private final String _bundle
  The bundle being read.
- _ctx
  private final I2PAppContext _ctx
  The app context.
- _inBuf
  private final StringBuilder _inBuf
  Parse in progress.
- _outBuf
  private final StringBuilder _outBuf
  Parsed and translated.
- _argBuf
  private final StringBuilder _argBuf
  Pending string or parameter for translation.
- _args
  private final List<String> _args
  Parsed string and parameters.
- _state
  private TranslateReader.S _state
  Current state of the parser.
- _hook
  private TranslateReader.TagHook _hook
  The hook handling the tags found.
- MAX_ARGS
  private static final int MAX_ARGS
  Most arguments a tag may take.
  See Also:
  Constant Field Values
Constructor Details
- TranslateReader
  public TranslateReader(I2PAppContext ctx, String bundle, InputStream in) throws IOException
  May be null for tagging only.
  Parameters:
  ctx - the context the bundle is looked up through
  bundle - may be null for tagging only
  in - UTF-8
  Throws:
  IOException - declared but never thrown; the stream is only wrapped here
- TranslateReader
  public TranslateReader(I2PAppContext ctx, String bundle, Reader in)
  May be null for tagging only.
  Parameters:
  ctx - the context the bundle is looked up through
  bundle - may be null for tagging only
  in - the reader the tag text is pulled from
Method Details
- read
  public int read() throws IOException
  Overrides:
  read in class FilterReader
  Throws:
  IOException
- parse
  private int parse() throws IOException
  Reads the file and passes the strings to the hook.
  Returns:
  the number of tags processed
  Throws:
  IOException - if the file cannot be read
- read
  public int read(char[] cbuf, int off, int len) throws IOException
  Overrides:
  read in class FilterReader
  Throws:
  IOException
- skip
  public long skip(long n) throws IOException
  Overrides:
  skip in class FilterReader
  Throws:
  IOException
- ready
  public boolean ready() throws IOException
  Overrides:
  ready in class FilterReader
  Throws:
  IOException
- close
  public void close() throws IOException
  Specified by:
  close in interface AutoCloseable
  Specified by:
  close in interface Closeable
  Overrides:
  close in class FilterReader
  Throws:
  IOException
- mark
  public void mark(int readLimit)
  Overrides:
  mark in class FilterReader
- reset
  public void reset() throws IOException
  Overrides:
  reset in class FilterReader
  Throws:
  IOException
- markSupported
  public boolean markSupported()
  Overrides:
  markSupported in class FilterReader
- pushit
  private void pushit(char c)
  Put in the pending parse buf.
  Parameters:
  c - the character to append to the pending input buffer
- flushit
  private int flushit()
  Flush _inBuf to _outBuf, reset state, and return next char or -1.
  Returns:
  the next character from the output buffer, or -1 when it is empty
- popit
  private int popit()
  Return next char from _outBuf or -1.
  Returns:
  the next character from the output buffer, or -1 when it is empty
- translate
  private void translate()
  Clear _inBuf, translate _args to _outBuf, reset state.
- main
  public static void main(String[] args)
  Do not comment out, used to extract tags as a part of the build process.
  Parameters:
  args - the subcommand (test or tag) followed by its file arguments
- test
  private static void test(String file) throws IOException
  Runs the reader over one file from the command line.
  Parameters:
  file - the file to read
  Throws:
  IOException - if the file cannot be read
- tag
  private static void tag(String[] files) throws IOException
  Tag PO files with translation metadata.
  Parameters:
  files - command line arguments; files[0] is ignored, the rest name the input files and the output file
  Throws:
  IOException - if a directory listing fails or a file cannot be read or written

Nested Class Summary

Field Summary

Fields inherited from class FilterReader

Fields inherited from class Reader

Constructor Summary

Method Summary

Methods inherited from class Reader

Methods inherited from class Object

Field Details

_bundle

_ctx

_inBuf

_outBuf

_argBuf

_args

_state

_hook

MAX_ARGS

Constructor Details

TranslateReader

Method Details

read

parse

read

skip

ready

close

mark

reset

markSupported

pushit

flushit

popit

translate

main

test

tag