File: edge.rb

package info (click to toggle)
ruby-graphviz 1.0.8-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,124 kB
  • ctags: 695
  • sloc: ruby: 7,656; xml: 26; makefile: 17
file content (197 lines) | stat: -rw-r--r-- 6,470 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
# Copyright (C) 2004 - 2012 Gregoire Lejeune <gregoire.lejeune@free.fr>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA

require 'graphviz/attrs'
require 'graphviz/constants'

class GraphViz
   class Edge
      include Constants

      # Create a new edge
      #
      # In:
      # * vNodeOne : First node (can be a GraphViz::Node or a node ID)
      # * vNodeTwo : Second node (can be a GraphViz::Node or a node ID)
      # * parent_graph : Graph
      def initialize( vNodeOne, vNodeTwo, parent_graph )
         @node_one_id, @node_one_port = getNodeNameAndPort( vNodeOne )
         @node_two_id, @node_two_port = getNodeNameAndPort( vNodeTwo )

         @parent_graph = parent_graph
         @edge_attributes = GraphViz::Attrs::new( nil, "edge", EDGESATTRS )
         @index = nil

         unless @parent_graph.directed?
            (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id)).incidents << (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id))
            (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id)).neighbors << (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id))
         end
         (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id)).neighbors << (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id))
         (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id)).incidents << (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id))
      end

      # Return the node one as string (so with port if any)
      def node_one( with_port = true )
         if not (@node_one_port and with_port)
            GraphViz.escape(@node_one_id)
         else
            GraphViz.escape(@node_one_id, :force => true) + ":#{@node_one_port}"
         end
      end
      alias :tail_node :node_one

      # Return the node two as string (so with port if any)
      def node_two( with_port = true )
         if not (@node_two_port and with_port)
            GraphViz.escape(@node_two_id)
         else
            GraphViz.escape(@node_two_id, :force => true) + ":#{@node_two_port}"
         end
      end
      alias :head_node :node_two

      # Return the index of the edge
      def index
         @index
      end
      def index=(i) #:nodoc:
         @index = i if @index == nil
      end

      # Set value +attribute_value+ to the edge attribute +attribute_name+
      def []=( attribute_name, attribute_value )
         attribute_value = attribute_value.to_s if attribute_value.class == Symbol
         @edge_attributes[attribute_name.to_s] = attribute_value
      end

      # Set values for edge attributes or
      # get the value of the given edge attribute +attribute_name+
      def []( attribute_name )
         # Modification by axgle (http://github.com/axgle)
         if Hash === attribute_name
            attribute_name.each do |key, value|
               self[key] = value
            end
         else
            if @edge_attributes[attribute_name.to_s]
               @edge_attributes[attribute_name.to_s].clone
            else
               nil
            end
         end
      end

      #
      # Calls block once for each attribute of the edge, passing the name and value to the
      # block as a two-element array.
      #
      # If global is set to false, the block does not receive the attributes set globally
      #
      def each_attribute(global = true, &b)
         attrs = @edge_attributes.to_h
         if global
            attrs = pg.edge.to_h.merge attrs
         end
         attrs.each do |k,v|
            yield(k,v)
         end
      end
      def each_attribut(global = true, &b)
         warn "`GraphViz::Edge#each_attribut` is deprecated, please use `GraphViz::Edge#each_attribute`"
         each_attribute(global, &b)
      end

      def <<( node ) #:nodoc:
         n = @parent_graph.get_node(@node_two_id)

         GraphViz::commonGraph( node, n ).add_edges( n, node )
      end
      alias :> :<< #:nodoc:
      alias :- :<< #:nodoc:
      alias :>> :<< #:nodoc:

      #
      # Return the root graph
      #
      def root_graph
         return( (self.pg.nil?) ? nil : self.pg.root_graph )
      end

      def pg #:nodoc:
         @parent_graph
      end

      # Set edge attributes
      #
      # Example :
      #   e = graph.add_edges( ... )
      #   ...
      #   e.set { |_e|
      #     _e.color = "blue"
      #     _e.fontcolor = "red"
      #   }
      def set( &b )
         yield( self )
      end

      # Add edge options
      # use edge.<option>=<value> or edge.<option>( <value> )
      def method_missing( idName, *args, &block ) #:nodoc:
         return if idName == :to_ary # ruby 1.9.2 fix
         xName = idName.id2name

         self[xName.gsub( /=$/, "" )]=args[0]
      end

      def output( oGraphType ) #:nodoc:
         xLink = " -> "
         if oGraphType == "graph"
            xLink = " -- "
         end

         xOut = self.node_one + xLink + self.node_two
         xAttr = ""
         xSeparator = ""
         @edge_attributes.data.each do |k, v|
            xAttr << xSeparator + k + " = " + v.to_gv
            xSeparator = ", "
         end
         if xAttr.length > 0
            xOut << " [" + xAttr + "]"
         end
         xOut + ";"

         return( xOut )
      end

      private
      def getNodeNameAndPort( node )
         name, port = nil, nil
         if node.class == Hash
            node.each do |k, v|
               name, port = getNodeNameAndPort(k)
               port = v
            end
         elsif node.class == String
            name = node
         else
            name = node.id
         end

         return name, port
      end
   end
end