• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Community
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
      • Gl
      • Esim
      • Vl2014
        • Warnings
        • Primitives
        • Use-set
        • Syntax
        • Getting-started
        • Utilities
        • Loader
          • Preprocessor
          • Vl-loadconfig
          • Lexer
          • Vl-loadstate
          • Parser
            • Parse-expressions
              • Vl-parse-parameter-value-assignment-hack
              • Vl-erange-p
              • Vl-mixed-binop-list-p
              • Vl-parse-very-simple-type
              • Vl-mark-as-explicit-parens
              • Vl-parse-0+-scope-prefixes
              • Vl-parse-0+-attribute-instances
              • Vl-parse-op
              • Vl-parse-hierarchical-identifier
                • Vl-parse-pva-tail
                • Vl-parse-expression-top
                • Vl-parse-any-sort-of-concatenation
                • Vl-build-indexing-nest
                • Vl-erangetypelist-p
                • Vl-build-range-select-with
                • Vl-build-range-select
                • Vl-parse-simple-type
                • Vl-expr-has-any-atts-p
                • Vl-left-associate-mixed-binop-list
                • Vl-tack-scopes-onto-hid
                • Vl-parse-op-alist-p
                • Vl-make-guts-from-inttoken
                • Vl-parse-range-expression
                • Vl-parse-slice-size
                • Vl-parse-concatenation
                • Vl-parse-stream-expression
                • Vl-parse-1+-stream-expressions-separated-by-commas
                • Vl-parse-stream-concatenation
                • Vl-parse-primary
                • Vl-parse-0+-bracketed-expressions
                • Vl-parse-system-function-call
                • Vl-parse-shift-expression-aux
                • Vl-parse-power-expression-aux
                • Vl-parse-mult-expression-aux
                • Vl-parse-mintypmax-expression
                • Vl-parse-logor-expression-aux
                • Vl-parse-logand-expression-aux
                • Vl-parse-indexed-id-2012
                • Vl-parse-indexed-id-2005
                • Vl-parse-equality-expression-aux
                • Vl-parse-equality-expression
                • Vl-parse-compare-expression-aux
                • Vl-parse-bitxor-expression-aux
                • Vl-parse-bitor-expression-aux
                • Vl-parse-bitand-expression-aux
                • Vl-parse-1+-open-value-ranges
                • Vl-parse-1+-keyval-expression-pairs
                • Vl-parse-unary-expression
                • Vl-parse-shift-expression
                • Vl-parse-qmark-expression
                • Vl-parse-primary-main
                • Vl-parse-primary-cast
                • Vl-parse-power-expression
                • Vl-parse-open-value-range
                • Vl-parse-nonprimary-cast
                • Vl-parse-mult-expression
                • Vl-parse-logor-expression
                • Vl-parse-logand-expression
                • Vl-parse-indexed-id
                • Vl-parse-impl-expression
                • Vl-parse-function-call
                • Vl-parse-expression
                • Vl-parse-compare-expression
                • Vl-parse-bitxor-expression
                • Vl-parse-bitor-expression
                • Vl-parse-bitand-expression
                • Vl-parse-assignment-pattern
                • Vl-parse-add-expression-aux
                • Vl-parse-add-expression
                • Vl-parse-1+-expressions-separated-by-commas
              • Parse-udps
              • Vl-genelements
              • Parse-paramdecls
              • Parse-blockitems
              • Parse-utils
              • Parse-insts
              • Parse-datatype
              • Parse-functions
              • Parse-datatypes
              • Parse-strengths
              • Vl-parse-genvar-declaration
              • Vl-parse
              • Parse-ports
              • Seq
              • Parse-packages
            • Vl-load-merge-descriptions
            • Scope-of-defines
            • Vl-load-file
            • Vl-flush-out-descriptions
            • Vl-description
            • Vl-loadresult
            • Vl-read-file
            • Vl-find-basename/extension
            • Vl-find-file
            • Vl-read-files
            • Extended-characters
            • Vl-load
            • Vl-load-main
            • Vl-load-description
            • Vl-descriptions-left-to-load
            • Inject-warnings
            • Vl-load-descriptions
            • Vl-load-files
            • Vl-load-summary
            • Vl-collect-modules-from-descriptions
            • Vl-descriptionlist
          • Transforms
          • Lint
          • Mlib
          • Server
          • Kit
          • Printer
          • Esim-vl
          • Well-formedness
        • Sv
        • Fgl
        • Vwsim
        • Vl
        • X86isa
        • Svl
        • Rtl
      • Software-verification
      • Math
      • Testing-utilities
    • Parse-expressions

    Vl-parse-hierarchical-identifier

    Match a hierarchical_identifier.

    Signature
    (vl-parse-hierarchical-identifier 
         recursivep &key (tokstream 'tokstream) 
         (config 'config)) 
     
      → 
    (mv errmsg? value new-tokstream)
    Arguments
    config — Guard (vl-loadconfig-p config).

    In Verilog-2005, the rule is:

    hierarchical_identifier ::=
      { identifier [ '[' expression ']' '.' } identifier

    This permits, e.g., foo.bar[2].baz, but at most one indexing expression is allowed at each level, e.g., foo.bar[2][3].baz is not allowed.

    SystemVerilog extends this in two ways. The new rule is:

    hierarchical_identifier ::=
      [ '$root' '.' ] { identifier bit_select '.' } identifier
    
    bit_select ::= { '[' expression ']' }

    The first extension, $root, is straightforward enough.

    The second extension is that there can now be multiple levels of indexing, because the bit_select production has any amount of replication allowed. So, a hierarchical identifier such as foo.bar[2][3].baz is now permitted.

    This function can return a hierarchical identifier or a simple identifier expression. The recursivep argument is used to determine, in the base case, whether the atom we build should be a hidpiece or an ordinary id. Basically, if we have not yet seen a dot then recursivep is nil and we want to just build a regular id token. But otherwise, this id is just part of a hierarchical identifier, so we convert it into a hidpiece.