org.omegat.filters2.mozlang

Class MozillaLangFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters2.mozlang.MozillaLangFilter

All Implemented Interfaces:

IFilter

public class MozillaLangFilter
extends AbstractFilter

Filter for support Mozilla lang files. Filter for lang files. Something about the format described on https://sourceforge.net/p/omegat/feature-requests/962/ https://developer.mozilla.org/en-US/docs/Web_Localizability/Localization_formats http://bedrock.readthedocs.org/en/latest/l10n.html Code adapted from the files: PoFilter.java and SrtFilter.java

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.regex.Pattern	LOCALIZATION_NOTE
protected static java.util.regex.Pattern	PATTERN_SOURCE

Fields inherited from class org.omegat.filters2.AbstractFilter

ENCODING_AUTO_HUMAN, entryAlignCallback, entryParseCallback, entryTranslateCallback, inEncodingLastParsedFile, processOptions, TARGET_DEFAULT, TFP_EXTENSION, TFP_FILE_FILTER_NAME, TFP_FILE_SOURCE_ENCODING, TFP_FILE_TARGET_ENCODING, TFP_FILENAME, TFP_NAMEONLY, TFP_SYSTEM_HOST_NAME, TFP_SYSTEM_OS_ARCH, TFP_SYSTEM_OS_NAME, TFP_SYSTEM_OS_VERSION, TFP_SYSTEM_USER_NAME, TFP_TARGET_COUNTRY_CODE, TFP_TARGET_COUTRY_CODE, TFP_TARGET_LANG_CODE, TFP_TARGET_LANGUAGE, TFP_TARGET_LOCALE, TFP_TARGET_LOCALE_LCID, TFP_TIMESTAMP_LA, TFP_TIMESTAMP_LD, TFP_TIMESTAMP_LDD, TFP_TIMESTAMP_LH, TFP_TIMESTAMP_LHH, TFP_TIMESTAMP_LM, TFP_TIMESTAMP_LMM, TFP_TIMESTAMP_LS, TFP_TIMESTAMP_LSS, TFP_TIMESTAMP_LYYYY, TFP_TIMESTAMP_UD, TFP_TIMESTAMP_UEEE, TFP_TIMESTAMP_UEEEE, TFP_TIMESTAMP_UH, TFP_TIMESTAMP_UHH, TFP_TIMESTAMP_UM, TFP_TIMESTAMP_UMM, TFP_TIMESTAMP_UMMM

Constructor Summary

Constructors

Constructor and Description
MozillaLangFilter()

Method Summary

Modifier and Type	Method and Description
protected void	align(int pair)
protected void	align(java.lang.String source, java.lang.String translation, java.lang.String comments)
java.io.BufferedReader	createReader(java.io.File infile, java.lang.String encoding) Creating an input stream to read the source .lang file.
java.io.BufferedWriter	createWriter(java.io.File outfile, java.lang.String encoding) Creating an output stream to save a localized .lang file.
protected void	eol(java.lang.String s)
protected void	flushTranslation(FilterContext fc)
Instance[]	getDefaultInstances() The default list of filter instances that this filter class has.
java.lang.String	getFileFormatName() Human-readable name of the File Format this filter supports.
java.lang.String	getInEncodingLastParsedFile() Returns the encoding of the last parsed source file.
boolean	hasOptions() Returns true to indicate that Text filter has options.
boolean	isBilingual() Indicates whether the filter is bilingual, and thus can be used as external TM (i.e.
boolean	isSourceEncodingVariable() Whether source encoding can be varied by the user.
boolean	isTargetEncodingVariable() Whether target encoding can be varied by the user.
protected void	processFile(java.io.BufferedReader inFile, java.io.BufferedWriter outFile, FilterContext fc) Processes a single file given a reader and a writer.
void	processFile(java.io.File inFile, java.io.File outFile, FilterContext fc) Processes a single file given an input and output files (output file may be null while loading files).

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, alignFile, changeOptions, getFuzzyMark, getHint, getInputEncoding, getOutputEncoding, getTargetFilenamePatterns, isFileSupported, isFileSupported, parseFile, processEntry, processEntry, requirePrevNextFields, setCallbacks, translateFile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.omegat.filters2.IFilter

changeOptions

Field Detail

LOCALIZATION_NOTE

protected static final java.util.regex.Pattern LOCALIZATION_NOTE

PATTERN_SOURCE

protected static final java.util.regex.Pattern PATTERN_SOURCE

Constructor Detail

MozillaLangFilter

public MozillaLangFilter()

Method Detail

getFileFormatName

public java.lang.String getFileFormatName()

Description copied from class: AbstractFilter

Human-readable name of the File Format this filter supports.

Specified by:

getFileFormatName in interface IFilter

Specified by:

getFileFormatName in class AbstractFilter

Returns:

File format name

getDefaultInstances

public Instance[] getDefaultInstances()

Description copied from class: AbstractFilter

The default list of filter instances that this filter class has. One filter class may have different filter instances, different by source file mask, encoding of the source file etc.

Note that the user may change the instances freely.

Specified by:

getDefaultInstances in interface IFilter

Specified by:

getDefaultInstances in class AbstractFilter

Returns:

Default filter instances

createReader

public java.io.BufferedReader createReader(java.io.File infile,
                                           java.lang.String encoding)
                                    throws java.io.UnsupportedEncodingException,
                                           java.io.IOException

Creating an input stream to read the source .lang file.

NOTE: Mozilla lang files use always UTF-8 encoding without BOM.

Overrides:

createReader in class AbstractFilter

Parameters:

infile - The source file.

encoding - Encoding of the input file, if the filter supports it. Otherwise null.

Returns:

The reader for the source file

Throws:

java.io.UnsupportedEncodingException - Thrown if JVM doesn't support the specified inEncoding

java.io.IOException - If any I/O Error occurs upon reader creation

createWriter

public java.io.BufferedWriter createWriter(java.io.File outfile,
                                           java.lang.String encoding)
                                    throws java.io.UnsupportedEncodingException,
                                           java.io.IOException

Creating an output stream to save a localized .lang file.

NOTE: Mozilla lang files use always UTF-8 encoding without BOM.

Overrides:

createWriter in class AbstractFilter

Parameters:

outfile - The target file

encoding - Encoding of the target file, if the filter supports it. Otherwise null.

Returns:

The writer for the target file

Throws:

java.io.UnsupportedEncodingException - Thrown if JVM doesn't support the specified outEncoding

java.io.IOException - If any I/O Error occurs upon writer creation

isSourceEncodingVariable

public boolean isSourceEncodingVariable()

Description copied from class: AbstractFilter

Whether source encoding can be varied by the user.

True means that OmegaT should handle all the encoding mess.

Return false to state that your filter doesn't need encoding management provided by OmegaT, because it either autodetects the encoding based on file contents (like HTML filter does) or the encoding is fixed (like in OpenOffice files).

Specified by:

isSourceEncodingVariable in interface IFilter

Specified by:

isSourceEncodingVariable in class AbstractFilter

Returns:

whether source encoding can be changed by the user

isTargetEncodingVariable

public boolean isTargetEncodingVariable()

Description copied from class: AbstractFilter

Whether target encoding can be varied by the user.

True means that OmegaT should handle all the encoding mess.

Return false to state that your filter doesn't need encoding management provided by OmegaT, because the encoding is fixed (like in OpenOffice files), or for some other reason.

Specified by:

isTargetEncodingVariable in interface IFilter

Specified by:

isTargetEncodingVariable in class AbstractFilter

Returns:

whether target encoding can be changed by the user

getInEncodingLastParsedFile

public java.lang.String getInEncodingLastParsedFile()

Description copied from interface: IFilter

Returns the encoding of the last parsed source file.

Specified by:

getInEncodingLastParsedFile in interface IFilter

Overrides:

getInEncodingLastParsedFile in class AbstractFilter

Returns:

the encoding of the last parsed source file, or null when no file has been parsed yet.

processFile

public void processFile(java.io.File inFile,
                        java.io.File outFile,
                        FilterContext fc)
                 throws java.io.IOException,
                        TranslationException

Description copied from class: AbstractFilter

Processes a single file given an input and output files (output file may be null while loading files). This method can be used to create a filter that works with the source/target files directly, rather than using BufferedReader/BufferedWriter.

Generally this method should read strings from the input reader and write them to the output reader. In order to let OmegaT know what strings are translatable and to get their translation, filter should call AbstractFilter.processEntry(String) method.

If you override this method and do all the processing here, you should simply implement #processFile(BufferedReader,BufferedWriter) with a stub.

Default implementation calls AbstractFilter.createReader(File,String) to create a reader, new BufferedWriter(new StringWriter()) to create a writer for null output file, or AbstractFilter.createWriter(File,String) to create a writer if output file is not null; then calls #processFile(BufferedReader,BufferedWriter) to process source file, and then closes reader and writer.

Overrides:

processFile in class AbstractFilter

Parameters:

inFile - The source file.

outFile - The target file.

fc - Filter context.

Throws:

java.io.IOException - In case of any I/O error.

TranslationException - Should be thrown when processed file has any format defects.

processFile

protected void processFile(java.io.BufferedReader inFile,
                           java.io.BufferedWriter outFile,
                           FilterContext fc)
                    throws java.io.IOException,
                           TranslationException

Description copied from class: AbstractFilter

Processes a single file given a reader and a writer. Generally this method should read strings from the input reader and write them to the output reader. In order to let OmegaT know what strings are translatable and to get their translation, filter should call AbstractFilter.processEntry(String) method.

Note that outFile is never null, even when the project is loading. (in this case it writes no nowhere, but anyway you may use it...)

If you need more control over processed files, override AbstractFilter.processFile(File, File, FilterContext) instead.

Specified by:

processFile in class AbstractFilter

Parameters:

inFile - Reader of the source file. It's the result of calling AbstractFilter.createReader(File,String).

outFile - Writer of the target file on compilation (the result of calling AbstractFilter.createWriter(File, String)), or a fictive writer to /dev/null.

Throws:

java.io.IOException - In case of any I/O error.

TranslationException - Should be thrown when processed file has any format defects.

eol

protected void eol(java.lang.String s)
            throws java.io.IOException

Throws:

java.io.IOException

align

protected void align(int pair)

align

protected void align(java.lang.String source,
                     java.lang.String translation,
                     java.lang.String comments)

Parameters:

source -

translation -

comments -

flushTranslation

protected void flushTranslation(FilterContext fc)
                         throws java.io.IOException

Throws:

java.io.IOException

hasOptions

public boolean hasOptions()

Returns true to indicate that Text filter has options.

Specified by:

hasOptions in interface IFilter

Overrides:

hasOptions in class AbstractFilter

Returns:

False, because the LANG filter has not options.

isBilingual

public boolean isBilingual()

Description copied from interface: IFilter

Indicates whether the filter is bilingual, and thus can be used as external TM (i.e. files can be added to the /tm/ folder of an OmegaT project). Bilingual filters will supply both source strings and translation strings to IParseCallback.addEntry().

Returns:

true if the filter is bilingual