This is the open-with Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:12:14 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
open-withOpen a file in a suitable external program
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/open-with.git)
zlib
1.0.0
documentation-utils (system).
trivial-features (system).
uiop (system).
cffi (system)., for feature :nx
package.lisp (file).
toolkit.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
open-with/toolkit.lisppackage.lisp (file).
open-with (system).
*default-file-handler* (special variable).
*default-url-handler* (special variable).
*file-type-associations* (special variable).
*url-schema-associations* (special variable).
external-open-with-fun (function).
open (generic function).
run-handler (function).
alphabetic-p (function).
find-program (function).
open-with/documentation.lisptoolkit.lisp (file).
open-with (system).
Packages are listed by definition order.
org.shirakumo.open-withcommon-lisp.
*default-file-handler* (special variable).
*default-url-handler* (special variable).
*file-type-associations* (special variable).
*url-schema-associations* (special variable).
external-open-with-fun (function).
open (generic function).
run-handler (function).
alphabetic-p (function).
find-program (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The default handler for files when no specific one is set.
You may set this to any handler as specified by RUN-HANDLER.
See *FILE-TYPE-ASSOCIATIONS*
See RUN-HANDLER
See OPEN
The default handler for URLs when no specific one is set.
You may set this to any handler as specified by RUN-HANDLER.
See *URL-SCHEMA-ASSOCIATIONS*
See RUN-HANDLER
See OPEN
A hash table associating file extension types to handlers.
You may set entries in this table with keys being PATHNAME-TYPEs and
values being handlers as specified by RUN-HANDLER.
See RUN-HANDLER
See OPEN
A hash table associating url schemas to handlers.
You may set entries in this table with keys being URL schemas and
values being handlers as specified by RUN-HANDLER.
See RUN-HANDLER
See OPEN
Create a handler for an external program.
An external program with the given name is searched for in directories
listed in the PATH environment variable (on Windows with the .exe
suffix). If none can be found, an error is signalled. If one can be
found, a function suitable for RUN-HANDLER is returned that will
create a process for the program to open the THING with. When starting
the program, ARGS are provided as command-line arguments to the
program, with the THING to open as the last argument appended on.
See RUN-HANDLER
Run a handler for the THING with the given arguments.
HANDLER can be one of the following:
HANDLER ::= symbol
| function
| program
| (option+)
program ::= string
option ::= symbol
| function
| program
| (program string*)
Where OPTIONs are potential handlers that are tried in sequence until
one that does not error appears. If none of the options run without
error, an error is signalled at the end.
In the case of SYMBOLs and FUNCTIONs, the designated lisp function is
simply invoked with THING and ARGS. In the case of PROGRAMs, a handler
function is constructed via EXTERNAL-OPEN-WITH-FUN
In all cases ARGS should be a keyword argument list, and whatever
handler must accept any keyword argument, though may ignore all of
them. The only specified keyword argument is BACKGROUND which, if
true, specifies that the handler should be run in the background and
the function should return immediately.
See EXTERNAL-OPEN-WITH-FUN
Attempts to open THING for viewing or editing.
Users may add methods to this function to customise the behhaviour for
other types. A default implementation for PATHNAMEs and STRINGs is
provided, which invokes a file handler for pathnames and strings
unless the string starts with an URL schema, in which case a url
handler is invoked instead.
For files, if the pathname has a type, a corresponding handler is
looked up in the *FILE-TYPE-ASSOCIATIONS* table. If it is a directory,
the handler is looked up by the :DIRECTORY key. Otherwise it is looked
up by the :FILE key. If no custom handler is set, the
*DEFAULT-FILE-HANDLER* is used.
For URLs, a corresponding handler is looked up in the
*URL-SCHEMA-ASSOCIATIONS* table. If no custom handler is set, the
*DEFAULT-URL-HANDLER* is used.
Whatever the case, the chosen handler is then invoked on THING and
ARGS via the RUN-HANDLER function.
See *FILE-TYPE-ASSOCIATIONS*
See *URL-SCHEMA-ASSOCIATIONS*
See *DEFAULT-FILE-HANDLER*
See *DEFAULT-URL-HANDLER*
See RUN-HANDLER
| Jump to: | A E F G M O R |
|---|
| Jump to: | A E F G M O R |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | D F O P S T |
|---|
| Jump to: | D F O P S T |
|---|