NAME
SystemC::Vregs - Utility routines used by vregs
SYNOPSIS
use SystemC::Vregs;DESCRIPTION
A Vregs object contains a documentation "package" containing enumerations, definitions, classes, and registers.
METHODS
See also SystemC::Vregs::Outputs for details on functions that write out various header files.
- new
-
Creates a new Vregs package object and returns a reference to it. The name of the package should be passed as a "name" named parameter, likewise the number of address bits should be passed as address_bits.
- check
-
Checks the object for errors, and parses the object to create some derived fields.
- defines_sorted
-
Returns list of SystemC::Vregs::Define objects.
- enums_sorted
-
Returns list of SystemC::Vregs::Enum objects.
- exit_if_error
-
Exits if any errors were detected by check().
- find_define
-
Returns SystemC::Vregs::Define object with a name matching the passed parameter, or undef if not found.
- find_enum
-
Returns SystemC::Vregs::Enum object with a name matching the passed parameter, or undef if not found.
- find_type
-
Returns SystemC::Vregs::Type object with a name matching the passed parameter, or undef if not found.
- find_type_regexp
-
Returns list of SystemC::Vregs::Type objects with a name matching the passed wildcard, or undef if not found.
- html_read
-
Reads the specified HTML filename, and creates internal objects.
- regs_read
-
Reads the specified .vregs filename, and creates internal objects.
- regs_read_check
-
Calls the normal sequence of commands to read a known-good vregs file; regs_read, check, and exit_if_error.
- regs_write
-
Creates the specified .vregs filename.
- types_sorted
-
Returns list of SystemC::Vregs::Type objects.
DISTRIBUTION
The latest version is available from CPAN and from http://www.veripool.com/.
Copyright 2001-2005 by Wilson Snyder. This package is free software; you can redistribute it and/or modify it under the terms of either the GNU Lesser General Public License or the Perl Artistic License.
AUTHORS
Wilson Snyder <wsnyder@wsnyder.org>
SEE ALSO
Low level objects:
SystemC::Vregs::Bit, SystemC::Vregs::Define, SystemC::Vregs::Enum, SystemC::Vregs::Language, SystemC::Vregs::Number, SystemC::Vregs::OutputNamed SystemC::Vregs::Outputs SystemC::Vregs::Register, SystemC::Vregs::Subclass, SystemC::Vregs::TableExtract, SystemC::Vregs::Type