• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Community
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
    • Software-verification
      • Kestrel-books
        • Crypto-hdwallet
        • Apt
        • Error-checking
        • Fty-extensions
        • Isar
        • Kestrel-utilities
        • Set
        • C
        • Soft
        • Bv
        • Imp-language
        • Ethereum
        • Event-macros
          • Evmac-input-hints-p
          • Evmac-input-print-p
          • Event-macro-input-processing
          • Function-definedness
          • Event-macro-screen-printing
          • Make-event-terse
          • Event-macro-applicability-conditions
          • Event-macro-results
          • Template-generators
          • Event-macro-event-generators
          • Event-macro-proof-preparation
          • Try-event
          • Restore-output?
          • Restore-output
          • Fail-event
          • Cw-event
          • Event-macro-xdoc-constructors
            • Event-macro-xdoc-constructors-user-level
            • Event-macro-xdoc-constructors-implementation-level
              • Xdoc::evmac-topic-implementation
              • Xdoc::evmac-topic-event-generation
              • Xdoc::evmac-topic-input-processing
              • Xdoc::evmac-topic-library-extensions
            • Event-macro-intro-macros
          • Java
          • Riscv
          • Bitcoin
          • Zcash
          • Yul
          • ACL2-programming-language
          • Prime-fields
          • Json
          • Syntheto
          • File-io-light
          • Cryptography
          • Number-theory
          • Axe
          • Lists-light
          • Builtins
          • Solidity
          • Helpers
          • Htclient
          • Typed-lists-light
          • Arithmetic-light
        • X86isa
        • Axe
        • Execloader
      • Math
      • Testing-utilities
    • Event-macro-xdoc-constructors-implementation-level

    Xdoc::evmac-topic-library-extensions

    Generate an XDOC topic for the library extensions that are part of the implementation of an event macro.

    Macro: evmac-topic-library-extensions

    (defmacro xdoc::evmac-topic-library-extensions (macro)
     (declare (xargs :guard (symbolp macro)))
     (b*
      ((macro-name (string-downcase (symbol-name macro)))
       (macro-ref (concatenate 'string
                               "@(tsee " macro-name ")"))
       (this-topic (add-suffix macro "-LIBRARY-EXTENSIONS"))
       (parent-topic (add-suffix macro "-IMPLEMENTATION"))
       (short (concatenate 'string
                           "Library extensions for "
                           macro-ref "."))
       (long
        (xdoc::topstring-p
         "These are used by, but more general than, "
         macro-ref
         ". Thus, they should be moved
                     to more general libraries eventually.")))
      (cons
       'defxdoc+
       (cons
        this-topic
        (cons
         ':parents
         (cons
          (cons parent-topic 'nil)
          (cons
           ':short
           (cons
             short
             (cons ':long
                   (cons long
                         '(:order-subtopics t
                                            :default-parent t)))))))))))