com.ibm.systemz.common.editor.extensionpoints.preprocessor
Interface IPreprocessorBehavior


public interface IPreprocessorBehavior

Interface for the 'Editor Preprocessor Behavior' extension point's behavior. Contributions to the com.ibm.systemz.editor.preprocessorBehavior extension point must implement this interface.


Method Summary
 java.util.Map<org.eclipse.jface.text.source.ILineRange,java.lang.String> getPreprocessorTransformations(org.eclipse.core.resources.IFile file, org.eclipse.jface.text.IDocument document, org.eclipse.core.runtime.IProgressMonitor monitor)
          Returns a mapping of line ranges in the document to text output by a preprocessor.
 

Method Detail

getPreprocessorTransformations

java.util.Map<org.eclipse.jface.text.source.ILineRange,java.lang.String> getPreprocessorTransformations(org.eclipse.core.resources.IFile file,
                                                                                                        org.eclipse.jface.text.IDocument document,
                                                                                                        org.eclipse.core.runtime.IProgressMonitor monitor)
Returns a mapping of line ranges in the document to text output by a preprocessor. Each line range represents a point where text will be inserted into the document by the preprocessor. The String value represents the text the preprocessor will insert at the start of the line range. This string may be the empty string. The number of lines in the range indicate the number of lines of text that will be over-written by the preprocessor transformation. If it is 0, then no text will be removed from the original document, and instead any new preprocessor output will be inserted at the start of the line range.

Parameters:
file -
document -
monitor -
Returns:
mapping of line ranges to preprocessor output text