]>
git.proxmox.com Git - mirror_edk2.git/blob - EdkCompatibilityPkg/Sample/Tools/Source/Common/ParseInf.h
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
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.
18 Header file for helper functions useful for parsing INF files.
22 #ifndef _EFI_PARSE_INF_H
23 #define _EFI_PARSE_INF_H
25 #include "TianoCommon.h"
30 // Common data structures
35 CHAR8
*CurrentFilePointer
;
39 // Functions declarations
43 IN MEMORY_FILE
*InputFile
,
44 IN OUT CHAR8
*InputBuffer
,
53 This function reads a line, stripping any comments.
54 The function reads a string from the input stream argument and stores it in
55 the input string. ReadLine reads characters from the current file position
56 to and including the first newline character, to the end of the stream, or
57 until the number of characters read is equal to MaxLength - 1, whichever
58 comes first. The newline character, if read, is replaced with a \0.
62 InputFile Memory file image.
63 InputBuffer Buffer to read into, must be _MAX_PATH size.
64 MaxLength The maximum size of the input buffer.
74 IN MEMORY_FILE
*InputFile
,
83 This function parses a file from the beginning to find a section.
84 The section string may be anywhere within a line.
88 InputFile Memory file image.
89 Section Section to search for
99 IN MEMORY_FILE
*InputFile
,
111 Finds a token value given the section and token to search for.
115 InputFile Memory file image.
116 Section The section to search for, a string within [].
117 Token The token to search for, e.g. EFI_PEIM_RECOVERY, followed by an = in the INF file.
118 Instance The instance of the token to search for. Zero is the first instance.
119 Value The string that holds the value following the =. Must be _MAX_PATH in size.
123 EFI_SUCCESS Value found.
124 EFI_ABORTED Format error detected in INF file.
125 EFI_INVALID_PARAMETER Input argument was null.
126 EFI_LOAD_ERROR Error reading from the file.
127 EFI_NOT_FOUND Section/Token/Value not found.
132 IN CHAR8
*AsciiGuidBuffer
,
133 OUT EFI_GUID
*GuidBuffer
141 Converts a string to an EFI_GUID. The string must be in the
142 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format.
146 GuidBuffer - pointer to destination Guid
147 AsciiGuidBuffer - pointer to ascii string
151 EFI_ABORTED Could not convert the string
152 EFI_SUCCESS The string was successfully converted
156 AsciiStringToUint64 (
157 IN CONST CHAR8
*AsciiString
,
159 OUT UINT64
*ReturnValue
167 Converts a null terminated ascii string that represents a number into a
168 UINT64 value. A hex number may be preceeded by a 0x, but may not be
169 succeeded by an h. A number without 0x or 0X is considered to be base 10
170 unless the IsHex input is true.
174 AsciiString The string to convert.
175 IsHex Force the string to be treated as a hex number.
176 ReturnValue The return value.
180 EFI_SUCCESS Number successfully converted.
181 EFI_ABORTED Invalid character encountered.
187 IN OUT CHAR8
*InputBuffer
195 This function reads a line, stripping any comments.
199 InputFile Stream pointer.
200 InputBuffer Buffer to read into, must be _MAX_PATH size.
205 InputBuffer otherwise
209 FindSectionInStream (
219 This function parses a stream file from the beginning to find a section.
220 The section string may be anywhere within a line.
224 InputFile Stream pointer.
225 Section Section to search for
229 FALSE if error or EOF
230 TRUE if section found