• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Community
    • Proof-automation
    • ACL2
    • Macro-libraries
    • Interfacing-tools
    • Hardware-verification
    • Software-verification
      • Kestrel-books
        • Crypto-hdwallet
        • Apt
        • Error-checking
        • Fty-extensions
        • Isar
        • Kestrel-utilities
        • Set
        • Soft
        • C
        • Bv
        • Imp-language
        • Event-macros
        • Java
          • Atj
            • Atj-implementation
              • Atj-types
              • Atj-java-primitive-array-model
              • Atj-java-abstract-syntax
              • Atj-input-processing
              • Atj-java-pretty-printer
              • Atj-code-generation
                • Atj-gen-test-method
                • Atj-shallow-code-generation
                  • Atj-gen-shallow-term-fns
                  • String-jmethodlist-alistp
                  • Atj-gen-shallow-fndef-method
                  • String-jfieldlist-alistp
                  • Atj-gen-shallow-test-code
                  • Atj-adapt-expr-to-type
                  • Atj-gen-shallow-fn-call
                  • Atj-check-marked-annotated-mv-let-call
                  • Atj-gen-shallow-main-class
                  • Atj-gen-shallow-fnnative-method
                  • Atj-gen-shallow-synonym-method
                  • Atj-gen-shallow-if-call
                  • Atj-gen-shallow-and-call
                  • Atj-gen-shallow-pkg-methods
                  • Atj-convert-expr-to-jprim
                  • Atj-gen-shallow-or-call
                  • Atj-convert-expr-from-jprimarr-method
                  • Atj-adapt-expr-to-types
                  • Atj-gen-shallow-all-pkg-methods
                  • Atj-convert-expr-to-jprimarr-method
                  • Atj-gen-shallow-fndef-all-methods
                  • Atj-convert-expr-from-jprim
                  • Atj-gen-shallow-mv-class
                  • Atj-gen-shallow-main-cunit
                  • Atj-gen-shallow-fndef-methods
                  • Atj-gen-shallow-mv-class-name
                  • Atj-shallow-fns-that-may-throw
                  • Atj-gen-shallow-term
                  • Atj-gen-shallow-let-bindings
                  • Atj-gen-shallow-fn-methods
                  • Atj-gen-shallow-jprimarr-new-init-call
                  • Atj-gen-shallow-fnname
                  • Atj-gen-shallow-all-fn-methods
                  • Atj-gen-shallow-not-call
                  • Atj-fnnative-method-name
                  • Atj-gen-shallow-mv-let
                  • Atj-gen-shallow-jprim-constr-call
                  • Atj-gen-shallow-jprimarr-write-call
                  • Atj-gen-shallow-fnnative-all-methods
                  • Atj-gen-shallow-pkg-class
                    • Atj-gen-shallow-jprimarr-length-call
                    • Atj-gen-shallow-pkg-fields
                    • Atj-all-mv-output-types
                    • Atj-gen-shallow-mv-call
                    • Atj-gen-shallow-jprim-binop-call
                    • Atj-gen-shallow-jprim-conv-call
                    • Atj-gen-shallow-primarray-write-method
                    • Atj-gen-shallow-mv-fields
                    • Atj-gen-shallow-jprimarr-read-call
                    • Atj-gen-shallow-jprimarr-new-len-call
                    • Atj-gen-shallow-jprimarr-conv-tolist-call
                    • Atj-gen-shallow-jprimarr-conv-fromlist-call
                    • Atj-gen-shallow-synonym-all-methods
                    • Atj-gen-shallow-jprim-deconstr-call
                    • Atj-gen-shallow-all-pkg-fields
                    • Atj-gen-shallow-test-code-asgs
                    • Atj-gen-shallow-lambda
                    • Atj-gen-shallow-jprim-unop-call
                    • Atj-jprim-binop-fn-to-jbinop
                    • Atj-gen-shallow-mv-asgs
                    • Atj-gen-shallow-env-class
                    • Atj-gen-shallow-mv-params
                    • Atj-gen-shallow-fnnative-methods
                    • Atj-gen-shallow-pkg-classes
                    • Atj-gen-shallow-env-cunit
                    • Atj-gen-shallow-all-synonym-methods
                    • Atj-convert-expr-to-jprimarr
                    • Atj-convert-expr-from-jprimarr
                    • Atj-jprim-constr-fn-of-qconst-to-expr
                    • Atj-gen-shallow-test-code-mv-asgs
                    • Atj-gen-shallow-synonym-methods
                    • Atj-gen-shallow-synonym-method-params
                    • Atj-convert-expr-to-jprimarr-method-name
                    • Atj-convert-expr-from-jprimarr-method-name
                    • Atj-jexpr-list-to-3-jexprs
                    • Atj-jblock-list-to-3-jblocks
                    • Atj-gen-shallow-test-code-comps
                    • Atj-jprim-conv-fn-to-jtype
                    • Atj-gen-shallow-terms
                    • Atj-gen-shallow-mv-field-name
                    • Atj-adapt-exprs-to-types
                    • Atj-jblock-list-to-2-jblocks
                    • Atj-gen-shallow-primarray-write-methods
                    • Atj-gen-shallow-mv-classes
                    • Atj-gen-shallow-jtype
                    • Atj-gen-shallow-build-method
                    • Atj-jexpr-list-to-2-jexprs
                    • Atj-jprimarr-write-to-method-name
                    • Atj-gen-shallow-all-jprimarr-conv-methods
                    • Atj-jprimarr-new-len-fn-to-comp-jtype
                    • Atj-jprimarr-new-init-fn-to-comp-jtype
                    • Atj-jprim-unop-fn-to-junop
                    • *atj-gen-cond-exprs*
                    • Atj-primarray-write-method-name
                    • Atj-gen-shallow-jprimarr-fromlist-methods
                    • Atj-gen-shallow-jprimarr-tolist-methods
                    • Atj-gen-shallow-mv-classes-guard
                    • *atj-mv-singleton-field-name*
                    • *atj-mv-factory-method-name*
                  • Atj-common-code-generation
                  • Atj-shallow-quoted-constant-generation
                  • Atj-pre-translation
                  • Atj-gen-everything
                  • Atj-name-translation
                  • Atj-gen-test-cunit
                  • Atj-gen-test-class
                  • Atj-gen-main-file
                  • Atj-post-translation
                  • Atj-deep-code-generation
                  • Atj-gen-test-methods
                  • Atj-gen-test-file
                  • Atj-gen-env-file
                  • Atj-gen-output-subdir
                • Atj-java-primitives
                • Atj-java-primitive-arrays
                • Atj-type-macros
                • Atj-java-syntax-operations
                • Atj-fn
                • Atj-library-extensions
                • Atj-java-input-types
                • Atj-test-structures
                • Aij-notions
                • Atj-macro-definition
              • Atj-tutorial
            • Aij
            • Language
          • Bitcoin
          • Ethereum
          • Yul
          • Zcash
          • ACL2-programming-language
          • Prime-fields
          • Json
          • Syntheto
          • File-io-light
          • Cryptography
          • Number-theory
          • Lists-light
          • Axe
          • Builtins
          • Solidity
          • Helpers
          • Htclient
          • Typed-lists-light
          • Arithmetic-light
        • X86isa
        • Axe
        • Execloader
      • Math
      • Testing-utilities
    • Atj-shallow-code-generation

    Atj-gen-shallow-pkg-class

    Generate the class for an ACL2 package.

    Signature
    (atj-gen-shallow-pkg-class pkg fields-by-pkg 
                               methods-by-pkg pkg-class-names verbose$) 
     
      → 
    class
    Arguments
    pkg — Guard (stringp pkg).
    fields-by-pkg — Guard (string-jfieldlist-alistp fields-by-pkg).
    methods-by-pkg — Guard (string-jmethodlist-alistp methods-by-pkg).
    pkg-class-names — Guard (string-string-alistp pkg-class-names).
    verbose$ — Guard (booleanp verbose$).
    Returns
    class — Type (jclassp class).

    In the shallow embedding approach, we generate a Java class for each ACL2 package. This is a public static Java class, nested into the main Java class that ATJ generates.

    The fields are in the fields-by-pkg alist, which is calculated (elsewhere) via atj-gen-shallow-all-pkg-fields.

    The methods are in the methods-by-pkg alist, which is calculated (elsewhere) via atj-gen-shallow-all-pkg-methods.

    We apply to the class body elements of the class the part of the post-translation that operates at that level. The part of the post-translation that operates at the level of methods is applied in atj-gen-shallow-fndef-method.

    Definitions and Theorems

    Function: atj-gen-shallow-pkg-class

    (defun atj-gen-shallow-pkg-class
           (pkg fields-by-pkg
                methods-by-pkg pkg-class-names verbose$)
     (declare
          (xargs :guard (and (stringp pkg)
                             (string-jfieldlist-alistp fields-by-pkg)
                             (string-jmethodlist-alistp methods-by-pkg)
                             (string-string-alistp pkg-class-names)
                             (booleanp verbose$))))
     (let ((__function__ 'atj-gen-shallow-pkg-class))
      (declare (ignorable __function__))
      (b* ((class-name (atj-get-pkg-class-name pkg pkg-class-names))
           ((run-when verbose$)
            (cw "  ~s0 for ~s1~%" class-name pkg))
           (fields (cdr (assoc-equal pkg fields-by-pkg)))
           (methods (cdr (assoc-equal pkg methods-by-pkg)))
           (body-elems (append (jmethods-to-jcbody-elements methods)
                               (jfields-to-jcbody-elements fields)))
           (body-elems (atj-post-translate-jcbody-elements body-elems)))
        (make-jclass :access (jaccess-public)
                     :abstract? nil
                     :static? t
                     :final? nil
                     :strictfp? nil
                     :name class-name
                     :superclass? nil
                     :superinterfaces nil
                     :body body-elems))))

    Theorem: jclassp-of-atj-gen-shallow-pkg-class

    (defthm jclassp-of-atj-gen-shallow-pkg-class
      (b*
       ((class
             (atj-gen-shallow-pkg-class pkg fields-by-pkg methods-by-pkg
                                        pkg-class-names verbose$)))
       (jclassp class))
      :rule-classes :rewrite)