CLHS: macro WITH-OPEN-FILE

#

macro WITH-OPEN-FILE

Syntax:

with-open-file (stream filespec options*) declaration* form*

=> results

Arguments and Values:

stream -- a variable.

filespec---a pathname designator.

options -- forms; evaluated.

declaration---a declare expression; not evaluated.

forms---an implicit progn.

results---the values returned by the forms.

Description:

with-open-file uses open to create a file stream to file named by filespec. Filespec is the name of the file to be opened. Options are used as keyword arguments to open.

The stream object to which the stream variable is bound has dynamic extent; its extent ends when the form is exited.

with-open-file evaluates the forms as an implicit progn with stream bound to the value returned by open.

When control leaves the body, either normally or abnormally (such as by use of throw), the file is automatically closed. If a new output file is being written, and control leaves abnormally, the file is aborted and the file system is left, so far as possible, as if the file had never been opened.

It is possible by the use of `:if-exists nil` or `:if-does-not-exist nil` for stream to be bound to nil. Users of `:if-does-not-exist nil` should check for a valid stream.

The consequences are undefined if an attempt is made to assign the stream variable. The compiler may choose to issue a warning if such an attempt is detected.

Examples:

     (setq p (merge-pathnames "test"))
    =>  #<PATHNAME :HOST NIL :DEVICE device-name :DIRECTORY directory-name
        :NAME "test" :TYPE NIL :VERSION :NEWEST>
     (with-open-file (s p :direction :output :if-exists :supersede)
        (format s "Here are a couple~%of test data lines~%")) =>  NIL
     (with-open-file (s p)
        (do ((l (read-line s) (read-line s nil 'eof)))
            ((eq l 'eof) "Reached end of file.")
         (format t "~&*** ~A~%" l)))
    >>  *** Here are a couple
    >>  *** of test data lines
    =>  "Reached end of file."

    ;; Normally one would not do this intentionally because it is
    ;; not perspicuous, but beware when using :IF-DOES-NOT-EXIST NIL
    ;; that this doesn't happen to you accidentally...
     (with-open-file (foo "no-such-file" :if-does-not-exist nil)
       (read foo))
    >>  hello?
    =>  HELLO? ;This value was read from the terminal, not a file!

    ;; Here's another bug to avoid...
     (with-open-file (foo "no-such-file" :direction :output :if-does-not-exist nil)
       (format foo "Hello"))
    =>  "Hello" ;FORMAT got an argument of NIL!

Side Effects:

Creates a stream to the file named by filename (upon entry), and closes the stream (upon exit). In some implementations, the file might be locked in some way while it is open. If the stream is an output stream, a file might be created.

Affected By:

The host computer's file system.

Exceptional Situations:

See the function open.

See Also:

open, close, pathname, logical-pathname, Section 19.1.2 (Pathnames as Filenames)

Notes: None.

The following X3J13 cleanup issues, not part of the specification, apply to this section:

- PATHNAME-HOST-PARSING:RECOGNIZE-LOGICAL-HOST-NAMES
- PATHNAME-LOGICAL:ADD
- FILE-OPEN-ERROR:SIGNAL-FILE-ERROR
- WITH-OPEN-FILE-SETQ:EXPLICITLY-VAGUE
- WITH-OPEN-FILE-DOES-NOT-EXIST:STREAM-IS-NIL
- WITH-OPEN-FILE-STREAM-EXTENT:DYNAMIC-EXTENT
- STREAM-ACCESS:ADD-TYPES-ACCESSORS
- DECLS-AND-DOC

Copyright 1996-2005, LispWorks Ltd. All rights reserved.