The wumpus-core package
Wumpus-Core is a low-level library for generating static 2D
vector pictures, its salient feature is portability due to no
FFI dependencies. It can generate PostScript (EPS) files and SVG
files. The generated PostScript code is plain and reasonably
efficient as the use of stack operations, i.e
grestore, is minimized.
Although Wumpus-Core only generates vector output, the generated PostScript can be interpreted by GraphicsMagick or a similar tool to convert EPS files into bitmap image files (e.g JPEGs).
Wumpus-Core makes pictures from paths and text labels. Paths themselves are made from points. The usual affine transformations (rotations, scaling, translations) can be applied to Pictures. Unlike PostScript there is no notion of a current point, Wumpus-Core builds pictures in a coordinate-free style.
For actually building pictures, diagrams, etc. Wumpus-Core is
very low-level. There is a supplementary package
available that helps create certain types of diagram, but it is
experimental - functionality is added and dropped between
releases, it has no stable API.
Some of the design decisions made for Wumpus-Core are not sophisticated (e.g. how path and text attributes like colour are handled, and how the bounding boxes of text labels are calculated), so Wumpus might be limited compared to other systems. However, the design permits a fairly simple implementation, which is a priority.
UPDATING from 0.37.0 or earlier to 0.41.0.
There were substantial changes in verion 0.40.0 - hence the version number jump from 0.37.0. Version 0.41.0 introduces mostly cosmetic changes, but for upgrading from 0.37.0 or earlier the change-notes that follow are still relevant.
Core.Picture API change - the path construction function has
primPath. The type of the path segments
has changed, the functions
curveTo now build
The Text API has changed substantially, however most user code
should only need minor changes. The functions
writeSVG_latin1 have been removed, code
should be changed to use
writeEPS and and
writeSVG respectively. These three functions no longer take a
TextEncoder argument as TextEncoders no longer exist.
The Font Size API has also changed substantially. It now exports a more consistent set of metrics (consistent with what is present in font files - the previous version was derived from hand measurements). It also adds a margin to bounding box calculations, again this is more consistent with how font files actually work.
The handling of escaped special characters is now more
consistent and the escaping mecahnism has been clarified
(previously the documentation and the implementation were at
odds): PostScript glyph names are delimited between
; (semi), Unicode code points are delimited
&# (ampersand-hash) and
; (semi). Note Wumpus silently
drops mal-formed escape charcters, for robustness this is
preferable to throwing a runtime error, but it does mean the
output needs visually checking.
v0.40.0 to v0.41.0:
Changed PostScript output to use pre-defined procedures for circles and ellipses. This should be a significant optimization for drawings that have many circles or ellipses. For drawings that do not use circles or ellipses, it adds circa. 75 lines to the generated PostScript which is tolerable.
API change -
Core.Text.Baseno longer exports the constructor and field label for
EscapedText, it is now an opaque type. For a building
EscapedTexteither the existing safeconstructor
escapeStringor the new function
wrapEscCharshould be used. For destructing
EscapedTextthere is a new function
API change - the argument order of the functions
Core.Picturehas changed. The order of angle of rotation and the baseline-left has been swapped so that angle of rotation is first. This matches the other rotated graphics in
Upper bounds of Cabal build depends relaxed a bit.
Core.Geometryand added affine instances for the UNil type, plus Maybe and Pair.
UNilis useful for higher-level drawing (it is used extensively in Wumpus-Basic).
Added the function
Core.Picture. This creates a null path with an empty list of path segments. Null paths still need a start point - this is minimum needed for bounding box calculation. Improved the PostScript and SVG output so there is no code generated for empty paths and textlabels.
Improved generated SVG code generation for ellipses / circles.
v0.37.0 to v0.40.0:
Text handling substantially revised. SVG text output is now better aligned to Unicode. The encoding tables for PostScript have been re-thought, the previous implementation had some serious design flaws that should now be rectified.
The rules for escaping special characters has been clarified. Previously the documentation suggested
ampersand-name-semicoloncould be used to escape glyph names however only
ampersand-name-semicolonis now the correct way. The ampersand-hash prefix is for numeric literals -
Versions of the textlabel functions have been added to
Core.Picturefor escape-parsed text. It is useful for higher-level software to escape the text, do some calculations then render it - going back to un-escaped text for the rendering would be inefficient.
The internal representation of paths has changed. They are now represented as start-point plus list of relative path segments rather than start-point plus list of absolute path segments. Using relative path segments makes it cheaper to move paths with
translate, although calculating the bounding box and rendering to PostScript is more expensive. The rationale for the change is that to make complex pictures, paths are potentially moved many times but the other operations are only performed once.
Internal change to Primitives and the PrimCTM - ellipses and labels no longer have a point (center or baseline left) as an element in the datatype, the point is now represented within the PrimCTM.
Name change to
Core.PictureAPI - the path construction function
pathhas been renamed to
Name change in
Core.FontSize, the function
textBoundsEnchas been renamed to
textBoundsEsc. Wumpus-Core now calls strings that have been parsed for escape characters Escaped Text rather than Encoded Text.
Fixed bug where ellipse rotation and scaling calculated the wrong bounding box.
Fixed bug in
illustrateControlPointswhere the control points were drawn but the original primitive was lost.
Added initial support for arbitrary SVG attributes (e.g. onmouseover handlers) via
Core.Picture. Arbitrary SVG "defs" can be written into the defs prologue by using
writeSVG. This functionality is mostly untested!
|Versions||0.12.0, 0.13.0, 0.13.1, 0.14.0, 0.15.0, 0.16.0, 0.17.0, 0.18.0, 0.19.0, 0.20.0, 0.21.0, 0.22.0, 0.23.0, 0.30.0, 0.31.0, 0.32.0, 0.33.0, 0.34.0, 0.35.0, 0.36.0, 0.37.0, 0.40.0, 0.41.0, 0.42.0, 0.42.1, 0.43.0, 0.50.0, 0.51.0, 0.52.0, 0.52.1|
|Dependencies||base (<4.5), containers (>=0.3 && <=0.6), time (>=1.1.3 && <1.6), vector-space (>=0.6 && <1.0) [details]|
|Copyright||Stephen Tetley <email@example.com>|
|Maintainer||Stephen Tetley <firstname.lastname@example.org>|
|Uploaded||Tue Dec 28 13:59:44 UTC 2010 by StephenTetley|
|Updated||Sat Nov 7 11:46:14 UTC 2015 by HerbertValerioRiedel to revision 1|
|Downloads||5609 total (59 in the last 30 days)|
|Rating||0.0 (0 ratings) [clear rating]|
|Status||Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI
For package maintainers and hackage trustees