		Search-engine friendly clone of the ACL2 documentation.

Vl-cassertion

Make-vl-cassertion

Basic constructor macro for vl-cassertion structures.

Syntax

(make-vl-cassertion [:name <name>] 
                    [:type <type>] 
                    [:sequencep <sequencep>] 
                    [:condition <condition>] 
                    [:success <success>] 
                    [:failure <failure>] 
                    [:loc <loc>])

This is the usual way to construct vl-cassertion structures. It simply conses together a structure with the specified fields.

This macro generates a new vl-cassertion structure from scratch. See also change-vl-cassertion, which can "change" an existing structure, instead.

Definition

This is an ordinary make- macro introduced by defprod.

Macro: make-vl-cassertion

(defmacro make-vl-cassertion (&rest args)
  (std::make-aggregate 'vl-cassertion
                       args
                       '((:name)
                         (:type)
                         (:sequencep)
                         (:condition)
                         (:success)
                         (:failure)
                         (:loc))
                       'make-vl-cassertion
                       nil))

Function: vl-cassertion

(defun vl-cassertion (name type
                           sequencep condition success failure loc)
 (declare (xargs :guard (and (maybe-stringp name)
                             (vl-asserttype-p type)
                             (booleanp sequencep)
                             (vl-propspec-p condition)
                             (vl-stmt-p success)
                             (vl-stmt-p failure)
                             (vl-location-p loc))))
 (declare (xargs :guard t))
 (let ((__function__ 'vl-cassertion))
  (declare (ignorable __function__))
  (b* ((name (mbe :logic (maybe-string-fix name)
                  :exec name))
       (type (mbe :logic (vl-asserttype-fix type)
                  :exec type))
       (sequencep (mbe :logic (acl2::bool-fix sequencep)
                       :exec sequencep))
       (condition (mbe :logic (vl-propspec-fix condition)
                       :exec condition))
       (success (mbe :logic (vl-stmt-fix success)
                     :exec success))
       (failure (mbe :logic (vl-stmt-fix failure)
                     :exec failure))
       (loc (mbe :logic (vl-location-fix loc)
                 :exec loc)))
    (cons :vl-cassertion
          (std::prod-cons
               (std::prod-cons name (std::prod-cons type sequencep))
               (std::prod-cons (std::prod-cons condition success)
                               (std::prod-cons failure loc)))))))