Class: GraphViz

Inherits:
Object show all
Includes:
Constants, Utils
Defined in:
lib/graphviz/constants.rb,
lib/graphviz.rb,
lib/graphviz/ext.rb,
lib/graphviz/xml.rb,
lib/graphviz/edge.rb,
lib/graphviz/node.rb,
lib/graphviz/attrs.rb,
lib/graphviz/types.rb,
lib/graphviz/utils.rb,
lib/graphviz/theory.rb,
lib/graphviz/graphml.rb,
lib/graphviz/elements.rb,
lib/graphviz/nothugly.rb,
lib/graphviz/dot_script.rb,
lib/graphviz/types/rect.rb,
lib/graphviz/family_tree.rb,
lib/graphviz/math/matrix.rb,
lib/graphviz/types/color.rb,
lib/graphviz/utils/colors.rb,
lib/graphviz/types/gv_bool.rb,
lib/graphviz/types/gv_double.rb,
lib/graphviz/types/arrow_type.rb,
lib/graphviz/types/color_list.rb,
lib/graphviz/types/esc_string.rb,
lib/graphviz/types/lbl_string.rb,
lib/graphviz/types/html_string.rb,
lib/graphviz/types/spline_type.rb,
lib/graphviz/family_tree/couple.rb,
lib/graphviz/family_tree/person.rb,
lib/graphviz/family_tree/sibling.rb,
lib/graphviz/family_tree/generation.rb

Overview

spliteType or point

spline ( ‘;’ spline )* where spline = (endp)? (startp)? point (triple)+ and triple = point point point and endp = “e,%f,%f” and startp = “s,%f,%f”

If a spline has points p1 p2 p3 … pn, (n = 1 (mod 3)), the points correspond to the control points of a B-spline from p1 to pn. If startp is given, it touches one node of the edge, and the arrowhead goes from p1 to startp. If startp is not given, p1 touches a node. Similarly for pn and endp.

Defined Under Namespace

Modules: Constants, Utils Classes: Attrs, DOTScript, DOTScriptData, DSL, Edge, Elements, Ext, FamilyTree, GraphML, GraphMLError, Math, Node, Theory, Types, XML

Constant Summary collapse

@@format =

Var: Output format (dot, png, jpeg, …)

nil
@@prog =

Var: program to use (dot|twopi)

"dot"
@@path =

Var: program path

[]
@@errors =

Var: Error level

1
@@extlibs =

Var: External libraries

[]

Constants included from Constants

Constants::EDGESATTRS, Constants::FORMATS, Constants::GENCS_ATTRS, Constants::GRAPHSATTRS, Constants::GRAPHTYPE, Constants::NODESATTRS, Constants::PROGRAMS, Constants::RGV_VERSION

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils

#find_executable, #output_and_errors_from_command, #output_from_command

Methods included from Constants

getAttrsFor

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(idName, *args, &block) ⇒ Object

:nodoc:



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/graphviz.rb', line 357

def method_missing( idName, *args, &block ) #:nodoc:
  xName = idName.id2name

  rCod = nil

  if block
    # Creating a cluster named '#{xName}'
    rCod = add_graph( xName, args[0]||{} )
    yield( rCod )
  else
    # Create a node named '#{xName}' or search for a node, edge or cluster
    if @hoNodes.keys.include?( xName )
      if( args[0] )
        return { xName => args[0] }
      else
        return( @hoNodes[xName] )
      end
    end
    return( @hoGraphs[xName] ) if @hoGraphs.keys.include?( xName )

    rCod = add_nodes( xName, args[0]||{} )
  end

  return rCod
end

Instance Attribute Details

#edge ⇒ Object Also known as: edge_attrs

This accessor allow you to set global edges attributes



79
80
81
 
# File 'lib/graphviz.rb', line 79

def edge
  @edge
end

#graph ⇒ Object

This accessor allow you to set global graph attributes



71
72
73
 
# File 'lib/graphviz.rb', line 71

def graph
  @graph
end

#node ⇒ Object Also known as: node_attrs

This accessor allow you to set global nodes attributes



75
76
77
 
# File 'lib/graphviz.rb', line 75

def node
  @node
end

Class Method Details

.commonGraph(o1, o2) ⇒ Object

:nodoc:



699
700
701
702
703
704
705
706
707
708
709
 
# File 'lib/graphviz.rb', line 699

def self.commonGraph( o1, o2 ) #:nodoc:
  g1 = o1.pg
  g2 = o2.pg

  return o1 if g1.nil?
  return o2 if g2.nil?

  return g1 if g1.object_id == g2.object_id

  return GraphViz::commonGraph( g1, g2 )
end

.default(hOpts) ⇒ Object

Change default options (:use, :path, :errors and :output)



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
 
# File 'lib/graphviz.rb', line 724

def self.default( hOpts )
  hOpts.each do |k, v|
    case k.to_s
      when "use"
        @@prog = v
      when "path"
        @@path = v.split( "," ).map{ |x| x.strip }
      when "errors"
        @@errors = v
      when "extlibs"
        @@extlibs = v.split( "," ).map{ |x| x.strip }
      else
        warn "Invalid option #{k}!"
    end
  end
end

.libxslt_transform(xml, xsl) ⇒ Object 



54
55
56
57
58
59
60
61
62
 
# File 'lib/graphviz/nothugly.rb', line 54

def self.libxslt_transform(xml, xsl)
   LibXML::XML.default_load_external_dtd = false
   LibXML::XML.default_substitute_entities = false

   stylesheet_doc = LibXML::XML::Document.file(xsl)
   stylesheet = LibXSLT::XSLT::Stylesheet.new(stylesheet_doc)
   xml_doc = LibXML::XML::Document.file(xml)
   stylesheet.apply(xml_doc).to_s
end

.nothugly(file, save = true) ⇒ Object

Transform to pretty up the SVG output

For more information, see hokstad.com/making-graphviz-output-pretty-with-xsl and hokstad.com/making-graphviz-output-pretty-with-xsl-updated

You can use the :nothugly option to GraphViz#output :

graph.output( :svg => "myGraph.svg", :nothugly => true )

Or directly on an SVG output graph :

GraphViz.nothugly( "myGraph.svg" )



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/graphviz/nothugly.rb', line 33

def self.nothugly( file, save = true )
  xsl = File.join( File.dirname(File.expand_path(__FILE__)), "nothugly", "nothugly.xsl" )
  out = self.send(XSLT_METHOD, file, xsl)

  if save
    fname = File.join( File.dirname(File.expand_path(file)), File.basename(file))
    File.open( fname, "w" ) { |io|
      io.print out
    }
  else
    return out
  end
end

.options(hOpts) ⇒ Object 



741
742
743
 
# File 'lib/graphviz.rb', line 741

def self.options( hOpts )
  GraphViz::default( hOpts )
end

.parse(xFile, hOpts = {}) {|graph| ... } ⇒ Object

Create a new graph from a GraphViz File

Options :

  • :output : Output format (GraphViz::Constants::FORMATS) (default : dot)

  • :file : Output file name (default : none)

  • :use : Program to use (GraphViz::Constants::PROGRAMS) (default : dot)

  • :path : Program PATH

Yields:

  • (graph) 


755
756
757
758
759
 
# File 'lib/graphviz.rb', line 755

def self.parse( xFile, hOpts = {}, &block )
  graph = Dot2Ruby::new( hOpts[:path], nil, nil ).eval( xFile )
  yield( graph ) if( block and graph )
  return graph
end

.parse_string(str, hOpts = {}) {|graph| ... } ⇒ Object

Create a new graph from a GraphViz File

Options :

  • :output : Output format (GraphViz::Constants::FORMATS) (default : dot)

  • :file : Output file name (default : none)

  • :use : Program to use (GraphViz::Constants::PROGRAMS) (default : dot)

  • :path : Program PATH

Yields:

  • (graph) 


769
770
771
772
773
 
# File 'lib/graphviz.rb', line 769

def self.parse_string( str, hOpts = {}, &block )
  graph = Dot2Ruby::new(hOpts[:path], nil, nil).eval_string(str)
  yield(graph) if(block and graph)
  return graph
end

.xml_xslt_transform(xml, xsl) ⇒ Object 



47
48
49
50
51
52
 
# File 'lib/graphviz/nothugly.rb', line 47

def self.xml_xslt_transform(xml, xsl)
  xslt = XML::XSLT.new()
  xslt.xml = xml
  xslt.xsl = xsl
  xslt.serve()
end

Instance Method Details

#<<(oNode) ⇒ Object Also known as: >, -, >>

Create an edge between the current cluster and the node or cluster oNode

Raises:

  • (ArgumentError) 


670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/graphviz.rb', line 670

def <<( oNode )
  raise( ArgumentError, "Edge between root graph and node or cluster not allowed!" ) if self.pg.nil?

  if( oNode.class == Array )
    oNode.each do |no|
      self << no
    end
  else
    return GraphViz::commonGraph( oNode, self ).add_edges( self, oNode )
  end
end

#[](xAttrName) ⇒ Object

Get the value of the graph attribute xAttrName



394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/graphviz.rb', line 394

def []( xAttrName )
  if Hash === xAttrName
    xAttrName.each do |key, value|
      self[key] = value
    end
  else
    attr = @graph[xAttrName]
    if attr.nil?
      return nil
    else
      return( @graph[xAttrName].clone )
    end
  end
end

#[]=(xAttrName, xValue) ⇒ Object

Set value xValue to the graph attribute xAttrName



386
387
388
389
 
# File 'lib/graphviz.rb', line 386

def []=( xAttrName, xValue )
  xValue = xValue.to_s if xValue.class == Symbol
  @graph[xAttrName] = xValue
end

#add(h) ⇒ Object

Add nodes and edges defined by a Hash



332
333
334
335
336
337
338
 
# File 'lib/graphviz.rb', line 332

def add(h)
  if h.kind_of? Hash
    h.each do |node, data|
      add_hash_edge(node, data)
    end
  end
end

#add_edge(oNodeOne, oNodeTwo, hOpts = {}) ⇒ Object 



191
192
193
194
195
196
 
# File 'lib/graphviz.rb', line 191

def add_edge( oNodeOne, oNodeTwo, hOpts = {} )
  if oNodeTwo.kind_of? Array or oNodeOne.kind_of? Array 
    raise ArgumentError, "use `add_edges' to add several edges at the same time"
  end
  add_edges(oNodeOne, oNodeTwo, hOpts)
end

#add_edges(node_one, node_two, options = {}) ⇒ Object

Create a new edge

In:

  • node_one : First node (or node list)

  • node_two : Second Node (or node list)

  • options : Edge attributes



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/graphviz.rb', line 204

def add_edges( node_one, node_two, options = {} )

  if( node_one.class == Array )
    node_one.each do |no|
      add_edges( no, node_two, options )
    end
  else
    if( node_two.class == Array )
      node_two.each do |nt|
        add_edges( node_one, nt, options )
      end
    else
      edge = GraphViz::Edge::new( node_one, node_two, self )
      edge.index = @elements_order.size_of( "edge" )

      options.each do |xKey, xValue|
        edge[xKey.to_s] = xValue
      end

      @elements_order.push( {
        "type" => "edge",
        "value" => edge
      } )
      @loEdges.push( edge )

      return( edge )
    end
  end
end

#add_graph(xGraphName = nil, hOpts = {}, &block) ⇒ Object Also known as: subgraph

Create a new graph

In:

  • xGraphName : Graph name

  • hOpts : Graph attributes



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/graphviz.rb', line 269

def add_graph( xGraphName = nil, hOpts = {}, &block )
   if xGraphName.kind_of?(GraphViz)
      xGraphID = xGraphName.id
      @hoGraphs[xGraphID] = xGraphName.clone
      @hoGraphs[xGraphID].type = @oGraphType
      @hoGraphs[xGraphID].pg = self
      xGraphName = xGraphID
   else
      if xGraphName.kind_of?(Hash)
         hOpts = xGraphName
         xGraphName = nil
      end

      if xGraphName.nil?
         xGraphID = String.random(11)
         xGraphName = ""
      else
         xGraphID = xGraphName
      end

      @hoGraphs[xGraphID] = GraphViz::new( xGraphName, {:parent => self, :type => @oGraphType}, &block )

      hOpts.each do |xKey, xValue|
         @hoGraphs[xGraphID][xKey.to_s] = xValue
      end
   end

   @elements_order.push( {
      "type" => "graph",
      "name" => xGraphName,
      "value" => @hoGraphs[xGraphID]
   } )

   return( @hoGraphs[xGraphID] )
end

#add_node(xNodeName, hOpts = {}) ⇒ Object 



85
86
87
88
89
90
 
# File 'lib/graphviz.rb', line 85

def add_node( xNodeName, hOpts = {} )
  if xNodeName.kind_of? Array
    raise ArgumentError, "use `add_nodes' to add several nodes at the same time"
  end
  return add_nodes(xNodeName, hOpts)
end

#add_nodes(node_name, options = {}) ⇒ Object

Create a new node

In:

  • xNodeName : Name of the new node

  • hOpts : Node attributes

Return the GraphViz::Node object created



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
 
# File 'lib/graphviz.rb', line 99

def add_nodes(node_name, options = {})
   if node_name.kind_of? Array
      node_name.each { |n| add_nodes(n, options.clone) }
   else
      node = @hoNodes[node_name]

      if node.nil?
         @hoNodes[node_name] = GraphViz::Node::new( node_name, self )
         @hoNodes[node_name].index = @elements_order.size_of( "node" )

         unless options.keys.include?(:label) or options.keys.include?("label")
            options[:label] = node_name
         end

         @elements_order.push( {
            "type" => "node",
            "name" => node_name,
            "value" => @hoNodes[node_name]
         } )

         node = @hoNodes[node_name]
      end

      options.each do |xKey, xValue|
         @hoNodes[node_name][xKey.to_s] = xValue
      end

      return node
   end
end

#append_attributes_and_types(script) ⇒ Object 



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/graphviz.rb', line 627

def append_attributes_and_types(script)
  script_data = DOTScriptData.new

  @elements_order.each { |kElement|
    is_new_type = script_data.type != kElement["type"]
    if is_new_type 
      script << script_data unless script_data.type.nil? or script_data.empty?
      script_data = DOTScriptData.new(kElement["type"])
    end

    # Modified by Brandon Coleman verify value is NOT NULL
    kElement["value"] or raise ArgumentError, "#{kElement["name"]} is nil!"

    case kElement["type"]
      when "graph_attr", "node_attr", "edge_attr"
        script_data.add_attribute(kElement["name"], kElement["value"].to_gv)
      when "node", "graph"
        script << kElement["value"].output()
      when "edge"
        script << "  " + kElement["value"].output( @oGraphType )
      else
        raise ArgumentError,
          "Don't know what to do with element type '#{kElement['type']}'"
    end
  }
  script << script_data unless script_data.type.nil? or script_data.empty?
end

#complete ⇒ Object

Return a new completed graph



776
777
778
 
# File 'lib/graphviz.rb', line 776

def complete
  GraphViz.parse_string( root_graph.output( :dot => String ) )
end

#complete! ⇒ Object

Complete the current graph



781
782
783
784
 
# File 'lib/graphviz.rb', line 781

def complete!
  # TODO: Keep options
  complete
end

#directed? ⇒ Boolean

Return true if the graph is directed.

Returns:

  • (Boolean) 


787
788
789
 
# File 'lib/graphviz.rb', line 787

def directed?
  not((/digraph/ =~ "bla digraph bla").nil?)
end

#each_attribut(&b) ⇒ Object 



418
419
420
421
 
# File 'lib/graphviz.rb', line 418

def each_attribut(&b)
   warn "`GraphViz#each_attribut` is deprecated, please use `GraphViz#each_attribute`"
   each_attribute(&b)
end

#each_attribute(&b) ⇒ Object

Calls block once for each attribute of the graph, passing the name and value to the block as a two-element array.



413
414
415
416
417
 
# File 'lib/graphviz.rb', line 413

def each_attribute(&b)
  @graph.each do |k,v|
    yield(k,v)
  end
end

#each_edge(&block) ⇒ Object

Allow you to traverse edges



237
238
239
240
241
242
243
244
245
 
# File 'lib/graphviz.rb', line 237

def each_edge( &block )
  if block_given?
    @loEdges.each do |edge|
      yield(edge)
    end
  else
    return @loEdges
  end
end

#each_graph(&block) ⇒ Object

Allow you to traverse graphs



319
320
321
322
323
324
325
326
327
 
# File 'lib/graphviz.rb', line 319

def each_graph( &block )
  if block_given?
    @hoGraphs.each do |name, graph|
      yield( name, graph )
    end
  else
    return @hoGraphs
  end
end

#each_node(&block) ⇒ Object

Allow you to traverse nodes



176
177
178
179
180
181
182
183
184
 
# File 'lib/graphviz.rb', line 176

def each_node( &block )
  if block_given?
    @hoNodes.each do |name, node|
      yield( name, node )
    end
  else
    return( @hoNodes )
  end
end

#edge_count ⇒ Object

Get the number of edges



250
251
252
 
# File 'lib/graphviz.rb', line 250

def edge_count
  @loEdges.size
end

#enumerate_nodes ⇒ Object 



156
157
158
159
160
161
162
163
 
# File 'lib/graphviz.rb', line 156

def enumerate_nodes
  nodes = @hoNodes.keys
  each_graph { |_, g|
    child_nodes = g.enumerate_nodes
    nodes += child_nodes
  }
  return nodes
end

#find_node(name) ⇒ Object

Returns the first node found in the entire graph, starting from the root graph



140
141
142
143
 
# File 'lib/graphviz.rb', line 140

def find_node(name)
   root = root_graph
   return root.search_node(name)
end

#get_edge_at_index(index) ⇒ Object

Return the edge object for the given index



257
258
259
260
 
# File 'lib/graphviz.rb', line 257

def get_edge_at_index( index )
  element = @elements_order[index, "edge"]
  (element.nil?) ? nil : element["value"]
end

#get_graph(xGraphName) {|graph| ... } ⇒ Object

Return the graph object for the given name (or nil)

Yields:

  • (graph) 


308
309
310
311
312
313
314
 
# File 'lib/graphviz.rb', line 308

def get_graph( xGraphName, &block )
  graph = @hoGraphs[xGraphName] || nil

  yield( graph ) if( block and graph )

  return graph
end

#get_node(xNodeName) {|node| ... } ⇒ Object

Return the node object for the given name (or nil) in the current graph

Yields:



131
132
133
134
135
136
137
 
# File 'lib/graphviz.rb', line 131

def get_node( xNodeName, &block )
  node = @hoNodes[xNodeName] || nil

  yield( node ) if( block and node )

  return node
end

#get_node_at_index(index) ⇒ Object

Return the node object for the given index



168
169
170
171
 
# File 'lib/graphviz.rb', line 168

def get_node_at_index( index )
  element = @elements_order[index, "node"]
  (element.nil?) ? nil : element["value"]
end

#graph_attrs ⇒ Object

This accessor allow you to set global graph attributes



72
73
74
 
# File 'lib/graphviz.rb', line 72

def graph
  @graph
end

#graph_count ⇒ Object

Get the number of graphs



353
354
355
 
# File 'lib/graphviz.rb', line 353

def graph_count
  @hoGraphs.size
end

#has_parent_graph? ⇒ Boolean

Returns:

  • (Boolean) 


791
792
793
 
# File 'lib/graphviz.rb', line 791

def has_parent_graph?
   not @oParentGraph.nil?
end

#name ⇒ Object Also known as: id

Get the graph name



662
663
664
 
# File 'lib/graphviz.rb', line 662

def name
  @name.clone
end

#node_count ⇒ Object

Get the number of nodes



187
188
189
 
# File 'lib/graphviz.rb', line 187

def node_count
  @hoNodes.size
end

#output(hOpts = {}) ⇒ Object Also known as: save

Generate the graph

Options :

  • :output : Output format (GraphViz::Constants::FORMATS)

  • :file : Output file name

  • :use : Program to use (GraphViz::Constants::PROGRAMS)

  • :path : Program PATH

  • :<format> => <file> : <file> can be

    • a file name

    • nil, then the output will be printed to STDOUT

    • String, then the output will be returned as a String

  • :errors : DOT error level (default 1)

    • 0 = Error + Warning

    • 1 = Error

    • 2 = none



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/graphviz.rb', line 447

def output( hOpts = {} )
  xDOTScript = DOTScript.new
  lNotHugly = []

  append_attributes_and_types(xDOTScript)

  xDOTScript << "}"

  if has_parent_graph?
    xDOTScript.make_subgraph("#{GraphViz.escape(@name, :unquote_empty => true)}")
  else
    hOutput = {}

    hOpts.each do |xKey, xValue|
      xValue = xValue.to_s unless xValue.nil? or [Class, TrueClass, FalseClass].include?(xValue.class)
      case xKey.to_s
        when "use"
          if PROGRAMS.index( xValue ).nil?
            raise ArgumentError, "can't use '#{xValue}'"
          end
          @prog = xValue
        when "path"
          @path = xValue && xValue.split( "," ).map{ |x| x.strip }
        when "errors"
          @errors = xValue
        when "extlib"
          @extlibs = xValue.split( "," ).map{ |x| x.strip }
        when "scale"
          # Scale input by 'v' (=72)
          @scale = xValue
        when "inverty"
          # Invert y coordinate in output
          @inverty = xValue
        when "no_layout"
          # No layout mode 'v' (=1)
          @no_layout = xValue
        when "reduce"
          # Reduce graph
          @reduce_graph = xValue
        when "Lg"
          # Don't use grid
          @Lg = xValue
        when "LO"
          # Use old attractive force
          @LO = xValue
        when "Ln"
          # Set number of iterations to i
          @Ln = xValue
        when "LU"
          # Set unscaled factor to i
          @LU = xValue
        when "LC"
          # Set overlap expansion factor to v
          @LC = xValue
        when "LT"
          # Set temperature (temperature factor) to v
          @LT = xValue
        when "nothugly"
          begin
            require 'graphviz/nothugly'
            @nothugly = true
          rescue LoadError
            warn "You must install ruby-xslt or libxslt-ruby to use nothugly option!"
            @nothugly = false
          end
        else
          if FORMATS.index( xKey.to_s ).nil?
            raise ArgumentError, "output format '#{xValue}' invalid"
          end
          hOutput[xKey.to_s] = xValue
      end
    end

    @output = hOutput if hOutput.size > 0

    xStict = ((@strict && @oGraphType == "digraph") ? "strict " : "")
    xDOTScript.prepend(
      "#{xStict}#{@oGraphType} #{GraphViz.escape(@name, :unquote_empty => true)} {"
    )

    xOutputString = (@filename == String ||
      @output.any? {|format, file| file == String })

    xOutput = ""
    if @format.to_s == "none" or @output.any? {|fmt, fn| fmt.to_s == "none"}
      if xOutputString
        xOutput << xDOTScript
      else
        xFileName = @output["none"] || @filename
        open( xFileName, "w" ) do |h|
          h.puts xDOTScript
        end
      end
    end

    if (@format.to_s != "none" and not @format.nil?) or (@output.any? {|format, file| format != "none" } and @output.size > 0)
      ## Act: Save script and send it to dot
      t = Tempfile::open( File.basename(__FILE__) )
      t.print( xDOTScript )
      t.close

      cmd = find_executable( @prog, @path )
      if cmd == nil
        raise StandardError, "GraphViz not installed or #{@prog} not in PATH. Install GraphViz or use the 'path' option"
      end

      xOutputWithFile = []
      xOutputWithoutFile = []
      unless @format.nil? or @format == "none"
        lNotHugly << @filename if @format.to_s == "svg" and @nothugly
        if @filename.nil? or @filename == String
          xOutputWithoutFile = ["-T#{@format}"]
        else
          xOutputWithFile = ["-T#{@format}", "-o#{@filename}"]
        end
      end
      @output.each_except( :key => ["none"] ) do |format, file|
        lNotHugly << file if format.to_s == "svg" and @nothugly
        if file.nil? or file == String
          xOutputWithoutFile += ["-T#{format}"]
        else
          xOutputWithFile += ["-T#{format}", "-o#{file}"]
        end
      end

      xExternalLibraries = @extlibs.map { |lib| "-l#{lib}" }

      xOtherOptions = []
      xOtherOptions << "-s#{@scale}" if @scale
      xOtherOptions << "-y" if @inverty
      xOtherOptions << "-n#{@no_layout}" if @no_layout
      xOtherOptions << "-x" if @reduce_graph
      xOtherOptions << "-Lg" if @Lg
      xOtherOptions << "-LO" if @LO
      xOtherOptions << "-Ln#{@Ln}" if @Ln
      xOtherOptions << "-LU#{@LU}" if @LU
      xOtherOptions << "-LC#{@LC}" if @LC
      xOtherOptions << "-LT#{@LT}" if @LT

      tmpPath = if IS_JRUBY
        t.path
      elsif IS_CYGWIN
        begin
          IO.popen("cygpath", "-w", t.path).chomp
        rescue
          warn "cygpath is not installed!"
          t.path
        end
      else
        t.path
      end

      xCmd = [cmd, "-q#{@errors}"] +
             xExternalLibraries +
             xOtherOptions +
             xOutputWithFile +
             xOutputWithoutFile +
             [tmpPath]

      xOutput << output_from_command( xCmd )
    end

    # Not Hugly
    lNotHugly.each do |f|
      if f.nil? or f == String
        xOutput = GraphViz.nothugly( xOutput, false )
      else
        GraphViz.nothugly( f, true )
      end
    end

    if xOutputString
      xOutput
    else
      print xOutput
    end
  end
end

#pg ⇒ Object

:nodoc:



685
686
687
 
# File 'lib/graphviz.rb', line 685

def pg #:nodoc:
  @oParentGraph
end

#pg=(x) ⇒ Object

:nodoc:



688
689
690
 
# File 'lib/graphviz.rb', line 688

def pg=(x) #:nodoc:
  @oParentGraph = x
end

#root_graph ⇒ Object

Return the root graph



695
696
697
 
# File 'lib/graphviz.rb', line 695

def root_graph
  return( (self.pg.nil?) ? self : self.pg.root_graph )
end

#search_node(name) ⇒ Object

Return the first node found in the current graph, and it subgraphs



146
147
148
149
150
151
152
153
154
 
# File 'lib/graphviz.rb', line 146

def search_node(name)
   n = get_node(name)
   return n unless n.nil?
   each_graph { |_, g|
      n = g.search_node(name)
      return n unless n.nil?
   }
   return nil
end

#set_position(xType, xKey, xValue) ⇒ Object

:nodoc:



711
712
713
714
715
716
717
 
# File 'lib/graphviz.rb', line 711

def set_position( xType, xKey, xValue ) #:nodoc:
  @elements_order.push( {
    "type" => "#{xType}_attr",
    "name" => xKey,
    "value" => xValue
  } )
end

#to_graph ⇒ Object

Create a new graph from the current subgraph



424
425
426
427
428
 
# File 'lib/graphviz.rb', line 424

def to_graph
  graph = self.clone
  graph.pg = nil
  return graph
end

#to_s ⇒ Object 



655
656
657
 
# File 'lib/graphviz.rb', line 655

def to_s
  self.output(:none => String)
end

#type ⇒ Object

Return the graph type (graph digraph)



343
344
345
 
# File 'lib/graphviz.rb', line 343

def type
  @oGraphType
end

#type=(x) ⇒ Object

:nodoc:



346
347
348
 
# File 'lib/graphviz.rb', line 346

def type=(x) #:nodoc:
  @oGraphType = x
end