forest(3pm) [debian man page]

Forest(3pm)						User Contributed Perl Documentation					       Forest(3pm)

NAME

       Forest - A collection of n-ary tree related modules

DESCRIPTION

       Forest is intended to be a replacement for the Tree::Simple family of modules, and fixes many of the issues that have always bothered me
       about them. It is by no means a complete replacement yet, but should eventually grow to become that.

       For more information please refer to the individual module documentation, starting with Forest::Tree.

TODO

       More documentation
	   This is 0.09 so it is (still) lacking quite a bit of docs (I am being really lazy sorry).  Although I invite people to read the source,
	   it is quite simple really.

       More tests
	   The coverage is in the low 90s, but there is still a lot of behavioral stuff that could use some testing too.

SEE ALSO

       Tree::Simple
	   I wrote this module a few years ago and I had served me well, but recently I find myself getting frustrated with some of the uglier
	   bits of this module. So Forest is a re-write of this module.

       Tree
	   This is an ambitious project to replace all the Tree related modules with a single core implementation. There is some good code in
	   here, but the project seems to be very much on the back-burner at this time.

       OCaml port of Forest
	   Ask me about the OCaml port of this module, it is also sitting on my hard drive waiting for release. It actually helped quite a bit in
	   terms of helping me settle on the APIs for this module. Static typing can be very helpful sometimes.

BUGS

       All complex software has bugs lurking in it, and this module is no exception. If you find a bug please either email me, or add the bug to
       cpan-RT.

AUTHOR

       Stevan Little <stevan.little@iinteractive.com>

       With contributions from:

       Yuval (nothingmuch) Kogman

       Guillermo (groditi) Roditi

       Florian (rafl) Ragwitz

COPYRIGHT AND LICENSE

       Copyright 2008-2010 Infinity Interactive, Inc.

       <http://www.iinteractive.com>

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.10.1							    2010-10-24							       Forest(3pm)

Tree::Simple::Visitor::ToNestedHash(3pm)		User Contributed Perl Documentation		  Tree::Simple::Visitor::ToNestedHash(3pm)

NAME

       Tree::Simple::Visitor::ToNestedHash - A Visitor for creating nested hash trees from Tree::Simple objects.

SYNOPSIS

	 use Tree::Simple::Visitor::ToNestedHash;

	 my $visitor = Tree::Simple::Visitor::ToNestedHash->new();

	 # given this Tree::Simple tree
	 my $tree = Tree::Simple->new("Root")
		       ->addChildren(
			   Tree::Simple->new("Child1")
			       ->addChildren(
				   Tree::Simple->new("GrandChild1"),
				   Tree::Simple->new("GrandChild2")
			       ),
			   Tree::Simple->new("Child2"),
		       );

	 $tree->accept($visitor);

	 my $array_tree = $visitor->getResults();

	 # this then creates the equivalent nested array tree:
	 # {
	 # Root => {
	 #	   Child1 => {
	 #		   GrandChild1 => {},
	 #		   GrandChild2 => {}
	 #		   },
	 #	   Child2 => {}
	 #	   }
	 # }

DESCRIPTION

       Given a tree constructed from a Tree::Simple heirarchy, this Visitor will create the equivalent tree of nested hashes.

METHODS

       new There are no arguments to the constructor the object will be in its default state. You can use the "setNodeFilter" and "includTrunk"
	   methods to customize its behavior.

       includTrunk ($boolean)
	   Setting the $boolean value to true(1) will cause the node value of the tree's root to be included in the nested hash output, setting
	   it to false will do the opposite.

       setNodeFilter ($filter_function)
	   This method accepts a CODE reference as its $filter_function 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 placed into the hash tree. The $filter_function is passed a Tree::Simple object,
	   and is expected to return the value desired for inclusion into the hash tree.

       visit ($tree)
	   This is the method that is used by Tree::Simple's "accept" method. It can also be used on its own, it requires the $tree argument to be
	   a Tree::Simple object (or derived from a Tree::Simple object), and will throw and exception otherwise.

       getResults
	   This method will return the hash tree constructed.

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.

CODE COVERAGE

       See the CODE COVERAGE section in Tree::Simple::VisitorFactory for more inforamtion.

SEE ALSO

       These Visitor classes are all subclasses of Tree::Simple::Visitor, which can be found in the Tree::Simple module, you should refer to that
       module for more information.

AUTHOR

       stevan little, <stevan@iinteractive.com>

COPYRIGHT AND LICENSE

       Copyright 2004, 2005 by Infinity Interactive, Inc.

       <http://www.iinteractive.com>

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.10.1							    2005-07-14				  Tree::Simple::Visitor::ToNestedHash(3pm)