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

The asdf-encodings Reference Manual

This is the asdf-encodings Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 03:20:13 2023 GMT+0.

Table of Contents

Next: Systems, Previous: The asdf-encodings Reference Manual, Up: The asdf-encodings Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The asdf-encodings Reference Manual [Contents][Index]

2 Systems

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

asdf-encodings

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

2.1 `asdf-encodings`

Portable interface to character encodings and your implementation’s external-format

Author

Francois-Rene Rideau

Defsystem Dependency

asdf (system)., at least version "3.0"

Source

asdf-encodings.asd.

Child Components

pkgdcl.lisp (file).
encodings.lisp (file).
autodetect.lisp (file).
asdf-support.lisp (file).
initialization.lisp (file).

Next: Packages, Previous: Systems, Up: The asdf-encodings Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

asdf-encodings/asdf-encodings.asd
asdf-encodings/pkgdcl.lisp
asdf-encodings/encodings.lisp
asdf-encodings/autodetect.lisp
asdf-encodings/asdf-support.lisp
asdf-encodings/initialization.lisp

Next: asdf-encodings/pkgdcl.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `asdf-encodings/asdf-encodings.asd`

Source: asdf-encodings.asd.
Parent Component: asdf-encodings (system).
ASDF Systems: asdf-encodings.

Next: asdf-encodings/encodings.lisp, Previous: asdf-encodings/asdf-encodings.asd, Up: Lisp [Contents][Index]

3.1.2 `asdf-encodings/pkgdcl.lisp`

Source: asdf-encodings.asd.
Parent Component: asdf-encodings (system).
Packages: asdf-encodings.

Next: asdf-encodings/autodetect.lisp, Previous: asdf-encodings/pkgdcl.lisp, Up: Lisp [Contents][Index]

3.1.3 `asdf-encodings/encodings.lisp`

Dependency

pkgdcl.lisp (file).

Source

asdf-encodings.asd.

Parent Component

asdf-encodings (system).

Public Interface

find-implementation-encoding (function).
normalize-encoding (function).

Internals

*encodings* (special variable).
*normalized-encodings* (special variable).
initialize-normalized-encodings (function).

Next: asdf-encodings/asdf-support.lisp, Previous: asdf-encodings/encodings.lisp, Up: Lisp [Contents][Index]

3.1.4 `asdf-encodings/autodetect.lisp`

Dependency

pkgdcl.lisp (file).

Source

asdf-encodings.asd.

Parent Component

asdf-encodings (system).

Public Interface

detect-file-encoding (function).

Internals

decode-ascii-encoded-declaration (function).
detect-buffer-encoding-header (function).
detect-utf-8 (function).

Next: asdf-encodings/initialization.lisp, Previous: asdf-encodings/autodetect.lisp, Up: Lisp [Contents][Index]

3.1.5 `asdf-encodings/asdf-support.lisp`

Dependency

pkgdcl.lisp (file).

Source

asdf-encodings.asd.

Parent Component

asdf-encodings (system).

Public Interface

*on-unsupported-encoding* (special variable).
encoding-external-format (function).

Internals

register-asdf-encodings (function).

Previous: asdf-encodings/asdf-support.lisp, Up: Lisp [Contents][Index]

3.1.6 `asdf-encodings/initialization.lisp`

Dependencies

encodings.lisp (file).
autodetect.lisp (file).
asdf-support.lisp (file).

Source

asdf-encodings.asd.

Parent Component

asdf-encodings (system).

Next: Definitions, Previous: Files, Up: The asdf-encodings Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

asdf-encodings

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

4.1 `asdf-encodings`

Source

Use List

asdf/interface.
common-lisp.

Public Interface

*on-unsupported-encoding* (special variable).
detect-file-encoding (function).
encoding-external-format (function).
find-implementation-encoding (function).
normalize-encoding (function).

Internals

*encodings* (special variable).
*normalized-encodings* (special variable).
decode-ascii-encoded-declaration (function).
detect-buffer-encoding-header (function).
detect-utf-8 (function).
initialize-normalized-encodings (function).
register-asdf-encodings (function).

Next: Indexes, Previous: Packages, Up: The asdf-encodings Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Special variables
Ordinary functions

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

5.1.1 Special variables

Special Variable: *on-unsupported-encoding* ¶

One of :error, :warn or nil, specifies what to do when passed an unsupported encoding.

Package: asdf-encodings.
Source: asdf-support.lisp.

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

5.1.2 Ordinary functions

Function: detect-file-encoding (file) ¶

Package: asdf-encodings.
Source: autodetect.lisp.

Function: encoding-external-format (encoding &key on-error) ¶

Package: asdf-encodings.
Source: asdf-support.lisp.

Function: find-implementation-encoding (encoding) ¶

Package: asdf-encodings.
Source: encodings.lisp.

Function: normalize-encoding (encoding) ¶

Package: asdf-encodings.
Source: encodings.lisp.

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

5.2 Internals

Special variables
Ordinary functions

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

5.2.1 Special variables

Special Variable: *encodings* ¶

Package: asdf-encodings.
Source: encodings.lisp.

Special Variable: *normalized-encodings* ¶

Package: asdf-encodings.
Source: encodings.lisp.

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

5.2.2 Ordinary functions

Function: decode-ascii-encoded-declaration (buffer available start size offset) ¶

Package: asdf-encodings.
Source: autodetect.lisp.

Function: detect-buffer-encoding-header (buffer available) ¶

Package: asdf-encodings.
Source: autodetect.lisp.

Function: detect-utf-8 (file) ¶

Package: asdf-encodings.
Source: autodetect.lisp.

Function: initialize-normalized-encodings (&optional warn) ¶

Package: asdf-encodings.
Source: encodings.lisp.

Function: register-asdf-encodings () ¶

Package: asdf-encodings.
Source: asdf-support.lisp.

Previous: Definitions, Up: The asdf-encodings Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	D E F I N R

	Index Entry		Section

D
	`decode-ascii-encoded-declaration`:		Private ordinary functions
	`detect-buffer-encoding-header`:		Private ordinary functions
	`detect-file-encoding`:		Public ordinary functions
	`detect-utf-8`:		Private ordinary functions

E
	`encoding-external-format`:		Public ordinary functions

F
	`find-implementation-encoding`:		Public ordinary functions
	`Function, decode-ascii-encoded-declaration`:		Private ordinary functions
	`Function, detect-buffer-encoding-header`:		Private ordinary functions
	`Function, detect-file-encoding`:		Public ordinary functions
	`Function, detect-utf-8`:		Private ordinary functions
	`Function, encoding-external-format`:		Public ordinary functions
	`Function, find-implementation-encoding`:		Public ordinary functions
	`Function, initialize-normalized-encodings`:		Private ordinary functions
	`Function, normalize-encoding`:		Public ordinary functions
	`Function, register-asdf-encodings`:		Private ordinary functions

I
	`initialize-normalized-encodings`:		Private ordinary functions

N
	`normalize-encoding`:		Public ordinary functions

R
	`register-asdf-encodings`:		Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry		Section

*
	`encodings`:		Private special variables
	`normalized-encodings`:		Private special variables
	`on-unsupported-encoding`:		Public special variables

S
	`Special Variable, encodings`:		Private special variables
	`Special Variable, normalized-encodings`:		Private special variables
	`Special Variable, on-unsupported-encoding`:		Public special variables

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

A.4 Data types

Jump to:	A E F I P S

	Index Entry		Section

A
	`asdf-encodings`:		The asdf-encodings system
	`asdf-encodings`:		The asdf-encodings package
	`asdf-encodings.asd`:		The asdf-encodings/asdf-encodings․asd file
	`asdf-support.lisp`:		The asdf-encodings/asdf-support․lisp file
	`autodetect.lisp`:		The asdf-encodings/autodetect․lisp file

E
	`encodings.lisp`:		The asdf-encodings/encodings․lisp file

F
	`File, asdf-encodings.asd`:		The asdf-encodings/asdf-encodings․asd file
	`File, asdf-support.lisp`:		The asdf-encodings/asdf-support․lisp file
	`File, autodetect.lisp`:		The asdf-encodings/autodetect․lisp file
	`File, encodings.lisp`:		The asdf-encodings/encodings․lisp file
	`File, initialization.lisp`:		The asdf-encodings/initialization․lisp file
	`File, pkgdcl.lisp`:		The asdf-encodings/pkgdcl․lisp file

I
	`initialization.lisp`:		The asdf-encodings/initialization․lisp file

P
	`Package, asdf-encodings`:		The asdf-encodings package
	`pkgdcl.lisp`:		The asdf-encodings/pkgdcl․lisp file

S
	`System, asdf-encodings`:		The asdf-encodings system