Ton Hospel > Graph-Layout-Aesthetic > Graph::Layout::Aesthetic::Include

Download:
Graph-Layout-Aesthetic-0.12.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 0.02   Source  

NAME ^

Graph::Layout::Aesthetic::Include - Include files that were used to build Graph::Layout::Aesthetic

SYNOPSIS ^

  # This module is normally used in the Makefile.PL for new packages in
  # the Graph::Layout::Aesthetic group.
  use Graph::Layout::Aesthetic::Includes;
  @list = Graph::Layout::Aesthetic::Include::list;
  Graph::Layout::Aesthetic::Include::write_file($name);
  Graph::Layout::Aesthetic::Include::write_files;

DESCRIPTION ^

This modules contains the include files and typemap that were used to compile Graph::Layout::Aesthetic. It's not supposed to be used in user program, but is meant for people writing new Graph::Layout::Aesthetic XS packages (in particualr new Graph::Layout::Aesthetic::Force packages). These people will need to compile C-code and link with the existing libraries, which means they should use the same assumptions about data structures as the original code.

The files inside this module are put there by the gen_include program.

METHODS ^

@list = Graph::Layout::Aesthetic::Include::list

Returns the list of all filenames available in this module. Filenames will be relative, but may contain directory parts. A typical example would be include/aglo.h.

Graph::Layout::Aesthetic::Include::write_file($name)

Creates and writes the proper contents of the file $name relative to the current directory. Any non-existing but needed subdirectories are created first. $name must be one of the names returned by list. Throws an exception in case of error.

Graph::Layout::Aesthetic::Include::write_files

Writes out all files available in this module. Basically equal to:

    Graph::Layout::Aesthetic::Include::write_file($_) for
        Graph::Layout::Aesthetic::Include::list;

EXPORT ^

None.

SEE ALSO ^

Graph::Layout::Aesthetic, Graph::Layout::Aesthetic::Force,

AUTHOR ^

Ton Hospel, <Graph-Layout-Aesthetic@ton.iguana.be>

COPYRIGHT AND LICENSE ^

Copyright (C) 2004 by Ton Hospel

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.6.1 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: