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

The query-fs Reference Manual

This is the query-fs Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 14:40:27 2023 GMT+0.

Table of Contents

Next: , Previous: , Up: The query-fs Reference Manual   [Contents][Index]

1 Introduction

Next: , Previous: , Up: The query-fs Reference Manual   [Contents][Index]

2 Systems

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

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

2.1 query-fs

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

Maintainer

Michael Raskin <>

Author

Michael Raskin <>

License

LLGPL

Dependencies
  • cl-fuse (system).
  • cl-fuse-meta-fs (system).
  • iterate (system).
  • cl-ppcre (system).
  • bordeaux-threads (system).
  • trivial-backtrace (system).
  • command-line-arguments (system).
Source

query-fs.asd.

Child Components

Next: , Previous: , Up: The query-fs Reference Manual   [Contents][Index]

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

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

3.1.1 query-fs/query-fs.asd

Source

query-fs.asd.

Parent Component

query-fs (system).

ASDF Systems

query-fs.

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

3.1.2 query-fs/package.lisp

Source

query-fs.asd.

Parent Component

query-fs (system).

Packages

query-fs.

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

3.1.3 query-fs/query-fs.lisp

Dependency

package.lisp (file).

Source

query-fs.asd.

Parent Component

query-fs (system).

Public Interface
Internals

Next: , Previous: , Up: The query-fs Reference Manual   [Contents][Index]

4 Packages

Packages are listed by definition order.

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

4.1 query-fs

Source

package.lisp.

Use List
  • cl-fuse-meta-fs.
  • command-line-arguments.
  • common-lisp.
  • iterate.
Public Interface
Internals

Next: , Previous: , Up: The query-fs Reference Manual   [Contents][Index]

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: *plugin-path*
Package

query-fs.

Source

query-fs.lisp.

Special Variable: *query-parser*
Package

query-fs.

Source

query-fs.lisp.

Special Variable: *query-path*
Package

query-fs.

Source

query-fs.lisp.

Special Variable: *result-path*
Package

query-fs.

Source

query-fs.lisp.

Special Variable: *target*
Package

query-fs.

Source

query-fs.lisp.

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

5.1.2 Macros

Macro: def-linear-query-parser (query-type &rest body)
Package

query-fs.

Source

query-fs.lisp.

Macro: def-query-parser (query-type &rest body)
Package

query-fs.

Source

query-fs.lisp.

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

5.1.3 Ordinary functions

Function: backtrace-error (e &optional extra-text)
Package

query-fs.

Source

query-fs.lisp.

Function: collect-entries (file func)
Package

query-fs.

Source

query-fs.lisp.

Function: load-demo (name)
Package

query-fs.

Source

query-fs.lisp.

Function: load-plugin (file-path)
Package

query-fs.

Source

query-fs.lisp.

Function: load-query (file-name)
Package

query-fs.

Source

query-fs.lisp.

Function: reload-files ()
Package

query-fs.

Source

query-fs.lisp.

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.

Function: run-fs-with-cmdline-args (&optional prepended-arguments)
Package

query-fs.

Source

query-fs.lisp.

Function: update-description ()
Package

query-fs.

Source

query-fs.lisp.

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

5.2 Internals

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

5.2.1 Special variables

Special Variable: *description*
Package

query-fs.

Source

query-fs.lisp.

Special Variable: *home*
Package

query-fs.

Source

query-fs.lisp.

Special Variable: *plugins-loaded*
Package

query-fs.

Source

query-fs.lisp.

Special Variable: *queries-loaded*
Package

query-fs.

Source

query-fs.lisp.

Special Variable: *query-loader-types*
Package

query-fs.

Source

query-fs.lisp.

Special Variable: *query-loaders*
Package

query-fs.

Source

query-fs.lisp.

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

5.2.2 Macros

Macro: compile-time-value (x)
Package

query-fs.

Source

query-fs.lisp.

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

5.2.3 Ordinary functions

Function: getenv (var-name)
Package

query-fs.

Source

query-fs.lisp.

Function: load-new-files ()
Package

query-fs.

Source

query-fs.lisp.

Function: prepare-description (desc)
Package

query-fs.

Source

query-fs.lisp.

Function: reload-plugins ()
Package

query-fs.

Source

query-fs.lisp.

Function: reload-queries ()
Package

query-fs.

Source

query-fs.lisp.

Function: remove-query (name)
Package

query-fs.

Source

query-fs.lisp.

Function: setenv (var-name val overwrite)
Package

query-fs.

Source

query-fs.lisp.

Previous: , Up: The query-fs Reference Manual   [Contents][Index]

Appendix A Indexes

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

A.1 Concepts

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

A.2 Functions

Jump to:   B   C   D   F   G   L   M   P   R   S   U  
Index Entry  Section
B
backtrace-error: Public ordinary functions
C
collect-entries: Public ordinary functions
compile-time-value: Private macros
D
def-linear-query-parser: Public macros
def-query-parser: Public macros
F
Function, backtrace-error: Public ordinary functions
Function, collect-entries: Public ordinary functions
Function, getenv: Private ordinary functions
Function, load-demo: Public ordinary functions
Function, load-new-files: Private ordinary functions
Function, load-plugin: Public ordinary functions
Function, load-query: Public ordinary functions
Function, prepare-description: Private ordinary functions
Function, reload-files: Public ordinary functions
Function, reload-plugins: Private ordinary functions
Function, reload-queries: Private ordinary functions
Function, remove-query: Private ordinary functions
Function, run-fs: Public ordinary functions
Function, run-fs-with-cmdline-args: Public ordinary functions
Function, setenv: Private ordinary functions
Function, update-description: Public ordinary functions
G
getenv: Private ordinary functions
L
load-demo: Public ordinary functions
load-new-files: Private ordinary functions
load-plugin: Public ordinary functions
load-query: Public ordinary functions
M
Macro, compile-time-value: Private macros
Macro, def-linear-query-parser: Public macros
Macro, def-query-parser: Public macros
P
prepare-description: Private ordinary functions
R
reload-files: Public ordinary functions
reload-plugins: Private ordinary functions
reload-queries: Private ordinary functions
remove-query: Private ordinary functions
run-fs: Public ordinary functions
run-fs-with-cmdline-args: Public ordinary functions
S
setenv: Private ordinary functions
U
update-description: Public ordinary functions
Jump to:   B   C   D   F   G   L   M   P   R   S   U