Gedcom::Grammar(3pm)

📦
version 1.22 · 3 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Gedcom::Grammar 💖

okay bestie, so this is the manual page for Gedcom::Grammar — it lives in section 3pm of the User Contributed Perl Documentation, and it's a whole module for messing with GEDCOM grammars ✨

Version 1.22 - 15th November 2019

✨ NAME ✨

Gedcom::Grammar — a module to manipulate GEDCOM grammars 🦋

Version 1.22 - 15th November 2019

🌸 SYNOPSIS 🌸

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;

💅 DESCRIPTION 💅

It's a lil collection of subroutines that handle the grammar of a GEDCOM file. Lowkey iconic, ngl.

It's derived from Gedcom::Item. 👑

🎀 HASH MEMBERS 🎀

Some of the more important hash members are giving main character energy:

  • $grammar->{top} — the top of the grammar tree 🌳
  • $grammar->{top}{structures} — a reference to a hash that maps the names of all the structures to the grammar objects ✨

🫶 METHODS 🫶

structures

my $st = $grammar->structure("GEDCOM");

Returns the grammar item of the structure you asked for — but like, only if it actually exists, otherwise you get undef. 💀

item

my @sgr = $grammar->item("DATE");

Returns a list of the possible grammar items of the sub-item you specified, if it exists. 👍

min

my $min = $grammar->min;

Returns the minimum permissible number of $grammar items. 🔢

max

my $max = $grammar->max;

Returns the maximum permissible number of $grammar items. 🔢

items

my @items = $grammar->items;

Returns a list of tags of the grammar's sub-items 🏷️

valid_items

my @items = $grammar->valid_items;

Returns 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:

grammar => the sub-item grammar
min     => the minimum permissible number of these sub-items
max     => the maximum permissible number of these sub-items

like… three lil facts per sub-item, no cap. 🌈

sf cute, bestie — that's the whole page 💖 go forth and grammar

this page came to you via perl v5.36.0, dated 2022-10-16, and it's Gedcom::Grammar(3pm). mwah 💅✨

📦 where this page comes from