The cl-rsvg2 Reference Manual

Table of Contents

The cl-rsvg2 Reference Manual

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

1 Introduction

cl-rsvg2 is a Common Lisp binding to RSVG Library to allow rendering
SVGs to Cairo surfaces.

It requires cffi, asdf, cl-cairo2, cl-gtk2, trivial-gray-streams, and
naturally, librsvg.

So far it has been tested against librsvg 2.34.1 with SBCL 1.0.54 under
Ubuntu GNU/Linux.

It is a fork of cl-rsvg by Sasha Kovar which was using cl-cairo instead
of cl-cairo2.  It also uses the cl-gtk2-glib system of cl-gtk2 for a
few definitions that cl-rsvg made itself.  If anyone should want to use
the library but like to avoid this dependency, contact me so I can make
a light version without it.

The mapping was somewhat minimal in cl-rsvg.  I added FFI declarations
for most (non-deprecated) functions of the RSVG Library, but tested only
some of them.  The GdkPixmap functions are in a seperate sytem which
depends upon cl-ftk2-gdk.  The well supported functionaly consists only
of what is required to load SVG files and render them to Cairo.  The
highest level wrappers are DRAW-SVG-DATA and DRAW-SVG-FILE, the later of
which is doing just that.  If you have used some of the untested
functionality and noticed problems, or wish for more functionality,
contact me!

The newest functionality (in highly experimental state) is the
HANDLE-DATA-STREAM class.  As of yet, it is completely untested.
Its purpose is to make it possible to treat a RsvgHandle as a stream,
i.e. feed it data with WRITE-SEQUENCE and WRITE-BYTE.

tests/cairo-test.lisp contains example usage.

See also:
http://developer.gnome.org/rsvg/stable/index.html (Reference Manual)
http://librsvg.sourceforge.net
http://www.cairographics.org
http://common-lisp.net/project/cl-cairo2/

TODO:
* Add docstrings for all exported functions.

Enjoy!
Rörd Hinrichsen 

2 Systems

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

2.1 cl-rsvg2

Maintainer

Rörd Hinrichsen <roerdhh@gmail.com>

Author

Sasha Kovar <sasha-rsvg@arcocene.org>

License

LLGPL

Description

Bindings for RSVG Library.

Version

0.4.1

Dependencies

• cffi
• cl-cairo2
• cl-gtk2-glib
• trivial-gray-streams

Source

cl-rsvg2.asd (file)

Components

• package.lisp (file)
• cl-rsvg2-ffi.lisp (file)
• cl-rsvg2.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 cl-rsvg2.asd

Location

cl-rsvg2.asd

Systems

cl-rsvg2 (system)

3.1.2 cl-rsvg2/package.lisp

Parent

cl-rsvg2 (system)

Location

package.lisp

Packages

cl-rsvg2

3.1.3 cl-rsvg2/cl-rsvg2-ffi.lisp

Dependency

package.lisp (file)

Parent

cl-rsvg2 (system)

Location

cl-rsvg2-ffi.lisp

Exported Definitions

• handle-get-base-uri (function)
• handle-get-desc (function)
• handle-get-metadata (function)
• handle-get-title (function)
• handle-has-sub (function)
• handle-new (function)
• handle-set-base-uri (function)
• handle-set-dpi (function)
• handle-set-dpi-x-y (function)
• set-default-dpi (function)
• set-default-dpi-x-y (function)

Internal Definitions

• dimension-data-tclass (class)
• handle-close (function)
• handle-get-dimensions (function)
• handle-get-dimensions-sub (function)
• handle-get-position-sub (function)
• handle-new-from-data (function)
• handle-new-from-file (function)
• handle-render-cairo (function)
• handle-render-cairo-sub (function)
• handle-write (function)
• position-data-tclass (class)

3.1.4 cl-rsvg2/cl-rsvg2.lisp

Dependency

cl-rsvg2-ffi.lisp (file)

Parent

cl-rsvg2 (system)

Location

cl-rsvg2.lisp

Exported Definitions

• draw-svg (function)
• draw-svg-data (function)
• draw-svg-file (function)
• draw-svg-sub (function)
• handle (method)
• handle-close* (function)
• handle-data-stream (class)
• handle-get-dimension-values (function)
• handle-get-sub-dimension-values (function)
• handle-get-sub-position-values (function)
• handle-write-data (function)
• with-handle (macro)
• with-handle-data-stream (macro)
• with-handle-from-data (macro)
• with-handle-from-file (macro)

4 Packages

Packages are listed by definition order.

4.1 cl-rsvg2

Source

package.lisp (file)

Nickname

rsvg2

Use List

• trivial-gray-streams
• glib
• gobject.ffi
• cffi
• common-lisp

Exported Definitions

• draw-svg (function)
• draw-svg-data (function)
• draw-svg-file (function)
• draw-svg-sub (function)
• handle (generic function)
• handle (method)
• handle-close* (function)
• handle-data-stream (class)
• handle-get-base-uri (function)
• handle-get-desc (function)
• handle-get-dimension-values (function)
• handle-get-metadata (function)
• handle-get-sub-dimension-values (function)
• handle-get-sub-position-values (function)
• handle-get-title (function)
• handle-has-sub (function)
• handle-new (function)
• handle-set-base-uri (function)
• handle-set-dpi (function)
• handle-set-dpi-x-y (function)
• handle-write-data (function)
• set-default-dpi (function)
• set-default-dpi-x-y (function)
• with-handle (macro)
• with-handle-data-stream (macro)
• with-handle-from-data (macro)
• with-handle-from-file (macro)

Internal Definitions

• dimension-data-tclass (class)
• handle-close (function)
• handle-get-dimensions (function)
• handle-get-dimensions-sub (function)
• handle-get-position-sub (function)
• handle-new-from-data (function)
• handle-new-from-file (function)
• handle-render-cairo (function)
• handle-render-cairo-sub (function)
• handle-write (function)
• position-data-tclass (class)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: with-handle (VAR HANDLE) &body BODY

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Macro: with-handle-data-stream (STREAM) &body BODY

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Macro: with-handle-from-data (HANDLE DATA DATA-LEN) &body BODY

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Macro: with-handle-from-file (HANDLE FILESPEC) &body BODY

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

5.1.2 Functions

Function: draw-svg SVG &optional CONTEXT

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Function: draw-svg-data DATA DATA-LEN &optional CONTEXT

Draw SVG data on a Cairo surface. DATA needs to be an uint8 C array, and DATA-LEN its length, in bytes. Return the SVGs width and height.

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Function: draw-svg-file FILESPEC &optional CONTEXT

Draw a SVG file on a Cairo surface. Return its width and height.

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Function: draw-svg-sub SVG ID &optional CONTEXT

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Function: handle-close* HANDLE

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Function: handle-get-base-uri HANDLE

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-get-desc HANDLE

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-get-dimension-values HANDLE

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Function: handle-get-metadata HANDLE

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-get-sub-dimension-values HANDLE ID

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Function: handle-get-sub-position-values HANDLE ID

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Function: handle-get-title HANDLE

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-has-sub HANDLE ID

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-new ()

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-set-base-uri HANDLE BASE-URI

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-set-dpi HANDLE DPI

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-set-dpi-x-y HANDLE DPI-X DPI-Y

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-write-data HANDLE BUF COUNT

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Function: set-default-dpi DPI

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: set-default-dpi-x-y DPI-X DPI-Y

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

5.1.3 Generic functions

Generic Function: handle OBJECT

Package

cl-rsvg2

Methods

Method: handle (HANDLE-DATA-STREAM handle-data-stream)

automatically generated reader method

Source

cl-rsvg2.lisp (file)

5.1.4 Classes

Class: handle-data-stream ()

Package

cl-rsvg2

Source

cl-rsvg2.lisp (file)

Direct superclasses

• trivial-gray-stream-mixin (class)
• fundamental-binary-output-stream (class)

Direct methods

• stream-write-byte (method)
• stream-write-sequence (method)
• close (method)
• stream-element-type (method)
• handle (method)

Direct slots

Slot: handle

Initargs

:handle

Readers

handle (generic function)

5.2 Internal definitions

5.2.1 Functions

Function: handle-close HANDLE ERROR

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-get-dimensions HANDLE DIMENSION-DATA

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-get-dimensions-sub HANDLE DIMENSION-DATA ID

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-get-position-sub HANDLE POSITION-DATA ID

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-new-from-data DATA DATA_LEN ERROR

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-new-from-file FILE_NAME ERROR

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-render-cairo HANDLE CR

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-render-cairo-sub HANDLE CR ID

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Function: handle-write HANDLE BUF COUNT ERROR

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

5.2.2 Classes

Class: dimension-data-tclass ()

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: position-data-tclass ()

Package

cl-rsvg2

Source

cl-rsvg2-ffi.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types