.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "Forest::Tree::Builder 3pm"
.TH Forest::Tree::Builder 3pm "2021-01-05" "perl v5.32.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"
Forest::Tree::Builder \- An abstract role for bottom up tree reader
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    package MyBuilder;
\&    use Moose;
\&
\&    with qw(Forest::Tree::Builder);
\&
\&    # implement required builder:
\&
\&    sub _build_subtrees {
\&        return [
\&            $self\->create_new_subtree( ... ), # probably a recursive process
\&        ];
\&    }
\&
\&
\&    my $builder = MyBuilder\->new(
\&        tree_class => ...,
\&        ...
\&    );
\&
\&    my $tree = $builder\->tree;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Forest::Tree::Builder replaces Forest::Tree::Loader and
Forest::Tree::Reader with a bottom up construction approach, which is also
suitable for constructing Forest::Tree::Pure derived trees without excessive
cloning.
.PP
It provides a declarative \s-1API\s0 instead of an imperative one, where \f(CW\*(C`tree\*(C'\fR is
lazily constructed on the first use, instead of being constructed immediately
and \*(L"filled in\*(R" by the \f(CW\*(C`load\*(C'\fR method.
.SH "METHODS"
.IX Header "METHODS"
.IP "create_new_subtree" 4
.IX Item "create_new_subtree"
Implemented by Forest::Tree::Constructor
.IP "_build_tree" 4
.IX Item "_build_tree"
Constructs a root node by using the top level \f(CW\*(C`subtrees\*(C'\fR list as the children.
.IP "_build_subtrees" 4
.IX Item "_build_subtrees"
Build the subtrees.
.Sp
Abstract method that should return an array ref of Forest::Tree::Pure derived objects.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Forest::Tree::Builder::SimpleTextFile
.SH "BUGS"
.IX Header "BUGS"
All complex software has bugs lurking in it, and this module is no
exception. If you find a bug please either email me, or add the bug
to cpan-RT.
.SH "AUTHOR"
.IX Header "AUTHOR"
Yuval Kogman
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2008\-2014 Infinity Interactive, Inc.
.PP
<http://www.iinteractive.com>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.