NAME
Verilog::Getopt - Get Verilog command line options
SYNOPSIS
use Verilog::Getopt;
my $opt = new Verilog::Getopt;
$opt->parameter (qw( +incdir+standard_include_directory ));
@ARGV = $opt->parameter (@ARGV);
...
print "Path to foo.v is ", $opt->file_path('foo.v');
DESCRIPTION
The Verilog::Getopt
package provides standardized handling of options similar to Verilog/VCS and cc/GCC.
- $opt = Verilog::Getopt->new ( opts )
-
Create a new Getopt. If gcc_style=>0 is passed as a parameter, parsing of GCC-like parameters is disabled. If vcs_style=>0 is passed as a parameter, parsing of VCS-like parameters is disabled.
- $self->file_path ( filename )
-
Returns a new path to the filename, using the library directories and search paths to resolve the file.
- $self->get_parameter ( )
-
Returns a list of parameters that when passed through $self->parameter() should result in the same state. Often this is used to form command lines for downstream programs that also use Verilog::Getopt.
- $self->parameter ( \@params )
-
Parses any recognized parameters in the referenced array, removing the standard parameters and returning a array with all unparsed parameters.
The below list shows the VCS-like parameters that are supported, and the functions that are called:
+libext+I<ext>+I<ext>... libext (I<ext>) +incdir+I<dir> incdir (I<dir>) +define+I<var>+I<value> define (I<val>,I<value>) +define+I<var> define (I<val>,undef) -f I<file> Parse parameters in file -v I<file> library (I<file>) -y I<dir> module_dir (I<dir>) all others Put in returned list
The below list shows the GCC-like parameters that are supported, and the functions that are called:
-DI<var>=I<value> define (I<val>,I<value>) -DI<var> define (I<val>,undef) -II<dir> incdir (I<dir>) -f I<file> Parse parameters in file all others Put in returned list
ACCESSORS
- $self->define ( $token, $value )
-
This method is called when a define is recognized. The default behavior loads a hash that is used to fufill define references. This fuction may also be called outside parsing to predefine values.
- $self->defvalue ( $token )
-
This method returns the value of a given define, or undef.
- $self->depend_files ()
-
Returns reference to list of filenames referenced with file_path, useful for creating dependancy lists. With argument, adds that file. With list reference argument, sets the list to the argument.
- $self->incdir ()
-
Returns reference to list of include directories. With argument, adds that directory.
- $self->libext ()
-
Returns reference to list of library extensions. With argument, adds that extension.
- $self->library ()
-
Returns reference to list of libraries. With argument, adds that library.
- $self->module_dir ()
-
Returns reference to list of module directories. With argument, adds that directory.
- $self->undef ( $token )
-
Deletes a hash element that is used to fufill define references. This fuction may also be called outside parsing to erase a predefined value.
SEE ALSO
Verilog::Language
,
DISTRIBUTION
The latest version is available from CPAN or http://veripool.com/verilog-perl
.
AUTHORS
Wilson Snyder <wsnyder@wsnyder.org>