The cl-fuse-meta-fs Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-fuse-meta-fs Reference Manual

This is the cl-fuse-meta-fs Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:39:14 2022 GMT+0.

Table of Contents


1 Introduction

meta-fs: completely Lisp-level bindings for CL-FUSE

The idea is that you specify contents of your FS as the results of running
functions that can return files or functions generating directories (of course,
there are also callbacks for modification)

Load file lisp-meta-fs-test.lisp to see it in action in /tmp/test

Writing:
  (CL-FUSE-META-FS::MK-FILE "a.lisp" (FORMAT NIL "~a~%" (+ 2 3)))
to file structured-code/a.lisp will create structured-code-result/a.lisp 
containing line "5".

Among other things, this allows browsing Lisp packages and symbols in them.


2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-fuse-meta-fs

CFFI bindings to FUSE (Filesystem in user space)

Maintainer

Michael Raskin <fb08af68@rambler.ru>

Author

Michael Raskin <fb08af68@rambler.ru>

License

LLGPL

Dependencies
  • cl-fuse (system).
  • iterate (system).
  • pcall (system).
  • bordeaux-threads (system).
Source

cl-fuse-meta-fs.asd.

Child Component

lisp-meta-fs.lisp (file).


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


3.1.1 cl-fuse-meta-fs/cl-fuse-meta-fs.asd

Source

cl-fuse-meta-fs.asd.

Parent Component

cl-fuse-meta-fs (system).

ASDF Systems

cl-fuse-meta-fs.


3.1.2 cl-fuse-meta-fs/lisp-meta-fs.lisp

Source

cl-fuse-meta-fs.asd.

Parent Component

cl-fuse-meta-fs (system).

Packages

cl-fuse-meta-fs.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-fuse-meta-fs

Source

lisp-meta-fs.lisp.

Use List
  • bordeaux-threads.
  • cl-fuse.
  • common-lisp.
  • iterate.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.1 Special variables

Special Variable: *meta-fs-name-encoding*
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Special Variable: *object-cache-duration*
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.


5.1.2 Macros

Macro: cached-expr (e key &key duration eval-key)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Macro: fmt (s var)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Macro: id (&rest x)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Macro: mk-creator (var create-file create-dir)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Macro: mk-dir (name kind &rest contents)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Macro: mk-dir-remover (body)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Macro: mk-file (name contents &optional writer remover size executable)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Macro: mk-generator (var parser predicate lister contents)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Macro: mk-pair-generator (var lister &optional contents)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Macro: mk-splice (&rest x)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Macro: mk-symlinker (var target-var &rest body)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.


Previous: , Up: Public Interface   [Contents][Index]

5.1.3 Ordinary functions

Function: run-lisp-meta-fs (description &optional target-path call-manager thread-pool-size extra-fuse-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.


5.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

Special Variable: *cache-storage*
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Special Variable: *cache-storage-lock*
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Special Variable: *description*
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Special Variable: *object-cache*
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Special Variable: *object-cache-lock*
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Special Variable: *write-cache*
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Special Variable: *write-cache-lock*
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.


5.2.2 Macros

Macro: make-op (f args &rest body)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.


Previous: , Up: Internals   [Contents][Index]

5.2.3 Ordinary functions

Function: cached (f key &key duration)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: cast-splice-as-progn (x)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: clean-object-cache (&optional now)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: decode-name (n)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: dir-create (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: directory-content (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: directoryp (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: file-create (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: file-executable-p (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: file-flush (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: file-read (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: file-release (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: file-size (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: file-truncate (path offset &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: file-write-whole (path data &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: file-writeable-p (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: flatten-splicing (x)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: flush-object-cache ()
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: get-dir-remover (obj)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: get-object (path initial &optional rev-path-already)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: launch-creator (obj kind name)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: launch-symlinker (obj name content)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: list-directory (obj &key path)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: object-cache-retrieve (key now)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: safe-call (f &rest args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: safe-subseq (seq start end)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.

Function: symlinkp (path &rest more-args)
Package

cl-fuse-meta-fs.

Source

lisp-meta-fs.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   D   F   G   I   L   M   O   R   S  
Index Entry  Section

C
cached: Private ordinary functions
cached-expr: Public macros
cast-splice-as-progn: Private ordinary functions
clean-object-cache: Private ordinary functions

D
decode-name: Private ordinary functions
dir-create: Private ordinary functions
dir-unlink: Private ordinary functions
directory-content: Private ordinary functions
directoryp: Private ordinary functions

F
file-create: Private ordinary functions
file-executable-p: Private ordinary functions
file-flush: Private ordinary functions
file-read: Private ordinary functions
file-release: Private ordinary functions
file-size: Private ordinary functions
file-truncate: Private ordinary functions
file-unlink: Private ordinary functions
file-write-whole: Private ordinary functions
file-writeable-p: Private ordinary functions
flatten-splicing: Private ordinary functions
flush-object-cache: Private ordinary functions
fmt: Public macros
Function, cached: Private ordinary functions
Function, cast-splice-as-progn: Private ordinary functions
Function, clean-object-cache: Private ordinary functions
Function, decode-name: Private ordinary functions
Function, dir-create: Private ordinary functions
Function, dir-unlink: Private ordinary functions
Function, directory-content: Private ordinary functions
Function, directoryp: Private ordinary functions
Function, file-create: Private ordinary functions
Function, file-executable-p: Private ordinary functions
Function, file-flush: Private ordinary functions
Function, file-read: Private ordinary functions
Function, file-release: Private ordinary functions
Function, file-size: Private ordinary functions
Function, file-truncate: Private ordinary functions
Function, file-unlink: Private ordinary functions
Function, file-write-whole: Private ordinary functions
Function, file-writeable-p: Private ordinary functions
Function, flatten-splicing: Private ordinary functions
Function, flush-object-cache: Private ordinary functions
Function, get-dir-remover: Private ordinary functions
Function, get-object: Private ordinary functions
Function, launch-creator: Private ordinary functions
Function, launch-symlinker: Private ordinary functions
Function, list-directory: Private ordinary functions
Function, object-cache-retrieve: Private ordinary functions
Function, run-lisp-meta-fs: Public ordinary functions
Function, safe-call: Private ordinary functions
Function, safe-subseq: Private ordinary functions
Function, symlink: Private ordinary functions
Function, symlink-target: Private ordinary functions
Function, symlinkp: Private ordinary functions

G
get-dir-remover: Private ordinary functions
get-object: Private ordinary functions

I
id: Public macros

L
launch-creator: Private ordinary functions
launch-symlinker: Private ordinary functions
list-directory: Private ordinary functions

M
Macro, cached-expr: Public macros
Macro, fmt: Public macros
Macro, id: Public macros
Macro, make-op: Private macros
Macro, mk-creator: Public macros
Macro, mk-dir: Public macros
Macro, mk-dir-remover: Public macros
Macro, mk-file: Public macros
Macro, mk-generator: Public macros
Macro, mk-pair-generator: Public macros
Macro, mk-splice: Public macros
Macro, mk-symlink: Public macros
Macro, mk-symlinker: Public macros
make-op: Private macros
mk-creator: Public macros
mk-dir: Public macros
mk-dir-remover: Public macros
mk-file: Public macros
mk-generator: Public macros
mk-pair-generator: Public macros
mk-splice: Public macros
mk-symlink: Public macros
mk-symlinker: Public macros

O
object-cache-retrieve: Private ordinary functions

R
run-lisp-meta-fs: Public ordinary functions

S
safe-call: Private ordinary functions
safe-subseq: Private ordinary functions
symlink: Private ordinary functions
symlink-target: Private ordinary functions
symlinkp: Private ordinary functions

Jump to:   C   D   F   G   I   L   M   O   R   S