• NAME
• DESCRIPTION
• METHODS
  • new
  • local_c
  • global_c
  • local_declaration
• COPYRIGHT AND LICENSE

NAME

Clownfish::Variable - A Clownfish 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 = Clownfish::Variable->new(
        parcel      => 'Crustacean',
        type        => $int32_t_type,            # required
        micro_sym   => 'average_lifespan',       # required
        exposure    => 'parcel',                 # default: 'local'
        class_name  => "Crustacean::Lobster",    # default: undef
        class_cnick => "Lobster",                # default: undef
    );

• type - A Clownfish::Type.

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

• exposure - See Clownfish::Symbol.

• class_name - See Clownfish::Symbol.

• class_cnick - See Clownfish::Symbol.

local_c

    # e.g. "int32_t average_lifespan"
    print $variable->local_c;

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

global_c

    # e.g. "int32_t crust_Lobster_average_lifespan"
    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. "int32_t average_lifespan;"
    print $variable->local_declaration;

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

COPYRIGHT AND LICENSE

Copyright 2008-2011 Marvin Humphrey

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