| 1 |
(* ShortStr.mod provides low level SHORTREAL/string conversions. |
| 2 |
|
| 3 |
Copyright (C) 2023-2025 Free Software Foundation, Inc. |
| 4 |
Contributed by Gaius Mulley <[email protected]>. |
| 5 |
|
| 6 |
This file is part of GNU Modula-2. |
| 7 |
|
| 8 |
GNU Modula-2 is free software; you can redistribute it and/or modify |
| 9 |
it under the terms of the GNU General Public License as published by |
| 10 |
the Free Software Foundation; either version 3, or (at your option) |
| 11 |
any later version. |
| 12 |
|
| 13 |
GNU Modula-2 is distributed in the hope that it will be useful, but |
| 14 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 16 |
General Public License for more details. |
| 17 |
|
| 18 |
Under Section 7 of GPL version 3, you are granted additional |
| 19 |
permissions described in the GCC Runtime Library Exception, version |
| 20 |
3.1, as published by the Free Software Foundation. |
| 21 |
|
| 22 |
You should have received a copy of the GNU General Public License and |
| 23 |
a copy of the GCC Runtime Library Exception along with this program; |
| 24 |
see the files COPYING3 and COPYING.RUNTIME respectively. If not, see |
| 25 |
<http://www.gnu.org/licenses/>. *) |
| 26 |
|
| 27 |
DEFINITION MODULE ShortConv; |
| 28 |
|
| 29 |
IMPORT |
| 30 |
ConvTypes; |
| 31 |
|
| 32 |
TYPE |
| 33 |
ConvResults = ConvTypes.ConvResults; (* strAllRight, strOutOfRange, |
| 34 |
strWrongFormat, strEmpty *) |
| 35 |
|
| 36 |
PROCEDURE ScanReal (inputCh: CHAR; VAR chClass: ConvTypes.ScanClass; |
| 37 |
VAR nextState: ConvTypes.ScanState); |
| 38 |
(* Represents the start state of a finite state scanner for real |
| 39 |
numbers - assigns class of inputCh to chClass and a procedure |
| 40 |
representing the next state to nextState. |
| 41 |
*) |
| 42 |
|
| 43 |
PROCEDURE FormatReal (str: ARRAY OF CHAR): ConvResults; |
| 44 |
(* Returns the format of the string value for conversion to LONGREAL. *) |
| 45 |
|
| 46 |
PROCEDURE ValueReal (str: ARRAY OF CHAR): SHORTREAL; |
| 47 |
(* Returns the value corresponding to the real number string value |
| 48 |
str if str is well-formed; otherwise raises the ShortConv exception. |
| 49 |
*) |
| 50 |
|
| 51 |
PROCEDURE LengthFloatReal (real: SHORTREAL; sigFigs: CARDINAL): CARDINAL; |
| 52 |
(* Returns the number of characters in the floating-point string |
| 53 |
representation of real with sigFigs significant figures. |
| 54 |
*) |
| 55 |
|
| 56 |
PROCEDURE LengthEngReal (real: SHORTREAL; sigFigs: CARDINAL): CARDINAL; |
| 57 |
(* Returns the number of characters in the floating-point engineering |
| 58 |
string representation of real with sigFigs significant figures. |
| 59 |
*) |
| 60 |
|
| 61 |
PROCEDURE LengthFixedReal (real: SHORTREAL; place: INTEGER): CARDINAL; |
| 62 |
(* Returns the number of characters in the fixed-point string |
| 63 |
representation of real rounded to the given place relative to the |
| 64 |
decimal point. |
| 65 |
*) |
| 66 |
|
| 67 |
PROCEDURE IsRConvException (): BOOLEAN; |
| 68 |
(* Returns TRUE if the current coroutine is in the exceptional |
| 69 |
execution state because of the raising of an exception in a |
| 70 |
routine from this module; otherwise returns FALSE. |
| 71 |
*) |
| 72 |
|
| 73 |
END ShortConv. |