mirror of
https://github.com/lcn2/calc.git
synced 2025-08-19 01:13:27 +03:00
a6824debbc
Changed calc_errno a global int variable so that is may be directly accessed by libcalc users. Further improve help files for help/errno, help/error, help/newerror, help/stoponerror and help/strerror by adding to documentation of the calc error code system as well as libcalc interface where applicable. Changed #define E_USERDEF to #define E__USERDEF. Removed use of E_USERDEF, E__BASE, E__COUNT, and E__HIGHEST from custom/c_sysinfo because the c_sysinfo is just a demo and this will simplify the custom/Makefile. The include file calcerr.h is now the errsym.h include file. The calcerr.tbl has been replaced by errtbl.c and errtbl.h. The calcerr_c.awk, calcerr_c.sed, calcerr_h.awk, and calcerr_h.sed files are now obsolete and have been removed. The calcerr.c and calcerr.h now obsolete and are no longer built. The calc computation error codes, symbols and messages are now in a error_table[] array of struct errtbl. An E_STRING is a string corresponds to an error code #define. For example, the E_STRING for the calc error E_STRCAT, is the string "E_STRING". An E_STRING must now match the regular expression: "^E_[A-Z0-9_]+$". The old array error_table[] of error message strings has been replaced by a new error_table[] array of struct errtbl. The struct errtbl array holds calc errnum error codes, the related E_STRING symbol as a string, and the original related error message. To add new computation error codes, add them near the bottom of the error_table[] array, just before the NULL entry. The ./errcode utility, when run, will verify the consistency of the error_table[] array. The Makefile uses ./errcode -e to generate the contents of help/errorcodes file. The help errorcodes now prints information from the new cstruct errtbl error_table[] array. The help/errorcodes.hdr and help/errorcodes.sed files are now obsolete and have been removed. The Makefile uses ./errcode -d to generate the contents of the errsym.h include file. Updated .gitignore and trailblank to support the above changes.
148 lines
4.3 KiB
Plaintext
148 lines
4.3 KiB
Plaintext
NAME
|
|
error - raise a calc error condition
|
|
|
|
SYNOPSIS
|
|
error([errnum | "E_STRING"])
|
|
|
|
TYPES
|
|
errnum integer, defaults to errno()
|
|
E_STRING string
|
|
|
|
return null value or error value
|
|
|
|
DESCRIPTION
|
|
If errnum == 0:
|
|
|
|
error(errnum) returns the null value.
|
|
|
|
The "global calc_errno value" is set to 0.
|
|
|
|
The global calc error count is not changed.
|
|
|
|
For 0 < errnum <= 32767:
|
|
|
|
error(errnum) returns a value that is of a special type called
|
|
"error". The "error" return value, when given to iserror()
|
|
will cause that function to return a true value that happens
|
|
to match the "global calc_errno value".
|
|
|
|
The "global calc_errno value" is then set to errnum.
|
|
|
|
The global calc error count (see help errcount) is incremented.
|
|
If the global calc error count exceeds the maximum count
|
|
(see help errmax), any ongoing calc execution is aborted.
|
|
|
|
All other values of errnum are reserved for future use and currently
|
|
will generate an error.
|
|
|
|
NOTE:
|
|
|
|
Calling error() without an argument will return the current
|
|
"global calc_errno value" AND will also increment the
|
|
global calc error count.
|
|
|
|
Use errno() instead of error() to return the "global calc_errno
|
|
value" without incrementing the global calc error count.
|
|
|
|
The term "global calc_errno value" is an internal calc state.
|
|
This is NOT a calc variable called calc_errno. The value of the
|
|
"global calc_errno value" may be returned by errno() (see help errno).
|
|
|
|
The "global calc_errno value" be set to some other non-zero
|
|
value by other builtin functions and calculations, especially
|
|
if they result in an error. Thus, while calling errno(errnum) may
|
|
set calc_errno, some other error may later overwrite the
|
|
"global calc_errno value".
|
|
|
|
By convention, the "global calc_errno value" has the following ranges:
|
|
|
|
errnum < 0 Reserved for future use
|
|
|
|
errnum == 0 calc_errno cleared: libc errno codes above here
|
|
|
|
1 <= errnum <= 9999 system error and libc errno codes
|
|
|
|
errnum == 10000 Reserved for "No error" calc internal state
|
|
|
|
10001 <= errnum <= E__HIGHEST calc computation error codes
|
|
|
|
E__HIGHEST < errnum < 20000 Reserved for future calc error codes
|
|
|
|
20000 < errnum <= 32767 User defined error codes start here
|
|
|
|
errnum >= 32768 Reserved for future use
|
|
|
|
The following constants are part of the calc error code mechanism:
|
|
|
|
E__BASE == 10000 # 1 less than the 1st calc computation error code
|
|
|
|
E__COUNT # number of calc computation error codes (not including E__BASE)
|
|
E__HIGHEST # highest assigned calc computation error code
|
|
|
|
E__USERDEF == 20000 # user defined error codes start here
|
|
E__USERMAX == 32767 # maximum user defined error code
|
|
|
|
|
|
See help errorcodes for the actual values of the above constants.
|
|
|
|
EXAMPLE
|
|
; errcount(0),; errmax(20),;
|
|
; print errcount(), errmax()
|
|
0 20
|
|
|
|
; a = error(10009)
|
|
|
|
; print errcount(), errmax()
|
|
1 20
|
|
; print a
|
|
Error 10009
|
|
; print iserror(a)
|
|
10009
|
|
; print strerror(a)
|
|
"Bad argument for inverse"
|
|
; print errno()
|
|
10009
|
|
|
|
; b = error(0)
|
|
|
|
; print errcount(), errmax()
|
|
1 20
|
|
; print isnull(b)
|
|
1
|
|
; print errno()
|
|
0
|
|
|
|
LIMITS
|
|
0 <= errnum <= 32767
|
|
|
|
E_STRING is C string matching the regular expression: "^E_[A-Z0-9_]+$"
|
|
|
|
LINK LIBRARY
|
|
int calc_errno; /* global calc_errno value */
|
|
|
|
SEE ALSO
|
|
errcount, errmax, errorcodes, iserror, errno, strerror, newerror,
|
|
stoponerror
|
|
|
|
## Copyright (C) 1999-2006,2023 Landon Curt Noll
|
|
##
|
|
## Calc is open software; you can redistribute it and/or modify it under
|
|
## the terms of the version 2.1 of the GNU Lesser General Public License
|
|
## as published by the Free Software Foundation.
|
|
##
|
|
## Calc 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 Lesser General
|
|
## Public License for more details.
|
|
##
|
|
## A copy of version 2.1 of the GNU Lesser General Public License is
|
|
## distributed with calc under the filename COPYING-LGPL. You should have
|
|
## received a copy with calc; if not, write to Free Software Foundation, Inc.
|
|
## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
##
|
|
## Under source code control: 1995/12/18 03:30:59
|
|
## File existed as early as: 1995
|
|
##
|
|
## chongo <was here> /\oo/\ http://www.isthe.com/chongo/
|
|
## Share and enjoy! :-) http://www.isthe.com/chongo/tech/comp/calc/
|