Package org.eclipse.cdt.core
Class CCorePreferenceConstants
java.lang.Object
org.eclipse.cdt.core.CCorePreferenceConstants
- Restriction:
- This class is not intended to be subclassed by clients.
- Restriction:
- This class is not intended to be instantiated by clients.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringA named preference that specifies whether the override keyword should be added to method signature.static final StringActive code formatter ID.static final booleanDefault value forADD_OVERRIDE_KEYWORD.static final StringDefault code formatterstatic final StringDefault value forINCLUDE_BEGIN_EXPORTS_PATTERN.static final StringDefault value forINCLUDE_END_EXPORTS_PATTERN.static final StringDefault value forINCLUDE_EXPORT_PATTERN.static final StringDefault value forINCLUDE_KEEP_PATTERN.static final StringDefault value forINCLUDE_PRIVATE_PATTERN.static final StringDefault cache size of the index-db in percentage of max memory.static final StringDefault absolute maximum size of the index-db in megabytes.static final booleanDefault value forPLACE_CONST_RIGHT_OF_TYPE.static final booleanDefault value forPRESERVE_VIRTUAL_KEYWORD.static final booleanDefault value forSCALABILITY_LIMIT_TOKENS_PER_TU.static final intDefault value forSCALABILITY_MAXIMUM_TOKENS.static final intDefault value forSCALABILITY_MAXIMUM_TRIVIAL_EXPRESSIONS.static final booleanDefault value forSCALABILITY_SKIP_TRIVIAL_EXPRESSIONS.static final StringDefault case sensitivity of task tags.static final StringDefault task prioritystatic final StringDefault task tagstatic final StringList of tags provided by defaultstatic final StringDefault workspace-wide language mappings.static final StringBoolean preference controlling whether paths of non-workspace files are stored in index in canonical form or not.static final StringPreference key for the regular expression pattern that, when appears in a comment, marks the beginning of a sequence of include statements that export the included header files.static final StringPreference key for the regular expression pattern that, when appears in a comment, marks the end of a sequence of include statements that export the included header files.static final StringPreference key for the regular expression pattern that, when appears in a comment on the same line as include statement, indicates that the included header file is exported.static final StringPreference key for the regular expression pattern that, when appears in a comment on the same line as include statement, indicates that the include statement should be preserved when organizing includes.static final StringPreference key for the regular expression pattern that, when appears in a comment on the same line as include statement, indicates that the included header file is private and that another header file should be included instead.static final StringCache size for the index in percentage of max memory.static final StringAbsolute maximum size of the index-db in megabytes.static final StringA named preference that specifies whether the const qualifier is written to the right (or left) of the type in a declaration specifier.static final String"Build All Configurations" preference key.static final StringPreference key for "build only if resources in (related) projects are modified".static final StringA named preference that specifies whether the virtual keyword should be added to method signature.static final StringA named preference that specifies whether the parser should abort when too many Tokens are created during parse of a single TU.static final StringA named preference that specifies the parser's token limit.static final StringThe maximum number of trivial expressions that are parsed in initializer lists.static StringA named preference that controls whether the parser should skip trivial expressions in initializer lists.static final StringAttempt to show source files for executable binaries.static final StringAttempt to (not) show c source not found editor in debug.static final StringUse to display all the time the source not found editorstatic final StringUse to display by default the source not found editorstatic final StringUse to don't display the source not found editorstatic final StringUse to display sometimes the source not found editorstatic final StringShow source roots at the top level of projects.static final StringPossible configurable option value for TODO_TASK_PRIORITIES.static final StringPossible configurable option value for TODO_TASK_PRIORITIES.static final StringPossible configurable option value for TODO_TASK_PRIORITIES.static final StringCase sensitivity of task tags.static final StringPriorities associated with task tags.static final StringTask tags used in code comments.static final StringWorkspace-wide language mappings. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic StringgetPreference(String key, ICProject project) Returns the string value for the given key in the given context.static booleangetPreference(String key, ICProject project, boolean defaultValue) Returns the boolean value for the given key in the given context.static intgetPreference(String key, ICProject project, int defaultValue) Returns the integer value for the given key in the given context.static StringgetPreference(String key, ICProject project, String defaultValue) Returns the string value for the given key in the given context.static StringgetPreference(String key, org.eclipse.core.resources.IProject project) Returns the string value for the given key in the given context.static booleangetPreference(String key, org.eclipse.core.resources.IProject project, boolean defaultValue) Returns the boolean value for the given key in the given context.static intgetPreference(String key, org.eclipse.core.resources.IProject project, int defaultValue) Returns the integer value for the given key in the given context.static StringgetPreference(String key, org.eclipse.core.resources.IProject project, String defaultValue) Returns the string value for the given key in the given context.static org.eclipse.core.runtime.preferences.IScopeContext[]getPreferenceScopes(org.eclipse.core.resources.IProject project) Returns the scopes for preference lookup.
-
Field Details
-
TODO_TASK_TAGS
Task tags used in code comments.- See Also:
-
DEFAULT_TASK_TAG
Default task tag- See Also:
-
DEFAULT_TASK_TAGS
List of tags provided by default- Since:
- 5.1
- See Also:
-
TASK_PRIORITY_NORMAL
Possible configurable option value for TODO_TASK_PRIORITIES.- See Also:
-
TASK_PRIORITY_HIGH
Possible configurable option value for TODO_TASK_PRIORITIES.- See Also:
-
TASK_PRIORITY_LOW
Possible configurable option value for TODO_TASK_PRIORITIES.- See Also:
-
DEFAULT_TASK_PRIORITY
Default task priority- See Also:
-
TODO_TASK_PRIORITIES
Priorities associated with task tags.- See Also:
-
TODO_TASK_CASE_SENSITIVE
Case sensitivity of task tags.- See Also:
-
DEFAULT_TASK_CASE_SENSITIVE
Default case sensitivity of task tags.- See Also:
-
CODE_FORMATTER
Active code formatter ID.- See Also:
-
DEFAULT_CODE_FORMATTER
Default code formatter- See Also:
-
INDEX_DB_CACHE_SIZE_PCT
Cache size for the index in percentage of max memory.- See Also:
-
DEFAULT_INDEX_DB_CACHE_SIZE_PCT
Default cache size of the index-db in percentage of max memory.- See Also:
-
MAX_INDEX_DB_CACHE_SIZE_MB
Absolute maximum size of the index-db in megabytes.- See Also:
-
DEFAULT_MAX_INDEX_DB_CACHE_SIZE_MB
Default absolute maximum size of the index-db in megabytes.- See Also:
-
FILE_PATH_CANONICALIZATION
Boolean preference controlling whether paths of non-workspace files are stored in index in canonical form or not. Canonicalization is performed by callingFile.getCanonicalPath().- Since:
- 5.2
- See Also:
-
WORKSPACE_LANGUAGE_MAPPINGS
Workspace-wide language mappings.- See Also:
-
DEFAULT_WORKSPACE_LANGUAGE_MAPPINGS
Default workspace-wide language mappings.- See Also:
-
SHOW_SOURCE_FILES_IN_BINARIES
Attempt to show source files for executable binaries.- See Also:
-
SHOW_SOURCE_NOT_FOUND_EDITOR
Attempt to (not) show c source not found editor in debug. String value, one ofSHOW_SOURCE_NOT_FOUND_EDITOR_ALL_THE_TIME,SHOW_SOURCE_NOT_FOUND_EDITOR_SOMETIMES,SHOW_SOURCE_NOT_FOUND_EDITOR_NEVER- Since:
- 6.3
- See Also:
-
SHOW_SOURCE_NOT_FOUND_EDITOR_ALL_THE_TIME
Use to display all the time the source not found editor- Since:
- 6.3
- See Also:
-
SHOW_SOURCE_NOT_FOUND_EDITOR_SOMETIMES
Use to display sometimes the source not found editor- Since:
- 6.3
- See Also:
-
SHOW_SOURCE_NOT_FOUND_EDITOR_NEVER
Use to don't display the source not found editor- Since:
- 6.3
- See Also:
-
SHOW_SOURCE_NOT_FOUND_EDITOR_DEFAULT
Use to display by default the source not found editor- Since:
- 6.3
- See Also:
-
SHOW_SOURCE_ROOTS_AT_TOP_LEVEL_OF_PROJECT
Show source roots at the top level of projects.- Since:
- 5.2
- See Also:
-
PREF_BUILD_ALL_CONFIGS
"Build All Configurations" preference key.- Since:
- 5.3
- See Also:
-
PREF_BUILD_CONFIGS_RESOURCE_CHANGES
Preference key for "build only if resources in (related) projects are modified".- Since:
- 5.3
- See Also:
-
DEFAULT_INCLUDE_EXPORT_PATTERN
Default value forINCLUDE_EXPORT_PATTERN.- Since:
- 5.5
- See Also:
-
INCLUDE_EXPORT_PATTERN
Preference key for the regular expression pattern that, when appears in a comment on the same line as include statement, indicates that the included header file is exported.- Since:
- 5.5
- See Also:
-
DEFAULT_INCLUDE_BEGIN_EXPORTS_PATTERN
Default value forINCLUDE_BEGIN_EXPORTS_PATTERN.- Since:
- 5.5
- See Also:
-
INCLUDE_BEGIN_EXPORTS_PATTERN
Preference key for the regular expression pattern that, when appears in a comment, marks the beginning of a sequence of include statements that export the included header files.- Since:
- 5.5
- See Also:
-
DEFAULT_INCLUDE_END_EXPORTS_PATTERN
Default value forINCLUDE_END_EXPORTS_PATTERN.- Since:
- 5.5
- See Also:
-
INCLUDE_END_EXPORTS_PATTERN
Preference key for the regular expression pattern that, when appears in a comment, marks the end of a sequence of include statements that export the included header files.- Since:
- 5.5
- See Also:
-
DEFAULT_INCLUDE_PRIVATE_PATTERN
Default value forINCLUDE_PRIVATE_PATTERN.- Since:
- 5.7
- See Also:
-
INCLUDE_PRIVATE_PATTERN
Preference key for the regular expression pattern that, when appears in a comment on the same line as include statement, indicates that the included header file is private and that another header file should be included instead.- Since:
- 5.7
- See Also:
-
DEFAULT_INCLUDE_KEEP_PATTERN
Default value forINCLUDE_KEEP_PATTERN.- Since:
- 5.9
- See Also:
-
INCLUDE_KEEP_PATTERN
Preference key for the regular expression pattern that, when appears in a comment on the same line as include statement, indicates that the include statement should be preserved when organizing includes.- Since:
- 5.9
- See Also:
-
SCALABILITY_SKIP_TRIVIAL_EXPRESSIONS
A named preference that controls whether the parser should skip trivial expressions in initializer lists.Value is of type
Boolean.- Since:
- 5.6
-
DEFAULT_SCALABILITY_SKIP_TRIVIAL_EXPRESSIONS
public static final boolean DEFAULT_SCALABILITY_SKIP_TRIVIAL_EXPRESSIONSDefault value forSCALABILITY_SKIP_TRIVIAL_EXPRESSIONS.- Since:
- 5.6
- See Also:
-
SCALABILITY_MAXIMUM_TRIVIAL_EXPRESSIONS
The maximum number of trivial expressions that are parsed in initializer lists. This preference is considered only ifSCALABILITY_SKIP_TRIVIAL_EXPRESSIONSis set to true.Value is of type
int.- Since:
- 5.6
- See Also:
-
DEFAULT_SCALABILITY_MAXIMUM_TRIVIAL_EXPRESSIONS
public static final int DEFAULT_SCALABILITY_MAXIMUM_TRIVIAL_EXPRESSIONSDefault value forSCALABILITY_MAXIMUM_TRIVIAL_EXPRESSIONS.- Since:
- 5.6
- See Also:
-
SCALABILITY_LIMIT_TOKENS_PER_TU
A named preference that specifies whether the parser should abort when too many Tokens are created during parse of a single TU. This is a heuristic that is used to detect translation units that are too complex to be handled the by the CDT parser.- Since:
- 5.7
- See Also:
-
DEFAULT_SCALABILITY_LIMIT_TOKENS_PER_TU
public static final boolean DEFAULT_SCALABILITY_LIMIT_TOKENS_PER_TUDefault value forSCALABILITY_LIMIT_TOKENS_PER_TU.- Since:
- 5.7
- See Also:
-
SCALABILITY_MAXIMUM_TOKENS
A named preference that specifies the parser's token limit. Parsing will be aborted when a single translation unit has produced a maximum number of tokens. This is a heuristic that is used to detect translation units that are too complex to be handled the by the CDT parser.- Since:
- 5.7
- See Also:
-
DEFAULT_SCALABILITY_MAXIMUM_TOKENS
public static final int DEFAULT_SCALABILITY_MAXIMUM_TOKENSDefault value forSCALABILITY_MAXIMUM_TOKENS.- Since:
- 5.7
- See Also:
-
PLACE_CONST_RIGHT_OF_TYPE
A named preference that specifies whether the const qualifier is written to the right (or left) of the type in a declaration specifier.- Since:
- 6.3
- See Also:
-
DEFAULT_PLACE_CONST_RIGHT_OF_TYPE
public static final boolean DEFAULT_PLACE_CONST_RIGHT_OF_TYPEDefault value forPLACE_CONST_RIGHT_OF_TYPE.- Since:
- 6.3
- See Also:
-
ADD_OVERRIDE_KEYWORD
A named preference that specifies whether the override keyword should be added to method signature.- Since:
- 6.8
- See Also:
-
PRESERVE_VIRTUAL_KEYWORD
A named preference that specifies whether the virtual keyword should be added to method signature.- Since:
- 6.8
- See Also:
-
DEFAULT_ADD_OVERRIDE_KEYWORD
public static final boolean DEFAULT_ADD_OVERRIDE_KEYWORDDefault value forADD_OVERRIDE_KEYWORD.- Since:
- 6.8
- See Also:
-
DEFAULT_PRESERVE_VIRTUAL_KEYWORD
public static final boolean DEFAULT_PRESERVE_VIRTUAL_KEYWORDDefault value forPRESERVE_VIRTUAL_KEYWORD.- Since:
- 6.8
- See Also:
-
-
Constructor Details
-
CCorePreferenceConstants
public CCorePreferenceConstants()
-
-
Method Details
-
getPreference
Returns the string value for the given key in the given context.- Parameters:
key- The preference keyproject- The current context ornullif no context is available and the workspace setting should be taken. Note that passingnullshould be avoided.- Returns:
- Returns the current value for the string.
- Since:
- 5.5
-
getPreference
Returns the string value for the given key in the given context.- Parameters:
key- The preference keyproject- The current context ornullif no context is available and the workspace setting should be taken. Note that passingnullshould be avoided.- Returns:
- Returns the current value for the string.
- Since:
- 5.9
-
getPreference
Returns the string value for the given key in the given context.- Parameters:
key- The preference keyproject- The current context ornullif no context is available and the workspace setting should be taken. Note that passingnullshould be avoided.defaultValue- The default value if not specified in the preferences.- Returns:
- Returns the current value of the preference.
- Since:
- 5.5
-
getPreference
public static String getPreference(String key, org.eclipse.core.resources.IProject project, String defaultValue) Returns the string value for the given key in the given context.- Parameters:
key- The preference keyproject- The current context ornullif no context is available and the workspace setting should be taken. Note that passingnullshould be avoided.defaultValue- The default value if not specified in the preferences.- Returns:
- Returns the current value of the preference.
- Since:
- 5.9
-
getPreference
Returns the integer value for the given key in the given context.- Parameters:
key- The preference keyproject- The current context ornullif no context is available and the workspace setting should be taken. Note that passingnullshould be avoided.defaultValue- The default value if not specified in the preferences.- Returns:
- Returns the current value of the preference.
- Since:
- 5.5
-
getPreference
public static int getPreference(String key, org.eclipse.core.resources.IProject project, int defaultValue) Returns the integer value for the given key in the given context.- Parameters:
key- The preference keyproject- The current context ornullif no context is available and the workspace setting should be taken. Note that passingnullshould be avoided.defaultValue- The default value if not specified in the preferences.- Returns:
- Returns the current value of the preference.
- Since:
- 5.9
-
getPreference
Returns the boolean value for the given key in the given context.- Parameters:
key- The preference keyproject- The current context ornullif no context is available and the workspace setting should be taken. Note that passingnullshould be avoided.defaultValue- The default value if not specified in the preferences.- Returns:
- Returns the current value of the preference.
- Since:
- 5.5
-
getPreference
public static boolean getPreference(String key, org.eclipse.core.resources.IProject project, boolean defaultValue) Returns the boolean value for the given key in the given context.- Parameters:
key- The preference keyproject- The current context ornullif no context is available and the workspace setting should be taken. Note that passingnullshould be avoided.defaultValue- The default value if not specified in the preferences.- Returns:
- Returns the current value of the preference.
- Since:
- 5.9
-
getPreferenceScopes
public static org.eclipse.core.runtime.preferences.IScopeContext[] getPreferenceScopes(org.eclipse.core.resources.IProject project) Returns the scopes for preference lookup.- Parameters:
project- a project ornull- Returns:
- the scopes for preference lookup.
- Since:
- 5.5
-