EdkCompatibilityPkg/Sample/Tools/Source/Common/SimpleFileParsing.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   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 #define T_CHAR  char
  26
  27 STATUS
  28 SFPInit (
  29   VOID
  30   );
  31
  32 STATUS
  33 SFPOpenFile (
  34   char    *FileName
  35   );
  36
  37 BOOLEAN
  38 SFPIsKeyword (
  39   T_CHAR *Str
  40   );
  41
  42 BOOLEAN
  43 SFPIsToken (
  44   T_CHAR *Str
  45   );
  46
  47 BOOLEAN
  48 SFPGetNextToken (
  49   T_CHAR        *Str,
  50   unsigned int  Len
  51   );
  52
  53 BOOLEAN
  54 SFPGetGuidToken (
  55   T_CHAR *Str,
  56   UINT32 Len
  57   );
  58
  59 #define PARSE_GUID_STYLE_5_FIELDS 0
  60
  61 BOOLEAN
  62 SFPGetGuid (
  63   int         GuidStyle,
  64   EFI_GUID    *Value
  65   );
  66
  67 BOOLEAN
  68 SFPSkipToToken (
  69   T_CHAR *Str
  70   );
  71
  72 BOOLEAN
  73 SFPGetNumber (
  74   unsigned int   *Value
  75   );
  76
  77 BOOLEAN
  78 SFPGetQuotedString (
  79   T_CHAR      *Str,
  80   int         Length
  81   );
  82
  83 BOOLEAN
  84 SFPIsEOF (
  85   VOID
  86   );
  87
  88 STATUS
  89 SFPCloseFile (
  90   VOID
  91   );
  92
  93 unsigned
  94 int
  95 SFPGetLineNumber (
  96   VOID
  97   );
  98
  99 T_CHAR  *
 100 SFPGetFileName (
 101   VOID
 102   );
 103
 104 #endif // #ifndef _SIMPLE_FILE_PARSING_H_