Ron Savage > GraphViz2-Marpa > GraphViz2::Marpa::Utils

Download:
GraphViz2-Marpa-1.13.tgz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.11   Source  

NAME ^

GraphViz2::Marpa::Utils - A Perl lexer and parser for Graphviz dot files

Synopsis ^

See scripts/generate.index.pl, and scripts/dot2lex.pl etc.

Description ^

Some utils to simplify reading CSV files, and testing.

Distributions ^

This module is available as a Unix-style distro (*.tgz).

See http://savage.net.au/Perl-modules/html/installing-a-module.html for help on unpacking and installing distros.

Installation ^

Install GraphViz2::Marpa as you would for any Perl module:

Run:

        cpanm GraphViz2::Marpa

or run:

        sudo cpan GraphViz2::Marpa

or unpack the distro, and then either:

        perl Build.PL
        ./Build
        ./Build test
        sudo ./Build install

or:

        perl Makefile.PL
        make (or dmake or nmake)
        make test
        make install

Constructor and Initialization ^

Calling new()

new() is called as my($obj) = GraphViz2::Marpa::Utils -> new(k1 => v1, k2 => v2, ...).

It returns a new object of type GraphViz2::Marpa::Utils.

Key-value pairs accepted in the parameter list:

o (none)

Methods ^

generate_code_attributes_csv()

Generate data/code.attributes.csv, for conversion into html/code.attributes.html.

generate_code_attributes_index()

Generate html/code.attributes.html.

generate_demo_index()

Generates html/index.html.

Does not run any programs to generate other files, e.g. html/*.svg. See scripts/generate.demo.sh for that.

generate_demo_environment()

Called by generate_demo_index().

Generates a table to be inserted into html/index.html.

See scripts/generate.demo.pl.

generate_stt_index()

Generate html/stt.html.

get_files($dir_name, $type)

Returns a sorted list of files of type (extension) $type from directory $dir_name.

justify($string)

Right justify the $string in a field of 20 spaces.

new()

See "Constructor and Initialization" for details on the parameters accepted by "new()".

Version Numbers ^

Version numbers < 1.00 represent development versions. From 1.00 up, they are production versions.

Machine-Readable Change Log ^

The file CHANGES was converted into Changelog.ini by Module::Metadata::Changes.

Support ^

Email the author, or log a bug on RT:

https://rt.cpan.org/Public/Dist/Display.html?Name=GraphViz2::Marpa.

Author ^

GraphViz2::Marpa was written by Ron Savage <ron@savage.net.au> in 2012.

Home page: http://savage.net.au/index.html.

Copyright ^

Australian copyright (c) 2012, Ron Savage.

        All Programs of mine are 'OSI Certified Open Source Software';
        you can redistribute them and/or modify them under the terms of
        The Artistic License, a copy of which is available at:
        http://www.opensource.org/licenses/index.html
syntax highlighting: