The grovel-locally Reference Manual

This is the grovel-locally Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:35:14 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 grovel-locally

Grovel using cffi and cache the result locally to the system

Author

Chris Bagley (Baggers) <>

License

BSD 2 Clause

Dependencies
  • cffi (system).
  • cffi-grovel (system).
  • with-cached-reader-conditionals (system).
  • alexandria (system).
  • cl-ppcre (system).
Source

grovel-locally.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 grovel-locally/grovel-locally.asd

Source

grovel-locally.asd.

Parent Component

grovel-locally (system).

ASDF Systems

grovel-locally.


3.1.2 grovel-locally/package.lisp

Source

grovel-locally.asd.

Parent Component

grovel-locally (system).

Packages

grovel-locally.


3.1.3 grovel-locally/os-id.lisp

Dependency

package.lisp (file).

Source

grovel-locally.asd.

Parent Component

grovel-locally (system).

Internals

3.1.4 grovel-locally/helpers.lisp

Dependency

os-id.lisp (file).

Source

grovel-locally.asd.

Parent Component

grovel-locally (system).

Internals

3.1.5 grovel-locally/local-include.lisp

Dependency

helpers.lisp (file).

Source

grovel-locally.asd.

Parent Component

grovel-locally (system).

Internals

3.1.6 grovel-locally/grovel.lisp

Dependency

local-include.lisp (file).

Source

grovel-locally.asd.

Parent Component

grovel-locally (system).

Internals

3.1.7 grovel-locally/wrap.lisp

Dependency

grovel.lisp (file).

Source

grovel-locally.asd.

Parent Component

grovel-locally (system).

Internals

3.1.8 grovel-locally/asdf.lisp

Dependency

wrap.lisp (file).

Source

grovel-locally.asd.

Parent Component

grovel-locally (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 grovel-locally

Source

package.lisp.

Use List
  • asdf/interface.
  • cffi-grovel.
  • common-lisp.
  • uiop/driver.
  • with-cached-reader-conditionals.
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Standalone methods

Method: output-files ((op process-op) (c caching-wrapper-file))
Package

asdf/action.

Source

asdf.lisp.

Method: output-files ((op process-op) (c caching-grovel-file))
Package

asdf/action.

Source

asdf.lisp.

Method: perform ((op process-op) (c caching-wrapper-file))
Package

asdf/action.

Source

asdf.lisp.

Method: perform ((op process-op) (c caching-grovel-file))
Package

asdf/action.

Source

asdf.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *local-includes*
Package

grovel-locally.

Source

local-include.lisp.


5.2.2 Ordinary functions

Function: asdf-path (system &rest path)
Package

grovel-locally.

Source

helpers.lisp.

Function: copy-local-includes-to-cache (in-dir)
Package

grovel-locally.

Source

local-include.lisp.

Function: djb2 (string)
Package

grovel-locally.

Source

helpers.lisp.

Function: ensure-fresh-dir (abs-path)
Package

grovel-locally.

Source

helpers.lisp.

Function: feature-specific-cache-dir (cache-dir feature-expressions)
Package

grovel-locally.

Source

helpers.lisp.

Function: feature-specific-cache-file (file-name cache-dir feature-expressions)
Package

grovel-locally.

Source

helpers.lisp.

Function: gen-feature-hash (features)
Package

grovel-locally.

Source

helpers.lisp.

Function: generate-bindings-file* (lib-soname lisp-forms output-defaults system sys-local-lib-name)
Package

grovel-locally.

Source

wrap.lisp.

Function: generate-c-file* (c-file forms)
Package

grovel-locally.

Source

grovel.lisp.

Function: generate-c-lib-file (input-data c-file)
Package

grovel-locally.

Source

wrap.lisp.

Function: get-spec-features (input-file)
Package

grovel-locally.

Source

helpers.lisp.

Function: os-id ()
Package

grovel-locally.

Source

os-id.lisp.

Function: posix-os-id ()
Package

grovel-locally.

Source

os-id.lisp.

Function: process-from-cache-p (system cached-lisp-file cached-lib-file)
Package

grovel-locally.

Source

wrap.lisp.

Function: process-grovel-file* (input-file dest-lisp-file c-file exe-file)
Package

grovel-locally.

Source

grovel.lisp.

Function: process-grovel-file-from-scratch (forms dest-lisp-file c-file exe-file)
Package

grovel-locally.

Source

grovel.lisp.

Function: process-wrapper-file* (system spec-file dest-lisp-file dest-lib-file c-file o-file lib-soname sys-local-lib-name)
Package

grovel-locally.

Source

wrap.lisp.

Function: process-wrapper-file-from-scratch (system input-data dest-lisp-file lib-soname lib-file c-file o-file sys-local-lib-name)
Package

grovel-locally.

Source

wrap.lisp.

Function: processed-os-id ()
Package

grovel-locally.

Source

helpers.lisp.

Function: push-local-include (path)
Package

grovel-locally.

Source

local-include.lisp.

Function: read-grovel-file* (input-file)
Package

grovel-locally.

Source

grovel.lisp.

Function: read-wrapper-spec (input-file)
Package

grovel-locally.

Source

wrap.lisp.

Function: sys-relative-cache-dir (c)
Package

grovel-locally.

Source

asdf.lisp.

Function: system-to-component-path (component)
Package

grovel-locally.

Source

asdf.lisp.

Function: touch-file (pathname)
Package

grovel-locally.

Source

helpers.lisp.

Function: win-os-id ()
Package

grovel-locally.

Source

os-id.lisp.

Function: win-os-val-to-name (val)
Package

grovel-locally.

Source

os-id.lisp.


5.2.3 Generic functions

Generic Reader: cache-dir-of (object)
Package

grovel-locally.

Methods
Reader Method: cache-dir-of ((caching-wrapper-file caching-wrapper-file))

automatically generated reader method

Source

asdf.lisp.

Target Slot

cache-dir.

Reader Method: cache-dir-of ((caching-grovel-file caching-grovel-file))

automatically generated reader method

Source

asdf.lisp.

Target Slot

cache-dir.

Generic Writer: (setf cache-dir-of) (object)
Package

grovel-locally.

Methods
Writer Method: (setf cache-dir-of) ((caching-wrapper-file caching-wrapper-file))

automatically generated writer method

Source

asdf.lisp.

Target Slot

cache-dir.

Writer Method: (setf cache-dir-of) ((caching-grovel-file caching-grovel-file))

automatically generated writer method

Source

asdf.lisp.

Target Slot

cache-dir.


5.2.4 Classes

Class: caching-grovel-file
Package

grovel-locally.

Source

asdf.lisp.

Direct superclasses

grovel-file.

Direct methods
Direct slots
Slot: cache-dir
Initargs

:cache-dir

Readers

cache-dir-of.

Writers

(setf cache-dir-of).

Class: caching-wrapper-file
Package

grovel-locally.

Source

asdf.lisp.

Direct superclasses

wrapper-file.

Direct methods
Direct slots
Slot: cache-dir
Initargs

:cache-dir

Readers

cache-dir-of.

Writers

(setf cache-dir-of).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   M   O   P   R   S   T   W  
Index Entry  Section

(
(setf cache-dir-of): Private generic functions
(setf cache-dir-of): Private generic functions
(setf cache-dir-of): Private generic functions

A
asdf-path: Private ordinary functions

C
cache-dir-of: Private generic functions
cache-dir-of: Private generic functions
cache-dir-of: Private generic functions
copy-local-includes-to-cache: Private ordinary functions

D
djb2: Private ordinary functions

E
ensure-fresh-dir: Private ordinary functions

F
feature-specific-cache-dir: Private ordinary functions
feature-specific-cache-file: Private ordinary functions
Function, asdf-path: Private ordinary functions
Function, copy-local-includes-to-cache: Private ordinary functions
Function, djb2: Private ordinary functions
Function, ensure-fresh-dir: Private ordinary functions
Function, feature-specific-cache-dir: Private ordinary functions
Function, feature-specific-cache-file: Private ordinary functions
Function, gen-feature-hash: Private ordinary functions
Function, generate-bindings-file*: Private ordinary functions
Function, generate-c-file*: Private ordinary functions
Function, generate-c-lib-file: Private ordinary functions
Function, get-spec-features: Private ordinary functions
Function, os-id: Private ordinary functions
Function, posix-os-id: Private ordinary functions
Function, process-from-cache-p: Private ordinary functions
Function, process-grovel-file*: Private ordinary functions
Function, process-grovel-file-from-scratch: Private ordinary functions
Function, process-wrapper-file*: Private ordinary functions
Function, process-wrapper-file-from-scratch: Private ordinary functions
Function, processed-os-id: Private ordinary functions
Function, push-local-include: Private ordinary functions
Function, read-grovel-file*: Private ordinary functions
Function, read-wrapper-spec: Private ordinary functions
Function, sys-relative-cache-dir: Private ordinary functions
Function, system-to-component-path: Private ordinary functions
Function, touch-file: Private ordinary functions
Function, win-os-id: Private ordinary functions
Function, win-os-val-to-name: Private ordinary functions

G
gen-feature-hash: Private ordinary functions
generate-bindings-file*: Private ordinary functions
generate-c-file*: Private ordinary functions
generate-c-lib-file: Private ordinary functions
Generic Function, (setf cache-dir-of): Private generic functions
Generic Function, cache-dir-of: Private generic functions
get-spec-features: Private ordinary functions

M
Method, (setf cache-dir-of): Private generic functions
Method, (setf cache-dir-of): Private generic functions
Method, cache-dir-of: Private generic functions
Method, cache-dir-of: Private generic functions
Method, output-files: Public standalone methods
Method, output-files: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods

O
os-id: Private ordinary functions
output-files: Public standalone methods
output-files: Public standalone methods

P
perform: Public standalone methods
perform: Public standalone methods
posix-os-id: Private ordinary functions
process-from-cache-p: Private ordinary functions
process-grovel-file*: Private ordinary functions
process-grovel-file-from-scratch: Private ordinary functions
process-wrapper-file*: Private ordinary functions
process-wrapper-file-from-scratch: Private ordinary functions
processed-os-id: Private ordinary functions
push-local-include: Private ordinary functions

R
read-grovel-file*: Private ordinary functions
read-wrapper-spec: Private ordinary functions

S
sys-relative-cache-dir: Private ordinary functions
system-to-component-path: Private ordinary functions

T
touch-file: Private ordinary functions

W
win-os-id: Private ordinary functions
win-os-val-to-name: Private ordinary functions


A.4 Data types