01: /*
02: * Jatha - a Common LISP-compatible LISP library in Java.
03: * Copyright (C) 1997-2005 Micheal Scott Hewett
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
10: * This library is distributed in the hope that it will be useful,
11: * but WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * Lesser General Public License for more details.
14: *
15: * You should have received a copy of the GNU Lesser General Public
16: * License along with this library; if not, write to the Free Software
17: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18: *
19: *
20: * For further information, please contact Micheal Hewett at
21: * hewett@cs.stanford.edu
22: *
23: */
24:
25: package org.jatha.compile;
26:
27: import org.jatha.Jatha;
28: import org.jatha.dynatype.*;
29: import org.jatha.machine.*;
30:
31: /**
32: * <p>Gets the documentation for the object.</p>
33: * <p>(documentation symbol type)</p>
34: * <p>The type may be any symbol, but the most common ones are:</p>
35: * <ul>
36: * <li>variable (for defvar, defparameter, defconstant)</li>
37: * <li>function (for defun, defmacro)</li>
38: * <li>structure (for defstruct)</li>
39: * <li>type (for deftype)</li>
40: * <li>setf (for defsetf)</li>
41: * </ul>
42: *
43: * @author <a href="mailto:Ola.Bini@itc.ki.se">Ola Bini</a>
44: * @version $Revision: 1.4 $
45: */
46: public class DocumentationPrimitive extends LispPrimitive {
47: public DocumentationPrimitive(final Jatha lisp) {
48: super (lisp, "DOCUMENTATION", 2, 2);
49: }
50:
51: public void Execute(final SECDMachine machine) {
52: final LispValue type = machine.S.pop();
53: final LispValue sym = machine.S.pop();
54: machine.S.push(sym.documentation(type));
55: machine.C.pop();
56: }
57: }// DocumentationPrimitive
|