vacuum-graphviz (empty) → 2.0.0.0
raw patch · 4 files changed
+282/−0 lines, 4 filesdep +basedep +filepathdep +graphvizsetup-changed
Dependencies added: base, filepath, graphviz, vacuum
Files
- LICENSE.txt +165/−0
- Setup.hs +2/−0
- src/GHC/Vacuum/GraphViz.hs +92/−0
- vacuum-graphviz.cabal +23/−0
+ LICENSE.txt view
@@ -0,0 +1,165 @@+ GNU LESSER GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.+++ This version of the GNU Lesser General Public License incorporates+the terms and conditions of version 3 of the GNU General Public+License, supplemented by the additional permissions listed below.++ 0. Additional Definitions. ++ As used herein, "this License" refers to version 3 of the GNU Lesser+General Public License, and the "GNU GPL" refers to version 3 of the GNU+General Public License.++ "The Library" refers to a covered work governed by this License,+other than an Application or a Combined Work as defined below.++ An "Application" is any work that makes use of an interface provided+by the Library, but which is not otherwise based on the Library.+Defining a subclass of a class defined by the Library is deemed a mode+of using an interface provided by the Library.++ A "Combined Work" is a work produced by combining or linking an+Application with the Library. The particular version of the Library+with which the Combined Work was made is also called the "Linked+Version".++ The "Minimal Corresponding Source" for a Combined Work means the+Corresponding Source for the Combined Work, excluding any source code+for portions of the Combined Work that, considered in isolation, are+based on the Application, and not on the Linked Version.++ The "Corresponding Application Code" for a Combined Work means the+object code and/or source code for the Application, including any data+and utility programs needed for reproducing the Combined Work from the+Application, but excluding the System Libraries of the Combined Work.++ 1. Exception to Section 3 of the GNU GPL.++ You may convey a covered work under sections 3 and 4 of this License+without being bound by section 3 of the GNU GPL.++ 2. Conveying Modified Versions.++ If you modify a copy of the Library, and, in your modifications, a+facility refers to a function or data to be supplied by an Application+that uses the facility (other than as an argument passed when the+facility is invoked), then you may convey a copy of the modified+version:++ a) under this License, provided that you make a good faith effort to+ ensure that, in the event an Application does not supply the+ function or data, the facility still operates, and performs+ whatever part of its purpose remains meaningful, or++ b) under the GNU GPL, with none of the additional permissions of+ this License applicable to that copy.++ 3. Object Code Incorporating Material from Library Header Files.++ The object code form of an Application may incorporate material from+a header file that is part of the Library. You may convey such object+code under terms of your choice, provided that, if the incorporated+material is not limited to numerical parameters, data structure+layouts and accessors, or small macros, inline functions and templates+(ten or fewer lines in length), you do both of the following:++ a) Give prominent notice with each copy of the object code that the+ Library is used in it and that the Library and its use are+ covered by this License.++ b) Accompany the object code with a copy of the GNU GPL and this license+ document.++ 4. Combined Works.++ You may convey a Combined Work under terms of your choice that,+taken together, effectively do not restrict modification of the+portions of the Library contained in the Combined Work and reverse+engineering for debugging such modifications, if you also do each of+the following:++ a) Give prominent notice with each copy of the Combined Work that+ the Library is used in it and that the Library and its use are+ covered by this License.++ b) Accompany the Combined Work with a copy of the GNU GPL and this license+ document.++ c) For a Combined Work that displays copyright notices during+ execution, include the copyright notice for the Library among+ these notices, as well as a reference directing the user to the+ copies of the GNU GPL and this license document.++ d) Do one of the following:++ 0) Convey the Minimal Corresponding Source under the terms of this+ License, and the Corresponding Application Code in a form+ suitable for, and under terms that permit, the user to+ recombine or relink the Application with a modified version of+ the Linked Version to produce a modified Combined Work, in the+ manner specified by section 6 of the GNU GPL for conveying+ Corresponding Source.++ 1) Use a suitable shared library mechanism for linking with the+ Library. A suitable mechanism is one that (a) uses at run time+ a copy of the Library already present on the user's computer+ system, and (b) will operate properly with a modified version+ of the Library that is interface-compatible with the Linked+ Version. ++ e) Provide Installation Information, but only if you would otherwise+ be required to provide such information under section 6 of the+ GNU GPL, and only to the extent that such information is+ necessary to install and execute a modified version of the+ Combined Work produced by recombining or relinking the+ Application with a modified version of the Linked Version. (If+ you use option 4d0, the Installation Information must accompany+ the Minimal Corresponding Source and Corresponding Application+ Code. If you use option 4d1, you must provide the Installation+ Information in the manner specified by section 6 of the GNU GPL+ for conveying Corresponding Source.)++ 5. Combined Libraries.++ You may place library facilities that are a work based on the+Library side by side in a single library together with other library+facilities that are not Applications and are not covered by this+License, and convey such a combined library under terms of your+choice, if you do both of the following:++ a) Accompany the combined library with a copy of the same work based+ on the Library, uncombined with any other library facilities,+ conveyed under the terms of this License.++ b) Give prominent notice with the combined library that part of it+ is a work based on the Library, and explaining where to find the+ accompanying uncombined form of the same work.++ 6. Revised Versions of the GNU Lesser General Public License.++ The Free Software Foundation may publish revised and/or new versions+of the GNU Lesser General Public License from time to time. Such new+versions will be similar in spirit to the present version, but may+differ in detail to address new problems or concerns.++ Each version is given a distinguishing version number. If the+Library as you received it specifies that a certain numbered version+of the GNU Lesser General Public License "or any later version"+applies to it, you have the option of following the terms and+conditions either of that published version or of any later version+published by the Free Software Foundation. If the Library as you+received it does not specify a version number of the GNU Lesser+General Public License, you may choose any version of the GNU Lesser+General Public License ever published by the Free Software Foundation.++ If the Library as you received it specifies that a proxy can decide+whether future versions of the GNU Lesser General Public License shall+apply, that proxy's public statement of acceptance of any version is+permanent authorization for you to choose that version for the+Library.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ src/GHC/Vacuum/GraphViz.hs view
@@ -0,0 +1,92 @@+{-# LANGUAGE OverloadedStrings #-}+-- |+-- Module : GHC.Vacuum.GraphViz+-- Copyright : (c) Austin Seipp 2012, Ivan Lazar Miljenovic 2011+-- License : LGPLv3+-- +-- Maintainer : mad.one@gmail.com+-- Stability : experimental+-- Portability : non-portable (GHC only)+-- +-- This module exports a simple, high level interface for exporting+-- @vacuum@ graphs to GraphViz @dot@ output, and rendering them to+-- PNG/SVG files. It also contains various helpers if you wish to+-- customize the output yourself in some manner.+-- +-- For this module to work, you will need to have graphviz installed,+-- and the 'dot' utility should be available somewhere in your+-- @$PATH@.+-- +-- The simplest possible usage of this module is like so:+-- +-- > vacuumToPng "list" [1..10]+-- +-- This will output a \'list.png\' file, which contains a pretty graph+-- visualization of the expression @[1..10]@. You may alternatively+-- use 'vacuumToSvg' in the same manner, to export a graph to an SVG+-- file. This is more than sufficient for many use cases.+-- +module GHC.Vacuum.GraphViz+ ( -- * Simple API+ vacuumToPng -- :: FilePath -> a -> IO FilePath+ , vacuumToSvg -- :: FilePath -> a -> IO FilePath+ + -- * Lower level API allowing more output control+ , graphToDotFile+ , graphToDot+ , graphToDotParams+ + -- * GraphViz attributes+ , vacuumParams+ ) where++import Data.GraphViz hiding (graphToDot)+import Data.GraphViz.Attributes.Complete( Attribute(RankDir, Splines, FontName)+ , RankDir(FromLeft), EdgeType(SplineEdges))+import Control.Arrow(second)++import GHC.Vacuum++------------------------------------------------++-- | @vacuumToPng "foo" e@ renders a graph representation of the+-- expression @e@ (which can be any expression what-so-ever) to+-- the file \"foo.png\" for later viewing.+vacuumToPng :: FilePath -> a -> IO FilePath+vacuumToPng fp a = graphToDotFile fp Png $ nameGraph (vacuum a)++-- | @vacuumToSvg "foo" e@ renders a graph representation of the+-- expression @e@ (which can be any expression what-so-ever) to+-- the file \"foo.svg\" for later viewing.+vacuumToSvg :: FilePath -> a -> IO FilePath+vacuumToSvg fp a = graphToDotFile fp Svg $ nameGraph (vacuum a)+++------------------------------------------------++graphToDotFile :: (Ord a, PrintDot a) => FilePath -> GraphvizOutput -> [(a, [a])] -> IO FilePath+graphToDotFile fpre outTy g = Data.GraphViz.addExtension (runGraphviz (graphToDot g)) outTy fpre++graphToDot :: (Ord a) => [(a, [a])] -> DotGraph a+graphToDot = graphToDotParams vacuumParams++graphToDotParams :: (Ord a, Ord cl) => GraphvizParams a () () cl l -> [(a, [a])] -> DotGraph a+graphToDotParams params nes = graphElemsToDot params ns es+ where+ ns = map (second $ const ()) nes++ es = concatMap mkEs nes+ mkEs (f,ts) = map (\t -> (f,t,())) ts++------------------------------------------------++vacuumParams :: GraphvizParams a () () () ()+vacuumParams = defaultParams { globalAttributes = gStyle }++gStyle :: [GlobalAttributes]+gStyle = [ GraphAttrs [RankDir FromLeft, Splines SplineEdges, FontName "courier"]+ , NodeAttrs [textLabel "\\N", shape PlainText, fontColor Blue]+ , EdgeAttrs [color Black, style dotted]+ ]++------------------------------------------------
+ vacuum-graphviz.cabal view
@@ -0,0 +1,23 @@+name: vacuum-graphviz+version: 2.0.0.0+synopsis: A library for transforming vacuum graphs into GraphViz output+description:+ A library for transforming @vacuum@ graphs into GraphViz output+license: LGPL-3+license-file: LICENSE.txt+copyright: Copyright (c) Ivan Miljenovic 2011, Austin Seipp 2012+author: Ivan Miljenovic+maintainer: Austin Seipp <mad.one@gmail.com>+category: Debug, GHC+build-type: Simple+cabal-version: >=1.6++library+ hs-source-dirs: src+ build-depends: base > 3 && < 5,+ filepath > 1 && < 2,+ vacuum == 2.0.0.0,+ graphviz == 2999.13.*++ exposed-modules: GHC.Vacuum.GraphViz+ ghc-options: -Wall -O2 -fwarn-tabs