]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/C/VfrCompile/VfrError.h
Sync BaseTools Branch (version r2149) to EDKII main trunk.
[mirror_edk2.git] / BaseTools / Source / C / VfrCompile / VfrError.h
CommitLineData
30fdf114
LG
1/** @file\r
2 \r
3 VfrCompiler Error definition\r
4\r
da92f276 5Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>\r
40d841f6 6This program and the accompanying materials \r
30fdf114
LG
7are licensed and made available under the terms and conditions of the BSD License \r
8which accompanies this distribution. The full text of the license may be found at \r
9http://opensource.org/licenses/bsd-license.php \r
10 \r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
13\r
14**/\r
15\r
16#ifndef _VFRERROR_H_\r
17#define _VFRERROR_H_\r
18\r
19#include "Common/UefiBaseTypes.h"\r
20\r
21typedef enum {\r
22 VFR_RETURN_SUCCESS = 0,\r
23 VFR_RETURN_ERROR_SKIPED,\r
24 VFR_RETURN_FATAL_ERROR,\r
25 VFR_RETURN_MISMATCHED,\r
26 VFR_RETURN_INVALID_PARAMETER,\r
27 VFR_RETURN_OUT_FOR_RESOURCES,\r
28 VFR_RETURN_UNSUPPORTED,\r
29 VFR_RETURN_REDEFINED,\r
30 VFR_RETURN_FORMID_REDEFINED,\r
31 VFR_RETURN_QUESTIONID_REDEFINED,\r
32 VFR_RETURN_VARSTOREID_REDEFINED,\r
33 VFR_RETURN_UNDEFINED,\r
34 VFR_RETURN_VAR_NOTDEFINED_BY_QUESTION,\r
da92f276 35 VFR_RETURN_VARSTORE_DATATYPE_REDEFINED_ERROR,\r
30fdf114
LG
36 VFR_RETURN_GET_EFIVARSTORE_ERROR,\r
37 VFR_RETURN_EFIVARSTORE_USE_ERROR,\r
38 VFR_RETURN_EFIVARSTORE_SIZE_ERROR,\r
39 VFR_RETURN_GET_NVVARSTORE_ERROR,\r
40 VFR_RETURN_QVAR_REUSE,\r
41 VFR_RETURN_FLAGS_UNSUPPORTED,\r
42 VFR_RETURN_ERROR_ARRARY_NUM,\r
43 VFR_RETURN_DATA_STRING_ERROR,\r
44 VFR_RETURN_DEFAULT_VALUE_REDEFINED,\r
45 VFR_RETURN_CONSTANT_ONLY,\r
46 VFR_RETURN_CODEUNDEFINED\r
47} EFI_VFR_RETURN_CODE;\r
48\r
49typedef struct _SVFR_ERROR_HANDLE {\r
50 EFI_VFR_RETURN_CODE mErrorCode;\r
52302d4d 51 CONST CHAR8 *mErrorMsg;\r
30fdf114
LG
52} SVFR_ERROR_HANDLE;\r
53\r
54struct SVfrFileScopeRecord {\r
55 CHAR8 *mFileName;\r
56 UINT32 mWholeScopeLine;\r
57 UINT32 mScopeLineStart;\r
58 SVfrFileScopeRecord *mNext;\r
59\r
60 SVfrFileScopeRecord (IN CHAR8 *, IN UINT32);\r
61 ~SVfrFileScopeRecord();\r
62};\r
63\r
64class CVfrErrorHandle {\r
65private:\r
66 CHAR8 *mInputFileName;\r
67 SVFR_ERROR_HANDLE *mVfrErrorHandleTable;\r
68 SVfrFileScopeRecord *mScopeRecordListHead;\r
69 SVfrFileScopeRecord *mScopeRecordListTail;\r
70\r
71public:\r
72 CVfrErrorHandle (VOID);\r
73 ~CVfrErrorHandle (VOID);\r
74\r
75 VOID SetInputFile (IN CHAR8 *);\r
76 VOID ParseFileScopeRecord (IN CHAR8 *, IN UINT32);\r
77 VOID GetFileNameLineNum (IN UINT32, OUT CHAR8 **, OUT UINT32 *);\r
52302d4d
LG
78 UINT8 HandleError (IN EFI_VFR_RETURN_CODE, IN UINT32 LineNum = 0, IN CHAR8 *TokName = NULL);\r
79 VOID PrintMsg (IN UINT32 LineNum = 0, IN CHAR8 *TokName = NULL, IN CONST CHAR8 *MsgType = "Error", IN CONST CHAR8 *ErrorMsg = "");\r
30fdf114
LG
80};\r
81\r
82#define CHECK_ERROR_RETURN(f, v) do { EFI_VFR_RETURN_CODE r; if ((r = (f)) != (v)) { return r; } } while (0)\r
83\r
84extern CVfrErrorHandle gCVfrErrorHandle;\r
85\r
86#endif\r