Getopt(3)

📦
version 3.482 · 8 versions
, in fedora 43

💅 Getopt(3) — Verilog::Getopt, but make it make sense

okay so bestie, you know how I'm always going on about the Verilog-Perl suite? yeah. this is the manual page for Verilog::Getopt, and no, it's not literally the C getopt(3) — it's the Perl one that speaks Verilog tooling. it ships as part of the perl v5.42.0 docs, and we'll get to the whole source/version/date thing at the end, mwah 🎀

✨ NAME ✨

Verilog::Getopt — the one that gets your Verilog command line options. yes. that's the whole bit. 💖

🌸 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');

like, look at her go. she's literally parsing arbitrary Verilog args and telling you where foo.v lives. icon behavior.

🦋 DESCRIPTION 🦋

Verilog::Getopt gives you standardized handling of options — in the same flavor as Verilog/VCS and cc/GCC. so if you already know how those tools munch on flags, you already get the vibe here. no cap. 🫶

🎀 OPTIONS 🎀

the new() constructor is where you get to be picky. these are the little knobs it accepts:

  • filename_expansion=>1 — turns filenames into relative filenames when it can, which is 👑 chef's kiss 👑. you're gonna want this on when you're using the -F option, fr fr. BUT 💀 heads up: if you pass flags through Getopt that shouldn't get expanded (think "--out myfile.v"), then having this on might undesirably expand myfile.v into an absolute filename. like, not ideal, bestie.
  • gcc_style=>0 — turn this off and parsing of GCC-like parameters is a no-go. 🚫
  • vcs_style=>0 — same energy, but for VCS-like parameters. off = deprecated vibes for that syntax. (just kidding, it just disables it 😌)

🧚 METHODS 🧚

$opt = Verilog::Getopt->new ( opts )

make a whole new Getopt. the opts? that's the OPTIONS section up there — peek at it, bestie. ⬆️

$self->file_path(filename, [lookup_type])

hands you a new path to filename, using the library directories and search paths to figure out where that file actually lives. 🌈

that optional lookup_type? it's 'module', 'include', or 'all' — pick module to only use module_dirs, include for just incdirs, or all for both. choose your fighter 💅

$self->get_parameters()

returns a list of parameters that, when passed back through $self->parameter(), lands you in the exact same state. literally a round trip. 🔁

people use this all the time to build command lines for downstream programs that also use Verilog::Getopt. it's giving teamwork.

$self->parameter(\@params)

this is the main character right here 👑. it parses any recognized parameters in the referenced array, removes the standard parameters from any previous parameters() call, and returns an array with all the unparsed parameters. slay.

the VCS-like parameters it supports (and what gets 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

and the GCC-like parameters 💖

-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

note the all others line in both — anything not recognized just gets put in the returned list like it's no big deal. 🦋

$self->write_parameters_file(filename)

writes the output from get_parameters straight into the specified file. it's giving "save your work, bestie." 💾

⭐ ACCESSORS ⭐

$self->define($token, $value)

called whenever a define gets recognized. by default it loads a hash that's used to fulfill define references — but you can also call it outside parsing to predefine values. 🔥

there's an optional third argument that specifies parameters to the define, and a fourth argument — if true, it means the define was set on the command line and should not be removed by `undefineall. important detail, don't skip it 🫶

$self->define_names_sorted

returns a sorted list of every define name that currently exists. alphabetized. tidy. iconic. ✨

$self->defparams($token)

returns the parameter list of the define. ngl this one's a little cursed — it will be defined, but false, if the define doesn't have arguments. like, she exists but she's also not there. 🙈

$self->defvalue($token)

returns the value of a given define… or prints a warning 😭 (so, you know, handle that)

$self->defvalue_nowarn($token)

same deal but no warning — returns the value of the given define, or undef. 😌

$self->depend_files()

returns a reference to the list of filenames referenced with file_path — super useful for building dependency lists 🧾

  • with an argument → adds that file
  • with a list reference argument → sets the list to the argument

$self->file_abs($filename)

uses the incdir and libext lists to convert a module or filename ("foo") into an absolute filename ("include/dir/foo.v"). glow up from relative bee to queen bee 👑

$self->file_skip_special($filename)

returns true if the filename is one of those "should generally be ignored when recursing directories" situations — like for example ".", "CVS", and ".svn". bye girl, you're not a real file 💀

$self->file_substitute($filename)

strips existing environment variables out of the provided filename. any undefined variables just stay as-is — no substitution, no errors, no drama. 🌸

$self->incdir

returns a reference to the list of include directories. pass an argument and it adds that directory. easy.

$self->includes

returns a reference to a hash of files that included some file — and each hash value is a list of the files that were included. 🫶

lowkey important: this is only relevant after Verilog::Netlist processing.

with two arguments → adds an include, from the given referencing filename to the given include filename.

$self->libext

returns a reference to the list of library extensions. with an argument, adds that extension. 🎀

$self->libext_matches(filename)

returns true if the filename you passed matches the libext. vibe check: passed ✅

$self->library

returns a reference to the list of libraries. with an argument, adds that library. 📚

$self->module_dir

returns a reference to the list of module directories. with an argument, adds that directory. 🗂️

$self->remove_defines($token)

returns a string with any definitions in the token removed. poof. gone. 🫧

$self->undef($token)

deletes a hash element used to fulfill define references. you can also call this outside parsing to erase a predefined value. so like, off with their head 💅

$self->undefineall

deletes all non-command-line definitions — this is what makes `undefineall actually work. command-line ones survive. periodt. 🫶

💜 DISTRIBUTION 💜

Verilog-Perl is part of the <https://www.veripool.org/> free Verilog EDA software tool suite — yes, the whole suite, obsessed 🧚

the latest version is available from CPAN and from <https://www.veripool.org/verilog-perl>.

Copyright 2000-2024 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. pick your license, bestie. 💖

🌟 AUTHORS 🌟

Wilson Snyder <wsnyder@wsnyder.org> — the icon who made this happen 👑

👀 SEE ALSO 👀

Verilog-Perl, Verilog::Language

okay and for the little sign-off — this page is from the perl v5.42.0 docs, the User Contributed Perl Documentation flavor of Getopt(3), dated 2025-07-25. ✨ that's the version and the date, all wrapped up in a bow 🎀 stay parsing, bestie 💖

📦 where this page comes from