Package org.eclipse.ease
Class AbstractCodeParser
java.lang.Object
org.eclipse.ease.AbstractCodeParser
- All Implemented Interfaces:
ICodeParser
- Direct Known Subclasses:
AbstractCompletionParser
,GroovyCodeParser
,JVMCompiledHeaderParser
,PythonCodeParser
,RubyCodeParser
public abstract class AbstractCodeParser extends Object implements ICodeParser
-
Field Summary
Fields Modifier and Type Field Description static Pattern
PARAMETER_PATTERN
-
Constructor Summary
Constructors Constructor Description AbstractCodeParser()
-
Method Summary
Modifier and Type Method Description static Map<String,String>
extractKeywords(String comment)
ICompletionContext
getContext(IScriptEngine scriptEngine, Object resource, String contents, int position, int selectionRange)
Parse the given piece of code into a language specificICompletionContext
.String
getHeaderComment(InputStream stream)
Default implementation to extract the first comment area from a stream.SignatureInfo
getSignatureInfo(InputStream stream)
Gets signature, certificates, provider and message-digest algorithm of signature, and content excluding signature block.boolean
isAcceptedBeforeHeader(String line)
Verify if a line of code is accepted before the header comment section.
-
Field Details
-
PARAMETER_PATTERN
-
-
Constructor Details
-
AbstractCodeParser
public AbstractCodeParser()
-
-
Method Details
-
extractKeywords
-
getHeaderComment
Default implementation to extract the first comment area from a stream. Looks for block and line comments. Might be replaced by more specific implementations for dedicated languages.- Specified by:
getHeaderComment
in interfaceICodeParser
- Parameters:
stream
- code content stream- Returns:
- comment data without decoration characters (eg: '*' at beginning of each line)
-
isAcceptedBeforeHeader
Description copied from interface:ICodeParser
Verify if a line of code is accepted before the header comment section. This allows special magic tokens to be placed before the header comment as some script languages depend on that.- Specified by:
isAcceptedBeforeHeader
in interfaceICodeParser
- Parameters:
line
- line of code- Returns:
true
when line is accepted before the comment header
-
getContext
public ICompletionContext getContext(IScriptEngine scriptEngine, Object resource, String contents, int position, int selectionRange)Description copied from interface:ICodeParser
Parse the given piece of code into a language specificICompletionContext
.- Specified by:
getContext
in interfaceICodeParser
- Parameters:
scriptEngine
- running script engineresource
- resource instance to be parsedcontents
- code to be parsed (only up to cursor position)position
- cursor position within contentsselectionRange
- amount of selected characters from cursor position- Returns:
ICompletionContext
with parsed information if successful,null
in case invalid syntax given.
-
getSignatureInfo
Description copied from interface:ICodeParser
Gets signature, certificates, provider and message-digest algorithm of signature, and content excluding signature block.- Specified by:
getSignatureInfo
in interfaceICodeParser
- Parameters:
stream
- provideInputStream
to get signature from- Returns:
SignatureInfo
instance containing signature, certificates, provider and message-digest algorithm, and content excluding signature block ornull
if signature is not found or is not in proper format- Throws:
ScriptSignatureException
- when there is text after signature block or error occurs while reading from provided input stream
-