• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
      • Warnings
      • Primitives
      • Use-set
      • Syntax
      • Getting-started
      • Utilities
      • Loader
      • Transforms
      • Lint
      • Mlib
      • Server
      • Kit
        • Vl-model
        • Vl-json
        • Vl-gather
        • Vl-server
        • Vl-pp
          • Vl-pp-opts-p
            • Parse-vl-pp-opts
              • Parse-vl-pp-opts-long
              • Parse-vl-pp-opts-aux
              • Parse-vl-pp-opts-bundle
              • Parse-vl-pp-opts-short->long-list
              • Parse-vl-pp-opts-short->long
            • Vl-pp-opts
            • Make-vl-pp-opts
            • Change-vl-pp-opts
            • Honsed-vl-pp-opts
            • Make-honsed-vl-pp-opts
            • *vl-pp-opts-usage*
            • Vl-pp-opts->strict
            • Vl-pp-opts->start-files
            • Vl-pp-opts->readme
            • Vl-pp-opts->output
            • Vl-pp-opts->outdefs
            • Vl-pp-opts->mem
            • Vl-pp-opts->include-dirs
            • Vl-pp-opts->help
            • Vl-pp-opts->edition
            • Vl-pp-opts->defines
        • Vl-lint
        • Vl-main
        • Vl-toolkit-other-command
        • Vl-help
      • Printer
      • Esim-vl
      • Well-formedness
    • Sv
    • Fgl
    • Vwsim
    • Vl
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Parse-vl-pp-opts

Parse-vl-pp-opts-long

Signature

(parse-vl-pp-opts-long getopt::longname getopt::explicit-val 
                       args getopt::acc getopt::seen) 
 
  → 
(mv getopt::errmsg getopt::acc rest)

Arguments

getopt::longname — Longname we've just found, e.g., "foo" if we've just seen --foo=bar.
    Guard (stringp getopt::longname).

getopt::explicit-val — Any explicit value passed to this option, e.g., "bar" if we've just seen --foo=bar, or NIL if we've just seen --foo.
    Guard (or (not getopt::explicit-val) (stringp getopt::explicit-val)).

args — Remaining arguments past longname.
    Guard (string-listp args).

getopt::acc — Structure we're updating.
    Guard (vl-pp-opts-p getopt::acc).

getopt::seen — List of longnames that we've seen so far.
    Guard (string-listp getopt::seen).

Returns

getopt::errmsg — NIL on success or an error message.

getopt::acc — Updated structure.
    Type (vl-pp-opts-p getopt::acc), given (force (vl-pp-opts-p getopt::acc)).

rest — Rest after this one.
    Type (string-listp rest), given (force (string-listp args)).

Definitions and Theorems

Function: parse-vl-pp-opts-long

(defun parse-vl-pp-opts-long
       (getopt::longname getopt::explicit-val
                         args getopt::acc getopt::seen)
 (declare (xargs :guard (and (stringp getopt::longname)
                             (or (not getopt::explicit-val)
                                 (stringp getopt::explicit-val))
                             (string-listp args)
                             (vl-pp-opts-p getopt::acc)
                             (string-listp getopt::seen))))
 (let ((__function__ 'parse-vl-pp-opts-long))
  (declare (ignorable __function__))
  (cond
    ((equal getopt::longname "help")
     (b* (((when (member-equal getopt::longname getopt::seen))
           (mv (msg "Option --~s0 given multiple times"
                    getopt::longname)
               getopt::acc args))
          ((mv getopt::err value rest)
           (getopt::parse-plain (cat "--" getopt::longname)
                                getopt::explicit-val args))
          ((when getopt::err)
           (mv getopt::err getopt::acc args))
          (getopt::acc (change-vl-pp-opts getopt::acc
                                          :help value)))
       (mv nil getopt::acc rest)))
    ((equal getopt::longname "readme")
     (b* (((when (member-equal getopt::longname getopt::seen))
           (mv (msg "Option --~s0 given multiple times"
                    getopt::longname)
               getopt::acc args))
          ((mv getopt::err value rest)
           (getopt::parse-plain (cat "--" getopt::longname)
                                getopt::explicit-val args))
          ((when getopt::err)
           (mv getopt::err getopt::acc args))
          (getopt::acc (change-vl-pp-opts getopt::acc
                                          :readme value)))
       (mv nil getopt::acc rest)))
    ((equal getopt::longname "output")
     (b* (((when (member-equal getopt::longname getopt::seen))
           (mv (msg "Option --~s0 given multiple times"
                    getopt::longname)
               getopt::acc args))
          ((mv getopt::err value rest)
           (getopt::parse-string (cat "--" getopt::longname)
                                 getopt::explicit-val args))
          ((when getopt::err)
           (mv getopt::err getopt::acc args))
          (getopt::acc (change-vl-pp-opts getopt::acc
                                          :output value)))
       (mv nil getopt::acc rest)))
    ((equal getopt::longname "outdefs")
     (b* (((when (member-equal getopt::longname getopt::seen))
           (mv (msg "Option --~s0 given multiple times"
                    getopt::longname)
               getopt::acc args))
          ((mv getopt::err value rest)
           (getopt::parse-string (cat "--" getopt::longname)
                                 getopt::explicit-val args))
          ((when getopt::err)
           (mv getopt::err getopt::acc args))
          (getopt::acc (change-vl-pp-opts getopt::acc
                                          :outdefs value)))
       (mv nil getopt::acc rest)))
    ((equal getopt::longname "include")
     (b* (((mv getopt::err value rest)
           (getopt::parse-string (cat "--" getopt::longname)
                                 getopt::explicit-val args))
          ((when getopt::err)
           (mv getopt::err getopt::acc args))
          (getopt::old-value (vl-pp-opts->include-dirs getopt::acc))
          (value (acl2::rcons value getopt::old-value))
          (getopt::acc (change-vl-pp-opts getopt::acc
                                          :include-dirs value)))
       (mv nil getopt::acc rest)))
    ((equal getopt::longname "define")
     (b* (((mv getopt::err value rest)
           (getopt::parse-string (cat "--" getopt::longname)
                                 getopt::explicit-val args))
          ((when getopt::err)
           (mv getopt::err getopt::acc args))
          (getopt::old-value (vl-pp-opts->defines getopt::acc))
          (value (cons value getopt::old-value))
          (getopt::acc (change-vl-pp-opts getopt::acc
                                          :defines value)))
       (mv nil getopt::acc rest)))
    ((equal getopt::longname "edition")
     (b* (((when (member-equal getopt::longname getopt::seen))
           (mv (msg "Option --~s0 given multiple times"
                    getopt::longname)
               getopt::acc args))
          ((mv getopt::err value rest)
           (vl-parse-edition (cat "--" getopt::longname)
                             getopt::explicit-val args))
          ((when getopt::err)
           (mv getopt::err getopt::acc args))
          (getopt::acc (change-vl-pp-opts getopt::acc
                                          :edition value)))
       (mv nil getopt::acc rest)))
    ((equal getopt::longname "strict")
     (b* (((when (member-equal getopt::longname getopt::seen))
           (mv (msg "Option --~s0 given multiple times"
                    getopt::longname)
               getopt::acc args))
          ((mv getopt::err value rest)
           (getopt::parse-plain (cat "--" getopt::longname)
                                getopt::explicit-val args))
          ((when getopt::err)
           (mv getopt::err getopt::acc args))
          (getopt::acc (change-vl-pp-opts getopt::acc
                                          :strict value)))
       (mv nil getopt::acc rest)))
    ((equal getopt::longname "mem")
     (b* (((when (member-equal getopt::longname getopt::seen))
           (mv (msg "Option --~s0 given multiple times"
                    getopt::longname)
               getopt::acc args))
          ((mv getopt::err value rest)
           (getopt::parse-pos (cat "--" getopt::longname)
                              getopt::explicit-val args))
          ((when getopt::err)
           (mv getopt::err getopt::acc args))
          (getopt::acc (change-vl-pp-opts getopt::acc
                                          :mem value)))
       (mv nil getopt::acc rest)))
    (t (mv (msg "Unrecognized option --~s0"
                getopt::longname)
           getopt::acc args)))))

Theorem: vl-pp-opts-p-of-parse-vl-pp-opts-long.acc

(defthm vl-pp-opts-p-of-parse-vl-pp-opts-long.acc
 (implies
  (force (vl-pp-opts-p getopt::acc))
  (b* (((mv getopt::?errmsg
            getopt::?acc common-lisp::?rest)
        (parse-vl-pp-opts-long getopt::longname getopt::explicit-val
                               args getopt::acc getopt::seen)))
    (vl-pp-opts-p getopt::acc)))
 :rule-classes :rewrite)

Theorem: string-listp-of-parse-vl-pp-opts-long.rest

(defthm string-listp-of-parse-vl-pp-opts-long.rest
 (implies
  (force (string-listp args))
  (b* (((mv getopt::?errmsg
            getopt::?acc common-lisp::?rest)
        (parse-vl-pp-opts-long getopt::longname getopt::explicit-val
                               args getopt::acc getopt::seen)))
    (string-listp rest)))
 :rule-classes :rewrite)

Theorem: parse-vl-pp-opts-long-makes-progress

(defthm parse-vl-pp-opts-long-makes-progress
 (<=
  (len
   (mv-nth
        2
        (parse-vl-pp-opts-long getopt::longname getopt::explicit-val
                               args getopt::acc getopt::seen)))
  (len args))
 :rule-classes ((:rewrite) (:linear)))