The grovel-locally Reference Manual

Table of Contents

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

The grovel-locally Reference Manual

This is the grovel-locally Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:45:38 2018 GMT+0.


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

1 Introduction

grovel-locally

Grovels as usual except that it builds the wrappers in a platform-specific system-local directory.

Where you usually use :wrapper-file you can use :caching-wrapper-file and in place of :grovel-file you can use :caching-grovel-file. You can then specify the directory local to the component that will be used to store the built files using :cache-dir.

For example:

(:caching-wrapper-file "libspec" :soname "libnuklear" :cache-dir "cache")

Also adds the include-local spec directive which let's you include header files specified as :static-files in your .asd file

Note

This project (by design) builds thing locally to the system directory. There are very valid reasons you may want to avoid that. In those cases, don't use this.


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

2 Systems

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


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

2.1 grovel-locally

Author

Chris Bagley (Baggers) <techsnuffle@gmail.com>

License

BSD 2 Clause

Description

Grovel using cffi and cache the result locally to the system

Dependencies
Source

grovel-locally.asd (file)

Components

Next: , Previous: , Up: Top   [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 files   [Contents][Index]

3.1.1 grovel-locally.asd

Location

grovel-locally.asd

Systems

grovel-locally (system)


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

3.1.2 grovel-locally/package.lisp

Parent

grovel-locally (system)

Location

package.lisp

Packages

grovel-locally


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

3.1.3 grovel-locally/os-id.lisp

Dependency

package.lisp (file)

Parent

grovel-locally (system)

Location

os-id.lisp

Internal Definitions

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

3.1.4 grovel-locally/helpers.lisp

Dependency

os-id.lisp (file)

Parent

grovel-locally (system)

Location

helpers.lisp

Internal Definitions

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

3.1.5 grovel-locally/local-include.lisp

Dependency

helpers.lisp (file)

Parent

grovel-locally (system)

Location

local-include.lisp

Internal Definitions

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

3.1.6 grovel-locally/grovel.lisp

Dependency

local-include.lisp (file)

Parent

grovel-locally (system)

Location

grovel.lisp

Internal Definitions

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

3.1.7 grovel-locally/wrap.lisp

Dependency

grovel.lisp (file)

Parent

grovel-locally (system)

Location

wrap.lisp

Internal Definitions

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

3.1.8 grovel-locally/asdf.lisp

Dependency

wrap.lisp (file)

Parent

grovel-locally (system)

Location

asdf.lisp

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 grovel-locally

Source

package.lisp (file)

Use List
Internal Definitions

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

5 Definitions

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


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

5.1 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *local-includes*
Package

grovel-locally

Source

local-include.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.1.2 Functions

Function: asdf-path SYSTEM &rest PATH
Package

grovel-locally

Source

helpers.lisp (file)

Function: copy-local-includes-to-cache IN-DIR
Package

grovel-locally

Source

local-include.lisp (file)

Function: djb2 STRING
Package

grovel-locally

Source

helpers.lisp (file)

Function: ensure-fresh-dir ABS-PATH
Package

grovel-locally

Source

helpers.lisp (file)

Function: feature-specific-cache-dir CACHE-DIR FEATURE-EXPRESSIONS
Package

grovel-locally

Source

helpers.lisp (file)

Function: feature-specific-cache-file FILE-NAME CACHE-DIR FEATURE-EXPRESSIONS
Package

grovel-locally

Source

helpers.lisp (file)

Function: gen-feature-hash FEATURES
Package

grovel-locally

Source

helpers.lisp (file)

Function: generate-bindings-file* LIB-SONAME LISP-FORMS OUTPUT-DEFAULTS SYSTEM SYS-LOCAL-LIB-NAME
Package

grovel-locally

Source

wrap.lisp (file)

Function: generate-c-file* C-FILE FORMS
Package

grovel-locally

Source

grovel.lisp (file)

Function: generate-c-lib-file INPUT-DATA C-FILE
Package

grovel-locally

Source

wrap.lisp (file)

Function: get-spec-features INPUT-FILE
Package

grovel-locally

Source

helpers.lisp (file)

Function: os-id ()
Package

grovel-locally

Source

os-id.lisp (file)

Function: posix-os-id ()
Package

grovel-locally

Source

os-id.lisp (file)

Function: process-from-cache-p SYSTEM CACHED-LISP-FILE CACHED-LIB-FILE
Package

grovel-locally

Source

wrap.lisp (file)

Function: process-grovel-file* INPUT-FILE DEST-LISP-FILE C-FILE EXE-FILE
Package

grovel-locally

Source

grovel.lisp (file)

Function: process-grovel-file-from-scratch FORMS DEST-LISP-FILE C-FILE EXE-FILE
Package

grovel-locally

Source

grovel.lisp (file)

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 (file)

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 (file)

Function: processed-os-id ()
Package

grovel-locally

Source

helpers.lisp (file)

Function: push-local-include PATH
Package

grovel-locally

Source

local-include.lisp (file)

Function: read-grovel-file* INPUT-FILE
Package

grovel-locally

Source

grovel.lisp (file)

Function: read-wrapper-spec INPUT-FILE
Package

grovel-locally

Source

wrap.lisp (file)

Function: sys-relative-cache-dir C
Package

grovel-locally

Source

asdf.lisp (file)

Function: system-to-component-path COMPONENT
Package

grovel-locally

Source

asdf.lisp (file)

Function: touch-file PATHNAME
Package

grovel-locally

Source

helpers.lisp (file)

Function: win-os-id ()
Package

grovel-locally

Source

os-id.lisp (file)

Function: win-os-val-to-name VAL
Package

grovel-locally

Source

os-id.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.1.3 Generic functions

Generic Function: cache-dir-of OBJECT
Generic Function: (setf cache-dir-of) NEW-VALUE OBJECT
Package

grovel-locally

Methods
Method: cache-dir-of (CACHING-WRAPPER-FILE caching-wrapper-file)

automatically generated reader method

Source

asdf.lisp (file)

Method: (setf cache-dir-of) NEW-VALUE (CACHING-WRAPPER-FILE caching-wrapper-file)

automatically generated writer method

Source

asdf.lisp (file)

Method: cache-dir-of (CACHING-GROVEL-FILE caching-grovel-file)

automatically generated reader method

Source

asdf.lisp (file)

Method: (setf cache-dir-of) NEW-VALUE (CACHING-GROVEL-FILE caching-grovel-file)

automatically generated writer method

Source

asdf.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.1.4 Classes

Class: caching-grovel-file ()
Package

grovel-locally

Source

asdf.lisp (file)

Direct superclasses

grovel-file (class)

Direct methods
  • output-files (method)
  • perform (method)
  • cache-dir-of (method)
  • cache-dir-of (method)
Direct slots
Slot: cache-dir
Initargs

:cache-dir

Readers

cache-dir-of (generic function)

Writers

(setf cache-dir-of) (generic function)

Class: caching-wrapper-file ()
Package

grovel-locally

Source

asdf.lisp (file)

Direct superclasses

wrapper-file (class)

Direct methods
  • output-files (method)
  • perform (method)
  • cache-dir-of (method)
  • cache-dir-of (method)
Direct slots
Slot: cache-dir
Initargs

:cache-dir

Readers

cache-dir-of (generic function)

Writers

(setf cache-dir-of) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   G   L  
Index Entry  Section

F
File, Lisp, grovel-locally.asd: The grovel-locally<dot>asd file
File, Lisp, grovel-locally/asdf.lisp: The grovel-locally/asdf<dot>lisp file
File, Lisp, grovel-locally/grovel.lisp: The grovel-locally/grovel<dot>lisp file
File, Lisp, grovel-locally/helpers.lisp: The grovel-locally/helpers<dot>lisp file
File, Lisp, grovel-locally/local-include.lisp: The grovel-locally/local-include<dot>lisp file
File, Lisp, grovel-locally/os-id.lisp: The grovel-locally/os-id<dot>lisp file
File, Lisp, grovel-locally/package.lisp: The grovel-locally/package<dot>lisp file
File, Lisp, grovel-locally/wrap.lisp: The grovel-locally/wrap<dot>lisp file

G
grovel-locally.asd: The grovel-locally<dot>asd file
grovel-locally/asdf.lisp: The grovel-locally/asdf<dot>lisp file
grovel-locally/grovel.lisp: The grovel-locally/grovel<dot>lisp file
grovel-locally/helpers.lisp: The grovel-locally/helpers<dot>lisp file
grovel-locally/local-include.lisp: The grovel-locally/local-include<dot>lisp file
grovel-locally/os-id.lisp: The grovel-locally/os-id<dot>lisp file
grovel-locally/package.lisp: The grovel-locally/package<dot>lisp file
grovel-locally/wrap.lisp: The grovel-locally/wrap<dot>lisp file

L
Lisp File, grovel-locally.asd: The grovel-locally<dot>asd file
Lisp File, grovel-locally/asdf.lisp: The grovel-locally/asdf<dot>lisp file
Lisp File, grovel-locally/grovel.lisp: The grovel-locally/grovel<dot>lisp file
Lisp File, grovel-locally/helpers.lisp: The grovel-locally/helpers<dot>lisp file
Lisp File, grovel-locally/local-include.lisp: The grovel-locally/local-include<dot>lisp file
Lisp File, grovel-locally/os-id.lisp: The grovel-locally/os-id<dot>lisp file
Lisp File, grovel-locally/package.lisp: The grovel-locally/package<dot>lisp file
Lisp File, grovel-locally/wrap.lisp: The grovel-locally/wrap<dot>lisp file

Jump to:   F   G   L  

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

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): Internal generic functions
(setf cache-dir-of): Internal generic functions
(setf cache-dir-of): Internal generic functions

A
asdf-path: Internal functions

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

D
djb2: Internal functions

E
ensure-fresh-dir: Internal functions

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

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

M
Method, (setf cache-dir-of): Internal generic functions
Method, (setf cache-dir-of): Internal generic functions
Method, cache-dir-of: Internal generic functions
Method, cache-dir-of: Internal generic functions

O
os-id: Internal functions

P
posix-os-id: Internal functions
process-from-cache-p: Internal functions
process-grovel-file*: Internal functions
process-grovel-file-from-scratch: Internal functions
process-wrapper-file*: Internal functions
process-wrapper-file-from-scratch: Internal functions
processed-os-id: Internal functions
push-local-include: Internal functions

R
read-grovel-file*: Internal functions
read-wrapper-spec: Internal functions

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

T
touch-file: Internal functions

W
win-os-id: Internal functions
win-os-val-to-name: Internal functions

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

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

A.3 Variables

Jump to:   *  
C   S  
Index Entry  Section

*
*local-includes*: Internal special variables

C
cache-dir: Internal classes
cache-dir: Internal classes

S
Slot, cache-dir: Internal classes
Slot, cache-dir: Internal classes
Special Variable, *local-includes*: Internal special variables

Jump to:   *  
C   S  

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

A.4 Data types

Jump to:   C   G   P   S  
Index Entry  Section

C
caching-grovel-file: Internal classes
caching-wrapper-file: Internal classes
Class, caching-grovel-file: Internal classes
Class, caching-wrapper-file: Internal classes

G
grovel-locally: The grovel-locally system
grovel-locally: The grovel-locally package

P
Package, grovel-locally: The grovel-locally package

S
System, grovel-locally: The grovel-locally system

Jump to:   C   G   P   S