org.povclipse2.utils

Class DocumentUtils

java.lang.Object

org.povclipse2.utils.DocumentUtils

public class DocumentUtils
extends java.lang.Object

Utility class for IDocument related isues.

Author:

Wolfgang Möstl

Constructor Summary

Constructors

Constructor and Description
DocumentUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDocumentation(IDocument doc, int offset, boolean includeSpezification, java.lang.Character endToken) Gets the documentation prior to the given offset within the document.
static java.lang.String	getIndent(IDocument doc, int offset)
static int	getIndexOfNextNonCommentAndWhitespaceCharacter(IDocument doc, int offset) Returns the index of next character beeing not commented or a whitespace.
static int	getIndexOfPrevNonCommentAndWhitespaceCharacter(IDocument doc, int offset) Returns the index of prvious character beeing not commented or a whitespace. Note: the End.of-line comment style (//) is not supported, just the / * ...
static int	getNextCharacterOccurrence(IDocument doc, int offset, char c) Finds the very next character occurrence within the document, begining at offset.
static TokenData	getNextNonCommentToken(IDocument doc, int offset) Returns the next non-comment token.
static char	getNextNonWhitespaceCharacter(IDocument doc, int offset) Gets the next non-whitespace character from the document.
static int	getPrevCharacterOccurrence(IDocument doc, int offset, char c)
static TokenData	getPrevNonCommentToken(IDocument doc, int offset) Returns the previous non-comment token.
static boolean	isNextNonWhitespaceChar(IDocument doc, int offset, char c) Is the next non-whitespace character in the document one of these? This method is used when a MACRO_USE is detected and we want to know if there are parameters to the macro
static boolean	isNextTokenClosingBracket(IDocument doc, int offset)
static boolean	isPrevTokenOpeningBracket(IDocument doc, int offset)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentUtils

public DocumentUtils()

Method Detail

getDocumentation

public static java.lang.String getDocumentation(IDocument doc,
                                                int offset,
                                                boolean includeSpezification,
                                                java.lang.Character endToken)

Gets the documentation prior to the given offset within the document.

Parameters:

doc - The IDocument to process

offset - The offset within the document to start with. The processing is done reverse, thus nothing AFTER the offset will be found!

includeSpezification - If true everything from the offset until the very first occurence of the endToken is added to the return.

endToken - Only used if includeSpezification is true, see above.

Returns:

See above

getNextNonCommentToken

public static TokenData getNextNonCommentToken(IDocument doc,
                                               int offset)

Returns the next non-comment token.

Parameters:

doc - The document to work on

offset - The offset to start with

Returns:

The very fist non-comment token searching the document forward, beginning with the given offset, never null.

getPrevNonCommentToken

public static TokenData getPrevNonCommentToken(IDocument doc,
                                               int offset)

Returns the previous non-comment token.

Parameters:

doc - The document to work on

offset - The offset to start with

Returns:

The very fist non-comment token searching the document backwards, beginning with the given offset, never null.

isNextTokenClosingBracket

public static boolean isNextTokenClosingBracket(IDocument doc,
                                                int offset)

isPrevTokenOpeningBracket

public static boolean isPrevTokenOpeningBracket(IDocument doc,
                                                int offset)

getIndexOfNextNonCommentAndWhitespaceCharacter

public static int getIndexOfNextNonCommentAndWhitespaceCharacter(IDocument doc,
                                                                 int offset)

Returns the index of next character beeing not commented or a whitespace.

Parameters:

doc - The document to process

offset - The offset to start with

Returns:

The index of the next non-whitespace character beginning with offset, or -1 if non could be found.

getIndexOfPrevNonCommentAndWhitespaceCharacter

public static int getIndexOfPrevNonCommentAndWhitespaceCharacter(IDocument doc,
                                                                 int offset)

Returns the index of prvious character beeing not commented or a whitespace.
Note: the End.of-line comment style (//) is not supported, just the / * ... * / style is recognized!

Parameters:

doc - The document to process

offset - The offset to start with

Returns:

The index of the previous non-whitespace character beginning with offset, or -1 if non could be found.

getNextCharacterOccurrence

public static int getNextCharacterOccurrence(IDocument doc,
                                             int offset,
                                             char c)

Finds the very next character occurrence within the document, begining at offset.

Parameters:

doc - The document to be preocessed

offset - The offset to start processing with

c - The character to be found

Returns:

The offset of the very next character c or -1 if no character could be found til the end of the document.

getPrevCharacterOccurrence

public static int getPrevCharacterOccurrence(IDocument doc,
                                             int offset,
                                             char c)

isNextNonWhitespaceChar

public static boolean isNextNonWhitespaceChar(IDocument doc,
                                              int offset,
                                              char c)

Is the next non-whitespace character in the document one of these?
This method is used when a MACRO_USE is detected and we want to know if there are parameters to the macro

Parameters:

doc - The IDocument to check

offset - The current offset into the IDocument to start checking at

c - The character to check for.

Returns:

true if the next non-whitespace character is a #c

getNextNonWhitespaceCharacter

public static char getNextNonWhitespaceCharacter(IDocument doc,
                                                 int offset)
                                          throws BadLocationException

Gets the next non-whitespace character from the document.

Parameters:

doc - The document to operate on.

offset - The offset to start with

Returns:

The very next non-whitespace character.

Throws:

BadLocationException - If no non-whitespace character could be found.

getIndent

public static java.lang.String getIndent(IDocument doc,
                                         int offset)