-
-
16 Apr 2012 21:20:13 UTC
- Distribution: KinoSearch
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (5)
- Testers (536 / 132 / 8)
- Kwalitee
Bus factor: 0- 85.27% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (852.87KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- Marvin Humphrey <marvin at rectangular dot com>
- Dependencies
- JSON::XS
- Lingua::Stem::Snowball
- Lingua::StopWords
- Parse::RecDescent
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Clownfish::Parcel - Collection of code.
DESCRIPTION
A Parcel is a cohesive collection of code, which could, in theory, be published as as a single entity.
Clownfish supports two-tier manual namespacing, using a prefix, an optional class nickname, and the local symbol:
prefix_ClassNick_local_symbol
Clownfish::Parcel supports the first tier, specifying initial prefixes. These prefixes come in three capitalization variants: prefix_, Prefix_, and PREFIX_.
CLASS METHODS
singleton
Clownfish::Parcel->singleton( name => 'Crustacean', cnick => 'Crust', );
Add a Parcel singleton to a global registry. May be called multiple times, but only with compatible arguments.
name - The name of the parcel.
cnick - The C nickname for the parcel, which will be used as a prefix for generated global symbols. Must be mixed case and start with a capital letter. Defaults to
name
.
default_parcel
$parcel ||= Clownfish::Parcel->default_parcel;
Return the singleton for default parcel, which has no prefix.
OBJECT METHODS
get_prefix get_Prefix get_PREFIX
Return one of the three capitalization variants for the parcel's prefix.
get_name get_cnick
Accessors.
COPYRIGHT AND LICENSE
Copyright 2006-2011 Marvin Humphrey
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Module Install Instructions
To install KSx::Simple, copy and paste the appropriate command in to your terminal.
cpanm KSx::Simple
perl -MCPAN -e shell install KSx::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.