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-2000 Kevin Rosenberg
  11 **
  12 **  $Id: ctsupport.h,v 1.10 2000/12/06 16:41:17 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 #define snprintf _snprintf
  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
  48 #define TRUE    1
  49 #define FALSE   0
  50 #define OK      TRUE
  51 #define ERROR   FALSE
  52 #define YES     TRUE
  53 #define NO      FALSE
  54
  55 /*----------------------------------------------------------------------*/
  56
  57 #define SHOW(var, fmt)  { cerr << "var = " << var << endl; }
  58
  59 /*----------------------------------------------------------------------*/
  60
  61 #define NEWLINE '\n'
  62 #define TAB     '\t'
  63 #define EOS     '\0'
  64 #define BLANK   ' '
  65
  66 /*----------------------------------------------------------------------*/
  67
  68 struct time_st {
  69         int hour, minute, second, ms;
  70 };
  71
  72 struct date_st {
  73         int year, month, date, dow;
  74 };
  75
  76 struct timedate_st {
  77     struct time_st t;
  78     struct date_st d;
  79 };
  80
  81 typedef struct time_st TIME;
  82 typedef struct date_st DATE;
  83 typedef struct timedate_st TIMEDATE;
  84
  85 /*----------------------------------------------------------------------*/
  86
  87 #define ERR_WARNING     0
  88 #define ERR_SEVERE      1
  89 #define ERR_FATAL       2
  90
  91 /*----------------------------------------------------------------------*/
  92
  93
  94 /* codes for open command */
  95 #ifdef MSVC
  96 #define OPEN_RDONLY  O_RDONLY                   /* other system use standard codes */
  97 #define OPEN_WRONLY  O_WRONLY                   /* for binary */
  98 #define OPEN_RDWR    O_RDWR
  99 #else
 100 #define OPEN_RDONLY  0                  /* other system use standard codes */
 101 #define OPEN_WRONLY  1                  /* for binary */
 102 #define OPEN_RDWR    2
 103 #endif
 104
 105 /*----------------------------------------------------------------------*/
 106
 107 #ifndef O_BINARY
 108 #define O_BINARY (0)
 109 #endif
 110
 111 #ifndef S_IWRITE
 112 #define S_IWRITE S_IWUSR
 113 #endif
 114
 115 /*----------------------------------------------------------------------*/
 116
 117 #if defined(MSVC) || ! defined(SIZEOF_INT)
 118    #define SIZEOF_INT 4
 119    #define SIZEOF_LONG 4
 120    #define SIZEOF_SHORT 2
 121    #define SIZEOF_FLOAT 4
 122    #define SIZEOF_DOUBLE 8
 123 #endif
 124
 125 typedef signed char kint8;
 126 typedef unsigned char kuint8;
 127
 128 #if SIZEOF_INT == 4
 129     typedef int kint32;
 130     typedef unsigned int kuint32;
 131 #elif SIZEOF_LONG == 4
 132     typedef long int kint32;
 133     typedef unsigned int kuint32;
 134 #endif
 135
 136 #if SIZEOF_SHORT == 2
 137     typedef short int kint16;
 138     typedef unsigned short int kuint16;
 139 #elif SIZEOF_INT == 2
 140     typedef int kint16;
 141     typedef unsigned int kuint16;
 142 #endif
 143
 144 #if SIZEOF_FLOAT == 4
 145     typedef float kfloat32;
 146 #endif
 147 #if SIZEOF_DOUBLE == 8
 148     typedef double kfloat64;
 149 #endif
 150
 151
 152 inline const char*
 153 fileBasename (const char* const filename)
 154 {
 155   const char* p = strrchr (filename, '/');
 156   return (p ? p + 1 : filename);
 157 }
 158
 159
 160 /* strfuncs.cpp */
 161 char* str_skip_head(const char* str, const char* const charlist);
 162 char* str_skip_head(const char* str, char* charlist);
 163 char *str_lower(char *s);
 164 char *str_wrm_tail(char *str);
 165 char *str_rm_tail(char *str, const char* const charlist);
 166 char *str_upper(char *str);
 167
 168 /* syserror.cpp */
 169 void sys_error(int severity, const char *msg, ...);
 170 void sys_verror(int severity, const char *msg, va_list arg);
 171 void sys_error_level(int severity);
 172
 173 /* timedate.cpp */
 174 DATE *td_get_date(DATE *d);
 175 TIME *td_get_time(TIME *t);
 176 double td_current_sec(void);
 177 double td_time_to_sec(TIME *t);
 178 TIME *td_time_sub(const TIME *t1, const TIME *t2, TIME *tdiff);
 179 TIME *td_time_add(const TIME *t1, const TIME *t2, TIME *tsum);
 180 TIME *td_time_copy(TIME *to, const TIME *from);
 181 TIME *td_time_norm(TIME *t);
 182 void td_get_tmdt(TIMEDATE *td);
 183 const char *td_str_tmdt(const TIMEDATE *td);
 184 const char *td_str_time(const TIME *t);
 185 const char *td_str_stime(const TIME *t);
 186 const char *td_str_date(const DATE *d);
 187 char *td_str_cdate(DATE *d);
 188 char *td_month_name(int n);
 189 char *td_day_name(int n);
 190
 191
 192 // Math Section
 193
 194 #include <cmath>
 195
 196 #define PI      3.14159265358979323846
 197 #define HALFPI  1.57079632679489661923  /* PI divided by 2 */
 198 #define QUARTPI 0.78539816339744830962  /* PI divided by 4 */
 199 #define I_PI    0.31830988618379067154  /* Inverse of PI */
 200 #define I_PID2  0.63661977236758134308  /* Inverse of PID2 */
 201
 202 #define TWOPI   6.28318530717958647692
 203 #define SQRT2   1.414213562373095049
 204
 205 #define F_EPSILON       1.0E-6
 206 #define D_EPSILON       1.0E-10
 207
 208 #define ASSUMEDZERO  1E-10
 209
 210 typedef double GRFMTX_2D[3][3];
 211 typedef double GRFMTX_3D[4][4];
 212
 213 inline double
 214 convertDegreesToRadians (double x)
 215 { return (x * (PI/180.)); }
 216
 217 inline double
 218 convertRadiansToDegrees (double x)
 219 { return (x*(180./PI)); }
 220
 221 template<class T>
 222 inline T nearest (double x)
 223 { return (x > 0 ? static_cast<T>(x+0.5) : static_cast<T>(x-0.5)); }
 224
 225 inline int imax (int a, int b)\r
 226 { return (a >= b ? a : b); }\r
 227 \r
 228 template<class T>
 229 inline T clamp (T value, T lowerBounds, T upperBounds)
 230 { return (value >= upperBounds ? upperBounds : (value <= lowerBounds ? lowerBounds : value )); }
 231
 232 template<class T>
 233 inline T lineLength (T x1, T y1, T x2, T y2)
 234 { return static_cast<T>( sqrt ((x2-x1)*(x2-x1) + (y2-y1)*(y2-y1)) ); }
 235
 236 template<class T>
 237 inline void minmax_array (const T* array, const int n, T& min, T& max)
 238 {
 239   max = min = array[0];
 240
 241   for (int i = 1; i < n; i++)
 242     if (array[i] < min)
 243       min = array[i];
 244     else if (array[i] > max)
 245       max = array[i];
 246 }
 247
 248
 249 //////////////////////////////////////////////////////////////
 250 // FUNTION DECLARATIONS
 251 //////////////////////////////////////////////////////////////
 252
 253 // clip.cpp
 254 bool clip_rect (double& x1, double& y1, double& x2, double& y2, const double rect[4]);
 255 bool clip_segment (double& x1, double& y1, double& x2, double& y2, const double u, const double v);
 256 bool clip_sector (double& x1, double& y1, double& x2, double& y2, const double u, const double v);
 257 bool clip_circle (double& x1, double& y1, double& x2, double& y2, const double cx, const double cy, const double radius, double t1, double t2);
 258 bool clip_triangle (double& x1, double& y1, double& x2, double& y2, const double u, const double v, const int clip_xaxis);
 259
 260
 261 // xform.cpp
 262 void indent_mtx2 (GRFMTX_2D m);
 263 void xlat_mtx2 (GRFMTX_2D m, const double x, const double y);
 264 void scale_mtx2 (GRFMTX_2D m, const double sx, const double sy);
 265 void rot_mtx2 (GRFMTX_2D m, const double theta);
 266 void mult_mtx2 (const GRFMTX_2D m1, const GRFMTX_2D m2, GRFMTX_2D result);
 267 void xform_mtx2 (const GRFMTX_2D m, double& x, double& y);
 268 void rotate2d (double x[], double y[], int pts, double angle);
 269 void xlat2d (double x[], double y[], int pts, double xoffset, double yoffset);
 270 void scale2d (double x[], double y[], int pts, double xfact, double yfact);
 271
 272 // mathfuncs.cpp
 273 double normalizeAngle (double theta);
 274 double integrateSimpson (const double xmin, const double xmax, const double *y, const int np);
 275
 276
 277 /*----------------------------------------------------------------------*/
 278
 279 /* screen character codes */
 280
 281 #define SC_BKSP           8
 282 #define SC_TAB            9
 283 #define SC_BLANK        ' '
 284
 285
 286 /* audio.cpp */
 287 void cio_beep(void);
 288 void cio_tone(double freq, double length);
 289
 290 /* crtput.cpp */
 291 void cio_put_c(int c);
 292 void cio_put_cc(int c, int count);
 293 void cio_put_str(const char *str);
 294
 295 /* kbget.cpp */
 296 unsigned int cio_kb_getc(void);
 297 void cio_kb_ungetc(unsigned int c);
 298 char *cio_kb_gets(char *str, int maxlen);
 299 unsigned int cio_kb_waitc(const char *astr, int beep);
 300
 301 // Keyboard Section
 302
 303 #define KEY_BKSP         8
 304 #define KEY_TAB          9
 305 #define KEY_RETURN      13
 306 #define KEY_ESCAPE      27
 307
 308 // ASCII Section
 309
 310 #define BACKSPACE  8
 311 #define LF      0x0A
 312 #define CR      0x0D
 313 #define BELL    0x07
 314
 315 #define SQUOTE    '\''
 316 #define DQUOTE    '\"'
 317 #define BSLASH    '\\'
 318 #define BACKSLASH '\\'
 319 #define SHARP     '#'
 320 #define SLASH     '/'
 321 #define ASTERICK  '*'
 322 #define COLON     ':'
 323 #define LBRACE    '{'
 324 #define RBRACE    '}'
 325 #define LPAREN    '('
 326 #define RPAREN    ')'
 327 #define LBRACK    '['
 328 #define RBRACK    ']'
 329 #define LANBRACK  '<'
 330 #define RANBRACK  '>'
 331 #define SEMICOL   ';'
 332 #define UNDERLIN  '_'
 333 #define COMMA     ','
 334 #define CARET     '^'
 335 #define TILDE     '~'
 336 #define ATSIGN    '@'
 337 #define AMPERSAND  '&'
 338 #define EXCLAM    '!'
 339 #define DOLLAR    '$'
 340 #define PERCENT   '%'
 341 #define PLUS      '+'
 342 #define HYPHEN    '-'
 343 #define EQUALS    '='
 344 #define QUESTION  '?'
 345 #define PERIOD    '.'
 346 #define VERTBAR   '|'
 347
 348 #endif  /* #ifndef CTSUPPORT_H */