mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-06-07 09:46:02 +02:00
Cosmetics.
This commit is contained in:
Sergey Prigogin
parent
97079f6ad0
commit
35044af3ee
1 changed files with 78 additions and 73 deletions
|
|
@ -42,26 +42,26 @@ public interface IASTNode {
|
|||
public static final IASTNode[] EMPTY_NODE_ARRAY = {};
|
||||
|
||||
/**
|
||||
* Get the translation unit (master) node that is the ancestor of all nodes
|
||||
* Returns the translation unit (master) node that is the ancestor of all nodes
|
||||
* in this AST.
|
||||
*
|
||||
* @return <code>IASTTranslationUnit</code>
|
||||
* @return {@code IASTTranslationUnit}
|
||||
*/
|
||||
public IASTTranslationUnit getTranslationUnit();
|
||||
|
||||
/**
|
||||
* Get the location of this node. In cases not involving macro expansions,
|
||||
* Returns the location of this node. In cases not involving macro expansions,
|
||||
* the IASTNodeLocation[] result will only have one element in it, and it
|
||||
* will be an IASTFileLocation.
|
||||
*
|
||||
* will be an {@link IASTFileLocation}.
|
||||
* <p>
|
||||
* Where the node is completely generated within a macro expansion,
|
||||
* IASTNodeLocation[] result will have one element in it, and it will be an
|
||||
* {@link IASTMacroExpansionLocation}.
|
||||
*
|
||||
* <p>
|
||||
* Nodes that span file context into a macro expansion (and potentially out
|
||||
* of the macro expansion again) result in an IASTNodeLocation[] result
|
||||
* that is of length > 1.
|
||||
*
|
||||
* <p>
|
||||
* We do not provide meaningful node locations for nested macro references
|
||||
* (see {@link IASTPreprocessorMacroExpansion#getNestedMacroReferences()}).
|
||||
* For those, the file location of the enclosing explicit macro reference is
|
||||
|
|
@ -75,18 +75,18 @@ public interface IASTNode {
|
|||
* the location of the expansion is returned. In case the node spans multiple files the location
|
||||
* will be in a common root file and will contain the appropriate include directives.
|
||||
* <p>
|
||||
* The method may return <code>null</code> in case the node does not have a file-location. This
|
||||
* The method may return {@code null} in case the node does not have a file-location. This
|
||||
* is for instance the case for built-in macro names or empty names for anonymous type
|
||||
* declarations.
|
||||
*
|
||||
* @return the mapped file location or <code>null</code>.
|
||||
* @return the mapped file location or {@code null}.
|
||||
*/
|
||||
public IASTFileLocation getFileLocation();
|
||||
|
||||
/**
|
||||
* Lightweight check for understanding what file we are in.
|
||||
*
|
||||
* @return <code>String</code> absolute path
|
||||
* @return {@code String} absolute path
|
||||
*/
|
||||
public String getContainingFilename();
|
||||
|
||||
|
|
@ -97,9 +97,7 @@ public interface IASTNode {
|
|||
public boolean isPartOfTranslationUnitFile();
|
||||
|
||||
/**
|
||||
* Get the parent node of this node in the tree.
|
||||
*
|
||||
* @return the parent node of this node
|
||||
* Returns the parent node of this node in the tree.
|
||||
*/
|
||||
public IASTNode getParent();
|
||||
|
||||
|
|
@ -110,23 +108,21 @@ public interface IASTNode {
|
|||
IASTNode[] getChildren();
|
||||
|
||||
/**
|
||||
* Set the parent node of this node in the tree.
|
||||
* Sets the parent node of this node in the tree.
|
||||
*
|
||||
* @param node
|
||||
* <code>IASTNode</code>
|
||||
* @param node {@code IASTNode}
|
||||
*/
|
||||
public void setParent(IASTNode node);
|
||||
|
||||
/**
|
||||
* In order to properly understand the relationship between this child node
|
||||
* and it's parent, a node property object is used.
|
||||
* Describes relationship between this child node and it's parent.
|
||||
*
|
||||
* @return <code>ASTNodeProperty</code>
|
||||
* @return {@code ASTNodeProperty}
|
||||
*/
|
||||
public ASTNodeProperty getPropertyInParent();
|
||||
|
||||
/**
|
||||
* Set the parent property of the node.
|
||||
* Sets the parent property of the node.
|
||||
*
|
||||
* @param property
|
||||
*/
|
||||
|
|
@ -134,7 +130,7 @@ public interface IASTNode {
|
|||
|
||||
/**
|
||||
* Abstract method to be overridden by all subclasses. Necessary for
|
||||
* visitation of the tree using an <code>ASTVisitor</code>.
|
||||
* visitation of the tree using an {@code ASTVisitor}.
|
||||
*
|
||||
* @param visitor
|
||||
* @return continue on (true) or quit (false)
|
||||
|
|
@ -145,8 +141,11 @@ public interface IASTNode {
|
|||
* Returns the raw signature of the IASTNode before it is processed by the preprocessor.
|
||||
*
|
||||
* Example:
|
||||
* <pre>
|
||||
* #define ONE 1
|
||||
* int x=ONE; // getRawSignature() for this declaration would return "int x=ONE;"
|
||||
* </pre>
|
||||
*
|
||||
* @return the raw signature of the IASTNode before it is processed by the preprocessor
|
||||
*/
|
||||
public String getRawSignature();
|
||||
|
|
@ -154,6 +153,7 @@ public interface IASTNode {
|
|||
/**
|
||||
* Returns whether this node contains the given one. The decision is made
|
||||
* purely on location information and therefore the method is fast.
|
||||
*
|
||||
* @param node the node to check
|
||||
* @return whether this node contains the given one.
|
||||
* @since 4.0
|
||||
|
|
@ -165,7 +165,8 @@ public interface IASTNode {
|
|||
* beginning of the parent, if there is no left sibling). The tokens are obtained
|
||||
* from the lexer, no preprocessing is performed.
|
||||
* The offsets of the tokens are relative to the file-offset of this node.
|
||||
* <p> <b>Examples</b> looking at the condition of if-statements:
|
||||
* <p>
|
||||
* <b>Examples</b> looking at the condition of if-statements:
|
||||
* <pre>
|
||||
* #define IF if
|
||||
* #define IF_P if (
|
||||
|
|
@ -180,7 +181,8 @@ public interface IASTNode {
|
|||
* SEMI_IF (true) {} // throws ExpansionOverlapsBoundaryException
|
||||
* IF_COND // throws ExpansionOverlapsBoundaryException
|
||||
* </pre>
|
||||
* @return a chain of tokens or <code>null</code>, if there are none.
|
||||
*
|
||||
* @return a chain of tokens or {@code null}, if there are none.
|
||||
* @throws ExpansionOverlapsBoundaryException if one of the boundaries of the leading syntax is
|
||||
* overlapped by a macro-expansion.
|
||||
* @throws UnsupportedOperationException if invoked on preprocessor nodes, or nodes that are not
|
||||
|
|
@ -195,8 +197,10 @@ public interface IASTNode {
|
|||
* end of the parent, if there is no right sibling). The tokens are obtained from the lexer,
|
||||
* no preprocessing is performed.
|
||||
* The offsets of the tokens are relative to the file-offset of the end of this node.
|
||||
* <p> For examples see {@link #getLeadingSyntax()}.
|
||||
* @return a chain of tokens or <code>null</code>, if there are none.
|
||||
* <p>
|
||||
* For examples see {@link #getLeadingSyntax()}.
|
||||
*
|
||||
* @return a chain of tokens or {@code null}, if there are none.
|
||||
* @throws ExpansionOverlapsBoundaryException if one of the boundaries of the trailing syntax is
|
||||
* overlapped by a macro-expansion.
|
||||
* @throws UnsupportedOperationException if invoked on preprocessor nodes, or nodes that are not
|
||||
|
|
@ -209,8 +213,10 @@ public interface IASTNode {
|
|||
* Returns the tokens that make up this node. The tokens are obtained from the lexer,
|
||||
* no preprocessing is performed.
|
||||
* The offsets of the tokens are relative to the file-offset of the beginning of this node.
|
||||
* <p> For examples see {@link #getLeadingSyntax()}.
|
||||
* @return a chain of tokens or <code>null</code>, if there are none.
|
||||
* <p>
|
||||
* For examples see {@link #getLeadingSyntax()}.
|
||||
*
|
||||
* @return a chain of tokens or {@code null}, if there are none.
|
||||
* @throws ExpansionOverlapsBoundaryException if one of the boundaries of the node is
|
||||
* overlapped by a macro-expansion.
|
||||
* @throws UnsupportedOperationException if invoked on preprocessor nodes, or nodes that are not
|
||||
|
|
@ -235,18 +241,17 @@ public interface IASTNode {
|
|||
|
||||
/**
|
||||
* Returns a mutable copy of the tree rooted at this node. The following postconditions hold:
|
||||
*
|
||||
* <code>
|
||||
* <pre>
|
||||
* copy.getParent() == null
|
||||
* copy.getPropertyInParent() == null
|
||||
* copy.isFrozen() == false
|
||||
* </code>
|
||||
* </pre>
|
||||
*
|
||||
* Preprocessor nodes do not currently support being copied.
|
||||
*
|
||||
* Implicit name nodes are not copied, instead they can be regenerated if required.
|
||||
*
|
||||
* Calling this method is equivalent
|
||||
* <p>
|
||||
* Calling this method is equivalent to {@code copy(CopyStyle.withoutLocations)}.
|
||||
*
|
||||
* @since 5.1
|
||||
* @throws UnsupportedOperationException
|
||||
|
|
@ -257,11 +262,11 @@ public interface IASTNode {
|
|||
/**
|
||||
* Returns a mutable copy of the tree rooted at this node. The following postconditions hold:
|
||||
*
|
||||
* <code>
|
||||
* <pre>
|
||||
* copy.getParent() == null
|
||||
* copy.getPropertyInParent() == null
|
||||
* copy.isFrozen() == false
|
||||
* </code>
|
||||
* </pre>
|
||||
*
|
||||
* Preprocessor nodes do not currently support being copied.
|
||||
*
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue