.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "GraphViz::Parse::Yacc 3"
.TH GraphViz::Parse::Yacc 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
GraphViz::Parse::Yacc \- Visualise grammars
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use GraphViz::Parse::Yacc;
\&
\&  # Pass in a file generated via yacc \-v
\&  my $graph = GraphViz::Parse::Yacc\->new(\*(AqYacc.output\*(Aq);
\&  print $g\->as_png;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module makes it easy to visualise Parse::Yacc grammars.
Writing Parse::Yacc grammars is tricky at the best of times, and
grammars almost always evolve in ways unforseen at the start. This
module aims to visualise a grammar as a graph in order to make the
structure clear and aid in understanding the grammar.
.PP
Rules are represented as nodes, which have their name on the left of
the node and their productions on the right of the node. The subrules
present in the productions are represented by edges to the subrule
nodes.
.PP
Thus, every node (rule) should be connected to the graph \- otherwise a
rule is not part of the grammar.
.PP
This uses the GraphViz module to draw the graph. Thanks to Damian
Conway for the original idea.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
This is the constructor. It takes one mandatory argument, which is a
filename of the output file generated by running "yacc \-v " on the
grammar file. For example, if your Parse::Yacc grammar file is called
"calc.yp", you would run "yacc \-v calc.y" and pass in "calc.output"
as an argument here. A GraphViz object is returned.
.PP
.Vb 3
\&  # Pass in a file generated via yacc \-v
\&  my $graph = GraphViz::Parse::Yacc\->new(\*(AqYacc.output\*(Aq);
\&  print $g\->as_png;
.Ve
.SS as_*
.IX Subsection "as_*"
The grammar can be visualised in a number of different graphical
formats. Methods include as_ps, as_hpgl, as_pcl, as_mif, as_pic,
as_gd, as_gd2, as_gif, as_jpeg, as_png, as_wbmp, as_ismap, as_imap,
as_vrml, as_vtx, as_mp, as_fig, as_svg. See the GraphViz documentation
for more information. The two most common methods are:
.PP
.Vb 2
\&  # Print out a PNG\-format file
\&  print $g\->as_png;
\&
\&  # Print out a PostScript\-format file
\&  print $g\->as_ps;
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Leon Brocard <\fIacme@astray.com\fR>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2001, Leon Brocard
.PP
This module is free software; you can redistribute it or modify it under the Perl License,
a copy of which is available at <http://dev.perl.org/licenses/>.