BaseTools/Source/C/VfrCompile/VfrCompiler.h

   1 /** @file
   2
   3   VfrCompiler internal defintions.
   4
   5 Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
   6 This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _VFRCOMPILER_H_
  17 #define _VFRCOMPILER_H_
  18
  19 #include "Common/UefiBaseTypes.h"
  20 #include "EfiVfr.h"
  21 #include "VfrFormPkg.h"
  22 #include "VfrUtilityLib.h"
  23 #include "ParseInf.h"
  24
  25 #define PROGRAM_NAME                       "VfrCompile"
  26 #define VFR_COMPILER_VERSION               " 2.00 (UEFI 2.3.1)"
  27 #define VFR_COMPILER_UPDATE_TIME           " updated on 2011/07/15"
  28 //
  29 // This is how we invoke the C preprocessor on the VFR source file
  30 // to resolve #defines, #includes, etc. To make C source files
  31 // shareable between VFR and drivers, define VFRCOMPILE so that
  32 // #ifdefs can be used in shared .h files.
  33 //
  34 #define PREPROCESSOR_COMMAND                "cl "
  35 #define PREPROCESSOR_OPTIONS                "/nologo /E /TC /DVFRCOMPILE "
  36
  37 //
  38 // Specify the filename extensions for the files we generate.
  39 //
  40 #define VFR_PREPROCESS_FILENAME_EXTENSION   ".i"
  41 #define VFR_PACKAGE_FILENAME_EXTENSION      ".hpk"
  42 #define VFR_RECORDLIST_FILENAME_EXTENSION   ".lst"
  43
  44 typedef struct {
  45   CHAR8   VfrFileName[MAX_PATH];
  46   CHAR8   RecordListFile[MAX_PATH];
  47   CHAR8   PkgOutputFileName[MAX_PATH];
  48   CHAR8   COutputFileName[MAX_PATH];
  49   bool    CreateRecordListFile;
  50   bool    CreateIfrPkgFile;
  51   CHAR8   OutputDirectory[MAX_PATH];
  52   CHAR8   PreprocessorOutputFileName[MAX_PATH];
  53   CHAR8   VfrBaseFileName[MAX_PATH];  // name of input VFR file with no path or extension
  54   CHAR8   *IncludePaths;
  55   bool    SkipCPreprocessor;
  56   CHAR8   *CPreprocessorOptions;
  57   BOOLEAN CompatibleMode;
  58   BOOLEAN HasOverrideClassGuid;
  59   EFI_GUID OverrideClassGuid;
  60 } OPTIONS;
  61
  62 typedef enum {
  63   STATUS_INITIALIZED = 1,
  64   STATUS_PREPROCESSED,
  65   STATUS_COMPILEED,
  66   STATUS_GENBINARY,
  67   STATUS_FINISHED,
  68   STATUS_FAILED,
  69   STATUS_DEAD,
  70 } COMPILER_RUN_STATUS;
  71
  72 class CVfrCompiler {
  73 private:
  74   COMPILER_RUN_STATUS  mRunStatus;
  75   OPTIONS              mOptions;
  76   CHAR8                *mPreProcessCmd;
  77   CHAR8                *mPreProcessOpt;
  78
  79   VOID    OptionInitialization (IN INT32 , IN CHAR8 **);
  80   VOID    AppendIncludePath (IN CHAR8 *);
  81   VOID    AppendCPreprocessorOptions (IN CHAR8 *);
  82   INT8    SetBaseFileName (VOID);
  83   INT8    SetPkgOutputFileName (VOID);
  84   INT8    SetCOutputFileName(VOID);
  85   INT8    SetPreprocessorOutputFileName (VOID);
  86   INT8    SetRecordListFileName (VOID);
  87
  88   VOID    SET_RUN_STATUS (IN COMPILER_RUN_STATUS);
  89   BOOLEAN IS_RUN_STATUS (IN COMPILER_RUN_STATUS);
  90
  91 public:
  92   COMPILER_RUN_STATUS RunStatus (VOID) {
  93     return mRunStatus;
  94   }
  95
  96 public:
  97   CVfrCompiler (IN INT32 , IN CHAR8 **);
  98   ~CVfrCompiler ();
  99
 100   VOID                Usage (VOID);
 101
 102   VOID                PreProcess (VOID);
 103   VOID                Compile (VOID);
 104   VOID                AdjustBin (VOID);
 105   VOID                GenBinary (VOID);
 106   VOID                GenCFile (VOID);
 107   VOID                GenRecordListFile (VOID);
 108   VOID                DebugError (IN CHAR8*, IN UINT32, IN UINT32, IN CONST CHAR8*, IN CONST CHAR8*, ...);
 109 };
 110
 111 #endif