local-lib5/man/man3/Tree::Simple::Visitor::LoadDirectoryTree.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::LoadDirectoryTree 3"
 132 .TH Tree::Simple::Visitor::LoadDirectoryTree 3 "2005-07-14" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Tree::Simple::Visitor::LoadDirectoryTree \- A Visitor for loading the contents of a directory into a Tree::Simple object
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&  use Tree::Simple::Visitor::LoadDirectoryTree;
 139 .Ve
 140 .PP
 141 .Vb 3
 142 \&  # create a Tree::Simple object whose
 143 \&  # node is path to a directory
 144 \&  my $tree = Tree::Simple\->new("./");
 145 .Ve
 146 .PP
 147 .Vb 2
 148 \&  # create an instance of our visitor
 149 \&  my $visitor = Tree::Simple::Visitor::LoadDirectoryTree\->new();
 150 .Ve
 151 .PP
 152 .Vb 2
 153 \&  # set the directory sorting style
 154 \&  $visitor\->setSortStyle($visitor\->SORT_FILES_FIRST);
 155 .Ve
 156 .PP
 157 .Vb 7
 158 \&  # create node filter to filter
 159 \&  # out certain files and directories
 160 \&  $visitor\->setNodeFilter(sub {
 161 \&      my ($item) = @_;
 162 \&      return 0 if $item =~ /CVS/;
 163 \&      return 1;
 164 \&  });
 165 .Ve
 166 .PP
 167 .Vb 2
 168 \&  # pass the visitor to a Tree::Simple object
 169 \&  $tree\->accept($visitor);
 170 .Ve
 171 .PP
 172 .Vb 1
 173 \&  # the tree now mirrors the structure of the directory
 174 .Ve
 175 .SH "DESCRIPTION"
 176 .IX Header "DESCRIPTION"
 177 This visitor can be used to load a directory tree into a Tree::Simple hierarchy.
 178 .SH "METHODS"
 179 .IX Header "METHODS"
 180 .IP "\fBnew\fR" 4
 181 .IX Item "new"
 182 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 and \f(CW\*(C`setSortStyle\*(C'\fR methods to customize its behavior.
 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 function is given the current directory or file being added to the tree, and it is expected to return either true (\f(CW1\fR) of false (\f(CW0\fR) to determine if that directory should be traversed or file added to the tree.
 186 .IP "\fBsetSortStyle ($sort_function)\fR" 4
 187 .IX Item "setSortStyle ($sort_function)"
 188 This method accepts a \s-1CODE\s0 reference as its \f(CW$sort_function\fR argument and throws an exception if it is not a code reference. This function is used to sort the individual levels of the directory tree right before it is added to the tree being built. The function is passed the the current path, followed by the two items being sorted. The reason for passing the path in is so that sorting operations can be performed on the entire path if desired.
 189 .Sp
 190 Two pre-built functions are supplied and described below.
 191 .RS 4
 192 .IP "\fB\s-1SORT_FILES_FIRST\s0\fR" 4
 193 .IX Item "SORT_FILES_FIRST"
 194 This sorting function will sort files before directories, so that files are sorted alphabetically first in the list followed by directories sorted alphabetically. Here is example of how that would look:
 195 .Sp
 196 .Vb 7
 197 \&    Tree/
 198 \&        Simple.pm
 199 \&        Simple/
 200 \&            Visitor.pm
 201 \&            VisitorFactory.pm
 202 \&            Visitor/
 203 \&                PathToRoot.pm
 204 .Ve
 205 .IP "\fB\s-1SORT_DIRS_FIRST\s0\fR" 4
 206 .IX Item "SORT_DIRS_FIRST"
 207 This sorting function will sort directories before files, so that directories are sorted alphabetically first in the list followed by files sorted alphabetically. Here is example of how that would look:
 208 .Sp
 209 .Vb 7
 210 \&    Tree/
 211 \&        Simple/
 212 \&            Visitor/
 213 \&                PathToRoot.pm
 214 \&            Visitor.pm
 215 \&            VisitorFactory.pm
 216 \&        Simple.pm
 217 .Ve
 218 .RE
 219 .RS 4
 220 .RE
 221 .IP "\fBvisit ($tree)\fR" 4
 222 .IX Item "visit ($tree)"
 223 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.
 224 .Sp
 225 The node value of the \f(CW$tree\fR argument (gotten by calling \f(CW\*(C`getNodeValue\*(C'\fR) is considered the root directory from which we begin our traversal. We use File::Spec to keep our paths cross\-platform, but it is expected that you will feed in a valid path for your \s-1OS\s0. If the path either does not exist, or is not a directory, then an exception is thrown.
 226 .Sp
 227 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.
 228 .SH "BUGS"
 229 .IX Header "BUGS"
 230 None that I am aware of. Of course, if you find a bug, let me know, and I will be sure to fix it.
 231 .SH "CODE COVERAGE"
 232 .IX Header "CODE COVERAGE"
 233 See the \fB\s-1CODE\s0 \s-1COVERAGE\s0\fR section in Tree::Simple::VisitorFactory for more inforamtion.
 234 .SH "SEE ALSO"
 235 .IX Header "SEE ALSO"
 236 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.
 237 .SH "AUTHOR"
 238 .IX Header "AUTHOR"
 239 stevan little, <stevan@iinteractive.com>
 240 .SH "COPYRIGHT AND LICENSE"
 241 .IX Header "COPYRIGHT AND LICENSE"
 242 Copyright 2004, 2005 by Infinity Interactive, Inc.
 243 .PP
 244 <http://www.iinteractive.com>
 245 .PP
 246 This library is free software; you can redistribute it and/or modify
 247 it under the same terms as Perl itself.