-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add haskell_toolchains module extension
This extension is used to register the haskell bindists with bzlmod.
- Loading branch information
Showing
4 changed files
with
260 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| """ Module extension to install bindist haskell toolchains""" | ||
|
|
||
| load( | ||
| "@rules_haskell//haskell:ghc_bindist.bzl", | ||
| "ghc_bindist", | ||
| "ghc_bindist_toolchain_declaration", | ||
| "ghc_bindists_toolchain_declarations", | ||
| "haskell_register_ghc_bindists", | ||
| ) | ||
|
|
||
| _bindists_tag = tag_class( | ||
| attrs = { | ||
| "version": attr.string( | ||
| doc = "[see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-version)", | ||
| ), | ||
| "ghcopts": attr.string_list( | ||
| doc = "[see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-ghcopts)", | ||
| ), | ||
| "haddock_flags": attr.string_list( | ||
| doc = "haddock_flags: [see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-haddock_flags)", | ||
| ), | ||
| "repl_ghci_args": attr.string_list( | ||
| doc = "[see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-repl_ghci_args)", | ||
| ), | ||
| "cabalopts": attr.string_list( | ||
| doc = "[see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-cabalopts)", | ||
| ), | ||
| "locale": attr.string( | ||
| doc = "[see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-locale)", | ||
| ), | ||
| }, | ||
| doc = """See [rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains). | ||
| Only the first `bindists` tag is taken into account (according to the iteration order over modules). | ||
| """, | ||
| ) | ||
|
|
||
| _bindist_tag = tag_class( | ||
| attrs = { | ||
| "name": attr.string( | ||
| mandatory = True, | ||
| doc = "A unique name for the repository", | ||
| ), | ||
| "version": attr.string( | ||
| mandatory = True, | ||
| doc = "The desired GHC version", | ||
| ), | ||
| "target": attr.string( | ||
| mandatory = True, | ||
| doc = "The desired architecture (See [ghc_bindist_generated.bzl](https://github.com/tweag/rules_haskell/blob/master/haskell/private/ghc_bindist_generated.bzl))", | ||
| ), | ||
| "ghcopts": attr.string_list( | ||
| doc = "[see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-ghcopts)", | ||
| ), | ||
| "haddock_flags": attr.string_list( | ||
| doc = "[see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-haddock_flags)", | ||
| ), | ||
| "repl_ghci_args": attr.string_list( | ||
| doc = "[see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-repl_ghci_args) ", | ||
| ), | ||
| "cabalopts": attr.string_list( | ||
| doc = "[see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-cabalopts)", | ||
| ), | ||
| "locale": attr.string( | ||
| doc = "[see rules_haskell_toolchains](toolchain.html#rules_haskell_toolchains-locale)", | ||
| ), | ||
| }, | ||
| doc = "Declares and configure a bindist haskell toolchain. See [ghc_bindist](ghc_bindist.html#ghc_bindist).", | ||
| ) | ||
|
|
||
| def _all_toolchains_impl(rctx): | ||
| content = "\n".join(rctx.attr.toolchains) | ||
| rctx.file("BUILD.bazel", content = content) | ||
|
|
||
| _all_toolchains = repository_rule( | ||
| implementation = _all_toolchains_impl, | ||
| attrs = { | ||
| "toolchains": attr.string_list( | ||
| doc = "All the `toolchain(...)` declarations for the bindist toolchains as string", | ||
| ), | ||
| }, | ||
| doc = """ Used to generate the `all_bindist_toolchains` external repository. | ||
| We can then invoque `register_toolchains("@all_bindist_toolchains//:all")` in the MODULE.bazel file. | ||
| """, | ||
| ) | ||
|
|
||
| def _haskell_toolchains_impl(mctx): | ||
| # We gather the declarations of all the toolchains in the `toolchain_declarations` list | ||
| # in order to write them to the `@all_bindist_toolchains` repository. | ||
|
|
||
| # The code could be simplified a bit by registering aliases to the | ||
| # `toolchain` rules, once the following issue is resolved | ||
| # https://github.com/bazelbuild/bazel/issues/16298 | ||
| toolchain_declarations = [] | ||
|
|
||
| toolchain_names = [] | ||
| found_bindists = False | ||
| for module in mctx.modules: | ||
| for bindist_tag in module.tags.bindist: | ||
| name = "bindist_{}_{}_{}".format(module.name, module.version, bindist_tag.name) | ||
| if name in toolchain_names: | ||
| fail( | ||
| """Module "{module}~{version}" used the "bindist" tag twice with the "{tag_name}" name.""".format( | ||
| tag_name = bindist_tag.name, | ||
| module = module.name, | ||
| version = module.version, | ||
| ), | ||
| ) | ||
| else: | ||
| toolchain_names.append(name) | ||
| ghc_bindist( | ||
| name = name, | ||
| version = bindist_tag.version, | ||
| target = bindist_tag.target, | ||
| ghcopts = bindist_tag.ghcopts, | ||
| haddock_flags = bindist_tag.haddock_flags, | ||
| repl_ghci_args = bindist_tag.repl_ghci_args, | ||
| cabalopts = bindist_tag.cabalopts, | ||
| locale = bindist_tag.locale, | ||
| register = False, | ||
| ) | ||
| toolchain_declarations.append( | ||
| ghc_bindist_toolchain_declaration( | ||
| target = bindist_tag.target, | ||
| bindist_name = name, | ||
| toolchain_name = name, | ||
| ), | ||
| ) | ||
|
|
||
| if len(module.tags.bindists) > 1: | ||
| fail( | ||
| """Module "{module}~{version}" used the "bindists" tag more than once.""".format( | ||
| module = module.name, | ||
| version = module.version, | ||
| ), | ||
| ) | ||
| for bindists_tag in module.tags.bindists: | ||
| # We only consider the first `bindists` tag, because subsequent | ||
| # ones would have the same constraints and lower priority. | ||
| if not found_bindists: | ||
| found_bindists = True | ||
| haskell_register_ghc_bindists( | ||
| version = bindists_tag.version, | ||
| ghcopts = bindists_tag.ghcopts, | ||
| haddock_flags = bindists_tag.haddock_flags, | ||
| repl_ghci_args = bindists_tag.repl_ghci_args, | ||
| cabalopts = bindists_tag.cabalopts, | ||
| locale = bindists_tag.locale, | ||
| register = False, | ||
| ) | ||
| toolchain_declarations.extend( | ||
| ghc_bindists_toolchain_declarations(bindists_tag.version), | ||
| ) | ||
|
|
||
| _all_toolchains( | ||
| name = "all_bindist_toolchains", | ||
| toolchains = toolchain_declarations, | ||
| ) | ||
|
|
||
| haskell_toolchains = module_extension( | ||
| implementation = _haskell_toolchains_impl, | ||
| tag_classes = { | ||
| "bindist": _bindist_tag, | ||
| "bindists": _bindists_tag, | ||
| }, | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters