OPTIONS RUTINES - get program parameters, reading from options/ini file. More...

#include <strings.h>
#include <string.h>
#include <unistd.h>
#include <limits.h>
#include "system/system.hh"
#include "system/xio.h"
#include "io/read_ini.h"
#include <boost/tokenizer.hpp>
#include "boost/lexical_cast.hpp"
#include <boost/algorithm/string.hpp>

Macros
#define	FOR_INI_ITEMS(i) for((i)=read_ini->ini_item;(i)!=NULL;(i)=(i)->next)

Functions
static void	make_ini_item_list (const char *fname)

static char *	section_test (char *section)

static char *	strip_spaces (char *string)

static struct Ini_item *	new_item (struct Ini_item prev, char section, char key, char value)

char *	OptGetStr (const char section, const char key, const char *defval)
	Create new string from selected variable from ini file. More...

char *	OptGetFileName (const char section, const char key, const char *defval)

long int	OptGetInt (const char section, const char key, const char *defval)

double	OptGetDbl (const char section, const char key, const char *defval)

bool	OptGetBool (const char section, const char key, const char *defval)

void	OptionsInit (const char *fname)
	Load options file. More...

void	OptGetDblArray (const char section, const char key, const char *defval, std::vector< double > &array)

void	OptGetIntArray (const char section, const char key, const char defval, int ArrSize, int Array)

Variables
static struct Read_ini *	read_ini = NULL

Detailed Description

OPTIONS RUTINES - get program parameters, reading from options/ini file.

Please make a following refer to Flow123d on your project site if you use the program for any purpose, especially for academic research: Flow123d, Research Centre: Advanced Remedial Technologies, Technical University of Liberec, Czech Republic

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 021110-1307, USA.

$Id$ $Revision$ $LastChangedBy$ $LastChangedDate$

DESCRIPTION

Functions OptGet* are implemented through OptGetStr - only one interface routine for various implementation the parameter default is always char *, which can be NULL in the case that explicit value is necessary and program should produce an error if corresponding parameter is not given.

Current implementation is based on SimpleINI C++ library.

Definition in file read_ini.cc.

Macro Definition Documentation

#define FOR_INI_ITEMS ( i ) for((i)=read_ini->ini_item;(i)!=NULL;(i)=(i)->next)

Definition at line 55 of file read_ini.cc.

Function Documentation

void make_ini_item_list ( const char * fname )

static

Definition at line 67 of file read_ini.cc.

Here is the caller graph for this function:

struct Ini_item * new_item	(	struct Ini_item *	prev,
		char *	section,
		char *	key,
		char *	value
	)

static

Definition at line 159 of file read_ini.cc.

Here is the caller graph for this function:

bool OptGetBool	(	const char *	section,
		const char *	key,
		const char *	defval
	)

Definition at line 279 of file read_ini.cc.

Here is the caller graph for this function:

double OptGetDbl	(	const char *	section,
		const char *	key,
		const char *	defval
	)

Definition at line 260 of file read_ini.cc.

Here is the caller graph for this function:

void OptGetDblArray	(	const char *	section,
		const char *	key,
		const char *	defval,
		std::vector< double > &	array
	)

Read value of particular key as list of doubles and store them into array. defval string is used if the key is not found.

Definition at line 332 of file read_ini.cc.

char* OptGetFileName	(	const char *	section,
		const char *	key,
		const char *	defval
	)

Definition at line 232 of file read_ini.cc.

long int OptGetInt	(	const char *	section,
		const char *	key,
		const char *	defval
	)

Definition at line 242 of file read_ini.cc.

Here is the caller graph for this function:

void OptGetIntArray	(	const char *	section,
		const char *	key,
		const char *	defval,
		int	ArrSize,
		int *	Array
	)

Definition at line 359 of file read_ini.cc.

char* OptGetStr	(	const char *	section,
		const char *	key,
		const char *	defval
	)

Create new string from selected variable from ini file.

Parameters

[in]	section	Inifile section
[in]	key	Inifile key
[in]	defval	Default value, if key is not found in inifile

Returns: Ptr to new string with option value from Inifile or to default value

Definition at line 205 of file read_ini.cc.

Here is the caller graph for this function:

void OptionsInit ( const char * fname )

Load options file.

Parameters

[in] fname File name

Definition at line 301 of file read_ini.cc.

char * section_test ( char * section )

static

Definition at line 188 of file read_ini.cc.

Here is the caller graph for this function:

char * strip_spaces ( char * string )

static

Definition at line 144 of file read_ini.cc.

Here is the caller graph for this function:

Variable Documentation

struct Read_ini* read_ini = NULL

static

Definition at line 53 of file read_ini.cc.

Macros

Functions

Variables

Detailed Description

DESCRIPTION

Macro Definition Documentation

Function Documentation

Variable Documentation