decNumberLocal.h   [plain text]

/* decNumber package local type, tuning, and macro definitions.
   Copyright (C) 2005 Free Software Foundation, Inc.
   Contributed by IBM Corporation.  Author Mike Cowlishaw.

   This file is part of GCC.

   GCC 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, or (at your option) any later

   In addition to the permissions in the GNU General Public License,
   the Free Software Foundation gives you unlimited permission to link
   the compiled version of this file into combinations with other
   programs, and to distribute those combinations without any
   restriction coming from the use of this file.  (The General Public
   License restrictions do apply in other respects; for example, they
   cover modification of the file, and distribution when not linked
   into a combine executable.)

   GCC 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 GCC; see the file COPYING.  If not, write to the Free
   Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
   02110-1301, USA.  */

/* ------------------------------------------------------------------ */
/* This header file is included by all modules in the decNumber       */
/* library, and contains local type definitions, tuning parameters,   */
/* etc.  It must only be included once, and should not need to be     */
/* used by application programs.  decNumber.h must be included first. */
/* ------------------------------------------------------------------ */

#if !defined(DECNUMBERLOC)
#define DECNLAUTHOR   "Mike Cowlishaw"	/* Who to blame */

  /* Local names for common types -- decNumber modules do not use int or
     long directly */
#define Flag   uint8_t
#define Byte   int8_t
#define uByte  uint8_t
#define Short  int16_t
#define uShort uint16_t
#define Int    int32_t
#define uInt   uint32_t
#define Unit   decNumberUnit

  /* Tuning parameter */
#define DECBUFFER 36		/* Maximum size basis for local buffers. */
			      /* Should be a common maximum precision */
			      /* rounded up to a multiple of 4; must */
			      /* be non-negative. */

  /* Conditional code flags -- set these to 0 for best performance */
#define DECCHECK  0		/* 1 to enable robust checking */
#define DECALLOC  0		/* 1 to enable memory allocation accounting */
#define DECTRACE  0		/* 1 to trace critical intermediates, etc. */

  /* Development use defines */
     /* if these interfere with your C includes, just comment them out */
#define  int ?			/* enable to ensure we do not use plain C */
#define  long ??		/* .. 'int' or 'long' types from here on */

  /* Limits and constants */
#define DECNUMMAXP 999999999	/* maximum precision we can handle (9 digits) */
#define DECNUMMAXE 999999999	/* maximum adjusted exponent ditto (9 digits) */
#define DECNUMMINE -999999999	/* minimum adjusted exponent ditto (9 digits) */
#error Maximum digits mismatch
#error Maximum exponent mismatch
#error Minimum exponent mismatch

  /* Set DECDPUNMAX -- the maximum integer that fits in DECDPUN digits */
#if   DECDPUN==1
#define DECDPUNMAX 9
#elif DECDPUN==2
#define DECDPUNMAX 99
#elif DECDPUN==3
#define DECDPUNMAX 999
#elif DECDPUN==4
#define DECDPUNMAX 9999
#elif DECDPUN==5
#define DECDPUNMAX 99999
#elif DECDPUN==6
#define DECDPUNMAX 999999
#elif DECDPUN==7
#define DECDPUNMAX 9999999
#elif DECDPUN==8
#define DECDPUNMAX 99999999
#elif DECDPUN==9
#define DECDPUNMAX 999999999
#elif defined(DECDPUN)
#error DECDPUN must be in the range 1-9

  /* ----- Shared data ----- */
  /* The powers of of ten array (powers[n]==10**n, 0<=n<=10) */
extern const uInt powers[];

  /* ----- Macros ----- */
  /* ISZERO -- return true if decNumber dn is a zero */
  /* [performance-critical in some situations] */
#define ISZERO(dn) decNumberIsZero(dn)	/* now just a local name */

  /* X10 and X100 -- multiply integer i by 10 or 100 */
  /* [shifts are usually faster than multiply; could be conditional] */
#define X10(i)  (((i)<<1)+((i)<<3))
#define X100(i) (((i)<<2)+((i)<<5)+((i)<<6))

  /* D2U -- return the number of Units needed to hold d digits */
#if DECDPUN==8
#define D2U(d) ((unsigned)((d)+7)>>3)
#elif DECDPUN==4
#define D2U(d) ((unsigned)((d)+3)>>2)
#define D2U(d) (((d)+DECDPUN-1)/DECDPUN)

#error decNumberLocal included more than once