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

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 Mon Feb 26 15:17:54 2024 GMT+0.

Next: Systems, Previous: The cl-gobject-introspection-wrapper Reference Manual, Up: The cl-gobject-introspection-wrapper Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-gobject-introspection-wrapper Reference Manual [Contents][Index]

2 Systems

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

cl-gobject-introspection-wrapper

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

2.1 `cl-gobject-introspection-wrapper`

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

Maintainer

Bohong Huang <1281299809@qq.com>

Author

Bohong Huang <1281299809@qq.com>

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

package.lisp (file).
util.lisp (file).
desc.lisp (file).
macro.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-gobject-introspection-wrapper Reference Manual [Contents][Index]

3 Files

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

Lisp

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

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).

Public Interface

pointer-object (generic function).

Internals

class-instance-p (function).
interface-instance-p (function).
subclassp (function).

Next: cl-gobject-introspection-wrapper/macro.lisp, Previous: cl-gobject-introspection-wrapper/util.lisp, Up: Lisp [Contents][Index]

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

*class* (special variable).
*namespace* (special variable).
*quoted-name-alist* (special variable).

Internals

+constructor-pattern+ (special variable).
+getter-pattern+ (special variable).
+getter-pattern-1+ (special variable).
+getter-pattern-1-base+ (special variable).
+getter-pattern-2+ (special variable).
+setter-pattern+ (special variable).
callable-desc-argument-names (function).
camel-case->lisp-name (function).
camel-case->lisp-symbol (function).
merge-constructor-forms (function).
quoted-name-symbol (function).
scan-to-string (function).
transform-class-desc (function).
transform-class-function-desc (function).
transform-constant-desc (function).
transform-constructor-desc (function).
transform-enum-desc (function).
transform-function-desc (function).
transform-interface-desc (function).
transform-method-desc (function).
underscores->lisp-name (function).
underscores->lisp-symbol (function).

Previous: cl-gobject-introspection-wrapper/desc.lisp, Up: Lisp [Contents][Index]

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

define-gir-class (macro).
define-gir-constant (macro).
define-gir-enum (macro).
define-gir-function (macro).
define-gir-namespace (macro).

Internals

define-gir-interface (macro).
defun-form->symbol (function).

Next: Definitions, Previous: Files, Up: The cl-gobject-introspection-wrapper Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

gobject-introspection-wrapper

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

4.1 `gobject-introspection-wrapper`

Source

package.lisp.

Nickname

gir-wrapper

Use List

alexandria.
common-lisp.

Public Interface

*class* (special variable).
*namespace* (special variable).
*quoted-name-alist* (special variable).
define-gir-class (macro).
define-gir-constant (macro).
define-gir-enum (macro).
define-gir-function (macro).
define-gir-namespace (macro).
object-pointer (generic function).
pointer-object (generic function).

Internals

+constructor-pattern+ (special variable).
+getter-pattern+ (special variable).
+getter-pattern-1+ (special variable).
+getter-pattern-1-base+ (special variable).
+getter-pattern-2+ (special variable).
+setter-pattern+ (special variable).
callable-desc-argument-names (function).
camel-case->lisp-name (function).
camel-case->lisp-symbol (function).
class-instance-p (function).
define-gir-interface (macro).
defun-form->symbol (function).
interface-instance-p (function).
merge-constructor-forms (function).
quoted-name-symbol (function).
scan-to-string (function).
subclassp (function).
transform-class-desc (function).
transform-class-function-desc (function).
transform-constant-desc (function).
transform-constructor-desc (function).
transform-enum-desc (function).
transform-function-desc (function).
transform-interface-desc (function).
transform-method-desc (function).
underscores->lisp-name (function).
underscores->lisp-symbol (function).

Next: Indexes, Previous: Packages, Up: The cl-gobject-introspection-wrapper Reference Manual [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

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

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]

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.

Previous: Macros, Up: Public Interface [Contents][Index]

5.1.3 Generic functions

Generic Function: object-pointer (obj) ¶

Package: gobject-introspection-wrapper.
Alias for: this-of.

Generic Function: pointer-object (pointer type) ¶

Construct GObject from a CFFI pointer.

Package: gobject-introspection-wrapper.
Source: util.lisp.

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

5.2 Internals

Special variables
Macros
Ordinary functions

Next: Macros, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: +constructor-pattern+ ¶

Package: gobject-introspection-wrapper.
Source: desc.lisp.

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.

Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Macros

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

Package: gobject-introspection-wrapper.
Source: macro.lisp.

Previous: Macros, Up: Internals [Contents][Index]

5.2.3 Ordinary functions

Function: callable-desc-argument-names (desc) ¶

Package: gobject-introspection-wrapper.
Source: desc.lisp.

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 &optional case-sensitive-p) ¶

Package: gobject-introspection-wrapper.
Source: desc.lisp.

Previous: Definitions, Up: The cl-gobject-introspection-wrapper Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	C D F G I M O P Q S T U

	Index Entry	Section

C
	`callable-desc-argument-names`:	Private ordinary functions
	`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, callable-desc-argument-names`:	Private ordinary functions
	`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

G
	`Generic Function, object-pointer`:	Public generic functions
	`Generic Function, pointer-object`:	Public generic 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

O
	`object-pointer`:	Public generic functions

P
	`pointer-object`:	Public generic 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

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* + S

	Index Entry	Section

*
	`class`:	Public special variables
	`namespace`:	Public special variables
	`quoted-name-alist`:	Public special variables

+
	`+constructor-pattern+`:	Private special variables
	`+getter-pattern+`:	Private special variables
	`+getter-pattern-1+`:	Private special variables
	`+getter-pattern-1-base+`:	Private special variables
	`+getter-pattern-2+`:	Private special variables
	`+setter-pattern+`:	Private special variables

S
	`Special Variable, class`:	Public special variables
	`Special Variable, namespace`:	Public special variables
	`Special Variable, quoted-name-alist`:	Public special variables
	`Special Variable, +constructor-pattern+`:	Private special variables
	`Special Variable, +getter-pattern+`:	Private special variables
	`Special Variable, +getter-pattern-1+`:	Private special variables
	`Special Variable, +getter-pattern-1-base+`:	Private special variables
	`Special Variable, +getter-pattern-2+`:	Private special variables
	`Special Variable, +setter-pattern+`:	Private special variables

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

A.4 Data types

Jump to:	C D F G M P S U

	Index Entry	Section

C
	`cl-gobject-introspection-wrapper`:	The cl-gobject-introspection-wrapper system
	`cl-gobject-introspection-wrapper.asd`:	The cl-gobject-introspection-wrapper/cl-gobject-introspection-wrapper․asd file

D
	`desc.lisp`:	The cl-gobject-introspection-wrapper/desc․lisp file

F
	`File, cl-gobject-introspection-wrapper.asd`:	The cl-gobject-introspection-wrapper/cl-gobject-introspection-wrapper․asd file
	`File, desc.lisp`:	The cl-gobject-introspection-wrapper/desc․lisp file
	`File, macro.lisp`:	The cl-gobject-introspection-wrapper/macro․lisp file
	`File, package.lisp`:	The cl-gobject-introspection-wrapper/package․lisp file
	`File, util.lisp`:	The cl-gobject-introspection-wrapper/util․lisp file

G
	`gobject-introspection-wrapper`:	The gobject-introspection-wrapper package

M
	`macro.lisp`:	The cl-gobject-introspection-wrapper/macro․lisp file

P
	`Package, gobject-introspection-wrapper`:	The gobject-introspection-wrapper package
	`package.lisp`:	The cl-gobject-introspection-wrapper/package․lisp file

S
	`System, cl-gobject-introspection-wrapper`:	The cl-gobject-introspection-wrapper system

U
	`util.lisp`:	The cl-gobject-introspection-wrapper/util․lisp file

The cl-gobject-introspection-wrapper Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-gobject-introspection-wrapper

3 Files

3.1 Lisp

3.1.1 cl-gobject-introspection-wrapper/cl-gobject-introspection-wrapper.asd

3.1.2 cl-gobject-introspection-wrapper/package.lisp

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

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

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

4 Packages

4.1 gobject-introspection-wrapper

5 Definitions

5.1 Public Interface

5.1.1 Special variables

5.1.2 Macros

5.1.3 Generic functions

5.2 Internals

5.2.1 Special variables

5.2.2 Macros

5.2.3 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-gobject-introspection-wrapper`

3.1.1 `cl-gobject-introspection-wrapper/cl-gobject-introspection-wrapper.asd`

3.1.2 `cl-gobject-introspection-wrapper/package.lisp`

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

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

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

4.1 `gobject-introspection-wrapper`