filename.h File Reference

Detailed Description

Functions to deal with file names.

The main files used in the CuikSuite have the following extensions:

• .cuik Files including variables and equations. The solution set of a cuik file can be obtained using cuik. This will produce a .sol file.
• .param File with the parameters. The default set of parameters is in share/default.param
• .sol Solution file resulting from cuik.

See also

filename.c Tfilename

Definition in file filename.h.

Data Structures
struct	Tfilename
	Data structure to hold the information about the name of a file. More...

Macros
#define	LOOPS_EXT   "loops"
	File extension for loops files. More...
#define	CUIK_EXT   "cuik"
	File extension for equation files. More...
#define	PARAM_EXT   "param"
	File extension for parameter files. More...
#define	SOL_EXT   "sol"
	File extension for solution files. More...
#define	PLOT2D_EXT   "fig"
	File extension for 2D plot files. More...
#define	MAF_EXT   "maf"
	File extension for multi-affine equations. More...

Functions
void	CreateFileName (char *path, char *name, char *suffix, char *ext, Tfilename *fn)
	Constructor. More...
char *	GetFileFullName (Tfilename *fn)
	Gets the file full name (paht+name+extension). More...
char *	GetFilePath (Tfilename *fn)
	Gets the file path. More...
char *	GetFileBaseName (Tfilename *fn)
	Gets the file base name (paht+name) . More...
char *	GetFileName (Tfilename *fn)
	Gets the file name. More...
char *	GetFileExtension (Tfilename *fn)
	Gets the file extension. More...
void	LinkFileNameWithExtension (char *fn1, char *ext, Tfilename *fn2)
	Creates a link to a given filename. More...
void	DeleteFileName (Tfilename *fn)
	Destructor. More...

Macro Definition Documentation

LOOPS_EXT

#define LOOPS_EXT   "loops"

File extension for loops files.

Definition at line 31 of file filename.h.

CUIK_EXT

#define CUIK_EXT   "cuik"

File extension for equation files.

Definition at line 37 of file filename.h.

PARAM_EXT

#define PARAM_EXT   "param"

File extension for parameter files.

Definition at line 43 of file filename.h.

SOL_EXT

#define SOL_EXT   "sol"

File extension for solution files.

Definition at line 49 of file filename.h.

PLOT2D_EXT

#define PLOT2D_EXT   "fig"

File extension for 2D plot files.

Definition at line 55 of file filename.h.

MAF_EXT

#define MAF_EXT   "maf"

File extension files summaring problems involving multi-affine equations. Such files include the number of equations and variables, the variables in each equation, and the evaluation of the equations on a unit box.

Definition at line 64 of file filename.h.

Function Documentation

CreateFileName()

void CreateFileName	(	char *	path,
		char *	name,
		char *	suffix,
		char *	ext,
		Tfilename *	fn
	)

Generates a Tfilename structure.

Parameters

path	The path. If not given we get it from the system and is the path from of the directory from where the application is exeucted.
name	The name of the file. If the given name includes part of a path, it is removed from the name and added to the path data field.
suffix	A suffix to add to the name. Possibly NULL.
ext	The extension for the file.
fn	The filename structure to create.

Definition at line 22 of file filename.c.

References Tfilename::baseName, Error(), Tfilename::ext, FALSE, Tfilename::fullName, Tfilename::name, NEW, and Tfilename::path.

Referenced by InitParametersFromFile(), LinkFileNameWithExtension(), main(), ReadProblemFromFile(), and SaveCuikSystemToMAF().

GetFileFullName()

char* GetFileFullName

(

Tfilename *

fn

)

Gets the file full name (path+name+extension).

Parameters

fn	The filename structure.

Returns

Returns the full name for the file.

Definition at line 151 of file filename.c.

References Tfilename::fullName.

Referenced by InitParametersFromFile(), LinkFileNameWithExtension(), main(), ReadProblemFromFile(), and SaveCuikSystemToMAF().

GetFilePath()

char* GetFilePath

(

Tfilename *

fn

)

Gets the file path.

Parameters

fn	The filename structure.

Returns

Returns the path for the file.

Definition at line 156 of file filename.c.

References Tfilename::path.

Referenced by LinkFileNameWithExtension().

GetFileBaseName()

char* GetFileBaseName

(

Tfilename *

fn

)

Gets the file base name (paht+name).

Parameters

fn	The filename structure.

Returns

Returns the base name (path+name) for the file.

Definition at line 166 of file filename.c.

References Tfilename::baseName.

GetFileName()

char* GetFileName

(

Tfilename *

fn

)

Gets the file name.

Parameters

fn	The filename structure.

Returns

Returns the name for the file.

Definition at line 161 of file filename.c.

References Tfilename::name.

Referenced by LinkFileNameWithExtension().

GetFileExtension()

char* GetFileExtension

(

Tfilename *

fn

)

Gets the file extension.

Parameters

fn	The filename structure.

Returns

Returns the extension for the file.

Definition at line 171 of file filename.c.

References Tfilename::ext.

Referenced by ReadProblemFromFile().

LinkFileNameWithExtension()

void LinkFileNameWithExtension	(	char *	fn1,
		char *	ext,
		Tfilename *	fn2
	)

Creates a link to a given filename with a given extension.

Parameters

fn1	File to link.
ext	Extension of the files.
fn2	File name of the link.

Definition at line 177 of file filename.c.

References CreateFileName(), DeleteFileName(), GetFileFullName(), GetFileName(), and GetFilePath().

DeleteFileName()

void DeleteFileName

(

Tfilename *

fn

)

Deleltes the Tfilename structure.

Parameters

fn	The filename structure to delete.

Definition at line 205 of file filename.c.

References Tfilename::baseName, Tfilename::ext, Tfilename::fullName, Tfilename::name, and Tfilename::path.

Referenced by InitParametersFromFile(), LinkFileNameWithExtension(), main(), ReadProblemFromFile(), and SaveCuikSystemToMAF().