parse.c File Reference

#include <freeldr.h>
#include <debug.h>

Include dependency graph for parse.c:

Go to the source code of this file.

Functions
	DBG_DEFAULT_CHANNEL (INIFILE)
BOOLEAN	IniParseFile (PCHAR IniFileData, ULONG IniFileSize)
ULONG	IniGetNextLineSize (PCHAR IniFileData, ULONG IniFileSize, ULONG CurrentOffset)
ULONG	IniGetNextLine (PCHAR IniFileData, ULONG IniFileSize, PCHAR Buffer, ULONG BufferSize, ULONG CurrentOffset)
BOOLEAN	IniIsLineEmpty (PCHAR LineOfText, ULONG TextLength)
BOOLEAN	IniIsCommentLine (PCHAR LineOfText, ULONG TextLength)
BOOLEAN	IniIsSectionName (PCHAR LineOfText, ULONG TextLength)
ULONG	IniGetSectionNameSize (PCHAR SectionNameLine, ULONG LineLength)
VOID	IniExtractSectionName (PCHAR SectionName, PCHAR SectionNameLine, ULONG LineLength)
BOOLEAN	IniIsSetting (PCHAR LineOfText, ULONG TextLength)
ULONG	IniGetSettingNameSize (PCHAR SettingNameLine, ULONG LineLength)
ULONG	IniGetSettingValueSize (PCHAR SettingValueLine, ULONG LineLength)
VOID	IniExtractSettingName (PCHAR SettingName, PCHAR SettingNameLine, ULONG LineLength)
VOID	IniExtractSettingValue (PCHAR SettingValue, PCHAR SettingValueLine, ULONG LineLength)

Variables
LIST_ENTRY	IniFileSectionListHead = {&IniFileSectionListHead, &IniFileSectionListHead}
BOOLEAN	IniFileSectionInitialized = FALSE
ULONG	IniFileSectionCount = 0
ULONG	IniFileSettingCount = 0

Function Documentation

DBG_DEFAULT_CHANNEL()

DBG_DEFAULT_CHANNEL

(

INIFILE

)

IniExtractSectionName()

VOID IniExtractSectionName	(	PCHAR	SectionName,
		PCHAR	SectionNameLine,
		ULONG	LineLength
	)

Definition at line 360 of file parse.c.

{
    ULONG        Idx;
    ULONG        DestIdx;
 
    // Find the opening bracket (skipping whitespace)
    for (Idx=0; Idx<LineLength; Idx++)
    {
        if ((SectionNameLine[Idx] == ' ') ||
            (SectionNameLine[Idx] == '\t'))
        {
            continue;
        }
        else //if (SectionNameLine[Idx] == '[')
        {
            break;
        }
    }
 
    // Skip past the opening bracket
    Idx++;
 
    // Count the characters up until the closing bracket or EOL
    for (DestIdx=0; Idx<LineLength; Idx++)
    {
        if ((SectionNameLine[Idx] == ']') ||
            (SectionNameLine[Idx] == '\0'))
        {
            break;
        }
 
        // Grab a character and increment DestIdx
        SectionName[DestIdx] = SectionNameLine[Idx];
        DestIdx++;
    }
 
    // Terminate the string
    SectionName[DestIdx] = '\0';
}

Referenced by IniParseFile().

IniExtractSettingName()

VOID IniExtractSettingName	(	PCHAR	SettingName,
		PCHAR	SettingNameLine,
		ULONG	LineLength
	)

Definition at line 507 of file parse.c.

{
    ULONG        Idx;
    ULONG        DestIdx;
 
    // Skip whitespace
    for (Idx=0; Idx<LineLength; Idx++)
    {
        if ((SettingNameLine[Idx] == ' ') ||
            (SettingNameLine[Idx] == '\t'))
        {
            continue;
        }
        else
        {
            break;
        }
    }
 
    // Get the characters up until the '=' equals sign or EOL
    for (DestIdx=0; Idx<LineLength; Idx++)
    {
        if ((SettingNameLine[Idx] == '=') ||
            (SettingNameLine[Idx] == '\0'))
        {
            break;
        }
 
        // Grab a character and increment DestIdx
        SettingName[DestIdx] = SettingNameLine[Idx];
        DestIdx++;
    }
 
    // Terminate the string
    SettingName[DestIdx] = '\0';
}

Referenced by IniParseFile().

IniExtractSettingValue()

VOID IniExtractSettingValue	(	PCHAR	SettingValue,
		PCHAR	SettingValueLine,
		ULONG	LineLength
	)

Definition at line 544 of file parse.c.

{
    ULONG        Idx;
    ULONG        DestIdx;
 
    // Skip whitespace
    for (Idx=0; Idx<LineLength; Idx++)
    {
        if ((SettingValueLine[Idx] == ' ') ||
            (SettingValueLine[Idx] == '\t'))
        {
            continue;
        }
        else
        {
            break;
        }
    }
 
    // Skip the characters up until the '=' equals sign or EOL
    for (; Idx<LineLength; Idx++)
    {
        if (SettingValueLine[Idx] == '=')
        {
            Idx++;
            break;
        }
 
        // If we hit EOL then obviously the value size is zero
        if (SettingValueLine[Idx] == '\0')
        {
            SettingValue[0] = '\0';
            return;
        }
    }
 
    // Get the characters up until the EOL
    for (DestIdx=0; Idx<LineLength; Idx++)
    {
        if (SettingValueLine[Idx] == '\0')
        {
            break;
        }
 
        // Grab a character and increment DestIdx
        SettingValue[DestIdx] = SettingValueLine[Idx];
        DestIdx++;
    }
 
    // Terminate the string
    SettingValue[DestIdx] = '\0';
}

Referenced by IniParseFile().

IniGetNextLine()

ULONG IniGetNextLine	(	PCHAR	IniFileData,
		ULONG	IniFileSize,
		PCHAR	Buffer,
		ULONG	BufferSize,
		ULONG	CurrentOffset
	)

Definition at line 210 of file parse.c.

{
    ULONG        Idx;
 
    // Loop through grabbing chars until we hit the end of the
    // file or we encounter a new line char
    for (Idx=0; (CurrentOffset < IniFileSize); CurrentOffset++)
    {
        // If we haven't exceeded our buffer size yet
        // then store another char
        if (Idx < (BufferSize - 1))
        {
            Buffer[Idx++] = IniFileData[CurrentOffset];
        }
 
        // Check for new line char
        if (IniFileData[CurrentOffset] == '\n')
        {
            CurrentOffset++;
            break;
        }
    }
 
    // Terminate the string
    Buffer[Idx] = '\0';
 
    // Get rid of newline & linefeed characters (if any)
    while(Idx && (Buffer[--Idx] == '\n' || Buffer[Idx] == '\r'))
        Buffer[Idx] = '\0';
 
    // Send back new offset
    return CurrentOffset;
}

Referenced by IniParseFile().

IniGetNextLineSize()

ULONG IniGetNextLineSize	(	PCHAR	IniFileData,
		ULONG	IniFileSize,
		ULONG	CurrentOffset
	)

Definition at line 185 of file parse.c.

{
    ULONG        LineCharCount = 0;
 
    // Loop through counting chars until we hit the end of the
    // file or we encounter a new line char
    for (; (CurrentOffset < IniFileSize); CurrentOffset++)
    {
        // Increment the line character count
        LineCharCount++;
 
        // Check for new line char
        if (IniFileData[CurrentOffset] == '\n')
        {
            break;
        }
    }
 
    // Add one for the NULL-terminator
    LineCharCount++;
 
    // Send back line character count
    return LineCharCount;
}

Referenced by IniParseFile().

IniGetSectionNameSize()

ULONG IniGetSectionNameSize	(	PCHAR	SectionNameLine,
		ULONG	LineLength
	)

Definition at line 319 of file parse.c.

{
    ULONG        Idx;
    ULONG        NameSize;
 
    // Find the opening bracket (skipping whitespace)
    for (Idx=0; Idx<LineLength; Idx++)
    {
        if ((SectionNameLine[Idx] == ' ') ||
            (SectionNameLine[Idx] == '\t'))
        {
            continue;
        }
        else //if (SectionNameLine[Idx] == '[')
        {
            break;
        }
    }
 
    // Skip past the opening bracket
    Idx++;
 
    // Count the characters up until the closing bracket or EOL
    for (NameSize=0; Idx<LineLength; Idx++)
    {
        if ((SectionNameLine[Idx] == ']') ||
            (SectionNameLine[Idx] == '\0'))
        {
            break;
        }
 
        // Increment the count
        NameSize++;
    }
 
    // Add one for the NULL-terminator
    NameSize++;
 
    return NameSize;
}

Referenced by IniParseFile().

IniGetSettingNameSize()

ULONG IniGetSettingNameSize	(	PCHAR	SettingNameLine,
		ULONG	LineLength
	)

Definition at line 416 of file parse.c.

{
    ULONG        Idx;
    ULONG        NameSize;
 
    // Skip whitespace
    for (Idx=0; Idx<LineLength; Idx++)
    {
        if ((SettingNameLine[Idx] == ' ') ||
            (SettingNameLine[Idx] == '\t'))
        {
            continue;
        }
        else
        {
            break;
        }
    }
 
    // Count the characters up until the '=' equals sign or EOL
    for (NameSize=0; Idx<LineLength; Idx++)
    {
        if ((SettingNameLine[Idx] == '=') ||
            (SettingNameLine[Idx] == '\0'))
        {
            break;
        }
 
        // Increment the count
        NameSize++;
    }
 
    // Add one for the NULL-terminator
    NameSize++;
 
    return NameSize;
}

Referenced by IniParseFile().

IniGetSettingValueSize()

ULONG IniGetSettingValueSize	(	PCHAR	SettingValueLine,
		ULONG	LineLength
	)

Definition at line 454 of file parse.c.

{
    ULONG        Idx;
    ULONG        ValueSize;
 
    // Skip whitespace
    for (Idx=0; Idx<LineLength; Idx++)
    {
        if ((SettingValueLine[Idx] == ' ') ||
            (SettingValueLine[Idx] == '\t'))
        {
            continue;
        }
        else
        {
            break;
        }
    }
 
    // Skip the characters up until the '=' equals sign or EOL
    for (; Idx<LineLength; Idx++)
    {
        if (SettingValueLine[Idx] == '=')
        {
            Idx++;
            break;
        }
 
        // If we hit EOL then obviously the value size is zero
        if (SettingValueLine[Idx] == '\0')
        {
            return 0;
        }
    }
 
    // Count the characters up until the EOL
    for (ValueSize=0; Idx<LineLength; Idx++)
    {
        if (SettingValueLine[Idx] == '\0')
        {
            break;
        }
 
        // Increment the count
        ValueSize++;
    }
 
    // Add one for the NULL-terminator
    ValueSize++;
 
    return ValueSize;
}

Referenced by IniParseFile().

IniIsCommentLine()

BOOLEAN IniIsCommentLine	(	PCHAR	LineOfText,
		ULONG	TextLength
	)

Definition at line 267 of file parse.c.

{
    ULONG        Idx;
 
    // Check the first character (skipping whitespace)
    // and make sure that it is an opening bracket
    for (Idx=0; Idx<TextLength; Idx++)
    {
        if ((LineOfText[Idx] == ' ') ||
            (LineOfText[Idx] == '\t'))
        {
            continue;
        }
        else if (LineOfText[Idx] == INI_FILE_COMMENT_CHAR)
        {
            return TRUE;
        }
        else
        {
            break;
        }
    }
 
    return FALSE;
}

Referenced by IniParseFile().

IniIsLineEmpty()

BOOLEAN IniIsLineEmpty	(	PCHAR	LineOfText,
		ULONG	TextLength
	)

Definition at line 244 of file parse.c.

{
    ULONG        Idx;
 
    // Check for text (skipping whitespace)
    for (Idx=0; Idx<TextLength; Idx++)
    {
        if ((LineOfText[Idx] == ' ') ||
            (LineOfText[Idx] == '\t') ||
            (LineOfText[Idx] == '\n') ||
            (LineOfText[Idx] == '\r'))
        {
            continue;
        }
        else
        {
            return FALSE;
        }
    }
 
    return TRUE;
}

Referenced by IniParseFile().

IniIsSectionName()

BOOLEAN IniIsSectionName	(	PCHAR	LineOfText,
		ULONG	TextLength
	)

Definition at line 293 of file parse.c.

{
    ULONG        Idx;
 
    // Check the first character (skipping whitespace)
    // and make sure that it is an opening bracket
    for (Idx=0; Idx<TextLength; Idx++)
    {
        if ((LineOfText[Idx] == ' ') ||
            (LineOfText[Idx] == '\t'))
        {
            continue;
        }
        else if (LineOfText[Idx] == '[')
        {
            return TRUE;
        }
        else
        {
            break;
        }
    }
 
    return FALSE;
}

Referenced by IniParseFile().

IniIsSetting()

BOOLEAN IniIsSetting	(	PCHAR	LineOfText,
		ULONG	TextLength
	)

Definition at line 400 of file parse.c.

{
    ULONG        Idx;
 
    // Basically just check for an '=' equals sign
    for (Idx=0; Idx<TextLength; Idx++)
    {
        if (LineOfText[Idx] == '=')
        {
            return TRUE;
        }
    }
 
    return FALSE;
}

Referenced by IniParseFile().

IniParseFile()

BOOLEAN IniParseFile	(	PCHAR	IniFileData,
		ULONG	IniFileSize
	)

Definition at line 31 of file parse.c.

{
    ULONG                    CurrentOffset;
    ULONG                    CurrentLineNumber;
    PCHAR                IniFileLine;
    ULONG                    IniFileLineSize;
    ULONG                    LineLength;
    PINI_SECTION        CurrentSection = NULL;
    PINI_SECTION_ITEM    CurrentItem = NULL;
 
    TRACE("IniParseFile() IniFileSize: %d\n", IniFileSize);
 
    if (!IniFileSectionInitialized)
    {
        InitializeListHead(&IniFileSectionListHead);
        IniFileSectionInitialized = TRUE;
    }
 
    // Start with an 80-byte buffer
    IniFileLineSize = 80;
    IniFileLine = FrLdrTempAlloc(IniFileLineSize, TAG_INI_FILE);
    if (!IniFileLine)
    {
        return FALSE;
    }
 
    // Loop through each line and parse it
    CurrentLineNumber = 0;
    CurrentOffset = 0;
    while (CurrentOffset < IniFileSize)
    {
        // First check the line size and increase our buffer if necessary
        if (IniFileLineSize < IniGetNextLineSize(IniFileData, IniFileSize, CurrentOffset))
        {
            IniFileLineSize = IniGetNextLineSize(IniFileData, IniFileSize, CurrentOffset);
            FrLdrTempFree(IniFileLine, TAG_INI_FILE);
            IniFileLine = FrLdrTempAlloc(IniFileLineSize, TAG_INI_FILE);
            if (!IniFileLine)
            {
                return FALSE;
            }
        }
 
        // Get the line of data
        CurrentOffset = IniGetNextLine(IniFileData, IniFileSize, IniFileLine, IniFileLineSize, CurrentOffset);
        LineLength = (ULONG)strlen(IniFileLine);
 
        // If it is a blank line or a comment then skip it
        if (IniIsLineEmpty(IniFileLine, LineLength) || IniIsCommentLine(IniFileLine, LineLength))
        {
            CurrentLineNumber++;
            continue;
        }
 
        // Check if it is a new section
        if (IniIsSectionName(IniFileLine, LineLength))
        {
            // Allocate a new section structure
            CurrentSection = FrLdrTempAlloc(sizeof(INI_SECTION), TAG_INI_SECTION);
            if (!CurrentSection)
            {
                FrLdrTempFree(IniFileLine, TAG_INI_FILE);
                return FALSE;
            }
 
            RtlZeroMemory(CurrentSection, sizeof(INI_SECTION));
 
            // Allocate the section name buffer
            CurrentSection->SectionName = FrLdrTempAlloc(IniGetSectionNameSize(IniFileLine, LineLength), TAG_INI_NAME);
            if (!CurrentSection->SectionName)
            {
                FrLdrTempFree(CurrentSection, TAG_INI_FILE);
                FrLdrTempFree(IniFileLine, TAG_INI_FILE);
                return FALSE;
            }
 
            // Get the section name
            IniExtractSectionName(CurrentSection->SectionName, IniFileLine, LineLength);
            InitializeListHead(&CurrentSection->SectionItemList);
 
            // Add it to the section list head
            IniFileSectionCount++;
            InsertTailList(&IniFileSectionListHead, &CurrentSection->ListEntry);
 
            CurrentLineNumber++;
            continue;
        }
 
        // Check if it is a setting
        if (IniIsSetting(IniFileLine, LineLength))
        {
            // First check to make sure we're inside a [section]
            if (CurrentSection == NULL)
            {
                ERR("Error: freeldr.ini:%lu: Setting '%s' found outside of a [section].\n", CurrentLineNumber, IniFileLine);
 
                // Skip it
                CurrentLineNumber++;
                continue;
            }
 
            // Allocate a new item structure
            CurrentItem = FrLdrTempAlloc(sizeof(INI_SECTION_ITEM), TAG_INI_SECTION_ITEM);
            if (!CurrentItem)
            {
                FrLdrTempFree(IniFileLine, TAG_INI_FILE);
                return FALSE;
            }
 
            RtlZeroMemory(CurrentItem, sizeof(INI_SECTION_ITEM));
 
            // Allocate the setting name buffer
            CurrentItem->ItemName = FrLdrTempAlloc(IniGetSettingNameSize(IniFileLine, LineLength), TAG_INI_NAME);
            if (!CurrentItem->ItemName)
            {
                FrLdrTempFree(CurrentItem, TAG_INI_SECTION_ITEM);
                FrLdrTempFree(IniFileLine, TAG_INI_FILE);
                return FALSE;
            }
 
            // Allocate the setting value buffer
            CurrentItem->ItemValue = FrLdrTempAlloc(IniGetSettingValueSize(IniFileLine, LineLength), TAG_INI_VALUE);
            if (!CurrentItem->ItemValue)
            {
                FrLdrTempFree(CurrentItem->ItemName, TAG_INI_NAME);
                FrLdrTempFree(CurrentItem, TAG_INI_SECTION_ITEM);
                FrLdrTempFree(IniFileLine, TAG_INI_FILE);
                return FALSE;
            }
 
            // Get the section name
            IniExtractSettingName(CurrentItem->ItemName, IniFileLine, LineLength);
            IniExtractSettingValue(CurrentItem->ItemValue, IniFileLine, LineLength);
 
            // Add it to the current section
            IniFileSettingCount++;
            CurrentSection->SectionItemCount++;
            InsertTailList(&CurrentSection->SectionItemList, &CurrentItem->ListEntry);
 
            CurrentLineNumber++;
            continue;
        }
 
        CurrentLineNumber++;
    }
 
    FrLdrTempFree(IniFileLine, TAG_INI_FILE);
 
    TRACE("Parsed %d sections and %d settings.\n", IniFileSectionCount, IniFileSettingCount);
    TRACE("IniParseFile() done.\n");
 
    return TRUE;
}

Referenced by IniFileInitialize().

Variable Documentation

IniFileSectionCount

ULONG IniFileSectionCount = 0

Definition at line 27 of file parse.c.

Referenced by IniAddSection(), and IniParseFile().

IniFileSectionInitialized

BOOLEAN IniFileSectionInitialized = FALSE

Definition at line 26 of file parse.c.

Referenced by IniParseFile().

IniFileSectionListHead

LIST_ENTRY IniFileSectionListHead = {&IniFileSectionListHead, &IniFileSectionListHead}

Definition at line 25 of file parse.c.

Referenced by IniAddSection(), IniCleanup(), IniOpenSection(), IniParseFile(), and LoadSettings().

IniFileSettingCount

ULONG IniFileSettingCount = 0

Definition at line 28 of file parse.c.

Referenced by IniParseFile().