EdkCompatibilityPkg/Sample/Tools/Source/Common/EfiUtilityMsgs.h

   1 /*++
   2
   3 Copyright (c) 2004, Intel Corporation
   4 All rights reserved. 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
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   EfiUtilityMsgs.h
  15
  16 Abstract:
  17
  18   Defines and prototypes for common EFI utility error and debug messages.
  19
  20 --*/
  21
  22 #ifndef _EFI_UTILITY_MSGS_H_
  23 #define _EFI_UTILITY_MSGS_H_
  24
  25 //
  26 // Status codes returned by EFI utility programs and functions
  27 //
  28 #define STATUS_SUCCESS  0
  29 #define STATUS_WARNING  1
  30 #define STATUS_ERROR    2
  31 #define VOID void
  32
  33 typedef int STATUS;
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38 //
  39 // When we call Error() or Warning(), the module keeps track of the worst
  40 // case reported. GetUtilityStatus() will get the worst-case results, which
  41 // can be used as the return value from the app.
  42 //
  43 STATUS
  44 GetUtilityStatus (
  45   void
  46   );
  47
  48 //
  49 // If someone prints an error message and didn't specify a source file name,
  50 // then we print the utility name instead. However they must tell us the
  51 // utility name early on via this function.
  52 //
  53 void
  54 SetUtilityName (
  55   INT8 *ProgramName
  56   );
  57
  58 void
  59 Error (
  60   INT8    *FileName,
  61   UINT32  LineNumber,
  62   UINT32  ErrorCode,
  63   INT8    *OffendingText,
  64   INT8    *MsgFmt,
  65   ...
  66   );
  67
  68 void
  69 Warning (
  70   INT8    *FileName,
  71   UINT32  LineNumber,
  72   UINT32  ErrorCode,
  73   INT8    *OffendingText,
  74   INT8    *MsgFmt,
  75   ...
  76   );
  77
  78 void
  79 DebugMsg (
  80   INT8    *FileName,
  81   UINT32  LineNumber,
  82   UINT32  MsgLevel,
  83   INT8    *OffendingText,
  84   INT8    *MsgFmt,
  85   ...
  86   );
  87
  88 void
  89 SetDebugMsgMask (
  90   UINT32    MsgMask
  91   );
  92
  93 void
  94 ParserSetPosition (
  95   INT8    *SourceFileName,
  96   UINT32  LineNum
  97   );
  98
  99 void
 100 ParserError (
 101   UINT32  ErrorCode,
 102   INT8    *OffendingText,
 103   INT8    *MsgFmt,
 104   ...
 105   );
 106
 107 void
 108 ParserWarning (
 109   UINT32  ErrorCode,
 110   INT8    *OffendingText,
 111   INT8    *MsgFmt,
 112   ...
 113   );
 114
 115 void
 116 SetPrintLimits (
 117   UINT32  NumErrors,
 118   UINT32  NumWarnings,
 119   UINT32  NumWarningsPlusErrors
 120   );
 121
 122 #ifdef __cplusplus
 123 }
 124 #endif
 125
 126 #endif // #ifndef _EFI_UTILITY_MSGS_H_