Eclipse CDT
Pre-release 3.0

org.eclipse.cdt.core.dom.ast
Interface IASTProblem

All Superinterfaces:
IASTNode

public interface IASTProblem
extends IASTNode


Field Summary
static String A_NAMESPACE_NAME
          A_NAMESPACE_NAME = namespace name
static String A_PREPROC_CONDITION
          A preprocessor conditional that could not be evaluated #if X + Y == Z <== that one, if X, Y or Z are not defined #endif
static String A_PREPROC_CONDITIONAL_MISMATCH
          The preprocessor conditional statement that caused an unbalanced mismatch.
static String A_PREPROC_INCLUDE_FILENAME
          The filename that failed somehow in an preprocessor include directive
static String A_PREPROC_MACRO_NAME
          A preprocessor macro name
static String A_PREPROC_POUND_ERROR
          The text that follows a #error preprocessor directive
static String A_PREPROC_UNKNOWN_DIRECTIVE
          A preprocessor directive that could not be interpretted e.g.
static String A_SCANNER_BADCHAR
          The Bad character encountered in scanner
static String A_SYMBOL_NAME
          A_SYMBOL_NAME - symbol name
static String A_TYPE_NAME
          A_TYPE_NAME - type name
static String FILENAME_NOT_PROVIDED
          Unknown filename sentinel value
static int IGNORE_CATEGORIES_MASK
          Mask to use in order to filter out the category portion of the problem ID.
static int INT_VALUE_NOT_PROVIDED
          Unknown Numeric Value for line numbers and offsets; use this constant
static int INTERNAL_RELATED
          IProblem relates to an implementation of design limitation
static int PREPROCESSOR_CIRCULAR_INCLUSION
          Circular inclusion encountered by Preprocessor.
static int PREPROCESSOR_CONDITIONAL_EVAL_ERROR
          Preprocessor Conditional cannot not be evaluated due.
static int PREPROCESSOR_DEFINITION_NOT_FOUND
          Macro definition not found by Preprocessor.
static int PREPROCESSOR_INCLUSION_NOT_FOUND
          Inclusion not found by Preprocessor.
static int PREPROCESSOR_INVALID_DIRECTIVE
          Invalid or unknown preprocessor directive encountered by Preprocessor.
static int PREPROCESSOR_INVALID_MACRO_DEFN
          Invalid format to Macro definition.
static int PREPROCESSOR_INVALID_MACRO_REDEFN
          Invalid macro redefinition encountered by Preprocessor.
static int PREPROCESSOR_INVALID_VA_ARGS
          __VA_ARGS__ encountered in macro definition without the required '...'
static int PREPROCESSOR_MACRO_PASTING_ERROR
          Invalid Macro Pasting encountered by Preprocessor.
static int PREPROCESSOR_MACRO_USAGE_ERROR
          Invalid macro usage encountered by Preprocessor.
static int PREPROCESSOR_MISSING_RPAREN_PARMLIST
          macro argument "..." encountered without the required ')' i.e. must be last argument if used Required attributes: none
static int PREPROCESSOR_POUND_ERROR
          #error encountered by Preprocessor.
static int PREPROCESSOR_RELATED
          IProblem relates to a valid error on the preprocessor
static int PREPROCESSOR_UNBALANCE_CONDITION
          Preprocessor conditionals seem unbalanced.
static int SCANNER_ASSIGNMENT_NOT_ALLOWED
          Assignment '=' encountered in macro by Scanner.
static int SCANNER_BAD_CHARACTER
          Bad character encountered by Scanner.
static int SCANNER_BAD_CONDITIONAL_EXPRESSION
          Division by 0 encountered in macro by Scanner.
static int SCANNER_BAD_DECIMAL_FORMAT
          Bad decimal encountered by Scanner.
static int SCANNER_BAD_FLOATING_POINT
          Bad floating point encountered by Scanner.
static int SCANNER_BAD_HEX_FORMAT
          Bad hexidecimal encountered by Scanner.
static int SCANNER_BAD_OCTAL_FORMAT
          Bad octal encountered by Scanner.
static int SCANNER_DIVIDE_BY_ZERO
          Division by 0 encountered in macro by Scanner.
static int SCANNER_EXPRESSION_SYNTAX_ERROR
          Expression syntax error encountered in macro by Scanner.
static int SCANNER_ILLEGAL_IDENTIFIER
          Expression syntax error encountered in macro by Scanner.
static int SCANNER_INVALID_ESCAPECHAR
          Invalid escape sequence encountered by Scanner.
static int SCANNER_MISSING_R_PAREN
          Missing ')' encountered in macro by Scanner.
static int SCANNER_RELATED
          IProblem relates to a valid error on the Scanner
static int SCANNER_UNBOUNDED_STRING
          Unbounded literal string encountered by Scanner.
static int SCANNER_UNEXPECTED_EOF
          Unexpected EOF encountered by Scanner.
static int SEMANTICS_RELATED
          IProblem relates to a valid semantical error in the parser
static int SYNTAX_ERROR
           
static int SYNTAX_RELATED
          IProblem relates to a valid syntax error in the parser
 
Fields inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode
EMPTY_NODE_ARRAY
 
Method Summary
 boolean checkCategory(int bitmask)
          Check the parameter bitmask against an IProblem's ID to broadly segregate the types of problems.
 String getArguments()
          Return to the client a map between parameter names and values.
 int getID()
          Returns the problem id
 String getMessage()
          Answer a localized, human-readable message string which describes the problem.
 boolean isError()
          Checks the severity to see if the Error bit is set.
 boolean isWarning()
          Checks the severity to see if the Warning bit is not set.
 
Methods inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode
accept, getContainingFilename, getFileLocation, getNodeLocations, getParent, getPropertyInParent, getRawSignature, getTranslationUnit, setParent, setPropertyInParent
 

Field Detail

INT_VALUE_NOT_PROVIDED

static final int INT_VALUE_NOT_PROVIDED
Unknown Numeric Value for line numbers and offsets; use this constant

See Also:
Constant Field Values

FILENAME_NOT_PROVIDED

static final String FILENAME_NOT_PROVIDED
Unknown filename sentinel value


SCANNER_RELATED

static final int SCANNER_RELATED
IProblem relates to a valid error on the Scanner

See Also:
Constant Field Values

PREPROCESSOR_RELATED

static final int PREPROCESSOR_RELATED
IProblem relates to a valid error on the preprocessor

See Also:
Constant Field Values

SYNTAX_RELATED

static final int SYNTAX_RELATED
IProblem relates to a valid syntax error in the parser

See Also:
Constant Field Values

SEMANTICS_RELATED

static final int SEMANTICS_RELATED
IProblem relates to a valid semantical error in the parser

See Also:
Constant Field Values

INTERNAL_RELATED

static final int INTERNAL_RELATED
IProblem relates to an implementation of design limitation

See Also:
Constant Field Values

IGNORE_CATEGORIES_MASK

static final int IGNORE_CATEGORIES_MASK
Mask to use in order to filter out the category portion of the problem ID.

See Also:
Constant Field Values

A_PREPROC_POUND_ERROR

static final String A_PREPROC_POUND_ERROR
The text that follows a #error preprocessor directive


A_PREPROC_INCLUDE_FILENAME

static final String A_PREPROC_INCLUDE_FILENAME
The filename that failed somehow in an preprocessor include directive


A_PREPROC_MACRO_NAME

static final String A_PREPROC_MACRO_NAME
A preprocessor macro name


A_PREPROC_CONDITION

static final String A_PREPROC_CONDITION
A preprocessor conditional that could not be evaluated #if X + Y == Z <== that one, if X, Y or Z are not defined #endif


A_PREPROC_UNKNOWN_DIRECTIVE

static final String A_PREPROC_UNKNOWN_DIRECTIVE
A preprocessor directive that could not be interpretted e.g. #blah


A_PREPROC_CONDITIONAL_MISMATCH

static final String A_PREPROC_CONDITIONAL_MISMATCH
The preprocessor conditional statement that caused an unbalanced mismatch. #if X #else #else <=== that one #endif


A_SCANNER_BADCHAR

static final String A_SCANNER_BADCHAR
The Bad character encountered in scanner


A_SYMBOL_NAME

static final String A_SYMBOL_NAME
A_SYMBOL_NAME - symbol name


A_NAMESPACE_NAME

static final String A_NAMESPACE_NAME
A_NAMESPACE_NAME = namespace name


A_TYPE_NAME

static final String A_TYPE_NAME
A_TYPE_NAME - type name


SCANNER_BAD_CHARACTER

static final int SCANNER_BAD_CHARACTER
Bad character encountered by Scanner. Required attributes: A_SCANNER_BADCHAR

See Also:
A_SCANNER_BADCHAR, Constant Field Values

SCANNER_UNBOUNDED_STRING

static final int SCANNER_UNBOUNDED_STRING
Unbounded literal string encountered by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_INVALID_ESCAPECHAR

static final int SCANNER_INVALID_ESCAPECHAR
Invalid escape sequence encountered by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_BAD_FLOATING_POINT

static final int SCANNER_BAD_FLOATING_POINT
Bad floating point encountered by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_BAD_HEX_FORMAT

static final int SCANNER_BAD_HEX_FORMAT
Bad hexidecimal encountered by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_UNEXPECTED_EOF

static final int SCANNER_UNEXPECTED_EOF
Unexpected EOF encountered by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_BAD_OCTAL_FORMAT

static final int SCANNER_BAD_OCTAL_FORMAT
Bad octal encountered by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_BAD_DECIMAL_FORMAT

static final int SCANNER_BAD_DECIMAL_FORMAT
Bad decimal encountered by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_ASSIGNMENT_NOT_ALLOWED

static final int SCANNER_ASSIGNMENT_NOT_ALLOWED
Assignment '=' encountered in macro by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_DIVIDE_BY_ZERO

static final int SCANNER_DIVIDE_BY_ZERO
Division by 0 encountered in macro by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_MISSING_R_PAREN

static final int SCANNER_MISSING_R_PAREN
Missing ')' encountered in macro by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_EXPRESSION_SYNTAX_ERROR

static final int SCANNER_EXPRESSION_SYNTAX_ERROR
Expression syntax error encountered in macro by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_ILLEGAL_IDENTIFIER

static final int SCANNER_ILLEGAL_IDENTIFIER
Expression syntax error encountered in macro by Scanner. Required attributes: none.

See Also:
Constant Field Values

SCANNER_BAD_CONDITIONAL_EXPRESSION

static final int SCANNER_BAD_CONDITIONAL_EXPRESSION
Division by 0 encountered in macro by Scanner. Required attributes: none.

See Also:
Constant Field Values

PREPROCESSOR_POUND_ERROR

static final int PREPROCESSOR_POUND_ERROR
#error encountered by Preprocessor. Required attributes: A_PREPROC_POUND_ERROR

See Also:
A_PREPROC_POUND_ERROR, Constant Field Values

PREPROCESSOR_INCLUSION_NOT_FOUND

static final int PREPROCESSOR_INCLUSION_NOT_FOUND
Inclusion not found by Preprocessor. Required attributes: A_PREPROC_INCLUDE_FILENAME

See Also:
A_PREPROC_INCLUDE_FILENAME, Constant Field Values

PREPROCESSOR_DEFINITION_NOT_FOUND

static final int PREPROCESSOR_DEFINITION_NOT_FOUND
Macro definition not found by Preprocessor. Required attributes: A_PREPROC_MACRO_NAME

See Also:
A_PREPROC_MACRO_NAME, Constant Field Values

PREPROCESSOR_UNBALANCE_CONDITION

static final int PREPROCESSOR_UNBALANCE_CONDITION
Preprocessor conditionals seem unbalanced. Required attributes: A_PREPROC_CONDITIONAL_MISMATCH

See Also:
A_PREPROC_CONDITIONAL_MISMATCH, Constant Field Values

PREPROCESSOR_INVALID_MACRO_DEFN

static final int PREPROCESSOR_INVALID_MACRO_DEFN
Invalid format to Macro definition. Required attributes: A_PREPROC_MACRO_NAME

See Also:
A_PREPROC_MACRO_NAME, Constant Field Values

PREPROCESSOR_INVALID_DIRECTIVE

static final int PREPROCESSOR_INVALID_DIRECTIVE
Invalid or unknown preprocessor directive encountered by Preprocessor. Required attributes: A_PREPROC_UNKNOWN_DIRECTIVE

See Also:
A_PREPROC_UNKNOWN_DIRECTIVE, Constant Field Values

PREPROCESSOR_INVALID_MACRO_REDEFN

static final int PREPROCESSOR_INVALID_MACRO_REDEFN
Invalid macro redefinition encountered by Preprocessor. Required attributes: A_PREPROC_MACRO_NAME

See Also:
A_PREPROC_MACRO_NAME, Constant Field Values

PREPROCESSOR_CONDITIONAL_EVAL_ERROR

static final int PREPROCESSOR_CONDITIONAL_EVAL_ERROR
Preprocessor Conditional cannot not be evaluated due. Required attributes: A_PREPROC_CONDITION

See Also:
A_PREPROC_CONDITION, Constant Field Values

PREPROCESSOR_MACRO_USAGE_ERROR

static final int PREPROCESSOR_MACRO_USAGE_ERROR
Invalid macro usage encountered by Preprocessor. Required attributes: A_PREPROC_MACRO_NAME

See Also:
A_PREPROC_MACRO_NAME, Constant Field Values

PREPROCESSOR_MACRO_PASTING_ERROR

static final int PREPROCESSOR_MACRO_PASTING_ERROR
Invalid Macro Pasting encountered by Preprocessor. Required attributes: A_PREPROC_MACRO_NAME

See Also:
A_PREPROC_MACRO_NAME, Constant Field Values

PREPROCESSOR_CIRCULAR_INCLUSION

static final int PREPROCESSOR_CIRCULAR_INCLUSION
Circular inclusion encountered by Preprocessor. Required attributes: A_PREPROC_INCLUDE_FILENAME

See Also:
A_PREPROC_INCLUDE_FILENAME, Constant Field Values

PREPROCESSOR_MISSING_RPAREN_PARMLIST

static final int PREPROCESSOR_MISSING_RPAREN_PARMLIST
macro argument "..." encountered without the required ')' i.e. must be last argument if used Required attributes: none

See Also:
Constant Field Values

PREPROCESSOR_INVALID_VA_ARGS

static final int PREPROCESSOR_INVALID_VA_ARGS
__VA_ARGS__ encountered in macro definition without the required '...' parameter Required attributes: none

See Also:
Constant Field Values

SYNTAX_ERROR

static final int SYNTAX_ERROR
See Also:
Constant Field Values
Method Detail

getID

int getID()
Returns the problem id

Returns:
the problem id

getMessage

String getMessage()
Answer a localized, human-readable message string which describes the problem.

Returns:
a localized, human-readable message string which describes the problem

getArguments

String getArguments()
Return to the client a map between parameter names and values. The keys and values are all Strings.

Returns:
a map between parameter names and values.

isError

boolean isError()
Checks the severity to see if the Error bit is set.

Returns:
true if the Error bit is set for the severity, false otherwise

isWarning

boolean isWarning()
Checks the severity to see if the Warning bit is not set.

Returns:
true if the Warning bit is not set for the severity, false otherwise

checkCategory

boolean checkCategory(int bitmask)
Check the parameter bitmask against an IProblem's ID to broadly segregate the types of problems.

Parameters:
bitmask -
Returns:
true if ( (id & bitmask ) != 0 )

Eclipse CDT
Pre-release 3.0

Copyright (c) IBM Corp. and others 2004. All Rights Reserved.