.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Language 3pm"
.TH Language 3pm 2024-01-27 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Verilog::Language \- Verilog language utilities
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Verilog::Language;
\&
\&  $result = Verilog::Language::is_keyword("wire");  # true
\&  $result = Verilog::Language::is_compdirect("\`notundef");  # false
\&  $result = Verilog::Language::number_value("4\*(Aqb111");  # 8
\&  $result = Verilog::Language::number_bits("32\*(Aqh1b");  # 32
\&  $result = Verilog::Language::number_signed("1\*(Aqsh1");  # 1
\&  @vec    = Verilog::Language::split_bus("[31,5:4]");  # 31, 5, 4
\&  @vec    = Verilog::Language::split_bus_nocomma("[31:29]");  # 31, 30, 29
\&  $result = Verilog::Language::strip_comments("a/*b*/c");  # ac
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Verilog::Language provides general utilities for using the Verilog
Language, such as parsing numbers or determining what keywords exist.
General functions will be added as needed.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.IP Verilog::Language::is_keyword($symbol_string) 4
.IX Item "Verilog::Language::is_keyword($symbol_string)"
Return true if the given symbol string is a Verilog reserved keyword.
Value indicates the language standard as per the `begin_keywords macro,
\&'1364\-1995', '1364\-2001', '1364\-2005', '1800\-2005', '1800\-2009',
\&'1800\-2012', '1800\-2017', '1800\-2023', or 'VAMS'.
.IP Verilog::Language::is_compdirect($symbol_string) 4
.IX Item "Verilog::Language::is_compdirect($symbol_string)"
Return true if the given symbol string is a Verilog compiler directive.
.IP Verilog::Language::is_gateprim($symbol_string) 4
.IX Item "Verilog::Language::is_gateprim($symbol_string)"
Return true if the given symbol is a built in gate primitive; for example
"buf", "xor", etc.
.IP Verilog::Language::language_keywords($year) 4
.IX Item "Verilog::Language::language_keywords($year)"
Returns a hash for keywords for given language standard year, where the
value of the hash is the standard in which it was defined.
.IP Verilog::Language::language_standard($year) 4
.IX Item "Verilog::Language::language_standard($year)"
Sets the language standard to indicate what are keywords.  If undef, all
standards apply.  The year is indicates the language standard as per the
`begin_keywords macro, '1364\-1995', '1364\-2001', '1364\-2005', '1800\-2005'
\&'1800\-2009', '1800\-2012', '1800\-2017', or '1800\-2023'.
.IP Verilog::Language::language_maximum 4
.IX Item "Verilog::Language::language_maximum"
Returns the greatest language currently standardized, presently
\&'1800\-2023'.
.IP Verilog::Language::number_bigint($number_string) 4
.IX Item "Verilog::Language::number_bigint($number_string)"
Return the numeric value of a Verilog value stored as a Math::BigInt, or
undef if incorrectly formed.  You must 'use Math::BigInt' yourself before
calling this function.  Note bigints do not have an exact size, so NOT of a
Math::BigInt may return a different value than verilog.  See also
number_value and number_bitvector.
.IP Verilog::Language::number_bits($number_string) 4
.IX Item "Verilog::Language::number_bits($number_string)"
Return the number of bits in a value string, or undef if incorrectly
formed, _or_ not specified.
.IP Verilog::Language::number_bitvector($number_string) 4
.IX Item "Verilog::Language::number_bitvector($number_string)"
Return the numeric value of a Verilog value stored as a Bit::Vector, or
undef if incorrectly formed.  You must 'use Bit::Vector' yourself before
calling this function.  The size of the Vector will be that returned by
number_bits.
.IP Verilog::Language::number_signed($number_string) 4
.IX Item "Verilog::Language::number_signed($number_string)"
Return true if the Verilog value is signed, else undef.
.IP Verilog::Language::number_value($number_string) 4
.IX Item "Verilog::Language::number_value($number_string)"
Return the numeric value of a Verilog value, or undef if incorrectly
formed.  It ignores any signed Verilog attributes, but is is returned as a
perl signed integer, so it may fail for over 31 bit values.  See also
number_bigint and number_bitvector.
.IP Verilog::Language::split_bus($bus) 4
.IX Item "Verilog::Language::split_bus($bus)"
Return a list of expanded arrays.  When passed a string like
"foo[5:1:2,10:9]", it will return a array with ("foo[5]", "foo[3]", ...).
It correctly handles connectivity expansion also, so that "x[1:0] = y[3:0]"
will get intuitive results.
.IP Verilog::Language::split_bus_nocomma($bus) 4
.IX Item "Verilog::Language::split_bus_nocomma($bus)"
As with split_bus, but faster.  Only supports simple decimal colon
separated array specifications, such as "foo[3:0]".
.IP Verilog::Language::strip_comments($text) 4
.IX Item "Verilog::Language::strip_comments($text)"
Return text with any // or /**/ comments stripped, correctly handing quoted
strings.  Newlines will be preserved in this process.
.SH DISTRIBUTION
.IX Header "DISTRIBUTION"
Verilog-Perl is part of the <https://www.veripool.org/> free Verilog EDA
software tool suite.  The latest version is available from CPAN and from
<https://www.veripool.org/verilog\-perl>.
.PP
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.
.SH AUTHORS
.IX Header "AUTHORS"
Wilson Snyder <wsnyder@wsnyder.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Verilog-Perl,
Verilog::EditFiles
Verilog::Parser,
Verilog::ParseSig,
Verilog::Getopt
.PP
And the <https://www.veripool.org/verilog\-mode>Verilog-Mode package for Emacs.