]>
git.proxmox.com Git - mirror_edk2.git/blob - Tools/Source/TianoTools/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" */
29 #include <UefiBaseTypes.h>
32 // Common data structures
37 CHAR8
*CurrentFilePointer
;
41 // Functions declarations
45 IN MEMORY_FILE
*InputFile
,
46 IN OUT CHAR8
*InputBuffer
,
55 This function reads a line, stripping any comments.
56 The function reads a string from the input stream argument and stores it in
57 the input string. ReadLine reads characters from the current file position
58 to and including the first newline character, to the end of the stream, or
59 until the number of characters read is equal to MaxLength - 1, whichever
60 comes first. The newline character, if read, is replaced with a \0.
64 InputFile Memory file image.
65 InputBuffer Buffer to read into, must be _MAX_PATH size.
66 MaxLength The maximum size of the input buffer.
76 IN MEMORY_FILE
*InputFile
,
85 This function parses a file from the beginning to find a section.
86 The section string may be anywhere within a line.
90 InputFile Memory file image.
91 Section Section to search for
101 IN MEMORY_FILE
*InputFile
,
113 Finds a token value given the section and token to search for.
117 InputFile Memory file image.
118 Section The section to search for, a string within [].
119 Token The token to search for, e.g. EFI_PEIM_RECOVERY, followed by an = in the INF file.
120 Instance The instance of the token to search for. Zero is the first instance.
121 Value The string that holds the value following the =. Must be _MAX_PATH in size.
125 EFI_SUCCESS Value found.
126 EFI_ABORTED Format error detected in INF file.
127 EFI_INVALID_PARAMETER Input argument was null.
128 EFI_LOAD_ERROR Error reading from the file.
129 EFI_NOT_FOUND Section/Token/Value not found.
134 IN CHAR8
*AsciiGuidBuffer
,
135 OUT EFI_GUID
*GuidBuffer
143 Converts a string to an EFI_GUID. The string must be in the
144 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format.
148 GuidBuffer - pointer to destination Guid
149 AsciiGuidBuffer - pointer to ascii string
153 EFI_ABORTED Could not convert the string
154 EFI_SUCCESS The string was successfully converted
158 AsciiStringToUint64 (
159 IN CONST CHAR8
*AsciiString
,
161 OUT UINT64
*ReturnValue
169 Converts a null terminated ascii string that represents a number into a
170 UINT64 value. A hex number may be preceeded by a 0x, but may not be
171 succeeded by an h. A number without 0x or 0X is considered to be base 10
172 unless the IsHex input is true.
176 AsciiString The string to convert.
177 IsHex Force the string to be treated as a hex number.
178 ReturnValue The return value.
182 EFI_SUCCESS Number successfully converted.
183 EFI_ABORTED Invalid character encountered.
189 IN OUT CHAR8
*InputBuffer
197 This function reads a line, stripping any comments.
201 InputFile Stream pointer.
202 InputBuffer Buffer to read into, must be _MAX_PATH size.
207 InputBuffer otherwise
211 FindSectionInStream (
221 This function parses a stream file from the beginning to find a section.
222 The section string may be anywhere within a line.
226 InputFile Stream pointer.
227 Section Section to search for
231 FALSE if error or EOF
232 TRUE if section found