The cl-semver Reference Manual

Table of Contents

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

The cl-semver Reference Manual

This is the cl-semver Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:34:34 2020 GMT+0.


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

1 Introduction

CL-SEMVER

cl-semver is a Common Lisp implementation of the Semantic Versioning Specification (http://semver.org/

Functions

%disable-version-syntax nil

Internal function used to restore previous readtable.

%enable-version-syntax nil

Internal function used to enable reader syntax and store current readtable on stack.

make-semantic-version (major minor patch &optional pre-release build)

Creates a semantic version

print-version (version &optional stream)

Prints a version to a stream

print-version-to-string (version)

Prints a version to a string

read-version-from-string (string &optional (class (quote semantic-version)))

Parses a semantic version from a string

version<= (version1 version2)

Version less or equal comparison

version> (version1 version2)

Version greater than comparison

version>= (version1 version2)

Version greater or equal comparison

Macros

disable-version-syntax

Restore readtable which was active before last call to ENABLE-VERSION-SYNTAX. If there was no such call, the standard readtable is used.

enable-version-syntax

Enable version reader syntax.

Generic-Functions

version/=

Version distinct comparison

version/==

Version shallow distinct comparison

version<

Version less than comparison

version=

Version equality comparison

version==

Version shallow equality comparison

Slot-Accessors

version-build

The build version number

(setf version-build)

The build version number

version-major

The major version number

(setf version-major)

The major version number

version-minor

The minor version number

(setf version-minor)

The minor version number

version-patch

The patch (or micro) version number

(setf version-patch)

The patch (or micro) version number

version-pre-release

The pre release version number

(setf version-pre-release)

The pre release version number

Variables

Classes

semantic-version

Instances represent a full version according to the semantic version specs (version 2.0.0-rc1 of the spec). http://semver.org/ . The main features of this class are validation and version comparison.

version

Library version

Conditions

Constants


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

2 Systems

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


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

2.1 cl-semver

Author

Mariano Montone

License

MIT

Description

Semantic Version implementation

Dependencies
Source

cl-semver.asd (file)

Components

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-semver.asd

Location

cl-semver.asd

Systems

cl-semver (system)


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

3.1.2 cl-semver/package.lisp

Parent

cl-semver (system)

Location

package.lisp

Packages

cl-semver


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

3.1.3 cl-semver/semver.lisp

Dependency

package.lisp (file)

Parent

cl-semver (system)

Location

semver.lisp

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-semver

cl-semver is a Common Lisp implementation of the Semantic Versioning Specification (http://semver.org/

Source

package.lisp (file)

Nickname

semver

Use List
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 Macros

Macro: disable-version-syntax ()

Restore readtable which was active before last call to ENABLE-VERSION-SYNTAX. If there was no such call, the standard readtable is used.

Package

cl-semver

Source

semver.lisp (file)

Macro: enable-version-syntax ()

Enable version reader syntax.

Package

cl-semver

Source

semver.lisp (file)


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

5.1.2 Functions

Function: make-semantic-version MAJOR MINOR PATCH &optional PRE-RELEASE BUILD

Creates a semantic version

Package

cl-semver

Source

semver.lisp (file)

Function: print-version VERSION &optional STREAM

Prints a version to a stream

Package

cl-semver

Source

semver.lisp (file)

Function: print-version-to-string VERSION

Prints a version to a string

Package

cl-semver

Source

semver.lisp (file)

Function: read-version-from-string STRING &optional CLASS

Parses a semantic version from a string

Package

cl-semver

Source

semver.lisp (file)

Function: version-string-valid-p STRING

Validate a version string

Package

cl-semver

Source

semver.lisp (file)

Function: version<= VERSION1 VERSION2

Version less or equal comparison

Package

cl-semver

Source

semver.lisp (file)

Function: version> VERSION1 VERSION2

Version greater than comparison

Package

cl-semver

Source

semver.lisp (file)

Function: version>= VERSION1 VERSION2

Version greater or equal comparison

Package

cl-semver

Source

semver.lisp (file)

Function: versionp OBJECT
Package

cl-semver

Source

semver.lisp (file)


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

5.1.3 Generic functions

Generic Function: version-build OBJECT
Generic Function: (setf version-build) NEW-VALUE OBJECT
Package

cl-semver

Methods
Method: version-build (SEMANTIC-VERSION semantic-version)
Method: (setf version-build) NEW-VALUE (SEMANTIC-VERSION semantic-version)

The build version number

Source

semver.lisp (file)

Generic Function: version-major OBJECT
Generic Function: (setf version-major) NEW-VALUE OBJECT
Package

cl-semver

Methods
Method: version-major (SEMANTIC-VERSION semantic-version)
Method: (setf version-major) NEW-VALUE (SEMANTIC-VERSION semantic-version)

The major version number

Source

semver.lisp (file)

Generic Function: version-minor OBJECT
Generic Function: (setf version-minor) NEW-VALUE OBJECT
Package

cl-semver

Methods
Method: version-minor (SEMANTIC-VERSION semantic-version)
Method: (setf version-minor) NEW-VALUE (SEMANTIC-VERSION semantic-version)

The minor version number

Source

semver.lisp (file)

Generic Function: version-patch OBJECT
Generic Function: (setf version-patch) NEW-VALUE OBJECT
Package

cl-semver

Methods
Method: version-patch (SEMANTIC-VERSION semantic-version)
Method: (setf version-patch) NEW-VALUE (SEMANTIC-VERSION semantic-version)

The patch (or micro) version number

Source

semver.lisp (file)

Generic Function: version-pre-release OBJECT
Generic Function: (setf version-pre-release) NEW-VALUE OBJECT
Package

cl-semver

Methods
Method: version-pre-release (SEMANTIC-VERSION semantic-version)
Method: (setf version-pre-release) NEW-VALUE (SEMANTIC-VERSION semantic-version)

The pre release version number

Source

semver.lisp (file)

Generic Function: version/= VERSION1 VERSION2

Version distinct comparison

Package

cl-semver

Source

semver.lisp (file)

Methods
Method: version/= (VERSION1 version) (VERSION2 version)
Method: version/= VERSION1 VERSION2
Generic Function: version/== VERSION1 VERSION2

Version shallow distinct comparison

Package

cl-semver

Source

semver.lisp (file)

Methods
Method: version/== (VERSION1 version) (VERSION2 version)
Method: version/== VERSION1 VERSION2
Generic Function: version< VERSION1 VERSION2

Version less than comparison

Package

cl-semver

Source

semver.lisp (file)

Methods
Method: version< (VERSION1 version) (VERSION2 version)
Method: version< VERSION1 (VERSION2 (eql min-version))
Method: version< (VERSION1 (eql max-version)) VERSION2
Method: version< VERSION1 (VERSION2 (eql max-version))
Method: version< (VERSION1 (eql min-version)) VERSION2
Generic Function: version= VERSION1 VERSION2

Version equality comparison

Package

cl-semver

Source

semver.lisp (file)

Methods
Method: version= (VERSION1 version) (VERSION2 version)
Method: version= VERSION1 VERSION2
Generic Function: version== VERSION1 VERSION2

Version shallow equality comparison

Package

cl-semver

Source

semver.lisp (file)

Methods
Method: version== (VERSION1 version) (VERSION2 version)
Method: version== VERSION1 VERSION2

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

5.1.4 Classes

Class: semantic-version ()

Instances represent a full version according to the semantic version specs (version 2.0.0-rc1 of the spec). http://semver.org/ . The main features of this class are validation and version comparison.

Package

cl-semver

Source

semver.lisp (file)

Direct superclasses

version (class)

Direct methods
Direct slots
Slot: major

The major version number

Type

integer

Initargs

:major

Initform

(error "provide the major version number")

Readers

version-major (generic function)

Writers

(setf version-major) (generic function)

Slot: minor

The minor version number

Type

integer

Initargs

:minor

Initform

(error "provide the minor version number")

Readers

version-minor (generic function)

Writers

(setf version-minor) (generic function)

Slot: patch

The patch (or micro) version number

Type

integer

Initargs

:patch

Initform

(error "provide the patch version number")

Readers

version-patch (generic function)

Writers

(setf version-patch) (generic function)

Slot: pre-release

The pre release version number

Type

integer

Initargs

:pre-release

Readers

version-pre-release (generic function)

Writers

(setf version-pre-release) (generic function)

Slot: build

The build version number

Type

integer

Initargs

:build

Readers

version-build (generic function)

Writers

(setf version-build) (generic function)

Class: version ()

Library version

Package

cl-semver

Source

semver.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

semantic-version (class)

Direct methods

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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *previous-readtables*
Package

cl-semver

Source

semver.lisp (file)


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

5.2.2 Functions

Function: %disable-version-syntax ()

Internal function used to restore previous readtable.

Package

cl-semver

Source

semver.lisp (file)

Function: %enable-version-syntax ()

Internal function used to enable reader syntax and store current readtable on stack.

Package

cl-semver

Source

semver.lisp (file)

Function: tuple< T1 T2
Package

cl-semver

Source

semver.lisp (file)

Function: version-syntax-reader STREAM SUBCHAR ARG
Package

cl-semver

Source

semver.lisp (file)


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

5.2.3 Generic functions

Generic Function: validate-version VERSION

Validate a version

Package

cl-semver

Source

semver.lisp (file)

Methods
Method: validate-version VERSION
Method: validate-version (VERSION (eql min-version))
Method: validate-version (VERSION (eql max-version))
Method: validate-version (VERSION semantic-version)

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-semver.asd: The cl-semver․asd file
cl-semver/package.lisp: The cl-semver/package․lisp file
cl-semver/semver.lisp: The cl-semver/semver․lisp file

F
File, Lisp, cl-semver.asd: The cl-semver․asd file
File, Lisp, cl-semver/package.lisp: The cl-semver/package․lisp file
File, Lisp, cl-semver/semver.lisp: The cl-semver/semver․lisp file

L
Lisp File, cl-semver.asd: The cl-semver․asd file
Lisp File, cl-semver/package.lisp: The cl-semver/package․lisp file
Lisp File, cl-semver/semver.lisp: The cl-semver/semver․lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   %   (  
D   E   F   G   M   P   R   T   V  
Index Entry  Section

%
%disable-version-syntax: Internal functions
%enable-version-syntax: Internal functions

(
(setf version-build): Exported generic functions
(setf version-build): Exported generic functions
(setf version-major): Exported generic functions
(setf version-major): Exported generic functions
(setf version-minor): Exported generic functions
(setf version-minor): Exported generic functions
(setf version-patch): Exported generic functions
(setf version-patch): Exported generic functions
(setf version-pre-release): Exported generic functions
(setf version-pre-release): Exported generic functions

D
disable-version-syntax: Exported macros

E
enable-version-syntax: Exported macros

F
Function, %disable-version-syntax: Internal functions
Function, %enable-version-syntax: Internal functions
Function, make-semantic-version: Exported functions
Function, print-version: Exported functions
Function, print-version-to-string: Exported functions
Function, read-version-from-string: Exported functions
Function, tuple<: Internal functions
Function, version-string-valid-p: Exported functions
Function, version-syntax-reader: Internal functions
Function, version<=: Exported functions
Function, version>: Exported functions
Function, version>=: Exported functions
Function, versionp: Exported functions

G
Generic Function, (setf version-build): Exported generic functions
Generic Function, (setf version-major): Exported generic functions
Generic Function, (setf version-minor): Exported generic functions
Generic Function, (setf version-patch): Exported generic functions
Generic Function, (setf version-pre-release): Exported generic functions
Generic Function, validate-version: Internal generic functions
Generic Function, version-build: Exported generic functions
Generic Function, version-major: Exported generic functions
Generic Function, version-minor: Exported generic functions
Generic Function, version-patch: Exported generic functions
Generic Function, version-pre-release: Exported generic functions
Generic Function, version/=: Exported generic functions
Generic Function, version/==: Exported generic functions
Generic Function, version<: Exported generic functions
Generic Function, version=: Exported generic functions
Generic Function, version==: Exported generic functions

M
Macro, disable-version-syntax: Exported macros
Macro, enable-version-syntax: Exported macros
make-semantic-version: Exported functions
Method, (setf version-build): Exported generic functions
Method, (setf version-major): Exported generic functions
Method, (setf version-minor): Exported generic functions
Method, (setf version-patch): Exported generic functions
Method, (setf version-pre-release): Exported generic functions
Method, validate-version: Internal generic functions
Method, validate-version: Internal generic functions
Method, validate-version: Internal generic functions
Method, validate-version: Internal generic functions
Method, version-build: Exported generic functions
Method, version-major: Exported generic functions
Method, version-minor: Exported generic functions
Method, version-patch: Exported generic functions
Method, version-pre-release: Exported generic functions
Method, version/=: Exported generic functions
Method, version/=: Exported generic functions
Method, version/==: Exported generic functions
Method, version/==: Exported generic functions
Method, version<: Exported generic functions
Method, version<: Exported generic functions
Method, version<: Exported generic functions
Method, version<: Exported generic functions
Method, version<: Exported generic functions
Method, version=: Exported generic functions
Method, version=: Exported generic functions
Method, version==: Exported generic functions
Method, version==: Exported generic functions

P
print-version: Exported functions
print-version-to-string: Exported functions

R
read-version-from-string: Exported functions

T
tuple<: Internal functions

V
validate-version: Internal generic functions
validate-version: Internal generic functions
validate-version: Internal generic functions
validate-version: Internal generic functions
validate-version: Internal generic functions
version-build: Exported generic functions
version-build: Exported generic functions
version-major: Exported generic functions
version-major: Exported generic functions
version-minor: Exported generic functions
version-minor: Exported generic functions
version-patch: Exported generic functions
version-patch: Exported generic functions
version-pre-release: Exported generic functions
version-pre-release: Exported generic functions
version-string-valid-p: Exported functions
version-syntax-reader: Internal functions
version/=: Exported generic functions
version/=: Exported generic functions
version/=: Exported generic functions
version/==: Exported generic functions
version/==: Exported generic functions
version/==: Exported generic functions
version<: Exported generic functions
version<: Exported generic functions
version<: Exported generic functions
version<: Exported generic functions
version<: Exported generic functions
version<: Exported generic functions
version<=: Exported functions
version=: Exported generic functions
version=: Exported generic functions
version=: Exported generic functions
version==: Exported generic functions
version==: Exported generic functions
version==: Exported generic functions
version>: Exported functions
version>=: Exported functions
versionp: Exported functions

Jump to:   %   (  
D   E   F   G   M   P   R   T   V  

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

A.3 Variables

Jump to:   *  
B   M   P   S  
Index Entry  Section

*
*previous-readtables*: Internal special variables

B
build: Exported classes

M
major: Exported classes
minor: Exported classes

P
patch: Exported classes
pre-release: Exported classes

S
Slot, build: Exported classes
Slot, major: Exported classes
Slot, minor: Exported classes
Slot, patch: Exported classes
Slot, pre-release: Exported classes
Special Variable, *previous-readtables*: Internal special variables

Jump to:   *  
B   M   P   S  

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

A.4 Data types

Jump to:   C   P   S   V  
Index Entry  Section

C
cl-semver: The cl-semver system
cl-semver: The cl-semver package
Class, semantic-version: Exported classes
Class, version: Exported classes

P
Package, cl-semver: The cl-semver package

S
semantic-version: Exported classes
System, cl-semver: The cl-semver system

V
version: Exported classes

Jump to:   C   P   S   V