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
  59 void
  60 Error (
  61   INT8    *FileName,
  62   UINT32  LineNumber,
  63   UINT32  ErrorCode,
  64   INT8    *OffendingText,
  65   INT8    *MsgFmt,
  66   ...
  67   )
  68 ;
  69
  70 void
  71 Warning (
  72   INT8    *FileName,
  73   UINT32  LineNumber,
  74   UINT32  ErrorCode,
  75   INT8    *OffendingText,
  76   INT8    *MsgFmt,
  77   ...
  78   )
  79 ;
  80
  81 void
  82 DebugMsg (
  83   INT8    *FileName,
  84   UINT32  LineNumber,
  85   UINT32  MsgLevel,
  86   INT8    *OffendingText,
  87   INT8    *MsgFmt,
  88   ...
  89   )
  90 ;
  91
  92 void
  93 SetDebugMsgMask (
  94   UINT32    MsgMask
  95   )
  96 ;
  97
  98 void
  99 ParserSetPosition (
 100   INT8    *SourceFileName,
 101   UINT32  LineNum
 102   )
 103 ;
 104
 105 void
 106 ParserError (
 107   UINT32  ErrorCode,
 108   INT8    *OffendingText,
 109   INT8    *MsgFmt,
 110   ...
 111   )
 112 ;
 113
 114 void
 115 ParserWarning (
 116   UINT32  ErrorCode,
 117   INT8    *OffendingText,
 118   INT8    *MsgFmt,
 119   ...
 120   )
 121 ;
 122
 123 void
 124 SetPrintLimits (
 125   UINT32  NumErrors,
 126   UINT32  NumWarnings,
 127   UINT32  NumWarningsPlusErrors
 128   )
 129 ;
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif // #ifndef _EFI_UTILITY_MSGS_H_