diff options
Diffstat (limited to 'build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/OptionReference.java')
| -rw-r--r-- | build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/OptionReference.java | 582 |
1 files changed, 0 insertions, 582 deletions
diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/OptionReference.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/OptionReference.java deleted file mode 100644 index ab375eb89b8..00000000000 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/OptionReference.java +++ /dev/null @@ -1,582 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2003, 2004 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.managedbuilder.internal.core; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; -import java.util.ListIterator; - -import org.eclipse.cdt.managedbuilder.core.BuildException; -import org.eclipse.cdt.managedbuilder.core.IManagedConfigElement; -import org.eclipse.cdt.managedbuilder.core.IOption; -import org.eclipse.cdt.managedbuilder.core.IOptionCategory; -import org.eclipse.cdt.managedbuilder.core.ITool; -import org.eclipse.cdt.managedbuilder.core.ManagedBuildManager; -import org.w3c.dom.Document; -import org.w3c.dom.Element; -import org.w3c.dom.Node; -import org.w3c.dom.NodeList; - -/** - * An <code>OptionReference</code> plays two roles in the managed build model. - * It is used to store overridden option values in a toolchain specification at - * the level of a <code>Configuration</code> and it stores user option settings - * between sessions. - */ -public class OptionReference implements IOption { - - // List of built-in values a tool defines - private List builtIns; - // Used for all option references that override the command - private String command; - // The option this reference overrides - private IOption option; - // The owner of the reference - private ToolReference owner; - // The actual value of the reference - private Object value; - private boolean resolved = true; - - /** - * This constructor will be called when the receiver is created from - * the settings found in an extension point. - * - * @param owner - * @param element - */ - public OptionReference(ToolReference owner, IManagedConfigElement element) { - // setup for resolving - ManagedBuildManager.putConfigElement(this, element); - resolved = false; - - this.owner = owner; - - owner.addOptionReference(this); - - } - - /** - * Constructor called when the option reference is created from an - * existing <code>IOption</code> - * - * @param owner - * @param option - */ - public OptionReference(ToolReference owner, IOption option) { - this.owner = owner; - this.option = option; - - // Until the option reference is changed, all values will be extracted from original option - owner.addOptionReference(this); - } - - /** - * Created from project file. - * - * @param owner - * @param element - */ - public OptionReference(ToolReference owner, Element element) { - this.owner = owner; - try { - option = owner.getTool().getOptionById(element.getAttribute(ID)); - } catch (NullPointerException e) { - // Something bad happened - option = null; - } - - // Bail now if there's no option for the reference - if (option == null) { - return; - } - - // Hook the reference up - owner.addOptionReference(this); - - // value - switch (option.getValueType()) { - case BOOLEAN: - value = new Boolean(element.getAttribute(DEFAULT_VALUE)); - break; - case STRING: - case ENUMERATED: - // Pre-2.0 the value was the string for the UI - // Post-2.0 it is the ID of the enumerated option - value = (String) element.getAttribute(DEFAULT_VALUE); - break; - case STRING_LIST: - case INCLUDE_PATH: - case PREPROCESSOR_SYMBOLS: - case LIBRARIES: - case OBJECTS: - List valueList = new ArrayList(); - NodeList nodes = element.getElementsByTagName(LIST_VALUE); - for (int i = 0; i < nodes.getLength(); ++i) { - Node node = nodes.item(i); - if (node.getNodeType() == Node.ELEMENT_NODE) { - Boolean isBuiltIn = new Boolean(((Element)node).getAttribute(LIST_ITEM_BUILTIN)); - if (isBuiltIn.booleanValue()) { - getBuiltInList().add(((Element)node).getAttribute(LIST_ITEM_VALUE)); - } else { - valueList.add(((Element)node).getAttribute(LIST_ITEM_VALUE)); - } - } - } - value = valueList; - break; - } - - } - - public void resolveReferences() { - if (!resolved) { - resolved = true; - IManagedConfigElement element = ManagedBuildManager.getConfigElement(this); - - // resolve parent (recursively) before calling methods on it. - option = owner.getTool().getOptionById(element.getAttribute(ID)); - if (option == null) { - // error condition probably the result of a misidentified option ID - resolved = false; - return; - } - if (option instanceof Option) { - ((Option)option).resolveReferences(); - } else if (option instanceof OptionReference) { - ((OptionReference)option).resolveReferences(); - } - - // value - switch (option.getValueType()) { - case BOOLEAN: - value = new Boolean(element.getAttribute(DEFAULT_VALUE)); - break; - case STRING: - value = element.getAttribute(DEFAULT_VALUE); - break; - case ENUMERATED: - String temp = element.getAttribute(DEFAULT_VALUE); - if (temp == null) { - try { - temp = option.getSelectedEnum(); - } catch (BuildException e) { - temp = new String(); - } - } - value = temp; - break; - case STRING_LIST: - case INCLUDE_PATH: - case PREPROCESSOR_SYMBOLS: - case LIBRARIES: - case OBJECTS: - List valueList = new ArrayList(); - IManagedConfigElement[] valueElements = element.getChildren(LIST_VALUE); - for (int i = 0; i < valueElements.length; ++i) { - IManagedConfigElement valueElement = valueElements[i]; - Boolean isBuiltIn = new Boolean(valueElement.getAttribute(LIST_ITEM_BUILTIN)); - if (isBuiltIn.booleanValue()) { - getBuiltInList().add(valueElement.getAttribute(LIST_ITEM_VALUE)); - } - else { - valueList.add(valueElement.getAttribute(LIST_ITEM_VALUE)); - } } - value = valueList; - break; - } - } - } - - /** - * Persist receiver to project file. - * - * @param doc - * @param element - */ - public void serialize(Document doc, Element element) { - element.setAttribute(ID, option.getId()); - - // value - switch (option.getValueType()) { - case BOOLEAN: - element.setAttribute(DEFAULT_VALUE, ((Boolean)value).toString()); - break; - case STRING: - case ENUMERATED: - element.setAttribute(DEFAULT_VALUE, (String)value); - break; - case STRING_LIST: - case INCLUDE_PATH: - case PREPROCESSOR_SYMBOLS: - case LIBRARIES: - case OBJECTS: - ArrayList stringList = (ArrayList)value; - ListIterator iter = stringList.listIterator(); - while (iter.hasNext()) { - Element valueElement = doc.createElement(LIST_VALUE); - valueElement.setAttribute(LIST_ITEM_VALUE, (String)iter.next()); - valueElement.setAttribute(LIST_ITEM_BUILTIN, "false"); //$NON-NLS-1$ - element.appendChild(valueElement); - } - // Serialize the built-ins that have been overridden - if (builtIns != null) { - iter = builtIns.listIterator(); - while (iter.hasNext()) { - Element valueElement = doc.createElement(LIST_VALUE); - valueElement.setAttribute(LIST_ITEM_VALUE, (String)iter.next()); - valueElement.setAttribute(LIST_ITEM_BUILTIN, "true"); //$NON-NLS-1$ - element.appendChild(valueElement); - } - } - break; - } - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getApplicableValues() - */ - public String[] getApplicableValues() { - return option.getApplicableValues(); - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getCategory() - */ - public IOptionCategory getCategory() { - return option.getCategory(); - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getCommand() - */ - public String getCommand() { - return option.getCommand(); - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getCommandFalse() - */ - public String getCommandFalse() { - return option.getCommandFalse(); - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getDefinedSymbols() - */ - public String[] getDefinedSymbols() throws BuildException { - if (value == null) - return option.getDefinedSymbols(); - else if (getValueType() == PREPROCESSOR_SYMBOLS) { - ArrayList list = (ArrayList)value; - return (String[]) list.toArray(new String[list.size()]); - } - else - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getEnumCommand(java.lang.String) - */ - public String getEnumCommand(String name) { - if (!resolved) { - resolveReferences(); - } - if (option != null) { - return option.getEnumCommand(name); - } else { - return new String(); - } - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.managedbuilder.core.IOption#getEnumeratedId(java.lang.String) - */ - public String getEnumeratedId(String name) { - if (!resolved) { - resolveReferences(); - } - if (option != null) { - return option.getEnumeratedId(name); - } else { - return new String(); - } - - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IBuildObject#getId() - */ - public String getId() { - // A reference has the same id as the option it references - return option.getId(); - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getIncludePaths() - */ - public String[] getIncludePaths() throws BuildException { - if (value == null) - return option.getIncludePaths(); - else if (getValueType() == INCLUDE_PATH) { - ArrayList list = (ArrayList)value; - return (String[]) list.toArray(new String[list.size()]); - } - else - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getLibraries() - */ - public String[] getLibraries() throws BuildException { - if (value == null) - return option.getLibraries(); - else if (getValueType() == LIBRARIES) { - ArrayList list = (ArrayList)value; - return (String[]) list.toArray(new String[list.size()]); - } - else - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IBuildObject#getName() - */ - public String getName() { - // A reference has the same name as the option it references - return option.getName(); - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getBooleanValue() - */ - public boolean getBooleanValue() throws BuildException { - if (value == null){ - return option.getBooleanValue(); - } - else if (getValueType() == BOOLEAN) { - Boolean bool = (Boolean) value; - return bool.booleanValue(); - } else { - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.managedbuilder.core.IOption#getBrowseType() - */ - public int getBrowseType() { - return option.getBrowseType(); - } - - private List getBuiltInList() { - if (builtIns == null) { - builtIns = new ArrayList(); - } - return builtIns; - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getBuiltIns() - */ - public String[] getBuiltIns() { - List answer = new ArrayList(); - if (builtIns != null) { - answer.addAll(builtIns); - } - - // Add the built-ins from the referenced option to the list - if (option != null) { - String[] optionBuiltIns = option.getBuiltIns(); - for (int index = 0; index < optionBuiltIns.length; ++index) { - if (!answer.contains(optionBuiltIns[index])) { - answer.add(optionBuiltIns[index]); - } - } - } - return (String[]) answer.toArray(new String[answer.size()]); - } - - /** - * @return the <code>IOption the reference is for</code> - */ - public IOption getOption() { - // This is an operation that requires the reference to be resolved - if (!resolved) { - resolveReferences(); - } - return option; - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.managedbuilder.core.IOption#getSelectedEnum() - */ - public String getSelectedEnum() throws BuildException { - // A reference to an enumerated option stores the ID of the selected enum in its value - if (value == null) { - // Return the default defined for the enumeration in the manifest. - return option.getSelectedEnum(); - } else if (getValueType() == ENUMERATED) { - // This is a valid ID - return (String) value; - } else { - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getStringListValue() - */ - public String[] getStringListValue() throws BuildException { - if (value == null) - return option.getStringListValue(); - else if (getValueType() == STRING_LIST) { - ArrayList list = (ArrayList)value; - return (String[]) list.toArray(new String[list.size()]); - } - else - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getStringValue() - */ - public String getStringValue() throws BuildException { - if (value == null) - return option.getStringValue(); - else if (getValueType() == STRING) - return (String)value; - else - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getTool() - */ - public ITool getTool() { - return owner; - } - - /** - * Answers the tool reference that contains the receiver. - * - * @return ToolReference - */ - public ToolReference getToolReference() { - return owner; - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.managedbuilder.core.IOption#getUserObjects() - */ - public String[] getUserObjects() throws BuildException { - if (value == null) - return option.getDefinedSymbols(); - else if (getValueType() == OBJECTS) { - ArrayList list = (ArrayList)value; - return (String[]) list.toArray(new String[list.size()]); - } - else - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - - /* (non-Javadoc) - * @see org.eclipse.cdt.core.build.managed.IOption#getValueType() - */ - public int getValueType() { - return option.getValueType(); - } - - /** - * Answers <code>true</code> if the receiver is a reference to the - * <code>IOption</code> specified in the argument, esle answers <code>false</code>. - * - * @param target - * @return boolean - */ - public boolean references(IOption target) { - if (equals(target)) { - // we are the target - return true; - } else if (option instanceof OptionReference) { - // check the reference we are overriding - return ((OptionReference)option).references(target); - } else { - // the real reference - return option.equals(target); - } - } - - /** - * Sets the boolean value of the receiver to the value specified in the argument. - * If the receive is not a reference to a boolean option, method will throw an - * exception. - * - * @param value - * @throws BuildException - */ - public void setValue(boolean value) throws BuildException { - if (getValueType() == BOOLEAN) - this.value = new Boolean(value); - else - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - - /** - * @param value - * @throws BuildException - */ - public void setValue(String value) throws BuildException { - // Note that we can still set the human-readable value here - if (getValueType() == STRING || getValueType() == ENUMERATED) { - this.value = value; - } else { - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - } - - /** - * Sets the value of the receiver to be an array of items. - * - * @param value An array of strings to place in the option reference. - * @throws BuildException - */ - public void setValue(String [] value) throws BuildException { - if (getValueType() == STRING_LIST - || getValueType() == INCLUDE_PATH - || getValueType() == PREPROCESSOR_SYMBOLS - || getValueType() == LIBRARIES - || getValueType() == OBJECTS) { - // Just replace what the option reference is holding onto - this.value = new ArrayList(Arrays.asList(value)); - } - else - throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ - } - - /* (non-Javadoc) - * @see java.lang.Object#toString() - */ - public String toString() { - String answer = new String(); - if (option != null) { - answer += "Reference to " + option.getName(); //$NON-NLS-1$ - } - - if (answer.length() > 0) { - return answer; - } else { - return super.toString(); - } - } - -} |