A CFFI wrapper for pslib

José Ronquillo Rivera dd184c029a New open-image method 5 years ago
examples be28d307fd Initial revision 10 years ago
COPYING be28d307fd Initial revision 10 years ago
COPYING.LESSER be28d307fd Initial revision 10 years ago
LICENSE be28d307fd Initial revision 10 years ago
README.org 73ac300e54 Added quicklisp badge 6 years ago
cffi-interface.lisp dd184c029a New open-image method 5 years ago
cl-pslib.asd 427c78efd6 Improved description and fixed a typo 7 years ago
cl-pslib.lisp dd184c029a New open-image method 5 years ago
conditions.lisp be28d307fd Initial revision 10 years ago
constants.lisp 437b9e9250 More fixes 7 years ago
graphics-utils.lisp 9fab880062 -[fix] exported psdoc symbol; 10 years ago
package.lisp 1d20607a74 - added a couple of functions for draw text confined in a box. 5 years ago
page-metrics.lisp 938e6d6fca - exported symbol "page-size-equal-p" 6 years ago
pslib.i be28d307fd Initial revision 10 years ago
pslib.lisp be28d307fd Initial revision 10 years ago

README.org

Introduction

http://quickdocs.org/badge/cl-pslib.svg

Cl-pslib is a (thin) wrapper around pslib a library for generating PostScript files.

The wrapper

Cl-pslib use CFFI and SWIG to interface with foreign (non lisp) library and generate the low-level lisp wrapper respectively.

cl-pslib does not export the raw (CFFI) pslib API but use CLOS instead.

A psdoc C struct pointer is wrapped in the class psdoc, most of the functions to manipulate this pointer are wrapped in lisp methods specialized for that class.

Parameters

Pslib use a lot of parameters to configure its behavior.

Example:


 (get-value doc "boxheight")

I found this very unpractical so i tried to generate lisp constants to match the corresponding string parameter


 (get-value doc +value-key-boxheight+)

Function name

As general rule the methods for the class psdoc are the same of the ones of the pslib with the character "_" substituted by "-".

There are some exceptions listed below.

native name lisp name
PS\_set\_border\_color set-border-link-color
PS\_set\_border\_dash set-border-link-dash
PS\_set\_border\_style set-border-link-style
PS\_open, PS\_open\_mem open-doc
PS\_fill fill-path
PS\_show and PS\_show2 show
PS\_show\_xy and PS\_show\_xy2 show-xy
PS\_string\_geometry, PS\_stringwidth and PS\_stringwidth2 string-geometry
PS\_symbol font-symbol
PS\_symbol\_name font-symbol-name
PS\_symbol\_width font-symbol-width

Other differences

Issues

  • setcolor can accept a cl-color object as parameter;
  • there is no '(ps_)boot' method; when an instance of psdoc in created the
  • 'initialize-instance' of that class will call ps\_boot if needed. The same is true for '(ps_)new' method;
  • 'open-doc' method will pass the output of pslib (i.e.the PostScript
  • file) to a lisp callback function if the second argument of the function is nil; by default the callback just copy the output in ps:*callback-string*. This maybe can be useful for generate a file in a web application.
  • the string-geometry method return an instance of text-metrics class

Note that the whole library is in an alpha stage, testing is still in progress, please see section below

Missing function

The high-level API does not still remap this functions:

  • PS\_free\_glyph\_list;
  • PS\_get\_buffer;
  • PS\_glyph\_list;
  • PS\_new2;
  • PS\_open\_fp;
  • PS\_hyphenate;
  • PS\_list\_parameters;
  • PS\_list\_resources;
  • PS\_list\_values;
  • PS\_set\_gstate;
  • PS\_setdash (use set-polydash instead).

BUGS

Please send bug report to cage at katamail dot com

License

This library is released under Lisp Lesser General Public license (see COPYING.LESSER file)

Examples are released under GPL version 3 or later

NO WARRANTY

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.