org.povclipse2.editors.processors

Class PovrayDeclarationProcessor

java.lang.Object

org.povclipse2.editors.processors.PovrayDeclarationProcessor

Deprecated.

public class PovrayDeclarationProcessor
extends java.lang.Object

Processor for extracting declarations from the Povray code.

Include files are taken into account when searching for known declarations. The following search order is used:

1. Within the actual project
2. Within the library path (maining the library path entry order)
3. Try an absolut file path

Author:

Wolfgang Möstl

See Also:

gitweb

Constructor Summary

Constructors

Constructor and Description
PovrayDeclarationProcessor() Deprecated. Constructor

Method Summary

Modifier and Type	Method and Description
ICompletionProposal[]	computeDeclarationProposals(IFile file, IRegion region, ImageRegistry imgReg, java.lang.String match, boolean recurseInto) Deprecated. Gets a list of completion proposals for declared objects and variables.
ICompletionProposal[]	computeDeclarationProposals(ITextViewer viewer, IRegion region, ImageRegistry imgReg, java.lang.String match) Deprecated. Gets a list of completion proposals for declared objects and variables.
java.util.Set<DeclEntry>	getDeclEntries(IFile file, boolean includeInterfaceParameter, boolean recurseInto) Deprecated. Gets a list of DeclEntry objects, each representing a declared objects or variables.
java.util.Set<DeclEntry>	getIncludes(java.io.File file, java.util.Set<DeclEntry> includes, java.util.List<java.lang.String> processedFiles, java.lang.String match, IProject project, boolean includeInterfaceParameter, boolean recurseInto, int recursionLevel) Deprecated. Gets the list of the names for declared objects and variables.

Methods inherited from class java.lang.Object

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

Constructor Detail

PovrayDeclarationProcessor

public PovrayDeclarationProcessor()

Deprecated.

Constructor

Method Detail

getDeclEntries

public java.util.Set<DeclEntry> getDeclEntries(IFile file,
                                               boolean includeInterfaceParameter,
                                               boolean recurseInto)

Deprecated.

Gets a list of DeclEntry objects, each representing a declared objects or variables. From the beginning file on, all include files are taken into account as well, as long as they reside either within the viewer's project, referenced projects or can be found within the Povray library path, absolute specified files will be processed as well.

Parameters:

file - The IFile to start with.

includeInterfaceParameter - true to include macro interface parameter, false to ignore them.

recurseInto - true to include imported files (follow the #include statements), false to process just this file.

Returns:

A List of DeclEntry objects.

computeDeclarationProposals

public ICompletionProposal[] computeDeclarationProposals(ITextViewer viewer,
                                                         IRegion region,
                                                         ImageRegistry imgReg,
                                                         java.lang.String match)

Deprecated.

Gets a list of completion proposals for declared objects and variables. From the beginning document on, all include files are taken into account as well, as long as they reside eiter within the viewers project, referenced projects or can be found within the Povray library path, absolut specified files will be processed as well.

Parameters:

viewer - The viewer of the actual document.

region - The selection region

imgReg - The image registry holding the icons

match - If not-empty only declarations beginning with this String are returned.

Returns:

A array of ICompletionProposal objects.

computeDeclarationProposals

public ICompletionProposal[] computeDeclarationProposals(IFile file,
                                                         IRegion region,
                                                         ImageRegistry imgReg,
                                                         java.lang.String match,
                                                         boolean recurseInto)

Deprecated.

Gets a list of completion proposals for declared objects and variables. From the beginning file on, all include files are taken into account as well, as long as they reside eiter within the viewers project, referenced projects or can be found within the Povray library path, absolut specified files will be processed as well.

Parameters:

file - The IFile to start with.

region - The selection region

imgReg - The image registry holding the icons

match - If not-empty only declarations beginning with this String are returned.

recurseInto - true to include imported files (follow the #include statements), false to process just this file.

Returns:

A array of ICompletionProposal objects.

getIncludes

public java.util.Set<DeclEntry> getIncludes(java.io.File file,
                                            java.util.Set<DeclEntry> includes,
                                            java.util.List<java.lang.String> processedFiles,
                                            java.lang.String match,
                                            IProject project,
                                            boolean includeInterfaceParameter,
                                            boolean recurseInto,
                                            int recursionLevel)

Deprecated.

Gets the list of the names for declared objects and variables. From the beginning file on, all include files are taken into account as well, as long as they reside either within the specified project, referenced projects or can be found within the Povray library path, absolut specified files will be processed as well.

Parameters:

file - The file to be processed

includes - The declared names found so far

processedFiles - List of String, each one beeing the absolute path of already processed files, used for preventing double-processing of the very same file as well as cyclic processing.

match - If not-empty only declarations beginning with this String are returned.

project - The project of the starting document.

includeInterfaceParameter - true to include macro interface parameter, false to ignore them.

recurseInto - true to include imported files (follow the #include statements), false to process just this file.

recursionLevel - The actual recursion level, only utilized if recurseInto is true.

Returns: