eg_io.h

Go to the documentation of this file.

/* EGlib "Efficient General Library" provides some basic structures and
 * algorithms commons in many optimization algorithms.
 *
 * Copyright (C) 2005 Daniel Espinoza and Marcos Goycoolea.
 * 
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 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 Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA 
 * */

/* ========================================================================= */
/* input/output utilities
 *
 * Version 0.0.2 2003-05-09 (Marcos)
 *
 * Added the function EGioNParse to get a more argc, argv feel.
 * Also: Changed EGioParse so that it ignores multiple sequential delimiters.
 * 
 * Version 0.0.1 2003-04-11
 * - 2004-08-17
 *          - Add EGdisplayString function.
 * - 2006-08-16
 *          - Add EGioReadLine function.
 * */
/* ========================================================================= */

#ifndef __EG_IO_H__
#define __EG_IO_H__
#include <string.h>
#include <strings.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <errno.h>
#include "eg_macros.h"

/* ========================================================================= */
/** @brief safe open function, it test that we can open the given file with the
 * given mode, if an error occurs, display it on screen and exit, otherwise,
 * return the open file stream.
 * @param __file file name to open (is a const char*)
 * @param __mode mode to use to open the file (is a const char*)
 * @return FILE* stream */
#define EGsfopen(__file,__mode) ({\
  const char*__EGsfile = (__file);\
  const char*__EGsmode = (__mode);\
  FILE*__EGsFILE = fopen(__EGsfile,__EGsmode);\
  if(!__EGsFILE)\
  {\
    const int __EGserrno = errno;\
    fprintf(stderr,"fopen() failed with error code %d, error\n%s",__EGserrno,strerror(__EGserrno));\
    MESSAGE(0,"Could not open %s with mode %s", __EGsfile, __EGsmode);\
    exit(__EGserrno);\
  }\
  __EGsFILE;})

/* ========================================================================= */
/**@brief type of functions for display, receives a void* to the structure to print,
 * and a *FILE where to output */
typedef void (*EGdisplay_f) (void *,
                             FILE *);
#define EGnullDisplay ((EGdisplay_f)0)

/* ========================================================================= */
/** @brief type of functions for display, receives a void* to the structure to print, a
 * *FILE where to output, and a set of offsets for datas, the length of that
 * array must be know by the user. */
typedef void (*EGdisplayOS_f) (void *,
                               FILE *,
                               size_t *);

/* ========================================================================= */
/** @brief create names with indices */
void EGmvar (char *str,
             int nind,
             const char *header,
             ...);

/* ========================================================================= */
/** @brief Given a string 'input' this function uses EGioParse to separate
 * up to N words in it, we assume that argc is an array of pointers to strings
 * of size N, and note that the input array will be changed. */
void EGioNParse (char *input,
                 int max_argc,
                 const char *delim,
                 const char *comment,
                 int *argc,
                 char **argv);

/* ========================================================================= */
/** @brief given two *pointers 'next' and 'current' and a constant set 
 * of strings (parse delimiters), it store in 'next the next 
 * meaningfull string, and in current the rest of the secuence, 
 * the idea is to iterate over 'next' while it is not true; 
 * you have to store the original pointer to the string stream 
 * elsewere; also, we assume that the original stream is 
 * terminated with '\0'; also, it will discaard any sub-string 
 * that start with #, that is inteded for discard comments */
void EGioParse (char **next,
                char **current,
                const char *delim,
                const char *coment);

/* ========================================================================= */
/** @brief this discard all lines starting with comments and stores the next 
 * leading line in current and the next token in next, we assume that next 
 * does not contain data, and that current store the remainings of the
 * current line */
void EGioDisCom (char **next,
                 char **current,
                 const char *delim,
                 const char *coment,
                 char *store,
                 unsigned int storeSize,
                 FILE * in);

/* ========================================================================= */
/** @brief display function for strings
 * @param str pointer to a null terminated string of chars.
 * @param file pointer to a stream where we write the string.
 * @par Description:
 * This function just print the string on the file, it won't add a '\n' at the
 * end. */
void EGdisplayString (void *str,
                      FILE * file);

/* ========================================================================= */
/** @brief read a line from an input stream.
 * @param str where to store the line.
 * @param max_len maximum allowed length.
 * @param file stream from where we read the input
 * @return zero on success, non-zero otherwise, errors are cast when we can not
 * read from the given file.
 * */
int EGioReadLine(char*const str,size_t const max_len, FILE*file);

#endif

---