- COPYRIGHT AND LICENSE
Clownfish::File - Structured representation of the contents of a Clownfish source file.
An abstraction representing a file which contains Clownfish code.
my $file_obj = Clownfish::File->new( blocks => \@blocks, # required source_class => 'Crustacean::Lobster', # required parcel => 'Crustacean', # default: special );
blocks - An arrayref. Each element must be either a Clownfish::Class, a Clownfish::Parcel, or a Clownfish::CBlock.
source_class - The class name associated with the source file, regardless of how what classes are defined in the source file. Example: If source_class is "Foo::Bar", that implies that the source file could be found at 'Foo/Bar.bp' within the source directory and that the output C header file should be 'Foo/Bar.h' within the target include directory.
parcel - A Clownfish::Parcel or parcel name.
my @blocks = $file->blocks;
Return all blocks as a list.
my @classes = $file->classes;
Return all Clownfish::Class blocks from the file as a list.
Accessors for the file's "modified" property, which is initially false.
# '/path/to/Source/Class.c', etc. my $c_path = $file->c_path('/path/to'); my $h_path = $file->h_path('/path/to'); my $bp_path = $file->bp_path('/path/to');
Given a base directory, return a path name derived from the File's source_class with the specified extension.
# e.g. "H_CRUSTACEAN_LOBSTER" my $guard_name = $file->guard_name
Return a string used for an include guard in a C header, unique per file.
Return a string opening the include guard.
Return a string closing the include guard. Other classes count on being able to match this string.
Copyright 2008-2010 Marvin Humphrey
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.