heraia.h File Reference

heraia's header file. More...

Go to the source code of this file.

Data Structures

struct  Options
 Structure Options gives a way to store program options passed from the command line. More...

Defines

#define HERAIA_AUTHORS   "Olivier Delhomme, Sébastien TRICAUD, Grégory AUDET"
 defines heraia's main authors
#define HERAIA_DATE   "20 02 2005"
 defines heraia's creation date
#define HERAIA_LICENSE   N_("GPL v2 or later")
 defines heraia's license (at least GPL v2)
#define HERAIA_VERSION   "0.1.7 (02.05.2011)"
 defines heraia's current version and release date of this version (00.00.20XX means a development version)
#define NO_TESTS   0
 defines that no tests should be done (this is the default behaviour)
#define COVERAGE_TESTS   1
 In order to do some coverage tests.
#define LOADING_TESTS   2

Functions

heraia_struct_tget_main_struct (void)
 This is intended to be called by the library or any program that will use the library in order to get the pointer to the main structure heraia_struct_t.

Variables

static struct option const long_options []

Detailed Description

heraia's header file.

Definition in file heraia.h.


Define Documentation

#define COVERAGE_TESTS   1

In order to do some coverage tests.

Definition at line 57 of file heraia.h.

Referenced by main(), manage_command_line_options(), and usage().

#define HERAIA_AUTHORS   "Olivier Delhomme, Sébastien TRICAUD, Grégory AUDET"

defines heraia's main authors

Definition at line 44 of file heraia.h.

Referenced by version().

#define HERAIA_DATE   "20 02 2005"

defines heraia's creation date

Definition at line 45 of file heraia.h.

Referenced by version().

#define HERAIA_LICENSE   N_("GPL v2 or later")

defines heraia's license (at least GPL v2)

Definition at line 46 of file heraia.h.

Referenced by version().

#define HERAIA_VERSION   "0.1.7 (02.05.2011)"

defines heraia's current version and release date of this version (00.00.20XX means a development version)

Definition at line 47 of file heraia.h.

Referenced by version().

#define LOADING_TESTS   2

Definition at line 58 of file heraia.h.

Referenced by main(), and usage().

#define NO_TESTS   0

defines that no tests should be done (this is the default behaviour)

Definition at line 56 of file heraia.h.

Referenced by init_options_struct().


Function Documentation

heraia_struct_t* get_main_struct ( void   ) 

This is intended to be called by the library or any program that will use the library in order to get the pointer to the main structure heraia_struct_t.

Returns:
heraia_struct_t *, a pointer to the main structure

Definition at line 63 of file heraia.c.

Referenced by do_heraia_coverage_tests().

Here is the caller graph for this function:


Variable Documentation

struct option const long_options[] [static]
Initial value:
{
    {"version", no_argument, NULL, 'v'},     
    {"help", no_argument, NULL, 'h'},        
    {"tests", optional_argument, NULL, 't'}, 
    {NULL, 0, NULL, 0}
}

Definition at line 74 of file heraia.h.

Referenced by manage_command_line_options().

Generated on Mon May 2 21:06:24 2011 for Heraia by  doxygen 1.6.3