src/helper.h

Go to the documentation of this file.

/* **************************************************************************
 *   Copyright (C) 2008 by Matthias Ihrke   *
 *   mihrke@uni-goettingen.de   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   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  02111-1307, USA.             *
 ***************************************************************************/

#ifndef HELPER_H
# define HELPER_H

#include "definitions.h"
#include "escape_codes.h"
#include <stdio.h>


#ifdef HAVE_MATLAB
#ifndef MATLAB_STARTUP_CMD
#define MATLAB_STARTUP_CMD "/usr/local/matlab7/bin/matlab -nosplash"   
/* #define MATLAB_STARTUP_CMD "/usr/nld/matlab-17/bin/matlab -nosplash" */
#endif
#define ML(code) code /* this macro deletes all ML() statements if
                                 HAVE_MATLAB is not defined */
#include "engine.h"
#else
#define ML(code)
#endif

#define ERR_GSL  -1
#define ERR_IO   -2
#define ERR_PLOT -3
#define ERR_MEM  -4
#define ERR_MATLAB -5
#define ERR_ENDIAN -6
#define ERR_PARSEMAT -7
#define ERR_FATAL 1
#define ERR_NOFATAL 0

#define NOSTRING " \b" 

#define PROGRESSBAR_NUMCOLS        80 
#define PROGRESSBAR_INIT           0  
#define PROGRESSBAR_CONTINUE_SHORT 1  
#define PROGRESSBAR_CONTINUE_LONG  2  
#define PROGRESSBAR_FINISH         3  
#define SWAPT( Type, a, b ) { Type tmp; tmp=(a); (a)=(b); (b)=(tmp); }


/*-----------------------------------------------------------
  - Progress Bar
  ---------------------------------------------------------*/

typedef struct{
  ulonglong max_progress;
  ulonglong cur_progress;
  ulonglong prev_progress;
} ProgressBarStatus;

typedef void    (*ProgressBarFunction)          (int,ulonglong);

#define MALLOC( ptr, nmemb, type )                      \
  ptr = (type*)malloc(nmemb*sizeof(type));          \
  if( ptr==NULL ){                                          \
     errprintf("Could not allocate memory\n");      \
  }
  
#ifdef DEBUG
/*#define dprintf(...) fprintf(stderr, ## __VA_ARGS__)*/

#define dprintf(...) do{                                                                \
        fprintf(stderr, ESCAPE_FGYELLOW_STR ESCAPE_BRIGHT_STR "%s (%i), %s(): ", \
                  __FILE__, __LINE__, __FUNCTION__);                                \
        fprintf(stderr, ## __VA_ARGS__);                                                \
        fprintf(stderr, NOSTRING ESCAPE_RESET_STR);                                         \
     } while(0)

#define massert(x, text, ...) \
  do{                                                                                           \
     if(x){                                                                                 \
        fprintf(stderr, ESCAPE_FGRED_STR "Assertion failed: " #text, ## __VA_ARGS__); \
        fprintf(stderr, NOSTRING ESCAPE_RESET_STR);                                         \
     }                                                                                          \
  } while(0)
#else
#define dprintf(...)
#define massert(...)        
#endif

#define errprintf(...) do{ fprintf(stderr, ESCAPE_FGRED_STR ESCAPE_BOLD_STR\
                                              ESCAPE_BGYELLOW_STR "ERROR: %s (%i), %s(): ", \
                                              __FILE__, __LINE__, __FUNCTION__);    \
     fprintf(stderr, ## __VA_ARGS__);                                               \
     fprintf(stderr, NOSTRING ESCAPE_RESET_STR); } while(0)

#define warnprintf(...) do{ fprintf(stderr, ESCAPE_FGWHITE_STR ESCAPE_BOLD_STR \
                                                ESCAPE_BGBLUE_STR "WARNING: %s (%i), %s(): ", \
                                                __FILE__, __LINE__, __FUNCTION__);  \
     fprintf(stderr, ## __VA_ARGS__);                                               \
     fprintf(stderr, NOSTRING ESCAPE_RESET_STR); } while(0)

#define oprintf(...) do{ fprintf(stderr, ESCAPE_FGCYAN_STR ESCAPE_BRIGHT_STR \
                                            "%s (%i), %s() --> ",                       \
                                            __FILE__, __LINE__, __FUNCTION__);      \
     fprintf(stderr, ## __VA_ARGS__);                                               \
     fprintf(stderr, NOSTRING ESCAPE_RESET_STR); } while(0)

#ifdef __cplusplus
extern "C" {
#endif

  /* ---------------------------------------------------------------------------- 
      -- Helper functions (org)                                                       -- 
      ---------------------------------------------------------------------------- */
  void     errormsg(int err_no, int fatal);

  void     swap_bytes(void *ptr, int nmemb);
  void     wswap(void *ptr, int nmemb, int flag);
  int      is_little_endian();

  bool  isin_intarray( const int *a, int n, int val );

  void     qsort_int_index( int *idx_idx, const int *idx, int n );
  int      compare_ints (const void *a, const void *b);

  int      randint( int from, int to );  

  int      strcount( const char *s, char c );

  int      safer_free( void *p );

  char*    create_string( const char *string );

  double** copy_double_ptrptr(const double **s, int N, int n);
  void     string_strip_blanks( char *s );

  /* ---------------------------------------------------------------------------- 
      -- Helper functions (IO)                                                  -- 
      ---------------------------------------------------------------------------- */
  int     vprint_vector(const char* name, double *v, int n); 

  size_t  ffread(void *ptr, size_t size, size_t nmemb, FILE *stream);
  size_t  ffwrite(const void *ptr, size_t size, size_t nmemb, FILE *stream);

  int     stream_count_char( FILE* f, char c );




  /* ---------------------------------------------------------------------------- 
      -- Gobals                                                                 -- 
      ---------------------------------------------------------------------------- */

  extern ProgressBarStatus progress_status;
  void   progressbar_rotating( int flag, ulonglong num );

#ifdef __cplusplus
}
#endif

#endif