Verilog::Getopt - Get Verilog command line options
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');
Verilog::Getopt provides standardized handling of options similar to Verilog/VCS and cc/GCC.
The new() constructor accepts the following options:
Enable converting filenames to relative filenames when possible. This option is needed when the -F option will be used. If flags are passed through Getopt which should otherwise not be expanded (e.g. "--out myfile.v") having this option set may undesirably expand myfile.v to an absolute filename.
Disable parsing of GCC-like parameters.
Disable parsing of VCS-like parameters.
Create a new Getopt. See OPTIONS above.
Returns a new path to the filename, using the library directories and search paths to resolve the file. Optional lookup_type is 'module', 'include', or 'all', to use only module_dirs, incdirs, or both for the lookup.
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.
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<var>,I<value>) +define+I<var> define (I<var>,undef) +librescan Ignored -F I<file> Parse parameters in file relatively -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<var>,I<value>) -DI<var> define (I<var>,undef) -UI<var> undefine (I<var>) -II<dir> incdir (I<dir>) -F I<file> Parse parameters in file relatively -f I<file> Parse parameters in file all others Put in returned list
Write the output from get_parameters to the specified file.
This method is called when a define is recognized. The default behavior loads a hash that is used to fulfill define references. This function may also be called outside parsing to predefine values.
An optional third argument specifies parameters to the define, and a fourth argument if true indicates the define was set on the command line and should not be removed by `undefineall.
Return sorted list of all define names that currently exist.
This method returns the parameter list of the define. This will be defined, but false, if the define does not have arguments.
This method returns the value of a given define, or prints a warning.
This method returns the value of a given define, or undef.
Returns reference to list of filenames referenced with file_path, useful for creating dependency lists. With argument, adds that file. With list reference argument, sets the list to the argument.
Using the incdir and libext lists, convert the specified module or filename ("foo") to a absolute filename ("include/dir/foo.v").
Return true if the filename is one that generally should be ignored when recursing directories, such as for example, ".", "CVS", and ".svn".
Removes existing environment variables from the provided filename. Any undefined variables are not substituted nor cause errors.
Returns reference to list of include directories. With argument, adds that directory.
Returns reference to list of library extensions. With argument, adds that extension.
Returns true if the passed filename matches the libext.
Returns reference to list of libraries. With argument, adds that library.
Returns reference to list of module directories. With argument, adds that directory.
Return string with any definitions in the token removed.
Deletes a hash element that is used to fulfill define references. This function may also be called outside parsing to erase a predefined value.
Deletes all non-command line definitions, for implementing `undefineall.
Verilog-Perl is part of the http://www.veripool.org/ free Verilog EDA software tool suite. The latest version is available from CPAN and from http://www.veripool.org/verilog-perl.
Copyright 2000-2013 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 Version 3 or the Perl Artistic License Version 2.0.
Wilson Snyder <wsnyder@wsnyder.org>
Verilog-Perl, Verilog::Language = cut
To install Verilog::Std, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Verilog::Std
CPAN shell
perl -MCPAN -e shell install Verilog::Std
For more information on module installation, please visit the detailed CPAN module installation guide.