main modules index files download libit@sf.net

include/it/parser.h

Go to the documentation of this file.

/*
   libit - Library for basic source and channel coding functions
   Copyright (C) 2005-2008 Vivien Chappelier, Herve Jegou

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

/*
  Parser for Parameter files and command line arguments
  Copyright (C) 2005 Herve Jegou
*/

#ifndef __it_parser_h
#define __it_parser_h

#include <it/vec.h>
#include <it/mat.h>
#include <it/cplx.h>


typedef char *parser_t;

/*---------------------------------------------------------------------------*/
/*! \defgroup parser Parser                                                  */
/* @{                                                                        */
/*---------------------------------------------------------------------------*/

/* Creation and initialisation of a parser. This initialization requires 
   3 arguments, from the one which has the higher priority to the one 
   of the lower priority :
   1) The first is the command line. The variable set there 
   have the higher priority. 
   2) The second is the name of the file from which some variables 
   must be read. 
   3) The third is a const char * which allows to have default values 
   for arguments

   Any of these arguments may be NULL (or 0 for argc). 
*/
parser_t *parser_init (int argc, char **argv,
           const char *filename, char *cmdline);


/* The following functions add another source of data 
   to an existing parser                                                */
parser_t *_parser_add_file (parser_t * p, const char *filename);
parser_t *_parser_add_params (parser_t * p, int argc, char **argv);
parser_t *_parser_add_string (parser_t * p, char *s);

#define parser_add_file( p, filename )     do { p = _parser_add_file( p, filename );}   while(0)
#define parser_add_params( p, argc, argv ) do { p = _parser_add_params( p, argc, argv );} while(0)
#define parser_add_string( p, s )          do { p = _parser_add_string( p, s );} while(0)

/* Free the memory allocated for a parser                               */
void parser_delete (parser_t * p);

/* Print the content of the parser                                      */
void parser_print (parser_t * p);

/*----------------------------------------------------------------------*/

/* Retrieve the variable whose name is given by varname                 */
int  parser_get_int (const parser_t * p, const char *varname);
double parser_get_double (const parser_t * p, const char *varname);
byte parser_get_byte (const parser_t * p, const char *varname);
char *parser_get_string (const parser_t * p, const char *varname);
cplx parser_get_cplx (const parser_t * p, const char *varname);

/* Retrieve the vectors whose name is given by varname                  */
vec  parser_get_vec (const parser_t * p, const char *varname);
ivec parser_get_ivec (const parser_t * p, const char *varname);
bvec parser_get_bvec (const parser_t * p, const char *varname);
cvec parser_get_cvec (const parser_t * p, const char *varname);

/* Retrieve the matrices whose name is given by varname                 */
mat  parser_get_mat (const parser_t * p, const char *varname);
imat parser_get_imat (const parser_t * p, const char *varname);
bmat parser_get_bmat (const parser_t * p, const char *varname);
cmat parser_get_cmat (const parser_t * p, const char *varname);

/* Return 1 if the string has been found as a valid identifier, 0 otherwise */
int  parser_exists (const parser_t * p, const char *varname);

/*----------------------------------------------------------------------*/
/* Same function, but specify the echo of variable (verbose mode)       */

/* Retrieve the variable whose name is given by varname                 */
int  parser_get_int_verbose (const parser_t * p, const char *varname,
           int verbose);
double parser_get_double_verbose (const parser_t * p, const char *varname,
          int verbose);
byte parser_get_byte_verbose (const parser_t * p, const char *varname,
            int verbose);
char *parser_get_string_verbose (const parser_t * p, const char *varname,
         int verbose);
cplx parser_get_cplx_verbose (const parser_t * p, const char *varname,
            int verbose);

/* Retrieve the vectors whose name is given by varname                  */
vec  parser_get_vec_verbose (const parser_t * p, const char *varname,
           int verbose);
ivec parser_get_ivec_verbose (const parser_t * p, const char *varname,
            int verbose);
bvec parser_get_bvec_verbose (const parser_t * p, const char *varname,
            int verbose);
cvec parser_get_cvec_verbose (const parser_t * p, const char *varname,
            int verbose);

/* Retrieve the matrices whose name is given by varname                 */
mat  parser_get_mat_verbose (const parser_t * p, const char *varname,
           int verbose);
imat parser_get_imat_verbose (const parser_t * p, const char *varname,
            int verbose);
bmat parser_get_bmat_verbose (const parser_t * p, const char *varname,
            int verbose);
cmat parser_get_cmat_verbose (const parser_t * p, const char *varname,
            int verbose);

/* Return 1 if the string has been found as a valid identifier, 0 otherwise */
int  parser_exists (const parser_t * p, const char *varname);

/* @} */

#endif

---

Hosted by

Copyright (C) 2005-2006 Hervé Jégou Vivien Chappelier Francois Cayre libit logo courtesy of Jonathan Delhumeau