The file-local-variable Reference Manual

Table of Contents

The file-local-variable Reference Manual

This is the file-local-variable Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:28:10 2020 GMT+0.

1 Introduction

* File-Local-Variable  - File-local variable independent from ASDF

[[https://circleci.com/gh/guicho271828/file-local-variable][https://circleci.com/gh/guicho271828/file-local-variable.svg?style=svg]]

Implements a file-local variable using a carefully designed file-reloading scheme.

#+BEGIN_SRC lisp

(defpackage file-local-variable.example
  (:use :cl))

(in-package :file-local-variable.example)

(defun myhook (macrofn form env)
  (print form)
  (funcall macrofn form env))

(flv:file-local-bind *macroexpand-hook* 'myhook
                     *read-default-float-format* 'double-float)

(eval-when (:compile-toplevel) (print :compile-toplevel))
(eval-when (:load-toplevel)    (print :load-toplevel))
(eval-when (:execute)          (print :execute))

(eval-when (:compile-toplevel :load-toplevel :execute)
  (print '#.*macroexpand-hook*)         ; 'myhook
  (print (type-of 3.0)))                ; 'double-float

#+END_SRC

** syntax

The syntax is the same as =setf=.

: (file-local-bind var val &rest more)

** Related work

ASDF-FLV, but it depends on ASDF. by Didier Verna.

http://www.cliki.net/asdf-flv

CDR 9 proposal (File-local variables) by Didier Verna.

https://common-lisp.net/project/cdr/document/9/verna.11.cdr2.pdf

** How It Works

1. =flv:file-local-bind= dynamically binds the variable using =progv=, and
   opens the current =*compile-pathanme*=. Within the dynamic environment
   of =progv=, reread the file as follows:
   1. Skip the forms until the first appearance of =flv:file-local-bind=.
   2. Skip the =flv:file-local-bind= form.
   3. Read, then macroexpands the rest of the forms. Currently it depends
      on the implementation-specific =macroexpand-all=.
   4. =flv:file-local-bind= expands into a =progn= containing their
      expansion results.
2. Skips the rest of the forms by assigning =*dumb-readtable*= to
   =*readtable*= , i.e., a readtable which treats all characters
   as [[http://www.lispworks.com/documentation/HyperSpec/Body/02_ad.htm][whitespace characters]].
3. Since =*readtable*= is file-local as specified by ANSI, it is unbound when the file
   compilation finishes.

** Dependencies

This library is at least tested on implementation listed below:

+ SBCL 1.3.2 on X86-64 Linux  3.19.0-49-generic (author's environment)

Also, it depends on the following libraries:

+ iterate by  ::
    Jonathan Amsterdam's iterator/gatherer/accumulator facility

+ alexandria by  ::
    Alexandria is a collection of portable public domain utilities.

+ trivia  ::
    



** Installation


** Author

+ Masataro Asai (guicho2.71828@gmail.com)

* Copyright

Copyright (c) 2016 Masataro Asai (guicho2.71828@gmail.com)


* License

Licensed under the LLGPL License.

2 Systems

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

2.1 file-local-variable

Author

Masataro Asai

Contact

guicho2.71828@gmail.com

License

LLGPL

Description

File-local variable independent from ASDF

Version

0.1

Dependencies

• iterate
• alexandria
• trivia
• sb-cltl2

Source

file-local-variable.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 file-local-variable/src

Parent

file-local-variable (system)

Location

src/

Component

package.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 file-local-variable.asd

Location

file-local-variable.asd

Systems

file-local-variable (system)

Packages

file-local-variable-asd

4.1.2 file-local-variable/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

file-local-variable

Exported Definitions

file-local-bind (macro)

Internal Definitions

• *dumb-readtable* (special variable)
• recompile-with-flv (function)

5 Packages

Packages are listed by definition order.

5.1 file-local-variable-asd

Source

file-local-variable.asd

Use List

• asdf/interface
• common-lisp

5.2 file-local-variable

Source

package.lisp (file)

Nickname

flv

Use List

• trivia.level2
• alexandria
• iterate
• common-lisp

Exported Definitions

file-local-bind (macro)

Internal Definitions

• *dumb-readtable* (special variable)
• recompile-with-flv (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Macros

Macro: file-local-bind VARIABLE VALUE &rest MORE

Package

file-local-variable

Source

package.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *dumb-readtable*

Package

file-local-variable

Source

package.lisp (file)

6.2.2 Functions

Function: recompile-with-flv BINDINGS ENV

Package

file-local-variable

Source

package.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types