The cl-gobject-introspection-wrapper Reference Manual

This is the cl-gobject-introspection-wrapper Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:11:46 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-gobject-introspection-wrapper

Wrap and call GObject Introspection FFI function in LISP style, based on cl-gobject-introspection.

Maintainer

Bohong Huang <>

Author

Bohong Huang <>

Home Page

https://github.com/BohongHuang/cl-gobject-introspection-wrapper

Source Control

(GIT https://github.com/BohongHuang/cl-gobject-introspection-wrapper.git)

Bug Tracker

https://github.com/BohongHuang/cl-gobject-introspection-wrapper/issues

License

lgpl3

Version

1.0.0

Dependencies
  • alexandria (system).
  • cl-gobject-introspection (system).
  • cl-ppcre (system).
Source

cl-gobject-introspection-wrapper.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-gobject-introspection-wrapper/cl-gobject-introspection-wrapper.asd

Source

cl-gobject-introspection-wrapper.asd.

Parent Component

cl-gobject-introspection-wrapper (system).

ASDF Systems

cl-gobject-introspection-wrapper.


3.1.3 cl-gobject-introspection-wrapper/util.lisp

Dependency

package.lisp (file).

Source

cl-gobject-introspection-wrapper.asd.

Parent Component

cl-gobject-introspection-wrapper (system).

Internals

3.1.4 cl-gobject-introspection-wrapper/desc.lisp

Dependency

util.lisp (file).

Source

cl-gobject-introspection-wrapper.asd.

Parent Component

cl-gobject-introspection-wrapper (system).

Public Interface
Internals

3.1.5 cl-gobject-introspection-wrapper/macro.lisp

Dependency

desc.lisp (file).

Source

cl-gobject-introspection-wrapper.asd.

Parent Component

cl-gobject-introspection-wrapper (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 gobject-introspection-wrapper

Source

package.lisp.

Nickname

gir-wrapper

Use List
  • alexandria.
  • 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: *class*
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Special Variable: *namespace*
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Special Variable: *quoted-name-alist*
Package

gobject-introspection-wrapper.

Source

desc.lisp.


5.1.2 Macros

Macro: define-gir-class (name &optional namespace)
Package

gobject-introspection-wrapper.

Source

macro.lisp.

Macro: define-gir-constant (name &optional namespace)
Package

gobject-introspection-wrapper.

Source

macro.lisp.

Macro: define-gir-enum (name &optional namespace)
Package

gobject-introspection-wrapper.

Source

macro.lisp.

Macro: define-gir-function (name &optional namespace)
Package

gobject-introspection-wrapper.

Source

macro.lisp.

Macro: define-gir-namespace (name &optional version repository)
Package

gobject-introspection-wrapper.

Source

macro.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: +getter-pattern+
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Special Variable: +getter-pattern-1+
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Special Variable: +getter-pattern-1-base+
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Special Variable: +getter-pattern-2+
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Special Variable: +setter-pattern+
Package

gobject-introspection-wrapper.

Source

desc.lisp.


5.2.2 Macros

Macro: define-gir-interface (name &optional namespace)
Package

gobject-introspection-wrapper.

Source

macro.lisp.


5.2.3 Ordinary functions

Function: camel-case->lisp-name (phrase)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

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

gobject-introspection-wrapper.

Source

desc.lisp.

Function: class-instance-p (instance class)
Package

gobject-introspection-wrapper.

Source

util.lisp.

Function: defun-form->symbol (form)
Package

gobject-introspection-wrapper.

Source

macro.lisp.

Function: interface-instance-p (instance interface)
Package

gobject-introspection-wrapper.

Source

util.lisp.

Function: merge-constructor-forms (forms descs subst-arg-names)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: quoted-name-symbol (name)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: scan-to-string (regex target-string)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: subclassp (class-a class-b)
Package

gobject-introspection-wrapper.

Source

util.lisp.

Function: transform-class-desc (desc &optional namespace class)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: transform-class-function-desc (desc &optional namespace class)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: transform-constant-desc (desc &optional namespace class)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: transform-constructor-desc (desc &optional namespace class)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: transform-enum-desc (desc &optional namespace class)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: transform-function-desc (desc &optional namespace class)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: transform-interface-desc (desc &optional namespace class)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: transform-method-desc (desc &optional namespace class)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: underscores->lisp-name (phrase)
Package

gobject-introspection-wrapper.

Source

desc.lisp.

Function: underscores->lisp-symbol (phrase)
Package

gobject-introspection-wrapper.

Source

desc.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   D   F   I   M   Q   S   T   U  
Index Entry  Section

C
camel-case->lisp-name: Private ordinary functions
camel-case->lisp-symbol: Private ordinary functions
class-instance-p: Private ordinary functions

D
define-gir-class: Public macros
define-gir-constant: Public macros
define-gir-enum: Public macros
define-gir-function: Public macros
define-gir-interface: Private macros
define-gir-namespace: Public macros
defun-form->symbol: Private ordinary functions

F
Function, camel-case->lisp-name: Private ordinary functions
Function, camel-case->lisp-symbol: Private ordinary functions
Function, class-instance-p: Private ordinary functions
Function, defun-form->symbol: Private ordinary functions
Function, interface-instance-p: Private ordinary functions
Function, merge-constructor-forms: Private ordinary functions
Function, quoted-name-symbol: Private ordinary functions
Function, scan-to-string: Private ordinary functions
Function, subclassp: Private ordinary functions
Function, transform-class-desc: Private ordinary functions
Function, transform-class-function-desc: Private ordinary functions
Function, transform-constant-desc: Private ordinary functions
Function, transform-constructor-desc: Private ordinary functions
Function, transform-enum-desc: Private ordinary functions
Function, transform-function-desc: Private ordinary functions
Function, transform-interface-desc: Private ordinary functions
Function, transform-method-desc: Private ordinary functions
Function, underscores->lisp-name: Private ordinary functions
Function, underscores->lisp-symbol: Private ordinary functions

I
interface-instance-p: Private ordinary functions

M
Macro, define-gir-class: Public macros
Macro, define-gir-constant: Public macros
Macro, define-gir-enum: Public macros
Macro, define-gir-function: Public macros
Macro, define-gir-interface: Private macros
Macro, define-gir-namespace: Public macros
merge-constructor-forms: Private ordinary functions

Q
quoted-name-symbol: Private ordinary functions

S
scan-to-string: Private ordinary functions
subclassp: Private ordinary functions

T
transform-class-desc: Private ordinary functions
transform-class-function-desc: Private ordinary functions
transform-constant-desc: Private ordinary functions
transform-constructor-desc: Private ordinary functions
transform-enum-desc: Private ordinary functions
transform-function-desc: Private ordinary functions
transform-interface-desc: Private ordinary functions
transform-method-desc: Private ordinary functions

U
underscores->lisp-name: Private ordinary functions
underscores->lisp-symbol: Private ordinary functions