.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Gedcom::Grammar 3pm"
.TH Gedcom::Grammar 3pm "2022-10-16" "perl v5.34.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"
Gedcom::Grammar \- a module to manipulate GEDCOM grammars
.PP
Version 1.22 \- 15th November 2019
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Gedcom::Grammar;
\&
\&  my $st = $grammar\->structure("GEDCOM");
\&  my @sgr = $grammar\->item("DATE");
\&  my @items = $grammar\->valid_items;
\&  my $min = $grammar\->min;
\&  my $max = $grammar\->max;
\&  my @items = $grammar\->items;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A selection of subroutines to handle the grammar of a \s-1GEDCOM\s0 file.
.PP
Derived from Gedcom::Item.
.SH "HASH MEMBERS"
.IX Header "HASH MEMBERS"
Some of the more important hash members are:
.ie n .SS "$grammar\->{top}"
.el .SS "\f(CW$grammar\fP\->{top}"
.IX Subsection "$grammar->{top}"
The top of the grammar tree.
.ie n .SS "$grammar\->{top}{structures}"
.el .SS "\f(CW$grammar\fP\->{top}{structures}"
.IX Subsection "$grammar->{top}{structures}"
A reference to a hash mapping the names of all structures to the grammar
objects.
.SH "METHODS"
.IX Header "METHODS"
.SS "structures"
.IX Subsection "structures"
.Vb 1
\&  my $st = $grammar\->structure("GEDCOM");
.Ve
.PP
Return the grammar item of the specified structure, if it exists, or undef.
.SS "item"
.IX Subsection "item"
.Vb 1
\&  my @sgr = $grammar\->item("DATE");
.Ve
.PP
Return a list of the possible grammar items of the specified sub-item,
if it exists.
.SS "min"
.IX Subsection "min"
.Vb 1
\&  my $min = $grammar\->min;
.Ve
.PP
Return the minimum permissible number of \f(CW$grammar\fR items
.SS "max"
.IX Subsection "max"
.Vb 1
\&  my $max = $grammar\->max;
.Ve
.PP
Return the maximum permissible number of \f(CW$grammar\fR items
.SS "items"
.IX Subsection "items"
.Vb 1
\&  my @items = $grammar\->items;
.Ve
.PP
Return a list of tags of the grammar's sub-items
.SS "valid_items"
.IX Subsection "valid_items"
.Vb 1
\&  my @items = $grammar\->valid_items;
.Ve
.PP
Return a hash detailing all the valid sub-items of the grammar item.
The key is the tag of the sub-item and the value is an array of hashes
with three members:
.PP
.Vb 3
\&  grammar => the sub\-item grammar
\&  min     => the minimum permissible number of these sub\-items
\&  max     => the maximum permissible number of these sub\-items
.Ve