home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #20 / NN_1992_20.iso / spool / comp / lang / lisp / 2419 < prev    next >
Encoding:
Internet Message Format  |  1992-09-12  |  31.0 KB

  1. Xref: sparky comp.lang.lisp:2419 news.answers:2882
  2. Path: sparky!uunet!ogicse!das-news.harvard.edu!cantaloupe.srv.cs.cmu.edu!crabapple.srv.cs.cmu.edu!mkant
  3. From: mkant+@cs.cmu.edu (Mark Kantrowitz)
  4. Newsgroups: comp.lang.lisp,news.answers
  5. Subject: FAQ: Lisp Frequently Asked Questions 3/5 [Monthly posting]
  6. Summary: Common Pitfalls
  7. Message-ID: <lisp-faq-3.text_716371264@cs.cmu.edu>
  8. Date: 13 Sep 92 08:01:11 GMT
  9. Article-I.D.: cs.lisp-faq-3.text_716371264
  10. Expires: Tue, 27 Oct 1992 08:01:04 GMT
  11. Sender: news@cs.cmu.edu (Usenet News System)
  12. Reply-To: lisp-faq@think.com
  13. Followup-To: poster
  14. Organization: School of Computer Science, Carnegie Mellon
  15. Lines: 680
  16. Approved: news-answers-request@MIT.Edu
  17. Supersedes: <lisp-faq-3.text_713752722@cs.cmu.edu>
  18. Nntp-Posting-Host: a.gp.cs.cmu.edu
  19.  
  20. Archive-name: lisp-faq/part3
  21. Last-Modified: Wed Aug 19 21:38:21 1992 by Mark Kantrowitz
  22. Version: 1.23
  23.  
  24. ;;; ****************************************************************
  25. ;;; Answers to Frequently Asked Questions about Lisp ***************
  26. ;;; ****************************************************************
  27. ;;; Written by Mark Kantrowitz and Barry Margolin
  28. ;;; lisp-faq-3.text -- 31103 bytes
  29.  
  30. This post contains Part 3 of the Lisp FAQ.
  31.  
  32. If you think of questions that are appropriate for this FAQ, or would
  33. like to improve an answer, please send email to us at lisp-faq@think.com.
  34.  
  35. This section contains a list of common pitfalls. Pitfalls are aspects
  36. of Common Lisp which are non-obvious to new programmers and often
  37. seasoned programmers as well.
  38.  
  39. Common Pitfalls (Part 3):
  40.  
  41.   [3-0]  Why does (READ-FROM-STRING "foobar" :START 3) return FOOBAR
  42.          instead of BAR?  
  43.   [3-1]  Why can't it deduce from (READ-FROM-STRING "foobar" :START 3)
  44.          that the intent is to specify the START keyword parameter
  45.          rather than the EOF-ERROR-P and EOF-VALUE optional parameters?   
  46.   [3-2]  Why can't I apply #'AND and #'OR?
  47.   [3-3]  I used a destructive function (e.g. DELETE, SORT), but it
  48.          didn't seem to work.  Why? 
  49.   [3-4]  After I NREVERSE a list, it's only one element long.  After I
  50.          SORT a list, it's missing things.  What happened? 
  51.   [3-5]  Why does (READ-LINE) return "" immediately instead of waiting
  52.          for me to type a line?  
  53.   [3-6]  I typed a form to the read-eval-print loop, but nothing happened. Why?
  54.   [3-7]  DEFMACRO doesn't seem to work.
  55.          When I compile my file, LISP warns me that my macros are undefined
  56.          functions, or complains "Attempt to call <function> which is 
  57.          defined as a macro.
  58.   [3-8]  Name conflict errors are driving me crazy! (EXPORT, packages)
  59.   [3-9]  Closures don't seem to work properly when referring to the
  60.          iteration variable in DOLIST, DOTIMES and DO.
  61.   [3-10] What is the difference between FUNCALL and APPLY?
  62.   [3-11] Miscellaneous things to consider when debugging code.
  63.   [3-12] When is it right to use EVAL?
  64.   [3-13] Why does my program's behavior change each time I use it?
  65.   [3-14] When producing formatted output in Lisp, where should you put the
  66.          newlines (e.g., before or after the line, FRESH-LINE vs TERPRI,
  67.          ~& vs ~% in FORMAT)?
  68.  
  69. Search for [#] to get to question number # quickly.
  70.  
  71. ----------------------------------------------------------------
  72. [3-0] Why does (READ-FROM-STRING "foobar" :START 3) return FOOBAR instead 
  73.       of BAR?
  74.  
  75. READ-FROM-STRING is one of the rare functions that takes both &OPTIONAL and
  76. &KEY arguments:
  77.  
  78.        READ-FROM-STRING string &OPTIONAL eof-error-p eof-value 
  79.                                &KEY :start :end :preserve-whitespace
  80.  
  81. When a function takes both types of arguments, all the optional
  82. arguments must be specified explicitly before any of the keyword
  83. arguments may be specified.  In the example above, :START becomes the
  84. value of the optional EOF-ERROR-P parameter and 3 is the value of the
  85. optional EOF-VALUE parameter.
  86.      
  87. ----------------------------------------------------------------
  88. [3-1] Why can't it deduce from (READ-FROM-STRING "foobar" :START 3) that
  89.       the intent is to specify the START keyword parameter rather than
  90.       the EOF-ERROR-P and EOF-VALUE optional parameters?
  91.  
  92. In Common Lisp, keyword symbols are first-class data objects.  Therefore,
  93. they are perfectly valid values for optional parameters to functions.
  94. There are only four functions in Common Lisp that have both optional and
  95. keyword parameters (they are PARSE-NAMESTRING, READ-FROM-STRING,
  96. WRITE-LINE, and WRITE-STRING), so it's probably not worth adding a
  97. nonorthogonal kludge to the language just to make these functions slightly
  98. less confusing; unfortunately, it's also not worth an incompatible change
  99. to the language to redefine those functions to use only keyword arguments.
  100.      
  101. ----------------------------------------------------------------
  102. [3-2] Why can't I apply #'AND and #'OR?
  103.  
  104. Here's the simple, but not necessarily satisfying, answer: AND and OR are
  105. macros, not functions; APPLY and FUNCALL can only be used to invoke
  106. functions, not macros and special operators.
  107.  
  108. OK, so what's the *real* reason?  The reason that AND and OR are macros
  109. rather than functions is because they implement control structure in
  110. addition to computing a boolean value.  They evaluate their subforms
  111. sequentially from left/top to right/bottom, and stop evaluating subforms as
  112. soon as the result can be determined (in the case of AND, as soon as a
  113. subform returns NIL; in the case of OR, as soon as one returns non-NIL);
  114. this is referred to as "short circuiting" in computer language parlance.
  115. APPLY and FUNCALL, however, are ordinary functions; therefore, their
  116. arguments are evaluated automatically, before they are called.  Thus, were
  117. APPLY able to be used with #'AND, the short-circuiting would be defeated.
  118.  
  119. Perhaps you don't really care about the short-circuiting, and simply want
  120. the functional, boolean interpretation.  While this may be a reasonable
  121. interpretation of trying to apply AND or OR, it doesn't generalize to other
  122. macros well, so there's no obvious way to have the Lisp system "do the
  123. right thing" when trying to apply macros.  The only function associated
  124. with a macro is its expander function; this function accepts and returns
  125. and form, so it cannot be used to compute the value.
  126.  
  127. The Common Lisp functions EVERY and SOME can be used to get the
  128. functionality you intend when trying to apply #'AND and #'OR.  For
  129. instance, the erroneous form:
  130.  
  131.    (apply #'and *list*)
  132.  
  133. can be translated to the correct form:
  134.  
  135.    (every #'identity *list*)
  136.  
  137. ----------------------------------------------------------------
  138. [3-3] I used a destructive function (e.g. DELETE, SORT), but it didn't seem to
  139.       work.  Why?
  140.  
  141. I assume you mean that it didn't seem to modify the original list.  There
  142. are several possible reasons for this.  First, many destructive functions
  143. are not *required* to modify their input argument, merely *allowed* to; in
  144. some cases, the implementation may determine that it is more efficient to
  145. construct a new result than to modify the original (this may happen in Lisp
  146. systems that use "CDR coding", where RPLACD may have to turn a CDR-NEXT or
  147. CDR-NIL cell into a CDR-NORMAL cell), or the implementor may simply not
  148. have gotten around to implementing the destructive version in a truly
  149. destructive manner.  Another possibility is that the nature of the change
  150. that was made involves removing elements from the front of a list; in this
  151. case, the function can simply return the appropriate tail of the list,
  152. without actually modifying the list. And example of this is:
  153.      
  154.    (setq *a* (list 3 2 1))
  155.    (delete 3 *a*) => (2 1)
  156.    *a* => (3 2 1)
  157.  
  158. Similarly, when one sorts a list, SORT may destructively rearrange the
  159. pointers (cons cells) that make up the list. SORT then returns the cons
  160. cell that now heads the list; the original cons cell could be anywhere in
  161. the list. The value of any variable that contained the original head of the
  162. list hasn't changed, but the contents of that cons cell have changed
  163. because SORT is a destructive function:
  164.  
  165.    (setq *a* (list 2 1 3))
  166.    (sort *a* #'<) => (1 2 3)
  167.    *a* => (2 3)     
  168.  
  169. In both cases, the remedy is the same: store the result of the
  170. function back into the place whence the original value came, e.g.
  171.  
  172.    (setq *a* (delete 3 *a*))
  173.    *a* => (2 1)
  174.  
  175. Why don't the destructive functions do this automatically?  Recall that
  176. they are just ordinary functions, and all Lisp functions are called by
  177. value.  Therefore, these functions do not know where the lists they are
  178. given came from; they are simply passed the cons cell that represents the
  179. head of the list. Their only obligation is to return the new cons cell that
  180. represents the head of the list.
  181.  
  182. One thing to be careful about when doing this is that the original list
  183. might be referenced from multiple places, and all of these places may need
  184. to be updated.  For instance:
  185.  
  186.    (setq *a* (list 3 2 1))
  187.    (setq *b* *a*)
  188.    (setq *a* (delete 3 *a*))
  189.    *a* => (2 1)
  190.    *b* => (3 2 1) ; *B* doesn't "see" the change
  191.    (setq *a* (delete 1 *a*))
  192.    *a* => (2)
  193.    *b* => (3 2) ; *B* sees the change this time, though
  194.  
  195. One may argue that destructive functions could do what you expect by
  196. rearranging the CARs of the list, shifting things up if the first element
  197. is being deleted, as they are likely to do if the argument is a vector
  198. rather than a list.  In many cases they could do this, although it would
  199. clearly be slower.  However, there is one case where this is not possible:
  200. when the argument or value is NIL, and the value or argument, respectively,
  201. is not.  It's not possible to transform the object referenced from the
  202. original cell from one data type to another, so the result must be stored
  203. back.  Here are some examples:
  204.  
  205.    (setq *a* (list 3 2 1))
  206.    (delete-if #'numberp *a) => NIL
  207.    *a* => (3 2 1)
  208.    (setq *a* nil *b* '(1 2 3))
  209.    (nconc *a* *b*) => (1 2 3)
  210.    *a* => NIL
  211.  
  212. The names of most destructure functions (except for sort, delete,
  213. rplaca, rplacd, and setf of accessor functions) have the prefix N.
  214.  
  215. In summary, the two common problems to watch out for when using
  216. destructive functions are:
  217.  
  218.    1. Forgetting to store the result back. Even though the list
  219.       is modified in place, it is still necessary to store the
  220.       result of the function back into the original location, e.g.,
  221.            (setq foo (delete 'x foo))
  222.  
  223.       If the original list was stored in multiple places, you may
  224.       need to store it back in all of them, e.g.
  225.            (setq bar foo)
  226.            ...
  227.            (setq foo (delete 'x foo))
  228.            (setq bar foo)
  229.  
  230.    2. Sharing structure that gets modified. If it is important
  231.       to preserve the shared structure, then you should either
  232.       use a nondestructive operation or copy the structure first
  233.       using COPY-LIST or COPY-TREE.
  234.            (setq bar (cdr foo))
  235.            ...
  236.            (setq foo (sort foo #'<))
  237.            ;;; now it's not safe to use BAR
  238.  
  239. Note that even nondestructive functions, such as REMOVE, and UNION,
  240. can return a result which shares structure with an argument. 
  241. Nondestructive functions don't necessarily copy their arguments; they
  242. just don't modify them.
  243.      
  244. ----------------------------------------------------------------
  245. [3-4] After I NREVERSE a list, it's only one element long.  After I SORT
  246.       a list, it's missing things.  What happened?
  247.  
  248. These are particular cases of the previous question.  Many NREVERSE and
  249. SORT implementations operate by rechaining all the CDR links in the list's
  250. backbone, rather than by replacing the CARs.  In the case of NREVERSE, this
  251. means that the cons cell that was originally first in the list becomes the
  252. last one.  As in the last question, the solution is to store the result
  253. back into the original location.
  254.      
  255. ----------------------------------------------------------------
  256. [3-5] Why does (READ-LINE) return "" immediately instead of waiting for
  257.       me to type a line?
  258.  
  259. Many Lisp implementations on line-buffered systems do not discard the
  260. newline that the user must type after the last right parenthesis in order
  261. for the line to be transmitted from the OS to Lisp.  Lisp's READ function
  262. returns immediately after seeing the matching ")" in the stream.  When
  263. READLINE is called, it sees the next character in the stream, which is a
  264. newline, so it returns an empty line.  If you were to type "(read-line)This
  265. is a test" the result would be "This is a test".
  266.  
  267. The simplest solution is to use (PROGN (CLEAR-INPUT) (READ-LINE)).  This
  268. discards the buffered newline before reading the input.  However, it would
  269. also discard any other buffered input, as in the "This is a test" example
  270. above; some implementation also flush the OS's input buffers, so typeahead
  271. might be thrown away.
  272.  
  273. ----------------------------------------------------------------
  274. [3-6] I typed a form to the read-eval-print loop, but nothing happened. Why?
  275.  
  276. There's not much to go on here, but a common reason is that you haven't
  277. actually typed a complete form.  You may have typed a doublequote, vertical
  278. bar, "#|" comment beginning, or left parenthesis that you never matched
  279. with another doublequote, vertical bar, "|#", or right parenthesis,
  280. respectively.  Try typing a few right parentheses followed by Return.
  281.  
  282. ----------------------------------------------------------------
  283. [3-7]  DEFMACRO doesn't seem to work. 
  284.        When I compile my file, LISP warns me that my macros are undefined
  285.        functions, or complains "Attempt to call <function> which is 
  286.        defined as a macro.
  287.  
  288. When you evaluate a DEFMACRO form or proclaim a function INLINE, it
  289. doesn't go back and update code that was compiled under the old
  290. definition. When redefining a macro, be sure to recompile any
  291. functions that use the macro. Also be sure that the macros used in a
  292. file are defined before any forms in the same file that use them.
  293.  
  294. Certain forms, including LOAD, SET-MACRO-CHARACTER, and
  295. REQUIRE, are not normally evaluated at compile time. Common Lisp
  296. requires that macros defined in a file be used when compiling later
  297. forms in the file. If a Lisp doesn't follow the standard, it may be
  298. necessary to wrap an EVAL-WHEN form around the macro definition.
  299.  
  300. Most often the "macro was previously called as a function" problem
  301. occurs when files were compiled/loaded in the wrong order. For
  302. example, developers may add the definition to one file, but use it in
  303. a file which is compiled/loaded before the definition. To work around
  304. this problem, one can either fix the modularization of the system, or
  305. manually recompile the files containing the forward references to macros.
  306.  
  307. Also, if your macro calls functions at macroexpand time, those functions
  308. may need to be in an EVAL-WHEN. For example,
  309.  
  310.     (defun some-function (x)
  311.       x)
  312.  
  313.     (defmacro some-macro (y)
  314.       (let ((z (some-function y)))
  315.     `(print ',z)))
  316.  
  317. If the macros are defined in a file you require, make sure your
  318. require or load statement is in an appropriate EVAL-WHEN. Many people
  319. avoid all this nonsense by making sure to load all their files before
  320. compiling them, or use a system facility (or just a script file) that
  321. loads each file before compiling the next file in the system.
  322.  
  323. ----------------------------------------------------------------
  324. [3-8]  Name conflict errors are driving me crazy! (EXPORT, packages)
  325.  
  326. If a package tries to export a symbol that's already defined, it will
  327. report an error. You probably tried to use a function only to discover
  328. that you'd forgotten to load its file. The failed attempt at using the
  329. function caused its symbol to be interned. So now, when you try to
  330. load the file, you get a conflict. Unfortunately, understanding and
  331. correcting the code which caused the export problem doesn't make those
  332. nasty error messages go away. That symbol is still interned where it
  333. shouldn't be. Use unintern to remove the symbol from a package before
  334. reloading the file. Also, when giving arguments to REQUIRE or package
  335. functions, use strings or keywords, not symbols: (find-package "FOO"),
  336. (find-package :foo). 
  337.  
  338. A sometimes useful technique is to rename (or delete) a package
  339. that is "too messed up".  Then you can reload the relevant files
  340. into a "clean" package.
  341.  
  342. ----------------------------------------------------------------
  343. [3-9]  Closures don't seem to work properly when referring to the
  344.        iteration variable in DOLIST, DOTIMES and DO.
  345.  
  346. DOTIMES, DOLIST, and DO all use assignment instead of binding to
  347. update the value of the iteration variables. So something like
  348.  
  349.    (dotimes (n 10)
  350.      (push #'(lambda () (incf n))
  351.            *counters*))
  352.  
  353. will produce 10 closures over the same value of the variable N.
  354. ----------------------------------------------------------------
  355. [3-10] What is the difference between FUNCALL and APPLY?
  356.  
  357. FUNCALL is useful when the programmer knows the length of the argument
  358. list, but the function to call is either computed or provided as a
  359. parameter.  For instance, a simple implementation of MEMBER-IF (with
  360. none of the fancy options) could be written as:
  361.  
  362. (defun member-if (predicate list)
  363.   (do ((tail list (cdr tail)))
  364.       ((null tail))
  365.    (when (funcall predicate (car tail))
  366.      (return-from member-if tail))))
  367.  
  368. The programmer is invoking a caller-supplied function with a known
  369. argument list.
  370.  
  371. APPLY is needed when the argument list itself is supplied or computed.
  372. Its last argument must be a list, and the elements of this list become
  373. individual arguments to the function.  This frequently occurs when a
  374. function takes keyword options that will be passed on to some other
  375. function, perhaps with application-specific defaults inserted.  For
  376. instance:
  377.  
  378. (defun open-for-output (pathname &rest open-options)
  379.   (apply #'open pathname :direction :output open-options))
  380.  
  381. FUNCALL could actually have been defined using APPLY:
  382.  
  383. (defun funcall (function &rest arguments)
  384.   (apply function arguments))
  385.  
  386. ----------------------------------------------------------------
  387. [3-11] Miscellaneous things to consider when debugging code.
  388.  
  389. This question lists a variety of problems to watch out for when
  390. debugging code. This is sort of a catch-all question for problems too
  391. small to merit a question of their own. See also question [1-2] for
  392. some other common problems.
  393.  
  394. Functions:
  395.  
  396.   * (flet ((f ...)) (eq #'f #'f)) can return false.
  397.  
  398.   * The function LIST-LENGTH is not a faster, list-specific version
  399.     of the sequence function LENGTH.  It is list-specific, but it's
  400.     slower than LENGTH because it can handle circular lists.
  401.  
  402.   * Don't confuse the use of LISTP and CONSP. CONSP tests for the
  403.     presence of a cons cell, but will return NIL when called on NIL.
  404.     LISTP could be defined as (defun listp (x) (or (null x) (consp x))).
  405.  
  406.   * Use the right test for equality: 
  407.     EQ     tests if the objects are identical -- numbers with the
  408.         same value need not be EQ, nor are two similar lists
  409.         necessarily EQ. Similarly for characters and strings.
  410.         For instance, (let ((x 1)) (eq x x)) is not guaranteed
  411.         to return T.
  412.     EQL    Like EQ, but is also true if the arguments are numbers
  413.         of the same type with the same value or character objects
  414.         representing the same character. (eql -0.0 0.0) is not
  415.         guaranteed to return T.
  416.     EQUAL    Tests if the arguments are structurally isomorphic, using
  417.         EQUAL to compare components that conses, arrays, strings
  418.         or pathnames, and EQ for all other data objects
  419.         (except for numbers and characters, which are compared
  420.         using EQL). 
  421.     EQUALP     Like EQUAL, but ignores type differences when comparing 
  422.         numbers and case differences when comparing characters.
  423.     =    Compares the values of two numbers even if they are of
  424.         different types.
  425.     CHAR=    Case-sensitive comparison of characters.
  426.     CHAR-EQUAL    Case-insensitive comparison of characters.
  427.     STRING=    Compares two strings, checking if they are identical.
  428.         It is case sensitive.
  429.     STRING-EQUAL  Like STRING=, but case-insensitive.
  430.  
  431.   * Some destructive functions that you think would modify CDRs might
  432.     modify CARs instead.  (E.g., NREVERSE.)
  433.  
  434.   * READ-FROM-STRING has some optional arguments before the
  435.     keyword parameters.  If you want to supply some keyword
  436.     arguments, you have to give all of the optional ones too.
  437.  
  438.   * If you use the function READ-FROM-STRING, you should probably bind
  439.     *READ-EVAL* to NIL. Otherwise an unscrupulous user could cause a
  440.     lot of damage by entering 
  441.     #.(shell "cd; rm -R *")
  442.     at a prompt.
  443.  
  444.   * Only functional objects can be funcalled in CLtL2, so a lambda
  445.     expression '(lambda (..) ..) is no longer suitable. Use
  446.     #'(lambda (..) ..) instead. If you must use '(lambda (..) ..),
  447.     coerce it to type FUNCTION first using COERCE.
  448.  
  449. Methods:
  450.  
  451.   * PRINT-OBJECT methods can make good code look buggy. If there is a
  452.     problem with the PRINT-OBJECT methods for one of your classes, it
  453.     could make it seem as though there were a problem with the object.
  454.     It can be very annoying to go chasing through your code looking for
  455.     the cause of the wrong value, when the culprit is just a bad
  456.     PRINT-OBJECT method.
  457.  
  458. Initialization:
  459.  
  460.   * Don't count on array elements being initialized to NIL, if you don't
  461.     specify an :initial-element argument to MAKE-ARRAY. For example,
  462.          (make-array 10) => #(0 0 0 0 0 0 0 0 0 0)
  463.  
  464. Iteration vs closures:
  465.  
  466.   * DO and DO* update the iteration variables by assignment; DOLIST and
  467.     DOTIMES are allowed to use assignment (rather than a new binding).
  468.     (All CLtL says of DOLIST and DOTIMES is that the variable "is
  469.     bound" which has been taken as _not_ implying that there will be
  470.     separate bindings for each iteration.) 
  471.  
  472.     Consequently, if you make closures over an iteration variable
  473.     in separate iterations they may nonetheless be closures over
  474.     the same variable and hence will all refer to the same value
  475.     -- whatever value the variable was given last.  For example,
  476.     (let ((fns '()))
  477.       (do ((x '(1 2) (cdr x)))
  478.           ((null x))
  479.         (push #'(lambda () x)
  480.           fns))
  481.       (mapcar #'funcall (reverse fns)))
  482.     returns (nil nil), not (1 2), not even (2 2). Thus 
  483.      (let ((l nil)) (dolist (a '(1 2 3) l) (push #'(lambda () a l))))
  484.     returns a list of three closures closed over the same bindings, whereas
  485.          (mapcar #'(lambda (a) #'(lambda () a)) '(1 2 3))
  486.     returns a list of closures over distinct bindings.
  487.  
  488. Defining Variables and Constants:
  489.  
  490.   * (defvar var init) assigns to the variable only if it does not
  491.     already have a value.  So if you edit a DEFVAR in a file and
  492.     reload the file only to find that the value has not changed,
  493.     this is the reason.  (Use DEFPARAMETER if you want the value
  494.     to change upon reloading.) DEFVAR is used to declare a variable
  495.     that is changed by the program; DEFPARAMETER is used to declare
  496.     a variable that is normally constant, but which can be changed
  497.     to change the functioning of a program.
  498.  
  499.   * DEFCONSTANT has several potentially unexpected properties:
  500.  
  501.      - Once a name has been declared constant, it cannot be used a
  502.        the name of a local variable (lexical or special) or function
  503.        parameter.  Really.  See page 87 of CLtL II.
  504.  
  505.      - A DEFCONSTANT cannot be re-evaluated (eg, by reloading the
  506.        file in which it appears) unless the new value is EQL to the
  507.        old one.  Strictly speaking, even that may not be allowed.
  508.        (DEFCONSTANT is "like DEFPARAMETER" and hence does an
  509.        assignment, which is not allowed if the name has already
  510.        been declared constant by DEFCONSTANT.)
  511.  
  512.        Note that this makes it difficult to use anything other
  513.        than numbers, symbols, and characters as constants.       
  514.  
  515.      - When compiling (DEFCONSTANT name form) in a file, the form
  516.        may be evaluated at compile-time, load-time, or both.  
  517.  
  518.        (You might think it would be evaluated at compile-time and
  519.        the _value_ used to obtain the object at load-time, but it
  520.        doesn't have to work that way.)
  521.  
  522. Declarations:
  523.  
  524.   * You often have to declare the result type to get the most
  525.     efficient arithmetic.  Eg, 
  526.  
  527.        (the fixnum (+ (the fixnum e1) (the fixnum e2)))
  528.  
  529.      rather than
  530.  
  531.        (+ (the fixnum e1) (the fixnum e2))
  532.  
  533.   * Declaring the iteration variable of a DOTIMES to have type FIXNUM
  534.     does not guarantee that fixnum arithmetic will be used.  That is,
  535.     implementations that use fixnum-specific arithmetic in the presence
  536.     of appropriate declaration may not think _this_ declaration is
  537.     sufficient.  It may help to declare that the limit is also a
  538.     fixnum, or you may have to write out the loop as a DO and add
  539.     appropriate declarations for each operation involved.
  540.  
  541. FORMAT related errors:
  542.  
  543.   * When printing messages about files, filenames like foo~ (a GNU-Emacs
  544.     backup file) may cause problems with poorly coded FORMAT control
  545.     strings.
  546.  
  547.   * Beware of using an ordinary string as the format string,
  548.     i.e., (format t string), rather than (format t "~A" string).
  549.  
  550. Miscellaneous:
  551.  
  552.   * Be careful of circular lists and shared list structure. 
  553.  
  554.   * Watch out for macro redefinitions.
  555.  
  556.   * If you use (SETF SYMBOL-FUNCTION) to change the definition of
  557.     built-in Lisp functions, be aware that this may not work correctly
  558.     (i.e., as desired) in compiled code in all Lisps. In some Lisps, 
  559.     the compiler treats certain symbols in the LISP package specially,
  560.     ignoring the function definition.
  561.  
  562.   * A NOTINLINE may be needed if you want SETF of SYMBOL-FUNCTION to
  563.     affect calls within a file.  (See CLtL2, page 686.)
  564.  
  565.   * When dividing two numbers, beware of creating a rational
  566.     number where you intended to get a real number. Use TRUNCATE
  567.     or ROUND. This is a major source of errors when porting ZetaLisp
  568.     or C code to Common Lisp.
  569.  
  570.   * If your code doesn't work because all the symbols are mysteriously
  571.     in the keyword package, one of your comments has a colon (:) in
  572.     it instead of a semicolon (;).
  573.  
  574. ----------------------------------------------------------------
  575. [3-12] When is it right to use EVAL?
  576.  
  577. Hardly ever.  Any time you think you need to use EVAL, think hard about it.
  578. EVAL is useful when implementing a facility that provides an external
  579. interface to the Lisp interpreter.  For instance, many Lisp-based editors
  580. provide a command that prompts for a form and displays its value.
  581. Inexperienced macro writers often assume that they must explicitly EVAL the
  582. subforms that are supposed to be evaluated, but this is not so; the correct
  583. way to write such a macro is to have it expand into another form that has
  584. these subforms in places that will be evaluated by the normal evaluation
  585. rules.  Explicit use of EVAL in a macro is likely to result in one of two
  586. problems: the dreaded "double evaluation" problem, which may not show up
  587. during testing if the values of the expressions are self-evaluating
  588. constants (such as numbers); or evaluation at compile time rather than
  589. runtime.  For instance, if Lisp didn't have IF and one desired to write it,
  590. the following would be wrong:
  591.  
  592.    (defmacro if (test then-form &optional else-form)
  593.      ;; this evaluates all the subforms at compile time, and at runtime
  594.      ;; evaluates the results again.
  595.      `(cond (,(eval test) ,(eval then-form))
  596.             (t ,(eval else-form))))
  597.  
  598.    (defmacro if (test then-form &optional else-form)
  599.      ;; this double-evaluates at run time
  600.      `(cond ((eval ,test) (eval ,then-form))
  601.             (t (eval ,else-form)))
  602.  
  603. This is correct:
  604.  
  605.    (defmacro if (test then-form &optional else-form)
  606.      `(cond (,test ,then-form)
  607.             (t ,else-form)))
  608.  
  609. On the other hand, EVAL can sometimes be necessary when the only portable
  610. interface to an operation is a macro. 
  611.  
  612. ----------------------------------------------------------------
  613. [3-13] Why does my program's behavior change each time I use it?
  614.  
  615. Most likely your program is altering itself, and the most common way this
  616. may happen is by performing destructive operations on embedded constant
  617. data structures.  For instance, consider the following:
  618.  
  619.    (defun one-to-ten-except (n)
  620.      (delete n '(1 2 3 4 5 6 7 8 9 10)))
  621.    (one-to-ten-except 3) => (1 2 4 5 6 7 8 9 10)
  622.    (one-to-ten-except 5) => (1 2 4 6 7 8 9 10) ; 3 is missing
  623.  
  624. The basic problem is that QUOTE returns its argument, *not* a copy of
  625. it. The list is actually a part of the lambda expression that is in
  626. ONE-TO-TEN-EXCEPT's function cell, and any modifications to it (e.g., by
  627. DELETE) are modifications to the actual object in the function definition.
  628. The next time that the function is called, this modified list is used.
  629.  
  630. In some implementations calling ONE-TO-TEN-EXCEPT may even result in
  631. the signalling of an error or the complete aborting of the Lisp process.  Some
  632. Lisp implementations put self-evaluating and quoted constants onto memory
  633. pages that are marked read-only, in order to catch bugs such as this.
  634. Details of this behavior may vary even within an implementation,
  635. depending on whether the code is interpreted or compiled (perhaps due to
  636. inlined DEFCONSTANT objects).
  637.  
  638. All of these behaviors are allowed by the draft ANSI Common Lisp
  639. specification, which specifically states that the consequences of modifying
  640. a constant are undefined (X3J13 vote CONSTANT-MODIFICATION:DISALLOW).
  641.  
  642. To avoid these problems, use LIST to introduce a list, not QUOTE. QUOTE
  643. should be used only when the list is intended to be a constant which
  644. will not be modified.  If QUOTE is used to introduce a list which will
  645. later be modified, use COPY-LIST to provide a fresh copy.
  646.  
  647. For example, the following should all work correctly:
  648.  
  649.    o  (remove 4 (list 1 2 3 4 1 3 4 5))
  650.    o  (remove 4 '(1 2 3 4 1 3 4 5))   ;; Remove is non-destructive.
  651.    o  (delete 4 (list 1 2 3 4 1 3 4 5))
  652.    o  (let ((x (list 1 2 4 1 3 4 5)))
  653.     (delete 4 x))
  654.    o  (defvar *foo* '(1 2 3 4 1 3 4 5))
  655.       (delete 4 (copy-list *foo*))
  656.       (remove 4 *foo*)
  657.       (let ((x (copy-list *foo*)))
  658.      (delete 4 x))
  659.  
  660. The following, however, may not work as expected:
  661.  
  662.    o  (delete 4 '(1 2 3 4 1 3 4 5))
  663.      
  664. ----------------------------------------------------------------
  665. [3-14]  When producing formatted output in Lisp, where should you put the
  666.         newlines (e.g., before or after the line, FRESH-LINE vs TERPRI,
  667.         ~& vs ~% in FORMAT)?
  668.  
  669.  
  670. Where possible, it is desirable to write functions that produce output
  671. as building blocks. In contrast with other languages, which either
  672. conservatively force a newline at various times or require the program
  673. to keep track of whether it needs to force a newline, the Lisp I/O
  674. system keeps track of whether the most recently printed character was
  675. a newline or not. The function FRESH-LINE outputs a newline only if
  676. the stream is not already at the beginning of a line.  TERPRI forces a
  677. newline irrespective of the current state of the stream. These
  678. correspond to the ~& and ~% FORMAT directives, respectively. (If the
  679. Lisp I/O system can't determine whether it's physically at the
  680. beginning of a line, it assumes that a newline is needed, just in case.)
  681.  
  682. Thus, if you want formatted output to be on a line of its own, start
  683. it with ~& and end it with ~%. (Some people will use a ~& also at the
  684. end, but this isn't necessary, since we know a priori that we're not
  685. at the beginning of a line. The only exception is when ~& follows a
  686. ~A, to prevent a double newline when the argument to the ~A is a
  687. formatted string with a newline at the end.) For example, the
  688. following routine prints the elements of a list, N elements per line,
  689. and then prints the total number of elements on a new line:
  690.  
  691.    (defun print-list (list &optional (elements-per-line 10))
  692.      (fresh-line)
  693.      (loop for i upfrom 1
  694.            for element in list do
  695.        (format t "~A ~:[~;~%~]" element (zerop (mod i elements-per-line))))
  696.      (format t "~&~D~%" (length list)))
  697.  
  698. ----------------------------------------------------------------
  699. ;;; *EOF*
  700.