Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the s-dot2 Reference Manual, version 1.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 05:47:54 2022 GMT+0.
Next: Systems, Previous: The s-dot2 Reference Manual, Up: The s-dot2 Reference Manual [Contents][Index]
* Notes on this version *I am not the original author of this library, Martin Loetzsch (http://www.martin-loetzsch.de/S-DOT) is.* This version (marked as 1.3) of the library is a patched version of the original one[fn:origin-website] made to use some new uiop features, sb-ext:run-program if available and to pass its own tests (I was unable to make them pass them on my system). Important note: I have switched from symbols to keywords for the DSL (i.e s-dot::'node -> :node). * BUGS Please file bug report on the [[https://notabug.org/cage/s-dot2/issues][issue tracker]]. * License A Common Lisp language binding for the graphviz 'dot' tool. See http://www.martin-loetzsch.de/S-DOT for details Copyright (c) 2006-2010 Martin Loetzsch. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The end-user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes S-DOT developed by Martin Loetzsch (http://www.martin-loetzsch.de/S-DOT)." Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments normally appear. THIS SOFTWARE IS PROVIDED BY MARTIN LOETZSCH ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MARTIN LOETZSCH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. [fn:origin-website] [[http://martin-loetzsch.de/S-DOT/][http://martin-loetzsch.de/S-DOT/]]
Next: Files, Previous: Introduction, Up: The s-dot2 Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Render Graphviz graphs from within Lisp
Martin Loetzsch, cage
BSD-style
See http://martin-loetzsch.de/S-DOT/
1.3.0
uiop (system).
s-dot2.lisp (file).
Next: Packages, Previous: Systems, Up: The s-dot2 Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: s-dot2/s-dot2.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
s-dot2 (system).
Previous: s-dot2/s-dot2.asd, Up: Lisp [Contents][Index]
s-dot2 (system).
Next: Definitions, Previous: Files, Up: The s-dot2 Reference Manual [Contents][Index]
Packages are listed by definition order.
See http://martin-loetzsch.de/S-DOT
Next: Indexes, Previous: Packages, Up: The s-dot2 Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
the path (or name) name of the dot executable
Previous: Special variables, Up: Public Interface [Contents][Index]
Checks whether the s-expression ’graph’ is syntactically correct. Note that it does not check whether the attributes contain useful values.
Renders a s-dot graph into a graphic file. ’file-name’ should be a pathname.
If the file-name is /foo/bar.png, the dot file /foo/bar.dot is created
and then rendered. Format should be one out of
http://www.graphviz.org/doc/info/output.html, for example svg, ps,
gif, png, or jpg. The uiop:run-program is used to launch dot. If that
does not work for you, write a similar function that uses (s-dot->dot)
for dot generation and then runs dot on it.
SBCL users may take advantage of sb-ext:run-program, opening a pipe to ’dot’ instead of writing a file and reading that in again.
Generates dot syntax from a s-dot expression and writes the result to ’stream’.
This code looks indeed ugly. If you really want to understand what’s going on, then it might
be easier to look in the the XSLT stylesheet at
http://www.martin-loetzsch.de/DOTML/dotml-1.3/dotml2dot.xsl . This code does exactly the same.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
the command line option for dot needed to specify the output format
Previous: Definitions, Up: The s-dot2 Reference Manual [Contents][Index]
| Jump to: | C E F R S T |
|---|
| Jump to: | C E F R S T |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | F P S |
|---|
| Jump to: | F P S |
|---|