c_cpp/etc/calc/help/newerror

   1 NAME
   2     newerror - create or recall a described error-value
   3
   4 SYNOPSIS
   5     newerror([str])
   6
   7 TYPES
   8     str         string
   9
  10     return      error-value
  11
  12 DESCRIPTION
  13     If str is not "" and has not earlier been used as an argument for
  14     this function, newerror(str) creates a new described error-value so
  15     that any future use of newerror(str) with the same str will return
  16     the same error-value.
  17
  18     If x = newerror(str), both strerror(x) and strerror(iserro(x)) will
  19     return str and iserror(x) will return the error code value of the
  20     new error.
  21
  22     The null cases newerror() and newerror("") are equivalent to
  23     newerror("???").
  24
  25 EXAMPLE
  26     Note that by default, errmax() is 0 so unless errmax() is
  27     increased you will get:
  28
  29     ; ba = newerror("curds n' whey");
  30     Error 20000 caused errcount to exceed errmax
  31
  32     ; errmax(errcount()+5)
  33             0
  34     ; e1 = newerror("triangle side length <= 0")
  35     ; iserror(e1)
  36             20000
  37     ; error(20000)
  38             Error 20000
  39     ; strerror(error(20000))
  40             "triangle side length <= 0"
  41     ; strerror(e1);
  42             "triangle side length <= 0"
  43     ; strerror(error(iserror(e1)))
  44             "triangle side length <= 0"
  45
  46     ; define area(a,b,c) {
  47     ;;  local s;
  48     ;;  if (!(a > 0) || !(b > 0) || !(c > 0)) return e1;
  49     ;;  s = (a + b + c)/2;
  50     ;;  if (s <= a || s <= b || s <= c) return newerror("Non-triangle sides");
  51     ;;  return sqrt(s * (s - a) * (s - b) * (s - c));
  52     ;; }
  53     "area" defined
  54
  55     ; A = area(8,2,5);
  56     ; if (iserror(A)) print strerror(A) : ":", iserror(A);
  57     Non-triangle sides: 20001
  58
  59     ; A = area(-3,4,5)
  60     ; if (iserror(A)) print strerror(A) : ":", iserror(A);
  61     triangle side length <= 0: 20000
  62
  63 LIMITS
  64     The number of new described error-values is not to exceed 12767.
  65
  66 LINK LIBRARY
  67     none
  68
  69 SEE ALSO
  70     errmax, errcount, error, strerror, iserror, errno, errorcodes,
  71     stoponerror
  72
  73 ## Copyright (C) 1999-2006  Landon Curt Noll
  74 ##
  75 ## Calc is open software; you can redistribute it and/or modify it under
  76 ## the terms of the version 2.1 of the GNU Lesser General Public License
  77 ## as published by the Free Software Foundation.
  78 ##
  79 ## Calc is distributed in the hope that it will be useful, but WITHOUT
  80 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  81 ## or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
  82 ## Public License for more details.
  83 ##
  84 ## A copy of version 2.1 of the GNU Lesser General Public License is
  85 ## distributed with calc under the filename COPYING-LGPL.  You should have
  86 ## received a copy with calc; if not, write to Free Software Foundation, Inc.
  87 ## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  88 ##
  89 ## @(#) $Revision: 30.1 $
  90 ## @(#) $Id: newerror,v 30.1 2007/03/16 11:10:42 chongo Exp $
  91 ## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/newerror,v $
  92 ##
  93 ## Under source code control:   1996/04/30 03:39:56
  94 ## File existed as early as:    1996
  95 ##
  96 ## chongo <was here> /\oo/\     http://www.isthe.com/chongo/
  97 ## Share and enjoy!  :-)        http://www.isthe.com/chongo/tech/comp/calc/