CnC_Remastered_Collection/REDALERT/INI.H

160 lines
6.6 KiB
C++

//
// Copyright 2020 Electronic Arts Inc.
//
// TiberianDawn.DLL and RedAlert.dll and corresponding source code is free
// software: you can redistribute it and/or modify it under the terms of
// the GNU General Public License as published by the Free Software Foundation,
// either version 3 of the License, or (at your option) any later version.
// TiberianDawn.DLL and RedAlert.dll and corresponding source code is distributed
// in the hope that it will be useful, but with permitted additional restrictions
// under Section 7 of the GPL. See the GNU General Public License in LICENSE.TXT
// distributed with this program. You should have received a copy of the
// GNU General Public License along with permitted additional restrictions
// with this program. If not, see https://github.com/electronicarts/CnC_Remastered_Collection
/* $Header: /CounterStrike/INI.H 1 3/03/97 10:24a Joe_bostic $ */
/***********************************************************************************************
*** C O N F I D E N T I A L --- W E S T W O O D S T U D I O S ***
***********************************************************************************************
* *
* Project Name : Command & Conquer *
* *
* File Name : INI.H *
* *
* Programmer : Joe L. Bostic *
* *
* Start Date : 05/15/96 *
* *
* Last Update : May 15, 1996 [JLB] *
* *
*---------------------------------------------------------------------------------------------*
* Functions: *
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
#ifndef INI_H
#define INI_H
#include <stdlib.h>
#include "listnode.h"
#include "pipe.h"
#include "wwfile.h"
#include "pk.h"
#include "fixed.h"
#include "crc.h"
#include "search.h"
/*
** This is an INI database handler class. It handles a database with a disk format identical
** to the INI files commonly used by Windows.
*/
class INIClass {
public:
INIClass(void) {}
~INIClass(void);
/*
** Fetch and store INI data.
*/
bool Load(FileClass & file);
bool Load(Straw & file);
int Save(FileClass & file) const;
int Save(Pipe & file) const;
/*
** Erase all data within this INI file manager.
*/
bool Clear(char const * section = 0, char const * entry = 0);
int Line_Count(char const * section) const;
bool Is_Loaded(void) const {return(!SectionList.Is_Empty());}
int Size(void) const;
bool Is_Present(char const * section, char const * entry = 0) const {if (entry == 0) return(Find_Section(section) != 0);return(Find_Entry(section, entry) != 0);}
/*
** Fetch the number of sections in the INI file or verify if a specific
** section is present.
*/
int Section_Count(void) const;
bool Section_Present(char const * section) const {return(Find_Section(section) != NULL);}
/*
** Fetch the number of entries in a section or get a particular entry in a section.
*/
int Entry_Count(char const * section) const;
char const * Get_Entry(char const * section, int index) const;
/*
** Get the various data types from the section and entry specified.
*/
int Get_String(char const * section, char const * entry, char const * defvalue, char * buffer, int size) const;
int Get_Int(char const * section, char const * entry, int defvalue=0) const;
int Get_Hex(char const * section, char const * entry, int defvalue=0) const;
bool Get_Bool(char const * section, char const * entry, bool defvalue=false) const;
int Get_TextBlock(char const * section, char * buffer, int len) const;
int Get_UUBlock(char const * section, void * buffer, int len) const;
PKey Get_PKey(bool fast) const;
fixed Get_Fixed(char const * section, char const * entry, fixed defvalue) const;
/*
** Put a data type to the section and entry specified.
*/
bool Put_Fixed(char const * section, char const * entry, fixed value);
bool Put_String(char const * section, char const * entry, char const * string);
bool Put_Hex(char const * section, char const * entry, int number);
bool Put_Int(char const * section, char const * entry, int number, int format=0);
bool Put_Bool(char const * section, char const * entry, bool value);
bool Put_TextBlock(char const * section, char const * text);
bool Put_UUBlock(char const * section, void const * block, int len);
bool Put_PKey(PKey const & key);
protected:
enum {MAX_LINE_LENGTH=128};
/*
** The value entries for the INI file are stored as objects of this type.
** The entry identifier and value string are combined into this object.
*/
struct INIEntry : Node<INIEntry> {
INIEntry(char * entry = 0, char * value = 0) : Entry(entry), Value(value) {}
~INIEntry(void) {free(Entry);Entry = 0;free(Value);Value = 0;}
int Index_ID(void) const {return(CRCEngine()(Entry, strlen(Entry)));};
char * Entry;
char * Value;
};
/*
** Each section (bracketed) is represented by an object of this type. All entries
** subordinate to this section are attached.
*/
struct INISection : Node<INISection> {
INISection(char * section) : Section(section) {}
~INISection(void) {free(Section);Section = 0;EntryList.Delete();}
INIEntry * Find_Entry(char const * entry) const;
int Index_ID(void) const {return(CRCEngine()(Section, strlen(Section)));};
char * Section;
List<INIEntry> EntryList;
IndexClass<INIEntry *>EntryIndex;
};
/*
** Utility routines to help find the appropriate section and entry objects.
*/
INISection * Find_Section(char const * section) const;
INIEntry * Find_Entry(char const * section, char const * entry) const;
static void Strip_Comments(char * buffer);
/*
** This is the list of all sections within this INI file.
*/
List<INISection> SectionList;
IndexClass<INISection *> SectionIndex;
};
#endif