SimpleFileParsing.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
Abstract:
Generic but simple file parsing routines.
--*/
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include "EfiUtilityMsgs.h"
#include "SimpleFileParsing.h"
#ifndef MAX_PATH
#define MAX_PATH 255
#endif
//
// just in case we get in an endless loop.
//
#define MAX_NEST_DEPTH 20
//
// number of wchars
//
#define MAX_STRING_IDENTIFIER_NAME 100
#define T_CHAR_SPACE ' '
#define T_CHAR_NULL 0
#define T_CHAR_CR '\r'
#define T_CHAR_TAB '\t'
#define T_CHAR_LF '\n'
#define T_CHAR_SLASH '/'
#define T_CHAR_BACKSLASH '\\'
#define T_CHAR_DOUBLE_QUOTE '"'
#define T_CHAR_LC_X 'x'
#define T_CHAR_0 '0'
#define T_CHAR_STAR '*'
//
// We keep a linked list of these for the source files we process
//
typedef struct _SOURCE_FILE {
struct _SOURCE_FILE *Previous;
struct _SOURCE_FILE *Next;
} SOURCE_FILE;
typedef struct {
//
// Keep all our module globals in this structure
//
STATIC struct {
} mGlobals;
t_strcmp (
);
);
t_strlen (
);
);
);
);
);
);
CHAR8 *
t_strcpy (
);
);
);
);
);
SFPInit (
)
/*++
Routine Description:
Arguments:
None.
Returns:
STATUS_SUCCESS always
--*/
{
return STATUS_SUCCESS;
}
)
/*++
Routine Description:
Return the line number of the file we're parsing. Used
for error reporting purposes.
Arguments:
None.
Returns:
The line number, or 0 if no file is being processed
--*/
{
}
CHAR8 *
)
/*++
Routine Description:
Return the name of the file we're parsing. Used
for error reporting purposes.
Arguments:
None.
Returns:
A pointer to the file name. Null if no file is being
processed.
--*/
{
}
return NULL;
}
)
/*++
Routine Description:
Open a file for parsing.
Arguments:
FileName - name of the file to parse
Returns:
--*/
{
return Status;
}
)
/*++
Routine Description:
Check to see if the specified token is found at
the current position in the input file.
Arguments:
Str - the token to look for
Returns:
TRUE - the token is next
FALSE - the token is not next
Notes:
We do a simple string comparison on this function. It is
the responsibility of the caller to ensure that the token
is not a subset of some other token.
The file pointer is advanced past the token in the input file.
--*/
{
return FALSE;
}
if (mGlobals.VerboseToken) {
}
return TRUE;
}
return FALSE;
}
)
/*++
Routine Description:
Check to see if the specified keyword is found at
the current position in the input file.
Arguments:
Str - keyword to look for
Returns:
TRUE - the keyword is next
FALSE - the keyword is not next
Notes:
A keyword is defined as a "special" string that has a non-alphanumeric
character following it.
--*/
{
return FALSE;
}
return FALSE;
}
if (mGlobals.VerboseToken) {
}
return TRUE;
}
return FALSE;
}
)
/*++
Routine Description:
Get the next token from the input stream.
Arguments:
Str - pointer to a copy of the next token
Len - size of buffer pointed to by Str
Returns:
TRUE - next token successfully returned
FALSE - otherwise
Notes:
Preceeding white space is ignored.
The parser's buffer pointer is advanced past the end of the
token.
--*/
{
return FALSE;
}
//
// Have to have enough string for at least one char and a null-terminator
//
if (Len < 2) {
return FALSE;
}
//
// Look at the first character. If it's an identifier, then treat it
// as such
//
if (((TempChar >= 'a') && (TempChar <= 'z')) || ((TempChar >= 'A') && (TempChar <= 'Z')) || (TempChar == '_')) {
Index = 1;
(TempChar == '_')
) {
Index++;
} else {
//
// Invalid character for symbol name, so break out
//
break;
}
}
//
// Null terminate and return success
//
return TRUE;
Str[1] = 0;
return TRUE;
} else {
//
// Everything else is white-space (or EOF) separated
//
Index = 0;
if (Index > 0) {
return TRUE;
}
return FALSE;
} else {
Index++;
}
}
//
// See if we just ran out of file contents, but did find a token
//
return TRUE;
}
}
return FALSE;
}
)
/*++
Routine Description:
Parse a GUID from the input stream. Stop when you discover white space.
Arguments:
Str - pointer to a copy of the next token
Len - size of buffer pointed to by Str
Returns:
TRUE - GUID string returned successfully
FALSE - otherwise
--*/
{
return FALSE;
}
Index = 0;
if (Index > 0) {
return TRUE;
}
return FALSE;
} else {
Index++;
}
}
return FALSE;
}
)
{
return TRUE;
}
}
return FALSE;
}
)
/*++
Routine Description:
Check the token at the current file position for a numeric value.
May be either decimal or hex.
Arguments:
Value - pointer where to store the value
Returns:
FALSE - current token is not a number
TRUE - current token is a number
--*/
{
unsigned Val;
return FALSE;
}
//
// Check for hex value
//
if ((mGlobals.SourceFile.FileBufferPtr[0] == T_CHAR_0) && (mGlobals.SourceFile.FileBufferPtr[1] == T_CHAR_LC_X)) {
return FALSE;
}
}
return TRUE;
} else {
}
return TRUE;
}
} else {
return FALSE;
}
}
)
/*++
Routine Description:
Close the file being parsed.
Arguments:
None.
Returns:
STATUS_SUCCESS - the file was closed
STATUS_ERROR - no file is currently open
--*/
{
return STATUS_SUCCESS;
}
return STATUS_ERROR;
}
)
/*++
Routine Description:
Given a source file, open the file and parse it
Arguments:
SourceFile - name of file to parse
ParentSourceFile - for error reporting purposes, the file that #included SourceFile.
Returns:
Standard status.
--*/
{
NestDepth++;
//
// Print the file being processed. Indent so you can tell the include nesting
// depth.
//
if (mGlobals.VerboseFile) {
}
//
// Make sure we didn't exceed our maximum nesting depth
//
if (NestDepth > MAX_NEST_DEPTH) {
Error (NULL, 0, 3001, "Not Supported", "%s exceeeds max nesting depth (%u)", SourceFile->FileName, (unsigned) NestDepth);
goto Finish;
}
//
// Try to open the file locally, and if that fails try along our include paths.
//
return STATUS_ERROR;
}
//
// Process the file found
//
//
// Close open files and return status
//
}
return Status;
}
)
/*++
Routine Description:
Given a source file that's been opened, read the contents into an internal
buffer and pre-process it to remove comments.
Arguments:
SourceFile - structure containing info on the file to process
Returns:
Standard status.
--*/
{
//
// Get the file size, and then read the entire thing into memory.
// Allocate extra space for a terminator character.
//
if (mGlobals.VerboseFile) {
printf ("FileSize = %u (0x%X)\n", (unsigned) SourceFile->FileSize, (unsigned) SourceFile->FileSize);
}
return STATUS_ERROR;
}
//
// Pre-process the file to replace comments with spaces
//
return STATUS_SUCCESS;
}
)
/*++
Routine Description:
Preprocess a file to replace all carriage returns with NULLs so
we can print lines (as part of error messages) from the file to the screen.
Arguments:
SourceFile - structure that we use to keep track of an input file.
Returns:
Nothing.
--*/
{
int LineNum;
while (!EndOfFile (SourceFile)) {
//
// If a line-feed, then no longer in a comment if we're in a // comment
//
SourceFile->LineNum++;
if (InComment && SlashSlashComment) {
}
//
// Replace all carriage returns with a NULL so we can print stuff
//
SourceFile->FileBufferPtr[0] = 0;
//
// Check for */ comment end
//
} else if (InComment &&
) {
} else if (InComment) {
//
// Check for // comments
//
} else if ((SourceFile->FileBufferPtr[0] == T_CHAR_SLASH) && (SourceFile->FileBufferPtr[1] == T_CHAR_SLASH)) {
//
// Check for /* comment start
//
} else if ((SourceFile->FileBufferPtr[0] == T_CHAR_SLASH) && (SourceFile->FileBufferPtr[1] == T_CHAR_STAR)) {
} else {
}
}
//
// Could check for end-of-file and still in a comment, but
// should not be necessary. So just restore the file pointers.
//
//
// Dump the reformatted file if verbose mode
//
if (mGlobals.VerboseFile) {
LineNum = 1;
while (!EndOfFile (SourceFile)) {
} else {
}
}
printf ("'\n");
}
}
)
/*++
Routine Description:
Retrieve a quoted-string from the input file.
Arguments:
Str - pointer to a copy of the quoted string parsed
Length - size of buffer pointed to by Str
Returns:
TRUE - next token in input stream was a quoted string, and
the string value was returned in Str
FALSE - otherwise
--*/
{
return FALSE;
}
while (Length > 0) {
return FALSE;
}
//
// Check for closing quote
//
*Str = 0;
return TRUE;
}
Str++;
Length--;
}
}
//
// First character was not a quote, or the input string length was
// insufficient to contain the quoted string, so return failure code.
//
return FALSE;
}
SFPIsEOF (
)
/*++
Routine Description:
Return TRUE of FALSE to indicate whether or not we've reached the end of the
file we're parsing.
Arguments:
NA
Returns:
TRUE - EOF reached
FALSE - otherwise
--*/
{
}
#if 0
CHAR8 *
)
{
Error (SourceFile->FileName, SourceFile->LineNum, 0, "expected quoted string", "%S", SourceFile->FileBufferPtr);
}
return NULL;
}
Len = 0;
while (!EndOfFile (SourceFile)) {
break;
Warning (SourceFile->FileName, SourceFile->LineNum, 0, "carriage return found in quoted string", "%S", Start);
} else {
}
Len++;
}
Warning (SourceFile->FileName, SourceFile->LineNum, 0, "missing closing quote on string", "%S", Start);
} else {
}
//
// Now allocate memory for the string and save it off
//
return NULL;
}
//
// Copy the string from the file buffer to the local copy.
// We do no reformatting of it whatsoever at this point.
//
while (Len > 0) {
Start++;
Ptr++;
Len--;
}
*Ptr = 0;
return String;
}
#endif
)
{
//
// The file buffer pointer will typically get updated before the End-of-file flag in the
// source file structure, so check it first.
//
return TRUE;
}
if (SourceFile->EndOfFile) {
return TRUE;
}
return FALSE;
}
#if 0
)
{
if (SkipWhiteSpace (SourceFile) == 0) {
Warning (SourceFile->FileName, SourceFile->LineNum, 0, "expected whitespace following #include keyword", NULL);
}
//
// Should be quoted file name
//
goto FailDone;
}
//
// Copy the filename as ascii to our local string
//
Len = 0;
while (!EndOfFile (SourceFile)) {
Error (SourceFile->FileName, SourceFile->LineNum, 0, "end-of-line found in quoted include file name", NULL);
goto FailDone;
}
break;
}
//
// If too long, then report the error once and process until the closing quote
//
Len++;
Error (SourceFile->FileName, SourceFile->LineNum, 0, "length of include file name exceeds limit", NULL);
}
if (!ReportedError) {
To++;
}
}
if (!ReportedError) {
*To = 0;
}
return ;
//
// Error recovery -- skip to next #
//
}
#endif
)
{
switch (*SourceFile->FileBufferPtr) {
case T_CHAR_NULL:
case T_CHAR_CR:
case T_CHAR_SPACE:
case T_CHAR_TAB:
case T_CHAR_LF:
return TRUE;
default:
return FALSE;
}
}
)
{
Count = 0;
while (!EndOfFile (SourceFile)) {
Count++;
switch (*SourceFile->FileBufferPtr) {
case T_CHAR_NULL:
case T_CHAR_CR:
case T_CHAR_SPACE:
case T_CHAR_TAB:
break;
case T_CHAR_LF:
SourceFile->LineNum++;
break;
default:
return Count - 1;
}
}
//
// Some tokens require trailing whitespace. If we're at the end of the
// file, then we count that as well.
//
Count++;
}
return Count;
}
t_strcmp (
)
/*++
Routine Description:
Compare two strings for equality. The string pointed to by 'Buffer' may or may not be null-terminated,
so only compare up to the length of Str.
Arguments:
Buffer - pointer to first (possibly not null-terminated) string
Str - pointer to null-terminated string to compare to Buffer
Returns:
Number of bytes matched if exact match
0 if Buffer does not start with Str
--*/
{
Len = 0;
Buffer++;
Str++;
Len++;
}
if (*Str) {
return 0;
}
return Len;
}
t_strlen (
)
{
Len = 0;
while (*Str) {
Len++;
Str++;
}
return Len;
}
)
{
while (Len > 0) {
return Len;
}
Len--;
Str1++;
Str2++;
}
return 0;
}
CHAR8 *
t_strcpy (
)
{
while (*Src) {
Dest++;
Src++;
}
*Dest = 0;
return SaveDest;
}
)
{
SourceFile->EndOfFile = 0;
}
)
{
Len = 0;
Buffer++;
Len++;
BufferLen--;
} else {
break;
}
}
//
// Null terminate if we can
//
*Buffer = 0;
}
return Len;
}
)
/*++
Routine Description:
Parse a GUID from the input stream. Stop when you discover white space.
Arguments:
GuidStyle - Style of the following GUID token
Value - pointer to EFI_GUID struct for output
Returns:
TRUE - GUID string parsed successfully
FALSE - otherwise
GUID styles
Style[0] 12345678-1234-5678-AAAA-BBBBCCCCDDDD
--*/
{
unsigned Value32;
//
// Skip white space, then start parsing
//
GetFilePosition (&FPos);
return FALSE;
}
if (GuidStyle == PARSE_GUID_STYLE_5_FIELDS) {
//
// Style[0] 12345678-1234-5678-AAAA-BBBBCCCCDDDD
//
goto Done;
}
//
// Next two UINT16 fields
//
goto Done;
}
goto Done;
}
goto Done;
}
goto Done;
}
//
// Parse the "AAAA" as two bytes
//
goto Done;
}
goto Done;
}
goto Done;
}
//
// Read the last 6 bytes of the GUID
//
//
goto Done;
}
//
// Insert leading 0's to make life easier
//
if (Len != 12) {
TempString[12] = 0;
while (From >= TempString) {
To--;
From--;
}
while (To >= TempString) {
*To = '0';
To--;
}
}
//
// Now parse each byte
//
TempString2[2] = 0;
//
// Copy the two characters from the input string to something
// we can parse.
//
}
} else {
//
// Unsupported GUID style
//
return FALSE;
}
Done:
SetFilePosition (&FPos);
}
return Status;
}
)
{
return STATUS_SUCCESS;
}
)
{
//
// Should check range of pointer
//
return STATUS_SUCCESS;
}