The trivial-renamer Reference Manual

This is the trivial-renamer Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:58:06 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-renamer

rename and manage categorized named objects

Author

StackSmith <>

License

BSD 3-clause license

Dependency

cl-ppcre (system).

Source

trivial-renamer.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 trivial-renamer/trivial-renamer.asd

Source

trivial-renamer.asd.

Parent Component

trivial-renamer (system).

ASDF Systems

trivial-renamer.


3.1.2 trivial-renamer/package.lisp

Source

trivial-renamer.asd.

Parent Component

trivial-renamer (system).

Packages

trivial-renamer.


3.1.3 trivial-renamer/trivial-renamer.lisp

Dependency

package.lisp (file).

Source

trivial-renamer.asd.

Parent Component

trivial-renamer (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 trivial-renamer

Source

package.lisp.

Nickname

rename

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 Special variables

Special Variable: *default-renamer*
Package

trivial-renamer.

Source

trivial-renamer.lisp.


5.1.2 Ordinary functions

Function: clear (&optional renamer)

clear the caches, leaving rules intact

Package

trivial-renamer.

Source

trivial-renamer.lisp.

Function: please (oldname &optional category renamer)

rename obj and return new name

Package

trivial-renamer.

Source

trivial-renamer.lisp.

Function: reset (&optional renamer)
Package

trivial-renamer.

Source

trivial-renamer.lisp.

Function: rule (category val &optional ruler)

add a rule for key appending or replacing

Package

trivial-renamer.

Source

trivial-renamer.lisp.

Function: rules (rules &optional ruler)

Add a bunch of rules

Package

trivial-renamer.

Source

trivial-renamer.lisp.


5.1.3 Generic functions

Generic Reader: default (object)
Package

trivial-renamer.

Methods
Reader Method: default ((renamer renamer))

automatically generated reader method

Source

trivial-renamer.lisp.

Target Slot

default.

Generic Writer: (setf default) (object)
Package

trivial-renamer.

Methods
Writer Method: (setf default) ((renamer renamer))

automatically generated writer method

Source

trivial-renamer.lisp.

Target Slot

default.

Generic Reader: new->old (object)
Package

trivial-renamer.

Methods
Reader Method: new->old ((renamer renamer))

automatically generated reader method

Source

trivial-renamer.lisp.

Target Slot

new->old.

Generic Writer: (setf new->old) (object)
Package

trivial-renamer.

Methods
Writer Method: (setf new->old) ((renamer renamer))

automatically generated writer method

Source

trivial-renamer.lisp.

Target Slot

new->old.

Generic Reader: normal (object)
Package

trivial-renamer.

Methods
Reader Method: normal ((renamer renamer))

automatically generated reader method

Source

trivial-renamer.lisp.

Target Slot

normal.

Generic Writer: (setf normal) (object)
Package

trivial-renamer.

Methods
Writer Method: (setf normal) ((renamer renamer))

automatically generated writer method

Source

trivial-renamer.lisp.

Target Slot

normal.

Generic Reader: old->new (object)
Package

trivial-renamer.

Methods
Reader Method: old->new ((renamer renamer))

automatically generated reader method

Source

trivial-renamer.lisp.

Target Slot

old->new.

Generic Writer: (setf old->new) (object)
Package

trivial-renamer.

Methods
Writer Method: (setf old->new) ((renamer renamer))

automatically generated writer method

Source

trivial-renamer.lisp.

Target Slot

old->new.


5.1.4 Standalone methods

Method: initialize-instance :after ((renamer renamer) &key)
Source

trivial-renamer.lisp.

Method: initialize-instance :after ((obj ruler) &key)
Source

trivial-renamer.lisp.

Method: print-object ((object renamer) stream)
Source

trivial-renamer.lisp.


5.1.5 Classes

Class: renamer
Package

trivial-renamer.

Source

trivial-renamer.lisp.

Direct superclasses

ruler.

Direct methods
Direct slots
Slot: default
Initform

(function trivial-renamer::default-rename-function)

Initargs

:default

Readers

default.

Writers

(setf default).

Slot: normal
Initform

(function trivial-renamer::default-rename-function)

Initargs

:normal

Readers

normal.

Writers

(setf normal).

Slot: transform
Initform

(function trivial-renamer::default-transform)

Initargs

:transform

Readers

transform.

Writers

(setf transform).

Slot: old->new
Readers

old->new.

Writers

(setf old->new).

Slot: new->old
Readers

new->old.

Writers

(setf new->old).


5.2 Internals


5.2.1 Ordinary functions

Function: default-rename-function (string renamer)
Package

trivial-renamer.

Source

trivial-renamer.lisp.

Function: default-transform (oldname category rules renamer)
Package

trivial-renamer.

Source

trivial-renamer.lisp.

Function: rename-for-sure (oldname category renamer)
Package

trivial-renamer.

Source

trivial-renamer.lisp.

Function: rules-clear (ruler)
Package

trivial-renamer.

Source

trivial-renamer.lisp.


5.2.2 Generic functions

Generic Reader: db (object)
Package

trivial-renamer.

Methods
Reader Method: db ((ruler ruler))

automatically generated reader method

Source

trivial-renamer.lisp.

Target Slot

db.

Generic Writer: (setf db) (object)
Package

trivial-renamer.

Methods
Writer Method: (setf db) ((ruler ruler))

automatically generated writer method

Source

trivial-renamer.lisp.

Target Slot

db.

Generic Reader: overwrite (object)
Package

trivial-renamer.

Methods
Reader Method: overwrite ((ruler ruler))

automatically generated reader method

Source

trivial-renamer.lisp.

Target Slot

overwrite.

Generic Writer: (setf overwrite) (object)
Package

trivial-renamer.

Methods
Writer Method: (setf overwrite) ((ruler ruler))

automatically generated writer method

Source

trivial-renamer.lisp.

Target Slot

overwrite.

Generic Reader: test (object)
Package

trivial-renamer.

Methods
Reader Method: test ((ruler ruler))

automatically generated reader method

Source

trivial-renamer.lisp.

Target Slot

test.

Generic Writer: (setf test) (object)
Package

trivial-renamer.

Methods
Writer Method: (setf test) ((ruler ruler))

automatically generated writer method

Source

trivial-renamer.lisp.

Target Slot

test.

Generic Reader: transform (object)
Package

trivial-renamer.

Methods
Reader Method: transform ((renamer renamer))

automatically generated reader method

Source

trivial-renamer.lisp.

Target Slot

transform.

Generic Writer: (setf transform) (object)
Package

trivial-renamer.

Methods
Writer Method: (setf transform) ((renamer renamer))

automatically generated writer method

Source

trivial-renamer.lisp.

Target Slot

transform.

Generic Reader: validate (object)
Package

trivial-renamer.

Methods
Reader Method: validate ((ruler ruler))

automatically generated reader method

Source

trivial-renamer.lisp.

Target Slot

validate.

Generic Writer: (setf validate) (object)
Package

trivial-renamer.

Methods
Writer Method: (setf validate) ((ruler ruler))

automatically generated writer method

Source

trivial-renamer.lisp.

Target Slot

validate.


5.2.3 Classes

Class: ruler
Package

trivial-renamer.

Source

trivial-renamer.lisp.

Direct subclasses

renamer.

Direct methods
Direct slots
Slot: db
Initargs

:db

Readers

db.

Writers

(setf db).

Slot: test
Initform

(function equal)

Initargs

:test

Readers

test.

Writers

(setf test).

Slot: overwrite
Initform

t

Initargs

:overwrite

Readers

overwrite.

Writers

(setf overwrite).

Slot: validate
Initform

(lambda (trivial-renamer::key trivial-renamer::val trivial-renamer::r) (declare (ignore trivial-renamer::key trivial-renamer::val trivial-renamer::r)))

Initargs

:validate

Readers

validate.

Writers

(setf validate).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   D   F   G   I   M   N   O   P   R   T   V  
Index Entry  Section

(
(setf db): Private generic functions
(setf db): Private generic functions
(setf default): Public generic functions
(setf default): Public generic functions
(setf new->old): Public generic functions
(setf new->old): Public generic functions
(setf normal): Public generic functions
(setf normal): Public generic functions
(setf old->new): Public generic functions
(setf old->new): Public generic functions
(setf overwrite): Private generic functions
(setf overwrite): Private generic functions
(setf test): Private generic functions
(setf test): Private generic functions
(setf transform): Private generic functions
(setf transform): Private generic functions
(setf validate): Private generic functions
(setf validate): Private generic functions

C
clear: Public ordinary functions

D
db: Private generic functions
db: Private generic functions
default: Public generic functions
default: Public generic functions
default-rename-function: Private ordinary functions
default-transform: Private ordinary functions

F
Function, clear: Public ordinary functions
Function, default-rename-function: Private ordinary functions
Function, default-transform: Private ordinary functions
Function, please: Public ordinary functions
Function, rename-for-sure: Private ordinary functions
Function, reset: Public ordinary functions
Function, rule: Public ordinary functions
Function, rules: Public ordinary functions
Function, rules-clear: Private ordinary functions

G
Generic Function, (setf db): Private generic functions
Generic Function, (setf default): Public generic functions
Generic Function, (setf new->old): Public generic functions
Generic Function, (setf normal): Public generic functions
Generic Function, (setf old->new): Public generic functions
Generic Function, (setf overwrite): Private generic functions
Generic Function, (setf test): Private generic functions
Generic Function, (setf transform): Private generic functions
Generic Function, (setf validate): Private generic functions
Generic Function, db: Private generic functions
Generic Function, default: Public generic functions
Generic Function, new->old: Public generic functions
Generic Function, normal: Public generic functions
Generic Function, old->new: Public generic functions
Generic Function, overwrite: Private generic functions
Generic Function, test: Private generic functions
Generic Function, transform: Private generic functions
Generic Function, validate: Private generic functions

I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

M
Method, (setf db): Private generic functions
Method, (setf default): Public generic functions
Method, (setf new->old): Public generic functions
Method, (setf normal): Public generic functions
Method, (setf old->new): Public generic functions
Method, (setf overwrite): Private generic functions
Method, (setf test): Private generic functions
Method, (setf transform): Private generic functions
Method, (setf validate): Private generic functions
Method, db: Private generic functions
Method, default: Public generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, new->old: Public generic functions
Method, normal: Public generic functions
Method, old->new: Public generic functions
Method, overwrite: Private generic functions
Method, print-object: Public standalone methods
Method, test: Private generic functions
Method, transform: Private generic functions
Method, validate: Private generic functions

N
new->old: Public generic functions
new->old: Public generic functions
normal: Public generic functions
normal: Public generic functions

O
old->new: Public generic functions
old->new: Public generic functions
overwrite: Private generic functions
overwrite: Private generic functions

P
please: Public ordinary functions
print-object: Public standalone methods

R
rename-for-sure: Private ordinary functions
reset: Public ordinary functions
rule: Public ordinary functions
rules: Public ordinary functions
rules-clear: Private ordinary functions

T
test: Private generic functions
test: Private generic functions
transform: Private generic functions
transform: Private generic functions

V
validate: Private generic functions
validate: Private generic functions