VfrCompiler.h 3.5 KB

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