The cl-gimei Reference Manual

Table of Contents

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

The cl-gimei Reference Manual

This is the cl-gimei Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:09:04 2018 GMT+0.


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

1 Introduction

cl-gimei

Build Status

Common Lisp port of gimei
random Japanese name and address generator

Usage

(let ((name (gimei:make-name)))
  (hiragana name)               ;=> "さいとう はるな"
  (katakana name)               ;=> "サイトウ ハルナ"
  (kanji (last-name name))      ;=> "斎藤"
  (hiragana (last-name name))   ;=> "さいとう"
  (katakana (last-name name))   ;=> "サイトウ"
  (kanji (first-name name))     ;=> "陽菜"
  (hiragana (first-name name))  ;=> "はるな"
  (katakana (first-name name))) ;=> "ハルナ"

(let ((male (gimei:make-male)))
  (malep male)    ;=> t
  (femalep male)) ;=> nil

(let ((female (gimei:make-female)))
  (malep female)    ;=> nil
  (femalep female)) ;=> t

(let ((address (gimei:make-address)))
  (kanji address)                  ;=> 岡山県大島郡大和村稲木町
  (hiragana address)               ;=> おかやまけんおおしまぐんやまとそんいなぎちょう
  (katakana address)               ;=> オカヤマケンオオシマグンヤマトソンイナギチョウ
  (kanji (prefecture address))     ;=> 岡山県
  (hiragana (prefecture address))  ;=> おかやまけん
  (katakana (prefecture address))  ;=> オカヤマケン
  (kanji (city address))           ;=> 大島郡大和村
  (hiragana (city address))        

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

2 Systems

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


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

2.1 cl-gimei

Author

cxxxr

License

MIT

Description

random japanese name and address generator

Dependency

cl-gimei/main (system)

Source

cl-gimei.asd (file)


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

2.2 cl-gimei/main

Dependencies
Source

cl-gimei.asd (file)

Component

lisp.lisp (file)


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

3 Files

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


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

3.1 Lisp


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

3.1.1 cl-gimei.asd

Location

cl-gimei.asd

Systems

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

3.1.2 cl-gimei/main/lisp.lisp

Parent

cl-gimei/main (system)

Location

main.lisp

Packages

cl-gimei/main

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-gimei/main

Source

lisp.lisp (file)

Nicknames
Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: femalep NAME
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: make-address ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: make-female ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: make-male ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: make-name ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: make-phone-number &key LANDLINE MOBILE M2M RADIO-PAGER IP REVERSE-CHARGING PREFIX-0990 PREFIX-0570
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: malep NAME
Package

cl-gimei/main

Source

lisp.lisp (file)


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

5.1.2 Generic functions

Generic Function: city OBJECT
Package

cl-gimei/main

Methods
Method: city (ADDRESS address)

automatically generated reader method

Source

lisp.lisp (file)

Generic Function: first-name OBJECT
Package

cl-gimei/main

Methods
Method: first-name (NAME name)

automatically generated reader method

Source

lisp.lisp (file)

Generic Function: hiragana NAME
Package

cl-gimei/main

Source

lisp.lisp (file)

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

cl-gimei/main

Source

lisp.lisp (file)

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

cl-gimei/main

Source

lisp.lisp (file)

Methods
Method: katakana (ADDRESS address)
Method: katakana (NAME name)
Method: katakana (NAME item)
Generic Function: last-name OBJECT
Package

cl-gimei/main

Methods
Method: last-name (NAME name)

automatically generated reader method

Source

lisp.lisp (file)

Generic Function: prefecture OBJECT
Package

cl-gimei/main

Methods
Method: prefecture (ADDRESS address)

automatically generated reader method

Source

lisp.lisp (file)

Generic Function: town OBJECT
Package

cl-gimei/main

Methods
Method: town (ADDRESS address)

automatically generated reader method

Source

lisp.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *address-table*
Package

cl-gimei/main

Source

lisp.lisp (file)

Special Variable: *addresses-pathname*
Package

cl-gimei/main

Source

lisp.lisp (file)

Special Variable: *data-directory*
Package

cl-gimei/main

Source

lisp.lisp (file)

Special Variable: *name-table*
Package

cl-gimei/main

Source

lisp.lisp (file)

Special Variable: *names-pathname*
Package

cl-gimei/main

Source

lisp.lisp (file)


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

5.2.2 Macros

Macro: random-case &body CASES
Package

cl-gimei/main

Source

lisp.lisp (file)


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

5.2.3 Functions

Function: address-table-city INSTANCE
Function: (setf address-table-city) VALUE INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: address-table-p OBJECT
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: address-table-prefecture INSTANCE
Function: (setf address-table-prefecture) VALUE INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: address-table-town INSTANCE
Function: (setf address-table-town) VALUE INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: convert-items ITEMS
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: copy-address-table INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: copy-item INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: copy-name-table INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: item-hiragana INSTANCE
Function: (setf item-hiragana) VALUE INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: item-kanji INSTANCE
Function: (setf item-kanji) VALUE INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: item-katakana INSTANCE
Function: (setf item-katakana) VALUE INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: item-p OBJECT
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: list-to-item LIST
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: load-address-table ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: load-name-table ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: make-address-table &key (PREFECTURE PREFECTURE) (CITY CITY) (TOWN TOWN)
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: make-item KANJI HIRAGANA KATAKANA
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: make-name-table &key (LAST-NAME LAST-NAME) (MALE MALE) (FEMALE FEMALE)
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: name-table-female INSTANCE
Function: (setf name-table-female) VALUE INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: name-table-last-name INSTANCE
Function: (setf name-table-last-name) VALUE INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: name-table-male INSTANCE
Function: (setf name-table-male) VALUE INSTANCE
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: name-table-p OBJECT
Package

cl-gimei/main

Source

lisp.lisp (file)

Function: random-range MIN MAX
Package

cl-gimei/main

Source

lisp.lisp (file)


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

5.2.4 Structures

Structure: address-table ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: prefecture
Readers

address-table-prefecture (function)

Writers

(setf address-table-prefecture) (function)

Slot: city
Readers

address-table-city (function)

Writers

(setf address-table-city) (function)

Slot: town
Readers

address-table-town (function)

Writers

(setf address-table-town) (function)

Structure: item ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods
Direct slots
Slot: kanji
Readers

item-kanji (function)

Writers

(setf item-kanji) (function)

Slot: hiragana
Readers

item-hiragana (function)

Writers

(setf item-hiragana) (function)

Slot: katakana
Readers

item-katakana (function)

Writers

(setf item-katakana) (function)

Structure: name-table ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: last-name
Readers

name-table-last-name (function)

Writers

(setf name-table-last-name) (function)

Slot: male
Readers

name-table-male (function)

Writers

(setf name-table-male) (function)

Slot: female
Readers

name-table-female (function)

Writers

(setf name-table-female) (function)


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

5.2.5 Classes

Class: address ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: prefecture
Initform

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

Readers

prefecture (generic function)

Slot: city
Initform

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

Readers

city (generic function)

Slot: town
Initform

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

Readers

town (generic function)

Class: female ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Direct superclasses

name (class)

Direct Default Initargs
InitargValue
:first-name(alexandria.0.dev:random-elt (cl-gimei/main::name-table-female cl-gimei/main::*name-table*))
:last-name(alexandria.0.dev:random-elt (cl-gimei/main::name-table-last-name cl-gimei/main::*name-table*))
Class: male ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Direct superclasses

name (class)

Direct Default Initargs
InitargValue
:first-name(alexandria.0.dev:random-elt (cl-gimei/main::name-table-male cl-gimei/main::*name-table*))
:last-name(alexandria.0.dev:random-elt (cl-gimei/main::name-table-last-name cl-gimei/main::*name-table*))
Class: name ()
Package

cl-gimei/main

Source

lisp.lisp (file)

Direct superclasses

standard-object (class)

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

:first-name

Readers

first-name (generic function)

Slot: last-name
Initargs

:last-name

Readers

last-name (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-gimei.asd: The cl-gimei<dot>asd file
cl-gimei/main/lisp.lisp: The cl-gimei/main/lisp<dot>lisp file

F
File, Lisp, cl-gimei.asd: The cl-gimei<dot>asd file
File, Lisp, cl-gimei/main/lisp.lisp: The cl-gimei/main/lisp<dot>lisp file

L
Lisp File, cl-gimei.asd: The cl-gimei<dot>asd file
Lisp File, cl-gimei/main/lisp.lisp: The cl-gimei/main/lisp<dot>lisp file

Jump to:   C   F   L  

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

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): Internal functions
(setf address-table-prefecture): Internal functions
(setf address-table-town): Internal functions
(setf item-hiragana): Internal functions
(setf item-kanji): Internal functions
(setf item-katakana): Internal functions
(setf name-table-female): Internal functions
(setf name-table-last-name): Internal functions
(setf name-table-male): Internal functions

A
address-table-city: Internal functions
address-table-p: Internal functions
address-table-prefecture: Internal functions
address-table-town: Internal functions

C
city: Exported generic functions
city: Exported generic functions
convert-items: Internal functions
copy-address-table: Internal functions
copy-item: Internal functions
copy-name-table: Internal functions

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

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

H
hiragana: Exported generic functions
hiragana: Exported generic functions
hiragana: Exported generic functions
hiragana: Exported generic functions

I
item-hiragana: Internal functions
item-kanji: Internal functions
item-katakana: Internal functions
item-p: Internal functions

K
kanji: Exported generic functions
kanji: Exported generic functions
kanji: Exported generic functions
kanji: Exported generic functions
katakana: Exported generic functions
katakana: Exported generic functions
katakana: Exported generic functions
katakana: Exported generic functions

L
last-name: Exported generic functions
last-name: Exported generic functions
list-to-item: Internal functions
load-address-table: Internal functions
load-name-table: Internal functions

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

N
name-table-female: Internal functions
name-table-last-name: Internal functions
name-table-male: Internal functions
name-table-p: Internal functions

P
prefecture: Exported generic functions
prefecture: Exported generic functions

R
random-case: Internal macros
random-range: Internal functions

T
town: Exported generic functions
town: Exported generic functions

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

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

A.3 Variables

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

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

C
city: Internal structures
city: Internal classes

F
female: Internal structures
first-name: Internal classes

H
hiragana: Internal structures

K
kanji: Internal structures
katakana: Internal structures

L
last-name: Internal structures
last-name: Internal classes

M
male: Internal structures

P
prefecture: Internal structures
prefecture: Internal classes

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

T
town: Internal structures
town: Internal classes

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

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

A.4 Data types

Jump to:   A   C   F   I   M   N   P   S  
Index Entry  Section

A
address: Internal classes
address-table: Internal structures

C
cl-gimei: The cl-gimei system
cl-gimei/main: The cl-gimei/main system
cl-gimei/main: The cl-gimei/main package
Class, address: Internal classes
Class, female: Internal classes
Class, male: Internal classes
Class, name: Internal classes

F
female: Internal classes

I
item: Internal structures

M
male: Internal classes

N
name: Internal classes
name-table: Internal structures

P
Package, cl-gimei/main: The cl-gimei/main package

S
Structure, address-table: Internal structures
Structure, item: Internal structures
Structure, name-table: Internal structures
System, cl-gimei: The cl-gimei system
System, cl-gimei/main: The cl-gimei/main system

Jump to:   A   C   F   I   M   N   P   S