


CLISP SOURCE(1)                                   CLISP SOURCE(1)


AABBOOUUTT
       The source files for CLISP.



FFIILLEE TTYYPPEESS
       **..dd    The source files for unpreprocessed C code.


       **..cc    The C code after preprocessing.  They depend on the
              preprocessor: ansidecl or traddecl.


       **..llsspp  The source files for lisp code.


       **..ffaass  Compiled lisp code. Depends on the machine on which
              CLISP  runs  and  (perhaps) on the compiler used to
              build CLISP.



FFIILLEESS
       Unpreprocessed C code:


           Includes:


               lliissppbbiibbll..dd     main include file

               ffssuubbrr..dd        list of all built-in special forms

               ssuubbrr..dd         list of all built-in functions

               ppsseeuuddooffuunn..dd    list of all "pseudo functions"

               ccoonnssttssyymm..dd     list of symbols accessed by C code

               ccoonnssttoobbjj..dd     list   of   miscellaneous   objects
                              accessed by C code

               uunniixx..dd         include  file  for unix implementa-
                              tions

               aattaarrii..dd        include file for Atari/TOS version

               aammiiggaa..dd        include file for Amiga/AmigaOS ver-
                              sion

               aammiiggaa22..dd       second     include     file     for
                              Amiga/AmigaOS version

               mmssddooss..dd        include file  for  MS-DOS  or  OS/2



                          6 January 1993                        1





CLISP SOURCE(1)                                   CLISP SOURCE(1)


                              based versions


           Modules:

               ssppvvww..dd         Memory  management (garbage collec-
                              tion), startup. some OS  interface.

                   aavvll..dd      An implementation of AVL trees.

                   ssoorrtt..dd     A sorting routine.

               ssppvvwwttaabbff..dd     Table of built-in special forms and
                              functions.

               ssppvvwwttaabbss..dd     Table  of  symbols  accessed  by  C
                              code.

               ssppvvwwttaabboo..dd     Table   of   miscellaneous  objects
                              accessed by C code.

               eevvaall..dd         Evaluator  (form  interpreter)  and
                              bytecode interpreter.

               ccoonnttrrooll..dd      Special forms (form interpreter).

               ppaatthhnnaammee..dd     Pathnames,   file-  and  directory-
                              related functions.

               ssttrreeaamm..dd       Streams of all kinds: file streams,
                              terminal   stream,  string  streams
                              etc.

               ssoocckkeett..dd       Opening sockets for CLX.

               iioo..dd           The  lisp   reader   (parser)   and
                              printer (also pretty printer).

               aarrrraayy..dd        Functions  dealing  with arrays and
                              vectors.

               hhaasshhttaabbll..dd     Functions dealing with hash tables.

               lliisstt..dd         Functions dealing with lists.

               ppaacckkaaggee..dd      Functions dealing with packages.

               rreeccoorrdd..dd       Functions   dealing   with  records
                              (structures, closures, etc.)

               sseeqquueennccee..dd     The generic sequence functions.

               cchhaarrssttrrgg..dd     Functions dealing  with  characters
                              and strings.



                          6 January 1993                        2





CLISP SOURCE(1)                                   CLISP SOURCE(1)


               ddeebbuugg..dd        Support for debugging and the read-
                              eval-print loop.

               mmiisscc..dd         Miscellaneous functions, error sig-
                              nalling.

               pprreeddttyyppee..dd     Predicates, type tests.

               ssyymmbbooll..dd       Functions dealing with symbols.

               rreexxxx..dd         Low-level   Rexx  interface  (Amiga
                              version only).

               lliissppaarriitt00..dd    Functions  dealing   with   numbers
                              (arithmetic).

               nnoorreeaaddlliinnee..dd   Replacement    for   GNU   readline
                              library.

               ddbbxxttyyppeess..dd     Declaration of types for  use  with
                              SUN's dbx (Sun version only).

               aallgglloobbaall..dd     Declaration of all global variables
                              of the library (Atari  TOS  version
                              only).

               mmaaiinn..dd         Declaration  of auxiliary functions
                              for use with Gcc 2.


           Number system (arithmetic):

               lliissppaarriitt..dd     initialization,   input/output   of
                              numbers, lisp functions

               aarriiddeeccll..dd      declarations

               aarriilleevv00..dd      arithmetic at the machine level

               aarriilleevv11..dd      digit sequences

               aarriilleevv11cc..dd     operations   on   digit  sequences,
                              written in C

               aarriilleevv11ii..dd     operations on digit  sequences,  as
                              inline functions

               aarriilleevv11ee..dd     operations   on   digit  sequences,
                              bindings to external routines

               iinntteelleemm..dd      integers: elementary operations

               iinnttlloogg..dd       integers: logical connectives




                          6 January 1993                        3





CLISP SOURCE(1)                                   CLISP SOURCE(1)


               iinnttpplluuss..dd      integers: addition and subtraction

               iinnttccoommpp..dd      integers: comparison

               iinnttbbyyttee..dd      integers:  byte   operations   _l_d_b,
                              _l_o_a_d_-_b_y_t_e, ...

               iinnttmmaall..dd       integers: multiplication

               iinnttddiivv..dd       integers: division

               iinnttggccdd..dd       integers: gcd and lcm

               iinntt22aaddiicc..dd     integers:   operations   on  2-adic
                              integers

               iinnttssqqrrtt..dd      integers: square root, n-th root

               iinnttpprriinntt..dd     subroutines for integer output

               iinnttrreeaadd..dd      subroutines for integer input

               rraattiioonnaall..dd     rational numbers

               ssffllooaatt..dd       elementary  operations  for   short
                              floats

               ffffllooaatt..dd       elementary  operations  for  single
                              floats

               ddffllooaatt..dd       elementary  operations  for  double
                              floats

               llffllooaatt..dd       elementary   operations   for  long
                              floats

               fflloo__kkoonnvv..dd     conversions between floats

               fflloo__rreesstt..dd     general float operations

               rreeaalleelleemm..dd     elementary functions for real  num-
                              bers

               rreeaallrraanndd..dd     random numbers

               rreeaallttrraann..dd     transcendental  functions  for real
                              numbers

               ccoommppeelleemm..dd     elementary  functions  for  complex
                              numbers

               ccoommppttrraann..dd     transcendental  functions  for com-
                              plex numbers




                          6 January 1993                        4





CLISP SOURCE(1)                                   CLISP SOURCE(1)


           External routines for the arithmetic system, written
               in  assembly language:

               aarrii6688000000..mmiitt..dd      written  in  68000  assembler,
                                   MIT syntax

               aarrii6688000000..mmoott..dd      written  in  68000  assembler,
                                   Motorola syntax

               aarrii6688000000..aattaarrii..dd    written  in  68000  assembler,
                                   MIT syntax, use this for Atari
                                   version

               aarrii6688002200..mmiitt..dd      written  in  68020  assembler,
                                   MIT syntax

               aarrii6688002200..mmoott..dd      written  in  68020  assembler,
                                   Motorola syntax

               aarriissppaarrcc..dd          written in SPARC assembler

               aarrii8800338866..dd          written in i386/i486 assembler

               aarriimmiippss..dd           written in MIPS assembler

               aarriihhppppaa..dd           written in HPPA-1.0 assembler


           External  routines  for  accessing the stack, written
               in assembly language:

               sspp6688000000..mmiitt..dd       written  in  68000  assembler,
                                   MIT syntax

               sspp6688000000..mmoott..dd       written  in  68000  assembler,
                                   Motorola syntax

               ssppssppaarrcc..dd           written in SPARC assembler

               sspp8800338866..dd           written in i386/i486 assembler

               ssppmmiippss..dd            written in MIPS assembler



       Other assembly language stuff:

           cccc__ssppaarrcc..iill
                  lisp stack access in SPARC assembler,  for  use
                  with Sun's cc


       Lisp source files:




                          6 January 1993                        5





CLISP SOURCE(1)                                   CLISP SOURCE(1)


           iinniitt..llsspp
                  first file to be loaded, loads everything else

           ddeeffsseeqq..llsspp
                  defines   the  usual  sequence  types  for  the
                  generic sequence functions

           bbaacckkqquuoott..llsspp
                  implements the backquote read macro

           ddeeffmmaaccrroo..llsspp
                  implements _d_e_f_m_a_c_r_o

           mmaaccrrooss11..llsspp
                  the most important macros

           mmaaccrrooss22..llsspp
                  some other macros

           ddeeffss11..llsspp
                  miscellaneaous definitions

           ppllaacceess..llsspp
                  macros using places, definitions of most places

           ffllooaattpprrii..llsspp
                  printing floating point numbers in base 10

           ttyyppee..llsspp
                  functions  working with type specifiers: _t_y_p_e_p,
                  _s_u_b_t_y_p_e_p

           ddeeffssttrruucc..llsspp
                  implements the _d_e_f_s_t_r_u_c_t macro

           ffoorrmmaatt..llsspp
                  implements _f_o_r_m_a_t

           uusseerr11..llsspp
                  user interface, from the system's point of view

           uusseerr22..llsspp
                  user interface, from the user's point of view

           ttrraaccee..llsspp
                  tracer

           mmaaccrrooss33..llsspp
                  (optional)  the  macros  _l_e_t_f,  _l_e_t_f_*  and _n_t_h_-
                  _v_a_l_u_e.

           ccoonnffiigg..llsspp
                  (user  written)  site-dependent  configuration,
                  may be a link to one of the following:



                          6 January 1993                        6





CLISP SOURCE(1)                                   CLISP SOURCE(1)


                  ccffgglliinnuuxx..llsspp   for Unix, using Linux

                  ccffggssuunnuuxx..llsspp   for Unix, using SunOS

                  ccffgguunniixx..llsspp    for any other Unix

                  ccffggaattffdd..llsspp    for Atari, using floppy disk A:

                  ccffggaatthhdd..llsspp    for Atari, using hard disk E:

                  ccffggaammiiggaa..llsspp   for Amiga

                  ccffggddooss..llsspp     for MS-DOS version

           ccoommppiilleerr..llsspp
                  compiles lisp code to bytecode

           rreexxxx..llsspp
                  for Amiga, an interface to Rexx

           eeddiittoorr..llsspp
                  (optional) the screen editor


       Documentation:


           FFIILLEESS  lists the source files

           FFIILLEESS..11
                  nroff master for _F_I_L_E_S

           __RREEAADDMMEE
                  master for the distribution's README

           __cclliisspp..11
                  master for the distribution's manual page

           __iimmppnnootteess..ttxxtt
                  master  for  the  distribution's implementation
                  notes


       Automatic configuration on Unix:


           ccoonnffiigguurree..iinn
                  lists the features to be checked

           uussrr..llooccaall..lliibb..aaccllooccaall..mm44
                  a repertoire of features. Use  with  GNU  auto-
                  conf-1,2, install as /usr/local/lib/aclocal.m4





                          6 January 1993                        7





CLISP SOURCE(1)                                   CLISP SOURCE(1)


           ccoonnffiigguurree
                  configuration script, checks for dozens of fea-
                  tures

           mmaacchhiinnee..dd
                  figures out some machine parameters (word size,
                  endianness etc.)

           mmaacchhiinnee..cc
                  preprocessed version of _m_a_c_h_i_n_e_._d

           uunniixxccoonnff..hh..iinn
                  header  file  master.  unixconf.h  contains the
                  values of the features found out by  configure.

           mmaakkeemmaakkee..iinn
                  makefile construction script master








































                          6 January 1993                        8


