--- /dev/null
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.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. | will give a
+.\" real vertical bar. \*(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-|\(bv\*(Tr
+.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" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.\"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "Tree::Simple::Visitor::LoadDirectoryTree 3"
+.TH Tree::Simple::Visitor::LoadDirectoryTree 3 "2005-07-14" "perl v5.8.7" "User Contributed Perl Documentation"
+.SH "NAME"
+Tree::Simple::Visitor::LoadDirectoryTree \- A Visitor for loading the contents of a directory into a Tree::Simple object
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\& use Tree::Simple::Visitor::LoadDirectoryTree;
+.Ve
+.PP
+.Vb 3
+\& # create a Tree::Simple object whose
+\& # node is path to a directory
+\& my $tree = Tree::Simple\->new("./");
+.Ve
+.PP
+.Vb 2
+\& # create an instance of our visitor
+\& my $visitor = Tree::Simple::Visitor::LoadDirectoryTree\->new();
+.Ve
+.PP
+.Vb 2
+\& # set the directory sorting style
+\& $visitor\->setSortStyle($visitor\->SORT_FILES_FIRST);
+.Ve
+.PP
+.Vb 7
+\& # create node filter to filter
+\& # out certain files and directories
+\& $visitor\->setNodeFilter(sub {
+\& my ($item) = @_;
+\& return 0 if $item =~ /CVS/;
+\& return 1;
+\& });
+.Ve
+.PP
+.Vb 2
+\& # pass the visitor to a Tree::Simple object
+\& $tree\->accept($visitor);
+.Ve
+.PP
+.Vb 1
+\& # the tree now mirrors the structure of the directory
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This visitor can be used to load a directory tree into a Tree::Simple hierarchy.
+.SH "METHODS"
+.IX Header "METHODS"
+.IP "\fBnew\fR" 4
+.IX Item "new"
+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.
+.IP "\fBsetNodeFilter ($filter_function)\fR" 4
+.IX Item "setNodeFilter ($filter_function)"
+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.
+.IP "\fBsetSortStyle ($sort_function)\fR" 4
+.IX Item "setSortStyle ($sort_function)"
+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.
+.Sp
+Two pre-built functions are supplied and described below.
+.RS 4
+.IP "\fB\s-1SORT_FILES_FIRST\s0\fR" 4
+.IX Item "SORT_FILES_FIRST"
+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:
+.Sp
+.Vb 7
+\& Tree/
+\& Simple.pm
+\& Simple/
+\& Visitor.pm
+\& VisitorFactory.pm
+\& Visitor/
+\& PathToRoot.pm
+.Ve
+.IP "\fB\s-1SORT_DIRS_FIRST\s0\fR" 4
+.IX Item "SORT_DIRS_FIRST"
+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:
+.Sp
+.Vb 7
+\& Tree/
+\& Simple/
+\& Visitor/
+\& PathToRoot.pm
+\& Visitor.pm
+\& VisitorFactory.pm
+\& Simple.pm
+.Ve
+.RE
+.RS 4
+.RE
+.IP "\fBvisit ($tree)\fR" 4
+.IX Item "visit ($tree)"
+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.
+.Sp
+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.
+.Sp
+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.
+.SH "BUGS"
+.IX Header "BUGS"
+None that I am aware of. Of course, if you find a bug, let me know, and I will be sure to fix it.
+.SH "CODE COVERAGE"
+.IX Header "CODE COVERAGE"
+See the \fB\s-1CODE\s0 \s-1COVERAGE\s0\fR section in Tree::Simple::VisitorFactory for more inforamtion.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+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.
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+stevan little, <stevan@iinteractive.com>
+.SH "COPYRIGHT AND LICENSE"
+.IX Header "COPYRIGHT AND LICENSE"
+Copyright 2004, 2005 by 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.
projects / catagits/Gitalist.git / blobdiff