3 Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>
4 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
27 #include <Common/UefiBaseTypes.h>
28 #include <MemoryFile.h>
34 // Functions declarations
38 IN MEMORY_FILE
*InputFile
,
39 IN OUT CHAR8
*InputBuffer
,
48 This function reads a line, stripping any comments.
49 The function reads a string from the input stream argument and stores it in
50 the input string. ReadLine reads characters from the current file position
51 to and including the first newline character, to the end of the stream, or
52 until the number of characters read is equal to MaxLength - 1, whichever
53 comes first. The newline character, if read, is replaced with a \0.
57 InputFile Memory file image.
58 InputBuffer Buffer to read into, must be MaxLength size.
59 MaxLength The maximum size of the input buffer.
69 IN MEMORY_FILE
*InputFile
,
78 This function parses a file from the beginning to find a section.
79 The section string may be anywhere within a line.
83 InputFile Memory file image.
84 Section Section to search for
94 IN MEMORY_FILE
*InputFile
,
106 Finds a token value given the section and token to search for.
110 InputFile Memory file image.
111 Section The section to search for, a string within [].
112 Token The token to search for, e.g. EFI_PEIM_RECOVERY, followed by an = in the INF file.
113 Instance The instance of the token to search for. Zero is the first instance.
114 Value The string that holds the value following the =. Must be MAX_LONG_FILE_PATH in size.
118 EFI_SUCCESS Value found.
119 EFI_ABORTED Format error detected in INF file.
120 EFI_INVALID_PARAMETER Input argument was null.
121 EFI_LOAD_ERROR Error reading from the file.
122 EFI_NOT_FOUND Section/Token/Value not found.
127 IN CHAR8
*AsciiGuidBuffer
,
128 OUT EFI_GUID
*GuidBuffer
136 Converts a string to an EFI_GUID. The string must be in the
137 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format.
141 GuidBuffer - pointer to destination Guid
142 AsciiGuidBuffer - pointer to ascii string
146 EFI_ABORTED Could not convert the string
147 EFI_SUCCESS The string was successfully converted
151 AsciiStringToUint64 (
152 IN CONST CHAR8
*AsciiString
,
154 OUT UINT64
*ReturnValue
162 Converts a null terminated ascii string that represents a number into a
163 UINT64 value. A hex number may be preceeded by a 0x, but may not be
164 succeeded by an h. A number without 0x or 0X is considered to be base 10
165 unless the IsHex input is true.
169 AsciiString The string to convert.
170 IsHex Force the string to be treated as a hex number.
171 ReturnValue The return value.
175 EFI_SUCCESS Number successfully converted.
176 EFI_ABORTED Invalid character encountered.
182 IN OUT CHAR8
*InputBuffer
190 This function reads a line, stripping any comments.
194 InputFile Stream pointer.
195 InputBuffer Buffer to read into, must be MAX_LONG_FILE_PATH size.
200 InputBuffer otherwise
204 FindSectionInStream (
214 This function parses a stream file from the beginning to find a section.
215 The section string may be anywhere within a line.
219 InputFile Stream pointer.
220 Section Section to search for
224 FALSE if error or EOF
225 TRUE if section found