The symbol-munger Reference Manual

This is the symbol-munger Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:24:38 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 symbol-munger

Functions to convert between the spacing and capitalization conventions of various environments

License

MIT

Version

1.0

Dependencies
  • iterate (system).
  • alexandria (system).
Source

symbol-munger.asd.

Child Component

symbol-munger.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 symbol-munger/symbol-munger.asd

Source

symbol-munger.asd.

Parent Component

symbol-munger (system).

ASDF Systems

symbol-munger.


3.1.2 symbol-munger/symbol-munger.lisp

Source

symbol-munger.asd.

Parent Component

symbol-munger (system).

Packages

symbol-munger.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 symbol-munger

Source

symbol-munger.lisp.

Use List
  • common-lisp.
  • common-lisp-user.
  • iterate.
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: camel-case->english (phrase &key stream capitalize)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: camel-case->keyword (phrase)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: camel-case->lisp-name (phrase &key stream capitalize)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: camel-case->lisp-symbol (phrase &optional package)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: camel-case->underscores (phrase &key stream capitalize)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: combine-symbols (phrase &key package separator)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: english->camel-case (phrase &key stream capitalize)

Turns an english phrase into a camelCasePhraseLikeThis

Package

symbol-munger.

Source

symbol-munger.lisp.

Function: english->keyword (phrase)

Turns an english phrase into a common lisp keyword

Package

symbol-munger.

Source

symbol-munger.lisp.

Function: english->lisp-name (phrase &key stream capitalize)

Turns an english phrase into a string containing a common lisp style symbol-name

Package

symbol-munger.

Source

symbol-munger.lisp.

Function: english->lisp-symbol (phrase &optional package)

Turns an english phrase into a common lisp symbol in the specified package

Package

symbol-munger.

Source

symbol-munger.lisp.

Function: english->studly-case (phrase &key stream)

Turns an english phrase into a CamelCasePhraseLikeThis

Package

symbol-munger.

Source

symbol-munger.lisp.

Function: english->underscores (phrase &key stream capitalize)

Turns an english phrase into a a_phrase_like_this

Package

symbol-munger.

Source

symbol-munger.lisp.

Function: lisp->camel-case (phrase &key stream)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: lisp->english (phrase &key stream capitalize word-separator)

Converts a common lisp symbol (or symbol-name) into an english phrase

Package

symbol-munger.

Source

symbol-munger.lisp.

Function: lisp->keyword (phrase)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: lisp->studly-caps (phrase &key stream)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: lisp->underscores (phrase &key stream capitalize)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: normalize-capitalization-and-spacing (s &key capitalize word-separators word-separators-to-replace stream in-place)

Will recapitalize a string and replace word-separators with a standard one
(in-place if desired and possible)

If s is a lisp tree, then each part will be %coerce-to-string’ed and treated
as a separate part of the phrase being normalized

Will write to a stream if given otherwise it.
Defaults to capitalizing each word but can be any of
{:each-word :first-word T (:all is an alias for T) nil :but-first-word (likeJavaScript) }

word-separators are used to distinguish new words for the purposes of capitalization The first of these will be used to replace word-separators-to-replace (auto flattened) word-separators-to-replace helps normalize word separators so that spaces or underscores become the appropriate word-separator.
If this eql :capitals it assumes capital letters indicate a new word separation
(auto flattened)

returns a string (new or the one passed in if in-place) unless :stream is provided

Package

symbol-munger.

Source

symbol-munger.lisp.

Function: qualified-symbol-string (sym)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: reintern (phrase &optional package)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: underscores->camel-case (phrase &key stream)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: underscores->english (phrase &key stream capitalize)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: underscores->keyword (phrase)

Converts and underscores name to a common lisp keyword

Package

symbol-munger.

Source

symbol-munger.lisp.

Function: underscores->lisp-name (phrase &key stream capitalize)
Package

symbol-munger.

Source

symbol-munger.lisp.

Function: underscores->lisp-symbol (phrase &optional package)

Turns a_phrase_with_underscores into a-phrase-with-underscores lisp symbol

Package

symbol-munger.

Source

symbol-munger.lisp.

Function: underscores->studly-caps (phrase &key stream)
Package

symbol-munger.

Source

symbol-munger.lisp.


5.2 Internals


5.2.1 Macros

Macro: ensure-flat-list! (place)
Package

symbol-munger.

Source

symbol-munger.lisp.

Macro: ensure-list! (place)
Package

symbol-munger.

Source

symbol-munger.lisp.


5.2.2 Generic functions

Generic Function: %coerce-to-string (s)

This method can be specialized to help turn objects into strings so they can be combined and normalized correctly

Package

symbol-munger.

Source

symbol-munger.lisp.

Methods
Method: %coerce-to-string (s)

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
C   E   F   G   L   M   N   Q   R   U  
Index Entry  Section

%
%coerce-to-string: Private generic functions
%coerce-to-string: Private generic functions

C
camel-case->english: Public ordinary functions
camel-case->keyword: Public ordinary functions
camel-case->lisp-name: Public ordinary functions
camel-case->lisp-symbol: Public ordinary functions
camel-case->underscores: Public ordinary functions
combine-symbols: Public ordinary functions

E
english->camel-case: Public ordinary functions
english->keyword: Public ordinary functions
english->lisp-name: Public ordinary functions
english->lisp-symbol: Public ordinary functions
english->studly-case: Public ordinary functions
english->underscores: Public ordinary functions
ensure-flat-list!: Private macros
ensure-list!: Private macros

F
Function, camel-case->english: Public ordinary functions
Function, camel-case->keyword: Public ordinary functions
Function, camel-case->lisp-name: Public ordinary functions
Function, camel-case->lisp-symbol: Public ordinary functions
Function, camel-case->underscores: Public ordinary functions
Function, combine-symbols: Public ordinary functions
Function, english->camel-case: Public ordinary functions
Function, english->keyword: Public ordinary functions
Function, english->lisp-name: Public ordinary functions
Function, english->lisp-symbol: Public ordinary functions
Function, english->studly-case: Public ordinary functions
Function, english->underscores: Public ordinary functions
Function, lisp->camel-case: Public ordinary functions
Function, lisp->english: Public ordinary functions
Function, lisp->keyword: Public ordinary functions
Function, lisp->studly-caps: Public ordinary functions
Function, lisp->underscores: Public ordinary functions
Function, normalize-capitalization-and-spacing: Public ordinary functions
Function, qualified-symbol-string: Public ordinary functions
Function, reintern: Public ordinary functions
Function, underscores->camel-case: Public ordinary functions
Function, underscores->english: Public ordinary functions
Function, underscores->keyword: Public ordinary functions
Function, underscores->lisp-name: Public ordinary functions
Function, underscores->lisp-symbol: Public ordinary functions
Function, underscores->studly-caps: Public ordinary functions

G
Generic Function, %coerce-to-string: Private generic functions

L
lisp->camel-case: Public ordinary functions
lisp->english: Public ordinary functions
lisp->keyword: Public ordinary functions
lisp->studly-caps: Public ordinary functions
lisp->underscores: Public ordinary functions

M
Macro, ensure-flat-list!: Private macros
Macro, ensure-list!: Private macros
Method, %coerce-to-string: Private generic functions

N
normalize-capitalization-and-spacing: Public ordinary functions

Q
qualified-symbol-string: Public ordinary functions

R
reintern: Public ordinary functions

U
underscores->camel-case: Public ordinary functions
underscores->english: Public ordinary functions
underscores->keyword: Public ordinary functions
underscores->lisp-name: Public ordinary functions
underscores->lisp-symbol: Public ordinary functions
underscores->studly-caps: Public ordinary functions


A.3 Variables