Tool to create computer-readable settings. More...

#include "../stdafx.h"
#include "../core/string_consumer.hpp"
#include "../string_func.h"
#include "../strings_type.h"
#include "../misc/getoptdata.h"
#include "../ini_type.h"
#include "../core/mem_func.hpp"
#include "../error_func.h"
#include <filesystem>
#include "../safeguards.h"

Data Structures
class	OutputBuffer
	Output buffer for a block of data. More...

class	OutputStore
	Temporarily store output. More...

struct	SettingsIniFile
	Derived class for loading INI files without going through Fio stuff. More...

Functions
void	FatalErrorI (const std::string &msg)
	Report a fatal error.

static void	DumpGroup (const IniLoadFile &ifile, std::string_view group_name)
	Dump a IGT_SEQUENCE group into _stored_output.

static std::optional< std::string_view >	FindItemValue (std::string_view name, const IniGroup grp, const IniGroup defaults)
	Find the value of a template variable.

static void	DumpLine (const IniItem item, const IniGroup grp, const IniGroup *default_grp, OutputStore &output)
	Parse a single entry via a template and output this.

static void	DumpSections (const IniLoadFile &ifile)
	Output all non-special sections through the template / template variable expansion system.

static void	AppendFile (std::optional< std::string_view > fname, FILE *out_fp)
	Append a file to the output stream.

static bool	CompareFiles (std::string_view n1, std::string_view n2)
	Compare two files for identity.

static void	ProcessIniFile (std::string_view fname)
	Process a single INI file.

int CDECL	main (int argc, char *argv[])
	And the main program (what else?)

Variables
static const size_t	OUTPUT_BLOCK_SIZE = 16000
	Block size of the buffer in OutputBuffer.

OutputStore	_stored_output
	Temporary storage of the output, until all processing is done.

OutputStore	_post_amble_output
	Similar to _stored_output, but for the post amble.

static std::string_view	PREAMBLE_GROUP_NAME = "pre-amble"
	Name of the group containing the pre amble.

static std::string_view	POSTAMBLE_GROUP_NAME = "post-amble"
	Name of the group containing the post amble.

static std::string_view	TEMPLATES_GROUP_NAME = "templates"
	Name of the group containing the templates.

static std::string_view	VALIDATION_GROUP_NAME = "validation"
	Name of the group containing the validation statements.

static std::string_view	DEFAULTS_GROUP_NAME = "defaults"
	Name of the group containing default values for the template variables.

static const OptionData	_opts []
	Options of settingsgen.

Detailed Description

Tool to create computer-readable settings.

Definition in file settingsgen.cpp.

Function Documentation

◆ AppendFile()

static void AppendFile	(	std::optional< std::string_view >	fname,
		FILE *	out_fp
	)

static

Append a file to the output stream.

Parameters

fname	Filename of file to append.
out_fp	Output stream to write to.

Definition at line 304 of file settingsgen.cpp.

References lengthof, and FileHandle::Open().

Referenced by main().

◆ CompareFiles()

static bool CompareFiles	(	std::string_view	n1,
		std::string_view	n2
	)

static

Compare two files for identity.

Parameters

n1	First file.
n2	Second file.

Returns: True if both files are identical.

Definition at line 329 of file settingsgen.cpp.

References FileHandle::Open().

Referenced by main().

◆ DumpGroup()

static void DumpGroup	(	const IniLoadFile &	ifile,
		std::string_view	group_name
	)

static

Dump a IGT_SEQUENCE group into _stored_output.

Parameters

ifile	Loaded INI data.
group_name	Name of the group to copy.

Definition at line 187 of file settingsgen.cpp.

References _stored_output, OutputStore::Add(), IniLoadFile::GetGroup(), IGT_SEQUENCE, IniGroup::items, and IniGroup::type.

Referenced by ProcessIniFile().

◆ DumpLine()

static void DumpLine	(	const IniItem *	item,
		const IniGroup *	grp,
		const IniGroup *	default_grp,
		OutputStore &	output
	)

static

Parse a single entry via a template and output this.

Parameters

item	The template to use for the output.
grp	Group current being used for template rendering.
default_grp	Default values for items not set in @grp.
output	Output to use for result.

Definition at line 222 of file settingsgen.cpp.

References OutputStore::Add(), FindItemValue(), and IniItem::value.

Referenced by DumpSections().

◆ DumpSections()

static void DumpSections ( const IniLoadFile & ifile )

static

Output all non-special sections through the template / template variable expansion system.

Parameters

ifile Loaded INI data.

Definition at line 270 of file settingsgen.cpp.

References _post_amble_output, _stored_output, DEFAULTS_GROUP_NAME, DumpLine(), IniLoadFile::GetGroup(), IniGroup::GetItem(), IniLoadFile::groups, POSTAMBLE_GROUP_NAME, PREAMBLE_GROUP_NAME, TEMPLATES_GROUP_NAME, VALIDATION_GROUP_NAME, and IniItem::value.

Referenced by ProcessIniFile().

◆ FatalErrorI()

void FatalErrorI ( const std::string & msg )

Report a fatal error.

Error handling for fatal non-user errors.

Parameters

s	Format string.

Note: Function does not return.

Definition at line 28 of file settingsgen.cpp.

◆ FindItemValue()

static std::optional< std::string_view > FindItemValue	(	std::string_view	name,
		const IniGroup *	grp,
		const IniGroup *	defaults
	)

static

Find the value of a template variable.

Parameters

name	Name of the item to find.
grp	Group currently being expanded (searched first).
defaults	Fallback group to search, `nullptr` skips the search.

Returns: Text of the item if found, else std::nullopt.

Definition at line 207 of file settingsgen.cpp.

References IniGroup::GetItem(), and IniItem::value.

Referenced by DumpLine().

◆ main()

int CDECL main	(	int	argc,
		char *	argv[]
	)

And the main program (what else?)

Parameters

argc	Number of command-line arguments including the program name itself.
argv	Vector of the command-line arguments.

Definition at line 400 of file settingsgen.cpp.

References _opts, _post_amble_output, _stored_output, AppendFile(), GetOptData::arguments, OutputStore::Clear(), CompareFiles(), GetOptData::GetOpt(), FileHandle::Open(), GetOptData::opt, ProcessIniFile(), and OutputStore::Write().

◆ ProcessIniFile()

static void ProcessIniFile ( std::string_view fname )

static

Process a single INI file.

The file should have a [templates] group, where each item is one template. Variables in a template have the form '$[a-z0-9]+' (a literal '$' followed by one or more '', lowercase letters, or lowercase numbers).

After loading, the [pre-amble] group is copied verbatim if it exists.

For every group with a name that matches a template name the template is written. It starts with a optional #if line if an 'if' item exists in the group. The item value is used as condition. Similarly, #ifdef and #ifndef lines are also written. Below the macro processor directives, the value of the template is written at a line with its variables replaced by item values of the group being written. If the group has no item for the variable, the [defaults] group is tried as fall back. Finally, #endif lines are written to match the macro processor lines.

Last but not least, the [post-amble] group is copied verbatim.

Parameters

fname Ini file to process.

Returns: Exit status of the processing.

Definition at line 383 of file settingsgen.cpp.

References DumpGroup(), DumpSections(), IniLoadFile::LoadFromDisk(), NO_DIRECTORY, POSTAMBLE_GROUP_NAME, and PREAMBLE_GROUP_NAME.

Referenced by main().

Variable Documentation

◆ _opts

const OptionData _opts[]

static

Initial value:

= {
  { .type = ODF_NO_VALUE, .id = 'h', .shortname = 'h', .longname = "--help" },
  { .type = ODF_NO_VALUE, .id = 'h', .shortname = '?' },
  { .type = ODF_HAS_VALUE, .id = 'o', .shortname = 'o', .longname = "--output" },
  { .type = ODF_HAS_VALUE, .id = 'b', .shortname = 'b', .longname = "--before" },
  { .type = ODF_HAS_VALUE, .id = 'a', .shortname = 'a', .longname = "--after" },
}

Options of settingsgen.

Definition at line 355 of file settingsgen.cpp.

Referenced by main().

◆ _post_amble_output

OutputStore _post_amble_output

Similar to _stored_output, but for the post amble.

Definition at line 174 of file settingsgen.cpp.

Referenced by DumpSections(), and main().

◆ _stored_output

OutputStore _stored_output

Temporary storage of the output, until all processing is done.

Definition at line 173 of file settingsgen.cpp.

Referenced by DumpGroup(), DumpSections(), and main().

◆ DEFAULTS_GROUP_NAME

std::string_view DEFAULTS_GROUP_NAME = "defaults"

static

Name of the group containing default values for the template variables.

Definition at line 180 of file settingsgen.cpp.

Referenced by DumpSections().

◆ OUTPUT_BLOCK_SIZE

const size_t OUTPUT_BLOCK_SIZE = 16000

static

Block size of the buffer in OutputBuffer.

Definition at line 34 of file settingsgen.cpp.

Referenced by OutputBuffer::Add(), and OutputBuffer::HasRoom().

◆ POSTAMBLE_GROUP_NAME

std::string_view POSTAMBLE_GROUP_NAME = "post-amble"

static

Name of the group containing the post amble.

Definition at line 177 of file settingsgen.cpp.

Referenced by DumpSections(), and ProcessIniFile().

◆ PREAMBLE_GROUP_NAME

std::string_view PREAMBLE_GROUP_NAME = "pre-amble"

static

Name of the group containing the pre amble.

Definition at line 176 of file settingsgen.cpp.

Referenced by DumpSections(), and ProcessIniFile().

◆ TEMPLATES_GROUP_NAME

std::string_view TEMPLATES_GROUP_NAME = "templates"

static

Name of the group containing the templates.

Definition at line 178 of file settingsgen.cpp.

Referenced by DumpSections().

◆ VALIDATION_GROUP_NAME

std::string_view VALIDATION_GROUP_NAME = "validation"

static

Name of the group containing the validation statements.

Definition at line 179 of file settingsgen.cpp.

Referenced by DumpSections().

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ AppendFile()

◆ CompareFiles()

◆ DumpGroup()

◆ DumpLine()

◆ DumpSections()

◆ FatalErrorI()

◆ FindItemValue()

◆ main()

◆ ProcessIniFile()

Variable Documentation

◆ _opts

◆ _post_amble_output

◆ _stored_output

◆ DEFAULTS_GROUP_NAME

◆ OUTPUT_BLOCK_SIZE

◆ POSTAMBLE_GROUP_NAME

◆ PREAMBLE_GROUP_NAME

◆ TEMPLATES_GROUP_NAME

◆ VALIDATION_GROUP_NAME