Package org.fife.ui.rsyntaxtextarea

Class RSyntaxDocument

java.lang.Object
javax.swing.text.AbstractDocument
javax.swing.text.PlainDocument
org.fife.ui.rtextarea.RDocument
org.fife.ui.rsyntaxtextarea.RSyntaxDocument
All Implemented Interfaces:
Serializable, Iterable<Token>, Document, SyntaxConstants
public class RSyntaxDocument extends RDocument implements Iterable<Token>, SyntaxConstants
The document used by RSyntaxTextArea. This document is like javax.swing.text.PlainDocument except that it also keeps track of syntax highlighting in the document. It has a "style" attribute associated with it that determines how syntax highlighting is done (i.e., what language is being highlighted).

Instances of RSyntaxTextArea will only accept instances of RSyntaxDocument, since it is this document that keeps track of syntax highlighting. All others will cause an exception to be thrown.

To change the language being syntax highlighted at any time, you merely have to call setSyntaxStyle(java.lang.String). Other than that, this document can be treated like any other save one caveat: all DocumentEvents of type CHANGE use their offset and length values to represent the first and last lines, respectively, that have had their syntax coloring change. This is really a hack to increase the speed of the painting code and should really be corrected, but oh well.

Version:
1.0
See Also:

  • Field Details

    • tokenMakerFactory

      private transient TokenMakerFactory tokenMakerFactory
      Creates a TokenMaker appropriate for a given programming language.

    • tokenMaker

      private transient TokenMaker tokenMaker
      Splits text into tokens for the current programming language.

    • syntaxStyle

      private String syntaxStyle
      The current syntax style. Only cached to keep this class serializable.

    • lastTokensOnLines

      protected transient DynamicIntArray lastTokensOnLines
      Array of values representing the "last token type" on each line. This is used in cases such as multi-line comments: if the previous line ended with an (unclosed) multi-line comment, we can use this knowledge and start the current line's syntax highlighting in multi-line comment state.

    • lastLine

      private transient int lastLine

    • cachedTokenList

      private transient Token cachedTokenList

    • useCacheCount

      private transient int useCacheCount

    • tokenRetrievalCount

      private transient int tokenRetrievalCount

    • s

      private transient Segment s

    • DEBUG_TOKEN_CACHING

      private static final boolean DEBUG_TOKEN_CACHING
      If this is set to true, debug information about how much token caching is helping is printed to stdout.
      See Also:

  • Constructor Details

    • RSyntaxDocument

      public RSyntaxDocument(String syntaxStyle)
      Constructs a plain text document. A default root element is created, and the tab size set to 5.
      Parameters:
      syntaxStyle - The syntax highlighting scheme to use.

    • RSyntaxDocument

      public RSyntaxDocument(TokenMakerFactory tmf, String syntaxStyle)
      Constructs a plain text document. A default root element is created, and the tab size set to 5.
      Parameters:
      tmf - The TokenMakerFactory for this document. If this is null, a default factory is used.
      syntaxStyle - The syntax highlighting scheme to use.

  • Method Details

    • fireInsertUpdate

      protected void fireInsertUpdate(DocumentEvent e)
      Alerts all listeners to this document of an insertion. This is overridden so we can update our syntax highlighting stuff.

      The syntax highlighting stuff has to be here instead of in insertUpdate because insertUpdate is not called by the undo/redo actions, but this method is.

      Overrides:
      fireInsertUpdate in class AbstractDocument
      Parameters:
      e - The change.

    • fireRemoveUpdate

      protected void fireRemoveUpdate(DocumentEvent chng)
      This method is called AFTER the content has been inserted into the document and the element structure has been updated.

      The syntax-highlighting updates need to be done here (as opposed to an override of postRemoveUpdate) as this method is called in response to undo/redo events, whereas postRemoveUpdate is not.

      Now that the text is actually inserted into the content and element structure, we can update our token elements and "last tokens on lines" structure.

      Overrides:
      fireRemoveUpdate in class AbstractDocument
      Parameters:
      chng - The change that occurred.
      See Also:

    • getClosestStandardTokenTypeForInternalType

      public int getClosestStandardTokenTypeForInternalType(int type)
      Returns the closest "standard" token type for a given "internal" token type (e.g. one whose value is < 0).
      Parameters:
      type - The token type.
      Returns:
      The closest "standard" token type. If a mapping is not defined for this language, then type is returned.

    • getCompleteMarkupCloseTags

      public boolean getCompleteMarkupCloseTags()
      Returns whether closing markup tags should be automatically completed. This method only returns true if getLanguageIsMarkup() also returns true.
      Returns:
      Whether markup closing tags should be automatically completed.
      See Also:

    • getCurlyBracesDenoteCodeBlocks

      public boolean getCurlyBracesDenoteCodeBlocks(int languageIndex)
      Returns whether the current programming language uses curly braces ('{' and '}') to denote code blocks.
      Parameters:
      languageIndex - The language index at the offset in question. Since some TokenMakers effectively have nested languages (such as JavaScript in HTML), this parameter tells the TokenMaker what sub-language to look at.
      Returns:
      Whether curly braces denote code blocks.

    • getLanguageIsMarkup

      public boolean getLanguageIsMarkup()
      Returns whether the current language is a markup language, such as HTML, XML or PHP.
      Returns:
      Whether the current language is a markup language.

    • getLastTokenTypeOnLine

      public int getLastTokenTypeOnLine(int line)
      Returns the token type of the last token on the given line.
      Parameters:
      line - The line to inspect.
      Returns:
      The token type of the last token on the specified line. If the line is invalid, an exception is thrown.

    • getLineCommentStartAndEnd

      public String[] getLineCommentStartAndEnd(int languageIndex)
      Returns the text to place at the beginning and end of a line to "comment" it in this programming language.
      Parameters:
      languageIndex - The language index to get comment information for.
      Returns:
      The start and end strings to add to a line to "comment" it out. A null value for either means there is no string to add for that part. A value of null for the array means this language does not support commenting/uncommenting lines.

    • getMarkOccurrencesOfTokenType

      boolean getMarkOccurrencesOfTokenType(int type)
      Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language.
      Parameters:
      type - The token type.
      Returns:
      Whether tokens of this type should have "mark occurrences" enabled.

    • getOccurrenceMarker

      OccurrenceMarker getOccurrenceMarker()
      Returns the occurrence marker for the current language.
      Returns:
      The occurrence marker.

    • getShouldIndentNextLine

      public boolean getShouldIndentNextLine(int line)
      This method returns whether auto indentation should be done if Enter is pressed at the end of the specified line.
      Parameters:
      line - The line to check.
      Returns:
      Whether an extra indentation should be done.

    • getSyntaxStyle

      public String getSyntaxStyle()
      Returns the syntax style being used.
      Returns:
      The syntax style.
      See Also:

    • getTokenListForLine

      public Token getTokenListForLine(int line)
      Returns a token list for the specified segment of text representing the specified line number. This method is basically a wrapper for tokenMaker.getTokenList that takes into account the last token on the previous line to assure token accuracy.
      Parameters:
      line - The line number of text in the document, >= 0.
      Returns:
      A token list representing the specified line.

    • insertBreakSpecialHandling

      boolean insertBreakSpecialHandling(ActionEvent e)

    • isIdentifierChar

      public boolean isIdentifierChar(int languageIndex, char ch)
      Returns whether a character could be part of an "identifier" token in a specific language. This is used to identify such things as the bounds of the "word" to select on double-clicking.
      Parameters:
      languageIndex - The language index the character was found in.
      ch - The character.
      Returns:
      Whether the character could be part of an "identifier" token.

    • iterator

      public Iterator<Token> iterator()
      Returns an iterator over the paintable tokens in this document. Results are undefined if this document is modified while the iterator is being iterated through, so this should only be used on the EDT.

      The remove() method of the returned iterator will throw an UnsupportedOperationException.

      Specified by:
      iterator in interface Iterable<Token>
      Returns:
      An iterator.

    • readObject

      private void readObject(ObjectInputStream in) throws ClassNotFoundException, IOException
      Deserializes a document.
      Parameters:
      in - The stream to read from.
      Throws:
      ClassNotFoundException - If an unexpected error occurs.
      IOException - If an IO error occurs.

    • setSharedSegment

      private void setSharedSegment(int line)
      Makes our private Segment s point to the text in our document referenced by the specified element. Note that line MUST be a valid line number in the document.
      Parameters:
      line - The line number you want to get.

    • setSyntaxStyle

      public void setSyntaxStyle(String styleKey)
      Sets the syntax style being used for syntax highlighting in this document. What styles are supported by a document is determined by its TokenMakerFactory. By default, all RSyntaxDocuments support all languages built into RSyntaxTextArea.
      Parameters:
      styleKey - The new style to use, such as SyntaxConstants.SYNTAX_STYLE_JAVA. If this style is not known or supported by this document, then SyntaxConstants.SYNTAX_STYLE_NONE is used.
      See Also:

    • setSyntaxStyle

      public void setSyntaxStyle(TokenMaker tokenMaker)
      Sets the syntax style being used for syntax highlighting in this document. You should call this method if you've created a custom token maker for a language not normally supported by RSyntaxTextArea.
      Parameters:
      tokenMaker - The new token maker to use.
      See Also:

    • setTokenMakerFactory

      public void setTokenMakerFactory(TokenMakerFactory tmf)
      Sets the token maker factory used by this document.
      Parameters:
      tmf - The TokenMakerFactory for this document. If this is null, a default factory is used.

    • updateLastTokensBelow

      private int updateLastTokensBelow(int line, int numLines, int previousTokenType)
      Loops through the last-tokens-on-lines array from a specified point onward, updating last-token values until they stop changing. This should be called when lines are updated/inserted/removed, as doing so may cause lines below to change color.
      Parameters:
      line - The first line to check for a change in last-token value.
      numLines - The number of lines in the document.
      previousTokenType - The last-token value of the line just before line.
      Returns:
      The last line that needs repainting.

    • updateSyntaxHighlightingInformation

      private void updateSyntaxHighlightingInformation()
      Updates internal state information; e.g. the "last tokens on lines" data. After this, a changed update is fired to let listeners know that the document's structure has changed.

      This is called internally whenever the syntax style changes.