The query-fs Reference Manual

This is the query-fs Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 11:10:28 2019 GMT+0.

1 Introduction

query-fs

It is a mirror of QueryFS monotone repository. QueryFS is stable enough that difference is minimal, but the true repository is in Monotone: http://mtn-host.prjek.net/viewmtn/cl-fuse/branch/changes/com.ignorelist.401a0bf1.raskin.cl-fuse.query-fs

To run a minimal test, create /tmp/test-query-fs/ and copy example-queries as queries there, and example-plugins as plugins. Then load query-fs and run

(query-fs:run-fs :target "/tmp/test-query-fs/")

in your Common Lisp REPL. Example command for SBCL and Quicklisp:

sbcl --load setup.lisp --eval '(quicklisp:quickload :query-fs)' --eval '(query-fs:run-fs :target "/tmp/test-query-fs/")' --eval '(quit)'

2 Systems

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

2.1 `query-fs`

Maintainer

Michael Raskin <fb08af68@rambler.ru>

Author

Michael Raskin <fb08af68@rambler.ru>

License

LLGPL

Description

High-level virtual FS using CL-Fuse-Meta-FS to represent results of queries

Dependencies

cl-fuse
cl-fuse-meta-fs
iterate
cl-ppcre
bordeaux-threads
trivial-backtrace
command-line-arguments

Source

query-fs.asd (file)

Components

package.lisp (file)
query-fs.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 `query-fs.asd`

Location: query-fs.asd
Systems: query-fs (system)

3.1.2 `query-fs/package.lisp`

Parent: query-fs (system)
Location: package.lisp
Packages: query-fs

3.1.3 `query-fs/query-fs.lisp`

Dependency

package.lisp (file)

Parent

query-fs (system)

Location

query-fs.lisp

Exported Definitions

*plugin-path* (special variable)
*query-parser* (special variable)
*query-path* (special variable)
*result-path* (special variable)
*target* (special variable)
backtrace-error (function)
collect-entries (function)
def-linear-query-parser (macro)
def-query-parser (macro)
load-demo (function)
load-plugin (function)
load-query (function)
reload-files (function)
run-fs (function)
run-fs-with-cmdline-args (function)
update-description (function)

Internal Definitions

*description* (special variable)
*home* (special variable)
*plugins-loaded* (special variable)
*queries-loaded* (special variable)
*query-loader-types* (special variable)
*query-loaders* (special variable)
compile-time-value (macro)
getenv (function)
load-new-files (function)
prepare-description (function)
reload-plugins (function)
reload-queries (function)
remove-query (function)
setenv (function)

4 Packages

Packages are listed by definition order.

4.1 `query-fs`

Source

package.lisp (file)

Use List

command-line-arguments
common-lisp
iterate
cl-fuse-meta-fs

Exported Definitions

*plugin-path* (special variable)
*query-parser* (special variable)
*query-path* (special variable)
*result-path* (special variable)
*target* (special variable)
backtrace-error (function)
collect-entries (function)
def-linear-query-parser (macro)
def-query-parser (macro)
load-demo (function)
load-plugin (function)
load-query (function)
reload-files (function)
run-fs (function)
run-fs-with-cmdline-args (function)
update-description (function)

Internal Definitions

*description* (special variable)
*home* (special variable)
*plugins-loaded* (special variable)
*queries-loaded* (special variable)
*query-loader-types* (special variable)
*query-loaders* (special variable)
compile-time-value (macro)
getenv (function)
load-new-files (function)
prepare-description (function)
reload-plugins (function)
reload-queries (function)
remove-query (function)
setenv (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *plugin-path*

Package: query-fs
Source: query-fs.lisp (file)

Special Variable: *query-parser*

Package: query-fs
Source: query-fs.lisp (file)

Special Variable: *query-path*

Package: query-fs
Source: query-fs.lisp (file)

Special Variable: *result-path*

Package: query-fs
Source: query-fs.lisp (file)

Special Variable: *target*

Package: query-fs
Source: query-fs.lisp (file)

5.1.2 Macros

Macro: def-linear-query-parser QUERY-TYPE &rest BODY

Package: query-fs
Source: query-fs.lisp (file)

Macro: def-query-parser QUERY-TYPE &rest BODY

Package: query-fs
Source: query-fs.lisp (file)

5.1.3 Functions

Function: backtrace-error E &optional EXTRA-TEXT

Package: query-fs
Source: query-fs.lisp (file)

Function: collect-entries FILE FUNC

Package: query-fs
Source: query-fs.lisp (file)

Function: load-demo NAME

Package: query-fs
Source: query-fs.lisp (file)

Function: load-plugin FILE-PATH

Package: query-fs
Source: query-fs.lisp (file)

Function: load-query FILE-NAME

Package: query-fs
Source: query-fs.lisp (file)

Function: reload-files ()

Package: query-fs
Source: query-fs.lisp (file)

Function: run-fs &key TARGET QUERY-PATH PLUGIN-PATH RESULT-PATH BREAK-ON-ERRORS OBJECT-CACHE-DURATION CALL-MANAGER THREAD-POOL-SIZE EXTRA-FUSE-ARGS

Package: query-fs
Source: query-fs.lisp (file)

Function: run-fs-with-cmdline-args &optional PREPENDED-ARGUMENTS

Package: query-fs
Source: query-fs.lisp (file)

Function: update-description ()

Package: query-fs
Source: query-fs.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *description*

Package: query-fs
Source: query-fs.lisp (file)

Special Variable: *home*

Package: query-fs
Source: query-fs.lisp (file)

Special Variable: *plugins-loaded*

Package: query-fs
Source: query-fs.lisp (file)

Special Variable: *queries-loaded*

Package: query-fs
Source: query-fs.lisp (file)

Special Variable: *query-loader-types*

Package: query-fs
Source: query-fs.lisp (file)

Special Variable: *query-loaders*

Package: query-fs
Source: query-fs.lisp (file)

5.2.2 Macros

Macro: compile-time-value X

Package: query-fs
Source: query-fs.lisp (file)

5.2.3 Functions

Function: getenv VAR-NAME

Package: query-fs
Source: query-fs.lisp (file)

Function: load-new-files ()

Package: query-fs
Source: query-fs.lisp (file)

Function: prepare-description DESC

Package: query-fs
Source: query-fs.lisp (file)

Function: reload-plugins ()

Package: query-fs
Source: query-fs.lisp (file)

Function: reload-queries ()

Package: query-fs
Source: query-fs.lisp (file)

Function: remove-query NAME

Package: query-fs
Source: query-fs.lisp (file)

Function: setenv VAR-NAME VAL OVERWRITE

Package: query-fs
Source: query-fs.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	F L Q

	Index Entry	Section

F
	File, Lisp, `query-fs.asd`:	The query-fs․asd file
	File, Lisp, `query-fs/package.lisp`:	The query-fs/package․lisp file
	File, Lisp, `query-fs/query-fs.lisp`:	The query-fs/query-fs․lisp file

L
	Lisp File, `query-fs.asd`:	The query-fs․asd file
	Lisp File, `query-fs/package.lisp`:	The query-fs/package․lisp file
	Lisp File, `query-fs/query-fs.lisp`:	The query-fs/query-fs․lisp file

Q
	`query-fs.asd`:	The query-fs․asd file
	`query-fs/package.lisp`:	The query-fs/package․lisp file
	`query-fs/query-fs.lisp`:	The query-fs/query-fs․lisp file

Jump to:	F L Q

A.2 Functions

Jump to:	B C D F G L M P R S U

	Index Entry	Section

B
	`backtrace-error`:	Exported functions

C
	`collect-entries`:	Exported functions
	`compile-time-value`:	Internal macros

D
	`def-linear-query-parser`:	Exported macros
	`def-query-parser`:	Exported macros

F
	`Function, backtrace-error`:	Exported functions
	`Function, collect-entries`:	Exported functions
	`Function, getenv`:	Internal functions
	`Function, load-demo`:	Exported functions
	`Function, load-new-files`:	Internal functions
	`Function, load-plugin`:	Exported functions
	`Function, load-query`:	Exported functions
	`Function, prepare-description`:	Internal functions
	`Function, reload-files`:	Exported functions
	`Function, reload-plugins`:	Internal functions
	`Function, reload-queries`:	Internal functions
	`Function, remove-query`:	Internal functions
	`Function, run-fs`:	Exported functions
	`Function, run-fs-with-cmdline-args`:	Exported functions
	`Function, setenv`:	Internal functions
	`Function, update-description`:	Exported functions

G
	`getenv`:	Internal functions

L
	`load-demo`:	Exported functions
	`load-new-files`:	Internal functions
	`load-plugin`:	Exported functions
	`load-query`:	Exported functions

M
	`Macro, compile-time-value`:	Internal macros
	`Macro, def-linear-query-parser`:	Exported macros
	`Macro, def-query-parser`:	Exported macros

P
	`prepare-description`:	Internal functions

R
	`reload-files`:	Exported functions
	`reload-plugins`:	Internal functions
	`reload-queries`:	Internal functions
	`remove-query`:	Internal functions
	`run-fs`:	Exported functions
	`run-fs-with-cmdline-args`:	Exported functions

S
	`setenv`:	Internal functions

U
	`update-description`:	Exported functions

Jump to:	B C D F G L M P R S U

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`description`:	Internal special variables
	`home`:	Internal special variables
	`plugin-path`:	Exported special variables
	`plugins-loaded`:	Internal special variables
	`queries-loaded`:	Internal special variables
	`query-loader-types`:	Internal special variables
	`query-loaders`:	Internal special variables
	`query-parser`:	Exported special variables
	`query-path`:	Exported special variables
	`result-path`:	Exported special variables
	`target`:	Exported special variables

S
	`Special Variable, description`:	Internal special variables
	`Special Variable, home`:	Internal special variables
	`Special Variable, plugin-path`:	Exported special variables
	`Special Variable, plugins-loaded`:	Internal special variables
	`Special Variable, queries-loaded`:	Internal special variables
	`Special Variable, query-loader-types`:	Internal special variables
	`Special Variable, query-loaders`:	Internal special variables
	`Special Variable, query-parser`:	Exported special variables
	`Special Variable, query-path`:	Exported special variables
	`Special Variable, result-path`:	Exported special variables
	`Special Variable, target`:	Exported special variables

Jump to:	* S

A.4 Data types

Jump to:	P Q S

	Index Entry	Section

P
	`Package, query-fs`:	The query-fs package

Q
	`query-fs`:	The query-fs system
	`query-fs`:	The query-fs package

S
	`System, query-fs`:	The query-fs system

Jump to:	P Q S

• Introduction		What query-fs is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• Concept index
• Function index
• Variable index
• Data type index

• The query-fs.asd file
• The query-fs/package.lisp file
• The query-fs/query-fs.lisp file

• Exported special variables
• Exported macros
• Exported functions

• Internal special variables
• Internal macros
• Internal functions

The query-fs Reference Manual

Table of Contents

The query-fs Reference Manual

1 Introduction

query-fs

2 Systems

2.1 query-fs

3 Files

3.1 Lisp

3.1.1 query-fs.asd

3.1.2 query-fs/package.lisp

3.1.3 query-fs/query-fs.lisp

4 Packages

4.1 query-fs

5 Definitions

5.1 Exported definitions

5.1.1 Special variables

5.1.2 Macros

5.1.3 Functions

5.2 Internal definitions

5.2.1 Special variables

5.2.2 Macros

5.2.3 Functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `query-fs`

3.1.1 `query-fs.asd`

3.1.2 `query-fs/package.lisp`

3.1.3 `query-fs/query-fs.lisp`

4.1 `query-fs`