]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/C/VfrCompile/VfrError.h
Sync EDKII BaseTools to BaseTools project r1903.
[mirror_edk2.git] / BaseTools / Source / C / VfrCompile / VfrError.h
CommitLineData
30fdf114
LG
1/** @file\r
2 \r
3 VfrCompiler Error definition\r
4\r
5Copyright (c) 2004 - 2008, Intel Corporation \r
6All rights reserved. This program and the accompanying materials \r
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
35 VFR_RETURN_GET_EFIVARSTORE_ERROR,\r
36 VFR_RETURN_EFIVARSTORE_USE_ERROR,\r
37 VFR_RETURN_EFIVARSTORE_SIZE_ERROR,\r
38 VFR_RETURN_GET_NVVARSTORE_ERROR,\r
39 VFR_RETURN_QVAR_REUSE,\r
40 VFR_RETURN_FLAGS_UNSUPPORTED,\r
41 VFR_RETURN_ERROR_ARRARY_NUM,\r
42 VFR_RETURN_DATA_STRING_ERROR,\r
43 VFR_RETURN_DEFAULT_VALUE_REDEFINED,\r
44 VFR_RETURN_CONSTANT_ONLY,\r
45 VFR_RETURN_CODEUNDEFINED\r
46} EFI_VFR_RETURN_CODE;\r
47\r
48typedef struct _SVFR_ERROR_HANDLE {\r
49 EFI_VFR_RETURN_CODE mErrorCode;\r
52302d4d 50 CONST CHAR8 *mErrorMsg;\r
30fdf114
LG
51} SVFR_ERROR_HANDLE;\r
52\r
53struct SVfrFileScopeRecord {\r
54 CHAR8 *mFileName;\r
55 UINT32 mWholeScopeLine;\r
56 UINT32 mScopeLineStart;\r
57 SVfrFileScopeRecord *mNext;\r
58\r
59 SVfrFileScopeRecord (IN CHAR8 *, IN UINT32);\r
60 ~SVfrFileScopeRecord();\r
61};\r
62\r
63class CVfrErrorHandle {\r
64private:\r
65 CHAR8 *mInputFileName;\r
66 SVFR_ERROR_HANDLE *mVfrErrorHandleTable;\r
67 SVfrFileScopeRecord *mScopeRecordListHead;\r
68 SVfrFileScopeRecord *mScopeRecordListTail;\r
69\r
70public:\r
71 CVfrErrorHandle (VOID);\r
72 ~CVfrErrorHandle (VOID);\r
73\r
74 VOID SetInputFile (IN CHAR8 *);\r
75 VOID ParseFileScopeRecord (IN CHAR8 *, IN UINT32);\r
76 VOID GetFileNameLineNum (IN UINT32, OUT CHAR8 **, OUT UINT32 *);\r
52302d4d
LG
77 UINT8 HandleError (IN EFI_VFR_RETURN_CODE, IN UINT32 LineNum = 0, IN CHAR8 *TokName = NULL);\r
78 VOID PrintMsg (IN UINT32 LineNum = 0, IN CHAR8 *TokName = NULL, IN CONST CHAR8 *MsgType = "Error", IN CONST CHAR8 *ErrorMsg = "");\r
30fdf114
LG
79};\r
80\r
81#define CHECK_ERROR_RETURN(f, v) do { EFI_VFR_RETURN_CODE r; if ((r = (f)) != (v)) { return r; } } while (0)\r
82\r
83extern CVfrErrorHandle gCVfrErrorHandle;\r
84\r
85#endif\r