APISPEC-BASE full listing

Name

APISPEC-BASE full listing -- All funcallable objects

Package Content

Methods

ADD-ATTR
 (ADD-ATTR OBJ TYPE CONST-NAME SLOT) [macro]
Description 

Basically works as add-subelement, see it's documentation. Calls create-attribute instead. The third argument differs though and is expected to be a simple string

Calls 

CONCAT-PNAMES

Location 

apispec/helpers.lisp

ADD-SUBELEMENT
 (ADD-SUBELEMENT OBJ TYPE CONST-NAME SLOT) [macro]
Description 

Is a wrapper for the function create-subelement in APISPEC-XML but is easier to use. A use may be: (add-subelement xm PTRLIST project toplevel-projects) where: xm is the name of the object var PTRLIST is the type (it is transformed into =subelement-ptrlist= for c-s) project is the name of the constant with the xml-value toplevel-projects is the name of the slot as in CLASSNAME-SLOT

Calls 

CONCAT-PNAMES

Location 

apispec/helpers.lisp

ADD-TO-CONSTR-TABLE
 (ADD-TO-CONSTR-TABLE CONST-NAME FUN-NAME) [macro]
Description 

adds an entry to the constructor table. First argument should be the constant tied to the constructor and the second should be a function taking no arguments

Calls 

CONCAT-PNAMES

Location 

apispec/helpers.lisp

ALBERT-INFO
 (ALBERT-INFO STR) [function]
Description 

Prints a format-string STR with args ARGS to *default-albert-output* with albert-prefix.

Calls 

APPLY, FORMAT and PROG2

Location 

apispec/base.lisp

ALBERT-WARN
 (ALBERT-WARN STR) [macro]
Description 

Works as WARN if *submarine-quiet* is NIL.

Location 

apispec/base.lisp

CREATE-BASICS-FOR-CLASS
 (CREATE-BASICS-FOR-CLASS NAME XML-NAME) [macro]
Description 

The name (of the class) forms the basis for all created functions. The xml-name should be a defconstant which is a string

Calls 

CONCAT-PNAMES, FIND-SYMBOL, FORMAT and SYMBOL-VALUE

Location 

apispec/helpers.lisp

CREATE-CONSTRUCTOR
 (CREATE-CONSTRUCTOR NAME) [macro]
Description 

The macro generally creates a function (constructor) named MAKE-name (where name is the first argument and name of the class) and returns an instance of the class. The constructor is also automagically exported...

Calls 

CONCAT-PNAMES

Location 

apispec/helpers.lisp

CREATE-ELEMNAME-FUN
 (CREATE-ELEMNAME-FUN NAME RETVAL) [macro]
Description 

Creates a method get-element-name where name is the class and retval is what is returned.

Calls 

CONCAT-PNAMES

Location 

apispec/helpers.lisp

CREATE-OBJ-CONSTRUCTORS
 (CREATE-OBJ-CONSTRUCTORS) [macro]
Description 

this is cmu's fault

Calls 

CONCAT-PNAMES, FIND-SYMBOL, FORMAT and SYMBOL-VALUE

Location 

apispec/helpers.lisp

DEF-OR-METHOD
 (DEF-OR-METHOD NAME PARAMS) [macro]
Description 

defines methods based on OR'ed classes. does not handle lambda-lists properly

Calls 

CONCAT-PNAMES, FORMAT, GET-SIGNATURES and MAPCAR

Location 

apispec/helpers.lisp

DEF-SDS-CLASS
 (DEF-SDS-CLASS NAME SLOTS &OPTIONAL XML-NAME) [macro]
Description 

This is a definitive monster macro. It has two required parameters; name - which names the class and ends up as MODNAME-name slots - which should be on the form (slot1 slot2 slot3) and it has an optional third: xml-name - which names the constant with the name in xml if the third argument is given, the macro create-basics-for-class is also invoked. The generated class autocreates the following info for a given SLOT (SLOT :accessor MODNAME-CLASSNAME-SLOT :initarg :SLOT :initform nil :type list) where MODNAME and CLASSNAME is obvious Oh and yes, the created class inherits from XML-Class in package APISPEC-XML. The most recent addition is that all classes, and all accessors are exported.. very convenient..

Calls 

CONCAT-PNAMES, FIND-SYMBOL, FORMAT and SYMBOL-VALUE

Location 

apispec/helpers.lisp

DEF-SDS-CONST
 (DEF-SDS-CONST NAME VAL) [macro]
Description 

Defines a constant (defconstant) named as in (get-const-name) with value val

Calls 

CONCAT-PNAMES, FIND-SYMBOL, FORMAT and SYMBOL-VALUE

Location 

apispec/helpers.lisp

DEFINE-SDS-MODULE
 (DEFINE-SDS-MODULE MOD-NAME) [macro]
Description 

Should be the first expr after the defpackage and in-package. It currently defines three things: - A constant named +sds-module-name+ with val mod-name - A hash-table for constructors named *constructors* - A function get-constructor which takes an argument name and returns a constructor from *constructors*

Calls 

CONCAT-PNAMES

Location 

apispec/helpers.lisp

DEFMETHOD-WITH-WARN
 (DEFMETHOD-WITH-WARN NAME ARGLIST) [macro]
Description 

creates a method which prints out a warning that it's not written

Calls 

FORMAT, ITS-NAME, MAPCAR, REDUCE and STRCAT

Location 

apispec/helpers.lisp

DO-ITERATION
 (DO-ITERATION NODE FUNCTION CONTEXT &KEY RECURSIVE) [generic]
Description 

Iteration function which all other quasi-iterative functions should use. The function argument should take three arguments, the node, the context and an argument specifying when it was called (:before or :after kids are processed for parents or :in for leaves). The return value \underline{can} be a keyword which can have special meaning. One such keyword is :cancel which will stop the iteration.

Called By 

REGISTER-OBJECT and VERIFY-OBJECT

Location 

apispec/base.lisp

DO-ITERATION
 (DO-ITERATION NODE FUNCTION CONTEXT &KEY (RECURSIVE T)) [method]
Calls 

ITS-NAME and WARN

Location 

apispec/base.lisp

EAT-FILE
 (EAT-FILE FILENAME) [function]
Description 

eats a whole file and returns it as a string. If the filename argument is a string, it is made into a pathname and merged with the current path, if it is a pathname it is used directly.

Called By 

FIGURE-OUT-LISP-PACKAGES and READ-ESIS-FILE

Calls 

FILE-LENGTH, MAKE-ARRAY, MERGE-PATHNAMES, PATHNAME, READ-SEQUENCE and STREAM-ELEMENT-TYPE

Location 

apispec/base.lisp

ENSURE-DIR-NAME
 (ENSURE-DIR-NAME STR) [function]
Description 

Makes sure the str has a / suffix

Called By 

TL-FIND-OUT-DIR

Calls 

CHAR and CONCATENATE

Location 

apispec/base.lisp

FIGURE-OUT-FNAME
 (FIGURE-OUT-FNAME FNAME) [function]
Description 

should be made into one line later..

Called By 

PARSE-TYPED-XML-FILE

Calls 

MERGE-PATHNAMES, NAMESTRING and PATHNAME

Location 

apispec/base.lisp

GET-CONST-NAME
 (GET-CONST-NAME NAME) [macro]
Description 

Given NAME it returns the symbol: +MOD-name-NAME+ where MOD is the name of the module

Calls 

CONCAT-PNAMES, FIND-SYMBOL, FORMAT and SYMBOL-VALUE

Location 

apispec/helpers.lisp

GET-ELEMENT-NAME
 (GET-ELEMENT-NAME XMLOBJ) [generic]
Description 

Returns a string with the element name of the xml-object

Location 

apispec/base.lisp

ITS-NAME
 (ITS-NAME OBJ) [function]
Description 

convenient way to print out info when developing

Called By 

DEFMETHOD-WITH-WARN, PROCESS-CONVERSION-DATA and PUT-OBJ-IN-REPOSITORY

Calls 

CLASS-NAME and CLASS-OF

Location 

apispec/base.lisp

MAKE-SURE-DIRS-EXIST
 (MAKE-SURE-DIRS-EXIST DIR) [function]
Description 

mostly a call to ENSURE-DIRECTORIES-EXIST, but stops errors from floating out.. returns NIL instead.

Called By 

PRESENT-SDOC

Calls 

ENSURE-DIRECTORIES-EXIST, MERGE-PATHNAMES, PATHNAME and WARN

Location 

apispec/base.lisp

MAKE-TEMPORARY-FILENAME
 (MAKE-TEMPORARY-FILENAME) [function]
Description 

Returns the name of a temporary filename

Called By 

PARSE-XML-FILE

Calls 

SYSTEM:PICK-TEMPORARY-FILE-NAME

Location 

apispec/base.lisp

MYSTRCAT
 (MYSTRCAT X Y) [function]
Description 

Basically catenates strings and tries to stringify arguments to be sure

Calls 

CONCATENATE

Location 

apispec/base.lisp

NONBOOLSYM?
 (NONBOOLSYM? SYM) [function]
Description 

returns T if SYM is a symbol but not T or NIL.

Called By 

%CREATE-CLASS and %CREATE-STRUCT

Location 

apispec/base.lisp

REGISTER-OBJECT
 (REGISTER-OBJECT OBJ CONTEXT) [generic]
Description 

registers the object with the given context

Called By 

PRESENT-SDOC

Location 

apispec/base.lisp

REGISTER-OBJECT
 (REGISTER-OBJECT OBJ CONTEXT) [method]
Calls 

ITS-NAME and WARN

Location 

apispec/base.lisp

REGISTER-OBJECT-ACTUAL
 (REGISTER-OBJECT-ACTUAL OBJ CONTEXT WHEN) [generic]
Description 

Implementation of REGISTER-OBJECT

Location 

apispec/base.lisp

RUN-EXTERNAL-PROGRAM
 (RUN-EXTERNAL-PROGRAM PROGRAM ARGS &KEY OUTFILE) [function]
Description 

Should return the int that the external program returns..

Called By 

PARSE-XML-FILE

Calls 

PROCESS-EXIT-CODE and RUN-PROGRAM

Location 

apispec/base.lisp

UNLESS-QUIET
 (UNLESS-QUIET) [macro]
Description 

Unless *submarine-quiet* is true, it executes THE-BODY.

Location 

apispec/base.lisp

VERIFY-OBJECT
 (VERIFY-OBJECT OBJ CONTEXT) [generic]
Description 

Verifies an object given a context to verify under.

Called By 

ANALYSE-FILES

Location 

apispec/base.lisp

VERIFY-OBJECT
 (VERIFY-OBJECT OBJ CONTEXT) [method]
Calls 

ITS-NAME and WARN

Location 

apispec/base.lisp

VERIFY-OBJECT-ACTUAL
 (VERIFY-OBJECT-ACTUAL OBJ CONTEXT WHEN) [generic]
Description 

Implementation of VERIFY-OBJECT

Location 

apispec/base.lisp

WIPE-FILE
 (WIPE-FILE FILENAME) [function]
Description 

deletes the file named by filename

Called By 

PARSE-XML-FILE and READ-ESIS-FILE

Calls 

DELETE-FILE, FORMAT, PROBE-FILE and WHEN-VERBOSE

Location 

apispec/base.lisp

This documentation was generated 27 Oct 2003 from the original sources by Albert v.0.4.9.