Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.parsers
Class ISeriesEditorRPGOPMParser

java.lang.Object
  extended by LpexCommonParser
      extended by com.ibm.etools.iseries.parsers.ISeriesEditorParser
          extended by com.ibm.etools.iseries.parsers.ISeriesEditorRPGOPMParser
All Implemented Interfaces:
IISeriesCompileErrorInfoViewHandler, IISeriesEditorConstants, IISeriesEditorConstantsColors, IISeriesEditorConstantsRPG, IISeriesEditorConstantsRPGOPM, IISeriesEditorParser, ISystemEditorConstants, ISystemTextEditorAdapterContributor, ISystemTextEditorContextContributor, ISystemTextEditorDebugContributor, ISystemTextEditorHelpContributor, ISystemTextEditorParser, ISystemTextEditorSourceViewerConfigurationContributor

public class ISeriesEditorRPGOPMParser
extends ISeriesEditorParser
implements IISeriesEditorConstantsRPGOPM


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.etools.iseries.parsers.ISeriesEditorParser
ISeriesEditorParser.DataLineMarkListener, ISeriesEditorParser.RunnableParseAll
 
Field Summary
protected static ResourceBundle _bundle
           
protected  boolean _bUpdateView
           
protected  ISeriesEditorRPGOPMSourceViewerConfiguration _configuration
           
protected  SystemTextEditorHelpHandler _helpHandler
           
protected  SystemTextEditorHelpHandler _helpMessageHandler
           
protected  long _lClassComment
           
protected  long _lClassControl
           
protected  long _lClassMask
           
protected  long _lClassSpace
           
protected  long _lClassSql
           
protected  long _lClassSubroutine
           
protected  ISeriesEditorRPGOPMModel _model
           
protected  ISeriesEditorRPGOPMPrefixProcessor _prefixer
           
protected  ISeriesEditorRPGOPMPrompter _prompter
           
protected  ISeriesEditorRPGOPMFormatLine _ruler
           
protected  ISeriesEditorRPGOPMSyntaxChecker _syntaxChecker
           
protected  ISeriesEditorRPGOPMTokenizer _tokenizer
          the preference store with the OPM RPG preferences
static String copyright
           
 
Fields inherited from class com.ibm.etools.iseries.parsers.ISeriesEditorParser
_action, _bDataElementChanged, _bDebugMode, _bFromStylePreview, _bIgnoreParseExtras, _bIsPrimaryLpexView, _bLocal, _bOutlineViewNeedsResetting, _bParseAll, _bParsing, _compileEditManager, _compileErrorMarkerListener, _compileMarkNames, _dataLineMarkID, _dataLineMarkListener, _editor, _helpResourceBundle, _iCCSID, _iFile, _labelProvider, _member, _menuLanguageHelp, _menuSource, _outlinePage, _strImagePath, _strLocalFileName, _strSpecialChars, _view, DATA_LINE
 
Fields inherited from interface com.ibm.etools.iseries.editor.IISeriesEditorConstantsRPGOPM
_straControlWords, _straDataWords, _straMacroWords, _straRPGFonts, COLUMN_C_OPCODE, CSPECCOMMENT_POS, FACTOR2_POS, FIELDLEN_POS, LENGTH_C_OPCODE, PAGE_INDEX_OPM_C_Calculation, PAGE_INDEX_OPM_Comment, PAGE_INDEX_OPM_E_Extension, PAGE_INDEX_OPM_F_File_Description, PAGE_INDEX_OPM_F_File_Description_Continuation, PAGE_INDEX_OPM_F_File_Description_Continuation_SFILE_RENAME, PAGE_INDEX_OPM_F_File_Description_Externally_Described_File, PAGE_INDEX_OPM_Full_Line, PAGE_INDEX_OPM_H_Control, PAGE_INDEX_OPM_I_Input_Data_Structure, PAGE_INDEX_OPM_I_Input_Data_Structure_Subfield, PAGE_INDEX_OPM_I_Input_Field_Description, PAGE_INDEX_OPM_I_Input_Field_Description_Externally_Described_File, PAGE_INDEX_OPM_I_Input_Initialization_Value, PAGE_INDEX_OPM_I_Input_Named_Constant, PAGE_INDEX_OPM_I_Input_Record_Identification, PAGE_INDEX_OPM_I_Input_Record_Identification_Externally_Described_File, PAGE_INDEX_OPM_L_Line_Counter, PAGE_INDEX_OPM_O_Output_Field_Description, PAGE_INDEX_OPM_O_Output_Record_Description, PAGE_INDEX_OPM_O_Output_To_Disk, PROMPT_C, PROMPT_CIND, PROMPT_CM, PROMPT_DATA, PROMPT_DSS, PROMPT_DSS2, PROMPT_E, PROMPT_F, PROMPT_FC, PROMPT_FK, PROMPT_FX, PROMPT_H, PROMPT_IDS, PROMPT_IF, PROMPT_IFX, PROMPT_IR, PROMPT_IR2, PROMPT_IRX, PROMPT_L, PROMPT_LAST, PROMPT_MACRO, PROMPT_NC, PROMPT_NONE, PROMPT_OD, PROMPT_OF, PROMPT_OR, PROMPT_OR2, PROMPT_SPACE, PROMPT_SQL, PROMPT_SV, PROMPT_U, STRING_HELP_DOC_PLUGIN_ID, STRING_HELP_TABLE_FILENAME, STRING_HELP_TABLE_PLUGIN_ID, STRING_MESSAGE_HELP_DOC_PLUGIN_ID, STRING_MESSAGE_HELP_TABLE_FILENAME, STRING_MESSAGE_HELP_TABLE_PLUGIN_ID
 
Fields inherited from interface com.ibm.etools.iseries.editor.IISeriesEditorConstantsRPG
_straSQLWords, _straSQLWordsWithComment, CMD_SETFORMATLINETEXT, CMD_SETTABS, COLUMN_C_FREE, COLUMN_COMMENT, COLUMN_FACTOR1, COLUMN_FACTOR2, COLUMN_KEYWORDS, COLUMN_PROC_NAME_BEGIN, COLUMN_PROC_NAME_END, COLUMN_PROC_SPEC, COLUMN_SPEC, FIELD_FACTOR1, FIELD_FACTOR2, FIELD_FROM, FIELD_OPCODE, FIELD_TOLENGTH, OPM_COLUMN_FACTOR1
 
Fields inherited from interface com.ibm.etools.iseries.edit.IISeriesEditorConstantsColors
COLOR_BLACK_WHITE, COLOR_BLUE_WHITE, COLOR_BRIGHTBLUE_WHITE, COLOR_BRIGHTGREEN_WHITE, COLOR_BRIGHTGREY_WHITE, COLOR_BRIGHTPINK_WHITE, COLOR_BRIGHTRED_WHITE, COLOR_BRIGHTRED_WHITE_SQUIGGLE, COLOR_BROWN_WHITE, COLOR_CYAN_WHITE, COLOR_DARK_BROWN_WHITE, COLOR_ERROR_HIGHLIGHT, COLOR_GREEN_WHITE, COLOR_GREY_WHITE, COLOR_HIGHLIGHT, COLOR_MAGENTA_WHITE, COLOR_PINK_WHITE, COLOR_RED_WHITE, COLOR_WHITE_BRIGHTRED
 
Fields inherited from interface com.ibm.etools.iseries.parsers.IISeriesEditorParser
Copyright
 
Fields inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorAdapterContributor
Copyright
 
Fields inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorContextContributor
Copyright
 
Fields inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorDebugContributor
Copyright
 
Fields inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorHelpContributor
Copyright
 
Fields inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorSourceViewerConfigurationContributor
Copyright
 
Fields inherited from interface com.ibm.etools.iseries.edit.IISeriesEditorConstants
ACTION_VERIFYPROGRAM_ID, APPLICATION_DIAGRAM, COMPILE_ERROR_MESSAGE_STYLE, FILE_TYPE_CL, FILE_TYPE_DDS, FILE_TYPE_OTHER, FILE_TYPE_RPGILE, FILE_TYPE_RPGOPM, MAX_DS_NESTING, OUTLINE_VIEW, PREF_AUTO_FORMAT, PREF_AUTO_FORMAT_T, PREF_AUTO_UPPER, PREF_AUTO_UPPER_T, PREF_BASE_PREFIX, PREF_BLANK, PREF_BLANK_SUFFIX, PREF_BLANK_T, PREF_COMMAND_POS, PREF_COMMAND_POS_T, PREF_HIGHLIGHT, PREF_HIGHLIGHT_BACKGROUND, PREF_HIGHLIGHT_BACKGROUND_T, PREF_HIGHLIGHT_T, PREF_INDENT, PREF_INDENT_T, PREF_INDENTATION, PREF_INDENTATION_T, PREF_LABEL_ABOVE_CMD, PREF_LABEL_ABOVE_CMD_T, PREF_LABEL_POS, PREF_LABEL_POS_T, PREF_LINE_LENGTH, PREF_LINE_LENGTH_T, PREF_ONE_PARM_PER_LINE, PREF_ONE_PARM_PER_LINE_T, PREF_PARSER_ASSOC, PREF_PARSER_STYLES, PREF_SIGNATURE_T, PREF_SQL_SYNTAX_CHECK, PREF_SQL_SYNTAX_CHECK_T, PREF_SYNTAX_CHECK, PREF_SYNTAX_CHECK_T, PREF_TAB, PREF_TAB_GENERAL, PREF_TAB_GENERAL_T, PREF_TAB_T, PREF_TOOLTIP_SUFFIX, PROGRAM_VERIFICATION
 
Fields inherited from interface com.ibm.etools.systems.editor.ISystemEditorConstants
COMPILE_ERROR_CLASS_NAME, ICON_EDITOR_COMPILE, ICON_EDITOR_COMPILE_D, ICON_EDITOR_COMPILE_D_ID, ICON_EDITOR_COMPILE_D_ROOT, ICON_EDITOR_COMPILE_ID, ICON_EDITOR_COMPILE_ROOT, ICON_EDITOR_NEXT_ERROR, ICON_EDITOR_NEXT_ERROR_D, ICON_EDITOR_NEXT_ERROR_D_ID, ICON_EDITOR_NEXT_ERROR_D_ROOT, ICON_EDITOR_NEXT_ERROR_ID, ICON_EDITOR_NEXT_ERROR_ROOT, ICON_EDITOR_PREVIOUS_ERROR, ICON_EDITOR_PREVIOUS_ERROR_D, ICON_EDITOR_PREVIOUS_ERROR_D_ID, ICON_EDITOR_PREVIOUS_ERROR_D_ROOT, ICON_EDITOR_PREVIOUS_ERROR_ID, ICON_EDITOR_PREVIOUS_ERROR_ROOT, ICON_EXT, ICON_RELATIVE_PATH_DLCL16, ICON_RELATIVE_PATH_ELCL16, ICON_RELATIVE_PATH_FULL, ICON_SUFFIX, PREFIX, SYNTAX_ERROR_CLASS_NAME
 
Constructor Summary
ISeriesEditorRPGOPMParser(LpexView view)
          Constructor
 
Method Summary
 void cleanupMenu(ITextEditor editor, IMenuManager menuManager)
          Removes the Source and Compile menu items
 void cleanupToolBar(ITextEditor editor, IToolBarManager toolBarManager)
          removes the next and previous error toolbar buttons
protected  void contributeMenuItems(IMenuManager menuRoot, boolean bPopupMenu)
          Adds common menu items to the top of the root menu.
 void contributeToMenu(ITextEditor editor, IMenuManager menuManager)
          Contributes menu bar items.
 void contributeToPopupMenu(ITextEditor editor, IMenuManager menuRoot)
          Contributes popup menu bar items.
 void contributeToToolBar(ITextEditor editor, IToolBarManager toolBarManager)
          Contributes tool bar items.
protected  void createActions(ITextEditor editor)
          Creates menubar and toolbar actions.
protected  int determineElement(int iElement)
          Sets the line class bits, and returns the opcode type.
protected  int determineLine(int iLine)
          Deprecated.  
 void documentChanged(LpexView lpexView, int type, int line, int position, int len)
          Used by the parser to determine the element where the compile data is
 void finishedSaving(ITextEditor editor)
          Method finishedSaving Does nothing for the OPM RPG Parser
 void focusGained(FocusEvent event)
          when focus is gained, reset the tabs
 String getCommentStyleCharacters()
          Returns the style characters used for styling comments ("cs").
protected  long getElementClassTypes(String strElement, int iSpecType, int iElement)
          Port of evferppa.cpp, ClassOfLine
 IQSYSFile getFieldFile()
          b Method getFieldFile.
 LpexFieldsProvider getFieldsProvider()
          Retrieves the fields provided for the parser.
 IISeriesEditorFormatLine getFormatLine()
          Returns the format line ruler.
 SystemTextEditorHelpHandler getHelpHandler()
          Returns the help handler for this parser.
 String getHelpPluginID()
          Returns the name of the plugin that contains the help files.
 String getHelpTableFileName()
          Returns the name of the properties file that has the mapping between help resource ID to Html filename.
 IQSYSMember getIncludeMember()
          Subclasses should override if implementing the action ActionOpenInclude
 String getLanguage()
          Declared in ISystemEditorParser
protected  long getLineClassTypes(String strLine, int iSpecType, int iLine)
          Deprecated.  
protected  int getLineSpecType(String strLine)
          Port of evferppa.cpp, ParseLine
protected  int getLineSpecTypeF(String strLine)
           
protected  int getLineSpecTypeI(String strLine)
           
protected  int getLineSpecTypeO(String strLine)
           
 LanguageModel getModel(boolean bUpdate)
          Returns the element tree model for the outline view.
 String getPopupItems(int popupLocation)
          56708 Return the popup menu items
 ResourceBundle getProfile()
           
 IISeriesEditorPromptAdapter getPromptAdapter()
          Method declared on ISeriesEditorParser.
 String getPromptFormatLine(int iSpecType)
          Returns the format string of the spec type.
 LpexSourceViewerConfiguration getSourceViewerConfiguration()
          Returns the source viewer configuration.
 IISeriesEditorSyntaxChecker getSyntaxChecker()
          Returns the syntax checker.
 void initializeColors(LpexView view)
          Initializes the display colors.
 void initializeElementClassTypes()
          Registers the element class types with Lpex
 void initializeLpexView(LpexView lpexView)
          Declared in IISeriesEditorParser Update lpex profile with tabbing support.
protected  void initParser()
          initialize parser
 boolean isLineDebuggable(int iLine)
          Returns true if the line is debuggable
 boolean isValidFieldAction()
          Method isValidFieldAction.
 boolean isValidIncludeAction()
          Method isValidIncludeAction.
protected  LpexDocumentLocation matchToken(LpexDocumentLocation loc)
          Match tokens Matches the token that the location specifies.
 void parseElements(int iElementFirst, int iElementLast, int iElementCurrent)
          Parse range of elements This just calls parseLine(i) for each element, subclasses can handle it differently if they want (e.g.
 void parseLine(int iElement)
          Port of evferppp.cpp, LineParse
protected  void parseRegion(int iElementFirst, int iElementLast, IProgressMonitor progressMonitor)
          Parses a contiguous set of lines given the first and last line numbers.
 void promptRequest()
          Called when the F4 key was just pressed, before the focus is given to the prompter.
 void setEditor(LpexTextEditor editor)
          Method setEditor.
protected  boolean supportsOutlineView()
          Returns false by default.
 void terminateParser()
          When parsing is disabled, turn off document listeners
 
Methods inherited from class com.ibm.etools.iseries.parsers.ISeriesEditorParser
addCompileError, addError, cleanupPopupMenu, copyCompileErrorInfo, createOutlineView, doLpexAction, doPromptAction, doRefresh, elementChanged, focusLost, getAdapter, getAS400, getAutoUppercase, getEditor, getIFile, getImage, getISeriesConnection, getISeriesMember, getLocalFileName, getLpexLanguageHelpHandler, getLpexView, getLshToken, getProgramVerifier, getProperty, getPropertySheet, getSpecialChars, getTextLimit, hasSequenceNumbers, isDebugMode, isElementAboveDataRegion, isLineAboveDataRegion, isLocal, isReadOnly, match, modelBuiltAsynchronous, parseAll, parseElement, prompt, queryDataLine, removeErrors, removeErrors, resetOutlineView, saving, selectionLinesChanged, selectionLinesChanged, selectionLinesChanged, setAS400, setCompileErrorInfo, setDebugMode, setEnableParseExtras, setLocal, updateProfileForActions, updateProfileForTabbing, upperCase
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values

_bundle

protected static ResourceBundle _bundle

_tokenizer

protected ISeriesEditorRPGOPMTokenizer _tokenizer
the preference store with the OPM RPG preferences


_ruler

protected ISeriesEditorRPGOPMFormatLine _ruler

_prefixer

protected ISeriesEditorRPGOPMPrefixProcessor _prefixer

_prompter

protected ISeriesEditorRPGOPMPrompter _prompter

_syntaxChecker

protected ISeriesEditorRPGOPMSyntaxChecker _syntaxChecker

_helpHandler

protected SystemTextEditorHelpHandler _helpHandler

_helpMessageHandler

protected SystemTextEditorHelpHandler _helpMessageHandler

_model

protected ISeriesEditorRPGOPMModel _model

_configuration

protected ISeriesEditorRPGOPMSourceViewerConfiguration _configuration

_lClassComment

protected long _lClassComment

_lClassControl

protected long _lClassControl

_lClassMask

protected long _lClassMask

_lClassSpace

protected long _lClassSpace

_lClassSql

protected long _lClassSql

_lClassSubroutine

protected long _lClassSubroutine

_bUpdateView

protected boolean _bUpdateView
Constructor Detail

ISeriesEditorRPGOPMParser

public ISeriesEditorRPGOPMParser(LpexView view)
Constructor

Method Detail

initParser

protected void initParser()
initialize parser

Overrides:
initParser in class ISeriesEditorParser

setEditor

public void setEditor(LpexTextEditor editor)
Description copied from interface: IISeriesEditorParser
Method setEditor. Sets up the editor and related info for the parser

Specified by:
setEditor in interface IISeriesEditorParser
Overrides:
setEditor in class ISeriesEditorParser
Parameters:
editor - the editor for this parser
See Also:
The CCSID is set here. If the file CCSID is invalid, the job CCSID is used. The CCSID is used later to obtain the special translation characters in getSpecialChars.

IMPORTANT!!!!!!!! NOTE: if you modify this method, you NEED to propate all changes to all 4 COBOL parsers


contributeMenuItems

protected void contributeMenuItems(IMenuManager menuRoot,
                                   boolean bPopupMenu)
Adds common menu items to the top of the root menu.


contributeToMenu

public void contributeToMenu(ITextEditor editor,
                             IMenuManager menuManager)
Contributes menu bar items.

Specified by:
contributeToMenu in interface ISystemTextEditorContextContributor
Overrides:
contributeToMenu in class ISeriesEditorParser

contributeToPopupMenu

public void contributeToPopupMenu(ITextEditor editor,
                                  IMenuManager menuRoot)
Contributes popup menu bar items.

Specified by:
contributeToPopupMenu in interface ISystemTextEditorContextContributor

contributeToToolBar

public void contributeToToolBar(ITextEditor editor,
                                IToolBarManager toolBarManager)
Contributes tool bar items.

Specified by:
contributeToToolBar in interface ISystemTextEditorContextContributor
Overrides:
contributeToToolBar in class ISeriesEditorParser

cleanupToolBar

public void cleanupToolBar(ITextEditor editor,
                           IToolBarManager toolBarManager)
Description copied from class: ISeriesEditorParser
removes the next and previous error toolbar buttons

subclasses which add other toolbar buttons should subclass and call super

Specified by:
cleanupToolBar in interface ISystemTextEditorContextContributor
Overrides:
cleanupToolBar in class ISeriesEditorParser
See Also:
ISystemTextEditorContextContributor.cleanupToolBar(ITextEditor, IToolBarManager)

createActions

protected void createActions(ITextEditor editor)
Creates menubar and toolbar actions.


documentChanged

public void documentChanged(LpexView lpexView,
                            int type,
                            int line,
                            int position,
                            int len)
Used by the parser to determine the element where the compile data is

See Also:
com.ibm.lpex.core.LpexDocumentListener#documentChanged(LpexView, int, int, int, int)

finishedSaving

public void finishedSaving(ITextEditor editor)
Method finishedSaving Does nothing for the OPM RPG Parser

Specified by:
finishedSaving in interface ISystemTextEditorContextContributor
See Also:
ISystemTextEditorContextContributor.finishedSaving(ITextEditor)

determineLine

protected int determineLine(int iLine)
Deprecated. 

Sets the line class bits, and returns the opcode type. Port of evfrilda.c, DetermineLine


determineElement

protected int determineElement(int iElement)
Sets the line class bits, and returns the opcode type. Port of evfrilda.c, DetermineLine


focusGained

public void focusGained(FocusEvent event)
when focus is gained, reset the tabs

Overrides:
focusGained in class ISeriesEditorParser
See Also:
FocusListener

getCommentStyleCharacters

public String getCommentStyleCharacters()
Returns the style characters used for styling comments ("cs"). This is used by compare sessions when the compare.ignoreComments option is in effect.


getFieldFile

public IQSYSFile getFieldFile()
b Method getFieldFile. returns an ISeriesFile object if the cursor is on a line with an F spec, null otherwise.

Specified by:
getFieldFile in interface IISeriesEditorParser
Overrides:
getFieldFile in class ISeriesEditorParser
Returns:
an object that the action can run against
See Also:
com.ibm.etools.iseries.editor.IISeriesEditorParser#getFieldFile()

getFormatLine

public IISeriesEditorFormatLine getFormatLine()
Returns the format line ruler.

Specified by:
getFormatLine in interface IISeriesEditorParser
Overrides:
getFormatLine in class ISeriesEditorParser

getHelpHandler

public SystemTextEditorHelpHandler getHelpHandler()
Returns the help handler for this parser.

Specified by:
getHelpHandler in interface IISeriesEditorParser

getIncludeMember

public IQSYSMember getIncludeMember()
Description copied from class: ISeriesEditorParser
Subclasses should override if implementing the action ActionOpenInclude

Specified by:
getIncludeMember in interface IISeriesEditorParser
Overrides:
getIncludeMember in class ISeriesEditorParser
Returns:
the ISeriesMember to edit/browse
See Also:
com.ibm.etools.iseries.editor.IISeriesEditorParser#getIncludeMember()

getLanguage

public String getLanguage()
Declared in ISystemEditorParser

Specified by:
getLanguage in interface ISystemTextEditorParser
Specified by:
getLanguage in class ISeriesEditorParser

getLineClassTypes

protected long getLineClassTypes(String strLine,
                                 int iSpecType,
                                 int iLine)
Deprecated. 

Port of evferppa.cpp, ClassOfLine


getElementClassTypes

protected long getElementClassTypes(String strElement,
                                    int iSpecType,
                                    int iElement)
Port of evferppa.cpp, ClassOfLine


getLineSpecType

protected int getLineSpecType(String strLine)
Port of evferppa.cpp, ParseLine


getLineSpecTypeF

protected int getLineSpecTypeF(String strLine)

getLineSpecTypeI

protected int getLineSpecTypeI(String strLine)

getLineSpecTypeO

protected int getLineSpecTypeO(String strLine)

getHelpPluginID

public String getHelpPluginID()
Returns the name of the plugin that contains the help files.


getHelpTableFileName

public String getHelpTableFileName()
Returns the name of the properties file that has the mapping between help resource ID to Html filename.


supportsOutlineView

protected boolean supportsOutlineView()
Description copied from class: ISeriesEditorParser
Returns false by default. Subclass that do support an outline view should override to return true

Overrides:
supportsOutlineView in class ISeriesEditorParser

getModel

public LanguageModel getModel(boolean bUpdate)
Returns the element tree model for the outline view.

Specified by:
getModel in interface IISeriesEditorParser
Overrides:
getModel in class ISeriesEditorParser

getPopupItems

public String getPopupItems(int popupLocation)
56708 Return the popup menu items

Overrides:
getPopupItems in class ISeriesEditorParser
See Also:
com.ibm.lpex.core.LpexCommonParser#getPopupItems(int)

getProfile

public ResourceBundle getProfile()

getPromptAdapter

public IISeriesEditorPromptAdapter getPromptAdapter()
Method declared on ISeriesEditorParser. Returns an adapter used to communicate between the editor and a prompt view.

Specified by:
getPromptAdapter in interface IISeriesEditorParser
Specified by:
getPromptAdapter in class ISeriesEditorParser

getPromptFormatLine

public String getPromptFormatLine(int iSpecType)
Returns the format string of the spec type.


getSyntaxChecker

public IISeriesEditorSyntaxChecker getSyntaxChecker()
Returns the syntax checker.

Specified by:
getSyntaxChecker in interface IISeriesEditorParser
Overrides:
getSyntaxChecker in class ISeriesEditorParser

getSourceViewerConfiguration

public LpexSourceViewerConfiguration getSourceViewerConfiguration()
Returns the source viewer configuration. Default implementation returns null.

Specified by:
getSourceViewerConfiguration in interface ISystemTextEditorSourceViewerConfigurationContributor
Overrides:
getSourceViewerConfiguration in class ISeriesEditorParser

initializeColors

public void initializeColors(LpexView view)
Initializes the display colors.


initializeElementClassTypes

public void initializeElementClassTypes()
Registers the element class types with Lpex


initializeLpexView

public void initializeLpexView(LpexView lpexView)
Declared in IISeriesEditorParser Update lpex profile with tabbing support.

Specified by:
initializeLpexView in interface IISeriesEditorParser
Overrides:
initializeLpexView in class ISeriesEditorParser

isValidFieldAction

public boolean isValidFieldAction()
Method isValidFieldAction. checks whther the current line is valid for the show fields action

Specified by:
isValidFieldAction in interface IISeriesEditorParser
Overrides:
isValidFieldAction in class ISeriesEditorParser
Returns:
true if the current line has an f spec with a filename on it, false otherwise
See Also:
com.ibm.etools.iseries.editor.IISeriesEditorParser#isValidFieldAction()

isValidIncludeAction

public boolean isValidIncludeAction()
Method isValidIncludeAction. checkw whether the current line is valid for showing /copy members

Specified by:
isValidIncludeAction in interface IISeriesEditorParser
Overrides:
isValidIncludeAction in class ISeriesEditorParser
Returns:
true if the current line is a /COPY line
See Also:
com.ibm.etools.iseries.editor.IISeriesEditorParser#isValidIncludeAction()

isLineDebuggable

public boolean isLineDebuggable(int iLine)
Returns true if the line is debuggable

Specified by:
isLineDebuggable in interface ISystemTextEditorDebugContributor

matchToken

protected LpexDocumentLocation matchToken(LpexDocumentLocation loc)
Match tokens Matches the token that the location specifies.

Parameters:
loc - the location of the token to match
Returns:
the location of the matching token, null if the token is not found
See Also:
com.ibm.lpex.core.LpexCommonParser#matchToken(LpexDocumentLocation)

parseElements

public void parseElements(int iElementFirst,
                          int iElementLast,
                          int iElementCurrent)
Description copied from class: ISeriesEditorParser
Parse range of elements This just calls parseLine(i) for each element, subclasses can handle it differently if they want (e.g. only calling a syntax checker once for the whole range of lines instead of once per line).

Overrides:
parseElements in class ISeriesEditorParser
See Also:
com.ibm.etools.iseries.editor.ISeriesEditorParser#parseElements(int, int, int)

parseLine

public void parseLine(int iElement)
Port of evferppp.cpp, LineParse

Specified by:
parseLine in class ISeriesEditorParser

parseRegion

protected void parseRegion(int iElementFirst,
                           int iElementLast,
                           IProgressMonitor progressMonitor)
Parses a contiguous set of lines given the first and last line numbers. Port of evferppp.cpp PartParse

Specified by:
parseRegion in class ISeriesEditorParser

promptRequest

public void promptRequest()
Called when the F4 key was just pressed, before the focus is given to the prompter. Parse and tokenize the line and notify the prompter. This is done in case the user has changed the line.

Specified by:
promptRequest in class ISeriesEditorParser

getFieldsProvider

public LpexFieldsProvider getFieldsProvider()
Retrieves the fields provided for the parser. Returns null if there is no fields provider

Specified by:
getFieldsProvider in interface IISeriesEditorParser
Overrides:
getFieldsProvider in class ISeriesEditorParser
Since:
6.0.1 //SE23218

terminateParser

public void terminateParser()
When parsing is disabled, turn off document listeners

Overrides:
terminateParser in class ISeriesEditorParser
See Also:
com.ibm.lpex.core.LpexCommonParser#terminateParser()

cleanupMenu

public void cleanupMenu(ITextEditor editor,
                        IMenuManager menuManager)
Description copied from class: ISeriesEditorParser
Removes the Source and Compile menu items

subclasses which add other menus should subclass and call super

Specified by:
cleanupMenu in interface ISystemTextEditorContextContributor
Overrides:
cleanupMenu in class ISeriesEditorParser
See Also:
ISystemTextEditorContextContributor.cleanupMenu(ITextEditor, IMenuManager)

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.