The cl-iconv Reference Manual

Table of Contents

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

The cl-iconv Reference Manual

This is the cl-iconv Reference Manual, version 0.3, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:21:57 2018 GMT+0.


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

1 Systems

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


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

1.1 iconv

Author

Yoshinori Tahara <read.eval.print@gmail.com>

Version

0.3

Defsystem Dependency

cffi-grovel

Dependency

cffi

Source

iconv.asd (file)

Components

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

2 Files

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


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

2.1 Lisp


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

2.1.1 iconv.asd

Location

iconv.asd

Systems

iconv (system)


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

2.1.2 iconv/package.lisp

Parent

iconv (system)

Location

package.lisp

Packages

koto.iconv


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

2.1.3 iconv/grovell.lisp

Dependency

package.lisp (file)

Parent

iconv (system)

Location

grovell.lisp


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

2.1.4 iconv/iconv.lisp

Dependency

grovell.lisp (file)

Parent

iconv (system)

Location

iconv.lisp

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 koto.iconv

Source

package.lisp (file)

Nickname

iconv

Use List

common-lisp

Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


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

4.1.1 Functions

Function: iconv FROM-CODE TO-CODE FROM-VECTOR
Package

koto.iconv

Source

iconv.lisp (file)

Function: iconv-compat FROM-CODE TO-CODE FROM-VECTOR &optional ERROR-VALUE

The old behaviour of ICONV implemented in terms of the new conditions-based version.

Package

koto.iconv

Source

iconv.lisp (file)

Function: iconv-from-string TO-CODE STRING

Encode a string into a byte array.

Package

koto.iconv

Source

iconv.lisp (file)

Function: iconv-to-string FROM-CODE FROM-VECTOR

Decode a byte array into a string.

Package

koto.iconv

Source

iconv.lisp (file)


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

4.1.2 Conditions

Condition: iconv-error ()

Parent for all iconv errors

Package

koto.iconv

Source

iconv.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Condition: iconv-invalid-multibyte ()

Error that is raised when conversion encounters an illegal multibyte sequence

Package

koto.iconv

Source

iconv.lisp (file)

Direct superclasses

iconv-error (condition)

Direct methods
Direct slots
Slot: buffer

The buffer that is being converted. This is a CFFI native buffer.

Initargs

:buffer

Readers

iconv-invalid-multibyte-buffer (generic function)

Slot: index

Index into the source buffer where the error was encountered

Initargs

:index

Readers

iconv-invalid-multibyte-index (generic function)

Slot: at-end-p

True if the encoding error happened at the end of the buffer

Initargs

:at-end-p

Initform

(quote nil)

Readers

iconv-invalid-multibyte-at-end-p (generic function)

Condition: iconv-open-error ()

Error that is raised when ICONV-OPEN returns as error.

Package

koto.iconv

Source

iconv.lisp (file)

Direct superclasses

iconv-error (condition)

Condition: iconv-unknown-encoding-error ()

Error that is raised if the encoding is unknown.

Package

koto.iconv

Source

iconv.lisp (file)

Direct superclasses

iconv-error (condition)


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

4.2 Internal definitions


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

4.2.1 Constants

Constant: +error-return+
Package

koto.iconv

Source

iconv.lisp (file)

Constant: e2big
Package

koto.iconv

Source

/home/quickbuilder/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickbuilder/quicklisp/dists/quicklisp/software/cl-iconv-20171227-git/grovell.processed-grovel-file

Constant: eilseq
Package

koto.iconv

Source

/home/quickbuilder/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickbuilder/quicklisp/dists/quicklisp/software/cl-iconv-20171227-git/grovell.processed-grovel-file

Constant: einval
Package

koto.iconv

Source

/home/quickbuilder/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickbuilder/quicklisp/dists/quicklisp/software/cl-iconv-20171227-git/grovell.processed-grovel-file


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

4.2.2 Special variables

Special Variable: *report-bytes-count*

The number of bytes that will be reported when displaying an error.

Package

koto.iconv

Source

iconv.lisp (file)


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

4.2.3 Symbol macros

Symbol Macro: *errno*
Package

koto.iconv

Source

iconv.lisp (file)

Expansion

(koto.iconv::%var-accessor-*errno*)


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

4.2.4 Macros

Macro: with-iconv-cd (CD FROM TO) &body BODY
Package

koto.iconv

Source

iconv.lisp (file)


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

4.2.5 Functions

Function: %iconv CD INBUF INBYTESLEFT OUTBUF OUTBYTESLEFT
Package

koto.iconv

Source

iconv.lisp (file)

Function: %iconv-open TOCODE FROMCODE
Package

koto.iconv

Source

iconv.lisp (file)

Function: %var-accessor-*errno* ()
Function: (setf %var-accessor-*errno*) VALUE
Package

koto.iconv

Source

iconv.lisp (file)

Function: get-errno ()
Package

koto.iconv

Source

iconv.lisp (file)

Function: iconv-close CD
Package

koto.iconv

Source

iconv.lisp (file)

Function: iconv-open TOCODE FROMCODE
Package

koto.iconv

Source

iconv.lisp (file)

Function: read-new-replacement-and-offset ()
Package

koto.iconv

Source

iconv.lisp (file)

Function: test-iconv &optional FUNCTION
Package

koto.iconv

Source

iconv.lisp (file)

Function: test-print-array V
Package

koto.iconv

Source

iconv.lisp (file)


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

4.2.6 Generic functions

Generic Function: iconv-invalid-multibyte-at-end-p CONDITION
Package

koto.iconv

Methods
Method: iconv-invalid-multibyte-at-end-p (CONDITION iconv-invalid-multibyte)
Source

iconv.lisp (file)

Generic Function: iconv-invalid-multibyte-buffer CONDITION
Package

koto.iconv

Methods
Method: iconv-invalid-multibyte-buffer (CONDITION iconv-invalid-multibyte)
Source

iconv.lisp (file)

Generic Function: iconv-invalid-multibyte-index CONDITION
Package

koto.iconv

Methods
Method: iconv-invalid-multibyte-index (CONDITION iconv-invalid-multibyte)
Source

iconv.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   I   L  
Index Entry  Section

F
File, Lisp, iconv.asd: The iconv<dot>asd file
File, Lisp, iconv/grovell.lisp: The iconv/grovell<dot>lisp file
File, Lisp, iconv/iconv.lisp: The iconv/iconv<dot>lisp file
File, Lisp, iconv/package.lisp: The iconv/package<dot>lisp file

I
iconv.asd: The iconv<dot>asd file
iconv/grovell.lisp: The iconv/grovell<dot>lisp file
iconv/iconv.lisp: The iconv/iconv<dot>lisp file
iconv/package.lisp: The iconv/package<dot>lisp file

L
Lisp File, iconv.asd: The iconv<dot>asd file
Lisp File, iconv/grovell.lisp: The iconv/grovell<dot>lisp file
Lisp File, iconv/iconv.lisp: The iconv/iconv<dot>lisp file
Lisp File, iconv/package.lisp: The iconv/package<dot>lisp file

Jump to:   F   I   L  

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

A.2 Functions

Jump to:   %   (  
F   G   I   M   R   T   W  
Index Entry  Section

%
%iconv: Internal functions
%iconv-open: Internal functions
%var-accessor-*errno*: Internal functions

(
(setf %var-accessor-*errno*): Internal functions

F
Function, %iconv: Internal functions
Function, %iconv-open: Internal functions
Function, %var-accessor-*errno*: Internal functions
Function, (setf %var-accessor-*errno*): Internal functions
Function, get-errno: Internal functions
Function, iconv: Exported functions
Function, iconv-close: Internal functions
Function, iconv-compat: Exported functions
Function, iconv-from-string: Exported functions
Function, iconv-open: Internal functions
Function, iconv-to-string: Exported functions
Function, read-new-replacement-and-offset: Internal functions
Function, test-iconv: Internal functions
Function, test-print-array: Internal functions

G
Generic Function, iconv-invalid-multibyte-at-end-p: Internal generic functions
Generic Function, iconv-invalid-multibyte-buffer: Internal generic functions
Generic Function, iconv-invalid-multibyte-index: Internal generic functions
get-errno: Internal functions

I
iconv: Exported functions
iconv-close: Internal functions
iconv-compat: Exported functions
iconv-from-string: Exported functions
iconv-invalid-multibyte-at-end-p: Internal generic functions
iconv-invalid-multibyte-at-end-p: Internal generic functions
iconv-invalid-multibyte-buffer: Internal generic functions
iconv-invalid-multibyte-buffer: Internal generic functions
iconv-invalid-multibyte-index: Internal generic functions
iconv-invalid-multibyte-index: Internal generic functions
iconv-open: Internal functions
iconv-to-string: Exported functions

M
Macro, with-iconv-cd: Internal macros
Method, iconv-invalid-multibyte-at-end-p: Internal generic functions
Method, iconv-invalid-multibyte-buffer: Internal generic functions
Method, iconv-invalid-multibyte-index: Internal generic functions

R
read-new-replacement-and-offset: Internal functions

T
test-iconv: Internal functions
test-print-array: Internal functions

W
with-iconv-cd: Internal macros

Jump to:   %   (  
F   G   I   M   R   T   W  

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

A.3 Variables

Jump to:   *   +  
A   B   C   E   I   S  
Index Entry  Section

*
*errno*: Internal symbol macros
*report-bytes-count*: Internal special variables

+
+error-return+: Internal constants

A
at-end-p: Exported conditions

B
buffer: Exported conditions

C
Constant, +error-return+: Internal constants
Constant, e2big: Internal constants
Constant, eilseq: Internal constants
Constant, einval: Internal constants

E
e2big: Internal constants
eilseq: Internal constants
einval: Internal constants

I
index: Exported conditions

S
Slot, at-end-p: Exported conditions
Slot, buffer: Exported conditions
Slot, index: Exported conditions
Special Variable, *report-bytes-count*: Internal special variables
Symbol Macro, *errno*: Internal symbol macros

Jump to:   *   +  
A   B   C   E   I   S  

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

A.4 Data types

Jump to:   C   I   K   P   S  
Index Entry  Section

C
Condition, iconv-error: Exported conditions
Condition, iconv-invalid-multibyte: Exported conditions
Condition, iconv-open-error: Exported conditions
Condition, iconv-unknown-encoding-error: Exported conditions

I
iconv: The iconv system
iconv-error: Exported conditions
iconv-invalid-multibyte: Exported conditions
iconv-open-error: Exported conditions
iconv-unknown-encoding-error: Exported conditions

K
koto.iconv: The koto<dot>iconv package

P
Package, koto.iconv: The koto<dot>iconv package

S
System, iconv: The iconv system

Jump to:   C   I   K   P   S