1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#!/usr/bin/ruby 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver# encoding: utf-8 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver=begin LICENSE 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver[The "BSD licence"] 7324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverCopyright (c) 2009-2010 Kyle Yetter 8324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverAll rights reserved. 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 10324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverRedistribution and use in source and binary forms, with or without 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermodification, are permitted provided that the following conditions 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverare met: 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1. Redistributions of source code must retain the above copyright 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer. 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 2. Redistributions in binary form must reproduce the above copyright 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer in the 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver documentation and/or other materials provided with the distribution. 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 3. The name of the author may not be used to endorse or promote products 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver derived from this software without specific prior written permission. 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 22324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverTHIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverIMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverOF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverIN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverINCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverTHIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver=end 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverrequire 'antlr3' 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverrequire 'erb' 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermodule ANTLR3 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver=begin rdoc ANTLR3::DOT 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 42324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverAn extra utility for generating graphviz DOT file representations of ANTLR 43324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverAbstract Syntax Tree nodes. 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 45324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverThis module has been directly ported to Ruby from the ANTLR Python runtime 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverlibrary. 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver=end 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermodule DOT 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver class Context 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def []=( var, value ) 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver instance_variable_set( :"@#{ var }", value ) 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def []( var ) 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver instance_variable_get( :"@#{ var }" ) 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def initialize( template, vars = {} ) 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @__template__ = template 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver vars.each do |var, value| 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver self[ var ] = value 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def to_s 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @__template__.result( binding ) 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver class TreeGenerator 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver TREE_TEMPLATE = ERB.new( Util.tidy( <<-END ) ) 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | digraph { 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | ordering=out; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | ranksep=.4; 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | node [shape=plaintext, fixedsize=true, fontsize=11, fontname="Courier", 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | width=.25, height=.25]; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | edge [arrowsize=.5]; 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | <%= @nodes.join("\n ") %> 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | <%= @edges.join("\n ") %> 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | } 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver END 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NODE_TEMPLATE = ERB.new( Util.tidy( <<-END ) ) 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | <%= @name %> [label="<%= @text %>"]; 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver END 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver EDGE_TEMPLATE = ERB.new( Util.tidy( <<-END ) ) 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver | <%= @parent %> -> <%= @child %>; // "<%= @parent_text %>" -> "<%= @child_text %>" 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver END 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def self.generate( tree, adaptor = nil, tree_template = TREE_TEMPLATE, 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver edge_template = EDGE_TEMPLATE ) 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver new.to_dot( tree, adaptor, tree_template, edge_template ) 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def initialize 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @node_number = 0 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @node_to_number_map = Hash.new do |map, node| 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver map[ node ] = @node_number 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @node_number += 1 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @node_number - 1 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def to_dot( tree, adaptor = nil, tree_template = TREE_TEMPLATE, 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver edge_template = EDGE_TEMPLATE ) 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver adaptor ||= AST::CommonTreeAdaptor.new 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @node_number = 0 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver tree_template = Context.new( tree_template, :nodes => [], :edges => [] ) 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver define_nodes( tree, adaptor, tree_template ) 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @node_number = 0 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver define_edges( tree, adaptor, tree_template, edge_template ) 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return tree_template.to_s 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def define_nodes( tree, adaptor, tree_template, known_nodes = nil ) 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver known_nodes ||= Set.new 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver tree.nil? and return 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver n = adaptor.child_count( tree ) 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver n == 0 and return 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver number = node_number( tree ) 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver unless known_nodes.include?( number ) 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver parent_node_template = node_template_for( adaptor, child ) 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver tree_template[ :nodes ] << parent_node_template 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver known_nodes.add( number ) 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver n.times do |index| 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver child = adaptor.child_of( tree, index ) 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver number = @node_to_number_map[ child ] 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver unless known_nodes.include?( number ) 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver node_template = node_template_for( adaptor, child ) 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver tree_template[ :nodes ] << node_template 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver known_nodes.add( number ) 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver define_nodes( child, adaptor, tree_template, edge_template ) 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def define_edges( tree, adaptor, tree_template, edge_template ) 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver tree.nil? or return 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver n = adaptor.child_count( tree ) 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver n == 0 and return 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver parent_name = 'n%i' % @node_to_number_map[ tree ] 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver parent_text = adaptor.text_of( tree ) 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver n.times do |index| 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver child = adaptor.child_of( tree, index ) 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver child_text = adaptor.text_of( child ) 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver child_name = 'n%i' % @node_to_number_map[ tree ] 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver edge_template = Context.new( edge_template, 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :parent => parent_name, :child => child_name, 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :parent_text => parent_text, :child_text => child_text 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ) 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver tree_template[ :edges ] << edge_template 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver define_edges( child, adaptor, tree_template, edge_template ) 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def node_template_for( adaptor, tree ) 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver text = adaptor.text_of( tree ) 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver node_template = Context.new( NODE_TEMPLATE ) 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver unique_name = 'n%i' % @node_to_number_map[ tree ] 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver node_template[ :name ] = unique_name 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver text and text = text.gsub( /"/, '\\"' ) 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver node_template[ :text ] = text 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return node_template 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverend 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverend 175