Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Understand few defconsts #1160

Open
veripoolbot opened this issue May 8, 2017 · 1 comment
Open

Understand few defconsts #1160

veripoolbot opened this issue May 8, 2017 · 1 comment
Labels

Comments

@veripoolbot
Copy link
Collaborator

@veripoolbot veripoolbot commented May 8, 2017


Author Name: Kaushal Modi
Original Redmine Issue: 1160 from https://www.veripool.org


Hi,

I was working on refactoring @verilog-prettify-expr@ function and I came across the @verilog-basic-complete-re@ and @verilog-complete-reg@ variables.

These are @defconst@ variables but they are lacking docstrings. So just looking at their values, I cannot tell what they mean..

Also, for consistency, should @verilog-complete-reg@ have been named @verilog-complete-re@?

Looking at @verilog-basic-complete-re@:

(defconst verilog-basic-complete-re
  (eval-when-compile
     (verilog-regexp-words
      `(
        "always" "assign" "always_latch" "always_ff" "always_comb" "constraint"
        "import" "initial" "final" "module" "macromodule" "repeat" "randcase" "while"
        "if" "for" "forever" "foreach" "else" "parameter" "do" "localparam" "assert"
        ))))

At first glance, this seems to be a regexp for procedural blocks, but then it does not contain @Final@ (IEEE 1800-2012 Section 9.2). Then it has @module@, but no @Class@. So I couldn't correlate this set of keywords with any given set in the standard.

  • Do we need to add more keywords to this regexp?
  • A docstring will help tremendously.
@veripoolbot
Copy link
Collaborator Author

@veripoolbot veripoolbot commented May 8, 2017


Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2017-05-08T23:53:46Z


I can't personally advise as its not my code, but welcome a patch to improve the docs after you figure it out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.