eu.cqse.check.util.clang

Class ClangTranslationUnitWrapper

java.lang.Object

eu.cqse.check.util.clang.ClangTranslationUnitWrapper

public class ClangTranslationUnitWrapper
extends java.lang.Object

Wrapper for the CXIndex type in Clang. This wrapper implements disposing the index (freeing the memory) when this Object is garbage collected.

An "index" that consists of a set of translation units that would typically be linked together into an executable or library.

Method Summary

Modifier and Type	Method and Description
static ClangTranslationUnitWrapper	createForContext(ITokenElementContext context) Creates a ClangTranslationUnitWrapper based on the given ITokenElementContext.
static ClangTranslationUnitWrapper	createForText(java.lang.String uniformPath, java.lang.String text) Creates a ClangTranslationUnitWrapper based on the given uniform path and text content.
void	dispose() Allows to explicitly dispose this wrapper and free native memory.
protected void	finalize()
eu.cqse.clang.CXCursor	getMainRootCursor() Returns a new CXCursor pointing at the root node of the current translation unit (getMainTranslationUnit()).
eu.cqse.clang.SWIGTYPE_p_CXTranslationUnitImpl	getMainTranslationUnit() Returns the current file parsed by clang.

Methods inherited from class java.lang.Object

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

Method Detail

getMainTranslationUnit

public eu.cqse.clang.SWIGTYPE_p_CXTranslationUnitImpl getMainTranslationUnit()

Returns the current file parsed by clang. The clang index might contain more than one file (header files) which maybe lead to more than one translation unit known to clang. This is the translation unit corresponding to the file referenced in the current ICheckContext.

createForContext

public static ClangTranslationUnitWrapper createForContext(ITokenElementContext context)
                                                    throws ConQATException

Creates a ClangTranslationUnitWrapper based on the given ITokenElementContext. This means the text content of the context is parsed by clang.

Throws:

ConQATException

createForText

public static ClangTranslationUnitWrapper createForText(java.lang.String uniformPath,
                                                        java.lang.String text)
                                                 throws ConQATException

Creates a ClangTranslationUnitWrapper based on the given uniform path and text content.

Throws:

ConQATException

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

dispose

public void dispose()

Allows to explicitly dispose this wrapper and free native memory. This can be used to avoid the need to wait for the garbage collector, when the instance is no longer needed.

getMainRootCursor

public eu.cqse.clang.CXCursor getMainRootCursor()

Returns a new CXCursor pointing at the root node of the current translation unit (getMainTranslationUnit()).