local-lib5/man/man3/Tree::Simple::Visitor::CreateDirectoryTree.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::CreateDirectoryTree 3"
 132 .TH Tree::Simple::Visitor::CreateDirectoryTree 3 "2005-07-14" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Tree::Simple::Visitor::CreateDirectoryTree \- A Visitor for create a set of directories and files from a Tree::Simple object
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&  use Tree::Simple::Visitor::CreateDirectoryTree;
 139 .Ve
 140 .PP
 141 .Vb 17
 142 \&  # create a Tree::Simple object which
 143 \&  # represents a directory heirarchy
 144 \&  my $tree = Tree::Simple\->new("www/")
 145 \&                    \->addChildren(
 146 \&                        Tree::Simple\->new("conf/")
 147 \&                            \->addChildren(
 148 \&                                Tree::Simple\->new("startup.pl"),
 149 \&                                Tree::Simple\->new("httpd.conf")
 150 \&                            ),
 151 \&                        Tree::Simple\->new("cgi\-bin/"),
 152 \&                        Tree::Simple\->new("ht_docs/"),
 153 \&                        Tree::Simple\->new("logs/")
 154 \&                            \->addChildren(
 155 \&                                Tree::Simple\->new("error.log"),
 156 \&                                Tree::Simple\->new("access.log")
 157 \&                            ),
 158 \&                    );
 159 .Ve
 160 .PP
 161 .Vb 2
 162 \&  # create an instance of our visitor
 163 \&  my $visitor = Tree::Simple::Visitor::CreateDirectoryTree\->new();
 164 .Ve
 165 .PP
 166 .Vb 2
 167 \&  # pass the visitor to a Tree::Simple object
 168 \&  $tree\->accept($visitor);
 169 .Ve
 170 .PP
 171 .Vb 1
 172 \&  # the www/ directory now mirrors the structure of the tree
 173 .Ve
 174 .SH "DESCRIPTION"
 175 .IX Header "DESCRIPTION"
 176 This visitor can be used to create a set of directories and files from a Tree::Simple object hierarchy.
 177 .SH "METHODS"
 178 .IX Header "METHODS"
 179 .IP "\fBnew\fR" 4
 180 .IX Item "new"
 181 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, \f(CW\*(C`setFileHandler\*(C'\fR and \f(CW\*(C`setDirectoryHandler\*(C'\fR methods to customize its behavior.
 182 .IP "\fBsetNodeFilter ($filter_function)\fR" 4
 183 .IX Item "setNodeFilter ($filter_function)"
 184 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 used to create the directory tree, it can be basically used as a node pre\-processor. An example usage of this might be to enforce the \f(CW8.3\fR naming rules of \s-1DOS\s0, or the 32 character limit of older macintoshes.
 185 .IP "\fBsetFileHandler ($file_handler)\fR" 4
 186 .IX Item "setFileHandler ($file_handler)"
 187 This method accepts a \s-1CODE\s0 reference as its \f(CW$file_handler\fR argument and throws an exception if it is not a \s-1CODE\s0 reference. This method can be used to create custom file creation behavior. The default behavior is to just create the file and nothing else, but by using this method it is possible to implement some other custom behavior, such as creating a file based on a template. The function is passed the full path of the file to be created (as built by File::Spec).
 188 .IP "\fBsetDirectoryHandler ($dir_handler)\fR" 4
 189 .IX Item "setDirectoryHandler ($dir_handler)"
 190 This method accepts a \s-1CODE\s0 reference as its \f(CW$dir_handler\fR argument and throws an exception if it is not a \s-1CODE\s0 reference. This method can be used to create custom directory creation behavior. The default behavior is to just create the directory and nothing else, but by using this method it is possible to implement some other custom behavior, such as creating a directory on a remote server. The function is passed the full path of the directory to be created (as built by File::Spec).
 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 .Sp
 195 The tree is processed as follows:
 196 .RS 4
 197 .IP "Any node which is not a leaf is considered a directory." 4
 198 .IX Item "Any node which is not a leaf is considered a directory."
 199 Obviously since files themselves are leaf nodes, this makes sense that non-leaves will be directories.
 200 .ie n .IP "Any node (including leaf nodes) which ends in either the character ""/""\fR or \f(CW""\e"" is considered a directory." 4
 201 .el .IP "Any node (including leaf nodes) which ends in either the character \f(CW/\fR or \f(CW\e\fR is considered a directory." 4
 202 .IX Item "Any node (including leaf nodes) which ends in either the character / or  is considered a directory."
 203 I think it is a pretty standard convention to have directory names ending in a seperator. The seperator itself is stripped off before the directory name is passed to File::Spec where the platform specific directory path is created. This means that it does not matter which one you use, it will be completely cross platform (at least as cross-platform as File::Spec is).
 204 .IP "All other nodes are considered to be files." 4
 205 .IX Item "All other nodes are considered to be files."
 206 .RE
 207 .RS 4
 208 .RE
 209 .SH "BUGS"
 210 .IX Header "BUGS"
 211 None that I am aware of. Of course, if you find a bug, let me know, and I will be sure to fix it.
 212 .SH "CODE COVERAGE"
 213 .IX Header "CODE COVERAGE"
 214 See the \fB\s-1CODE\s0 \s-1COVERAGE\s0\fR section in Tree::Simple::VisitorFactory for more inforamtion.
 215 .SH "SEE ALSO"
 216 .IX Header "SEE ALSO"
 217 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.
 218 .SH "AUTHOR"
 219 .IX Header "AUTHOR"
 220 stevan little, <stevan@iinteractive.com>
 221 .SH "COPYRIGHT AND LICENSE"
 222 .IX Header "COPYRIGHT AND LICENSE"
 223 Copyright 2004, 2005 by Infinity Interactive, Inc.
 224 .PP
 225 <http://www.iinteractive.com>
 226 .PP
 227 This library is free software; you can redistribute it and/or modify
 228 it under the same terms as Perl itself.