NAME

Boilerplater::Variable - A Boilerplater variable.

DESCRIPTION

A variable, having a Type, a micro_sym (i.e. name), an exposure, and optionally, a location in the global namespace hierarchy.

Variable objects which exist only within a local scope, e.g. those within parameter lists, do not need to know about class. In contrast, inert class vars, for example, need to know class information so that they can declare themselves properly.

METHODS

new

my $var = Boilerplater::Variable->new(
    parcel      => 'Boil',
    type        => $type,    # required
    micro_sym   => 'foo',    # required
    exposure    => undef,    # default: 'local'
    class_name  => "Foo",    # default: undef
    class_cnick => "Foo",    # default: undef
);

• type - A Boilerplater::Type.

• micro_sym - The variable's name, without any namespacing prefixes.

• exposure - See Boilerplater::Symbol.

• class_name - See Boilerplater::Symbol.

• class_cnick - See Boilerplater::Symbol.

local_c

# e.g. "boil_Foo *foo"
print $variable->local_c;

Returns a string with the Variable's C type and its micro_sym.

global_c

# e.g. "boil_Foo *boil_Foo_foo"
print $variable->global_c;

Returns a string with the Variable's C type and its fully qualified name within the global namespace.

local_declaration

# e.g. "boil_Foo *foo;"
print $variable->local_declaration;

Returns C code appropriate for declaring the variable in a local scope, such as within a C parameter list or struct definition, or as an automatic variable within a C function.

COPYRIGHT AND LICENSE

Copyright 2008-2009 Marvin Humphrey

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