-
Notifications
You must be signed in to change notification settings - Fork 7
/
GraphViz2.pm
2114 lines (1531 loc) · 59.2 KB
/
GraphViz2.pm
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
198
199
200
201
202
203
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
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
625
626
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
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package GraphViz2;
use strict;
use warnings;
use warnings qw(FATAL utf8); # Fatalize encoding glitches.
use Data::Section::Simple 'get_data_section';
use File::Temp; # For newdir().
use File::Which; # For which().
use Moo;
use IPC::Run3; # For run3().
use Types::Standard qw/Any ArrayRef HasMethods HashRef Int Str/;
our $VERSION = '2.67';
my $DATA_SECTION = get_data_section; # load once
my $DEFAULT_COMBINE = 1; # default for combine_node_and_port
my %CONTEXT_QUOTING = (
label => '\\{\\}\\|<>\\s"',
label_legacy => '"',
);
my %PORT_QUOTING = map +($_ => sprintf "%%%02x", ord $_), qw(% \\ : " { } | < >);
my $PORT_QUOTE_CHARS = join '', '[', (map quotemeta, sort keys %PORT_QUOTING), ']';
has command =>
(
default => sub{[]},
is => 'ro',
isa => ArrayRef,
required => 0,
);
has dot_input =>
(
is => 'lazy',
isa => Str,
required => 0,
);
sub _build_dot_input {
my ($self) = @_;
join('', @{ $self->command }) . "}\n";
}
has dot_output =>
(
default => sub{return ''},
is => 'rw',
isa => Str,
required => 0,
);
has edge =>
(
default => sub{return {} },
is => 'rw',
isa => HashRef,
required => 0,
);
has edge_hash =>
(
default => sub{return {} },
is => 'rw',
isa => HashRef,
required => 0,
);
has global =>
(
default => sub{return {} },
is => 'rw',
isa => HashRef,
required => 0,
);
has graph =>
(
default => sub{return {} },
is => 'rw',
isa => HashRef,
required => 0,
);
has im_meta =>
(
default => sub{return {} },
is => 'rw',
isa => HashRef,
required => 0,
);
has logger =>
(
is => 'rw',
isa => HasMethods[qw(debug error)],
required => 0,
);
has node =>
(
default => sub{return {} },
is => 'rw',
isa => HashRef,
required => 0,
);
has node_hash =>
(
default => sub{return {} },
is => 'rw',
isa => HashRef,
required => 0,
);
has scope =>
(
default => sub{[]},
is => 'ro',
isa => ArrayRef,
required => 0,
);
has subgraph =>
(
default => sub{return {} },
is => 'rw',
isa => HashRef,
required => 0,
);
has verbose =>
(
default => sub{return 0},
is => 'rw',
isa => Int,
required => 0,
);
my $VALID_ATTRIBUTES = _build_valid_attributes();
sub valid_attributes { $VALID_ATTRIBUTES }
sub _build_valid_attributes {
my %data = map +($_ => [
grep !/^$/ && !/^(?:\s*)#/, split /\n/, $$DATA_SECTION{$_}
]), keys %$DATA_SECTION;
# Reorder them so the major key is the context and the minor key is the attribute.
# I.e. $attribute{global}{directed} => undef means directed is valid in a global context.
my %attribute;
# Common attributes are a special case, since one attribute can be valid is several contexts...
# Format: attribute_name => context_1, context_2.
for my $a (@{ delete $data{common_attribute} }) {
my ($attr, $contexts) = split /\s*=>\s*/, $a;
$attribute{$_}{$attr} = undef for split /\s*,\s*/, $contexts;
}
@{$attribute{$_}}{ @{$data{$_}} } = () for keys %data;
@{$attribute{subgraph}}{ keys %{ delete $attribute{cluster} } } = ();
\%attribute;
}
has valid_output_format => (
is => 'lazy',
isa => HashRef,
required => 0,
);
sub _build_valid_output_format {
my ($self) = @_;
run3
['dot', "-T?"],
undef,
\my $stdout,
\my $stderr,
;
$stderr =~ s/.*one of:\s+//;
+{ map +($_ => undef), split /\s+/, $stderr };
}
sub _dor { return $_[0] if defined $_[0]; $_[1] } # //
sub BUILD
{
my($self) = @_;
my($globals) = $self -> global;
my($global) =
{
combine_node_and_port => _dor($$globals{combine_node_and_port}, $DEFAULT_COMBINE),
directed => $$globals{directed} ? 'digraph' : 'graph',
driver => $$globals{driver} || scalar(which('dot')),
format => $$globals{format} || 'svg',
im_format => $$globals{im_format} || 'cmapx',
label => $$globals{directed} ? '->' : '--',
name => _dor($$globals{name}, 'Perl'),
record_shape => ($$globals{record_shape} && $$globals{record_shape} =~ /^(M?record)$/) ? $1 : 'Mrecord',
strict => _dor($$globals{strict}, 0),
timeout => _dor($$globals{timeout}, 10),
};
my($im_metas) = $self -> im_meta;
my($im_meta) =
{
URL => $$im_metas{URL} || '',
};
$self -> global($global);
$self -> im_meta($im_meta);
$self->validate_params('global', $self->global);
$self->validate_params('graph', $self->graph);
$self->validate_params('im_meta', $self->im_meta);
$self->validate_params('node', $self->node);
$self->validate_params('edge', $self->edge);
$self->validate_params('subgraph', $self->subgraph);
push @{ $self->scope }, {
edge => $self -> edge,
graph => $self -> graph,
node => $self -> node,
subgraph => $self -> subgraph,
};
my(%global) = %{$self -> global};
my(%im_meta) = %{$self -> im_meta};
$self -> log(debug => "Default global: $_ => $global{$_}") for sort keys %global;
$self -> log(debug => "Default im_meta: $_ => $im_meta{$_}") for grep{$im_meta{$_} } sort keys %im_meta;
my($command) = (${$self -> global}{strict} ? 'strict ' : '')
. (${$self -> global}{directed} . ' ')
. ${$self -> global}{name}
. " {\n";
for my $key (grep{$im_meta{$_} } sort keys %im_meta)
{
$command .= _indent(qq|$key = "$im_meta{$key}"; \n|, $self->scope);
}
push @{ $self->command }, $command;
$self -> default_graph;
$self -> default_node;
$self -> default_edge;
} # End of BUILD.
sub _edge_name_port {
my ($self, $name) = @_;
$name = _dor($name, '');
# Remove :port:compass, if any, from name.
# But beware Perl-style node names like 'A::Class'.
my @field = split /(:(?!:))/, $name;
$field[0] = $name if !@field;
# Restore Perl module names:
# o A: & B to A::B.
# o A: & B: & C to A::B::C.
splice @field, 0, 3, "$field[0]:$field[2]" while $field[0] =~ /:$/;
# Restore:
# o : & port to :port.
# o : & port & : & compass to :port:compass.
$name = shift @field;
($name, join '', @field);
}
sub add_edge
{
my($self, %arg) = @_;
my $from = _dor(delete $arg{from}, '');
my $to = _dor(delete $arg{to}, '');
my $label = _dor($arg{label}, '');
$label =~ s/^\s*(<)\n?/$1/;
$label =~ s/\n?(>)\s*$/$1/;
$arg{label} = $label if (defined $arg{label});
$self->validate_params('edge', \%arg);
my @nodes;
for my $tuple ([ $from, 'tailport' ], [ $to, 'headport' ]) {
my ($name, $argname) = @$tuple;
my $port = '';
if ($self->global->{combine_node_and_port}) {
($name, $port) = $self->_edge_name_port($name);
} elsif (defined(my $value = delete $arg{$argname})) {
$port = join ':', '', map qq{"$_"}, map escape_port($_), ref $value ? @$value : $value;
}
push @nodes, [ $name, $port ];
next if (my $nh = $self->node_hash)->{$name};
$self->log(debug => "Implicitly added node: $name");
$nh->{$name}{attributes} = {};
}
# Add this edge to the hashref of all edges.
push @{$self->edge_hash->{$nodes[0][0]}{$nodes[1][0]}}, {
attributes => \%arg,
from_port => $nodes[0][1],
to_port => $nodes[1][1],
};
# Add this edge to the DOT output string.
my $dot = $self->stringify_attributes(join(" ${$self->global}{label} ", map qq|"$_->[0]"$_->[1]|, @nodes), \%arg);
push @{ $self->command }, _indent($dot, $self->scope);
$self -> log(debug => "Added edge: $dot");
return $self;
} # End of add_edge.
sub _indent {
my ($text, $scope) = @_;
return '' if $text !~ /\S/;
(' ' x @$scope) . $text;
}
sub _compile_record {
my ($port_count, $item, $add_braces, $quote_more) = @_;
my $text;
if (ref $item eq 'ARRAY') {
my @parts;
for my $l (@$item) {
($port_count, my $t) = _compile_record($port_count, $l, 1, $quote_more);
push @parts, $t;
}
$text = join '|', @parts;
$text = "{$text}" if $add_braces;
} elsif (ref $item eq 'HASH') {
my $port = $item->{port} || 0;
$text = escape_some_chars(_dor($item->{text}, ''), $CONTEXT_QUOTING{$quote_more ? 'label' : 'label_legacy'});
if ($port) {
$port =~ s/^\s*<?//;
$port =~ s/>?\s*$//;
$port = escape_port($port);
$text = "<$port> $text";
}
} else {
$text = "<port".++$port_count."> " . escape_some_chars($item, $CONTEXT_QUOTING{$quote_more ? 'label' : 'label_legacy'});
}
($port_count, $text);
}
sub add_node {
my ($self, %arg) = @_;
my $name = _dor(delete $arg{name}, '');
$self->validate_params('node', \%arg);
my $node = $self->node_hash;
%arg = (%{$$node{$name}{attributes} || {}}, %arg);
$$node{$name}{attributes} = \%arg;
my $label = _dor($arg{label}, '');
$label =~ s/^\s*(<)\n?/$1/;
$label =~ s/\n?(>)\s*$/$1/;
$arg{label} = $label if defined $arg{label};
# Handle ports.
if (ref $label eq 'ARRAY') {
(undef, $arg{label}) = _compile_record(0, $label, 0, !$self->global->{combine_node_and_port});
$arg{shape} ||= $self->global->{record_shape};
} elsif ($arg{shape} && ( ($arg{shape} =~ /M?record/) || ( ($arg{shape} =~ /(?:none|plaintext)/) && ($label =~ /^</) ) ) ) {
# Do not escape anything.
} elsif ($label) {
$arg{label} = escape_some_chars($arg{label}, $CONTEXT_QUOTING{label_legacy});
}
my $dot = $self->stringify_attributes(qq|"$name"|, \%arg);
push @{ $self->command }, _indent($dot, $self->scope);
$self->log(debug => "Added node: $dot");
return $self;
}
sub default_edge
{
my($self, %arg) = @_;
$self->validate_params('edge', \%arg);
my $scope = $self->scope->[-1];
$$scope{edge} = {%{$$scope{edge} || {}}, %arg};
push @{ $self->command }, _indent($self->stringify_attributes('edge', $$scope{edge}), $self->scope);
$self -> log(debug => 'Default edge: ' . join(', ', map{"$_ => $$scope{edge}{$_}"} sort keys %{$$scope{edge} }) );
return $self;
} # End of default_edge.
# -----------------------------------------------
sub default_graph
{
my($self, %arg) = @_;
$self->validate_params('graph', \%arg);
my $scope = $self->scope->[-1];
$$scope{graph} = {%{$$scope{graph} || {}}, %arg};
push @{ $self->command }, _indent($self->stringify_attributes('graph', $$scope{graph}), $self->scope);
$self -> log(debug => 'Default graph: ' . join(', ', map{"$_ => $$scope{graph}{$_}"} sort keys %{$$scope{graph} }) );
return $self;
} # End of default_graph.
# -----------------------------------------------
sub default_node
{
my($self, %arg) = @_;
$self->validate_params('node', \%arg);
my $scope = $self->scope->[-1];
$$scope{node} = {%{$$scope{node} || {}}, %arg};
push @{ $self->command }, _indent($self->stringify_attributes('node', $$scope{node}), $self->scope);
$self -> log(debug => 'Default node: ' . join(', ', map{"$_ => $$scope{node}{$_}"} sort keys %{$$scope{node} }) );
return $self;
} # End of default_node.
# -----------------------------------------------
sub default_subgraph
{
my($self, %arg) = @_;
$self->validate_params('subgraph', \%arg);
my $scope = $self->scope->[-1];
$$scope{subgraph} = {%{$$scope{subgraph} || {}}, %arg};
push @{ $self->command }, _indent($self->stringify_attributes('subgraph', $$scope{subgraph}), $self->scope);
$self -> log(debug => 'Default subgraph: ' . join(', ', map{"$_ => $$scope{subgraph}{$_}"} sort keys %{$$scope{subgraph} }) );
return $self;
} # End of default_subgraph.
sub escape_port {
my ($s) = @_;
$s =~ s/($PORT_QUOTE_CHARS)/$PORT_QUOTING{$1}/g;
$s;
}
sub escape_some_chars {
my ($s, $quote_chars) = @_;
return $s if substr($s, 0, 1) eq '<'; # HTML label
$s =~ s/(\\.)|([$quote_chars])/ defined($1) ? $1 : '\\' . $2 /ge;
return $s;
}
sub log
{
my($self, $level, $message) = @_;
$level ||= 'debug';
$message ||= '';
if ($self->logger) {
$self->logger->$level($message);
} else {
die $message if $level eq 'error';
print "$level: $message\n" if $self->verbose;
}
return $self;
} # End of log.
# -----------------------------------------------
sub pop_subgraph
{
my($self) = @_;
pop @{ $self->scope };
push @{ $self->command }, _indent("}\n", $self->scope);
return $self;
} # End of pop_subgraph.
# -----------------------------------------------
sub push_subgraph
{
my($self, %arg) = @_;
my($name) = delete $arg{name};
$name = defined($name) && length($name) ? qq|"$name"| : '';
$self->validate_params('graph', $arg{graph});
$self->validate_params('node', $arg{node});
$self->validate_params('edge', $arg{edge});
$self->validate_params('subgraph', $arg{subgraph});
$arg{subgraph} = { %{ $self->subgraph||{} }, %{$arg{subgraph}||{}} };
push @{ $self->command }, "\n" . _indent(join(' ', grep length, "subgraph", $name, "{\n"), $self->scope);
push @{ $self->scope }, \%arg;
$self -> default_graph;
$self -> default_node;
$self -> default_edge;
$self -> default_subgraph;
return $self;
} # End of push_subgraph.
# -----------------------------------------------
sub run
{
my($self, %arg) = @_;
my($driver) = delete $arg{driver} || ${$self -> global}{driver};
my($format) = delete $arg{format} || ${$self -> global}{format};
my($im_format) = delete $arg{im_format} || ${$self -> global}{im_format};
my($timeout) = delete $arg{timeout} || ${$self -> global}{timeout};
my($output_file) = delete $arg{output_file} || '';
my($im_output_file) = delete $arg{im_output_file} || '';
for ($format, $im_format) {
my $prefix = $_;
$prefix =~ s/:.+$//; # In case of 'png:gd', etc.
$self->log(error => "Error: '$prefix' is not a valid output format")
if !exists $self->valid_output_format->{$prefix};
}
$self -> log(debug => $self -> dot_input);
# Warning: Do not use $im_format in this 'if', because it has a default value.
if ($im_output_file)
{
return $self -> run_map($driver, $output_file, $format, $timeout, $im_output_file, $im_format);
}
else
{
return $self -> run_mapless($driver, $output_file, $format, $timeout);
}
} # End of run.
# -----------------------------------------------
sub run_map
{
my($self, $driver, $output_file, $format, $timeout, $im_output_file, $im_format) = @_;
$self -> log(debug => "Driver: $driver. Output file: $output_file. Format: $format. IM output file: $im_output_file. IM format: $im_format. Timeout: $timeout second(s)");
# The EXLOCK option is for BSD-based systems.
my($temp_dir) = File::Temp -> newdir('temp.XXXX', CLEANUP => 1, EXLOCK => 0, TMPDIR => 1);
my($temp_file) = File::Spec -> catfile($temp_dir, 'temp.gv');
open(my $fh, '> :raw', $temp_file) || die "Can't open(> $temp_file): $!";
print $fh $self -> dot_input;
close $fh;
my(@args) = ("-T$im_format", "-o$im_output_file", "-T$format", "-o$output_file", $temp_file);
system($driver, @args);
return $self;
} # End of run_map.
# -----------------------------------------------
sub run_mapless
{
my($self, $driver, $output_file, $format, $timeout) = @_;
$self -> log(debug => "Driver: $driver. Output file: $output_file. Format: $format. Timeout: $timeout second(s)");
# Usage of utf8 here relies on ISO-8859-1 matching Unicode for low chars.
# It saves me the effort of determining if the input contains Unicode.
run3
[$driver, "-T$format"],
\$self -> dot_input,
\my $stdout,
\my $stderr,
{
binmode_stdin => ':utf8',
binmode_stdout => ':raw',
binmode_stderr => ':raw',
};
die $stderr if ($stderr);
$self -> dot_output($stdout);
if ($output_file)
{
open(my $fh, '> :raw', $output_file) || die "Can't open(> $output_file): $!";
print $fh $stdout;
close $fh;
$self -> log(debug => "Wrote $output_file. Size: " . length($stdout) . ' bytes');
}
return $self;
} # End of run_mapless.
sub stringify_attributes {
my($self, $context, $option) = @_;
# Add double-quotes around anything (e.g. labels) which does not look like HTML.
my @pairs;
for my $key (sort keys %$option) {
my $text = _dor($$option{$key}, '');
$text =~ s/^\s+(<)/$1/;
$text =~ s/(>)\s+$/$1/;
$text = qq|"$text"| if $text !~ /^<.+>$/s;
push @pairs, qq|$key=$text|;
}
return join(' ', @pairs) . "\n" if $context eq 'subgraph';
return join(' ', $context, '[', @pairs, ']') . "\n" if @pairs;
$context =~ /^(?:edge|graph|node)/ ? '' : "$context\n";
}
sub validate_params
{
my($self, $context, $attributes) = @_;
my $valid = $VALID_ATTRIBUTES->{$context};
my @invalid = grep !exists $valid->{$_}, keys %$attributes;
$self->log(error => "Error: '$_' is not a valid attribute in the '$context' context") for sort @invalid;
return $self;
} # End of validate_params.
sub from_graph {
my ($self, $g) = @_;
die "from_graph: '$g' not a Graph" if !$g->isa('Graph');
my %g_attrs = %{ $g->get_graph_attribute('graphviz') || {} };
my $global = { directed => $g->is_directed, %{delete $g_attrs{global}||{}} };
my $groups = delete $g_attrs{groups} || [];
if (ref $self) {
for (sort keys %g_attrs) {
my $method = "default_$_";
$self->$method(%{ $g_attrs{$_} });
}
} else {
$self = $self->new(global => $global, %g_attrs);
}
for my $group (@$groups) {
$self->push_subgraph(%{ $group->{attributes} || {} });
$self->add_node(name => $_) for @{ $group->{nodes} || [] };
$self->pop_subgraph;
}
my ($is_multiv, $is_multie) = map $g->$_, qw(multivertexed multiedged);
my ($v_attr, $e_attr) = qw(get_vertex_attribute get_edge_attribute);
$v_attr .= '_by_id' if $is_multiv;
$e_attr .= '_by_id' if $is_multie;
my %first2edges;
for my $e (sort {$a->[0] cmp $b->[0] || $a->[1] cmp $b->[1]} $g->unique_edges) {
my @edges = $is_multie
? map $g->$e_attr(@$e, $_, 'graphviz') || {}, sort $g->get_multiedge_ids(@$e)
: $g->$e_attr(@$e, 'graphviz')||{};
push @{ $first2edges{$e->[0]} }, map [ from => $e->[0], to => $e->[1], %$_ ], @edges;
}
for my $v (sort $g->unique_vertices) {
my @vargs = $v;
if ($is_multiv) {
my ($found_id) = grep $g->has_vertex_attribute_by_id($v, $_, 'graphviz'), sort $g->get_multivertex_ids($v);
@vargs = defined $found_id ? (@vargs, $found_id) : ();
}
my $attrs = @vargs ? $g->$v_attr(@vargs, 'graphviz') || {} : {};
$self->add_node(name => $v, %$attrs) if keys %$attrs or $g->is_isolated_vertex($v);
$self->add_edge(@$_) for @{ $first2edges{$v} };
}
$self;
}
# -----------------------------------------------
1;
=pod
=head1 NAME
GraphViz2 - A wrapper for AT&T's Graphviz
=head1 Synopsis
=head2 Sample output
See L<https://graphviz-perl.github.io/>.
=head2 Perl code
=head3 Typical Usage
use strict;
use warnings;
use File::Spec;
use GraphViz2;
use Log::Handler;
my $logger = Log::Handler->new;
$logger->add(screen => {
maxlevel => 'debug', message_layout => '%m', minlevel => 'error'
});
my $graph = GraphViz2->new(
edge => {color => 'grey'},
global => {directed => 1},
graph => {label => 'Adult', rankdir => 'TB'},
logger => $logger,
node => {shape => 'oval'},
);
$graph->add_node(name => 'Carnegie', shape => 'circle');
$graph->add_node(name => 'Murrumbeena', shape => 'box', color => 'green');
$graph->add_node(name => 'Oakleigh', color => 'blue');
$graph->add_edge(from => 'Murrumbeena', to => 'Carnegie', arrowsize => 2);
$graph->add_edge(from => 'Murrumbeena', to => 'Oakleigh', color => 'brown');
$graph->push_subgraph(
name => 'cluster_1',
graph => {label => 'Child'},
node => {color => 'magenta', shape => 'diamond'},
);
$graph->add_node(name => 'Chadstone', shape => 'hexagon');
$graph->add_node(name => 'Waverley', color => 'orange');
$graph->add_edge(from => 'Chadstone', to => 'Waverley');
$graph->pop_subgraph;
$graph->default_node(color => 'cyan');
$graph->add_node(name => 'Malvern');
$graph->add_node(name => 'Prahran', shape => 'trapezium');
$graph->add_edge(from => 'Malvern', to => 'Prahran');
$graph->add_edge(from => 'Malvern', to => 'Murrumbeena');
my $format = shift || 'svg';
my $output_file = shift || File::Spec->catfile('html', "sub.graph.$format");
$graph->run(format => $format, output_file => $output_file);
=head1 Description
=head2 Overview
This module provides a Perl interface to the amazing L<Graphviz|http://www.graphviz.org/>, an open source graph visualization tool from AT&T.
It is called GraphViz2 so that pre-existing code using (the Perl module) GraphViz continues to work.
To avoid confusion, when I use L<GraphViz2> (note the capital V), I'm referring to this Perl module, and
when I use L<Graphviz|http://www.graphviz.org/> (lower-case v) I'm referring to the underlying tool (which is in fact a set of programs).
Version 1.00 of L<GraphViz2> is a complete re-write, by Ron Savage, of GraphViz V 2, which was written by Leon Brocard. The point of the re-write
is to provide access to all the latest options available to users of L<Graphviz|http://www.graphviz.org/>.
GraphViz2 V 1 is not backwards compatible with GraphViz V 2, despite the considerable similarity. It was not possible to maintain compatibility
while extending support to all the latest features of L<Graphviz|http://www.graphviz.org/>.
To ensure L<GraphViz2> is a light-weight module, L<Moo> has been used to provide getters and setters,
rather than L<Moose>.
As of V 2.43, C<GraphViz2> supports image maps, both client and server side.
See L</Image Maps> below.
=head2 What is a Graph?
An undirected graph is a collection of nodes optionally linked together with edges.
A directed graph is the same, except that the edges have a direction, normally indicated by an arrow head.
A quick inspection of L<Graphviz|http://www.graphviz.org/>'s L<gallery|http://www.graphviz.org/gallery/> will show better than words
just how good L<Graphviz|http://www.graphviz.org/> is, and will reinforce the point that humans are very visual creatures.
=head1 Installation
Of course you need to install AT&T's Graphviz before using this module.
See L<http://www.graphviz.org/download/>.
=head1 Constructor and Initialization
=head2 Calling new()
C<new()> is called as C<< my($obj) = GraphViz2 -> new(k1 => v1, k2 => v2, ...) >>.
It returns a new object of type C<GraphViz2>.
Key-value pairs accepted in the parameter list:
=head3 edge => $hashref
The I<edge> key points to a hashref which is used to set default attributes for edges.
Hence, allowable keys and values within that hashref are anything supported by L<Graphviz|http://www.graphviz.org/>.
The default is {}.
This key is optional.
=head3 global => $hashref
The I<global> key points to a hashref which is used to set attributes for the output stream.
This key is optional.
Valid keys within this hashref are:
=head4 combine_node_and_port
New in 2.58. It defaults to true, but in due course (currently planned
May 2021) it will default to false. When true, C<add_node> and C<add_edge>
will escape only some characters in the label and names, and in particular
the "from" and "to" parameters on edges will combine the node name
and port in one string, with a C<:> in the middle (except for special
treatment of double-colons).
When the option is false, any name may be given to nodes, and edges can
be created between them. To specify ports, give the additional parameter
of C<tailport> or C<headport>. To specify a compass point in addition,
give array-refs with two values for these parameters. Also, C<add_node>'s
treatment of labels is more DWIM, with C<{> etc being transparently
quoted.
=head4 directed => $Boolean
This option affects the content of the output stream.
directed => 1 outputs 'digraph name {...}', while directed => 0 outputs 'graph name {...}'.
At the Perl level, directed graphs have edges with arrow heads, such as '->', while undirected graphs have
unadorned edges, such as '--'.
The default is 0.
This key is optional.
=head4 driver => $program_name
This option specifies which external program to run to process the output stream.
It is the equivalent of the C<-K> command-line option.
The default is to use L<File::Which>'s which() method to find the 'dot' program.
This key is optional.
=head4 format => $string
This option specifies what type of output file to create.
The default is 'svg'.
Output formats of the form 'png:gd' etc are also supported, but only the component before
the first ':' is validated by L<GraphViz2>.
This key is optional.
=head4 label => $string
This option specifies what an edge looks like: '->' for directed graphs and '--' for undirected graphs.
You wouldn't normally need to use this option.
The default is '->' if directed is 1, and '--' if directed is 0.
This key is optional.
=head4 name => $string
This option affects the content of the output stream.
name => 'G666' outputs 'digraph G666 {...}'.
The default is 'Perl' :-).
This key is optional.
=head4 record_shape => /^(?:M?record)$/
This option affects the shape of records. The value must be 'Mrecord' or 'record'.
Mrecords have nice, rounded corners, whereas plain old records have square corners.
The default is 'Mrecord'.
See L<Record shapes|http://www.graphviz.org/doc/info/shapes.html#record> for details.
=head4 strict => $Boolean
This option affects the content of the output stream.
strict => 1 outputs 'strict digraph name {...}', while strict => 0 outputs 'digraph name {...}'.
The default is 0.
This key is optional.
=head4 timeout => $integer
This option specifies how long to wait for the external program before exiting with an error.
The default is 10 (seconds).
This key is optional.
=head3 graph => $hashref
The I<graph> key points to a hashref which is used to set default attributes for graphs.
Hence, allowable keys and values within that hashref are anything supported by L<Graphviz|http://www.graphviz.org/>.
The default is {}.
This key is optional.
=head3 logger => $logger_object
Provides a logger object so $logger_object -> $level($message) can be called at certain times. Any object with C<debug> and C<error> methods
will do, since these are the only levels emitted by this module.
One option is a L<Log::Handler> object.
Retrieve and update the value with the logger() method.
By default (i.e. without a logger object), L<GraphViz2> prints warning and debug messages to STDOUT,
and dies upon errors.
However, by supplying a log object, you can capture these events.
Not only that, you can change the behaviour of your log object at any time, by calling
L</logger($logger_object)>.
See also the verbose option, which can interact with the logger option.
This key is optional.
=head3 node => $hashref
The I<node> key points to a hashref which is used to set default attributes for nodes.
Hence, allowable keys and values within that hashref are anything supported by L<Graphviz|http://www.graphviz.org/>.
The default is {}.
This key is optional.
=head3 subgraph => $hashref
The I<subgraph> key points to a hashref which is used to set attributes for all subgraphs, unless overridden
for specific subgraphs in a call of the form push_subgraph(subgraph => {$attribute => $string}).
Valid keys within this hashref are:
=over 4
=item * rank => $string
This option affects the content of all subgraphs, unless overridden later.
A typical usage would be new(subgraph => {rank => 'same'}) so that all nodes mentioned within each subgraph
are constrained to be horizontally aligned.
See scripts/rank.sub.graph.1.pl for sample code.
Possible values for $string are: max, min, same, sink and source.
See the L<Graphviz 'rank' docs|http://www.graphviz.org/doc/info/attrs.html#d:rank> for details.
=back
The default is {}.
This key is optional.
=head3 verbose => $Boolean
Provides a way to control the amount of output when a logger is not specified.
Setting verbose to 0 means print nothing.
Setting verbose to 1 means print the log level and the message to STDOUT, when a logger is not specified.
Retrieve and update the value with the verbose() method.
The default is 0.
See also the logger option, which can interact with the verbose option.
This key is optional.
=head2 Validating Parameters
The secondary keys (under the primary keys 'edge|graph|node') are checked against lists of valid attributes (stored at the end of this
module, after the __DATA__ token, and made available using L<Data::Section::Simple>).
This mechanism has the effect of hard-coding L<Graphviz|http://www.graphviz.org/> options in the source code of L<GraphViz2>.
Nevertheless, the implementation of these lists is handled differently from the way it was done in V 2.
V 2 ships with a set of scripts, scripts/extract.*.pl, which retrieve pages from the
L<Graphviz|http://www.graphviz.org/> web site and extract the current lists of valid attributes.
These are then copied manually into the source code of L<GraphViz2>, meaning any time those lists change on the
L<Graphviz|http://www.graphviz.org/> web site, it's a trivial matter to update the lists stored within this module.
See L<GraphViz2/Scripts Shipped with this Module>.
=head2 Alternate constructor and object method
=head3 from_graph
my $gv = GraphViz2->from_graph($g);
# alternatively
my $gv = GraphViz2->new;
$gv->from_graph($g);
# for handy debugging of arbitrary graphs:
GraphViz2->from_graph($g)->run(format => 'svg', output_file => 'output.svg');
Takes a L<Graph> object. This module will figure out various defaults from it,
including whether it is directed or not.
Will also use any node-, edge-, and graph-level attributes named
C<graphviz> as a hash-ref for setting attributes on the corresponding
entities in the constructed GraphViz2 object. These will override the
figured-out defaults referred to above.
For a C<multivertexed> graph, will only create one node per vertex,