inffile.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_INFCONTEXT

Macros
#define	STATUS_BAD_SECTION_NAME_LINE   (0xC0700001)
#define	STATUS_SECTION_NAME_TOO_LONG   (0xC0700002)
#define	STATUS_WRONG_INF_STYLE   (0xC0700003)
#define	STATUS_NOT_ENOUGH_MEMORY   (0xC0700004)
#define	MAX_INF_STRING_LENGTH   512

Typedefs
typedef PULONG	HINF
typedef PULONG *	PHINF
typedef struct _INFCONTEXT	INFCONTEXT
typedef struct _INFCONTEXT *	PINFCONTEXT

Functions
BOOLEAN	InfOpenFile (PHINF InfHandle, PCSTR FileName, PULONG ErrorLine)
VOID	InfCloseFile (HINF InfHandle)
BOOLEAN	InfFindFirstLine (HINF InfHandle, PCSTR Section, PCSTR Key, PINFCONTEXT Context)
BOOLEAN	InfFindNextLine (PINFCONTEXT ContextIn, PINFCONTEXT ContextOut)
BOOLEAN	InfFindFirstMatchLine (PINFCONTEXT ContextIn, PCHAR Key, PINFCONTEXT ContextOut)
BOOLEAN	InfFindNextMatchLine (PINFCONTEXT ContextIn, PCHAR Key, PINFCONTEXT ContextOut)
LONG	InfGetLineCount (HINF InfHandle, PCHAR Section)
LONG	InfGetFieldCount (PINFCONTEXT Context)
BOOLEAN	InfGetBinaryField (PINFCONTEXT Context, ULONG FieldIndex, PUCHAR ReturnBuffer, ULONG ReturnBufferSize, PULONG RequiredSize)
BOOLEAN	InfGetIntField (PINFCONTEXT Context, ULONG FieldIndex, LONG *IntegerValue)
BOOLEAN	InfGetMultiSzField (PINFCONTEXT Context, ULONG FieldIndex, PCHAR ReturnBuffer, ULONG ReturnBufferSize, PULONG RequiredSize)
BOOLEAN	InfGetStringField (PINFCONTEXT Context, ULONG FieldIndex, PCHAR ReturnBuffer, ULONG ReturnBufferSize, PULONG RequiredSize)
BOOLEAN	InfGetData (PINFCONTEXT Context, PCHAR *Key, PCHAR *Data)
BOOLEAN	InfGetDataField (PINFCONTEXT Context, ULONG FieldIndex, PCSTR *Data)

Macro Definition Documentation

MAX_INF_STRING_LENGTH

#define MAX_INF_STRING_LENGTH   512

Definition at line 16 of file inffile.h.

STATUS_BAD_SECTION_NAME_LINE

#define STATUS_BAD_SECTION_NAME_LINE   (0xC0700001)

Definition at line 11 of file inffile.h.

STATUS_NOT_ENOUGH_MEMORY

#define STATUS_NOT_ENOUGH_MEMORY   (0xC0700004)

Definition at line 14 of file inffile.h.

STATUS_SECTION_NAME_TOO_LONG

#define STATUS_SECTION_NAME_TOO_LONG   (0xC0700002)

Definition at line 12 of file inffile.h.

STATUS_WRONG_INF_STYLE

#define STATUS_WRONG_INF_STYLE   (0xC0700003)

Definition at line 13 of file inffile.h.

Typedef Documentation

HINF

typedef PULONG HINF

Definition at line 18 of file inffile.h.

INFCONTEXT

typedef struct _INFCONTEXT INFCONTEXT

PHINF

typedef PULONG * PHINF

Definition at line 18 of file inffile.h.

PINFCONTEXT

typedef struct _INFCONTEXT * PINFCONTEXT

Function Documentation

InfCloseFile()

VOID InfCloseFile

(

HINF

InfHandle

)

Definition at line 1028 of file inffile.c.

{
    PINFCACHE Cache;

    Cache = (PINFCACHE)InfHandle;

    if (Cache == NULL)
    {
        return;
    }

    while (Cache->FirstSection != NULL)
    {
        Cache->FirstSection = InfpCacheFreeSection(Cache->FirstSection);
    }
    Cache->LastSection = NULL;

    FrLdrTempFree(Cache, TAG_INF_CACHE);
}

InfFindFirstLine()

BOOLEAN InfFindFirstLine	(	HINF	InfHandle,
		PCSTR	Section,
		PCSTR	Key,
		PINFCONTEXT	Context
	)

Definition at line 1050 of file inffile.c.

{
    PINFCACHE Cache;
    PINFCACHESECTION CacheSection;
    PINFCACHELINE CacheLine;

    if ((InfHandle == NULL) || (Section == NULL) || (Context == NULL))
    {
//      DPRINT("Invalid parameter\n");
        return FALSE;
    }

    Cache = (PINFCACHE)InfHandle;

    /* Iterate through list of sections */
    CacheSection = Cache->FirstSection;
    while (CacheSection != NULL)
    {
//      DPRINT("Comparing '%s' and '%s'\n", CacheSection->Name, Section);

        /* Are the section names the same? */
        if (_stricmp(CacheSection->Name, Section) == 0)
        {
            if (Key != NULL)
            {
                CacheLine = InfpCacheFindKeyLine(CacheSection, Key);
            }
            else
            {
                CacheLine = CacheSection->FirstLine;
            }

            if (CacheLine == NULL)
                return FALSE;

            Context->Inf = (PVOID)Cache;
            Context->Section = (PVOID)CacheSection;
            Context->Line = (PVOID)CacheLine;

            return TRUE;
        }

        /* Get the next section */
        CacheSection = CacheSection->Next;
    }

//  DPRINT("Section not found\n");

    return FALSE;
}

Referenced by LoadReactOSSetup(), SetupFindFirstLineW(), SetupLdrInitErrataInf(), SetupLdrLoadNlsData(), and SetupLdrScanBootDrivers().

InfFindFirstMatchLine()

BOOLEAN InfFindFirstMatchLine	(	PINFCONTEXT	ContextIn,
		PCHAR	Key,
		PINFCONTEXT	ContextOut
	)

Definition at line 1135 of file inffile.c.

{
    PINFCACHELINE CacheLine;

    if ((ContextIn == NULL) || (ContextOut == NULL) || (Key == NULL) || (*Key == 0))
        return FALSE;

    if (ContextIn->Inf == NULL || ContextIn->Section == NULL)
        return FALSE;

    CacheLine = ((PINFCACHESECTION)(ContextIn->Section))->FirstLine;
    while (CacheLine != NULL)
    {
        if ((CacheLine->Key != NULL) && (_stricmp(CacheLine->Key, Key) == 0))
        {

            if (ContextIn != ContextOut)
            {
                ContextOut->Inf = ContextIn->Inf;
                ContextOut->Section = ContextIn->Section;
            }
            ContextOut->Line = (PVOID)CacheLine;

            return TRUE;
        }

        CacheLine = CacheLine->Next;
    }

    return FALSE;
}

InfFindNextLine()

BOOLEAN InfFindNextLine	(	PINFCONTEXT	ContextIn,
		PINFCONTEXT	ContextOut
	)

Definition at line 1107 of file inffile.c.

{
    PINFCACHELINE CacheLine;

    if ((ContextIn == NULL) || (ContextOut == NULL))
        return FALSE;

    if (ContextIn->Line == NULL)
        return FALSE;

    CacheLine = (PINFCACHELINE)ContextIn->Line;
    if (CacheLine->Next == NULL)
        return FALSE;

    if (ContextIn != ContextOut)
    {
        ContextOut->Inf = ContextIn->Inf;
        ContextOut->Section = ContextIn->Section;
    }
    ContextOut->Line = (PVOID)(CacheLine->Next);

    return TRUE;
}

InfFindNextMatchLine()

BOOLEAN InfFindNextMatchLine	(	PINFCONTEXT	ContextIn,
		PCHAR	Key,
		PINFCONTEXT	ContextOut
	)

Definition at line 1172 of file inffile.c.

{
    PINFCACHELINE CacheLine;

    if ((ContextIn == NULL) || (ContextOut == NULL) || (Key == NULL) || (*Key == 0))
        return FALSE;

    if ((ContextIn->Inf == NULL) || (ContextIn->Section == NULL) || (ContextIn->Line == NULL))
        return FALSE;

    CacheLine = (PINFCACHELINE)ContextIn->Line;
    while (CacheLine != NULL)
    {
        if ((CacheLine->Key != NULL) && (_stricmp(CacheLine->Key, Key) == 0))
        {

            if (ContextIn != ContextOut)
            {
                ContextOut->Inf = ContextIn->Inf;
                ContextOut->Section = ContextIn->Section;
            }
            ContextOut->Line = (PVOID)CacheLine;

            return TRUE;
        }

        CacheLine = CacheLine->Next;
    }

    return FALSE;
}

InfGetBinaryField()

BOOLEAN InfGetBinaryField	(	PINFCONTEXT	Context,
		ULONG	FieldIndex,
		PUCHAR	ReturnBuffer,
		ULONG	ReturnBufferSize,
		PULONG	RequiredSize
	)

Definition at line 1260 of file inffile.c.

{
    PINFCACHELINE CacheLine;
    PINFCACHEFIELD CacheField;
    ULONG Index;
    ULONG Size;
    PUCHAR Ptr;

    if ((Context == NULL) || (Context->Line == NULL) || (FieldIndex == 0))
    {
//      DPRINT("Invalid parameter\n");
        return FALSE;
    }

    if (RequiredSize != NULL)
        *RequiredSize = 0;

    CacheLine = (PINFCACHELINE)Context->Line;

    if (FieldIndex > CacheLine->FieldCount)
        return FALSE;

    CacheField = CacheLine->FirstField;
    for (Index = 1; Index < FieldIndex; Index++)
        CacheField = CacheField->Next;

    Size = CacheLine->FieldCount - FieldIndex + 1;

    if (RequiredSize != NULL)
        *RequiredSize = Size;

    if (ReturnBuffer != NULL)
    {
        if (ReturnBufferSize < Size)
            return FALSE;

        /* Copy binary data */
        Ptr = ReturnBuffer;
        while (CacheField != NULL)
        {
            *Ptr = (UCHAR)atoi(CacheField->Data); //strtoul(CacheField->Data, NULL, 16);

            Ptr++;
            CacheField = CacheField->Next;
        }
    }

    return TRUE;
}

InfGetData()

BOOLEAN InfGetData	(	PINFCONTEXT	Context,
		PCHAR *	Key,
		PCHAR *	Data
	)

Definition at line 1491 of file inffile.c.

{
    PINFCACHELINE CacheKey;

    if ((Context == NULL) || (Context->Line == NULL) || (Data == NULL))
    {
//      DPRINT("Invalid parameter\n");
        return FALSE;
    }

    CacheKey = (PINFCACHELINE)Context->Line;
    if (Key != NULL)
        *Key = CacheKey->Key;

    *Data = (CacheKey->FirstField == NULL) ? NULL : CacheKey->FirstField->Data;

    return TRUE;
}

InfGetDataField()

BOOLEAN InfGetDataField	(	PINFCONTEXT	Context,
		ULONG	FieldIndex,
		PCSTR *	Data
	)

Definition at line 1515 of file inffile.c.

{
    PINFCACHELINE CacheLine;
    PINFCACHEFIELD CacheField;
    ULONG Index;

    if ((Context == NULL) || (Context->Line == NULL) || (Data == NULL))
    {
//      DPRINT("Invalid parameter\n");
        return FALSE;
    }

    CacheLine = (PINFCACHELINE)Context->Line;

    if (FieldIndex > CacheLine->FieldCount)
        return FALSE;

    if (FieldIndex == 0)
    {
        *Data = CacheLine->Key;
    }
    else
    {
        CacheField = CacheLine->FirstField;
        for (Index = 1; Index < FieldIndex; Index++)
            CacheField = CacheField->Next;

        *Data = CacheField->Data;
    }

    return TRUE;
}

InfGetFieldCount()

LONG InfGetFieldCount

(

PINFCONTEXT

Context

)

Definition at line 1250 of file inffile.c.

{
    if ((Context == NULL) || (Context->Line == NULL))
        return 0;

    return ((PINFCACHELINE)Context->Line)->FieldCount;
}

InfGetIntField()

BOOLEAN InfGetIntField	(	PINFCONTEXT	Context,
		ULONG	FieldIndex,
		LONG *	IntegerValue
	)

InfGetLineCount()

LONG InfGetLineCount	(	HINF	InfHandle,
		PCHAR	Section
	)

Definition at line 1209 of file inffile.c.

{
    PINFCACHE Cache;
    PINFCACHESECTION CacheSection;

    if ((InfHandle == NULL) || (Section == NULL))
    {
//      DPRINT("Invalid parameter\n");
        return -1;
    }

    Cache = (PINFCACHE)InfHandle;

    /* Iterate through list of sections */
    CacheSection = Cache->FirstSection;
    while (CacheSection != NULL)
    {
//      DPRINT("Comparing '%s' and '%s'\n", CacheSection->Name, Section);

        /* Are the section names the same? */
        if (_stricmp(CacheSection->Name, Section) == 0)
        {
            return CacheSection->LineCount;
        }

        /* Get the next section */
        CacheSection = CacheSection->Next;
    }

//  DPRINT("Section not found\n");

    return -1;
}

InfGetMultiSzField()

BOOLEAN InfGetMultiSzField	(	PINFCONTEXT	Context,
		ULONG	FieldIndex,
		PCHAR	ReturnBuffer,
		ULONG	ReturnBufferSize,
		PULONG	RequiredSize
	)

Definition at line 1361 of file inffile.c.

{
    PINFCACHELINE CacheLine;
    PINFCACHEFIELD CacheField;
    PINFCACHEFIELD FieldPtr;
    ULONG Index;
    SIZE_T Size;
    PCHAR Ptr;

    if ((Context == NULL) || (Context->Line == NULL) || (FieldIndex == 0))
    {
//      DPRINT("Invalid parameter\n");
        return FALSE;
    }

    if (RequiredSize != NULL)
        *RequiredSize = 0;

    CacheLine = (PINFCACHELINE)Context->Line;

    if (FieldIndex > CacheLine->FieldCount)
        return FALSE;

    CacheField = CacheLine->FirstField;
    for (Index = 1; Index < FieldIndex; Index++)
        CacheField = CacheField->Next;

    /* Calculate the required buffer size */
    FieldPtr = CacheField;
    Size = 0;
    while (FieldPtr != NULL)
    {
        Size += (strlen(FieldPtr->Data) + 1);
        FieldPtr = FieldPtr->Next;
    }
    Size++;

    if (RequiredSize != NULL)
        *RequiredSize = (ULONG)Size;

    if (ReturnBuffer != NULL)
    {
        if (ReturnBufferSize < Size)
            return FALSE;

        /* Copy multi-sz string */
        Ptr = ReturnBuffer;
        FieldPtr = CacheField;
        while (FieldPtr != NULL)
        {
            Size = strlen(FieldPtr->Data) + 1;

            strcpy(Ptr, FieldPtr->Data);

            Ptr = Ptr + Size;
            FieldPtr = FieldPtr->Next;
        }
        *Ptr = 0;
    }

    return TRUE;
}

InfGetStringField()

BOOLEAN InfGetStringField	(	PINFCONTEXT	Context,
		ULONG	FieldIndex,
		PCHAR	ReturnBuffer,
		ULONG	ReturnBufferSize,
		PULONG	RequiredSize
	)

Definition at line 1431 of file inffile.c.

{
    PINFCACHELINE CacheLine;
    PINFCACHEFIELD CacheField;
    ULONG Index;
    PCHAR Ptr;
    SIZE_T Size;

    if ((Context == NULL) || (Context->Line == NULL))
    {
//      DPRINT("Invalid parameter\n");
        return FALSE;
    }

    if (RequiredSize != NULL)
        *RequiredSize = 0;

    CacheLine = (PINFCACHELINE)Context->Line;

    if (FieldIndex > CacheLine->FieldCount)
        return FALSE;

    if (FieldIndex == 0)
    {
        Ptr = CacheLine->Key;
    }
    else
    {
        CacheField = CacheLine->FirstField;
        for (Index = 1; Index < FieldIndex; Index++)
            CacheField = CacheField->Next;

        Ptr = CacheField->Data;
    }

    Size = strlen(Ptr) + 1;

    if (RequiredSize != NULL)
        *RequiredSize = (ULONG)Size;

    if (ReturnBuffer != NULL)
    {
        if (ReturnBufferSize < Size)
            return FALSE;

        strcpy(ReturnBuffer, Ptr);
    }

    return TRUE;
}

InfOpenFile()

BOOLEAN InfOpenFile	(	PHINF	InfHandle,
		PCSTR	FileName,
		PULONG	ErrorLine
	)

Definition at line 918 of file inffile.c.

{
    FILEINFORMATION Information;
    ULONG FileId;
    PCHAR FileBuffer;
    ULONG FileSize, Count;
    PINFCACHE Cache;
    BOOLEAN Success;
    ARC_STATUS Status;

    *InfHandle = NULL;
    *ErrorLine = (ULONG) - 1;

    //
    // Open the .inf file
    //
    Status = ArcOpen((PSTR)FileName, OpenReadOnly, &FileId);
    if (Status != ESUCCESS)
    {
        return FALSE;
    }

    //
    // Query file size
    //
    Status = ArcGetFileInformation(FileId, &Information);
    if ((Status != ESUCCESS) || (Information.EndingAddress.HighPart != 0))
    {
        ArcClose(FileId);
        return FALSE;
    }
    FileSize = Information.EndingAddress.LowPart;

    //
    // Allocate buffer to cache the file
    //
    FileBuffer = FrLdrTempAlloc(FileSize + 1, TAG_INF_FILE);
    if (!FileBuffer)
    {
        ArcClose(FileId);
        return FALSE;
    }

    //
    // Read file into memory
    //
    Status = ArcRead(FileId, FileBuffer, FileSize, &Count);
    if ((Status != ESUCCESS) || (Count != FileSize))
    {
        ArcClose(FileId);
        FrLdrTempFree(FileBuffer, TAG_INF_FILE);
        return FALSE;
    }

    //
    // We don't need the file anymore. Close it
    //
    ArcClose(FileId);

    //
    // Append string terminator
    //
    FileBuffer[FileSize] = 0;

    //
    // Allocate infcache header
    //
    Cache = (PINFCACHE)FrLdrTempAlloc(sizeof(INFCACHE), TAG_INF_CACHE);
    if (!Cache)
    {
        FrLdrTempFree(FileBuffer, TAG_INF_FILE);
        return FALSE;
    }

    //
    // Initialize inicache header
    //
    RtlZeroMemory(Cache, sizeof(INFCACHE));

    //
    // Parse the inf buffer
    //
    Success = InfpParseBuffer(Cache,
                              FileBuffer,
                              FileBuffer + FileSize,
                              ErrorLine);
    if (!Success)
    {
        FrLdrTempFree(Cache, TAG_INF_CACHE);
        Cache = NULL;
    }

    //
    // Free file buffer, as it has been parsed
    //
    FrLdrTempFree(FileBuffer, TAG_INF_FILE);

    //
    // Return .inf parsed contents
    //
    *InfHandle = (HINF)Cache;

    return Success;
}

Referenced by LoadReactOSSetup(), and SetupOpenInfFileExW().