libdecnumber/decSingle.h

   1 /* decSingle module header for the decNumber C Library.
   2    Copyright (C) 2005-2022 Free Software Foundation, Inc.
   3    Contributed by IBM Corporation.  Author Mike Cowlishaw.
   4
   5    This file is part of GCC.
   6
   7    GCC is free software; you can redistribute it and/or modify it under
   8    the terms of the GNU General Public License as published by the Free
   9    Software Foundation; either version 3, or (at your option) any later
  10    version.
  11
  12    GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13    WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15    for more details.
  16
  17 Under Section 7 of GPL version 3, you are granted additional
  18 permissions described in the GCC Runtime Library Exception, version
  19 3.1, as published by the Free Software Foundation.
  20
  21 You should have received a copy of the GNU General Public License and
  22 a copy of the GCC Runtime Library Exception along with this program;
  23 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  24 <http://www.gnu.org/licenses/>.  */
  25
  26 /* ------------------------------------------------------------------ */
  27 /* decSingle.h -- Decimal 32-bit format module header                 */
  28 /* ------------------------------------------------------------------ */
  29
  30 #if !defined(DECSINGLE)
  31   #define DECSINGLE
  32
  33   #define DECSINGLENAME       "decSingle"             /* Short name   */
  34   #define DECSINGLETITLE      "Decimal 32-bit datum"  /* Verbose name */
  35   #define DECSINGLEAUTHOR     "Mike Cowlishaw"        /* Who to blame */
  36
  37   /* parameters for decSingles */
  38   #define DECSINGLE_Bytes    4     /* length                          */
  39   #define DECSINGLE_Pmax     7     /* maximum precision (digits)      */
  40   #define DECSINGLE_Emin   -95     /* minimum adjusted exponent       */
  41   #define DECSINGLE_Emax    96     /* maximum adjusted exponent       */
  42   #define DECSINGLE_EmaxD    3     /* maximum exponent digits         */
  43   #define DECSINGLE_Bias   101     /* bias for the exponent           */
  44   #define DECSINGLE_String  16     /* maximum string length, +1       */
  45   #define DECSINGLE_EconL    6     /* exponent continuation length    */
  46   #define DECSINGLE_Declets  2     /* count of declets                */
  47   /* highest biased exponent (Elimit-1) */
  48   #define DECSINGLE_Ehigh (DECSINGLE_Emax + DECSINGLE_Bias - (DECSINGLE_Pmax-1))
  49
  50   /* Required includes                                                */
  51   #include "decContext.h"
  52   #include "decQuad.h"
  53   #include "decDouble.h"
  54
  55   /* The decSingle decimal 32-bit type, accessible by all sizes */
  56   typedef union {
  57     uint8_t   bytes[DECSINGLE_Bytes];   /* fields: 1, 5, 6, 20 bits */
  58     uint16_t shorts[DECSINGLE_Bytes/2];
  59     uint32_t  words[DECSINGLE_Bytes/4];
  60     } decSingle;
  61
  62   /* ---------------------------------------------------------------- */
  63   /* Routines -- implemented as decFloat routines in common files     */
  64   /* ---------------------------------------------------------------- */
  65
  66   #include "decSingleSymbols.h"
  67
  68   /* Utilities (binary argument(s) or result, extractors, etc.) */
  69   extern decSingle * decSingleFromBCD(decSingle *, int32_t, const uint8_t *, int32_t);
  70   extern decSingle * decSingleFromPacked(decSingle *, int32_t, const uint8_t *);
  71   extern decSingle * decSingleFromPackedChecked(decSingle *, int32_t, const uint8_t *);
  72   extern decSingle * decSingleFromString(decSingle *, const char *, decContext *);
  73   extern decSingle * decSingleFromWider(decSingle *, const decDouble *, decContext *);
  74   extern int32_t     decSingleGetCoefficient(const decSingle *, uint8_t *);
  75   extern int32_t     decSingleGetExponent(const decSingle *);
  76   extern decSingle * decSingleSetCoefficient(decSingle *, const uint8_t *, int32_t);
  77   extern decSingle * decSingleSetExponent(decSingle *, decContext *, int32_t);
  78   extern void        decSingleShow(const decSingle *, const char *);
  79   extern int32_t     decSingleToBCD(const decSingle *, int32_t *, uint8_t *);
  80   extern char      * decSingleToEngString(const decSingle *, char *);
  81   extern int32_t     decSingleToPacked(const decSingle *, int32_t *, uint8_t *);
  82   extern char      * decSingleToString(const decSingle *, char *);
  83   extern decDouble * decSingleToWider(const decSingle *, decDouble *);
  84   extern decSingle * decSingleZero(decSingle *);
  85
  86   /* (No Arithmetic routines for decSingle) */
  87
  88   /* Non-computational */
  89   extern uint32_t     decSingleRadix(const decSingle *);
  90   extern const char * decSingleVersion(void);
  91
  92   /* decNumber conversions; these are implemented as macros so as not  */
  93   /* to force a dependency on decimal32 and decNumber in decSingle.    */
  94   /* decSingleFromNumber returns a decimal32 * to avoid warnings.      */
  95   #define decSingleToNumber(dq, dn) decimal32ToNumber((decimal32 *)(dq), dn)
  96   #define decSingleFromNumber(dq, dn, set) decimal32FromNumber((decimal32 *)(dq), dn, set)
  97
  98 #endif