path: root/core/org.eclipse.cdt.core/build/org/eclipse/cdt/internal/core/build/managed/Option.java

/**********************************************************************
 * Copyright (c) 2003 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.internal.core.build.managed;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.eclipse.cdt.core.build.managed.BuildException;
import org.eclipse.cdt.core.build.managed.IConfiguration;
import org.eclipse.cdt.core.build.managed.IOption;
import org.eclipse.cdt.core.build.managed.IOptionCategory;
import org.eclipse.cdt.core.build.managed.ITool;
import org.eclipse.core.runtime.IConfigurationElement;

/**
 * 
 */
public class Option extends BuildObject implements IOption {

	private ITool tool;
	private IOptionCategory category;
	
	private int valueType;
	private Object value;
	private Map enumCommands;
	private String defaultEnumName;
	private String command;
	
	private static final String[] EMPTY_STRING_ARRAY = new String[0];
	private static final String EMPTY_STRING = new String();
	 
	public Option(ITool tool) {
		this.tool = tool;
	}
	
	public Option(Tool tool, IConfigurationElement element) {
		this(tool);
		
		// Get the unique id of the option
		setId(element.getAttribute(IOption.ID));
		
		// Hook me up to a tool
		tool.addOption(this);
		
		// Get the option Name (this is what the user will see in the UI)
		setName(element.getAttribute(IOption.NAME));

		// Options can be grouped into categories
		String categoryId = element.getAttribute(IOption.CATEGORY);
		if (categoryId != null)
			setCategory(tool.getOptionCategory(categoryId));
		
		// Get the command defined for the option
		command = element.getAttribute(IOption.COMMAND);
		
		// Options hold different types of values
		String valueTypeStr = element.getAttribute(IOption.VALUE_TYPE);
		if (valueTypeStr == null)
			valueType = -1;
		else if (valueTypeStr.equals(IOption.TYPE_STRING))
			valueType = IOption.STRING;
		else if (valueTypeStr.equals(IOption.TYPE_STR_LIST))
			valueType = IOption.STRING_LIST;
		else if (valueTypeStr.equals(IOption.TYPE_BOOL))
			valueType = IOption.BOOLEAN;
		else if (valueTypeStr.equals(IOption.TYPE_ENUM))
			valueType = IOption.ENUMERATED;
		else if (valueTypeStr.equals(IOption.TYPE_INC_PATH))
			valueType = IOption.INCLUDE_PATH;
		else if (valueTypeStr.equals(IOption.TYPE_LIB))
			valueType = IOption.LIBRARIES;
		else
			valueType = IOption.PREPROCESSOR_SYMBOLS;
		
		// Now get the actual value
		enumCommands = new HashMap();
		switch (valueType) {
			case IOption.BOOLEAN:
				// Convert the string to a boolean
				value = new Boolean(element.getAttribute(IOption.DEFAULT_VALUE));
				break;
			case IOption.STRING:
				// Just get the value out of the option directly
				value = element.getAttribute(IOption.DEFAULT_VALUE);
			break;
			case IOption.ENUMERATED:
				List enumList = new ArrayList();
				IConfigurationElement[] enumElements = element.getChildren(IOption.ENUM_VALUE);
				for (int i = 0; i < enumElements.length; ++i) {
					String optName = enumElements[i].getAttribute(IOption.NAME);
					String optCommand = enumElements[i].getAttribute(IOption.COMMAND); 
					enumList.add(optName);
					enumCommands.put(optName, optCommand);
					Boolean isDefault = new Boolean(enumElements[i].getAttribute(IOption.IS_DEFAULT));
					if (isDefault.booleanValue()) {
							defaultEnumName = optName; 
					}
				}
				value = enumList;
				break;
			case IOption.STRING_LIST:
			case IOption.INCLUDE_PATH:
			case IOption.PREPROCESSOR_SYMBOLS:
			case IOption.LIBRARIES:
				List valueList = new ArrayList();
				IConfigurationElement[] valueElements = element.getChildren(IOption.LIST_VALUE);
				for (int i = 0; i < valueElements.length; ++i) {
					valueList.add(valueElements[i].getAttribute(IOption.VALUE));
				}
				value = valueList;
				break;
			default :
				break;
		}
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getApplicableValues()
	 */
	public String[] getApplicableValues() {
		List enumValues = (List)value;
		return enumValues != null
			? (String[])enumValues.toArray(new String[enumValues.size()])
			: EMPTY_STRING_ARRAY;
	}

	public boolean getBooleanValue() {
		Boolean bool = (Boolean) value;
		return bool.booleanValue();
	}
	
	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getCategory()
	 */
	public IOptionCategory getCategory() {
		return category != null ? category : getTool().getTopOptionCategory();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getCommand()
	 */
	public String getCommand() {
		return command;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getDefinedSymbols()
	 */
	public String[] getDefinedSymbols() throws BuildException {
		if (valueType != IOption.PREPROCESSOR_SYMBOLS) {
			throw new BuildException("bad value type");
		}
		List v = (List)value;
		return v != null
			? (String[])v.toArray(new String[v.size()])
			: EMPTY_STRING_ARRAY;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getEnumCommand(java.lang.String)
	 */
	public String getEnumCommand(String name) {
		String cmd = (String) enumCommands.get(name); 
		return cmd == null ? EMPTY_STRING : cmd;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getIncludePaths()
	 */
	public String[] getIncludePaths() throws BuildException {
		if (valueType != IOption.INCLUDE_PATH) {
			throw new BuildException("bad value type");
		}
		List v = (List)value;
		return v != null
			? (String[])v.toArray(new String[v.size()])
			: EMPTY_STRING_ARRAY;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getLibraries()
	 */
	public String[] getLibraries() throws BuildException {
		if (valueType != IOption.LIBRARIES) {
			throw new BuildException("bad value type");
		}
		List v = (List)value;
		return v != null
			? (String[])v.toArray(new String[v.size()])
			: EMPTY_STRING_ARRAY;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getDefaultEnumValue()
	 */
	public String getSelectedEnum() throws BuildException {
		if (valueType != IOption.ENUMERATED) {
			throw new BuildException("bad value type");
		}
		return defaultEnumName == null ? EMPTY_STRING : defaultEnumName;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getStringListValue()
	 */
	public String[] getStringListValue() throws BuildException {
		if (valueType != IOption.STRING_LIST) {
			throw new BuildException("bad value type");
		}
		List v = (List)value;
		return v != null
			? (String[])v.toArray(new String[v.size()])
			: EMPTY_STRING_ARRAY;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getStringValue()
	 */
	public String getStringValue() throws BuildException {
		if (valueType != IOption.STRING) {
			throw new BuildException("bad value type");
		}
		return value == null ? EMPTY_STRING : (String)value;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getTool()
	 */
	public ITool getTool() {
		return tool;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#getValueType()
	 */
	public int getValueType() {
		return valueType;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#setCategory(org.eclipse.cdt.core.build.managed.IOptionCategory)
	 */
	public void setCategory(IOptionCategory category) {
		this.category = category;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#setStringValue(org.eclipse.cdt.core.build.managed.IConfiguration, java.lang.String)
	 */
	public IOption setValue(IConfiguration config, String value)
		throws BuildException
	{
		if (valueType != IOption.STRING
			|| valueType != IOption.ENUMERATED)
			throw new BuildException("Bad value for type");

		if (config == null) {
			this.value = value;
			return this;
		} else {
			// Magic time
			return null;
		}
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.core.build.managed.IOption#setStringValue(org.eclipse.cdt.core.build.managed.IConfiguration, java.lang.String[])
	 */
	public IOption setValue(IConfiguration config, String[] value)
		throws BuildException
	{
		if (valueType != IOption.STRING_LIST 
			|| valueType != IOption.INCLUDE_PATH
			|| valueType != IOption.PREPROCESSOR_SYMBOLS
			|| valueType != IOption.LIBRARIES)
			throw new BuildException("Bad value for type");
		
		if (config == null) {
			this.value = value;
			return this;
		} else {
			// More magic
			return null;
		}
	}

}