The asdf-linguist Reference Manual

Table of Contents

The asdf-linguist Reference Manual

This is the asdf-linguist Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:46:38 2018 GMT+0.

1 Introduction

asdf-linguist

ASDF-linguist is a set of extensions to the ASDF build system for Common Lisp for compiling various languages and running various preprocessing tools (Sass, LESS, etc.) on files in your project.

ASDF is very easy to extend to handle other languages within the same project, eg. compiling C source files, but this ease of extensibility leads to people reimplementing these basic capabilities in different, ad-hoc ways. This system attempts to solve this by providing one and only one way to do these things.

Extensions

• Languages
  • C
  • C++
  • Fortran
• Web
  • CSS preprocessors
    • LESS ✓
    • Myth ✓
    • Sass ✓
  • Tools
    • CSS/JSS Minifiers
      • YUI Compressor ✓
  • Compile-to-Javascript
    • CoffeeScript ✓
    • ParenScript
    • Roy ✓
• Build systems
  • Make ✓
  • CMake
• Tools
  • Text Processing
    • org-mode
    • pandoc
  • Graphics
    • dot ✓
    • ditaa ✓

License

Copyright (c) 2014-2015 Fernando Borretti eudoxiahp@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS

2 Systems

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

2.1 asdf-linguist

Author

Fernando Borretti

Contact

eudoxiahp@gmail.com

License

MIT

Description

Extensions for ASDF.

Long Description

# asdf-linguist

[](https://travis-ci.org/eudoxia0/asdf-linguist)

ASDF-linguist is a set of extensions to the ASDF build system for Common Lisp
for compiling various languages and running various preprocessing tools (Sass,
LESS, etc.) on files in your project.

ASDF is very easy to extend to handle other languages within the same project,
eg. compiling C source files, but this ease of extensibility leads to people
reimplementing these basic capabilities in different, ad-hoc ways. This system
attempts to solve this by providing one and only one way to do these things.

# Extensions

* Languages
* C
* C++
* Fortran
* Web
* CSS preprocessors
* [LESS](http://lesscss.org/) ✓
* [Myth](http://www.myth.io/) ✓
* [Sass](http://sass-lang.com/) ✓
* Tools
* CSS/JSS Minifiers
* [YUI Compressor](http://yui.github.io/yuicompressor/) ✓
* Compile-to-Javascript
* [CoffeeScript](http://coffeescript.org/) ✓
* [ParenScript](http://common-lisp.net/projects/parenscript/)
* [Roy](http://roy.brianmckenna.org/) ✓
* Build systems
* Make ✓
* CMake
* Tools
* Text Processing
* [org-mode](http://orgmode.org/)
* [pandoc](http://johnmacfarlane.net/pandoc/)
* Graphics
* [dot](http://www.graphviz.org/) ✓
* [ditaa](http://ditaa.sourceforge.net/) ✓

# License

Copyright (c) 2014-2015 Fernando Borretti <eudoxiahp@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Version

0.1

Dependencies

• asdf
• inferior-shell
• parenscript

Source

asdf-linguist.asd (file)

Component

src (module)

3 Modules

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

3.1 asdf-linguist/src

Parent

asdf-linguist (system)

Location

src/

Components

• base.lisp (file)
• lang (module)
• www (module)
• build-systems (module)
• graphics.lisp (file)
• text (module)

3.2 asdf-linguist/src/lang

Dependency

base.lisp (file)

Parent

src (module)

Location

src/lang/

Component

c.lisp (file)

3.3 asdf-linguist/src/www

Dependency

lang (module)

Parent

src (module)

Location

src/www/

Components

• css.lisp (file)
• js.lisp (file)
• tools.lisp (file)

3.4 asdf-linguist/src/build-systems

Dependency

www (module)

Parent

src (module)

Location

src/build-systems/

Component

make.lisp (file)

3.5 asdf-linguist/src/text

Dependency

graphics.lisp (file)

Parent

src (module)

Location

src/text/

Components

• flex.lisp (file)
• pandoc.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 asdf-linguist.asd

Location

asdf-linguist.asd

Systems

asdf-linguist (system)

4.1.2 asdf-linguist/src/base.lisp

Parent

src (module)

Location

src/base.lisp

Packages

asdf-linguist

Internal Definitions

• define-component (macro)
• define-shell-component (macro)
• ensure-list (function)
• output-pathname (function)

4.1.3 asdf-linguist/src/lang/c.lisp

Parent

lang (module)

Location

src/lang/c.lisp

Internal Definitions

• c->bin (class)
• link (method)
• output (method)

4.1.4 asdf-linguist/src/www/css.lisp

Parent

www (module)

Location

src/www/css.lisp

Internal Definitions

• less (class)
• myth (class)
• output (method)
• output (method)
• output (method)
• output (method)
• sass (class)
• sass-strict (class)

4.1.5 asdf-linguist/src/www/js.lisp

Parent

www (module)

Location

src/www/js.lisp

Internal Definitions

• coffee (class)
• output (method)
• output (method)
• output (method)
• parenscript (class)
• roy (class)

4.1.6 asdf-linguist/src/www/tools.lisp

Parent

www (module)

Location

src/www/tools.lisp

Internal Definitions

• css-minify (class)
• js-minify (class)
• output (method)
• output (method)

4.1.7 asdf-linguist/src/build-systems/make.lisp

Parent

build-systems (module)

Location

src/build-systems/make.lisp

Internal Definitions

output (method)

4.1.8 asdf-linguist/src/graphics.lisp

Dependency

build-systems (module)

Parent

src (module)

Location

src/graphics.lisp

Internal Definitions

• ditaa (class)
• dot (class)
• output (method)
• output (method)

4.1.9 asdf-linguist/src/text/flex.lisp

Parent

text (module)

Location

src/text/flex.lisp

Internal Definitions

• flex (class)
• output (method)

4.1.10 asdf-linguist/src/text/pandoc.lisp

Parent

text (module)

Location

src/text/pandoc.lisp

Internal Definitions

• input-format (method)
• input-type (method)
• options (method)
• output (method)
• output-extension (method)
• output-type (method)
• pandoc (class)

5 Packages

Packages are listed by definition order.

5.1 asdf-linguist

Source

base.lisp (file)

Use List

• asdf/interface
• common-lisp

Internal Definitions

• c->bin (class)
• coffee (class)
• css-minify (class)
• define-component (macro)
• define-shell-component (macro)
• ditaa (class)
• dot (class)
• ensure-list (function)
• flex (class)
• input-format (generic function)
• input-format (method)
• input-type (generic function)
• input-type (method)
• js-minify (class)
• less (class)
• link (generic function)
• link (method)
• myth (class)
• options (generic function)
• options (method)
• output (generic function)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output (method)
• output-extension (generic function)
• output-extension (method)
• output-pathname (function)
• output-type (generic function)
• output-type (method)
• pandoc (class)
• parenscript (class)
• roy (class)
• sass (class)
• sass-strict (class)

6 Definitions

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

6.1 Internal definitions

6.1.1 Macros

Macro: define-component NAME &key INPUT-TYPE OUTPUT-TYPE COMPILE-FUNCTION

Define an ASDF component.

Package

asdf-linguist

Source

base.lisp (file)

Macro: define-shell-component NAME &key INPUT-TYPE OUTPUT-TYPE SHELL-COMMAND

Define an ASDF component that’s compiled by running a shell command.

Package

asdf-linguist

Source

base.lisp (file)

6.1.2 Functions

Function: ensure-list OBJ

Package

asdf-linguist

Source

base.lisp (file)

Function: output-pathname COMPONENT &optional OUTPUT-TYPE NAME

Package

asdf-linguist

Source

base.lisp (file)

6.1.3 Generic functions

Generic Function: input-format OBJECT

Package

asdf-linguist

Methods

Method: input-format (PANDOC pandoc)

automatically generated reader method

Source

pandoc.lisp (file)

Generic Function: input-type OBJECT

Package

asdf-linguist

Methods

Method: input-type (PANDOC pandoc)

automatically generated reader method

Source

pandoc.lisp (file)

Generic Function: link OBJECT

Package

asdf-linguist

Methods

Method: link (C->BIN c->bin)

automatically generated reader method

Source

c.lisp (file)

Generic Function: options OBJECT

Package

asdf-linguist

Methods

Method: options (PANDOC pandoc)

automatically generated reader method

Source

pandoc.lisp (file)

Generic Function: output OBJECT

Package

asdf-linguist

Methods

Method: output (PANDOC pandoc)

automatically generated reader method

Source

pandoc.lisp (file)

Method: output (FLEX flex)

automatically generated reader method

Source

flex.lisp (file)

Method: output (DOT dot)

automatically generated reader method

Source

graphics.lisp (file)

Method: output (DITAA ditaa)

automatically generated reader method

Source

graphics.lisp (file)

Method: output (MAKE make)

automatically generated reader method

Source

make.lisp (file)

Method: output (JS-MINIFY js-minify)

automatically generated reader method

Source

tools.lisp (file)

Method: output (CSS-MINIFY css-minify)

automatically generated reader method

Source

tools.lisp (file)

Method: output (PARENSCRIPT parenscript)

automatically generated reader method

Source

js.lisp (file)

Method: output (ROY roy)

automatically generated reader method

Source

js.lisp (file)

Method: output (COFFEE coffee)

automatically generated reader method

Source

js.lisp (file)

Method: output (MYTH myth)

automatically generated reader method

Source

css.lisp (file)

Method: output (SASS-STRICT sass-strict)

automatically generated reader method

Source

css.lisp (file)

Method: output (SASS sass)

automatically generated reader method

Source

css.lisp (file)

Method: output (LESS less)

automatically generated reader method

Source

css.lisp (file)

Method: output (C->BIN c->bin)

automatically generated reader method

Source

c.lisp (file)

Generic Function: output-extension OBJECT

Package

asdf-linguist

Methods

Method: output-extension (PANDOC pandoc)

automatically generated reader method

Source

pandoc.lisp (file)

Generic Function: output-type OBJECT

Package

asdf-linguist

Methods

Method: output-type (PANDOC pandoc)

automatically generated reader method

Source

pandoc.lisp (file)

6.1.4 Classes

Class: c->bin ()

Package

asdf-linguist

Source

c.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• link (method)
• output (method)

Direct slots

Slot: type

Initform

"c"

Slot: output

Initargs

:output

Readers

output (generic function)

Slot: link

Initargs

:link

Readers

link (generic function)

Class: coffee ()

Package

asdf-linguist

Source

js.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"coffee"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: css-minify ()

Package

asdf-linguist

Source

tools.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"css"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: ditaa ()

Package

asdf-linguist

Source

graphics.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"ditaa"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: dot ()

Package

asdf-linguist

Source

graphics.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"dot"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: flex ()

Package

asdf-linguist

Source

flex.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"l"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: js-minify ()

Package

asdf-linguist

Source

tools.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"js"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: less ()

Package

asdf-linguist

Source

css.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"less"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: myth ()

Package

asdf-linguist

Source

css.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"myth"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: pandoc ()

Package

asdf-linguist

Source

pandoc.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• options (method)
• output-extension (method)
• output-type (method)
• output (method)
• input-format (method)
• input-type (method)

Direct slots

Slot: type

Initargs

:type

Readers

input-type (generic function)

Slot: input-format

Initargs

:input-type

Readers

input-format (generic function)

Slot: output

Initargs

:output

Readers

output (generic function)

Slot: output-type

Initargs

:output-type

Readers

output-type (generic function)

Slot: output-extension

Initargs

:output-extension

Readers

output-extension (generic function)

Slot: options

Initargs

:options

Initform

""

Readers

options (generic function)

Class: parenscript ()

Package

asdf-linguist

Source

js.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"lisp"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: roy ()

Package

asdf-linguist

Source

js.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"roy"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: sass ()

Package

asdf-linguist

Source

css.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"scss"

Slot: output

Initargs

:output

Readers

output (generic function)

Class: sass-strict ()

Package

asdf-linguist

Source

css.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• output (method)

Direct slots

Slot: type

Initform

"sass"

Slot: output

Initargs

:output

Readers

output (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types