source: trunk/abcl/src/org/armedbear/lisp/PackageError.java

Last change on this file was 15519, checked in by Mark Evenson, 3 years ago

Fix and standardize all error reader functions

Fixes #388, replaces #389. The reader function stream-error-stream
signals a type-error if it's applied to conditions that's typep to
stream-error, but whose class is a subtype to stream-error:

`lisp
(define-condition broken-error (stream-error) ())

BROKEN-ERROR

(stream-error-stream (make-condition 'stream-error :stream (make-string-input-stream "foo")))

#S(SYSTEM::STRING-INPUT-STREAM)

(stream-error-stream (make-condition 'broken-error :stream (make-string-input-stream "foo")))

#<THREAD "interpreter" {2075326}>: Debugger invoked on condition of type TYPE-ERROR

The value #<BROKEN-ERROR {75A83798}> is not of type STREAM-ERROR.

`

This fault exists within these reader functions:

  • file-error-pathname (almost -- instead of a type-error, the function returns NIL instead.)
  • package-error-package
  • arithmetic-error-operation
  • arithmetic-error-operands

The fault exists because the Java code checks if its argument is
instanceof its respective Java class. So, the method will fail on any
conditions defined in CL that subclass these errors.

Furthermore, some reader functions only check if they're instanceof
StandardObject?, which allows any CLOS object to succeed as long as the
slot the primitive method is looking for exists:

  • cell-error-name
  • type-error-datum
  • type-error-expected-type

Finally, some reader functions exist in standalone Java files, while
others reside in its condition's class file, adding to some
organizational clutter.

This change fills two main jobs:

  • Standardize all reader functions to the same behavior: If the argument is typep to the right condition, return the right slot value. Otherwise, signal a type error.
  • Move standalone reader Java code to the files of errors they apply to.

As an aside, this change would make ABCL's reader functions conformant
to a wave of proposals for WSCL:

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 4.6 KB
Line 
1/*
2 * PackageError.java
3 *
4 * Copyright (C) 2003-2005 Peter Graves
5 * $Id: PackageError.java 15519 2021-09-19 08:54:57Z mevenson $
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
20 *
21 * As a special exception, the copyright holders of this library give you
22 * permission to link this library with independent modules to produce an
23 * executable, regardless of the license terms of these independent
24 * modules, and to copy and distribute the resulting executable under
25 * terms of your choice, provided that you also meet, for each linked
26 * independent module, the terms and conditions of the license of that
27 * module.  An independent module is a module which is not derived from
28 * or based on this library.  If you modify this library, you may extend
29 * this exception to your version of the library, but you are not
30 * obligated to do so.  If you do not wish to do so, delete this
31 * exception statement from your version.
32 */
33
34package org.armedbear.lisp;
35
36import static org.armedbear.lisp.Lisp.*;
37
38public final class PackageError extends LispError
39{
40    public PackageError(LispObject initArgs)
41    {
42        super(StandardClass.PACKAGE_ERROR);
43        initialize(initArgs);
44    }
45
46    @Override
47    protected void initialize(LispObject initArgs)
48    {
49        super.initialize(initArgs);
50
51        if (initArgs.listp() && initArgs.car().stringp()) {
52           setFormatControl(initArgs.car().getStringValue());
53           // When printing an error string, presumably, if the string contains
54           // a symbol, we'll want to complain about its full name, not the accessible
55           // name, because it may omit an (important) package name part.
56           // Two problems: (1) symbols can be contained in sublists
57           //               (2) symbols may not be printed, but used otherwise.
58           // ### FIXME: why special-case that here: binding *PRINT-ESCAPE* to T
59           // will do exactly this, if the reader requests it.
60           for (LispObject arg = initArgs.cdr(); arg != NIL; arg = arg.cdr()) {
61              if (arg.car() instanceof Symbol)
62                 arg.setCar(new SimpleString(((Symbol)arg.car()).getQualifiedName()));
63           }
64           setFormatArguments(initArgs.cdr());
65           setPackage(NIL);
66
67           return;
68        }
69
70        LispObject pkg = NIL;
71        LispObject first, second;
72        while (initArgs != NIL) {
73            first = initArgs.car();
74            initArgs = initArgs.cdr();
75            second = initArgs.car();
76            initArgs = initArgs.cdr();
77            if (first == Keyword.PACKAGE)
78                pkg = second;
79        }
80        setPackage(pkg);
81    }
82
83    public PackageError(String message)
84    {
85        super(StandardClass.PACKAGE_ERROR);
86        setFormatControl(message);
87        setPackage(NIL);
88    }
89
90    public PackageError(String message, LispObject pkg)
91    {
92        super(StandardClass.PACKAGE_ERROR);
93        setFormatControl(message);
94        setPackage(pkg);
95    }
96
97    @Override
98    public LispObject typeOf()
99    {
100        return Symbol.PACKAGE_ERROR;
101    }
102
103    @Override
104    public LispObject classOf()
105    {
106        return StandardClass.PACKAGE_ERROR;
107    }
108
109    @Override
110    public LispObject typep(LispObject type)
111    {
112        if (type == Symbol.PACKAGE_ERROR)
113            return T;
114        if (type == StandardClass.PACKAGE_ERROR)
115            return T;
116        return super.typep(type);
117    }
118
119    public LispObject getPackage()
120    {
121        return getInstanceSlotValue(Symbol.PACKAGE);
122    }
123
124    public void setPackage(LispObject pkg)
125    {
126        setInstanceSlotValue(Symbol.PACKAGE, pkg);
127    }
128
129    // ### package-error-package
130    private static final Primitive PACKAGE_ERROR_PACKAGE =
131        new Primitive("package-error-package", "condition")
132    {
133        @Override
134        public LispObject execute(LispObject arg)
135        {
136            if (arg.typep(Symbol.PACKAGE_ERROR) == NIL) {
137                return type_error(arg, Symbol.PACKAGE_ERROR);
138            }
139
140            final StandardObject obj = (StandardObject) arg;
141            return obj.getInstanceSlotValue(Symbol.PACKAGE);
142        }
143    };
144}
Note: See TracBrowser for help on using the repository browser.