include/ctsupport.h

   1 /*****************************************************************************
   2 ** FILE IDENTIFICATION
   3 **
   4 **      File Name:      ctsupport.h
   5 **      Author:         Kevin Rosenberg
   6 **      Purpose:        Header file for CT support library
   7 **      Date Started:   Dec. 83
   8 **
   9 **  This is part of the CTSim program
  10 **  Copyright (c) 1983-2001 Kevin Rosenberg
  11 **
  12 **  $Id: ctsupport.h,v 1.24 2001/02/02 00:46:38 kevin Exp $
  13 **
  14 **
  15 **  This program is free software; you can redistribute it and/or modify
  16 **  it under the terms of the GNU General Public License (version 2) as
  17 **  published by the Free Software Foundation.
  18 **
  19 **  This program is distributed in the hope that it will be useful,
  20 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 **  GNU General Public License for more details.
  23 **
  24 **  You should have received a copy of the GNU General Public License
  25 **  along with this program; if not, write to the Free Software
  26 **  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  27 ******************************************************************************/
  28
  29 #ifndef CTSUPPORT_H
  30 #define CTSUPPORT_H
  31
  32 #ifdef HAVE_CONFIG_H
  33 #include "config.h"
  34 #endif
  35
  36 #ifdef MSVC
  37 #include "msvc_compat.h"
  38 #endif
  39
  40 #define STR_MAX_LEN 255
  41 #define STR_SIZE    STR_MAX_LEN+1
  42
  43 #include <cstdio>
  44 #include <cstdlib>
  45 #include <cstring>
  46 #include <cstdarg>
  47 #include <string>
  48 #include <vector>
  49 #include <algorithm>
  50
  51 #if defined(MSVC) || HAVE_SSTREAM
  52 #include <sstream>
  53 #else
  54 #include <sstream_subst>
  55 #endif
  56
  57 #define TRUE    1
  58 #define FALSE   0
  59 #define OK      TRUE
  60
  61 /*----------------------------------------------------------------------*/
  62
  63 #define SHOW(var, fmt)  { cerr << "var = " << var << endl; }
  64
  65 /*----------------------------------------------------------------------*/
  66
  67 #define NEWLINE '\n'
  68 #define TAB     '\t'
  69 #define EOS     '\0'
  70 #define BLANK   ' '
  71
  72 /*----------------------------------------------------------------------*/
  73
  74 #define ERR_TRACE -1
  75 #define ERR_WARNING     0
  76 #define ERR_SEVERE      1
  77 #define ERR_FATAL       2
  78
  79 /*----------------------------------------------------------------------*/
  80
  81
  82 /* codes for open command */
  83 #ifdef MSVC
  84 #define OPEN_RDONLY  O_RDONLY                   /* other system use standard codes */
  85 #define OPEN_WRONLY  O_WRONLY                   /* for binary */
  86 #define OPEN_RDWR    O_RDWR
  87 #else
  88 #define OPEN_RDONLY  0                  /* other system use standard codes */
  89 #define OPEN_WRONLY  1                  /* for binary */
  90 #define OPEN_RDWR    2
  91 #endif
  92
  93 /*----------------------------------------------------------------------*/
  94
  95 #if !defined(O_BINARY) && !defined(MSVC)
  96 #define O_BINARY (0)
  97 #endif
  98
  99 #ifndef S_IWRITE
 100 #define S_IWRITE S_IWUSR
 101 #endif
 102
 103 /*----------------------------------------------------------------------*/
 104
 105 #if defined(MSVC) || ! defined(SIZEOF_INT)
 106    #define SIZEOF_INT 4
 107    #define SIZEOF_LONG 4
 108    #define SIZEOF_SHORT 2
 109    #define SIZEOF_FLOAT 4
 110    #define SIZEOF_DOUBLE 8
 111 #endif
 112
 113 typedef signed char kint8;
 114 typedef unsigned char kuint8;
 115
 116 #if SIZEOF_INT == 4
 117     typedef int kint32;
 118     typedef unsigned int kuint32;
 119 #elif SIZEOF_LONG == 4
 120     typedef long int kint32;
 121     typedef unsigned int kuint32;
 122 #endif
 123
 124 #if SIZEOF_SHORT == 2
 125     typedef short int kint16;
 126     typedef unsigned short int kuint16;
 127 #elif SIZEOF_INT == 2
 128     typedef int kint16;
 129     typedef unsigned int kuint16;
 130 #endif
 131
 132 #if SIZEOF_FLOAT == 4
 133     typedef float kfloat32;
 134 #endif
 135 #if SIZEOF_DOUBLE == 8
 136     typedef double kfloat64;
 137 #endif
 138
 139
 140 inline const char*
 141 fileBasename (const char* const filename)
 142 {
 143   const char* p = strrchr (filename, '/');
 144   return (p ? p + 1 : filename);
 145 }
 146
 147
 148 /* strfuncs.cpp */
 149 char* str_skip_head(const char* str, const char* const charlist);
 150 char* str_skip_head(const char* str, char* charlist);
 151 char *str_lower(char *s);
 152 char *str_wrm_tail(char *str);
 153 char *str_rm_tail(char *str, const char* const charlist);
 154 char *str_upper(char *str);
 155
 156 /* syserror.cpp */
 157 void sys_error(int severity, const char *msg, ...);
 158 void sys_verror (std::string& strOutput, int severity, const char *msg, va_list arg);
 159 void sys_error_level(int severity);
 160
 161 // Math Section
 162
 163 #include <cmath>
 164
 165 #define PI      3.14159265358979323846
 166 #define HALFPI  1.57079632679489661923  /* PI divided by 2 */
 167 #define QUARTPI 0.78539816339744830962  /* PI divided by 4 */
 168 #define I_PI    0.31830988618379067154  /* Inverse of PI */
 169 #define I_PID2  0.63661977236758134308  /* Inverse of PID2 */
 170
 171 #define TWOPI   6.28318530717958647692
 172 #define SQRT2   1.414213562373095049
 173
 174 #define F_EPSILON       1.0E-6
 175 #define D_EPSILON       1.0E-10
 176
 177 #define ASSUMEDZERO  1E-10
 178
 179 typedef double GRFMTX_2D[3][3];
 180 typedef double GRFMTX_3D[4][4];
 181
 182 inline double
 183 convertDegreesToRadians (double x)
 184 { return (x * (PI/180.)); }
 185
 186 inline double
 187 convertRadiansToDegrees (double x)
 188 { return (x*(180./PI)); }
 189
 190 template<class T>
 191 inline T nearest (double x)
 192 { return (x > 0 ? static_cast<T>(x+0.5) : static_cast<T>(x-0.5)); }
 193
 194 template<class T>
 195 inline T maxValue (T x, T y)
 196 { return (x > y ? x : y); }
 197
 198 inline bool isEven (int n)
 199 { return (n % 2) == 0; }
 200
 201 inline bool isOdd (int n)
 202 { return (n % 2) != 0; }
 203
 204 #if 0
 205 inline bool isEven (long n)
 206 { return (n % 2) == 0; }
 207
 208 inline bool isOdd (long n)
 209 { return (n % 2) != 0; }
 210 #endif
 211
 212 inline int imax (int a, int b)
 213 { return (a >= b ? a : b); }
 214
 215 inline double dmax (double a, double b)
 216 { return (a >= b ? a : b); }
 217
 218 template<class T>
 219 inline T clamp (T value, T lowerBounds, T upperBounds)
 220 { return (value >= upperBounds ? upperBounds : (value <= lowerBounds ? lowerBounds : value )); }
 221
 222 template<class T>
 223 inline T lineLength (T x1, T y1, T x2, T y2)
 224 { return static_cast<T>( sqrt ((x2-x1)*(x2-x1) + (y2-y1)*(y2-y1)) ); }
 225
 226 template<class T>
 227 inline void minmax_array (const T* array, const int n, T& min, T& max)
 228 {
 229   max = min = array[0];
 230
 231   for (int i = 1; i < n; i++)
 232     if (array[i] < min)
 233       min = array[i];
 234     else if (array[i] > max)
 235       max = array[i];
 236 }
 237
 238
 239 //////////////////////////////////////////////////////////////
 240 // FUNTION DECLARATIONS
 241 //////////////////////////////////////////////////////////////
 242
 243 // clip.cpp
 244 bool clip_rect (double& x1, double& y1, double& x2, double& y2, const double rect[4]);
 245 bool clip_segment (double& x1, double& y1, double& x2, double& y2, const double u, const double v);
 246 bool clip_sector (double& x1, double& y1, double& x2, double& y2, const double u, const double v);
 247 bool clip_circle (double& x1, double& y1, double& x2, double& y2, const double cx, const double cy, const double radius, double t1, double t2);
 248 bool clip_triangle (double& x1, double& y1, double& x2, double& y2, const double u, const double v, const int clip_xaxis);
 249
 250
 251 // xform.cpp
 252 void indent_mtx2 (GRFMTX_2D m);
 253 void xlat_mtx2 (GRFMTX_2D m, const double x, const double y);
 254 void scale_mtx2 (GRFMTX_2D m, const double sx, const double sy);
 255 void rot_mtx2 (GRFMTX_2D m, const double theta);
 256 void mult_mtx2 (const GRFMTX_2D m1, const GRFMTX_2D m2, GRFMTX_2D result);
 257 void xform_mtx2 (const GRFMTX_2D m, double& x, double& y);
 258 void rotate2d (double x[], double y[], int pts, double angle);
 259 void xlat2d (double x[], double y[], int pts, double xoffset, double yoffset);
 260 void scale2d (double x[], double y[], int pts, double xfact, double yfact);
 261
 262 // mathfuncs.cpp
 263 double normalizeAngle (double theta);
 264 double integrateSimpson (const double xmin, const double xmax, const double *y, const int np);
 265 void vectorNumericStatistics (std::vector<double> vec, const int nPoints, double& min, double& max, double& mean, double& mode, double& median, double& stddev);
 266
 267
 268 /*----------------------------------------------------------------------*/
 269
 270 /* screen character codes */
 271
 272 #define SC_BKSP           8
 273 #define SC_TAB            9
 274 #define SC_BLANK        ' '
 275
 276
 277 /* audio.cpp */
 278 void cio_beep(void);
 279 void cio_tone(double freq, double length);
 280
 281 /* crtput.cpp */
 282 void cio_put_c(int c);
 283 void cio_put_cc(int c, int count);
 284 void cio_put_str(const char *str);
 285
 286 /* kbget.cpp */
 287 unsigned int cio_kb_getc(void);
 288 void cio_kb_ungetc(unsigned int c);
 289 char *cio_kb_gets(char *str, int maxlen);
 290 unsigned int cio_kb_waitc(const char *astr, int beep);
 291
 292 // Keyboard Section
 293
 294 #define KEY_BKSP         8
 295 #define KEY_TAB          9
 296 #define KEY_RETURN      13
 297 #define KEY_ESCAPE      27
 298
 299 // ASCII Section
 300
 301 #define BACKSPACE  8
 302 #define LF      0x0A
 303 #define CR      0x0D
 304 #define BELL    0x07
 305
 306 #define SQUOTE    '\''
 307 #define DQUOTE    '\"'
 308 #define BSLASH    '\\'
 309 #define BACKSLASH '\\'
 310 #define SHARP     '#'
 311 #define SLASH     '/'
 312 #define ASTERICK  '*'
 313 #define COLON     ':'
 314 #define LBRACE    '{'
 315 #define RBRACE    '}'
 316 #define LPAREN    '('
 317 #define RPAREN    ')'
 318 #define LBRACK    '['
 319 #define RBRACK    ']'
 320 #define LANBRACK  '<'
 321 #define RANBRACK  '>'
 322 #define SEMICOL   ';'
 323 #define UNDERLIN  '_'
 324 #define COMMA     ','
 325 #define CARET     '^'
 326 #define TILDE     '~'
 327 #define ATSIGN    '@'
 328 #define AMPERSAND  '&'
 329 #define EXCLAM    '!'
 330 #define DOLLAR    '$'
 331 #define PERCENT   '%'
 332 #define PLUS      '+'
 333 #define HYPHEN    '-'
 334 #define EQUALS    '='
 335 #define QUESTION  '?'
 336 #define PERIOD    '.'
 337 #define VERTBAR   '|'
 338
 339 #endif  /* #ifndef CTSUPPORT_H */