local-lib5/man/man3/Tree::Simple::Visitor::LoadClassHierarchy.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::LoadClassHierarchy 3"
 132 .TH Tree::Simple::Visitor::LoadClassHierarchy 3 "2005-07-14" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Tree::Simple::Visitor::LoadClassHierarchy \- A Visitor for loading class hierarchies into a Tree::Simple hierarchy
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&  use Tree::Simple::Visitor::LoadClassHierarchy;
 139 .Ve
 140 .PP
 141 .Vb 2
 142 \&  # create an visitor
 143 \&  my $visitor = Tree::Simple::Visitor::LoadClassHierarchy\->new();
 144 .Ve
 145 .PP
 146 .Vb 2
 147 \&  # set class as an instance, or
 148 \&  $visitor\->setClass($class);
 149 .Ve
 150 .PP
 151 .Vb 2
 152 \&  # as a package name
 153 \&  $visitor\->setClass("My::Class");
 154 .Ve
 155 .PP
 156 .Vb 2
 157 \&  # pass our visitor to the tree
 158 \&  $tree\->accept($visitor);
 159 .Ve
 160 .PP
 161 .Vb 1
 162 \&  # the $tree now mirrors the inheritance hierarchy of the $class
 163 .Ve
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 This visitor will traverse a class's inheritance hierarchy (through the \f(CW@ISA\fR arrays) and create a Tree::Simple hierarchy which mirrors it.
 167 .SH "METHODS"
 168 .IX Header "METHODS"
 169 .IP "\fBnew\fR" 4
 170 .IX Item "new"
 171 There are no arguments to the constructor the object will be in its default state. You can use the \f(CW\*(C`setNodeFilter\*(C'\fR method to customize its behavior.
 172 .IP "\fBincludeTrunk ($boolean)\fR" 4
 173 .IX Item "includeTrunk ($boolean)"
 174 Setting the \f(CW$boolean\fR value to true (\f(CW1\fR) will cause the node value of the \f(CW$tree\fR object passed into \f(CW\*(C`visit\*(C'\fR to be set with the root value found in the class heirarchy. Setting it to false (\f(CW0\fR), or not setting it, will result in the first value in the class heirarchy creating a new node level.
 175 .IP "\fBincludeMethods ($boolean)\fR" 4
 176 .IX Item "includeMethods ($boolean)"
 177 Setting the \f(CW$boolean\fR value to true (\f(CW1\fR) will cause methods to be added as a children of the class node. Setting it to false (\f(CW0\fR), or not setting it, will result in this not happening.
 178 .Sp
 179 \&\fB\s-1NOTE:\s0\fR Methods are sorted ascii-betically before they are added to the tree. This allows a more predictable heirarchy.
 180 .IP "\fBsetClass ($class)\fR" 4
 181 .IX Item "setClass ($class)"
 182 The argument \f(CW$class\fR should be either a class name or an instance, it is then used as the root from which to determine the class hierarchy.
 183 .IP "\fBsetNodeFilter ($filter_function)\fR" 4
 184 .IX Item "setNodeFilter ($filter_function)"
 185 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 created, the \f(CW$filter_function\fR is passed the node value extracted from the hash prior to it being inserted into the tree being built. The \f(CW$filter_function\fR is expected to return the value desired for inclusion into the tree.
 186 .IP "\fBvisit ($tree)\fR" 4
 187 .IX Item "visit ($tree)"
 188 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.
 189 .Sp
 190 The \f(CW$tree\fR argument which is passed to \f(CW\*(C`visit\*(C'\fR must be a leaf node. This is because this Visitor will create all the sub-nodes for this tree. If the tree is not a leaf, an exception is thrown. We do not require the tree to be a root though, and this Visitor will not affect any nodes above the \f(CW$tree\fR argument.
 191 .SH "TO DO"
 192 .IX Header "TO DO"
 193 .ie n .IP "Improve the ""includeMethods"" functionality" 4
 194 .el .IP "Improve the \f(CWincludeMethods\fR functionality" 4
 195 .IX Item "Improve the includeMethods functionality"
 196 I am not sure the tree this creates is the optimal tree for this situation. It is sufficient for now, until I have more of an \fIactual\fR need for this functionality.
 197 .ie n .IP "Add ""includeFullSymbolTable"" functionality" 4
 198 .el .IP "Add \f(CWincludeFullSymbolTable\fR functionality" 4
 199 .IX Item "Add includeFullSymbolTable functionality"
 200 This would traverse the full symbol tables and produce a detailed tree of everything it finds. This takes a lot more work, and as I have no current need for it, it remains in the \s-1TO\s0 \s-1DO\s0 list.
 201 .SH "BUGS"
 202 .IX Header "BUGS"
 203 None that I am aware of. Of course, if you find a bug, let me know, and I will be sure to fix it.
 204 .SH "CODE COVERAGE"
 205 .IX Header "CODE COVERAGE"
 206 See the \fB\s-1CODE\s0 \s-1COVERAGE\s0\fR section in Tree::Simple::VisitorFactory for more inforamtion.
 207 .SH "SEE ALSO"
 208 .IX Header "SEE ALSO"
 209 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.
 210 .SH "AUTHOR"
 211 .IX Header "AUTHOR"
 212 stevan little, <stevan@iinteractive.com>
 213 .SH "COPYRIGHT AND LICENSE"
 214 .IX Header "COPYRIGHT AND LICENSE"
 215 Copyright 2004, 2005 by Infinity Interactive, Inc.
 216 .PP
 217 <http://www.iinteractive.com>
 218 .PP
 219 This library is free software; you can redistribute it and/or modify
 220 it under the same terms as Perl itself.