local-lib5/man/man3/Tree::Simple::Visitor::PathToRoot.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Tree::Simple::Visitor::PathToRoot 3"
 132 .TH Tree::Simple::Visitor::PathToRoot 3 "2005-07-14" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Tree::Simple::Visitor::PathToRoot \- A Visitor for finding the path back a Tree::Simple object's root
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&  use Tree::Simple::Visitor::PathToRoot;
 139 .Ve
 140 .PP
 141 .Vb 2
 142 \&  # create an instance of our visitor
 143 \&  my $visitor = Tree::Simple::Visitor::PathToRoot\->new();
 144 .Ve
 145 .PP
 146 .Vb 2
 147 \&  # pass the visitor to a Tree::Simple object
 148 \&  $tree\->accept($visitor);
 149 .Ve
 150 .PP
 151 .Vb 3
 152 \&  # now get the accumulated path as a string
 153 \&  # with the '/' character as the delimiter
 154 \&  print $visitor\->getPathAsString("/");
 155 .Ve
 156 .PP
 157 .Vb 3
 158 \&  # include the tree's trunk in your
 159 \&  # output as well
 160 \&  $visitor\->includeTrunk();
 161 .Ve
 162 .PP
 163 .Vb 7
 164 \&  # for more complex node objects, you can specify
 165 \&  # a node filter which will be used to extract the
 166 \&  # information desired from each node
 167 \&  $visitor\->setNodeFilter(sub {
 168 \&                my ($t) = @_;
 169 \&                return $t\->getNodeValue()\->description();
 170 \&                });
 171 .Ve
 172 .PP
 173 .Vb 2
 174 \&  # you can also get the path back as an array
 175 \&  my @path = $visitor\->getPath();
 176 .Ve
 177 .SH "DESCRIPTION"
 178 .IX Header "DESCRIPTION"
 179 Given a Tree::Simple object, this Visitor will find the path back to the tree's root node.
 180 .SH "METHODS"
 181 .IX Header "METHODS"
 182 .IP "\fBnew\fR" 4
 183 .IX Item "new"
 184 There are no arguments to the constructor the object will be in its default state. You can use the \f(CW\*(C`includeTrunk\*(C'\fR and \f(CW\*(C`setNodeFilter\*(C'\fR methods to customize its behavior.
 185 .IP "\fBincludeTrunk ($boolean)\fR" 4
 186 .IX Item "includeTrunk ($boolean)"
 187 Based upon the value of \f(CW$boolean\fR, this will tell the visitor to collect the trunk of the tree as well.
 188 .IP "\fBsetNodeFilter ($filter_function)\fR" 4
 189 .IX Item "setNodeFilter ($filter_function)"
 190 This method accepts a \s-1CODE\s0 reference as its \f(CW$filter_function\fR argument and throws an exception if it is not a code reference. This code reference is used to filter the tree nodes as they are collected. This can be used to customize output, or to gather specific information from a more complex tree node. The filter function should accept a single argument, which is the current Tree::Simple object.
 191 .IP "\fBvisit ($tree)\fR" 4
 192 .IX Item "visit ($tree)"
 193 This is the method that is used by Tree::Simple's \f(CW\*(C`accept\*(C'\fR method. It can also be used on its own, it requires the \f(CW$tree\fR argument to be a Tree::Simple object (or derived from a Tree::Simple object), and will throw and exception otherwise.
 194 .IP "\fBgetPath\fR" 4
 195 .IX Item "getPath"
 196 This will return the collected path as an array, or in scalar context, as an array reference.
 197 .IP "\fBgetPathAsString ($delimiter)\fR" 4
 198 .IX Item "getPathAsString ($delimiter)"
 199 This will return the collected path as a string with the path elements joined by a \f(CW$delimiter\fR. If no \f(CW$delimiter\fR is specified, the default (', ') will be used.
 200 .SH "BUGS"
 201 .IX Header "BUGS"
 202 None that I am aware of. Of course, if you find a bug, let me know, and I will be sure to fix it.
 203 .SH "CODE COVERAGE"
 204 .IX Header "CODE COVERAGE"
 205 See the \fB\s-1CODE\s0 \s-1COVERAGE\s0\fR section in Tree::Simple::VisitorFactory for more inforamtion.
 206 .SH "SEE ALSO"
 207 .IX Header "SEE ALSO"
 208 These Visitor classes are all subclasses of \fBTree::Simple::Visitor\fR, which can be found in the \fBTree::Simple\fR module, you should refer to that module for more information.
 209 .SH "AUTHOR"
 210 .IX Header "AUTHOR"
 211 stevan little, <stevan@iinteractive.com>
 212 .SH "COPYRIGHT AND LICENSE"
 213 .IX Header "COPYRIGHT AND LICENSE"
 214 Copyright 2004, 2005 by Infinity Interactive, Inc.
 215 .PP
 216 <http://www.iinteractive.com>
 217 .PP
 218 This library is free software; you can redistribute it and/or modify
 219 it under the same terms as Perl itself.