Initial import.

[mirror_edk2.git] / Tools / Source / Cpptasks / net / sf / antcontrib / cpptasks / compiler / Linker.java

/*\r
 * \r
 * Copyright 2001-2004 The Ant-Contrib project\r
 *\r
 *  Licensed under the Apache License, Version 2.0 (the "License");\r
 *  you may not use this file except in compliance with the License.\r
 *  You may obtain a copy of the License at\r
 *\r
 *      http://www.apache.org/licenses/LICENSE-2.0\r
 *\r
 *  Unless required by applicable law or agreed to in writing, software\r
 *  distributed under the License is distributed on an "AS IS" BASIS,\r
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
 *  See the License for the specific language governing permissions and\r
 *  limitations under the License.\r
 */\r
package net.sf.antcontrib.cpptasks.compiler;\r
import java.io.File;\r
import net.sf.antcontrib.cpptasks.types.LibraryTypeEnum;\r
/**\r
 * A linker for executables, and static and dynamic libraries.\r
 * \r
 * @author Adam Murdoch\r
 */\r
public interface Linker extends Processor {\r
    /**\r
     * Extracts the significant part of a library name to ensure there aren't\r
     * collisions\r
     */\r
    String getLibraryKey(File libname);\r
    /**\r
     * returns the library path for the linker\r
     */\r
    File[] getLibraryPath();\r
    /**\r
     * Returns a set of filename patterns corresponding to library names.\r
     * \r
     * For example, "advapi32" would be expanded to "advapi32.dll" by\r
     * DevStudioLinker and to "libadvapi32.a" and "libadvapi32.so" by\r
     * GccLinker.\r
     * \r
     * @param libnames\r
     *            array of library names\r
     */\r
    String[] getLibraryPatterns(String[] libnames, LibraryTypeEnum libraryType);\r
    /**\r
     * Gets the linker for the specified link type.\r
     * \r
     * @return appropriate linker or null, will return this if this linker can\r
     *         handle the specified link type\r
     */\r
    Linker getLinker(LinkType linkType);\r
    /**\r
     * Returns true if the linker is case-sensitive\r
     */\r
    boolean isCaseSensitive();\r
}\r