moved exception and logger classes to org.tianocore.common package; and created defin...

[mirror_edk2.git] / Tools / Source / Common / org / tianocore / common / definitions / ToolDefinitions.java

diff --git a/Tools/Source/Common/org/tianocore/common/definitions/ToolDefinitions.java b/Tools/Source/Common/org/tianocore/common/definitions/ToolDefinitions.java
new file mode 100644 (file)
index 0000000..cc95e1f
--- /dev/null
+++ b/Tools/Source/Common/org/tianocore/common/definitions/ToolDefinitions.java
@@ -0,0 +1,100 @@
+/** @file\r
+  ToolDefinitions Class.\r
+\r
+  ToolDefinitions class incldes the common Tool definitions.\r
+\r
+Copyright (c) 2006, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+package org.tianocore.definitions;\r
+\r
+import java.io.File;\r
+\r
+/**\r
+  This class includes the common Tool definitions.\r
+ **/\r
+public class ToolDefinitions {\r
+    ///\r
+    /// Line separator (carriage return-line feed, CRLF)\r
+    ///\r
+    public final static String LINE_SEPARATOR = "\r\n";\r
+\r
+    ///\r
+    /// Framework Database (FrameworkDatabase.db) file path\r
+    ///\r
+    public final static String FRAMEWORK_DATABASE_FILE_PATH =\r
+        "Tools" + File.separatorChar + "Conf" + File.separatorChar + "FrameworkDatabase.db";\r
+\r
+    ///\r
+    /// Target (target.txt) file path\r
+    ///\r
+    public final static String TARGET_FILE_PATH =\r
+        "Tools" + File.separatorChar + "Conf" + File.separatorChar + "target.txt";\r
+\r
+    ///\r
+    /// Default Tools Definition (tools_def.txt) file path\r
+    ///\r
+    public final static String DEFAULT_TOOLS_DEF_FILE_PATH =\r
+        "Tools" + File.separatorChar + "Conf" + File.separatorChar + "tools_def.txt";\r
+\r
+    ///\r
+    /// Extension names for SPD, FPD, and MSA\r
+    ///\r
+    public final static String SPD_EXTENSION    = ".spd";\r
+    public final static String FPD_EXTENSION    = ".fpd";\r
+    public final static String MSA_EXTENSION    = ".msa";\r
+\r
+    ///\r
+    /// Tool Chain Elements in the Tools Definition file\r
+    ///\r
+    public final static String TOOLS_DEF_ELEMENT_TARGET       = "TARGET";\r
+    public final static String TOOLS_DEF_ELEMENT_TOOLCHAIN    = "TOOLCHAIN";\r
+    public final static String TOOLS_DEF_ELEMENT_ARCH         = "ARCH";\r
+    public final static String TOOLS_DEF_ELEMENT_TOOLCODE     = "TOOLCODE";\r
+    public final static String TOOLS_DEF_ELEMENT_ATTRIBUTE    = "ATTRIBUTE";\r
+\r
+    ///\r
+    /// Index of Tool Chain elements in the Tools Definition file\r
+    ///\r
+    public final static int TOOLS_DEF_ELEMENT_INDEX_TARGET      = 0;\r
+    public final static int TOOLS_DEF_ELEMENT_INDEX_TOOLCHAIN   = 1;\r
+    public final static int TOOLS_DEF_ELEMENT_INDEX_ARCH        = 2;\r
+    public final static int TOOLS_DEF_ELEMENT_INDEX_TOOLCODE    = 3;\r
+    public final static int TOOLS_DEF_ELEMENT_INDEX_ATTRIBUTE   = 4;\r
+    public final static int TOOLS_DEF_ELEMENT_INDEX_MAXIMUM     = 5;\r
+\r
+    ///\r
+    /// Tool Chain Attributes in the Tools Definition file\r
+    ///\r
+    public final static String TOOLS_DEF_ATTRIBUTE_NAME       = "NAME";\r
+    public final static String TOOLS_DEF_ATTRIBUTE_PATH       = "PATH";\r
+    public final static String TOOLS_DEF_ATTRIBUTE_DPATH      = "DPATH";\r
+    public final static String TOOLS_DEF_ATTRIBUTE_SPATH      = "SPATH";\r
+    public final static String TOOLS_DEF_ATTRIBUTE_EXT        = "EXT";\r
+    public final static String TOOLS_DEF_ATTRIBUTE_FAMILY     = "FAMILY";\r
+    public final static String TOOLS_DEF_ATTRIBUTE_FLAGS      = "FALGS";\r
+\r
+    ///\r
+    /// Tool Chain Families in the Tools Definition file\r
+    ///\r
+    public final static String TOOLS_DEF_FAMILY_MSFT          = "MSFT";\r
+    public final static String TOOLS_DEF_FAMILY_INTEL         = "INTEL";\r
+    public final static String TOOLS_DEF_FAMILY_GCC           = "GCC";\r
+\r
+    ///\r
+    /// Key name in the Target file\r
+    ///\r
+    public final static String TARGET_KEY_ACTIVE_PLATFORM     = "ACTIVE_PLATFORM";\r
+    public final static String TARGET_KEY_TARGET              = "TARGET";\r
+    public final static String TARGET_KEY_TOOLCHAIN           = "TOOL_CHAIN_TAG";\r
+    public final static String TARGET_KEY_ARCH                = "TARGET_ARCH";\r
+    public final static String TARGET_KEY_TOOLS_DEF           = "TOOL_CHAIN_CONF";\r
+}\r