Help-Site Computer Manuals
Software
Hardware
Programming
Networking
  Algorithms & Data Structures   Programming Languages   Revision Control
  Protocols
  Cameras   Computers   Displays   Keyboards & Mice   Motherboards   Networking   Printers & Scanners   Storage
  Windows   Linux & Unix   Mac

Verilog::Language
Verilog language utilities

Verilog::Language - Verilog language utilities



NAME

Verilog::Language - Verilog language utilities


SYNOPSIS


  use Verilog::Language;

  $result = Verilog::Language::is_keyword ("wire");  # true

  $result = Verilog::Language::is_compdirect ("`notundef");  # false

  $result = Verilog::Language::number_value ("4'b111");  # 8

  $result = Verilog::Language::number_bits  ("32'h1b");  # 32

  $result = Verilog::Language::number_signed ("1'sh1");  # 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


DESCRIPTION

Verilog::Language provides general utilities for using the Verilog Language, such as parsing numbers or determing what keywords exist. General functions will be added as needed.


WHICH PACKAGE

If you are starting a new application which needs to parse the Verilog language you have several tools available to you. Which you pick depends on how low level and complete the information you need is.

Verilog::Preproc
Verilog::Preproc is useful when you need only text out, or a list of defines, etc. It can preprocess a file, or be used to provide the Verilog macro language on top of synthesis scripts. It understands the full SystemVerilog 2005 preprocessor syntax.

Verilog::Parser
Verilog::Parser is useful when you need to tokenize or write source filters (where you need everything including whitespace). It can take raw files, or preprocessed input. It understands all SystemVerilog 2005 keywords.

Verilog::SigParser
Verilog::SigParser is useful when you need a list of modules, signals, ports, functions, etc. It requires a preprocessed file, and can parse most Verilog 2005 files, but only provides callbacks on certain interesting things.

Verilog::Netlist
Verilog::Netlist is useful for when you need the hierarchy, and a list of signals per module, pins per cell, etc. It builds upon the output of Verilog::SigParser, so requires preprocessed files.

This is probably the most popular choice.

VPI
Using the VPI is the best way to access the behavior of the design. It is not part of this package as it requires a compliant simulator and C++ code to call the VPI, and understands as much of the language as the simulator supports. This allows writing lint checks and full knowledge of all parts of the code, but generally requires the most work (short of writing a parser from scratch.)


FUNCTIONS

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', or '1800-2005'.

Verilog::Language::is_compdirect ($symbol_string)
Return true if the given symbol string is a Verilog compiler directive.

Verilog::Language::is_gateprim ($symbol_string)
Return true if the given symbol is a built in gate primitive; for example ``buf'', ``xor'', etc.

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', or '1800-2005'.

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.

Verilog::Language::number_bits ($number_string)
Return the number of bits in a value string, or undef if incorrectly formed, _or_ not specified.

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.

Verilog::Language::number_signed ($number_string)
Return true if the Verilog value is signed, else undef.

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.

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.

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]''.

Verilog::Language::strip_comments ($text)
Return text with any // or /**/ comments stripped, correctly handing quoted strings. Newlines will be preserved in this process.


DISTRIBUTION

Verilog-Perl is part of the http://www.veripool.com/ free Verilog EDA software tool suite. The latest version is available from CPAN and from http://www.veripool.com/verilog-perl.html.

Copyright 2000-2007 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

Verilog-Perl, the Verilog::EditFiles manpage the Verilog::Parser manpage, the Verilog::ParseSig manpage, the Verilog::Getopt manpage

And the http://www.veripool.com/verilog-mode.htmlVerilog-Mode package for Emacs.

Programminig
Wy
Wy
yW
Wy
Programming
Wy
Wy
Wy
Wy