]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - libdecnumber/decContext.h
merge from gcc
[thirdparty/binutils-gdb.git] / libdecnumber / decContext.h
CommitLineData
f5bc1778
DJ
1/* Decimal context header module for the decNumber C Library.
2 Copyright (C) 2005, 2007 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 2, or (at your option) any later
10 version.
11
12 In addition to the permissions in the GNU General Public License,
13 the Free Software Foundation gives you unlimited permission to link
14 the compiled version of this file into combinations with other
15 programs, and to distribute those combinations without any
16 restriction coming from the use of this file. (The General Public
17 License restrictions do apply in other respects; for example, they
18 cover modification of the file, and distribution when not linked
19 into a combine executable.)
20
21 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
22 WARRANTY; without even the implied warranty of MERCHANTABILITY or
23 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
24 for more details.
25
26 You should have received a copy of the GNU General Public License
27 along with GCC; see the file COPYING. If not, write to the Free
28 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
29 02110-1301, USA. */
30
31/* ------------------------------------------------------------------ */
32/* Decimal Context module header */
33/* ------------------------------------------------------------------ */
34/* */
35/* Context variables must always have valid values: */
36/* */
87d32bb7 37/* status -- [any bits may be cleared, but not set, by user] */
f5bc1778
DJ
38/* round -- must be one of the enumerated rounding modes */
39/* */
40/* The following variables are implied for fixed size formats (i.e., */
41/* they are ignored) but should still be set correctly in case used */
42/* with decNumber functions: */
43/* */
44/* clamp -- must be either 0 or 1 */
45/* digits -- must be in the range 1 through 999999999 */
46/* emax -- must be in the range 0 through 999999999 */
47/* emin -- must be in the range 0 through -999999999 */
48/* extended -- must be either 0 or 1 [present only if DECSUBSET] */
49/* traps -- only defined bits may be set */
50/* */
51/* ------------------------------------------------------------------ */
52
53#if !defined(DECCONTEXT)
54 #define DECCONTEXT
55 #define DECCNAME "decContext" /* Short name */
56 #define DECCFULLNAME "Decimal Context Descriptor" /* Verbose name */
87d32bb7 57 #define DECCAUTHOR "Mike Cowlishaw" /* Who to blame */
f5bc1778 58
1aa34cc5 59 #include "gstdint.h" /* C99 standard integers */
f5bc1778 60 #include <stdio.h> /* for printf, etc. */
87d32bb7 61 #include <signal.h> /* for traps */
f5bc1778
DJ
62
63 /* Extended flags setting -- set this to 0 to use only IEEE flags */
87d32bb7 64 #if !defined(DECEXTFLAG)
f5bc1778 65 #define DECEXTFLAG 1 /* 1=enable extended flags */
87d32bb7 66 #endif
f5bc1778
DJ
67
68 /* Conditional code flag -- set this to 0 for best performance */
87d32bb7 69 #if !defined(DECSUBSET)
f5bc1778 70 #define DECSUBSET 0 /* 1=enable subset arithmetic */
87d32bb7 71 #endif
f5bc1778
DJ
72
73 /* Context for operations, with associated constants */
74 enum rounding {
75 DEC_ROUND_CEILING, /* round towards +infinity */
87d32bb7 76 DEC_ROUND_UP, /* round away from 0 */
f5bc1778
DJ
77 DEC_ROUND_HALF_UP, /* 0.5 rounds up */
78 DEC_ROUND_HALF_EVEN, /* 0.5 rounds to nearest even */
79 DEC_ROUND_HALF_DOWN, /* 0.5 rounds down */
80 DEC_ROUND_DOWN, /* round towards 0 (truncate) */
81 DEC_ROUND_FLOOR, /* round towards -infinity */
87d32bb7 82 DEC_ROUND_05UP, /* round for reround */
f5bc1778
DJ
83 DEC_ROUND_MAX /* enum must be less than this */
84 };
85 #define DEC_ROUND_DEFAULT DEC_ROUND_HALF_EVEN;
86
87 typedef struct {
87d32bb7
DD
88 int32_t digits; /* working precision */
89 int32_t emax; /* maximum positive exponent */
90 int32_t emin; /* minimum negative exponent */
f5bc1778
DJ
91 enum rounding round; /* rounding mode */
92 uint32_t traps; /* trap-enabler flags */
93 uint32_t status; /* status flags */
94 uint8_t clamp; /* flag: apply IEEE exponent clamp */
95 #if DECSUBSET
96 uint8_t extended; /* flag: special-values allowed */
97 #endif
98 } decContext;
99
100 /* Maxima and Minima for context settings */
101 #define DEC_MAX_DIGITS 999999999
102 #define DEC_MIN_DIGITS 1
103 #define DEC_MAX_EMAX 999999999
104 #define DEC_MIN_EMAX 0
105 #define DEC_MAX_EMIN 0
106 #define DEC_MIN_EMIN -999999999
107 #define DEC_MAX_MATH 999999 /* max emax, etc., for math funcs. */
108
87d32bb7
DD
109 /* Classifications for decimal numbers, aligned with 754 (note that */
110 /* 'normal' and 'subnormal' are meaningful only with a decContext */
111 /* or a fixed size format). */
f5bc1778
DJ
112 enum decClass {
113 DEC_CLASS_SNAN,
114 DEC_CLASS_QNAN,
115 DEC_CLASS_NEG_INF,
116 DEC_CLASS_NEG_NORMAL,
117 DEC_CLASS_NEG_SUBNORMAL,
118 DEC_CLASS_NEG_ZERO,
119 DEC_CLASS_POS_ZERO,
120 DEC_CLASS_POS_SUBNORMAL,
121 DEC_CLASS_POS_NORMAL,
122 DEC_CLASS_POS_INF
123 };
124 /* Strings for the decClasses */
125 #define DEC_ClassString_SN "sNaN"
126 #define DEC_ClassString_QN "NaN"
127 #define DEC_ClassString_NI "-Infinity"
128 #define DEC_ClassString_NN "-Normal"
129 #define DEC_ClassString_NS "-Subnormal"
130 #define DEC_ClassString_NZ "-Zero"
131 #define DEC_ClassString_PZ "+Zero"
132 #define DEC_ClassString_PS "+Subnormal"
133 #define DEC_ClassString_PN "+Normal"
134 #define DEC_ClassString_PI "+Infinity"
135 #define DEC_ClassString_UN "Invalid"
136
137 /* Trap-enabler and Status flags (exceptional conditions), and */
138 /* their names. The top byte is reserved for internal use */
139 #if DECEXTFLAG
140 /* Extended flags */
141 #define DEC_Conversion_syntax 0x00000001
142 #define DEC_Division_by_zero 0x00000002
143 #define DEC_Division_impossible 0x00000004
144 #define DEC_Division_undefined 0x00000008
145 #define DEC_Insufficient_storage 0x00000010 /* [when malloc fails] */
87d32bb7
DD
146 #define DEC_Inexact 0x00000020
147 #define DEC_Invalid_context 0x00000040
f5bc1778
DJ
148 #define DEC_Invalid_operation 0x00000080
149 #if DECSUBSET
150 #define DEC_Lost_digits 0x00000100
151 #endif
152 #define DEC_Overflow 0x00000200
87d32bb7
DD
153 #define DEC_Clamped 0x00000400
154 #define DEC_Rounded 0x00000800
f5bc1778
DJ
155 #define DEC_Subnormal 0x00001000
156 #define DEC_Underflow 0x00002000
157 #else
158 /* IEEE flags only */
159 #define DEC_Conversion_syntax 0x00000010
160 #define DEC_Division_by_zero 0x00000002
161 #define DEC_Division_impossible 0x00000010
162 #define DEC_Division_undefined 0x00000010
163 #define DEC_Insufficient_storage 0x00000010 /* [when malloc fails] */
87d32bb7
DD
164 #define DEC_Inexact 0x00000001
165 #define DEC_Invalid_context 0x00000010
f5bc1778
DJ
166 #define DEC_Invalid_operation 0x00000010
167 #if DECSUBSET
168 #define DEC_Lost_digits 0x00000000
169 #endif
170 #define DEC_Overflow 0x00000008
87d32bb7
DD
171 #define DEC_Clamped 0x00000000
172 #define DEC_Rounded 0x00000000
f5bc1778
DJ
173 #define DEC_Subnormal 0x00000000
174 #define DEC_Underflow 0x00000004
175 #endif
176
87d32bb7 177 /* IEEE 754 groupings for the flags */
f5bc1778 178 /* [DEC_Clamped, DEC_Lost_digits, DEC_Rounded, and DEC_Subnormal */
87d32bb7
DD
179 /* are not in IEEE 754] */
180 #define DEC_IEEE_754_Division_by_zero (DEC_Division_by_zero)
f5bc1778 181 #if DECSUBSET
87d32bb7 182 #define DEC_IEEE_754_Inexact (DEC_Inexact | DEC_Lost_digits)
f5bc1778 183 #else
87d32bb7 184 #define DEC_IEEE_754_Inexact (DEC_Inexact)
f5bc1778 185 #endif
87d32bb7 186 #define DEC_IEEE_754_Invalid_operation (DEC_Conversion_syntax | \
f5bc1778
DJ
187 DEC_Division_impossible | \
188 DEC_Division_undefined | \
189 DEC_Insufficient_storage | \
87d32bb7 190 DEC_Invalid_context | \
f5bc1778 191 DEC_Invalid_operation)
87d32bb7
DD
192 #define DEC_IEEE_754_Overflow (DEC_Overflow)
193 #define DEC_IEEE_754_Underflow (DEC_Underflow)
f5bc1778
DJ
194
195 /* flags which are normally errors (result is qNaN, infinite, or 0) */
87d32bb7
DD
196 #define DEC_Errors (DEC_IEEE_754_Division_by_zero | \
197 DEC_IEEE_754_Invalid_operation | \
198 DEC_IEEE_754_Overflow | DEC_IEEE_754_Underflow)
f5bc1778 199 /* flags which cause a result to become qNaN */
87d32bb7 200 #define DEC_NaNs DEC_IEEE_754_Invalid_operation
f5bc1778
DJ
201
202 /* flags which are normally for information only (finite results) */
203 #if DECSUBSET
204 #define DEC_Information (DEC_Clamped | DEC_Rounded | DEC_Inexact \
205 | DEC_Lost_digits)
206 #else
207 #define DEC_Information (DEC_Clamped | DEC_Rounded | DEC_Inexact)
208 #endif
209
87d32bb7
DD
210 /* IEEE 854 names (for compatibility with older decNumber versions) */
211 #define DEC_IEEE_854_Division_by_zero DEC_IEEE_754_Division_by_zero
212 #define DEC_IEEE_854_Inexact DEC_IEEE_754_Inexact
213 #define DEC_IEEE_854_Invalid_operation DEC_IEEE_754_Invalid_operation
214 #define DEC_IEEE_854_Overflow DEC_IEEE_754_Overflow
215 #define DEC_IEEE_854_Underflow DEC_IEEE_754_Underflow
216
f5bc1778
DJ
217 /* Name strings for the exceptional conditions */
218 #define DEC_Condition_CS "Conversion syntax"
219 #define DEC_Condition_DZ "Division by zero"
220 #define DEC_Condition_DI "Division impossible"
221 #define DEC_Condition_DU "Division undefined"
222 #define DEC_Condition_IE "Inexact"
223 #define DEC_Condition_IS "Insufficient storage"
224 #define DEC_Condition_IC "Invalid context"
225 #define DEC_Condition_IO "Invalid operation"
226 #if DECSUBSET
227 #define DEC_Condition_LD "Lost digits"
228 #endif
229 #define DEC_Condition_OV "Overflow"
230 #define DEC_Condition_PA "Clamped"
231 #define DEC_Condition_RO "Rounded"
232 #define DEC_Condition_SU "Subnormal"
233 #define DEC_Condition_UN "Underflow"
234 #define DEC_Condition_ZE "No status"
235 #define DEC_Condition_MU "Multiple status"
236 #define DEC_Condition_Length 21 /* length of the longest string, */
237 /* including terminator */
238
239 /* Initialization descriptors, used by decContextDefault */
87d32bb7 240 #define DEC_INIT_BASE 0
f5bc1778
DJ
241 #define DEC_INIT_DECIMAL32 32
242 #define DEC_INIT_DECIMAL64 64
243 #define DEC_INIT_DECIMAL128 128
244 /* Synonyms */
245 #define DEC_INIT_DECSINGLE DEC_INIT_DECIMAL32
246 #define DEC_INIT_DECDOUBLE DEC_INIT_DECIMAL64
247 #define DEC_INIT_DECQUAD DEC_INIT_DECIMAL128
248
249 /* decContext routines */
250
251 #include "decContextSymbols.h"
252
253 extern decContext * decContextClearStatus(decContext *, uint32_t);
254 extern decContext * decContextDefault(decContext *, int32_t);
255 extern enum rounding decContextGetRounding(decContext *);
256 extern uint32_t decContextGetStatus(decContext *);
257 extern decContext * decContextRestoreStatus(decContext *, uint32_t, uint32_t);
258 extern uint32_t decContextSaveStatus(decContext *, uint32_t);
259 extern decContext * decContextSetRounding(decContext *, enum rounding);
260 extern decContext * decContextSetStatus(decContext *, uint32_t);
261 extern decContext * decContextSetStatusFromString(decContext *, const char *);
262 extern decContext * decContextSetStatusFromStringQuiet(decContext *, const char *);
263 extern decContext * decContextSetStatusQuiet(decContext *, uint32_t);
264 extern const char * decContextStatusToString(const decContext *);
87d32bb7 265 extern int32_t decContextTestEndian(uint8_t);
f5bc1778
DJ
266 extern uint32_t decContextTestSavedStatus(uint32_t, uint32_t);
267 extern uint32_t decContextTestStatus(decContext *, uint32_t);
268 extern decContext * decContextZeroStatus(decContext *);
269
270#endif