org.youscope.common.scripting

Interface ScriptStyle

All Known Implementing Classes:

JavaScriptStyle, MatlabScriptStyle, OnixScriptStyle

public interface ScriptStyle

Definition of how a script is rendered. Should be implemented for each script language for which a specific rendering is wanted.

Author:

langmo

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBlockCommentEndDelimiter() Returns the character sequence used in the language to end a block comment.
java.lang.String	getBlockCommentStartDelimiter() Returns the character sequence used in the language to start a block comment.
java.lang.String	getEscapeQuoteDelimiter(java.lang.String quoteDelimiter) Returns the string used to print the given quote delimiter inside a quote without stopping the quote (if quote delimiter is e.g.
java.lang.String[]	getFileNameExtensions() Returns an array of all file name extensions typically associated with scripts for which this style is made.
java.lang.String[]	getScriptLanguageNames() Should return a list of the names of all scripting language implemented by the respective implementation (e.g.
java.lang.String	getScriptStyleID() Should return a unique ID with which the script style implementation can be identified.
java.lang.String	getSingleLineDelimiter() Returns the character sequence used in the language to start a single line comment.
boolean	isDelimiter(java.lang.String character) Returns true if the given character delimits two words/commands (e.g.
boolean	isKeyword(java.lang.String token) Returns true if the given token is a language specific keyword (e.g.
boolean	isQuoteDelimiter(java.lang.String character) Returns true if the given character can be used to delimit a quote (e.g.
boolean	supportsFileNameExtension(java.lang.String extension) Returns true if the given file name extension is typically associated with scripts for which this style is made.

Method Detail

isDelimiter

boolean isDelimiter(java.lang.String character)

Returns true if the given character delimits two words/commands (e.g. ".", ",", ";", ...)

Parameters:

character - The character for which it should be queried if it is a delimiter.

Returns:

True if character is a delimiter.

isQuoteDelimiter

boolean isQuoteDelimiter(java.lang.String character)

Returns true if the given character can be used to delimit a quote (e.g. " or ').

Parameters:

character - The character for which it should be queried if it is a quote delimiter.

Returns:

True if character is a quote delimiter.

isKeyword

boolean isKeyword(java.lang.String token)

Returns true if the given token is a language specific keyword (e.g. "global", "function", ...).

Parameters:

token -

Returns:

true if the token is a keyword.

getBlockCommentStartDelimiter

java.lang.String getBlockCommentStartDelimiter()

Returns the character sequence used in the language to start a block comment.

Returns:

Character sequence to start a block comment, or null if block comments do not exist in the language.

getBlockCommentEndDelimiter

java.lang.String getBlockCommentEndDelimiter()

Returns the character sequence used in the language to end a block comment.

Returns:

Character sequence to end a block comment, or null if block comments do not exist in the language.

getSingleLineDelimiter

java.lang.String getSingleLineDelimiter()

Returns the character sequence used in the language to start a single line comment.

Returns:

Character sequence to start a single line comment, or null if single line comments do not exist in the language.

getEscapeQuoteDelimiter

java.lang.String getEscapeQuoteDelimiter(java.lang.String quoteDelimiter)

Returns the string used to print the given quote delimiter inside a quote without stopping the quote (if quote delimiter is e.g. ", the escaped one might be \").

Parameters:

quoteDelimiter - The escaped version of the quote delimiter.

Returns:

the escaped quote delimiter, or null if not existing.

getFileNameExtensions

java.lang.String[] getFileNameExtensions()

Returns an array of all file name extensions typically associated with scripts for which this style is made.

Returns:

List of typical file extensions.

supportsFileNameExtension

boolean supportsFileNameExtension(java.lang.String extension)

Returns true if the given file name extension is typically associated with scripts for which this style is made.

Parameters:

extension -

Returns:

true if this extension is typically for script files of this type.

getScriptStyleID

java.lang.String getScriptStyleID()

Should return a unique ID with which the script style implementation can be identified. Different to the name of the script language, the ID should be different for every implementation.

Returns:

Unique ID for the script style implementation.

getScriptLanguageNames

java.lang.String[] getScriptLanguageNames()

Should return a list of the names of all scripting language implemented by the respective implementation (e.g. JavaScript). If two scripting style implementations are styles for the same language, they should return the same name.

Returns:

Names of scripting languages supported by this style.