org.eclipse.cdt.internal.ui.text
Class AbstractCScanner

java.lang.Object
  extended by org.eclipse.jface.text.rules.RuleBasedScanner
      extended by org.eclipse.jface.text.rules.BufferedRuleBasedScanner
          extended by org.eclipse.cdt.internal.ui.text.AbstractCScanner
All Implemented Interfaces:
org.eclipse.jface.text.rules.ICharacterScanner, org.eclipse.jface.text.rules.ITokenScanner
Direct Known Subclasses:
AsmCodeScanner, AsmPreprocessorScanner, CCodeScanner, CCommentScanner, CPreprocessorScanner, SingleTokenCScanner

public abstract class AbstractCScanner
extends org.eclipse.jface.text.rules.BufferedRuleBasedScanner

Initialized with a color manager and a preference store, its subclasses are only responsible for providing a list of preference keys for based on which tokens are generated and to use this tokens to define the rules controlling this scanner.

This scanner stores the color defined by the color preference key into the color manager under the same key.

Preference color key + PreferenceConstants.EDITOR_BOLD_SUFFIX are used to retrieve whether the token is rendered in bold.

Preference color key + PreferenceConstants.EDITOR_ITALIC_SUFFIX are used to retrieve whether the token is rendered in italic.

Preference color key + PreferenceConstants.EDITOR_STRIKETHROUGH_SUFFIX are used to retrieve whether the token is rendered in strikethrough.

Preference color key + PreferenceConstants.EDITOR_UNDERLINE_SUFFIX are used to retrieve whether the token is rendered in underline.


Field Summary
 
Fields inherited from interface org.eclipse.jface.text.rules.ICharacterScanner
EOF
 
Constructor Summary
AbstractCScanner(IColorManager manager, org.eclipse.jface.preference.IPreferenceStore store)
          Creates an abstract C scanner.
AbstractCScanner(IColorManager manager, org.eclipse.jface.preference.IPreferenceStore store, int bufsize)
          Creates an abstract C scanner.
 
Method Summary
 void adaptToPreferenceChange(org.eclipse.jface.util.PropertyChangeEvent event)
           
 boolean affectsBehavior(org.eclipse.jface.util.PropertyChangeEvent event)
           
 void initialize()
          Must be called after the constructor has been called.
 org.eclipse.jface.text.rules.IToken nextToken()
           
 
Methods inherited from class org.eclipse.jface.text.rules.BufferedRuleBasedScanner
read, setRange, unread
 
Methods inherited from class org.eclipse.jface.text.rules.RuleBasedScanner
getColumn, getLegalLineDelimiters, getTokenLength, getTokenOffset, setDefaultReturnToken, setRules
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractCScanner

public AbstractCScanner(IColorManager manager,
                        org.eclipse.jface.preference.IPreferenceStore store)
Creates an abstract C scanner.


AbstractCScanner

public AbstractCScanner(IColorManager manager,
                        org.eclipse.jface.preference.IPreferenceStore store,
                        int bufsize)
Creates an abstract C scanner.

Method Detail

initialize

public final void initialize()
Must be called after the constructor has been called.


nextToken

public org.eclipse.jface.text.rules.IToken nextToken()
Specified by:
nextToken in interface org.eclipse.jface.text.rules.ITokenScanner
Overrides:
nextToken in class org.eclipse.jface.text.rules.RuleBasedScanner

affectsBehavior

public boolean affectsBehavior(org.eclipse.jface.util.PropertyChangeEvent event)

adaptToPreferenceChange

public void adaptToPreferenceChange(org.eclipse.jface.util.PropertyChangeEvent event)