From f4f320853448aeabd8fd6dac326cb4a38ac48a68 Mon Sep 17 00:00:00 2001 From: John Camelon Date: Fri, 11 Mar 2005 16:00:31 +0000 Subject: [PATCH] Add JavaDoc. --- .../dom/ast/IASTParameterDeclaration.java | 31 ++++++++++++++++--- .../eclipse/cdt/core/dom/ast/IASTPointer.java | 20 ++++++++++++ .../cdt/core/dom/ast/IASTPointerOperator.java | 3 ++ .../ast/IASTPreprocessorElifStatement.java | 7 +++++ .../ast/IASTPreprocessorElseStatement.java | 6 ++++ .../ast/IASTPreprocessorEndifStatement.java | 1 + .../ast/IASTPreprocessorErrorStatement.java | 2 ++ ...processorFunctionStyleMacroDefinition.java | 26 +++++++++++++--- .../dom/ast/IASTPreprocessorIfStatement.java | 6 ++++ .../ast/IASTPreprocessorIfdefStatement.java | 5 +++ .../ast/IASTPreprocessorIfndefStatement.java | 6 ++++ .../ast/IASTPreprocessorIncludeStatement.java | 11 +++++-- .../ast/IASTPreprocessorMacroDefinition.java | 23 ++++++++++++++ ...reprocessorObjectStyleMacroDefinition.java | 3 ++ .../ast/IASTPreprocessorPragmaStatement.java | 2 ++ .../ast/IASTPreprocessorSelectionResult.java | 24 -------------- .../dom/ast/IASTPreprocessorStatement.java | 2 ++ .../ast/IASTPreprocessorUndefStatement.java | 2 ++ .../core/dom/ast/IASTProblemDeclaration.java | 2 ++ .../core/dom/ast/IASTProblemExpression.java | 2 ++ .../cdt/core/dom/ast/IASTProblemHolder.java | 15 +++++++++ .../core/dom/ast/IASTProblemStatement.java | 1 + .../cdt/core/dom/ast/IASTProblemTypeId.java | 2 ++ .../ASTPreprocessorSelectionResult.java | 3 +- .../dom/parser/c/CASTTranslationUnit.java | 4 +-- .../dom/parser/cpp/CPPASTTranslationUnit.java | 4 +-- .../parser/scanner2/ILocationResolver.java | 6 ++-- .../core/parser/scanner2/LocationMap.java | 9 +++--- 28 files changed, 178 insertions(+), 50 deletions(-) delete mode 100644 core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorSelectionResult.java diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTParameterDeclaration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTParameterDeclaration.java index b41a70b8cca..3dff0968a54 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTParameterDeclaration.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTParameterDeclaration.java @@ -16,22 +16,45 @@ package org.eclipse.cdt.core.dom.ast; * @author Doug Schaefer */ public interface IASTParameterDeclaration extends IASTNode { + /** + * Constant/sentinel. + */ public static final IASTParameterDeclaration [] EMPTY_PARAMETERDECLARATION_ARRAY = new IASTParameterDeclaration[0]; - ASTNodeProperty DECL_SPECIFIER = new ASTNodeProperty( "Decl Specifier"); //$NON-NLS-1$ - ASTNodeProperty DECLARATOR = new ASTNodeProperty( "Declarator"); //$NON-NLS-1$ + /** + * DECL_SPECIFIER represents the relationship between an IASTParameterDeclaration and its nested IASTDeclSpecifier. + */ + public static final ASTNodeProperty DECL_SPECIFIER = new ASTNodeProperty( "Decl Specifier"); //$NON-NLS-1$ + /** + * DECLARATOR represents the relationship between an IASTParameterDeclaration and its nested IASTDeclarator. + */ + public static final ASTNodeProperty DECLARATOR = new ASTNodeProperty( "Declarator"); //$NON-NLS-1$ + /** + * Get the decl specifier. + * + * @return IASTDeclSpecifier + */ public IASTDeclSpecifier getDeclSpecifier(); + /** + * Get the declarator. + * + * @return IASTDeclarator + */ public IASTDeclarator getDeclarator(); /** - * @param declSpec + * Set the decl specifier. + * + * @param declSpec IASTDeclSpecifier. */ public void setDeclSpecifier(IASTDeclSpecifier declSpec); /** - * @param declarator2 + * Set the declarator. + * + * @param declarator IASTDeclarator */ public void setDeclarator(IASTDeclarator declarator); diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPointer.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPointer.java index 7e2e4202132..b68d4f71be0 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPointer.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPointer.java @@ -18,10 +18,30 @@ package org.eclipse.cdt.core.dom.ast; public interface IASTPointer extends IASTPointerOperator { // Qualifiers applied to the pointer type + /** + * Is this a const pointer? + * + * @return boolean + */ public boolean isConst(); + /** + * Is this a volatile pointer? + * + * @return boolean + */ public boolean isVolatile(); + /** + * Set this to be a const pointer (true/false). + * + * @param value - the value + */ public void setConst( boolean value ); + /** + * Set this to be a volatile pointer (true/false). + * + * @param value - the value + */ public void setVolatile( boolean value ); } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPointerOperator.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPointerOperator.java index 73be490a7f6..a5631c9d051 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPointerOperator.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPointerOperator.java @@ -15,6 +15,9 @@ package org.eclipse.cdt.core.dom.ast; */ public interface IASTPointerOperator extends IASTNode { + /** + * Constant/sentinel. + */ public static final IASTPointerOperator[] EMPTY_ARRAY = new IASTPointerOperator[0]; } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorElifStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorElifStatement.java index ac07ca31e6c..fcaa2f17aec 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorElifStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorElifStatement.java @@ -11,10 +11,17 @@ package org.eclipse.cdt.core.dom.ast; /** + * Represents a #elif preprocessor statement. + * * @author jcamelon */ public interface IASTPreprocessorElifStatement extends IASTPreprocessorStatement { + /** + * Was this #elif branch taken? + * + * @return boolean + */ public boolean taken(); } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorElseStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorElseStatement.java index c4691b3e242..40824eb2ada 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorElseStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorElseStatement.java @@ -11,9 +11,15 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represent a preprocessor #else statement. + * * @author jcamelon */ public interface IASTPreprocessorElseStatement extends IASTPreprocessorStatement { + /** + * Was this #else branch taken? + * @return boolean + */ public boolean taken(); } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorEndifStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorEndifStatement.java index 79db00be6f9..8093a62bedb 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorEndifStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorEndifStatement.java @@ -11,6 +11,7 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represent a preprocessor #endif statement. * @author jcamelon */ public interface IASTPreprocessorEndifStatement extends IASTPreprocessorStatement{ diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorErrorStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorErrorStatement.java index 6af4e2e288a..09e734042db 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorErrorStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorErrorStatement.java @@ -11,6 +11,8 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represent a preprocessor #error statement. + * * @author jcamelon */ public interface IASTPreprocessorErrorStatement extends diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorFunctionStyleMacroDefinition.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorFunctionStyleMacroDefinition.java index 7fed337642c..69a50c20f33 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorFunctionStyleMacroDefinition.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorFunctionStyleMacroDefinition.java @@ -11,16 +11,32 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represent a preprocessor function-style macro definition. e.g. + * #define ABC( def ) GHI + * * @author jcamelon */ public interface IASTPreprocessorFunctionStyleMacroDefinition extends - IASTPreprocessorMacroDefinition { + IASTPreprocessorMacroDefinition { - public static final ASTNodeProperty PARAMETER = new ASTNodeProperty( - "Function Macro Parameter"); //$NON-NLS-1$ + /** + * This property represents the relationship between a function style macro definition and one of its parameters. + */ + public static final ASTNodeProperty PARAMETER = new ASTNodeProperty( + "Function Macro Parameter"); //$NON-NLS-1$ - public IASTFunctionStyleMacroParameter[] getParameters(); + /** + * Get the macro parameters. + * + * @return IASTFunctionStyleMacroParameter[] parameters + */ + public IASTFunctionStyleMacroParameter[] getParameters(); - public void addParameter(IASTFunctionStyleMacroParameter parm); + /** + * Add a function-style macro parameter. + * + * @param parm IASTFunctionStyleMacroParameter + */ + public void addParameter(IASTFunctionStyleMacroParameter parm); } \ No newline at end of file diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfStatement.java index 20cb37a4db3..a72149e5ae5 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfStatement.java @@ -11,9 +11,15 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represent a preprocessor #if statement. * @author jcamelon */ public interface IASTPreprocessorIfStatement extends IASTPreprocessorStatement { + /** + * Was this branch taken? + * + * @return boolean + */ public boolean taken(); } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfdefStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfdefStatement.java index 4f26923117e..3838a52f264 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfdefStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfdefStatement.java @@ -11,9 +11,14 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represent a preprocessor #ifdef statement. * @author jcamelon */ public interface IASTPreprocessorIfdefStatement extends IASTPreprocessorStatement { + /** + * Was this #ifdef branch taken? + * @return + */ public boolean taken(); } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfndefStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfndefStatement.java index 407734d7d79..5cf34550b07 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfndefStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIfndefStatement.java @@ -11,10 +11,16 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represent a preprocessor #ifndef statement. + * * @author jcamelon */ public interface IASTPreprocessorIfndefStatement extends IASTPreprocessorStatement { + /** + * Was this branch taken? + * @return + */ public boolean taken(); } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIncludeStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIncludeStatement.java index 6180919586c..1973cdffb1a 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIncludeStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIncludeStatement.java @@ -11,11 +11,16 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represent a preprocessor #include statement. * @author jcamelon */ public interface IASTPreprocessorIncludeStatement extends - IASTPreprocessorStatement { - - public String getPath(); + IASTPreprocessorStatement { + + /** + * Get the full path filename of the file found through #include. + * @return + */ + public String getPath(); } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorMacroDefinition.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorMacroDefinition.java index edb357d7db6..fc75a9b2d35 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorMacroDefinition.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorMacroDefinition.java @@ -17,10 +17,33 @@ package org.eclipse.cdt.core.dom.ast; */ public interface IASTPreprocessorMacroDefinition extends IASTPreprocessorStatement { + /** + * MACRO_NAME describes the relationship between a macro definition and it's name. + */ public static final ASTNodeProperty MACRO_NAME = new ASTNodeProperty( "Macro Name"); //$NON-NLS-1$ + /** + * Get the macro name. + * + * @return IASTName + */ public IASTName getName(); + /** + * Set the macro name. + * + * @param name + */ public void setName( IASTName name ); + /** + * Get the macro expansion. + * + * @return String + */ public String getExpansion(); + /** + * Set the macro expansion. + * + * @param exp String + */ public void setExpansion( String exp ); } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorObjectStyleMacroDefinition.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorObjectStyleMacroDefinition.java index fbb7333facb..fb748fb7cef 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorObjectStyleMacroDefinition.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorObjectStyleMacroDefinition.java @@ -11,6 +11,9 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represents an object-style macro definition. + * e.g. #define ONE_TWO_THREE 123 + * * @author jcamelon */ public interface IASTPreprocessorObjectStyleMacroDefinition extends IASTPreprocessorMacroDefinition { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorPragmaStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorPragmaStatement.java index 32186a87e8a..7f6bc226ef4 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorPragmaStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorPragmaStatement.java @@ -11,6 +11,8 @@ package org.eclipse.cdt.core.dom.ast; /** + * Represents a #pragma directive. + * * @author jcamelon */ public interface IASTPreprocessorPragmaStatement extends diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorSelectionResult.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorSelectionResult.java deleted file mode 100644 index a0f0aec61e4..00000000000 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorSelectionResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/********************************************************************** - * Copyright (c) 2005 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Common Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/cpl-v10.html - * - * Contributors: - * IBM - Initial API and implementation - **********************************************************************/ -package org.eclipse.cdt.core.dom.ast; - -/** - * This interface is used to specify what the LocationMap has found when searching for IASTNodes - * corresponding to a selection from the preprocessor tree. - * - * @author dsteffle - */ -public interface IASTPreprocessorSelectionResult { - public IASTNode getSelectedNode(); - public void setSelectedNode(IASTNode selectedNode); - public int getGlobalOffset(); - public void setGlobalOffset(int globalOffset); -} diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorStatement.java index cad27577cad..6329248fa56 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorStatement.java @@ -11,6 +11,8 @@ package org.eclipse.cdt.core.dom.ast; /** + * This is the base interface for all preprocessor directives. + * * @author jcamelon */ public interface IASTPreprocessorStatement extends IASTNode { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorUndefStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorUndefStatement.java index e749cd753d8..207cfd45160 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorUndefStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorUndefStatement.java @@ -11,6 +11,8 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represents a preprocessor #undef statement. + * * @author jcamelon */ public interface IASTPreprocessorUndefStatement extends IASTPreprocessorStatement { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemDeclaration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemDeclaration.java index d5d3242a4af..fda77f28796 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemDeclaration.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemDeclaration.java @@ -11,6 +11,8 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represents a parse problem where we tried to match against a declaration. + * * @author jcamelon */ public interface IASTProblemDeclaration extends IASTDeclaration, IASTProblemHolder { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemExpression.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemExpression.java index 0a0f2a2dd3d..6f300a6a987 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemExpression.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemExpression.java @@ -12,6 +12,8 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represents a parse problem where we tried to match against a expression. + * * @author jcamelon */ public interface IASTProblemExpression extends IASTExpression, IASTProblemHolder { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemHolder.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemHolder.java index bf6bd8d772a..327a77fd947 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemHolder.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemHolder.java @@ -11,10 +11,25 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represents a base interface to represent a problem owner or holder. + * * @author jcamelon */ public interface IASTProblemHolder { + /** + * PROBLEM represents the relationship between a IASTProblemHolder and its IASTProblem. + */ public static final ASTNodeProperty PROBLEM = new ASTNodeProperty( "Problem"); //$NON-NLS-1$ + /** + * Get the problem. + * + * @return IASTProblem + */ public IASTProblem getProblem(); + /** + * Set the problem. + * + * @param p IASTProblem + */ public void setProblem(IASTProblem p); } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemStatement.java index 0188c51a6d6..f6cae07be91 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemStatement.java @@ -11,6 +11,7 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represents a parse problem where we tried to match against a statement. * @author jcamelon */ public interface IASTProblemStatement extends IASTStatement, IASTProblemHolder { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemTypeId.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemTypeId.java index 1f84f8d69ac..d9441fa763e 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemTypeId.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTProblemTypeId.java @@ -11,6 +11,8 @@ package org.eclipse.cdt.core.dom.ast; /** + * This interface represents a parse problem where we tried to match against a type-id. + * * @author jcamelon */ public interface IASTProblemTypeId extends IASTTypeId, IASTProblemHolder { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/ASTPreprocessorSelectionResult.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/ASTPreprocessorSelectionResult.java index 25dad227503..37c3f0d5e08 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/ASTPreprocessorSelectionResult.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/ASTPreprocessorSelectionResult.java @@ -11,14 +11,13 @@ package org.eclipse.cdt.internal.core.dom.parser; import org.eclipse.cdt.core.dom.ast.IASTNode; -import org.eclipse.cdt.core.dom.ast.IASTPreprocessorSelectionResult; /** * This class is used to wrap possible results from the ILocationResolver (when retrieving * nodes from the preprocessor tree. * @author dsteffle */ -public class ASTPreprocessorSelectionResult implements IASTPreprocessorSelectionResult { +public class ASTPreprocessorSelectionResult { IASTNode selectedNode = null; int globalOffset = 0; diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/c/CASTTranslationUnit.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/c/CASTTranslationUnit.java index 9f38b68c747..63f3b0db044 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/c/CASTTranslationUnit.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/c/CASTTranslationUnit.java @@ -25,7 +25,6 @@ import org.eclipse.cdt.core.dom.ast.IASTParameterDeclaration; import org.eclipse.cdt.core.dom.ast.IASTPointerOperator; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorIncludeStatement; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorMacroDefinition; -import org.eclipse.cdt.core.dom.ast.IASTPreprocessorSelectionResult; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorStatement; import org.eclipse.cdt.core.dom.ast.IASTProblem; import org.eclipse.cdt.core.dom.ast.IASTStatement; @@ -37,6 +36,7 @@ import org.eclipse.cdt.core.dom.ast.c.CASTVisitor; import org.eclipse.cdt.core.dom.ast.c.ICASTDesignator; import org.eclipse.cdt.core.parser.ast.IASTEnumerator; import org.eclipse.cdt.internal.core.dom.parser.ASTNode; +import org.eclipse.cdt.internal.core.dom.parser.ASTPreprocessorSelectionResult; import org.eclipse.cdt.internal.core.dom.parser.IRequiresLocationInformation; import org.eclipse.cdt.internal.core.parser.scanner2.ILocationResolver; import org.eclipse.cdt.internal.core.parser.scanner2.InvalidPreprocessorNodeException; @@ -341,7 +341,7 @@ public class CASTTranslationUnit extends CASTNode implements public IASTNode selectNodeForLocation(String path, int realOffset, int realLength) { IASTNode node = null; - IASTPreprocessorSelectionResult result = null; + ASTPreprocessorSelectionResult result = null; int globalOffset = 0; try { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/cpp/CPPASTTranslationUnit.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/cpp/CPPASTTranslationUnit.java index 2326eced315..8979ac1c8de 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/cpp/CPPASTTranslationUnit.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/cpp/CPPASTTranslationUnit.java @@ -26,7 +26,6 @@ import org.eclipse.cdt.core.dom.ast.IASTParameterDeclaration; import org.eclipse.cdt.core.dom.ast.IASTPointerOperator; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorIncludeStatement; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorMacroDefinition; -import org.eclipse.cdt.core.dom.ast.IASTPreprocessorSelectionResult; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorStatement; import org.eclipse.cdt.core.dom.ast.IASTProblem; import org.eclipse.cdt.core.dom.ast.IASTStatement; @@ -46,6 +45,7 @@ import org.eclipse.cdt.core.dom.ast.cpp.ICPPNamespace; import org.eclipse.cdt.core.dom.ast.cpp.ICPPScope; import org.eclipse.cdt.core.parser.ast.IASTEnumerator; import org.eclipse.cdt.internal.core.dom.parser.ASTNode; +import org.eclipse.cdt.internal.core.dom.parser.ASTPreprocessorSelectionResult; import org.eclipse.cdt.internal.core.dom.parser.IRequiresLocationInformation; import org.eclipse.cdt.internal.core.parser.scanner2.ILocationResolver; import org.eclipse.cdt.internal.core.parser.scanner2.InvalidPreprocessorNodeException; @@ -334,7 +334,7 @@ public class CPPASTTranslationUnit extends CPPASTNode implements */ public IASTNode selectNodeForLocation(String path, int realOffset, int realLength) { IASTNode node = null; - IASTPreprocessorSelectionResult result = null; + ASTPreprocessorSelectionResult result = null; int globalOffset = 0; try { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/parser/scanner2/ILocationResolver.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/parser/scanner2/ILocationResolver.java index 7aa4420ec9c..2696493b19c 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/parser/scanner2/ILocationResolver.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/parser/scanner2/ILocationResolver.java @@ -10,12 +10,12 @@ **********************************************************************/ package org.eclipse.cdt.internal.core.parser.scanner2; -import org.eclipse.cdt.core.dom.ast.IASTPreprocessorMacroDefinition; import org.eclipse.cdt.core.dom.ast.IASTNodeLocation; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorIncludeStatement; -import org.eclipse.cdt.core.dom.ast.IASTPreprocessorSelectionResult; +import org.eclipse.cdt.core.dom.ast.IASTPreprocessorMacroDefinition; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorStatement; import org.eclipse.cdt.core.dom.ast.IASTProblem; +import org.eclipse.cdt.internal.core.dom.parser.ASTPreprocessorSelectionResult; /** * @author jcamelon @@ -36,6 +36,6 @@ public interface ILocationResolver { public void cleanup(); - public IASTPreprocessorSelectionResult getPreprocessorNode( String path, int offset, int length ) throws InvalidPreprocessorNodeException; + public ASTPreprocessorSelectionResult getPreprocessorNode( String path, int offset, int length ) throws InvalidPreprocessorNodeException; } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/parser/scanner2/LocationMap.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/parser/scanner2/LocationMap.java index 481aa111cbb..679962c79f2 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/parser/scanner2/LocationMap.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/parser/scanner2/LocationMap.java @@ -21,8 +21,8 @@ import org.eclipse.cdt.core.dom.ast.IASTFunctionStyleMacroParameter; import org.eclipse.cdt.core.dom.ast.IASTName; import org.eclipse.cdt.core.dom.ast.IASTNode; import org.eclipse.cdt.core.dom.ast.IASTNodeLocation; -import org.eclipse.cdt.core.dom.ast.IASTPreprocessorElseStatement; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorElifStatement; +import org.eclipse.cdt.core.dom.ast.IASTPreprocessorElseStatement; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorEndifStatement; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorErrorStatement; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorFunctionStyleMacroDefinition; @@ -33,7 +33,6 @@ import org.eclipse.cdt.core.dom.ast.IASTPreprocessorIncludeStatement; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorMacroDefinition; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorObjectStyleMacroDefinition; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorPragmaStatement; -import org.eclipse.cdt.core.dom.ast.IASTPreprocessorSelectionResult; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorStatement; import org.eclipse.cdt.core.dom.ast.IASTPreprocessorUndefStatement; import org.eclipse.cdt.core.dom.ast.IASTProblem; @@ -1723,7 +1722,7 @@ public class LocationMap implements ILocationResolver, IScannerPreprocessorLog { return foundContext; } - private IASTPreprocessorSelectionResult getPreprocessorNode(int globalOffset, int length, _Context startContext) throws InvalidPreprocessorNodeException { + private ASTPreprocessorSelectionResult getPreprocessorNode(int globalOffset, int length, _Context startContext) throws InvalidPreprocessorNodeException { IASTNode result = null; if (!(startContext instanceof _CompositeContext)) throw new InvalidPreprocessorNodeException(NOT_VALID_MACRO, globalOffset); List contexts = ((_CompositeContext)startContext).getSubContexts(); @@ -1763,8 +1762,8 @@ public class LocationMap implements ILocationResolver, IScannerPreprocessorLog { /* (non-Javadoc) * @see org.eclipse.cdt.internal.core.parser.scanner2.ILocationResolver#getPreprocessorNode(int, int) */ - public IASTPreprocessorSelectionResult getPreprocessorNode(String path, int offset, int length) throws InvalidPreprocessorNodeException { - IASTPreprocessorSelectionResult result = null; + public ASTPreprocessorSelectionResult getPreprocessorNode(String path, int offset, int length) throws InvalidPreprocessorNodeException { + ASTPreprocessorSelectionResult result = null; int globalOffset = 0; _Context foundContext = tu;