Sync BaseTool trunk (version r2599) into EDKII BaseTools.

[mirror_edk2.git] / BaseTools / Source / C / VfrCompile / VfrUtilityLib.h

diff --git a/BaseTools/Source/C/VfrCompile/VfrUtilityLib.h b/BaseTools/Source/C/VfrCompile/VfrUtilityLib.h
index 76d7873e543acd9fc5c0b290aa986b6eb137278b..2847a74a7b96b51cd658d5c906d75bbcda3647fd 100644 (file)
--- a/BaseTools/Source/C/VfrCompile/VfrUtilityLib.h
+++ b/BaseTools/Source/C/VfrCompile/VfrUtilityLib.h
@@ -2,8 +2,8 @@
   \r
   Vfr common library functions.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation                                                         \r
-All rights reserved. This program and the accompanying materials                          \r
+Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>\r
+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
@@ -36,8 +36,8 @@ extern BOOLEAN  VfrCompatibleMode;
 \r
 class CVfrBinaryOutput {\r
 public:\r
-  virtual VOID WriteLine (IN FILE *, IN UINT32, IN CHAR8 *, IN CHAR8 *, IN UINT32);\r
-  virtual VOID WriteEnd (IN FILE *, IN UINT32, IN CHAR8 *, IN CHAR8 *, IN UINT32);\r
+  virtual VOID WriteLine (IN FILE *, IN UINT32, IN CONST CHAR8 *, IN CHAR8 *, IN UINT32);\r
+  virtual VOID WriteEnd (IN FILE *, IN UINT32, IN CONST CHAR8 *, IN CHAR8 *, IN UINT32);\r
 };\r
 \r
 UINT32\r
@@ -57,13 +57,14 @@ struct SConfigInfo {
 \r
 struct SConfigItem {\r
   CHAR8         *mName;         // varstore name\r
-  CHAR8         *mId;           // varstore ID\r
+  EFI_GUID      *mGuid;         // varstore guid, varstore name + guid deside one varstore\r
+  CHAR8         *mId;           // default ID\r
   SConfigInfo   *mInfoStrList;  // list of Offset/Value in the varstore\r
   SConfigItem   *mNext;\r
 \r
 public:\r
-  SConfigItem (IN CHAR8 *, IN CHAR8 *);\r
-  SConfigItem (IN CHAR8 *, IN CHAR8 *, IN UINT8, IN UINT16, IN UINT16, IN EFI_IFR_TYPE_VALUE);\r
+  SConfigItem (IN CHAR8 *, IN EFI_GUID *, IN CHAR8 *);\r
+  SConfigItem (IN CHAR8 *, IN EFI_GUID *, IN CHAR8 *, IN UINT8, IN UINT16, IN UINT16, IN EFI_IFR_TYPE_VALUE);\r
   virtual ~SConfigItem ();\r
 };\r
 \r
@@ -77,11 +78,11 @@ public:
   CVfrBufferConfig (VOID);\r
   virtual ~CVfrBufferConfig (VOID);\r
 \r
-  virtual UINT8   Register (IN CHAR8 *, IN CHAR8 *Info = NULL);\r
+  virtual UINT8   Register (IN CHAR8 *, IN EFI_GUID *,IN CHAR8 *Info = NULL);\r
   virtual VOID    Open (VOID);\r
   virtual BOOLEAN Eof(VOID);\r
-  virtual UINT8   Select (IN CHAR8 *, IN CHAR8 *Info = NULL);\r
-  virtual UINT8   Write (IN CONST CHAR8, IN CHAR8 *, IN CHAR8 *, IN UINT8, IN UINT16, IN UINT32, IN EFI_IFR_TYPE_VALUE);\r
+  virtual UINT8   Select (IN CHAR8 *, IN EFI_GUID *, IN CHAR8 *Info = NULL);\r
+  virtual UINT8   Write (IN CONST CHAR8, IN CHAR8 *, IN EFI_GUID *, IN CHAR8 *, IN UINT8, IN UINT16, IN UINT32, IN EFI_IFR_TYPE_VALUE);\r
 #if 0\r
   virtual UINT8   Read (OUT CHAR8 **, OUT CHAR8 **, OUT CHAR8 **, OUT CHAR8 **, OUT CHAR8 **);\r
 #endif\r
@@ -175,7 +176,7 @@ private:
   VOID RegisterNewType (IN SVfrDataType *);\r
 \r
   EFI_VFR_RETURN_CODE ExtractStructTypeName (IN CHAR8 *&, OUT CHAR8 *);\r
-  EFI_VFR_RETURN_CODE GetTypeField (IN CHAR8 *, IN SVfrDataType *, IN SVfrDataField *&);\r
+  EFI_VFR_RETURN_CODE GetTypeField (IN CONST CHAR8 *, IN SVfrDataType *, IN SVfrDataField *&);\r
   EFI_VFR_RETURN_CODE GetFieldOffset (IN SVfrDataField *, IN UINT32, OUT UINT32 &);\r
   UINT8               GetFieldWidth (IN SVfrDataField *);\r
   UINT32              GetFieldSize (IN SVfrDataField *, IN UINT32);\r
@@ -284,6 +285,10 @@ private:
   BOOLEAN         ChekVarStoreIdFree (IN EFI_VARSTORE_ID);\r
   VOID            MarkVarStoreIdUsed (IN EFI_VARSTORE_ID);\r
   VOID            MarkVarStoreIdUnused (IN EFI_VARSTORE_ID);\r
+  EFI_VARSTORE_ID CheckGuidField (IN SVfrVarStorageNode *, \r
+                                  IN EFI_GUID *, \r
+                                  IN BOOLEAN *, \r
+                                  OUT EFI_VFR_RETURN_CODE *);\r
 \r
 public:\r
   CVfrDataStorage ();\r
@@ -303,16 +308,15 @@ public:
 \r
   EFI_VFR_RETURN_CODE DeclareBufferVarStore (IN CHAR8 *, IN EFI_GUID *, IN CVfrVarDataTypeDB *, IN CHAR8 *, IN EFI_VARSTORE_ID, IN BOOLEAN Flag = TRUE);\r
 \r
-  EFI_VFR_RETURN_CODE GetVarStoreId (IN CHAR8 *, OUT EFI_VARSTORE_ID *);\r
-  EFI_VFR_RETURN_CODE GetVarStoreType (IN CHAR8 *, OUT EFI_VFR_VARSTORE_TYPE &);\r
+  EFI_VFR_RETURN_CODE GetVarStoreId (IN CHAR8 *, OUT EFI_VARSTORE_ID *, IN EFI_GUID *VarGuid = NULL);\r
   EFI_VFR_VARSTORE_TYPE GetVarStoreType (IN EFI_VARSTORE_ID);\r
+  EFI_GUID *          GetVarStoreGuid (IN  EFI_VARSTORE_ID);\r
   EFI_VFR_RETURN_CODE GetVarStoreName (IN EFI_VARSTORE_ID, OUT CHAR8 **);\r
+  EFI_VFR_RETURN_CODE GetVarStoreByDataType (IN CHAR8 *, OUT SVfrVarStorageNode **, IN EFI_GUID *VarGuid = NULL);\r
 \r
-  EFI_VFR_RETURN_CODE GetBufferVarStoreDataTypeName (IN CHAR8 *, OUT CHAR8 **);\r
+  EFI_VFR_RETURN_CODE GetBufferVarStoreDataTypeName (IN EFI_VARSTORE_ID, OUT CHAR8 **);\r
   EFI_VFR_RETURN_CODE GetEfiVarStoreInfo (IN EFI_VARSTORE_INFO *);\r
   EFI_VFR_RETURN_CODE GetNameVarStoreInfo (IN EFI_VARSTORE_INFO *, IN UINT32);\r
-\r
-  EFI_VFR_RETURN_CODE BufferVarStoreRequestElementAdd (IN CHAR8 *, IN EFI_VARSTORE_INFO &);\r
 };\r
 \r
 #define EFI_QUESTION_ID_MAX              0xFFFF\r
@@ -332,6 +336,7 @@ struct SVfrQuestionNode {
   EFI_QUESTION_ID           mQuestionId;\r
   UINT32                    mBitMask;\r
   SVfrQuestionNode          *mNext;\r
+  EFI_QUESION_TYPE          mQtype;\r
 \r
   SVfrQuestionNode (IN CHAR8 *, IN CHAR8 *, IN UINT32 BitMask = 0);\r
   ~SVfrQuestionNode ();\r
@@ -357,8 +362,9 @@ public:
   VOID                RegisterNewDateQuestion (IN CHAR8 *, IN CHAR8 *, IN OUT EFI_QUESTION_ID &);\r
   VOID                RegisterOldTimeQuestion (IN CHAR8 *, IN CHAR8 *, IN CHAR8 *, IN OUT EFI_QUESTION_ID &);\r
   VOID                RegisterNewTimeQuestion (IN CHAR8 *, IN CHAR8 *, IN OUT EFI_QUESTION_ID &);\r
+  VOID                RegisterRefQuestion (IN CHAR8 *, IN CHAR8 *, IN OUT EFI_QUESTION_ID &);  \r
   EFI_VFR_RETURN_CODE UpdateQuestionId (IN EFI_QUESTION_ID, IN EFI_QUESTION_ID);\r
-  VOID                GetQuestionId (IN CHAR8 *, IN CHAR8 *, OUT EFI_QUESTION_ID &, OUT UINT32 &);\r
+  VOID                GetQuestionId (IN CHAR8 *, IN CHAR8 *, OUT EFI_QUESTION_ID &, OUT UINT32 &, OUT EFI_QUESION_TYPE *QType = NULL);\r
   EFI_VFR_RETURN_CODE FindQuestion (IN EFI_QUESTION_ID);\r
   EFI_VFR_RETURN_CODE FindQuestion (IN CHAR8 *);\r
   VOID                PrintAllQuestion (IN VOID);\r
@@ -393,7 +399,7 @@ public:
   EFI_VFR_RETURN_CODE ReRegisterDefaultStoreById (IN UINT16, IN CHAR8 *, IN EFI_STRING_ID);\r
   BOOLEAN             DefaultIdRegistered (IN UINT16);\r
   EFI_VFR_RETURN_CODE GetDefaultId (IN CHAR8 *, OUT UINT16 *);\r
-  EFI_VFR_RETURN_CODE BufferVarStoreAltConfigAdd (IN EFI_VARSTORE_ID, IN EFI_VARSTORE_INFO &, IN CHAR8 *, IN UINT8, IN EFI_IFR_TYPE_VALUE);\r
+  EFI_VFR_RETURN_CODE BufferVarStoreAltConfigAdd (IN EFI_VARSTORE_ID, IN EFI_VARSTORE_INFO &, IN CHAR8 *, IN EFI_GUID *, IN UINT8, IN EFI_IFR_TYPE_VALUE);\r
 };\r
 \r
 #define EFI_RULE_ID_START    0x01\r
@@ -421,7 +427,38 @@ public:
   UINT8 GetRuleId (IN CHAR8 *);\r
 };\r
 \r
-#define MIN(v1, v2) (((v1) < (v2)) ? (v1) : (v2))\r
-#define MAX(v1, v2) (((v1) > (v2)) ? (v1) : (v2))\r
+class CVfrStringDB {\r
+private:\r
+  CHAR8   *mStringFileName;\r
+\r
+  EFI_STATUS FindStringBlock (\r
+    IN  UINT8            *StringData,\r
+    IN  EFI_STRING_ID    StringId,\r
+    OUT UINT32           *StringTextOffset,\r
+    OUT UINT8            *BlockType\r
+    );\r
+\r
+  UINT32 GetUnicodeStringTextSize (\r
+    IN  UINT8            *StringSrc\r
+    );\r
+    \r
+  BOOLEAN GetBestLanguage (\r
+    IN CONST CHAR8  *SupportedLanguages,\r
+    IN CHAR8        *Language\r
+    );\r
+\r
+public:\r
+  CVfrStringDB ();\r
+  ~CVfrStringDB ();\r
+\r
+  VOID SetStringFileName (\r
+    IN CHAR8 *StringFileName\r
+    );\r
+\r
+  CHAR8 * GetVarStoreNameFormStringId (\r
+    IN EFI_STRING_ID StringId\r
+    );\r
+\r
+};\r
 \r
 #endif\r