The cl-strings Reference Manual

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

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-strings

A set of utilities for manipulating strings in CL.

Author

Diogo Franco

License

MIT

Version

0.0.1

Source

cl-strings.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 cl-strings/cl-strings.asd

Source

cl-strings.asd.

Parent Component

cl-strings (system).

ASDF Systems

cl-strings.


3.1.2 cl-strings/package.lisp

Source

cl-strings.asd.

Parent Component

cl-strings (system).

Packages

cl-strings.


3.1.3 cl-strings/cl-strings.lisp

Dependency

package.lisp (file).

Source

cl-strings.asd.

Parent Component

cl-strings (system).

Public Interface
Internals

*blank-chars* (special variable).


4 Packages

Packages are listed by definition order.


4.1 cl-strings

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

*blank-chars* (special variable).


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 (string &key delimiter)

Returns a string which concatenates every word separated by a space (or a specified delimiter), and upcases every first letter except for the first word of the string.

Package

cl-strings.

Source

cl-strings.lisp.

Function: chars (string)

Returns a list with the chars in "string"

Package

cl-strings.

Source

cl-strings.lisp.

Function: chop (string step)

Returns a list with parts of "string", each with length "step", except for the last one which might have a length small than "step".

Package

cl-strings.

Source

cl-strings.lisp.

Function: clean (string &key char)

Returns a trimmed string with multiple spaces replaced by one

Package

cl-strings.

Source

cl-strings.lisp.

Function: clean-diacritics (string)

Returns a string with the diacritics replaced by their closest ASCII equivalents

Package

cl-strings.

Source

cl-strings.lisp.

Function: ends-with (string suffix &key ignore-case)

Returns true if "string"’s last characters are equal to "suffix".

Package

cl-strings.

Source

cl-strings.lisp.

Function: format-number (number &key precision decimal-separator order-separator)

Converts a number to a string, with "precision" number of digits.

Package

cl-strings.

Source

cl-strings.lisp.

Function: insert (string original &key position)

Returns a string consisting of "original" with "string" inserted at "position".

Package

cl-strings.

Source

cl-strings.lisp.

Function: join (lst &key separator)

Joins a list of strings (or other objects) in a string, delimited by "separator"

Package

cl-strings.

Source

cl-strings.lisp.

Function: kebab-case (string &key delimiter)

Returns a string with every space (or a specified char) replaced by an hyphen, and every character lower cased.

Package

cl-strings.

Source

cl-strings.lisp.

Function: make-template-parser (start-delimiter end-delimiter &key ignore-case)

Returns a closure than can substitute variables delimited by "start-delimiter" and "end-delimiter" in a string, by the provided values.

Package

cl-strings.

Source

cl-strings.lisp.

Function: parse-number (number-str &key decimal-separator order-separator)

Parses number-str without using the reader, returning the equivalent number

Package

cl-strings.

Source

cl-strings.lisp.

Function: repeat (string count &key separator)

Repeats a given string "count" number of times

Package

cl-strings.

Source

cl-strings.lisp.

Function: replace-all (string part replacement &key ignore-case)

Returns a new string in which all the occurences of "part" in "string" are replaced with replacement.

Package

cl-strings.

Source

cl-strings.lisp.

Function: shorten (string len &key truncate-string)

If "string"’s length is bigger than "length", cut the last characters out. Also replaces the last characters of the shortened string for the omission string. It defaults to "...", but can be nil or the empty string.

Package

cl-strings.

Source

cl-strings.lisp.

Function: snake-case (string &key delimiter)

Returns a string with every space (or a specified delimiter) replaced by an underscore, and downcased, except for the first letter.

Package

cl-strings.

Source

cl-strings.lisp.

Function: split (string &optional separator &key ignore-case)

Returns a list of substrings of string
divided by separator. Separator can be a string or a character.
Note: Two consecutive separators will be seen as if there were an empty string between them.

Package

cl-strings.

Source

cl-strings.lisp.

Function: starts-with (string prefix &key ignore-case)

Returns true if "string"’s first characters are equal to "prefix".

Package

cl-strings.

Source

cl-strings.lisp.

Function: title-case (string &key remove-hyphens)

Returns a string with the first letter of every word upcased, and the other ones downcased.

Package

cl-strings.

Source

cl-strings.lisp.

Function: toggle-case (string)

Changes the case of each character in "string"

Package

cl-strings.

Source

cl-strings.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *blank-chars*
Package

cl-strings.

Source

cl-strings.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   E   F   I   J   K   M   P   R   S   T  
Index Entry  Section

C
camel-case: Public ordinary functions
chars: Public ordinary functions
chop: Public ordinary functions
clean: Public ordinary functions
clean-diacritics: Public ordinary functions

E
ends-with: Public ordinary functions

F
format-number: Public ordinary functions
Function, camel-case: Public ordinary functions
Function, chars: Public ordinary functions
Function, chop: Public ordinary functions
Function, clean: Public ordinary functions
Function, clean-diacritics: Public ordinary functions
Function, ends-with: Public ordinary functions
Function, format-number: Public ordinary functions
Function, insert: Public ordinary functions
Function, join: Public ordinary functions
Function, kebab-case: Public ordinary functions
Function, make-template-parser: Public ordinary functions
Function, parse-number: Public ordinary functions
Function, repeat: Public ordinary functions
Function, replace-all: Public ordinary functions
Function, shorten: Public ordinary functions
Function, snake-case: Public ordinary functions
Function, split: Public ordinary functions
Function, starts-with: Public ordinary functions
Function, title-case: Public ordinary functions
Function, toggle-case: Public ordinary functions

I
insert: Public ordinary functions

J
join: Public ordinary functions

K
kebab-case: Public ordinary functions

M
make-template-parser: Public ordinary functions

P
parse-number: Public ordinary functions

R
repeat: Public ordinary functions
replace-all: Public ordinary functions

S
shorten: Public ordinary functions
snake-case: Public ordinary functions
split: Public ordinary functions
starts-with: Public ordinary functions

T
title-case: Public ordinary functions
toggle-case: Public ordinary functions


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*blank-chars*: Private special variables

S
Special Variable, *blank-chars*: Private special variables