|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IBuildMacroProvider
Field Summary | |
---|---|
static int |
CONTEXT_CONFIGURATION
|
static int |
CONTEXT_ECLIPSEENV
|
static int |
CONTEXT_FILE
|
static int |
CONTEXT_INSTALLATIONS
|
static int |
CONTEXT_OPTION
|
static int |
CONTEXT_PROJECT
|
static int |
CONTEXT_TOOL
|
static int |
CONTEXT_WORKSPACE
|
Method Summary | |
---|---|
void |
checkIntegrity(int contextType,
java.lang.Object contextData)
checks the integrity of the Macros If there are inconsistencies, such as when a macro value refers to a nonexistent macro or when two macros refer to each other, this method will throw the BuildMacroException exception The BuildMacroException will contain the human-readable string describing the inconsistency and the array of the IBuildMacro interfaces that will represent the macros that caused the inconsistency. |
java.lang.String |
convertStringListToString(java.lang.String[] value,
java.lang.String listDelimiter)
converts StringList value into String of the following format: " |
IBuildMacro |
getMacro(java.lang.String macroName,
int contextType,
java.lang.Object contextData,
boolean includeParentContexts)
Returns reference to the IBuildMacro interface representing Macro of the specified name or null if there is there is no such macro |
IBuildMacro[] |
getMacros(int contextType,
java.lang.Object contextData,
boolean includeParentContexts)
|
IBuildMacroSupplier[] |
getSuppliers(int contextType,
java.lang.Object contextData)
This method is defined to be used primarily by the UI classes and should not be used by the tool-integrator |
ICdtVariable |
getVariable(java.lang.String macroName,
int contextType,
java.lang.Object contextData,
boolean includeParentContexts)
|
ICdtVariable[] |
getVariables(int contextType,
java.lang.Object contextData,
boolean includeParentContexts)
|
boolean |
isStringListValue(java.lang.String value,
int contextType,
java.lang.Object contextData)
|
java.lang.String[] |
resolveStringListValue(java.lang.String value,
java.lang.String nonexistentMacrosValue,
java.lang.String listDelimiter,
int contextType,
java.lang.Object contextData)
if the string contains a value that can be treated as a StringList resolves it to arrays of strings otherwise throws the BuildMacroException exception |
java.lang.String[] |
resolveStringListValues(java.lang.String[] value,
java.lang.String nonexistentMacrosValue,
java.lang.String listDelimiter,
int contextType,
java.lang.Object contextData)
resolves macros in the array of string-list values |
java.lang.String[] |
resolveStringListValuesToMakefileFormat(java.lang.String[] value,
java.lang.String nonexistentMacrosValue,
java.lang.String listDelimiter,
int contextType,
java.lang.Object contextData)
resolves macros in the array of string-list values macros are resolved to the makefile format |
java.lang.String[] |
resolveStringListValueToMakefileFormat(java.lang.String value,
java.lang.String nonexistentMacrosValue,
java.lang.String listDelimiter,
int contextType,
java.lang.Object contextData)
if the string contains a value that can be treated as a StringList resolves it to arrays of strings otherwise throws the BuildMacroException exception each string of the returned array will contain all macro references resolved in case of a user has specified to resolve the build macros, and will contain the string with the environment macro references unresolved and converted to the buildfile format otherwise |
java.lang.String |
resolveValue(java.lang.String value,
java.lang.String nonexistentMacrosValue,
java.lang.String listDelimiter,
int contextType,
java.lang.Object contextData)
resolves all macros in the string. |
java.lang.String |
resolveValueToMakefileFormat(java.lang.String value,
java.lang.String nonexistentMacrosValue,
java.lang.String listDelimiter,
int contextType,
java.lang.Object contextData)
resolves all macros in the string to the makefile format. |
Field Detail |
---|
static final int CONTEXT_FILE
static final int CONTEXT_OPTION
static final int CONTEXT_CONFIGURATION
static final int CONTEXT_PROJECT
static final int CONTEXT_WORKSPACE
static final int CONTEXT_INSTALLATIONS
static final int CONTEXT_ECLIPSEENV
static final int CONTEXT_TOOL
Method Detail |
---|
IBuildMacro getMacro(java.lang.String macroName, int contextType, java.lang.Object contextData, boolean includeParentContexts)
macroName
- macro namecontextType
- represents the context type. Should be set to one of the the
IBuildMacroProvider. CONTEXT_xxx constantscontextData
- represents the additional data needed by the Build Macro Provider
and Macro Suppliers in order to obtain the macro value. The type of the context data
differs depending on the context type and can be one of the following:
1. IFileContextData interface � used to represent currently selected file context
the IFileContextData interface is defined as follows:
pulic interface IFileContextData{
IFile getFile();
IOption getOption();
}
NOTE: the IFileContextData is passed that represents the current file and the option
for that file because Macro Value Provider needs to know what option should be used
as a context in case macro is not found for �current file� context
2. IOptionContextData interface used to represent the currently selected option context
3. IConfiguration � used to represent the currently selected configuration context
4. IProject � used to represent current project context
5. IWorkspace � used to represent current workspace context
6. null � to represent the CDT and Eclipse installation context
7. null � to represent process environment contextincludeParentContext
- specifies whether lower-precedence context macros should
be includedIBuildMacro[] getMacros(int contextType, java.lang.Object contextData, boolean includeParentContexts)
ICdtVariable getVariable(java.lang.String macroName, int contextType, java.lang.Object contextData, boolean includeParentContexts)
ICdtVariable[] getVariables(int contextType, java.lang.Object contextData, boolean includeParentContexts)
IBuildMacroSupplier[] getSuppliers(int contextType, java.lang.Object contextData)
java.lang.String convertStringListToString(java.lang.String[] value, java.lang.String listDelimiter)
java.lang.String resolveValue(java.lang.String value, java.lang.String nonexistentMacrosValue, java.lang.String listDelimiter, int contextType, java.lang.Object contextData) throws BuildMacroException
value
- the value to be resolvednonexistentMacrosValue
- specifies the value that inexistent macro references will be
expanded to. If null the BuildMacroException is thrown in case the string to be resolved
references inexistent macroslistDelimiter
- if not null, StringList macros are expanded as
�contextType
- context from which the macro search should be startedcontextData
- context data
BuildMacroException
java.lang.String[] resolveStringListValue(java.lang.String value, java.lang.String nonexistentMacrosValue, java.lang.String listDelimiter, int contextType, java.lang.Object contextData) throws BuildMacroException
BuildMacroException
isStringListValue
java.lang.String[] resolveStringListValues(java.lang.String[] value, java.lang.String nonexistentMacrosValue, java.lang.String listDelimiter, int contextType, java.lang.Object contextData) throws BuildMacroException
BuildMacroException
isStringListValue
java.lang.String resolveValueToMakefileFormat(java.lang.String value, java.lang.String nonexistentMacrosValue, java.lang.String listDelimiter, int contextType, java.lang.Object contextData) throws BuildMacroException
value
- the value to be resolvednonexistentMacrosValue
- specifies the value that inexistent macro references will be
expanded to. If null the BuildMacroException is thrown in case the string to be resolved
references inexistent macroslistDelimiter
- if not null, StringList macros are expanded as
�contextType
- context from which the macro search should be startedcontextData
- context data
BuildMacroException
java.lang.String[] resolveStringListValueToMakefileFormat(java.lang.String value, java.lang.String nonexistentMacrosValue, java.lang.String listDelimiter, int contextType, java.lang.Object contextData) throws BuildMacroException
BuildMacroException
isStringListValue
java.lang.String[] resolveStringListValuesToMakefileFormat(java.lang.String[] value, java.lang.String nonexistentMacrosValue, java.lang.String listDelimiter, int contextType, java.lang.Object contextData) throws BuildMacroException
BuildMacroException
isStringListValue
boolean isStringListValue(java.lang.String value, int contextType, java.lang.Object contextData) throws BuildMacroException
BuildMacroException
void checkIntegrity(int contextType, java.lang.Object contextData) throws BuildMacroException
BuildMacroException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |