BaseTools/Source/C/Common/SimpleFileParsing.h

   1 /** @file
   2 Function prototypes and defines for the simple file parsing routines.
   3
   4 Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _SIMPLE_FILE_PARSING_H_
  16 #define _SIMPLE_FILE_PARSING_H_
  17
  18 #include <Common/UefiBaseTypes.h>
  19
  20 STATUS
  21 SFPInit (
  22   VOID
  23   )
  24 ;
  25
  26 STATUS
  27 SFPOpenFile (
  28   CHAR8    *FileName
  29   )
  30 ;
  31
  32 BOOLEAN
  33 SFPIsKeyword (
  34   CHAR8 *Str
  35   )
  36 ;
  37
  38 BOOLEAN
  39 SFPIsToken (
  40   CHAR8 *Str
  41   )
  42 ;
  43
  44 BOOLEAN
  45 SFPGetNextToken (
  46   CHAR8  *Str,
  47   UINTN  Len
  48   )
  49 ;
  50
  51 BOOLEAN
  52 SFPGetGuidToken (
  53   CHAR8 *Str,
  54   UINT32 Len
  55   )
  56 ;
  57
  58 #define PARSE_GUID_STYLE_5_FIELDS 0
  59
  60 BOOLEAN
  61 SFPGetGuid (
  62   INTN        GuidStyle,
  63   EFI_GUID    *Value
  64   )
  65 ;
  66
  67 BOOLEAN
  68 SFPSkipToToken (
  69   CHAR8 *Str
  70   )
  71 ;
  72
  73 BOOLEAN
  74 SFPGetNumber (
  75   UINTN   *Value
  76   )
  77 ;
  78
  79 BOOLEAN
  80 SFPGetQuotedString (
  81   CHAR8      *Str,
  82   INTN       Length
  83   )
  84 ;
  85
  86 BOOLEAN
  87 SFPIsEOF (
  88   VOID
  89   )
  90 ;
  91
  92 STATUS
  93 SFPCloseFile (
  94   VOID
  95   )
  96 ;
  97
  98 UINTN
  99 SFPGetLineNumber (
 100   VOID
 101   )
 102 ;
 103
 104 CHAR8  *
 105 SFPGetFileName (
 106   VOID
 107   )
 108 ;
 109
 110 #endif // #ifndef _SIMPLE_FILE_PARSING_H_