BaseTools/VfrCompile: Minor code cleanup

Add minor code cleanups made while tracking down the bugs fixed in the
preceding commits.

 - Fix spelling 'arrary' -> 'array' where it occurs in the tool code and comments.
   - When renaming ExtractFieldNameAndArrary to ExtractFieldNameAndArrayIdx,
we fix the typo and also clarify what the method does: it returns the field name
and the array index when present. Since it is always used to populate a local
variable named ArrayIdx, we stick to that spelling in the renamed method.
 - Add comment clarifying that mArrayNum holds array length (but again, don't
go for a bigger global rename).
 - Rename CVfrVarDataTypeDB::GetFieldWidth to GetFieldType. It is only used
once, and the new name correctly matches what it does.

Signed-off-by: Mike Beaton <[email protected]>

Author: mikebeaton

BaseTools/Source/C/VfrCompile/VfrError.cpp

@@ -35,7 +35,7 @@ static SVFR_ERROR_HANDLE VFR_ERROR_HANDLE_TABLE [] = {
   { VFR_RETURN_GET_NVVARSTORE_ERROR, ": get name value varstore error" },
   { VFR_RETURN_QVAR_REUSE, ": variable reused by more than one question" },
   { VFR_RETURN_FLAGS_UNSUPPORTED, ": flags unsupported" },
-  { VFR_RETURN_ERROR_ARRARY_NUM, ": array number error, the valid value is in (0 ~ MAX_INDEX-1) for UEFI vfr and in (1 ~ MAX_INDEX) for Framework Vfr" },
+  { VFR_RETURN_ERROR_ARRAY_NUM, ": array number error, the valid value is in (0 ~ MAX_INDEX-1) for UEFI vfr and in (1 ~ MAX_INDEX) for Framework Vfr" },
   { VFR_RETURN_DATA_STRING_ERROR, ": data field string error or not support"},
   { VFR_RETURN_DEFAULT_VALUE_REDEFINED, ": default value re-defined with different value"},
   { VFR_RETURN_CONSTANT_ONLY, ": only constant is allowed in the expression"},

BaseTools/Source/C/VfrCompile/VfrError.h

@@ -33,7 +33,7 @@ typedef enum {
   VFR_RETURN_GET_NVVARSTORE_ERROR,
   VFR_RETURN_QVAR_REUSE,
   VFR_RETURN_FLAGS_UNSUPPORTED,
-  VFR_RETURN_ERROR_ARRARY_NUM,
+  VFR_RETURN_ERROR_ARRAY_NUM,
   VFR_RETURN_DATA_STRING_ERROR,
   VFR_RETURN_DEFAULT_VALUE_REDEFINED,
   VFR_RETURN_CONSTANT_ONLY,

BaseTools/Source/C/VfrCompile/VfrFormPkg.cpp

@@ -853,7 +853,7 @@ CFormPkg::DeclarePendingQuestion (
       //
       // Get Question Info, framework vfr VarName == StructName
       //
-      ReturnCode = lCVfrVarDataTypeDB.ExtractFieldNameAndArrary (VarStr, FName, ArrayIdx);
+      ReturnCode = lCVfrVarDataTypeDB.ExtractFieldNameAndArrayIdx (VarStr, FName, ArrayIdx);
       if (ReturnCode != VFR_RETURN_SUCCESS) {
         gCVfrErrorHandle.PrintMsg (pNode->mLineNo, pNode->mKey, "Error", "Var string is not the valid C variable");
         return ReturnCode;

BaseTools/Source/C/VfrCompile/VfrUtilityLib.cpp

@@ -649,7 +649,7 @@ CVfrVarDataTypeDB::IsThisBitField (
   CHECK_ERROR_RETURN (GetDataType (TName, &pType), VFR_RETURN_SUCCESS);
 
   while (*VarStr != '\0') {
-    CHECK_ERROR_RETURN(ExtractFieldNameAndArrary(VarStr, FName, ArrayIdx), VFR_RETURN_SUCCESS);
+    CHECK_ERROR_RETURN(ExtractFieldNameAndArrayIdx(VarStr, FName, ArrayIdx), VFR_RETURN_SUCCESS);
     CHECK_ERROR_RETURN(GetTypeField (FName, pType, pField), VFR_RETURN_SUCCESS);
     pType  = pField->mFieldType;
   }
@@ -661,7 +661,7 @@ CVfrVarDataTypeDB::IsThisBitField (
 }
 
 EFI_VFR_RETURN_CODE
-CVfrVarDataTypeDB::ExtractFieldNameAndArrary (
+CVfrVarDataTypeDB::ExtractFieldNameAndArrayIdx (
   IN  CHAR8   *&VarStr,
   IN  CHAR8   *FName,
   OUT UINT32 &ArrayIdx
@@ -766,17 +766,17 @@ CVfrVarDataTypeDB::GetFieldOffset (
   }
 
   if ((ArrayIdx != INVALID_ARRAY_INDEX) && ((Field->mArrayNum == 0) || (Field->mArrayNum <= ArrayIdx))) {
-    return VFR_RETURN_ERROR_ARRARY_NUM;
+    return VFR_RETURN_ERROR_ARRAY_NUM;
   }
 
   //
   // Be compatible with the current usage
-  // If ArraryIdx is not specified, the first one is used.
+  // If ArrayIdx is not specified, the first one is used.
   //
-  // if ArrayNum is larger than zero, ArraryIdx must be specified.
+  // if ArrayNum is larger than zero, ArrayIdx must be specified.
   //
   // if ((ArrayIdx == INVALID_ARRAY_INDEX) && (Field->mArrayNum > 0)) {
-  //   return VFR_RETURN_ERROR_ARRARY_NUM;
+  //   return VFR_RETURN_ERROR_ARRAY_NUM;
   // }
   //
   if (IsBitField) {
@@ -788,7 +788,7 @@ CVfrVarDataTypeDB::GetFieldOffset (
 }
 
 UINT8
-CVfrVarDataTypeDB::GetFieldWidth (
+CVfrVarDataTypeDB::GetFieldType (
   IN SVfrDataField *Field
   )
 {
@@ -1183,7 +1183,7 @@ CVfrVarDataTypeDB::DataTypeAddBitField (
       }
     } else {
       //
-      // The bit filed start a new memory
+      // The bit field start a new memory
       //
       pNewField->mBitOffset = mNewDataType->mTotalSize * 8;
       UpdateTotalSize = TRUE;
@@ -1408,7 +1408,7 @@ CVfrVarDataTypeDB::GetDataFieldInfo (
   Size  = pType->mTotalSize;
 
   while (*VarStr != '\0') {
-    CHECK_ERROR_RETURN(ExtractFieldNameAndArrary(VarStr, FName, ArrayIdx), VFR_RETURN_SUCCESS);
+    CHECK_ERROR_RETURN(ExtractFieldNameAndArrayIdx(VarStr, FName, ArrayIdx), VFR_RETURN_SUCCESS);
     CHECK_ERROR_RETURN(GetTypeField (FName, pType, pField), VFR_RETURN_SUCCESS);
     pType  = pField->mFieldType;
     CHECK_ERROR_RETURN(GetFieldOffset (pField, ArrayIdx, Tmp, pField->mIsBitField), VFR_RETURN_SUCCESS);
@@ -1417,7 +1417,7 @@ CVfrVarDataTypeDB::GetDataFieldInfo (
     } else {
       Offset = (UINT16) (Offset + Tmp);
     }
-    Type   = GetFieldWidth (pField);
+    Type   = GetFieldType (pField);
     Size   = GetFieldSize (pField, ArrayIdx, BitField);
   }
   return VFR_RETURN_SUCCESS;

BaseTools/Source/C/VfrCompile/VfrUtilityLib.h

@@ -110,7 +110,7 @@ struct SVfrDataField {
   CHAR8                     mFieldName[MAX_NAME_LEN];
   SVfrDataType              *mFieldType;
   UINT32                    mOffset;
-  UINT32                    mArrayNum;
+  UINT32                    mArrayNum; ///< Holds array length, or zero for non-array.
   BOOLEAN                   mIsBitField;
   UINT8                     mBitWidth;
   UINT32                    mBitOffset;
@@ -195,7 +195,7 @@ class CVfrVarDataTypeDB {
   EFI_VFR_RETURN_CODE ExtractStructTypeName (IN CHAR8 *&, OUT CHAR8 *);
   EFI_VFR_RETURN_CODE GetTypeField (IN CONST CHAR8 *, IN SVfrDataType *, IN SVfrDataField *&);
   EFI_VFR_RETURN_CODE GetFieldOffset (IN SVfrDataField *, IN UINT32, OUT UINT32 &, IN BOOLEAN);
-  UINT8               GetFieldWidth (IN SVfrDataField *);
+  UINT8               GetFieldType (IN SVfrDataField *);
   UINT32              GetFieldSize (IN SVfrDataField *, IN UINT32, IN BOOLEAN);
 
 public:
@@ -214,7 +214,7 @@ class CVfrVarDataTypeDB {
   EFI_VFR_RETURN_CODE GetDataFieldInfo (IN CHAR8 *, OUT UINT16 &, OUT UINT8 &, OUT UINT32 &, OUT BOOLEAN &);
 
   EFI_VFR_RETURN_CODE GetUserDefinedTypeNameList (OUT CHAR8 ***, OUT UINT32 *);
-  EFI_VFR_RETURN_CODE ExtractFieldNameAndArrary (IN CHAR8 *&, OUT CHAR8 *, OUT UINT32 &);
+  EFI_VFR_RETURN_CODE ExtractFieldNameAndArrayIdx (IN CHAR8 *&, OUT CHAR8 *, OUT UINT32 &);
   BOOLEAN             DataTypeHasBitField (IN  CHAR8 *);
   BOOLEAN             IsThisBitField (IN  CHAR8 *);