Tools/Source/Common/org/tianocore/common/definitions/ToolDefinitions.java

   1 /** @file
   2   ToolDefinitions Class.
   3
   4   ToolDefinitions class incldes the common Tool definitions.
   5
   6 Copyright (c) 2006, Intel Corporation
   7 All rights reserved. This program and the accompanying materials
   8 are licensed and made available under the terms and conditions of the BSD License
   9 which accompanies this distribution.  The full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 package org.tianocore.common.definitions;
  18
  19 import java.io.File;
  20
  21 /**
  22   This class includes the common Tool definitions.
  23  **/
  24 public class ToolDefinitions {
  25     ///
  26     /// Line separator (carriage return-line feed, CRLF)
  27     ///
  28     public final static String LINE_SEPARATOR = "\r\n";
  29
  30     ///
  31     /// Framework Database (FrameworkDatabase.db) file path
  32     ///
  33     public final static String FRAMEWORK_DATABASE_FILE_PATH =
  34         "Tools" + File.separatorChar + "Conf" + File.separatorChar + "FrameworkDatabase.db";
  35
  36     ///
  37     /// Target (target.txt) file path
  38     ///
  39     public final static String TARGET_FILE_PATH =
  40         "Tools" + File.separatorChar + "Conf" + File.separatorChar + "target.txt";
  41
  42     ///
  43     /// Default Tools Definition (tools_def.txt) file path
  44     ///
  45     public final static String DEFAULT_TOOLS_DEF_FILE_PATH =
  46         "Tools" + File.separatorChar + "Conf" + File.separatorChar + "tools_def.txt";
  47
  48     ///
  49     /// Extension names for SPD, FPD, and MSA
  50     ///
  51     public final static String SPD_EXTENSION    = ".spd";
  52     public final static String FPD_EXTENSION    = ".fpd";
  53     public final static String MSA_EXTENSION    = ".msa";
  54
  55     ///
  56     /// Tool Chain Elements in the Tools Definition file
  57     ///
  58     public final static String TOOLS_DEF_ELEMENT_TARGET       = "TARGET";
  59     public final static String TOOLS_DEF_ELEMENT_TOOLCHAIN    = "TOOLCHAIN";
  60     public final static String TOOLS_DEF_ELEMENT_ARCH         = "ARCH";
  61     public final static String TOOLS_DEF_ELEMENT_TOOLCODE     = "TOOLCODE";
  62     public final static String TOOLS_DEF_ELEMENT_ATTRIBUTE    = "ATTRIBUTE";
  63
  64     ///
  65     /// Index of Tool Chain elements in the Tools Definition file
  66     ///
  67     public final static int TOOLS_DEF_ELEMENT_INDEX_TARGET      = 0;
  68     public final static int TOOLS_DEF_ELEMENT_INDEX_TOOLCHAIN   = 1;
  69     public final static int TOOLS_DEF_ELEMENT_INDEX_ARCH        = 2;
  70     public final static int TOOLS_DEF_ELEMENT_INDEX_TOOLCODE    = 3;
  71     public final static int TOOLS_DEF_ELEMENT_INDEX_ATTRIBUTE   = 4;
  72     public final static int TOOLS_DEF_ELEMENT_INDEX_MAXIMUM     = 5;
  73
  74     ///
  75     /// Tool Chain Attributes in the Tools Definition file
  76     ///
  77     public final static String TOOLS_DEF_ATTRIBUTE_NAME       = "NAME";
  78     public final static String TOOLS_DEF_ATTRIBUTE_PATH       = "PATH";
  79     public final static String TOOLS_DEF_ATTRIBUTE_DPATH      = "DPATH";
  80     public final static String TOOLS_DEF_ATTRIBUTE_SPATH      = "SPATH";
  81     public final static String TOOLS_DEF_ATTRIBUTE_EXT        = "EXT";
  82     public final static String TOOLS_DEF_ATTRIBUTE_FAMILY     = "FAMILY";
  83     public final static String TOOLS_DEF_ATTRIBUTE_FLAGS      = "FLAGS";
  84
  85     ///
  86     /// Tool Chain Families in the Tools Definition file
  87     ///
  88     public final static String TOOLS_DEF_FAMILY_MSFT          = "MSFT";
  89     public final static String TOOLS_DEF_FAMILY_INTEL         = "INTEL";
  90     public final static String TOOLS_DEF_FAMILY_GCC           = "GCC";
  91
  92     ///
  93     /// Key name in the Target file
  94     ///
  95     public final static String TARGET_KEY_ACTIVE_PLATFORM     = "ACTIVE_PLATFORM";
  96     public final static String TARGET_KEY_TARGET              = "TARGET";
  97     public final static String TARGET_KEY_TOOLCHAIN           = "TOOL_CHAIN_TAG";
  98     public final static String TARGET_KEY_ARCH                = "TARGET_ARCH";
  99     public final static String TARGET_KEY_TOOLS_DEF           = "TOOL_CHAIN_CONF";
 100 }