Skip to main content

ed

ed Function

Syntax:

ed &optional x → implementation-dependent

Arguments and Values:

x—nil, a pathname, a string, or a function name. The default is nil.

Description:

ed invokes the editor if the implementation provides a resident editor.

If x is nil, the editor is entered. If the editor had been previously entered, its prior state is resumed, if possible.

If x is a pathname or string, it is taken as the pathname designator for a file to be edited.

If x is a function name, the text of its definition is edited. The means by which the function text is obtained is implementation-defined.

Exceptional Situations:

The consequences are undefined if the implementation does not provide a resident editor. Might signal type-error if its argument is supplied but is not a symbol, a pathname, or nil.

If a failure occurs when performing some operation on the file system while attempting to edit a file, an error of type file-error is signaled.

An error of type file-error might be signaled if x is a designator for a wild pathname. Implementation-dependent additional conditions might be signaled as well.

See Also:

pathname, logical-pathname, compile-file, load, Section 19.1.2 (Pathnames as Filenames)

Expanded Reference: ed​

Invoking the editor​

ed invokes an implementation-dependent editor. With no argument, it enters the editor. With a pathname, it opens that file for editing. With a function name, it opens the source of that function if available.

;; Open the editor (implementation-dependent)
;; (ed)

;; Edit a specific file
;; (ed "/tmp/my-code.lisp")

;; Edit a function's source (if the implementation supports it)
;; (ed 'my-function)

Editing a file​

When given a pathname argument, ed opens that file in the editor.

;; (ed #P"/home/user/project/main.lisp")
;; Opens the file in the implementation's editor
=> ; implementation-dependent

Editing a function definition​

When given a symbol naming a function, some implementations can locate and edit the function's source code.

;; (defun greet (name) (format nil "Hello, ~A!" name))
;; (ed 'greet)
;; Opens the source of GREET in the editor (if supported)
=> ; implementation-dependent

Return value​

The return value of ed is implementation-dependent.

;; (ed)
=> NIL  ; or implementation-dependent value