The iconv Reference Manual

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

The iconv Reference Manual

This is the iconv Reference Manual, version 0.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:43:39 2022 GMT+0.

Table of Contents


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 (system).

Dependency

cffi (system).

Source

iconv.asd.

Child Components

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   [Contents][Index]

2.1.1 iconv/iconv.asd

Source

iconv.asd.

Parent Component

iconv (system).

ASDF Systems

iconv.


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

2.1.2 iconv/package.lisp

Source

iconv.asd.

Parent Component

iconv (system).

Packages

koto.iconv.


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

2.1.3 iconv/grovell.lisp

Dependency

package.lisp (file).

Source

iconv.asd.

Parent Component

iconv (system).


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

2.1.4 iconv/iconv.lisp

Dependency

grovell.lisp (file).

Source

iconv.asd.

Parent Component

iconv (system).

Public Interface
Internals

3 Packages

Packages are listed by definition order.


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

3.1 koto.iconv

Source

package.lisp.

Nickname

iconv

Use List

common-lisp.

Public Interface
Internals

4 Definitions

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


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

4.1 Public Interface


4.1.1 Ordinary functions

Function: iconv (from-code to-code from-vector)
Package

koto.iconv.

Source

iconv.lisp.

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.

Function: iconv-from-string (to-code string)

Encode a string into a byte array.

Package

koto.iconv.

Source

iconv.lisp.

Function: iconv-to-string (from-code from-vector)

Decode a byte array into a string.

Package

koto.iconv.

Source

iconv.lisp.


4.1.2 Conditions

Condition: iconv-error

Parent for all iconv errors

Package

koto.iconv.

Source

iconv.lisp.

Direct superclasses

error.

Direct subclasses
Condition: iconv-invalid-multibyte

Error that is raised when conversion encounters an illegal multibyte sequence

Package

koto.iconv.

Source

iconv.lisp.

Direct superclasses

iconv-error.

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.

Writers

This slot is read-only.

Slot: index

Index into the source buffer where the error was encountered

Initargs

:index

Readers

iconv-invalid-multibyte-index.

Writers

This slot is read-only.

Slot: at-end-p

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

Initform

(quote nil)

Initargs

:at-end-p

Readers

iconv-invalid-multibyte-at-end-p.

Writers

This slot is read-only.

Condition: iconv-open-error

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

Package

koto.iconv.

Source

iconv.lisp.

Direct superclasses

iconv-error.

Condition: iconv-unknown-encoding-error

Error that is raised if the encoding is unknown.

Package

koto.iconv.

Source

iconv.lisp.

Direct superclasses

iconv-error.


4.2 Internals


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

4.2.1 Constants

Constant: +error-return+
Package

koto.iconv.

Source

iconv.lisp.


Next: , Previous: , Up: Internals   [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.


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

4.2.3 Symbol macros

Symbol Macro: *errno*
Package

koto.iconv.

Source

iconv.lisp.


4.2.4 Macros

Macro: with-iconv-cd ((cd from to) &body body)
Package

koto.iconv.

Source

iconv.lisp.


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

4.2.5 Ordinary functions

Function: %iconv (cd inbuf inbytesleft outbuf outbytesleft)
Package

koto.iconv.

Source

iconv.lisp.

Function: %iconv-open (tocode fromcode)
Package

koto.iconv.

Source

iconv.lisp.

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

koto.iconv.

Source

iconv.lisp.

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

koto.iconv.

Source

iconv.lisp.

Function: get-errno ()
Package

koto.iconv.

Source

iconv.lisp.

Function: iconv-close (cd)
Package

koto.iconv.

Source

iconv.lisp.

Function: iconv-open (tocode fromcode)
Package

koto.iconv.

Source

iconv.lisp.

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

koto.iconv.

Source

iconv.lisp.

Function: test-iconv (&optional function)
Package

koto.iconv.

Source

iconv.lisp.

Function: test-print-array (v)
Package

koto.iconv.

Source

iconv.lisp.


4.2.6 Generic functions

Generic Reader: iconv-invalid-multibyte-at-end-p (condition)
Package

koto.iconv.

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

iconv.lisp.

Target Slot

at-end-p.

Generic Reader: iconv-invalid-multibyte-buffer (condition)
Package

koto.iconv.

Methods
Reader Method: iconv-invalid-multibyte-buffer ((condition iconv-invalid-multibyte))
Source

iconv.lisp.

Target Slot

buffer.

Generic Reader: iconv-invalid-multibyte-index (condition)
Package

koto.iconv.

Methods
Reader Method: iconv-invalid-multibyte-index ((condition iconv-invalid-multibyte))
Source

iconv.lisp.

Target Slot

index.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

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

%
%iconv: Private ordinary functions
%iconv-open: Private ordinary functions
%var-accessor-*errno*: Private ordinary functions

(
(setf %var-accessor-*errno*): Private ordinary functions

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

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

I
iconv: Public ordinary functions
iconv-close: Private ordinary functions
iconv-compat: Public ordinary functions
iconv-from-string: Public ordinary functions
iconv-invalid-multibyte-at-end-p: Private generic functions
iconv-invalid-multibyte-at-end-p: Private generic functions
iconv-invalid-multibyte-buffer: Private generic functions
iconv-invalid-multibyte-buffer: Private generic functions
iconv-invalid-multibyte-index: Private generic functions
iconv-invalid-multibyte-index: Private generic functions
iconv-open: Private ordinary functions
iconv-to-string: Public ordinary functions

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

R
read-new-replacement-and-offset: Private ordinary functions

T
test-iconv: Private ordinary functions
test-print-array: Private ordinary functions

W
with-iconv-cd: Private macros

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