org.povclipse2.editors.scanners

Class PovclipseProjectScanner

java.lang.Object

org.povclipse2.editors.scanners.PovclipseProjectScanner

public class PovclipseProjectScanner
extends java.lang.Object

Manage a parsed representation of the entire project, starting at the root pov file spec'd in the .ini.

Author:

Dick Balaska

See Also:

gitweb

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MARKER_NONCOMPILED
static java.lang.String	MARKER_SDL_ERROR

Method Summary

Modifier and Type	Method and Description
PovClipseToken	findToken(java.lang.String name) Find this named token in the tree
static PovclipseProjectScanner	getInstance() Return the singleton instance of this class
PovClipseToken	getRootToken() Get the root token of the parsed tree
PovClipseToken	getToken(java.lang.String filePath) Get the root token of the named file (may be an include)
java.util.HashMap<java.lang.String,PovClipseToken>	getTree()
void	markInclude()
void	rescan(java.lang.String fileName, DirtyRegion dirtyRegion)
void	scanProject() Primary entry point to scan and tokenize a project
void	setActiveDocument(IniDocument iniDocument)
boolean	treeWalker(PovClipseToken parent, boolean walkIncludes, TreeWalkerFunc twFunc) Walk the parsed tree recursively, calling back for each token encountered.

Methods inherited from class java.lang.Object

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

Field Detail

MARKER_SDL_ERROR

public static final java.lang.String MARKER_SDL_ERROR

See Also:

Constant Field Values

MARKER_NONCOMPILED

public static final java.lang.String MARKER_NONCOMPILED

See Also:

Constant Field Values

Method Detail

getInstance

public static PovclipseProjectScanner getInstance()

Return the singleton instance of this class

Returns:

the one and only PovclipseProjectScanner

getTree

public java.util.HashMap<java.lang.String,PovClipseToken> getTree()

getToken

public PovClipseToken getToken(java.lang.String filePath)

Get the root token of the named file (may be an include)

Parameters:

filePath -

Returns:

setActiveDocument

public void setActiveDocument(IniDocument iniDocument)

getRootToken

public PovClipseToken getRootToken()

Get the root token of the parsed tree

Returns:

The root of the tree

findToken

public PovClipseToken findToken(java.lang.String name)

Find this named token in the tree

Parameters:

name - The name of the token we are looking for

Returns:

The found token or null if not found

rescan

public void rescan(java.lang.String fileName,
                   DirtyRegion dirtyRegion)

scanProject

public void scanProject()

Primary entry point to scan and tokenize a project

Parameters:

iniDocument - The ini file to parse

markInclude

public void markInclude()

treeWalker

public boolean treeWalker(PovClipseToken parent,
                          boolean walkIncludes,
                          TreeWalkerFunc twFunc)

Walk the parsed tree recursively, calling back for each token encountered. If the callback returns false, terminate walking.

Parameters:

parent - The token to start walking at.

twFunc - The callback function

Returns:

true to keep walking, false to terminate walking.