org.jeditor.scripts

Class SyntaxMapper

java.lang.Object

org.jeditor.scripts.SyntaxMapper

public class SyntaxMapper
extends java.lang.Object

This class maps script name to their associated TokenMarkers.

Built-in builtinSyntaxes

The built-in builtinSyntaxes are:

• "java": Java
• "groovy": "java" syntax
• "xml": XML
• "cc": C++
• "c": C
• "python": Python
• "csharp": CSharp
• "jscript": JavaScript
• "json": JSON (same syntax as JavaScript)
• "prop": Properties files
• "manifest": Java manifest files
• "fortran": Fortran
• "html": HTML
• "php": PHP
• "sql": SQL
• "xpath": XPath
• "idl": IDL
• "make": makefiles
• "patch": Patch files
• "eiffel": Eiffel
• "tex": TeX
• "shell": Shell scripts
• "batch": Windows bat files
• "csv": CSV files

Built-in extensions

The built-in extensions are:

• "groovy"
• "ruby"
• "povray"

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MANIFEST_EXTENSIONS "jEditor-extensions": The manifest key for the syntax extensions.
static java.lang.String	MANIFEST_TYPES "jEditor-type": The manifest key for the syntax types.
static java.lang.String	MANIFEST_XMLDEF "jEditor-def": The manifest key for the syntax XML definition.

Method Summary

Modifier and Type	Method and Description
boolean	addSyntaxForExtension(java.lang.String ext, Syntax syntax) Add an existing syntax for a new extension.
boolean	addSyntaxForMIME(java.lang.String mime, Syntax syntax) Add an existing syntax for a new MIME type.
TokenMarker	createDefaultTokenMarker() Return a default TokenMarker.
TokenMarker	createTokenMarker(java.lang.String syntax) Create the TokenMarker associated with a specified syntax.
java.lang.Class<TokenMarker>	getClass(java.lang.String syntax) Return the TokenMarker class associated with a syntax name.
java.lang.String	getDefaultSyntax() Return the default syntax.
static SyntaxMapper	getInstance() Return the unique instance.
Syntax	getSyntax(java.lang.String name) Return the Syntax for a syntax name.
java.util.Map<java.lang.String,Syntax>	getSyntaxes() Return the mapping between syntax names and their associated TokenMarker classes.
java.util.Map<java.lang.String,Syntax>	getSyntaxExtensions() Return the Map of syntax for scripts extensions.
Syntax	getSyntaxForExtension(java.io.File file) Return the syntax associated with a file.
Syntax	getSyntaxForExtension(java.io.File file, boolean strict) Return the syntax associated with a file.If there is no file extension, or there is no syntax for the extension, it will return the default syntax.
Syntax	getSyntaxForExtension(java.lang.String ext) Return the syntax associated with a MIME type, or null if there is no syntax for this MIME type.
Syntax	getSyntaxForExtension(java.lang.String ext, boolean strict) Return the syntax associated with an extension, or null if there is no syntax for this extension.
Syntax	getSyntaxForMIME(java.lang.String mime) Return the syntax associated with a MIME type, or null if there is no syntax for this MIME type.
Syntax	getSyntaxForMIME(java.lang.String mime, boolean strict) Return the syntax associated with a MIME type, or null if there is no syntax for this MIME type.
java.util.Map<java.lang.String,Syntax>	getSyntaxForMIMETypes() Return the Map of syntax for scripts MIME types.
java.util.SortedSet<java.lang.String>	getSyntaxList() Return the set of scripts names.
boolean	hasSyntax(java.lang.String syntax) Return true if there is a syntax for a specified name.
boolean	hasSyntaxForExtension(java.lang.String ext) Return true if there is a syntax for a specified file extension.
boolean	hasSyntaxForMIME(java.lang.String mime) Return true if there is a syntax for a specified MIME type.
boolean	installSyntax(java.lang.String key, java.lang.String extension, java.lang.String path) Add a new Syntax for a Script.
boolean	installSyntax(java.lang.String key, java.lang.String extension, java.lang.String path, java.lang.ClassLoader loader) Add a new Syntax for a Script.
boolean	installSyntax(java.lang.String key, java.lang.String extension, java.lang.String path, short type, java.lang.ClassLoader loader) Add a new Syntax for a Script.
boolean	installSyntaxPack(java.net.URL syntaxPack) Install all built-in Syntaxes from a syntax Pack.
boolean	installSyntaxPack(java.net.URL syntaxPack, boolean allowExisting) Install all built-in Syntaxes from a syntax Pack.
void	reset() Reset the additional built-in Syntaxes.
void	setDefaultSyntax(java.lang.String syntax) Set the default syntax.

Methods inherited from class java.lang.Object

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

Field Detail

MANIFEST_EXTENSIONS

public static final java.lang.String MANIFEST_EXTENSIONS

"jEditor-extensions": The manifest key for the syntax extensions. The key is the file extension, the value is the syntax name.

See Also:

Constant Field Values

MANIFEST_TYPES

public static final java.lang.String MANIFEST_TYPES

"jEditor-type": The manifest key for the syntax types. The key is the syntax name, the value if the class path for the syntax.

See Also:

Constant Field Values

MANIFEST_XMLDEF

public static final java.lang.String MANIFEST_XMLDEF

"jEditor-def": The manifest key for the syntax XML definition.

See Also:

Constant Field Values

Method Detail

getInstance

public static SyntaxMapper getInstance()

Return the unique instance.

Returns:

the unique instance

reset

public void reset()

Reset the additional built-in Syntaxes.

getSyntaxExtensions

public java.util.Map<java.lang.String,Syntax> getSyntaxExtensions()

Return the Map of syntax for scripts extensions.

Returns:

the Map of syntax

getSyntaxForMIMETypes

public java.util.Map<java.lang.String,Syntax> getSyntaxForMIMETypes()

Return the Map of syntax for scripts MIME types.

Returns:

the Map of syntax

getSyntaxList

public java.util.SortedSet<java.lang.String> getSyntaxList()

Return the set of scripts names.

Returns:

the set of scripts names

installSyntaxPack

public boolean installSyntaxPack(java.net.URL syntaxPack)

Install all built-in Syntaxes from a syntax Pack.

Distributing a syntax pack

Syntax packs are jar files which contains classes which extends the TokenMarker class. Two additional properties files must be present in the jar file:

• A properties files which maps file extensions to syntax names
• A properties files which maps syntax names to the associated class path of the syntax

The Manifest of the jar file must contain two properties:

• MANIFEST_EXTENSIONS: the path of the file for the <extensions>-<syntax names> properties
• MANIFEST_TYPES: the path of the file for the <syntax names>-<TokenMarker class path> properties

Parameters:

syntaxPack - the syntax pack

Returns:

true if the install was successful

installSyntaxPack

public boolean installSyntaxPack(java.net.URL syntaxPack,
                                 boolean allowExisting)

Install all built-in Syntaxes from a syntax Pack.

Distributing a syntax pack

Syntax packs are jar files which contains classes which extends the TokenMarker class. Two additional properties files must be present in the jar file:

• A properties files which maps file extensions to syntax names
• A properties files which maps syntax names to the associated class path of the syntax

The Manifest of the jar file must contain two properties:

• MANIFEST_EXTENSIONS: the path of the file for the <extensions>-<syntax names> properties
• MANIFEST_TYPES: the path of the file for the <syntax names>-<TokenMarker class path> properties

Parameters:

syntaxPack - the syntax pack

allowExisting - true fi it is allowed to override an existing syntax

Returns:

true if the install was successful

installSyntax

public boolean installSyntax(java.lang.String key,
                             java.lang.String extension,
                             java.lang.String path)

Add a new Syntax for a Script.

Parameters:

key - the syntax key

extension - the syntax extension

path - the TokenMarker classpath

Returns:

true if the TokenMarker class could be found

installSyntax

public boolean installSyntax(java.lang.String key,
                             java.lang.String extension,
                             java.lang.String path,
                             java.lang.ClassLoader loader)

Add a new Syntax for a Script.

Parameters:

key - the syntax key

extension - the syntax extension

path - the TokenMarker classpath

loader - the ClassLoader

Returns:

true if the TokenMarker class could be found

installSyntax

public boolean installSyntax(java.lang.String key,
                             java.lang.String extension,
                             java.lang.String path,
                             short type,
                             java.lang.ClassLoader loader)

Add a new Syntax for a Script.

Parameters:

key - the syntax key

extension - the syntax extension

path - the TokenMarker classpath

type - the syntax type

loader - the ClassLoader

Returns:

true if the TokenMarker class could be found

getSyntax

public Syntax getSyntax(java.lang.String name)

Return the Syntax for a syntax name.

Parameters:

name - the syntax name

Returns:

the Syntax

getSyntaxes

public java.util.Map<java.lang.String,Syntax> getSyntaxes()

Return the mapping between syntax names and their associated TokenMarker classes.

Returns:

the map

getClass

public java.lang.Class<TokenMarker> getClass(java.lang.String syntax)

Return the TokenMarker class associated with a syntax name.

Parameters:

syntax - the TokenMarker class

Returns:

the syntax the syntax name

hasSyntax

public boolean hasSyntax(java.lang.String syntax)

Return true if there is a syntax for a specified name.

Parameters:

syntax - the syntax name

Returns:

true if there is a syntax for the specified name

hasSyntaxForExtension

public boolean hasSyntaxForExtension(java.lang.String ext)

Return true if there is a syntax for a specified file extension.

Parameters:

ext - the file extension

Returns:

true if there is a syntax for the specified extension

addSyntaxForExtension

public boolean addSyntaxForExtension(java.lang.String ext,
                                     Syntax syntax)

Add an existing syntax for a new extension. The syntax must exist, and the exgtension must not exist.

Parameters:

ext - the extension

syntax - the syntax

Returns:

true if it was possible to add the syntax for this extension. It will return false if there is no syntax for the syntax name, or if there is already an extension for the ext name

getSyntaxForExtension

public Syntax getSyntaxForExtension(java.io.File file)

Return the syntax associated with a file. If there is no file extension, or there is no syntax for the extension, it will return the default syntax.

Parameters:

file - the file

Returns:

the syntax

getSyntaxForExtension

public Syntax getSyntaxForExtension(java.io.File file,
                                    boolean strict)

Return the syntax associated with a file.If there is no file extension, or there is no syntax for the extension, it will return the default syntax.

Parameters:

file - the file

strict - true if the lookup for the syntax is strict

Returns:

the syntax

getSyntaxForExtension

public Syntax getSyntaxForExtension(java.lang.String ext)

Return the syntax associated with a MIME type, or null if there is no syntax for this MIME type.

Parameters:

ext - the extension

Returns:

the syntax

getSyntaxForExtension

public Syntax getSyntaxForExtension(java.lang.String ext,
                                    boolean strict)

Return the syntax associated with an extension, or null if there is no syntax for this extension.

Parameters:

ext - the extension

strict - true if the lookup for the syntax is strict

Returns:

the syntax

addSyntaxForMIME

public boolean addSyntaxForMIME(java.lang.String mime,
                                Syntax syntax)

Add an existing syntax for a new MIME type. The syntax must exist, and the MIME type must not exist.

Parameters:

mime - the MIME type

syntax - the syntax

Returns:

true if it was possible to add the syntax for this MIME type. It will return false if there is no syntax for the syntax name, or if there is already an extension for the MIME type

hasSyntaxForMIME

public boolean hasSyntaxForMIME(java.lang.String mime)

Return true if there is a syntax for a specified MIME type.

Parameters:

mime - the MIME type

Returns:

true if there is a syntax for the specified MIME type

getSyntaxForMIME

public Syntax getSyntaxForMIME(java.lang.String mime)

Return the syntax associated with a MIME type, or null if there is no syntax for this MIME type.

Parameters:

mime - the MIME type

Returns:

the syntax

getSyntaxForMIME

public Syntax getSyntaxForMIME(java.lang.String mime,
                               boolean strict)

Return the syntax associated with a MIME type, or null if there is no syntax for this MIME type.

Parameters:

mime - the MIME type

strict - true if the lookup for the syntax must be strict

Returns:

the syntax

setDefaultSyntax

public void setDefaultSyntax(java.lang.String syntax)

Set the default syntax. It will be used when calling createDefaultTokenMarker().

Parameters:

syntax - the default syntax

getDefaultSyntax

public java.lang.String getDefaultSyntax()

Return the default syntax. The default syntax will be used when calling createDefaultTokenMarker().

Returns:

the default syntax

createDefaultTokenMarker

public TokenMarker createDefaultTokenMarker()

Return a default TokenMarker. The algorithm is the following:

• If there is a default syntax, call createTokenMarker(java.lang.String) with this syntax. If the method returns null, return a BasicTokenMarker
• Else return a BasicTokenMarker

Returns:

the a default TokenMarker

createTokenMarker

public TokenMarker createTokenMarker(java.lang.String syntax)

Create the TokenMarker associated with a specified syntax.

Parameters:

syntax - the syntax name

Returns:

the TokenMarker