BaseTools/Source/C/Common/SimpleFileParsing.h

   1 /** @file
   2
   3 Copyright (c) 2004 - 2008, 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   SimpleFileParsing.h
  15
  16 Abstract:
  17
  18   Function prototypes and defines for the simple file parsing routines.
  19
  20 **/
  21
  22 #ifndef _SIMPLE_FILE_PARSING_H_
  23 #define _SIMPLE_FILE_PARSING_H_
  24
  25 #include <Common/UefiBaseTypes.h>
  26
  27 STATUS
  28 SFPInit (
  29   VOID
  30   )
  31 ;
  32
  33 STATUS
  34 SFPOpenFile (
  35   CHAR8    *FileName
  36   )
  37 ;
  38
  39 BOOLEAN
  40 SFPIsKeyword (
  41   CHAR8 *Str
  42   )
  43 ;
  44
  45 BOOLEAN
  46 SFPIsToken (
  47   CHAR8 *Str
  48   )
  49 ;
  50
  51 BOOLEAN
  52 SFPGetNextToken (
  53   CHAR8  *Str,
  54   UINTN  Len
  55   )
  56 ;
  57
  58 BOOLEAN
  59 SFPGetGuidToken (
  60   CHAR8 *Str,
  61   UINT32 Len
  62   )
  63 ;
  64
  65 #define PARSE_GUID_STYLE_5_FIELDS 0
  66
  67 BOOLEAN
  68 SFPGetGuid (
  69   INTN        GuidStyle,
  70   EFI_GUID    *Value
  71   )
  72 ;
  73
  74 BOOLEAN
  75 SFPSkipToToken (
  76   CHAR8 *Str
  77   )
  78 ;
  79
  80 BOOLEAN
  81 SFPGetNumber (
  82   UINTN   *Value
  83   )
  84 ;
  85
  86 BOOLEAN
  87 SFPGetQuotedString (
  88   CHAR8      *Str,
  89   INTN       Length
  90   )
  91 ;
  92
  93 BOOLEAN
  94 SFPIsEOF (
  95   VOID
  96   )
  97 ;
  98
  99 STATUS
 100 SFPCloseFile (
 101   VOID
 102   )
 103 ;
 104
 105 UINTN
 106 SFPGetLineNumber (
 107   VOID
 108   )
 109 ;
 110
 111 CHAR8  *
 112 SFPGetFileName (
 113   VOID
 114   )
 115 ;
 116
 117 #endif // #ifndef _SIMPLE_FILE_PARSING_H_