BaseTools/Source/C/Common/SimpleFileParsing.h

   1 /** @file
   2 Function prototypes and defines for the simple file parsing routines.
   3
   4 Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _SIMPLE_FILE_PARSING_H_
  10 #define _SIMPLE_FILE_PARSING_H_
  11
  12 #include <Common/UefiBaseTypes.h>
  13
  14 STATUS
  15 SFPInit (
  16   VOID
  17   )
  18 ;
  19
  20 STATUS
  21 SFPOpenFile (
  22   CHAR8    *FileName
  23   )
  24 ;
  25
  26 BOOLEAN
  27 SFPIsKeyword (
  28   CHAR8 *Str
  29   )
  30 ;
  31
  32 BOOLEAN
  33 SFPIsToken (
  34   CHAR8 *Str
  35   )
  36 ;
  37
  38 BOOLEAN
  39 SFPGetNextToken (
  40   CHAR8  *Str,
  41   UINTN  Len
  42   )
  43 ;
  44
  45 BOOLEAN
  46 SFPGetGuidToken (
  47   CHAR8 *Str,
  48   UINT32 Len
  49   )
  50 ;
  51
  52 #define PARSE_GUID_STYLE_5_FIELDS 0
  53
  54 BOOLEAN
  55 SFPGetGuid (
  56   INTN        GuidStyle,
  57   EFI_GUID    *Value
  58   )
  59 ;
  60
  61 BOOLEAN
  62 SFPSkipToToken (
  63   CHAR8 *Str
  64   )
  65 ;
  66
  67 BOOLEAN
  68 SFPGetNumber (
  69   UINTN   *Value
  70   )
  71 ;
  72
  73 BOOLEAN
  74 SFPGetQuotedString (
  75   CHAR8      *Str,
  76   INTN       Length
  77   )
  78 ;
  79
  80 BOOLEAN
  81 SFPIsEOF (
  82   VOID
  83   )
  84 ;
  85
  86 STATUS
  87 SFPCloseFile (
  88   VOID
  89   )
  90 ;
  91
  92 UINTN
  93 SFPGetLineNumber (
  94   VOID
  95   )
  96 ;
  97
  98 CHAR8  *
  99 SFPGetFileName (
 100   VOID
 101   )
 102 ;
 103
 104 #endif // #ifndef _SIMPLE_FILE_PARSING_H_