basic.hpp File Reference

#include "classdef.hpp"
#include "fast_alloc.hpp"
#include "minmax.hpp"
#include "tm_ostream.hpp"
#include <math.h>

Include dependency graph for basic.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	type_helper< T >
	Helper struct for type identification and initialization. More...

Macros
#define	LESSGTR   <>
	Macro used for template specialization of less than and greater than operators.
#define	MAX_SI   0x7fffffff
#define	MIN_SI   0x80000000
	Macro defining the minimum value of a signed integer.
#define	STACK_NEW_ARRAY(name, T, size)   T name[size]
#define	STACK_DELETE_ARRAY(name)
#define	USE_EXCEPTIONS
	Macro used to enable or disable the use of exceptions.
#define	ASSERT(cond, msg)
	Macro used to assert that a condition is true, and throw an exception with an error message if the condition is false.
#define	TM_FAILED(msg)    { tm_throw (msg); }
	Macro used to throw an exception with a specified error message.

Typedefs
typedef void *	pointer
typedef unsigned int	color

Enumerations
enum	display_control { INDENT , UNINDENT , HRULE , LF }
	Enumeration of display control options. More...

Functions
void	tm_failure (const char *msg)
	Function used to handle a TM failure by displaying an error message and exiting the program.
void	tm_throw (const char *msg)
	Function used to throw an exception with a specified error message.
void	handle_exceptions ()
	Function used to handle exceptions by displaying and clearing the exception message.
int	hash (int i)
	Hashes an integer.
int	hash (long int i)
	Hashes a long integer.
int	hash (DI i)
	Hashes a double integer.
int	hash (unsigned int i)
	Hashes an unsigned integer.
int	hash (unsigned long int i)
	Hashes an unsigned long integer.
int	hash (DN i)
	Hashes a double number.
int	hash (float x)
	Hashes a float number.
int	hash (double x)
	Hashes a double number.
int	copy (int x)
	Returns a copy of an integer.
SI	as_int (double x)
	Converts a double to a signed integer, rounding to the nearest integer.
double	tm_round (double x)
	Rounds a double to the nearest integer.
int	hash (pointer ptr)
	Computes a hash value for a pointer.
tm_ostream &	operator<< (tm_ostream &out, display_control ctrl)
	Output operator for display control options.
int	new_type_identifier ()
	Generates a new type identifier.

Variables
string	the_exception
	Global variable used to store the current exception message.

Detailed Description

Copyright

GPLv3

defines basic types and macros used throughout the kernel.

Author

Joris van der Hoeven

Date

1999

Definition in file basic.hpp.

Macro Definition Documentation

LESSGTR

#define LESSGTR   <>

Macro used for template specialization of less than and greater than operators.

Definition at line 22 of file basic.hpp.

MAX_SI

#define MAX_SI   0x7fffffff

Definition at line 27 of file basic.hpp.

MIN_SI

#define MIN_SI   0x80000000

Macro defining the minimum value of a signed integer.

Definition at line 32 of file basic.hpp.

STACK_NEW_ARRAY

#define STACK_NEW_ARRAY	(		name,
			T,
			size )   T name[size]

Definition at line 43 of file basic.hpp.

STACK_DELETE_ARRAY

#define STACK_DELETE_ARRAY

(

name

)

Definition at line 44 of file basic.hpp.

USE_EXCEPTIONS

#define USE_EXCEPTIONS

Macro used to enable or disable the use of exceptions.

Definition at line 50 of file basic.hpp.

ASSERT

#define ASSERT	(		cond,
			msg )

Value:

  {                                                                            \
    if (!(cond)) tm_throw (msg);                                               \
  }

Macro used to assert that a condition is true, and throw an exception with an error message if the condition is false.

Definition at line 85 of file basic.hpp.

#define ASSERT(cond, msg)                                                      \
  {                                                                            \
    if (!(cond)) tm_throw (msg);                                               \
  }

TM_FAILED

#define TM_FAILED

(

msg

)

{ tm_throw (msg); }

Macro used to throw an exception with a specified error message.

Definition at line 93 of file basic.hpp.

#define TM_FAILED(msg)                                                         \
  { tm_throw (msg); }

Typedef Documentation

pointer

typedef void* pointer

Definition at line 24 of file basic.hpp.

color

typedef unsigned int color

Definition at line 25 of file basic.hpp.

Enumeration Type Documentation

display_control

enum display_control

Enumeration of display control options.

Enumerator
INDENT
UNINDENT
HRULE
LF

Definition at line 287 of file basic.hpp.

{ INDENT, UNINDENT, HRULE, LF };

Function Documentation

tm_failure()

void tm_failure

(

const char *

msg

)

Function used to handle a TM failure by displaying an error message and exiting the program.

Parameters

msg	The error message to display.

tm_throw()

void tm_throw

(

const char *

msg

)

Function used to throw an exception with a specified error message.

Parameters

msg	The error message to throw with the exception.

Definition at line 27 of file basic.cpp.

                           {
  the_exception= msg;
  // the_report   = get_crash_report (msg);
  cout << "Throwing " << msg << LF;
  cout << "-------------------------------------------------\n";
  cout << the_report << LF;
  cout << "-------------------------------------------------\n";
  throw string (msg);
}

handle_exceptions()

void handle_exceptions

(

)

Function used to handle exceptions by displaying and clearing the exception message.

Note

if catching an exception throwed by tm_throw, this function must be appended after catch(){...} block.

Definition at line 38 of file basic.cpp.

                     {
  if (N (the_exception) != 0) {
    // formatted arg (verbatim_to_tree (the_report, false, "utf-8"));
    // failed_error << "Exception, " << the_exception << arg << LF;
    the_exception= "";
    the_report   = "";
  }
}

hash() [1/9]

int hash ( int i )

inline

Hashes an integer.

Parameters

i	The integer to hash.

Returns

The hashed value of the integer.

Definition at line 151 of file basic.hpp.

             {
  return i;
}

hash() [2/9]

int hash ( long int i )

inline

Hashes a long integer.

Parameters

i	The long integer to hash.

Returns

The hashed value of the long integer.

Definition at line 162 of file basic.hpp.

                  {
  return (int) i;
}

hash() [3/9]

int hash ( DI i )

inline

Hashes a double integer.

Parameters

i	The double integer to hash.

Returns

The hashed value of the double integer.

Definition at line 173 of file basic.hpp.

            {
  return (int) i;
}

hash() [4/9]

int hash ( unsigned int i )

inline

Hashes an unsigned integer.

Parameters

i	The unsigned integer to hash.

Returns

The hashed value of the unsigned integer.

Definition at line 184 of file basic.hpp.

                      {
  return i;
}

hash() [5/9]

int hash ( unsigned long int i )

inline

Hashes an unsigned long integer.

Parameters

i	The unsigned long integer to hash.

Returns

The hashed value of the unsigned long integer.

Definition at line 195 of file basic.hpp.

                           {
  return (int) i;
}

hash() [6/9]

int hash ( DN i )

inline

Hashes a double number.

Parameters

x	The double number to hash.

Returns

The hashed value of the double number.

Definition at line 206 of file basic.hpp.

            {
  return (int) i;
}

hash() [7/9]

int hash ( float x )

inline

Hashes a float number.

Parameters

x	The float numberto hash.

Returns

The hashed value of the float number.

Definition at line 217 of file basic.hpp.

               {
  union {
    int   n;
    float d;
  } u;
  u.d= x;
  return u.n & 0xffffffff;
}

hash() [8/9]

int hash ( double x )

inline

Hashes a double number.

Parameters

x	The double number to hash.

Returns

The hashed value of the double number.

Definition at line 233 of file basic.hpp.

                {
  union {
    DI     n;
    double d;
  } u;
  u.d= x;
  return (int) (u.n ^ (u.n >> 32));
}

copy()

int copy ( int x )

inline

Returns a copy of an integer.

Parameters

x	The integer to copy.

Returns

A copy of the integer.

Definition at line 249 of file basic.hpp.

             {
  return x;
}

as_int()

SI as_int ( double x )

inline

Converts a double to a signed integer, rounding to the nearest integer.

Parameters

x	The double to convert.

Returns

The converted signed integer.

Definition at line 261 of file basic.hpp.

                  {
  return (SI) floor (x + 0.5);
}

tm_round()

double tm_round ( double x )

inline

Rounds a double to the nearest integer.

Parameters

x	The double to round.

Returns

The rounded double.

Definition at line 272 of file basic.hpp.

                    {
  return floor (x + 0.5);
}

hash() [9/9]

int hash

(

pointer

ptr

)

Computes a hash value for a pointer.

Parameters

ptr	The pointer to hash.

Returns

The hash value.

Definition at line 17 of file basic.cpp.

                   {
  return ((int) ((intptr_t) ptr)) + (((int) ((intptr_t) ptr)) % 19);
}

operator<<()

tm_ostream & operator<<	(	tm_ostream &	out,
		display_control	ctrl )

Output operator for display control options.

Parameters

out	The output stream to write to.
ctrl	The display control option.

Returns

The output stream.

Definition at line 61 of file basic.cpp.

                                                   {
  int i;
  switch (ctrl) {
  case INDENT:
    out << "  ";
    current_indent+= 2;
    break;
  case UNINDENT:
    out << "\b\b";
    current_indent-= 2;
    break;
  case HRULE:
    for (i= current_indent; i < 78; i++)
      out << "-";
  case LF:
    out << "\n";
    for (i= 0; i < current_indent; i++)
      out << " ";
    break;
  }
  return out;
}

new_type_identifier()

int new_type_identifier

(

)

Generates a new type identifier.

Returns

The new type identifier.

Definition at line 53 of file basic.cpp.

                       {
  static int id= 0;
  id--;
  return id;
}

Variable Documentation

the_exception

string the_exception

extern

Global variable used to store the current exception message.

Definition at line 22 of file basic.cpp.