1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-09-01 04:33:36 +02:00

Fix line endings

This commit is contained in:
Leo Treggiari 2006-03-07 18:39:40 +00:00
parent bdc33b193c
commit 73debc0e33
4 changed files with 2121 additions and 2121 deletions

View file

@ -1,391 +1,391 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2005, 2006 Intel Corporation and others. * Copyright (c) 2005, 2006 Intel Corporation and others.
* All rights reserved. This program and the accompanying materials * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html * http://www.eclipse.org/legal/epl-v10.html
* *
* Contributors: * Contributors:
* Intel Corporation - Initial API and implementation * Intel Corporation - Initial API and implementation
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.managedbuilder.core; package org.eclipse.cdt.managedbuilder.core;
import org.eclipse.cdt.managedbuilder.makegen.IManagedDependencyGeneratorType; import org.eclipse.cdt.managedbuilder.makegen.IManagedDependencyGeneratorType;
import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.content.IContentType; import org.eclipse.core.runtime.content.IContentType;
/** /**
* This interface represents an inputType instance in the managed build system. * This interface represents an inputType instance in the managed build system.
* It describes one category of input files to a Tool. A tool can have * It describes one category of input files to a Tool. A tool can have
* multiple inputType children. * multiple inputType children.
* *
* @since 3.0 * @since 3.0
*/ */
public interface IInputType extends IBuildObject { public interface IInputType extends IBuildObject {
public static final String INPUT_TYPE_ELEMENT_NAME = "inputType"; //$NON-NLS-1$ public static final String INPUT_TYPE_ELEMENT_NAME = "inputType"; //$NON-NLS-1$
public static final String SOURCE_CONTENT_TYPE = "sourceContentType"; //$NON-NLS-1$ public static final String SOURCE_CONTENT_TYPE = "sourceContentType"; //$NON-NLS-1$
public static final String SOURCES = "sources"; //$NON-NLS-1$ public static final String SOURCES = "sources"; //$NON-NLS-1$
public static final String DEPENDENCY_CONTENT_TYPE = "dependencyContentType"; //$NON-NLS-1$ public static final String DEPENDENCY_CONTENT_TYPE = "dependencyContentType"; //$NON-NLS-1$
public static final String DEPENDENCY_EXTENSIONS = "dependencyExtensions"; //$NON-NLS-1$ public static final String DEPENDENCY_EXTENSIONS = "dependencyExtensions"; //$NON-NLS-1$
public static final String OPTION = "option"; //$NON-NLS-1$ public static final String OPTION = "option"; //$NON-NLS-1$
public static final String ASSIGN_TO_OPTION = "assignToOption"; //$NON-NLS-1$ public static final String ASSIGN_TO_OPTION = "assignToOption"; //$NON-NLS-1$
public static final String MULTIPLE_OF_TYPE = "multipleOfType"; //$NON-NLS-1$ public static final String MULTIPLE_OF_TYPE = "multipleOfType"; //$NON-NLS-1$
public static final String PRIMARY_INPUT = "primaryInput"; //$NON-NLS-1$ public static final String PRIMARY_INPUT = "primaryInput"; //$NON-NLS-1$
public static final String BUILD_VARIABLE = "buildVariable"; //$NON-NLS-1$ public static final String BUILD_VARIABLE = "buildVariable"; //$NON-NLS-1$
/** /**
* Creates an inputOrder child for this InputType. * Creates an inputOrder child for this InputType.
* *
* @param path The path associated with the InputOrder element * @param path The path associated with the InputOrder element
* @return IInputOrder of the new element * @return IInputOrder of the new element
*/ */
public IInputOrder createInputOrder(String path); public IInputOrder createInputOrder(String path);
/** /**
* Removes the InputOrder element with the path specified in the argument. * Removes the InputOrder element with the path specified in the argument.
* *
* @param path The path associated with the InputOrder element * @param path The path associated with the InputOrder element
*/ */
public void removeInputOrder(String path); public void removeInputOrder(String path);
/** /**
* Removes the InputOrder element specified in the argument. * Removes the InputOrder element specified in the argument.
* *
* @param path The InputOrder element * @param path The InputOrder element
*/ */
public void removeInputOrder(IInputOrder element); public void removeInputOrder(IInputOrder element);
/** /**
* Returns all of the InputOrder children of this InputType * Returns all of the InputOrder children of this InputType
* *
* @return IInputOrder[] * @return IInputOrder[]
*/ */
public IInputOrder[] getInputOrders(); public IInputOrder[] getInputOrders();
/** /**
* Returns the InputOrder element with the path specified in the argument. * Returns the InputOrder element with the path specified in the argument.
* *
* @param path The path associated with the InputOrder element * @param path The path associated with the InputOrder element
* @return IInputOrder * @return IInputOrder
*/ */
public IInputOrder getInputOrder(String path); public IInputOrder getInputOrder(String path);
/** /**
* Creates an additionalInput child for this InputType. * Creates an additionalInput child for this InputType.
* *
* @param path The path associated with the AdditionalInput element * @param path The path associated with the AdditionalInput element
* @return IAdditionalInput of the new element * @return IAdditionalInput of the new element
*/ */
public IAdditionalInput createAdditionalInput(String path); public IAdditionalInput createAdditionalInput(String path);
/** /**
* Removes the AdditionalInput element with the path specified in the argument. * Removes the AdditionalInput element with the path specified in the argument.
* *
* @param path The path associated with the AdditionalInput element * @param path The path associated with the AdditionalInput element
*/ */
public void removeAdditionalInput(String path); public void removeAdditionalInput(String path);
/** /**
* Removes the AdditionalInput element specified in the argument. * Removes the AdditionalInput element specified in the argument.
* *
* @param element The AdditionalInput element * @param element The AdditionalInput element
*/ */
public void removeAdditionalInput(IAdditionalInput element); public void removeAdditionalInput(IAdditionalInput element);
/** /**
* Returns all of the AdditionalInput children of this InputType * Returns all of the AdditionalInput children of this InputType
* *
* @return IAdditionalInput[] * @return IAdditionalInput[]
*/ */
public IAdditionalInput[] getAdditionalInputs(); public IAdditionalInput[] getAdditionalInputs();
/** /**
* Returns the AdditionalInput element with the path specified in the argument. * Returns the AdditionalInput element with the path specified in the argument.
* *
* @param path The path associated with the AdditionalInput element * @param path The path associated with the AdditionalInput element
* @return IAdditionalInput * @return IAdditionalInput
*/ */
public IAdditionalInput getAdditionalInput(String path); public IAdditionalInput getAdditionalInput(String path);
/** /**
* Returns all of the additional input resources of this InputType. * Returns all of the additional input resources of this InputType.
* Note: This does not include additional dependencies. * Note: This does not include additional dependencies.
* *
* @return IPath[] * @return IPath[]
*/ */
public IPath[] getAdditionalResources(); public IPath[] getAdditionalResources();
/** /**
* Returns all of the additional dependency resources of this InputType. * Returns all of the additional dependency resources of this InputType.
* Note: This does not include additional inputs. * Note: This does not include additional inputs.
* *
* @return IPath[] * @return IPath[]
*/ */
public IPath[] getAdditionalDependencies(); public IPath[] getAdditionalDependencies();
/** /**
* Returns the tool parent of this InputType. * Returns the tool parent of this InputType.
* *
* @return ITool * @return ITool
*/ */
public ITool getParent(); public ITool getParent();
/** /**
* Returns the <code>IInputType</code> that is the superclass of this * Returns the <code>IInputType</code> that is the superclass of this
* InputType, or <code>null</code> if the attribute was not specified. * InputType, or <code>null</code> if the attribute was not specified.
* *
* @return IInputType * @return IInputType
*/ */
public IInputType getSuperClass(); public IInputType getSuperClass();
/** /**
* Returns the Eclipse <code>IContentType</code> that describes this * Returns the Eclipse <code>IContentType</code> that describes this
* input type. If both the sources attribute and the sourceContentType * input type. If both the sources attribute and the sourceContentType
* attribute are specified, the sourceContentType will be used if it * attribute are specified, the sourceContentType will be used if it
* is registered in Eclipse. * is registered in Eclipse.
* *
* @return IContentType * @return IContentType
*/ */
public IContentType getSourceContentType(); public IContentType getSourceContentType();
/** /**
* Sets the Eclipse <code>IContentType</code> that describes this * Sets the Eclipse <code>IContentType</code> that describes this
* input type. * input type.
* *
* @param contentType The Eclipse content type * @param contentType The Eclipse content type
*/ */
public void setSourceContentType(IContentType contentType); public void setSourceContentType(IContentType contentType);
/** /**
* Returns the list of valid source extensions from the * Returns the list of valid source extensions from the
* sourceExtensions attribute. Note that this value is not used * sourceExtensions attribute. Note that this value is not used
* if source content type is specified and registered with Eclipse. * if source content type is specified and registered with Eclipse.
* Also, the user will not be able to modify the set of file * Also, the user will not be able to modify the set of file
* extensions as they can when sourceContentType is specified. * extensions as they can when sourceContentType is specified.
* *
* @return String[] * @return String[]
*/ */
public String[] getSourceExtensionsAttribute(); public String[] getSourceExtensionsAttribute();
/** /**
* Sets the list of valid source extensions for this input type. * Sets the list of valid source extensions for this input type.
* NOTE: The value of this attribute will NOT be used if a * NOTE: The value of this attribute will NOT be used if a
* source content type is specified and is registered with * source content type is specified and is registered with
* Eclipse. * Eclipse.
* *
* @param extensions The comma-separated list of valid file extensions * @param extensions The comma-separated list of valid file extensions
* - not including the separator period. * - not including the separator period.
*/ */
public void setSourceExtensionsAttribute(String extensions); public void setSourceExtensionsAttribute(String extensions);
/** /**
* Returns the list of valid source extensions for this input type. * Returns the list of valid source extensions for this input type.
* Note that the list will come from the sourceContentType if it * Note that the list will come from the sourceContentType if it
* is specified and registered with Eclipse. Otherwise the * is specified and registered with Eclipse. Otherwise the
* sourceExtensions attribute will be used. * sourceExtensions attribute will be used.
* *
* @param tool the tool that contains the input-type * @param tool the tool that contains the input-type
* @return String[] * @return String[]
*/ */
public String[] getSourceExtensions(ITool tool); public String[] getSourceExtensions(ITool tool);
/** /**
* Answers <code>true</code> if the input type considers the file extension to be * Answers <code>true</code> if the input type considers the file extension to be
* one associated with a source file. * one associated with a source file.
* *
* @param tool the tool that contains the input-type * @param tool the tool that contains the input-type
* @param ext file extension of the source * @param ext file extension of the source
* @return boolean * @return boolean
*/ */
public boolean isSourceExtension(ITool tool, String ext); public boolean isSourceExtension(ITool tool, String ext);
/** /**
* Returns the Eclipse <code>IContentType</code> that describes the * Returns the Eclipse <code>IContentType</code> that describes the
* dependency files of this input type. If both the dependencyExtensions * dependency files of this input type. If both the dependencyExtensions
* attribute and the dependencyContentType attribute are specified, * attribute and the dependencyContentType attribute are specified,
* the dependencyContentType will be used if it is defined in Eclipse. * the dependencyContentType will be used if it is defined in Eclipse.
* *
* @return IContentType * @return IContentType
*/ */
public IContentType getDependencyContentType(); public IContentType getDependencyContentType();
/** /**
* Sets the Eclipse <code>IContentType</code> that describes the * Sets the Eclipse <code>IContentType</code> that describes the
* dependency files of this input type. * dependency files of this input type.
* *
* @return type * @return type
*/ */
public void setDependencyContentType(IContentType type); public void setDependencyContentType(IContentType type);
/** /**
* Returns the list of valid dependency extensions from the * Returns the list of valid dependency extensions from the
* dependencyExtensions attribute. Note that this value is not used * dependencyExtensions attribute. Note that this value is not used
* if dependency content type is specified and registered with Eclipse. * if dependency content type is specified and registered with Eclipse.
* Also, the user will not be able to modify the set of file * Also, the user will not be able to modify the set of file
* extensions as they can when dependencyContentType is specified. * extensions as they can when dependencyContentType is specified.
* *
* @return String[] * @return String[]
*/ */
public String[] getDependencyExtensionsAttribute(); public String[] getDependencyExtensionsAttribute();
/** /**
* Sets the list of valid dependency extensions for this input type. * Sets the list of valid dependency extensions for this input type.
* NOTE: The value of this attribute will NOT be used if a * NOTE: The value of this attribute will NOT be used if a
* dependency content type is specified and is registered with * dependency content type is specified and is registered with
* Eclipse. * Eclipse.
* *
* @param extensions The comma-separated list of valid dependency extensions * @param extensions The comma-separated list of valid dependency extensions
* - not including the separator period. * - not including the separator period.
*/ */
public void setDependencyExtensionsAttribute(String extensions); public void setDependencyExtensionsAttribute(String extensions);
/** /**
* Returns the list of valid dependency extensions for this input type. * Returns the list of valid dependency extensions for this input type.
* Note that the list will come from the dependencyContentType if it * Note that the list will come from the dependencyContentType if it
* is specified and registered with Eclipse. Otherwise the * is specified and registered with Eclipse. Otherwise the
* dependencyExtensions attribute will be used. * dependencyExtensions attribute will be used.
* *
* @param tool the tool that contains the input-type * @param tool the tool that contains the input-type
* @return String[] * @return String[]
*/ */
public String[] getDependencyExtensions(ITool tool); public String[] getDependencyExtensions(ITool tool);
/** /**
* Answers <code>true</code> if the input type considers the file extension to be * Answers <code>true</code> if the input type considers the file extension to be
* one associated with a dependency file. * one associated with a dependency file.
* *
* @param tool the tool that contains the input-type * @param tool the tool that contains the input-type
* @param ext file extension of the source * @param ext file extension of the source
* @return boolean * @return boolean
*/ */
public boolean isDependencyExtension(ITool tool, String ext); public boolean isDependencyExtension(ITool tool, String ext);
/** /**
* Returns the id of the option that is associated with this input * Returns the id of the option that is associated with this input
* type on the command line. If specified, the name(s) of the input * type on the command line. If specified, the name(s) of the input
* files for this input type are taken from the value specified * files for this input type are taken from the value specified
* for the option. * for the option.
* *
* @return String * @return String
*/ */
public String getOptionId(); public String getOptionId();
/** /**
* Sets the id of the option that is associated with this input type on * Sets the id of the option that is associated with this input type on
* the command line. If specified, the name(s) of the input files for * the command line. If specified, the name(s) of the input files for
* this input type are taken from the value specified for the option. * this input type are taken from the value specified for the option.
* *
* @param optionId * @param optionId
*/ */
public void setOptionId(String optionId); public void setOptionId(String optionId);
/** /**
* Returns the id of the option whose value is to be assigned to the * Returns the id of the option whose value is to be assigned to the
* file(s) calculated for this input type. The default is not to * file(s) calculated for this input type. The default is not to
* assign the input file(s) to a command line option but to assign the * assign the input file(s) to a command line option but to assign the
* files to the ${Inputs} part of the command line. Note that the * files to the ${Inputs} part of the command line. Note that the
* option value is only updated during build file generation and therefore * option value is only updated during build file generation and therefore
* could be out of sync with the project until build file generation * could be out of sync with the project until build file generation
* occurs. * occurs.
* *
* @return String * @return String
*/ */
public String getAssignToOptionId(); public String getAssignToOptionId();
/** /**
* Sets the id of the option whose value is to be assigned to the * Sets the id of the option whose value is to be assigned to the
* file(s) calculated for this input type. The default is not to * file(s) calculated for this input type. The default is not to
* assign the input file(s) to a command line option but to assign the * assign the input file(s) to a command line option but to assign the
* files to the ${Inputs} part of the command line. Note that the * files to the ${Inputs} part of the command line. Note that the
* option value is only updated during build file generation and therefore * option value is only updated during build file generation and therefore
* could be out of sync with the project until build file generation * could be out of sync with the project until build file generation
* occurs. * occurs.
* *
* @param optionId * @param optionId
*/ */
public void setAssignToOptionId(String optionId); public void setAssignToOptionId(String optionId);
/** /**
* Returns <code>true</code> if this inputType can contain multiple input * Returns <code>true</code> if this inputType can contain multiple input
* resources, else <code>false</code>. The inputs can be project resources, * resources, else <code>false</code>. The inputs can be project resources,
* or the outputs of other tools in the tool-chain. * or the outputs of other tools in the tool-chain.
* *
* @return boolean * @return boolean
*/ */
public boolean getMultipleOfType(); public boolean getMultipleOfType();
/** /**
* Sets whether this inputType can contain multiple input resources * Sets whether this inputType can contain multiple input resources
* *
* @param multiple * @param multiple
*/ */
public void setMultipleOfType(boolean multiple); public void setMultipleOfType(boolean multiple);
/** /**
* Returns <code>true</code> if this inputType is considered the primary input * Returns <code>true</code> if this inputType is considered the primary input
* of the tool, else <code>false</code>. * of the tool, else <code>false</code>.
* *
* @return boolean * @return boolean
*/ */
public boolean getPrimaryInput(); public boolean getPrimaryInput();
/** /**
* Sets whether this inputType is considered the primary input of the tool * Sets whether this inputType is considered the primary input of the tool
* *
* @param primary * @param primary
*/ */
public void setPrimaryInput(boolean primary); public void setPrimaryInput(boolean primary);
/** /**
* Returns a class instance that implements an interface to generate * Returns a class instance that implements an interface to generate
* source-level dependencies for this input type. * source-level dependencies for this input type.
* This method may return <code>null</code> in which case, the receiver * This method may return <code>null</code> in which case, the receiver
* should assume that the input type does not require dependency information * should assume that the input type does not require dependency information
* when the project is built. * when the project is built.
* *
* @return IManagedDependencyGeneratorType * @return IManagedDependencyGeneratorType
*/ */
public IManagedDependencyGeneratorType getDependencyGenerator(); public IManagedDependencyGeneratorType getDependencyGenerator();
/** /**
* Returns the name of the build variable associated this this input type's resources * Returns the name of the build variable associated this this input type's resources
* The build variable used in the build file to represent the list of input files when * The build variable used in the build file to represent the list of input files when
* multipleOfType is True. The same variable name can be used by an outputType to * multipleOfType is True. The same variable name can be used by an outputType to
* identify a set of output files that contribute to this tools input * identify a set of output files that contribute to this tools input
* (i.e., those using the same buildVariable name). The default name is chosen by MBS. * (i.e., those using the same buildVariable name). The default name is chosen by MBS.
* *
* @return String * @return String
*/ */
public String getBuildVariable(); public String getBuildVariable();
/** /**
* Sets the name of the build variable associated this this input type's resources * Sets the name of the build variable associated this this input type's resources
* *
* @return variableName * @return variableName
*/ */
public void setBuildVariable(String variableName); public void setBuildVariable(String variableName);
/** /**
* Returns <code>true</code> if this element has changes that need to * Returns <code>true</code> if this element has changes that need to
* be saved in the project file, else <code>false</code>. * be saved in the project file, else <code>false</code>.
* *
* @return boolean * @return boolean
*/ */
public boolean isDirty(); public boolean isDirty();
/** /**
* Returns <code>true</code> if this InputType was loaded from a manifest file, * Returns <code>true</code> if this InputType was loaded from a manifest file,
* and <code>false</code> if it was loaded from a project (.cdtbuild) file. * and <code>false</code> if it was loaded from a project (.cdtbuild) file.
* *
* @return boolean * @return boolean
*/ */
public boolean isExtensionElement(); public boolean isExtensionElement();
/** /**
* Sets the element's "dirty" (have I been modified?) flag. * Sets the element's "dirty" (have I been modified?) flag.
* *
* @param isDirty * @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);
} }