The cl-gimei Reference Manual

This is the cl-gimei Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:16:45 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-gimei

random japanese name and address generator

Author

cxxxr

License

MIT

Dependency

cl-gimei/main (system).

Source

cl-gimei.asd.


2.2 cl-gimei/main

Author

cxxxr

License

MIT

Dependencies
  • cl-yaml (system).
  • alexandria (system).
Source

cl-gimei.asd.


3 Files

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


3.1 Lisp


3.1.1 cl-gimei/cl-gimei.asd

Source

cl-gimei.asd.

Parent Component

cl-gimei (system).

ASDF Systems

3.1.2 cl-gimei/main/file-type.lisp

Source

cl-gimei.asd.

Parent Component

cl-gimei/main (system).

Packages

cl-gimei/main.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-gimei/main

Source

file-type.lisp.

Nicknames
  • cl-gimei
  • gimei
Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: femalep (name)
Package

cl-gimei/main.

Source

file-type.lisp.

Function: make-address ()
Package

cl-gimei/main.

Source

file-type.lisp.

Function: make-female ()
Package

cl-gimei/main.

Source

file-type.lisp.

Function: make-male ()
Package

cl-gimei/main.

Source

file-type.lisp.

Function: make-name ()
Package

cl-gimei/main.

Source

file-type.lisp.

Function: make-phone-number (&key landline mobile m2m radio-pager ip reverse-charging prefix-0990 prefix-0570)
Package

cl-gimei/main.

Source

file-type.lisp.

Function: malep (name)
Package

cl-gimei/main.

Source

file-type.lisp.


5.1.2 Generic functions

Generic Reader: city (object)
Package

cl-gimei/main.

Methods
Reader Method: city ((address address))

automatically generated reader method

Source

file-type.lisp.

Target Slot

city.

Generic Reader: first-name (object)
Package

cl-gimei/main.

Methods
Reader Method: first-name ((name name))

automatically generated reader method

Source

file-type.lisp.

Target Slot

first-name.

Generic Function: hiragana (name)
Package

cl-gimei/main.

Source

file-type.lisp.

Methods
Method: hiragana ((address address))
Method: hiragana ((name name))
Method: hiragana ((name item))
Generic Function: kanji (name)
Package

cl-gimei/main.

Source

file-type.lisp.

Methods
Method: kanji ((address address))
Method: kanji ((name name))
Method: kanji ((name item))
Generic Function: katakana (name)
Package

cl-gimei/main.

Source

file-type.lisp.

Methods
Method: katakana ((address address))
Method: katakana ((name name))
Method: katakana ((name item))
Generic Reader: last-name (object)
Package

cl-gimei/main.

Methods
Reader Method: last-name ((name name))

automatically generated reader method

Source

file-type.lisp.

Target Slot

last-name.

Generic Reader: prefecture (object)
Package

cl-gimei/main.

Methods
Reader Method: prefecture ((address address))

automatically generated reader method

Source

file-type.lisp.

Target Slot

prefecture.

Generic Reader: town (object)
Package

cl-gimei/main.

Methods
Reader Method: town ((address address))

automatically generated reader method

Source

file-type.lisp.

Target Slot

town.


5.2 Internals


5.2.1 Special variables

Special Variable: *address-table*
Package

cl-gimei/main.

Source

file-type.lisp.

Special Variable: *addresses-pathname*
Package

cl-gimei/main.

Source

file-type.lisp.

Special Variable: *data-directory*
Package

cl-gimei/main.

Source

file-type.lisp.

Special Variable: *name-table*
Package

cl-gimei/main.

Source

file-type.lisp.

Special Variable: *names-pathname*
Package

cl-gimei/main.

Source

file-type.lisp.


5.2.2 Macros

Macro: random-case (&body cases)
Package

cl-gimei/main.

Source

file-type.lisp.


5.2.3 Ordinary functions

Reader: address-table-city (instance)
Writer: (setf address-table-city) (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Target Slot

city.

Function: address-table-p (object)
Package

cl-gimei/main.

Source

file-type.lisp.

Reader: address-table-prefecture (instance)
Writer: (setf address-table-prefecture) (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Target Slot

prefecture.

Reader: address-table-town (instance)
Writer: (setf address-table-town) (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Target Slot

town.

Function: convert-items (items)
Package

cl-gimei/main.

Source

file-type.lisp.

Function: copy-address-table (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Function: copy-item (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Function: copy-name-table (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Reader: item-hiragana (instance)
Writer: (setf item-hiragana) (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Target Slot

hiragana.

Reader: item-kanji (instance)
Writer: (setf item-kanji) (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Target Slot

kanji.

Reader: item-katakana (instance)
Writer: (setf item-katakana) (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Target Slot

katakana.

Function: item-p (object)
Package

cl-gimei/main.

Source

file-type.lisp.

Function: list-to-item (list)
Package

cl-gimei/main.

Source

file-type.lisp.

Function: load-address-table ()
Package

cl-gimei/main.

Source

file-type.lisp.

Function: load-name-table ()
Package

cl-gimei/main.

Source

file-type.lisp.

Function: make-address-table (&key prefecture city town)
Package

cl-gimei/main.

Source

file-type.lisp.

Function: make-item (kanji hiragana katakana)
Package

cl-gimei/main.

Source

file-type.lisp.

Function: make-name-table (&key last-name male female)
Package

cl-gimei/main.

Source

file-type.lisp.

Reader: name-table-female (instance)
Writer: (setf name-table-female) (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Target Slot

female.

Reader: name-table-last-name (instance)
Writer: (setf name-table-last-name) (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Target Slot

last-name.

Reader: name-table-male (instance)
Writer: (setf name-table-male) (instance)
Package

cl-gimei/main.

Source

file-type.lisp.

Target Slot

male.

Function: name-table-p (object)
Package

cl-gimei/main.

Source

file-type.lisp.

Function: random-range (min max)
Package

cl-gimei/main.

Source

file-type.lisp.


5.2.4 Structures

Structure: address-table
Package

cl-gimei/main.

Source

file-type.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: prefecture
Readers

address-table-prefecture.

Writers

(setf address-table-prefecture).

Slot: city
Readers

address-table-city.

Writers

(setf address-table-city).

Slot: town
Readers

address-table-town.

Writers

(setf address-table-town).

Structure: item
Package

cl-gimei/main.

Source

file-type.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: kanji
Readers

item-kanji.

Writers

(setf item-kanji).

Slot: hiragana
Readers

item-hiragana.

Writers

(setf item-hiragana).

Slot: katakana
Readers

item-katakana.

Writers

(setf item-katakana).

Structure: name-table
Package

cl-gimei/main.

Source

file-type.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: last-name
Readers

name-table-last-name.

Writers

(setf name-table-last-name).

Slot: male
Readers

name-table-male.

Writers

(setf name-table-male).

Slot: female
Readers

name-table-female.

Writers

(setf name-table-female).


5.2.5 Classes

Class: address
Package

cl-gimei/main.

Source

file-type.lisp.

Direct methods
Direct slots
Slot: prefecture
Initform

(alexandria:random-elt (cl-gimei/main::address-table-prefecture cl-gimei/main::*address-table*))

Readers

prefecture.

Writers

This slot is read-only.

Slot: city
Initform

(alexandria:random-elt (cl-gimei/main::address-table-city cl-gimei/main::*address-table*))

Readers

city.

Writers

This slot is read-only.

Slot: town
Initform

(alexandria:random-elt (cl-gimei/main::address-table-town cl-gimei/main::*address-table*))

Readers

town.

Writers

This slot is read-only.

Class: female
Package

cl-gimei/main.

Source

file-type.lisp.

Direct superclasses

name.

Direct Default Initargs
InitargValue
:first-name(random-elt (name-table-female *name-table*))
:last-name(random-elt (name-table-last-name *name-table*))
Class: male
Package

cl-gimei/main.

Source

file-type.lisp.

Direct superclasses

name.

Direct Default Initargs
InitargValue
:first-name(random-elt (name-table-male *name-table*))
:last-name(random-elt (name-table-last-name *name-table*))
Class: name
Package

cl-gimei/main.

Source

file-type.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: first-name
Initargs

:first-name

Readers

first-name.

Writers

This slot is read-only.

Slot: last-name
Initargs

:last-name

Readers

last-name.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   F   G   H   I   K   L   M   N   P   R   T  
Index Entry  Section

(
(setf address-table-city): Private ordinary functions
(setf address-table-prefecture): Private ordinary functions
(setf address-table-town): Private ordinary functions
(setf item-hiragana): Private ordinary functions
(setf item-kanji): Private ordinary functions
(setf item-katakana): Private ordinary functions
(setf name-table-female): Private ordinary functions
(setf name-table-last-name): Private ordinary functions
(setf name-table-male): Private ordinary functions

A
address-table-city: Private ordinary functions
address-table-p: Private ordinary functions
address-table-prefecture: Private ordinary functions
address-table-town: Private ordinary functions

C
city: Public generic functions
city: Public generic functions
convert-items: Private ordinary functions
copy-address-table: Private ordinary functions
copy-item: Private ordinary functions
copy-name-table: Private ordinary functions

F
femalep: Public ordinary functions
first-name: Public generic functions
first-name: Public generic functions
Function, (setf address-table-city): Private ordinary functions
Function, (setf address-table-prefecture): Private ordinary functions
Function, (setf address-table-town): Private ordinary functions
Function, (setf item-hiragana): Private ordinary functions
Function, (setf item-kanji): Private ordinary functions
Function, (setf item-katakana): Private ordinary functions
Function, (setf name-table-female): Private ordinary functions
Function, (setf name-table-last-name): Private ordinary functions
Function, (setf name-table-male): Private ordinary functions
Function, address-table-city: Private ordinary functions
Function, address-table-p: Private ordinary functions
Function, address-table-prefecture: Private ordinary functions
Function, address-table-town: Private ordinary functions
Function, convert-items: Private ordinary functions
Function, copy-address-table: Private ordinary functions
Function, copy-item: Private ordinary functions
Function, copy-name-table: Private ordinary functions
Function, femalep: Public ordinary functions
Function, item-hiragana: Private ordinary functions
Function, item-kanji: Private ordinary functions
Function, item-katakana: Private ordinary functions
Function, item-p: Private ordinary functions
Function, list-to-item: Private ordinary functions
Function, load-address-table: Private ordinary functions
Function, load-name-table: Private ordinary functions
Function, make-address: Public ordinary functions
Function, make-address-table: Private ordinary functions
Function, make-female: Public ordinary functions
Function, make-item: Private ordinary functions
Function, make-male: Public ordinary functions
Function, make-name: Public ordinary functions
Function, make-name-table: Private ordinary functions
Function, make-phone-number: Public ordinary functions
Function, malep: Public ordinary functions
Function, name-table-female: Private ordinary functions
Function, name-table-last-name: Private ordinary functions
Function, name-table-male: Private ordinary functions
Function, name-table-p: Private ordinary functions
Function, random-range: Private ordinary functions

G
Generic Function, city: Public generic functions
Generic Function, first-name: Public generic functions
Generic Function, hiragana: Public generic functions
Generic Function, kanji: Public generic functions
Generic Function, katakana: Public generic functions
Generic Function, last-name: Public generic functions
Generic Function, prefecture: Public generic functions
Generic Function, town: Public generic functions

H
hiragana: Public generic functions
hiragana: Public generic functions
hiragana: Public generic functions
hiragana: Public generic functions

I
item-hiragana: Private ordinary functions
item-kanji: Private ordinary functions
item-katakana: Private ordinary functions
item-p: Private ordinary functions

K
kanji: Public generic functions
kanji: Public generic functions
kanji: Public generic functions
kanji: Public generic functions
katakana: Public generic functions
katakana: Public generic functions
katakana: Public generic functions
katakana: Public generic functions

L
last-name: Public generic functions
last-name: Public generic functions
list-to-item: Private ordinary functions
load-address-table: Private ordinary functions
load-name-table: Private ordinary functions

M
Macro, random-case: Private macros
make-address: Public ordinary functions
make-address-table: Private ordinary functions
make-female: Public ordinary functions
make-item: Private ordinary functions
make-male: Public ordinary functions
make-name: Public ordinary functions
make-name-table: Private ordinary functions
make-phone-number: Public ordinary functions
malep: Public ordinary functions
Method, city: Public generic functions
Method, first-name: Public generic functions
Method, hiragana: Public generic functions
Method, hiragana: Public generic functions
Method, hiragana: Public generic functions
Method, kanji: Public generic functions
Method, kanji: Public generic functions
Method, kanji: Public generic functions
Method, katakana: Public generic functions
Method, katakana: Public generic functions
Method, katakana: Public generic functions
Method, last-name: Public generic functions
Method, prefecture: Public generic functions
Method, town: Public generic functions

N
name-table-female: Private ordinary functions
name-table-last-name: Private ordinary functions
name-table-male: Private ordinary functions
name-table-p: Private ordinary functions

P
prefecture: Public generic functions
prefecture: Public generic functions

R
random-case: Private macros
random-range: Private ordinary functions

T
town: Public generic functions
town: Public generic functions


A.3 Variables

Jump to:   *  
C   F   H   K   L   M   P   S   T  
Index Entry  Section

*
*address-table*: Private special variables
*addresses-pathname*: Private special variables
*data-directory*: Private special variables
*name-table*: Private special variables
*names-pathname*: Private special variables

C
city: Private structures
city: Private classes

F
female: Private structures
first-name: Private classes

H
hiragana: Private structures

K
kanji: Private structures
katakana: Private structures

L
last-name: Private structures
last-name: Private classes

M
male: Private structures

P
prefecture: Private structures
prefecture: Private classes

S
Slot, city: Private structures
Slot, city: Private classes
Slot, female: Private structures
Slot, first-name: Private classes
Slot, hiragana: Private structures
Slot, kanji: Private structures
Slot, katakana: Private structures
Slot, last-name: Private structures
Slot, last-name: Private classes
Slot, male: Private structures
Slot, prefecture: Private structures
Slot, prefecture: Private classes
Slot, town: Private structures
Slot, town: Private classes
Special Variable, *address-table*: Private special variables
Special Variable, *addresses-pathname*: Private special variables
Special Variable, *data-directory*: Private special variables
Special Variable, *name-table*: Private special variables
Special Variable, *names-pathname*: Private special variables

T
town: Private structures
town: Private classes