The cl-skkserv Reference Manual

Table of Contents

The cl-skkserv Reference Manual

This is the cl-skkserv Reference Manual, version 0.3.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:48:38 2020 GMT+0.

1 Introduction

cl-skkserv

概要

cl-skkserv はSKKに影響を受けた日本語入力システムです。 既存のSKKサーバーとの互換性を保ちながらCommon Lispによるインテグレーションを可能にします。

cl-skkservはSKKサーバーとその辞書機能が完全に分離しており動的に辞書機能を書き換えることが可能です。 これにより辞書ファイルを事前に合成しておく必要がなくなります。 更にGoogleのCGIや他のSKKサーバーでさえ辞書として使うことができます。

なお、このソフトウェアは開発初期段階です。APIが変わる可能性があります。 Quicklispとの関係上developブランチ上で開発を行い、安定版の公開用にmasterブランチを使用しています。 最新の開発版APIはdevelopブランチを参照してください。

導入

Common Lisp開発ツールであるRoswellを使うことで以下のように簡単に導入できます。

$ ros install cl-skkserv

使い方

基礎

$ skkserv start # skkservを起動する
$ skkserv stop  # skkservを停止する

応用

設定

~/.skkservrcで編集することができます。以下に一例を示します。

(in-package :skkserv-user)

(setf *dictionary* (make-instance 'skk-dictionary :pathname #p"/path/to/dictionary"))

Emacs

Emacsで使う場合は~/.emacsで以下を追記してください。

(setq skk-server-host "127.0.0.1")
(setq skk-server-portnum 1178)

Vim

Vimで使う場合は~/.vimrcで以下を追記してください。

let g:eskk#server = {
\	'host': 'localhost',
\	'port': 1178,
\}

辞書

すべての辞書はCLOSによって管理されており、必ずDICTIONARYクラスを継承しconvertメソッドが定義されています。 もしあなたが新しい辞書を作りたい場合はDICTIONARYクラスを継承しconvertメソッドを定義したクラスを作ることで辞書を作ることができます。

以下は入力をそのまま候補として返すEcho辞書の例です。 メソッドコンビネーションがappendになっていることに注意してください。

(defclass echo-dictionary (dictionary) ())
(defmethod convert append ((d echo-dictionary) (s string)) (declare (ignore d)) (list s))
(setq *dictionary* (make-instance 'echo-dictionary))

例えば、SKKの辞書にEcho辞書を合成したいならSKK辞書を継承して以下のようにすることができます。

(defclass echo-and-skk-dictionary (echo-dictionary skk-dictionary) ()) ;; skk-dicitonary はdictionaryクラスのサブクラスです。
(setq *dictionary* (make-instance 'echo-and-skk-dictionary :pathname #p"/path/to/dictionary"))

また、DICTIONARYクラスのサブクラスのインスタンス同士を合成するMIXED-DICTIONARYクラスを使うこともできます。

(defvar skk (make-instance 'skk-dictionary :pathname #p"/path/to/dictionary"))
(defvar echo (make-instance 'echo-dictionary

2 Systems

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

2.1 cl-skkserv

Author

asciian

License

GPLv3

Description

skkserv with Common Lisp

Version

0.3.0

Dependencies

• cl-skkserv/core (system)
• cl-skkserv/skk (system)
• cl-skkserv/mixed (system)
• cl-skkserv/proxy (system)
• cl-skkserv/google-ime (system)
• cl-skkserv/user (system)

Source

cl-skkserv.asd (file)

2.2 cl-skkserv/skk

Author

asciian

License

GPLv3

Dependencies

• alexandria
• cl-ppcre
• esrap
• babel
• jp-numeral
• papyrus
• named-readtables
• cl-skkserv/core (system)

Source

cl-skkserv.asd (file)

Component

skk (module)

2.3 cl-skkserv/mixed

Author

asciian

License

GPLv3

Dependencies

• papyrus
• named-readtables
• cl-skkserv/core (system)

Source

cl-skkserv.asd (file)

Component

mixed (module)

2.4 cl-skkserv/proxy

Author

asciian

License

GPLv3

Dependencies

• papyrus
• usocket
• babel
• named-readtables
• cl-skkserv/core (system)

Source

cl-skkserv.asd (file)

Component

proxy (module)

2.5 cl-skkserv/google-ime

Author

asciian

License

GPLv3

Dependencies

• papyrus
• drakma
• flexi-streams
• yason
• named-readtables
• cl-skkserv/core (system)

Source

cl-skkserv.asd (file)

Component

google-ime (module)

2.6 cl-skkserv/user

Author

asciian

License

GPLv3

Dependencies

• papyrus
• named-readtables
• cl-skkserv/core (system)

Source

cl-skkserv.asd (file)

Component

user (module)

2.7 cl-skkserv/core

Author

asciian

License

GPLv3

Dependencies

• alexandria
• esrap
• babel
• papyrus
• named-readtables

Source

cl-skkserv.asd (file)

Component

core (module)

3 Modules

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

3.1 cl-skkserv/skk/skk

Parent

cl-skkserv/skk (system)

Location

skk/

Components

• index.md (file)
• util.md (file)
• lisp.md (file)
• numeric.md (file)
• text.md (file)

3.2 cl-skkserv/mixed/mixed

Parent

cl-skkserv/mixed (system)

Location

mixed/

Component

index.md (file)

3.3 cl-skkserv/proxy/proxy

Parent

cl-skkserv/proxy (system)

Location

proxy/

Component

index.md (file)

3.4 cl-skkserv/google-ime/google-ime

Parent

cl-skkserv/google-ime (system)

Location

google-ime/

Component

index.md (file)

3.5 cl-skkserv/user/user

Parent

cl-skkserv/user (system)

Location

user/

Component

index.md (file)

3.6 cl-skkserv/core/core

Parent

cl-skkserv/core (system)

Location

core/

Components

• index.md (file)
• dictionary.md (file)
• handler.md (file)
• process.md (file)

4 Files

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

4.1 Lisp

4.1.1 cl-skkserv.asd

Location

cl-skkserv.asd

Systems

• cl-skkserv (system)
• cl-skkserv/skk (system)
• cl-skkserv/mixed (system)
• cl-skkserv/proxy (system)
• cl-skkserv/google-ime (system)
• cl-skkserv/user (system)
• cl-skkserv/core (system)

4.1.2 cl-skkserv/skk/skk/index.md

Parent

skk (module)

Location

skk/index.md

Packages

cl-skkserv/skk

Exported Definitions

skk-dictionary (class)

4.1.3 cl-skkserv/skk/skk/util.md

Parent

skk (module)

Location

skk/util.md

Internal Definitions

• make-table (function)
• remove-comment (function)

4.1.4 cl-skkserv/skk/skk/lisp.md

Parent

skk (module)

Location

skk/lisp.md

Exported Definitions

• complete (method)
• convert (method)
• skk-lisp-dictionary (class)

Internal Definitions

• concat (function)
• lispp (function)
• pathname-of (method)
• table-of (method)
• (setf table-of) (method)

4.1.5 cl-skkserv/skk/skk/numeric.md

Parent

skk (module)

Location

skk/numeric.md

Exported Definitions

• convert (method)
• skk-numeric-dictionary (class)

Internal Definitions

• hankaku-to-zenkaku (function)
• numericp (function)
• pathname-of (method)
• table-of (method)
• (setf table-of) (method)

4.1.6 cl-skkserv/skk/skk/text.md

Parent

skk (module)

Location

skk/text.md

Exported Definitions

• complete (method)
• convert (method)
• skk-text-dictionary (class)

Internal Definitions

• pathname-of (method)
• table-of (method)
• (setf table-of) (method)

4.1.7 cl-skkserv/mixed/mixed/index.md

Parent

mixed (module)

Location

mixed/index.md

Packages

cl-skkserv/mixed

Exported Definitions

• complete (method)
• convert (method)
• mixed-dictionary (class)

Internal Definitions

dictionaries (method)

4.1.8 cl-skkserv/proxy/proxy/index.md

Parent

proxy (module)

Location

proxy/index.md

Packages

cl-skkserv/proxy

Exported Definitions

• complete (method)
• convert (method)
• proxy-dictionary (class)

Internal Definitions

• address-of (method)
• encoding-of (method)
• port-of (method)

4.1.9 cl-skkserv/google-ime/google-ime/index.md

Parent

google-ime (module)

Location

google-ime/index.md

Packages

cl-skkserv/google-ime

Exported Definitions

• convert (method)
• google-ime-dictionary (class)

Internal Definitions

*url* (special variable)

4.1.10 cl-skkserv/user/user/index.md

Parent

user (module)

Location

user/index.md

Packages

cl-skkserv/user

Exported Definitions

• *address* (special variable)
• *dictionary* (special variable)
• *encoding* (special variable)
• *port* (special variable)

Internal Definitions

jisyo (special variable)

4.1.11 cl-skkserv/core/core/index.md

Parent

core (module)

Location

core/index.md

Packages

cl-skkserv/core

4.1.12 cl-skkserv/core/core/dictionary.md

Parent

core (module)

Location

core/dictionary.md

Exported Definitions

• complete (generic function)
• complete (method)
• convert (generic function)
• convert (method)
• dictionary (class)

4.1.13 cl-skkserv/core/core/handler.md

Parent

core (module)

Location

core/handler.md

Exported Definitions

handle (function)

4.1.14 cl-skkserv/core/core/process.md

Parent

core (module)

Location

core/process.md

Exported Definitions

• process (function)
• read-request (function)
• write-response (function)

5 Packages

Packages are listed by definition order.

5.1 cl-skkserv/skk

Source

index.md (file)

Nickname

skkserv/skk

Use List

• cl-skkserv/core
• papyrus
• editor-hints.named-readtables
• jp-numeral
• babel
• esrap
• cl-ppcre
• alexandria
• common-lisp

Used By List

cl-skkserv/user

Exported Definitions

• skk-dictionary (class)
• skk-lisp-dictionary (class)
• skk-numeric-dictionary (class)
• skk-text-dictionary (class)

Internal Definitions

• concat (function)
• hankaku-to-zenkaku (function)
• lispp (function)
• make-table (function)
• numericp (function)
• pathname-of (generic function)
• pathname-of (method)
• pathname-of (method)
• pathname-of (method)
• remove-comment (function)
• table-of (generic function)
• table-of (method)
• (setf table-of) (method)
• table-of (method)
• (setf table-of) (method)
• table-of (method)
• (setf table-of) (method)
• (setf table-of) (generic function)

5.2 cl-skkserv/mixed

Source

index.md (file)

Nickname

skkserv/mixed

Use List

• cl-skkserv/core
• papyrus
• editor-hints.named-readtables
• common-lisp

Used By List

cl-skkserv/user

Exported Definitions

mixed-dictionary (class)

Internal Definitions

• dictionaries (generic function)
• dictionaries (method)

5.3 cl-skkserv/proxy

Source

index.md (file)

Nickname

skkserv/proxy

Use List

• cl-skkserv/core
• papyrus
• editor-hints.named-readtables
• cl-ppcre
• babel
• usocket
• common-lisp

Used By List

cl-skkserv/user

Exported Definitions

proxy-dictionary (class)

Internal Definitions

• address-of (generic function)
• address-of (method)
• encoding-of (generic function)
• encoding-of (method)
• port-of (generic function)
• port-of (method)

5.4 cl-skkserv/google-ime

Source

index.md (file)

Nickname

skkserv/google-ime

Use List

• cl-skkserv/core
• papyrus
• editor-hints.named-readtables
• alexandria
• flexi-streams
• yason
• drakma
• common-lisp

Used By List

cl-skkserv/user

Exported Definitions

google-ime-dictionary (class)

Internal Definitions

*url* (special variable)

5.5 cl-skkserv/user

Source

index.md (file)

Nicknames

• skkserv-user
• cl-skkserv-user
• skkserv/user

Use List

• cl-skkserv/mixed
• cl-skkserv/proxy
• cl-skkserv/google-ime
• cl-skkserv/skk
• cl-skkserv/core
• papyrus
• editor-hints.named-readtables
• asdf/interface
• common-lisp

Exported Definitions

• *address* (special variable)
• *dictionary* (special variable)
• *encoding* (special variable)
• *port* (special variable)

Internal Definitions

jisyo (special variable)

5.6 cl-skkserv/core

Source

index.md (file)

Nicknames

• skkserv
• cl-skkserv
• skkserv/core

Use List

• editor-hints.named-readtables
• papyrus
• babel
• esrap
• alexandria
• asdf/interface
• common-lisp

Used By List

• cl-skkserv/user
• cl-skkserv/google-ime
• cl-skkserv/proxy
• cl-skkserv/mixed
• cl-skkserv/skk

Exported Definitions

• complete (generic function)
• complete (method)
• complete (method)
• complete (method)
• complete (method)
• complete (method)
• convert (generic function)
• convert (method)
• convert (method)
• convert (method)
• convert (method)
• convert (method)
• convert (method)
• convert (method)
• dictionary (class)
• handle (function)
• process (function)
• read-request (function)
• write-response (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *address*

Package

cl-skkserv/user

Source

index.md (file)

Special Variable: *dictionary*

Package

cl-skkserv/user

Source

index.md (file)

Special Variable: *encoding*

Package

cl-skkserv/user

Source

index.md (file)

Special Variable: *port*

Package

cl-skkserv/user

Source

index.md (file)

6.1.2 Functions

Function: handle STRING DICTIONARY

Package

cl-skkserv/core

Source

handler.md (file)

Function: process STREAM DICTIONARY ENCODING

Package

cl-skkserv/core

Source

process.md (file)

Function: read-request STREAM

Package

cl-skkserv/core

Source

process.md (file)

Function: write-response STREAM RESPONSE

Package

cl-skkserv/core

Source

process.md (file)

6.1.3 Generic functions

Generic Function: complete DICTIONARY WORD

Package

cl-skkserv/core

Source

dictionary.md (file)

Method Combination

append (short method combination)

Options: :most-specific-first

Methods

Method: complete (D proxy-dictionary) (S string) append

Source

index.md (file)

Method: complete (D mixed-dictionary) (S string) append

Source

index.md (file)

Method: complete (D skk-text-dictionary) (S string) append

Source

text.md (file)

Method: complete (D skk-lisp-dictionary) (S string) append

Source

lisp.md (file)

Method: complete (D dictionary) (S string) append

Generic Function: convert DICTIONARY WORD

Package

cl-skkserv/core

Source

dictionary.md (file)

Method Combination

append (short method combination)

Options: :most-specific-first

Methods

Method: convert (D google-ime-dictionary) (S string) append

Source

index.md (file)

Method: convert (D proxy-dictionary) (S string) append

Source

index.md (file)

Method: convert (D mixed-dictionary) (S string) append

Source

index.md (file)

Method: convert (D skk-text-dictionary) (S string) append

Source

text.md (file)

Method: convert (D skk-numeric-dictionary) (S string) append

Source

numeric.md (file)

Method: convert (D skk-lisp-dictionary) (S string) append

Source

lisp.md (file)

Method: convert (D dictionary) (S string) append

6.1.4 Classes

Class: dictionary ()

Package

cl-skkserv/core

Source

dictionary.md (file)

Direct superclasses

standard-object (class)

Direct subclasses

• skk-lisp-dictionary (class)
• skk-numeric-dictionary (class)
• skk-text-dictionary (class)
• mixed-dictionary (class)
• proxy-dictionary (class)
• google-ime-dictionary (class)

Direct methods

• complete (method)
• convert (method)

Class: google-ime-dictionary ()

Package

cl-skkserv/google-ime

Source

index.md (file)

Direct superclasses

dictionary (class)

Direct methods

convert (method)

Class: mixed-dictionary ()

Package

cl-skkserv/mixed

Source

index.md (file)

Direct superclasses

dictionary (class)

Direct methods

• complete (method)
• convert (method)
• dictionaries (method)

Direct slots

Slot: dictionaries

Initargs

:dictionaries

Readers

dictionaries (generic function)

Class: proxy-dictionary ()

Package

cl-skkserv/proxy

Source

index.md (file)

Direct superclasses

dictionary (class)

Direct methods

• complete (method)
• convert (method)
• encoding-of (method)
• port-of (method)
• address-of (method)

Direct slots

Slot: address

Initargs

:address

Initform

"localhost"

Readers

address-of (generic function)

Slot: port

Initargs

:port

Initform

1178

Readers

port-of (generic function)

Slot: encoding

Initargs

:encoding

Initform

:eucjp

Readers

encoding-of (generic function)

Class: skk-dictionary ()

Package

cl-skkserv/skk

Source

index.md (file)

Direct superclasses

• skk-lisp-dictionary (class)
• skk-numeric-dictionary (class)
• skk-text-dictionary (class)

Class: skk-lisp-dictionary ()

Package

cl-skkserv/skk

Source

lisp.md (file)

Direct superclasses

dictionary (class)

Direct subclasses

skk-dictionary (class)

Direct methods

• complete (method)
• convert (method)
• initialize-instance (method)
• table-of (method)
• table-of (method)
• pathname-of (method)

Direct slots

Slot: pathname

Initargs

:pathname

Readers

pathname-of (generic function)

Slot: table

Readers

table-of (generic function)

Writers

(setf table-of) (generic function)

Class: skk-numeric-dictionary ()

Package

cl-skkserv/skk

Source

numeric.md (file)

Direct superclasses

dictionary (class)

Direct subclasses

skk-dictionary (class)

Direct methods

• convert (method)
• initialize-instance (method)
• table-of (method)
• table-of (method)
• pathname-of (method)

Direct slots

Slot: pathname

Initargs

:pathname

Readers

pathname-of (generic function)

Slot: table

Readers

table-of (generic function)

Writers

(setf table-of) (generic function)

Class: skk-text-dictionary ()

Package

cl-skkserv/skk

Source

text.md (file)

Direct superclasses

dictionary (class)

Direct subclasses

skk-dictionary (class)

Direct methods

• complete (method)
• convert (method)
• initialize-instance (method)
• table-of (method)
• table-of (method)
• pathname-of (method)

Direct slots

Slot: pathname

Initargs

:pathname

Readers

pathname-of (generic function)

Slot: table

Readers

table-of (generic function)

Writers

(setf table-of) (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *url*

Package

cl-skkserv/google-ime

Source

index.md (file)

Special Variable: jisyo

Package

cl-skkserv/user

Source

index.md (file)

6.2.2 Functions

Function: concat &rest S

Package

cl-skkserv/skk

Source

lisp.md (file)

Function: hankaku-to-zenkaku S

Package

cl-skkserv/skk

Source

numeric.md (file)

Function: lispp S

Package

cl-skkserv/skk

Source

lisp.md (file)

Function: make-table PATHNAME

Package

cl-skkserv/skk

Source

util.md (file)

Function: numericp S

Package

cl-skkserv/skk

Source

numeric.md (file)

Function: remove-comment S

Package

cl-skkserv/skk

Source

util.md (file)

6.2.3 Generic functions

Generic Function: address-of OBJECT

Package

cl-skkserv/proxy

Methods

Method: address-of (PROXY-DICTIONARY proxy-dictionary)

automatically generated reader method

Source

index.md (file)

Generic Function: dictionaries OBJECT

Package

cl-skkserv/mixed

Methods

Method: dictionaries (MIXED-DICTIONARY mixed-dictionary)

automatically generated reader method

Source

index.md (file)

Generic Function: encoding-of OBJECT

Package

cl-skkserv/proxy

Methods

Method: encoding-of (PROXY-DICTIONARY proxy-dictionary)

automatically generated reader method

Source

index.md (file)

Generic Function: pathname-of OBJECT

Package

cl-skkserv/skk

Methods

Method: pathname-of (SKK-TEXT-DICTIONARY skk-text-dictionary)

automatically generated reader method

Source

text.md (file)

Method: pathname-of (SKK-NUMERIC-DICTIONARY skk-numeric-dictionary)

automatically generated reader method

Source

numeric.md (file)

Method: pathname-of (SKK-LISP-DICTIONARY skk-lisp-dictionary)

automatically generated reader method

Source

lisp.md (file)

Generic Function: port-of OBJECT

Package

cl-skkserv/proxy

Methods

Method: port-of (PROXY-DICTIONARY proxy-dictionary)

automatically generated reader method

Source

index.md (file)

Generic Function: table-of OBJECT

Generic Function: (setf table-of) NEW-VALUE OBJECT

Package

cl-skkserv/skk

Methods

Method: table-of (SKK-TEXT-DICTIONARY skk-text-dictionary)

automatically generated reader method

Source

text.md (file)

Method: (setf table-of) NEW-VALUE (SKK-TEXT-DICTIONARY skk-text-dictionary)

automatically generated writer method

Source

text.md (file)

Method: table-of (SKK-NUMERIC-DICTIONARY skk-numeric-dictionary)

automatically generated reader method

Source

numeric.md (file)

Method: (setf table-of) NEW-VALUE (SKK-NUMERIC-DICTIONARY skk-numeric-dictionary)

automatically generated writer method

Source

numeric.md (file)

Method: table-of (SKK-LISP-DICTIONARY skk-lisp-dictionary)

automatically generated reader method

Source

lisp.md (file)

Method: (setf table-of) NEW-VALUE (SKK-LISP-DICTIONARY skk-lisp-dictionary)

automatically generated writer method

Source

lisp.md (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types