This is the fof Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 04:33:22 2022 GMT+0.
Next: Files, Previous: The fof Reference Manual, Up: The fof Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Next: fof/package, Previous: Systems, Up: Systems [Contents][Index]
File-object finder. Enable rapid file search, inspection and manipulation.
Pierre Neidhardt <mail@ambrevar.xyz>
GPL3+
0.2.0
fof/package (system).
Pierre Neidhardt <mail@ambrevar.xyz>
GPL3+
Next: fof/predicates, Previous: fof/package, Up: Systems [Contents][Index]
Pierre Neidhardt <mail@ambrevar.xyz>
GPL3+
Pierre Neidhardt <mail@ambrevar.xyz>
GPL3+
Next: Packages, Previous: Systems, Up: The fof Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: fof/package/file-type.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
fof (system).
Next: fof/file/file-type.lisp, Previous: fof/fof.asd, Up: Lisp [Contents][Index]
fof/package (system).
Next: fof/predicates/file-type.lisp, Previous: fof/package/file-type.lisp, Up: Lisp [Contents][Index]
fof/file (system).
Previous: fof/file/file-type.lisp, Up: Lisp [Contents][Index]
fof/predicates (system).
Next: Definitions, Previous: Files, Up: The fof Reference Manual [Contents][Index]
Packages are listed by definition order.
File object finder.
This is the meta package which includes all others.
fof
Next: fof/predicates, Previous: fof/package, Up: Packages [Contents][Index]
File class.
common-lisp.
All predicates for the FOF finder.
fof/p
Next: Indexes, Previous: Packages, Up: The fof Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
Function that takes a path and returns a ‘file’-like object.
When non-nil ‘finder’ includes directories.
Whether to abbreviate the user home directory to ’~’.
Maximum abbreviation length, for each directory.
Abbreviate printout if strictly longer than this value. Set to 0 to stop abbreviating.
Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]
Call BODY while the POSIX current working directory is set to FILE.
This is just like ‘uiop:with-current-directory’ except that it takes a ‘file’
object.
Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]
Return a file predicate that matches on modification time less recent than TIMESTAMP.
Return a file predicate that matches on modification time more recent than TIMESTAMP.
Return a predicate for files that match one of the provided extensions.
Return true if FILE1 and FILE2 point to the same file. They might not be the same objects.
List files in current directory that satisfy all PREDICATE-SPECIFIERS
Directories are ignored.
Without PREDICATE-SPECIFIERS, list all files.
A predicate specifier can be:
- a string, in which case it is turned into (match-path STRING);
- a pathname, in which case it is turned into (match-path-end PATHNAME);
- a list of predicates, in which case it is turned into (apply #’alexandria:disjoin PREDICATES);
- a function (a predicate).
For a more tunable finder, see ‘finder*’.
List FILES (including directories) that satisfy all PREDICATES.
Without PREDICATES, list all files.
Recur in subdirectories when they satisfy all RECUR-PREDICATES. Without RECUR-PREDICATES, recur in all subdirectories.
Return a predicate for files that match one of the provided ‘group-specifier’s.
Return a predicate for files that match one of the provided ‘file-kind’s.
Return entries in PATH.
By default, directories come first.
If SORT is non nil, sort them alphabetically.
Second value is the list of directories, third value is the non-directories.
Return a predicate that matches when one of the names is contained in the file basename.
Return a predicate that matches when one of the path suffixes matches the file path.
Return a predicate that matches when one of the path elements is contained in the file path.
Return a predicate for files that match one of the provided ‘user-specifier’s.
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Useful so that ‘path’ can be called both on a ‘file’ or a ‘pathname’. A trailing separator is automatically append for directories, if missing. This is to be consistent with the ‘path’ method for ‘file’.
Useful so that ‘path’ can be called both on a ‘file’ or a ‘string’.
A trailing separator is automatically append for directories, if missing.
This is to be consistent with the ‘path’ method for ‘file’.
Return path of FILE relative to PARENT-DIRECTORY.
If PARENT-DIRECTORY is not a parent of FILE, return FILE’s path.
Return PATH relative to PARENT-DIRECTORY.
If PARENT-DIRECTORY is not a parent of PATH, return PATH.
Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]
Next: Types, Previous: Standalone methods, Up: Public Interface [Contents][Index]
string
(error "path required")
:path
path.
This slot is read-only.
0
:link-count
This slot is read-only.
fof/file:file-kind
:regular-file
:kind
kind.
This slot is read-only.
0
:disk-usage
This slot is read-only.
0
:user-id
0
:group-id
(local-time:unix-to-timestamp 0)
:creation-date
This slot is read-only.
(local-time:unix-to-timestamp 0)
:modification-date
(local-time:unix-to-timestamp 0)
:access-date
(or null (cons (member :user-read :user-write :user-exec :group-read :group-write :group-exec :other-read :other-write :other-exec :set-user-id :set-group-id :sticky)))
(quote nil)
:permissions
file.
""
:mime-type
This slot is read-only.
""
:mime-encoding
This slot is read-only.
""
:description
This slot is read-only.
Previous: Classes, Up: Public Interface [Contents][Index]
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
Internal storage for ‘magic-cookie-description’.
Internal storage for ‘magic-cookie-mime’.
Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]
Return the PATH description as per the ‘file’ UNIX command.
Return a pair of MIME type and MIME encoding for PATH.
Return NIL if FILE is not a child of PARENT.
Return a predicate that matches when the argument file is in a subdirectory of ROOT less deep than LEVEL.
Mimicks Unix’ ‘ls -l’.
Same as ‘magic-cooke-mime’ but for ‘file’ descriptions. See ‘%description’.
Return internal, persistent MIME cookie for ‘magicffi’ calls.
Benchmark on thousands of files shows that
keeping the same cookie saves about 15% of time.
Return a predicate that matches when the argument file is in a subdirectory of ROOT less deep than LEVEL.
Return a predicate that matches when one of the path elements is contained in
the file path.
Useful for ‘finder’.
Return a predicate that matches when one of the path suffixes matches
the file path.
Useful for ‘finder’.
Return true if PARENT is a parent of FILE.
When ABBREVIATE-HOME?, abbreviate user home directory regardless of ABBREVIATION-THRESHOLD.
Next: Types, Previous: Ordinary functions, Up: Internals [Contents][Index]
Previous: Generic functions, Up: Internals [Contents][Index]
A ‘string’ identifies the group name, a ‘fixnum’ the group ID.
A ‘string’ identifies the user name, a ‘fixnum’ the user ID.
Previous: Definitions, Up: The fof Reference Manual [Contents][Index]
| Jump to: | %
(
A B C D E F G H I K L M N P R S U W |
|---|
| Jump to: | %
(
A B C D E F G H I K L M N P R S U W |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | %
*
+
A C D G I K L M P S U |
|---|
| Jump to: | %
*
+
A C D G I K L M P S U |
|---|
| Jump to: | C F G P S T U |
|---|
| Jump to: | C F G P S T U |
|---|