source: trunk/abcl/src/org/armedbear/lisp/FileError.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: 3.9 KB
Line 
1/*
2 * FileError.java
3 *
4 * Copyright (C) 2004-2005 Peter Graves
5 * $Id: FileError.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 FileError extends LispError
39{
40    // initArgs is either a normal initArgs list or a pathname.
41    public FileError(LispObject initArgs)
42    {
43        super(StandardClass.FILE_ERROR);
44        if (initArgs instanceof Cons)
45            initialize(initArgs);
46        else
47            setPathname(initArgs);
48    }
49
50    @Override
51    protected void initialize(LispObject initArgs)
52    {
53        super.initialize(initArgs);
54        LispObject pathname = NIL;
55        while (initArgs != NIL) {
56            LispObject first = initArgs.car();
57            initArgs = initArgs.cdr();
58            if (first == Keyword.PATHNAME) {
59                pathname = initArgs.car();
60                break;
61            }
62            initArgs = initArgs.cdr();
63        }
64        setPathname(pathname);
65    }
66
67    public FileError(String message)
68    {
69        super(StandardClass.FILE_ERROR);
70        setFormatControl(message.replaceAll("~","~~"));
71        setFormatArguments(NIL);
72        setPathname(NIL);
73    }
74
75    public FileError(String message, LispObject pathname)
76
77    {
78        super(StandardClass.FILE_ERROR);
79        setFormatControl(message.replaceAll("~","~~"));
80        setFormatArguments(NIL);
81        setPathname(pathname);
82    }
83
84    public LispObject getPathname()
85    {
86        return getInstanceSlotValue(Symbol.PATHNAME);
87    }
88
89    private void setPathname(LispObject pathname)
90    {
91        setInstanceSlotValue(Symbol.PATHNAME, pathname);
92    }
93
94    @Override
95    public LispObject typeOf()
96    {
97        return Symbol.FILE_ERROR;
98    }
99
100    @Override
101    public LispObject classOf()
102    {
103        return StandardClass.FILE_ERROR;
104    }
105
106    @Override
107    public LispObject typep(LispObject type)
108    {
109        if (type == Symbol.FILE_ERROR)
110            return T;
111        if (type == StandardClass.FILE_ERROR)
112            return T;
113        return super.typep(type);
114    }
115
116    // ### file-error-pathname
117    private static final Primitive FILE_ERROR_PATHNAME =
118        new Primitive("file-error-pathname", "condition")
119    {
120        @Override
121        public LispObject execute(LispObject arg)
122        {
123            if (arg.typep(Symbol.FILE_ERROR) == NIL) {
124                return type_error(arg, Symbol.FILE_ERROR);
125            }
126
127            final StandardObject obj = (StandardObject) arg;
128            return obj.getInstanceSlotValue(Symbol.PATHNAME);
129        }
130    };
131}
Note: See TracBrowser for help on using the repository browser.