tjtools.h

/***************************************************************************
                          tjtools.h  -  description
                             -------------------
    begin                : Thu Jul 13 2000
    copyright            : (C) 2000-2021 by Thies Jochimsen
    email                : thies@jochimsen.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 is a collection of frequently used C-routines
 
 
#ifndef TJTOOLS_H
#define TJTOOLS_H
 
#include <tjutils/tjutils.h>
 
#ifndef PII
#define PII 3.14159265358979323846264338327950288
#endif
 
#ifndef ODIN_MAXCHAR
#define ODIN_MAXCHAR 4096
#endif
 
#ifdef HAVE_LONG_LONG
#define LONGEST_INT long long
#else
#define LONGEST_INT long
#endif
 
 
// functions of large file extension, define them here so
// these macros can re-used in other modules
#ifdef HAVE_STAT64
#define ODIN_STAT stat64
#else
#ifdef HAVE_STAT 
#define ODIN_STAT stat
#endif
#endif
 
#ifdef HAVE_OPEN64
#define ODIN_OPEN open64
#else
#define ODIN_OPEN open
#endif
 
#ifdef HAVE_FOPEN64
#define ODIN_FOPEN fopen64
#else
#define ODIN_FOPEN fopen
#endif
 
#ifdef HAVE_FSEEKO64
#define ODIN_FSEEK fseeko64
#else
#ifdef HAVE_FSEEKO
#define ODIN_FSEEK fseeko
#else
#define ODIN_FSEEK fseek
#endif
#endif
 
#ifdef HAVE_FTELLO64
#define ODIN_FTELL ftello64
#else
#ifdef HAVE_FTELLO
#define ODIN_FTELL ftello
#else
#define ODIN_FTELL ftell
#endif
#endif
 
#ifdef HAVE_MMAP64
#define ODIN_MMAP mmap64
#else
#define ODIN_MMAP mmap
#endif
 
 
// macro to avoid compiler warnings about unused static string arrays
#define AVOID_CC_WARNING(strArray) inline const char* strArray##_dummyfunc() {return strArray[0];}
 
enum fopenMode {readMode,overwriteMode,appendMode};
 
 
double norm(double x, double y);
 
 
double norm3(double x,double y,double z);
 
 
 
double maxof3(double f1, double f2, double f3);
 
 
#ifndef NO_FILEHANDLING
 
 
const char* modestring(fopenMode mode);
 
 
LONGEST_INT filesize(const char *filename);
 
 
const char* getpwd();
 
 
int chpwd(const char *dirname);
 
 
int createdir(const char *dirname);
 
 
bool checkdir(const char *dirname);
 
 
int movefile(const char *src, const char* dst);
 
 
int copyfile(const char *src, const char* dst);
 
 
int rmfile(const char *fname);
 
 
int chperm(const char *fname, int perm);
 
 
 
void* filemap(const STD_string& filename, LONGEST_INT nbytes, LONGEST_INT offset, bool readonly, int& fd);
 
 
void fileunmap(int fd, void* start, LONGEST_INT nbytes, LONGEST_INT offset);
 
 
STD_string tempfile();
 
 
int create_empty_file(const STD_string& filename, LONGEST_INT nbytes, fopenMode mode=overwriteMode);
 
 
#endif
 
 
const char* lasterr();
 
 
void sleep_ms(unsigned int ms);
 
 
double current_time_s();
 
 
double secureDivision(double numerator, double denominator);
 
inline double secureInv(double denominator) {return secureDivision(1.0, denominator); }
 
 
 
const char* getenv_nonnull(const char* variable_name);
 
 
bool little_endian_byte_order();
 
unsigned int numof_cores();
 
double sinc(double x);
 
 
#ifndef NO_CMDLINE
 
int getCommandlineOption(int argc, char *argv[], const char *option, char *returnvalue, int maxchar,bool modify=true);
 
 
int isCommandlineOption(int argc, char *argv[], const char *option,bool modify=true);
 
 
int getLastArgument(int argc, char *argv[], char *returnvalue, int maxchar,bool modify=true);
 
 
int hasHelpOption(int argc, char *argv[]);
 
const char* helpUsage();
 
const char* configInfo();
 
 
#endif
 
 
#endif