LPC Library Functions: ed

NAME

ed() - edit a file

SYNOPSIS

void ed( string file | void, string exit_fn, int restricted );

void ed( string file | void, string write_fn, string exit_fn, int restricted );

DESCRIPTION

ed() starts the driver's built-in line editor, which is similar to UNIX ed(1) or ex(1). Once in the editor, type 'h' for help.

If the optional parameter 'file' is included, ed() will attempt to load the file for editing. If the file does not exist, ed() will inform the user with the message "No file."

The 'write_fn' parameter allows you to specify a mudlib function which will do pre- or post-processing on ed's attempt to write its buffer to disk. When the editor is about to write to the file 'file', the driver will call the function 'write_fn' with 'file' as the first parameter and '0' (zero) as the second parameter. If 'write_fn' returns TRUE, the write takes place; otherwise, it will abort.

Once ed() has completed the write operation, 'write_fn' will be called again with 'file' as the first parameter and '1' (one) as the second parameter.

The callback function 'write_fn' should have the form:

    int write_fn(string fname, int flag)

The 'exit_fn' parameter enables you to specify a mudlib function which will do processing when the user exits the editor. This callback function has the form:

    void exit_fn()

• inserting another file into the current buffer (the 'e', 'E', and 'r' commands).
• saving using an alternate file name (the 'f', 'w', and 'W' commands).

This efun is only available if the driver flag OLD_ED is defined.

SEE ALSO

regexp(), valid_read(), valid_write(), get_save_file_name()