2bd1db490a
* Update bazel-common to fix javadoc issues
Specifically, to fix the following error
```
ERROR: /home/aj/tweag.io/da/da-bazel-1.1/ledger-api/rs-grpc-bridge/BUILD.bazel:7:1: in javadoc_library rule //ledger-api/rs-grpc-bridge:rs-grpc-bridge_javadoc:
Traceback (most recent call last):
File "/home/aj/tweag.io/da/da-bazel-1.1/ledger-api/rs-grpc-bridge/BUILD.bazel", line 7
javadoc_library(name = 'rs-grpc-bridge_javadoc')
File "/home/aj/.cache/bazel/_bazel_aj/5f825ad28f8e070f999ba37395e46ee5/external/com_github_google_bazel_common/tools/javadoc/javadoc.bzl", line 27, in _javadoc_library
dep.java.transitive_deps
object of type 'JavaSkylarkApiProvider' has no field 'transitive_deps'
```
* Define Maven deps using rules_jvm_external
* Pin artifacts
* Remove bazel-deps generated targets
* Remove bazel-deps
* Switch to rules_jvm_external targets
* update bazel documentation
* pom_file: There are no more bazel-deps targets
* BAZEL-JVM.md `maven_install` typo
|
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| BUILD.bazel | ||
| codegen.bzl | ||
| README.md | ||
Developer's guide to DAML Scala code generator
For the User's guide to the Scala code generator see:
docs/daml-scala-code-gen-user-guide.rst
Introduction
The DAML Scala code generator produces wrapper classes that correspond to DAML contract templates and DAML user defined types (records/variants that are the right hand side of a DAML type synonym). They are intended to be used by application developers and they provide the same level of type safety as the DAML langauge itself.
Working with Scala macros
The code makes heavy use of Scala macros and quasiquotes.
More information on Scala macros can be found here
There is some great documentation on quasiquotes here In particular, this page is a great reference
You may also find this guide on the Scala Reflection API useful as macros/quasiquotes make use of it. See here
The reference documentation for the Reflection API is available here
I have also found it very useful to use the Scala console to see the abstract syntax tree (AST) structure
showRaw is your friend
You can use the Reflection API's showRaw function to see which
constructors are used in a quasiquoted expression/statement/definition.
From an SBT console open a Scala console with:
> console
Then:
scala> val universe: scala.reflect.runtime.universe.type = scala.reflect.runtime.universe
universe: reflect.runtime.universe.type = scala.reflect.runtime.JavaUniverse@712e80d8
scala> import universe._
import universe._
Then (for example):
scala> showRaw(q"obj.method")
res2: String = Select(Ident(TermName("obj")), TermName("method"))
Use Ctrl-D to get back to SBT console
Understanding the code
The best way to understand the structure of the generated code is to
read DamlContractTemplate.scala and DamlUserDefinedType.scala. The
Scala macros are quite readable and both classes have informative comments.