Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

package::generator(3) [centos man page]

Package::Generator(3)					User Contributed Perl Documentation				     Package::Generator(3)

NAME

       Package::Generator - generate new packages quickly and easily

VERSION

       version 0.103

SYNOPSIS

	   use Package::Generator;

	   my $package = Package::Generator->new_package;
	   ...

DESCRIPTION

       This module lets you quickly and easily construct new packages.	It gives them unused names and sets up their package data, if provided.

INTERFACE

   new_package
	 my $package = Package::Generator->new_package(\%arg);

       This returns the newly generated package.  It can be called with no arguments, in which case it just returns the name of a pristene
       package.  The "base" argument can be provided to generate the package under an existing namespace.  A "make_unique" argument can also be
       provided; it must be a coderef which will be passed the base package name and returns a unique package name under the base name.

       A "data" argument may be passed as a reference to an array of pairs.  These pairs will be used to set up the data in the generated package.
       For example, the following call will create a package with a $foo set to 1 and a @foo set to the first ten counting numbers.

	 my $package = Package::Generator->new_package({
	   data => [
	     foo => 1,
	     foo => [ 1 .. 10 ],
	   ]
	 });

       For convenience, "isa" and "version" arguments may be passed to "new_package".  They will set up @ISA, $VERSION, or &VERSION, as
       appropriate.  If a single scalar value is passed as the "isa" argument, it will be used as the only value to assign to @ISA.  (That is, it
       will not cause $ISA to be assigned;  that wouldn't be very helpful.)

   assign_symbols
	 Package::Generator->assign_symbols($package, @key_value_pairs);

       This routine is used by "new_package" to set up the data in a package.

   package_exists
	 ... if Package::Generator->package_exists($package);

       This method returns true if something has already created a symbol table for the named package.	This is equivalent to:

	 ... if defined *{$package . '::'};

       It's just a little less voodoo-y.

AUTHOR

       Ricardo SIGNES, "<rjbs@cpan.org>"

BUGS

       Please report any bugs or feature requests to "bug-package-generator@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.  I
       will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

COPYRIGHT

       Copyright 2006 Ricardo Signes, all rights reserved.

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

perl v5.16.3							    2009-07-09						     Package::Generator(3)

Check Out this Related Man Page

PPI::Statement::Package(3pm)				User Contributed Perl Documentation			      PPI::Statement::Package(3pm)

NAME

       PPI::Statement::Package - A package statement

INHERITANCE

	 PPI::Statement::Package
	 isa PPI::Statement
	     isa PPI::Node
		 isa PPI::Element

DESCRIPTION

       Most PPI::Statement subclasses are assigned based on the value of the first token or word found in the statement. When PPI encounters a
       statement starting with 'package', it converts it to a "PPI::Statement::Package" object.

       When working with package statements, please remember that packages only exist within their scope, and proper support for scoping has yet
       to be completed in PPI.

       However, if the immediate parent of the package statement is the top level PPI::Document object, then it can be considered to define
       everything found until the next top-level "file scoped" package statement.

       A file may, however, contain nested temporary package, in which case you are mostly on your own :)

METHODS

       "PPI::Statement::Package" has a number of methods in addition to the standard PPI::Statement, PPI::Node and PPI::Element methods.

   namespace
       Most package declarations are simple, and just look something like

	 package Foo::Bar;

       The "namespace" method returns the name of the declared package, in the above case 'Foo::Bar'. It returns this exactly as written and does
       not attempt to clean up or resolve things like ::Foo to main::Foo.

       If the package statement is done any different way, it returns false.

   file_scoped
       Regardless of whether it is named or not, the "file_scoped" method will test to see if the package declaration is a top level "file scoped"
       statement or not, based on its location.

       In general, returns true if it is a "file scoped" package declaration with an immediate parent of the top level Document, or false if not.

       Note that if the PPI DOM tree does not have a PPI::Document object at as the root element, this will return false. Likewise, it will also
       return false if the root element is a PPI::Document::Fragment, as a fragment of a file does not represent a scope.

SUPPORT

       See the support section in the main module.

AUTHOR

       Adam Kennedy <adamk@cpan.org>

COPYRIGHT

       Copyright 2001 - 2011 Adam Kennedy.

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

       The full text of the license can be found in the LICENSE file included with this module.

perl v5.10.1							    2011-02-26					      PPI::Statement::Package(3pm)
Man Page