plutus-tx: split out plutus-tx-plugin

Fixes #1790.

This pulls out the compiler plugin into its own package that just has the stuff that depends on ghc in it (so: the compiler and the plugin itself).

The dependencies on plutus-tx-plugin are gated by “not compiling with GHCJS”. This is important for cross-compilation: the plugin really needs to be provided as a native dependency and won’t work when cross-compiled. So we need another mechanism for supplying it (which Moritz has), and we need to not try and provide it the normal way.

All the stuff that doesn’t depend on ghc is in plutus-tx, so plutus-tx-plugin also depends on plutus-tx. As a nice side-effect, this means that many things don’t actually depend on the plugin, improving our build parallelism a bit.

(Another bonus: now plutus-tx doesn’t have an internal library any more, which is what was causing the issue with the package occasionally appearing as hidden in the playground interpreter. So we can delete a FIXME.)

View on GitHub
File Changes
m
+1/-0
          plutus-exe
          plutus-wallet-api
          plutus-tx
+
          plutus-tx-plugin
          plutus-use-cases
          plutus-ir
          plutus-playground-server
m
+1/-20
        filter = localLib.isPlutus;
      };
      customOverlays = optional forceError errorOverlay;
-
      # Filter down to local packages, except those named in the given list
-
      localButNot = nope:
-
        let okay = builtins.filter (name: !(builtins.elem name nope)) localLib.plutusPkgList;
-
        in name: builtins.elem name okay;
      # We can pass an evaluated version of our packages into
      # iohk-nix, and then we can also get out the compiler
      # so we make sure it uses the same one.
      enableSplitCheck = false;

                      
      filter = localLib.isPlutus;
-
      filterOverrides = {
-
        splitCheck = localButNot [
-
            # Broken for things with test tool dependencies
-
            "plutus-wallet-api"
-
            "plutus-tx"
-
            "plutus-tutorial"
-
            # Broken for things which pick up other files at test runtime
-
            "plutus-playground-server"
-
            "marlowe-playground-server"
-
          ];
-
        haddock = localButNot [
-
            # Haddock is broken for things with internal libraries
-
            "plutus-tx"
-

                      
-
        ];
-
      };
      requiredOverlay = ./nix/overlays/haskell-overrides.nix;
    };

                      
                  haskellPackages.plutus-emulator
                  haskellPackages.plutus-wallet-api
                  haskellPackages.plutus-tx
+
                  haskellPackages.plutus-tx-plugin
                  haskellPackages.plutus-use-cases
                  haskellPackages.plutus-ir
                  haskellPackages.plutus-contract
m
+1/-0
    "plutus-exe"
    "plutus-ir"
    "plutus-tx"
+
    "plutus-tx-plugin"
    "plutus-wallet-api"
    "plutus-emulator"
    "iots-export"
{ pkgs }:
with pkgs.haskell.lib;
self: super: {
-
  # Plugins don't work with static compilation. We can stil use the plutus-tx package,
+
  # Plugins don't work with static compilation. We can stil use the plutus-tx-plugin package,
  # we just can't run the tests.
-
  plutus-tx = dontCheck super.plutus-tx;
+
  plutus-tx-plugin = dontCheck super.plutus-tx-plugin;
}
m
+60/-5
, plutus-contract
, plutus-emulator
, plutus-tx
+
, plutus-tx-plugin
, plutus-wallet-api
, prettyprinter
, profunctors
plutus-contract
plutus-emulator
plutus-tx
+
plutus-tx-plugin
plutus-wallet-api
tasty
tasty-hunit
, newtype-generics
, operational
, plutus-tx
+
, plutus-tx-plugin
, plutus-wallet-api
, prettyprinter
, recursion-schemes
hedgehog
lens
plutus-tx
+
plutus-tx-plugin
plutus-wallet-api
tasty
tasty-hedgehog
, plutus-emulator
, plutus-playground-lib
, plutus-tx
+
, plutus-tx-plugin
, plutus-wallet-api
, process
, prometheus
plutus-emulator
plutus-playground-lib
plutus-tx
+
plutus-tx-plugin
plutus-wallet-api
process
recursion-schemes
plutus-emulator
plutus-playground-lib
plutus-tx
+
plutus-tx-plugin
plutus-wallet-api
prometheus
purescript-bridge
plutus-emulator
plutus-playground-lib
plutus-tx
+
plutus-tx-plugin
plutus-wallet-api
tasty
tasty-golden
, cborg
, containers
, doctest
+
, language-plutus-core
+
, mtl
+
, plutus-ir
+
, prettyprinter
+
, serialise
+
, stdenv
+
, template-haskell
+
, text
+
, th-abstraction
+
}:
+
mkDerivation {
+

                      
+
pname = "plutus-tx";
+
version = "0.1.0.0";
+
src = .././plutus-tx;
+
libraryHaskellDepends = [
+
base
+
bytestring
+
cborg
+
containers
+
language-plutus-core
+
mtl
+
plutus-ir
+
prettyprinter
+
serialise
+
template-haskell
+
text
+
th-abstraction
+
];
+
libraryToolDepends = [
+
doctest
+
];
+
doHaddock = false;
+
description = "Libraries for Plutus Tx and its prelude";
+
license = stdenv.lib.licenses.asl20;
+

                      
+
}) {};
+
"plutus-tx-plugin" = callPackage
+
({
+
  mkDerivation
+
, base
+
, bytestring
+
, cborg
+
, containers
, extra
, ghc
, hedgehog
, lens
, mtl
, plutus-ir
+
, plutus-tx
, prettyprinter
, serialise
, stdenv
}:
mkDerivation {

                      
-
pname = "plutus-tx";
+
pname = "plutus-tx-plugin";
version = "0.1.0.0";
-
src = .././plutus-tx;
+
src = .././plutus-tx-plugin;
libraryHaskellDepends = [
base
bytestring
lens
mtl
plutus-ir
+
plutus-tx
prettyprinter
serialise
template-haskell
text
th-abstraction
transformers
];
-
libraryToolDepends = [
-
doctest
-
];
testHaskellDepends = [
base
bytestring
language-plutus-core
mtl
plutus-ir
+
plutus-tx
prettyprinter
tasty
tasty-hedgehog
, plutus-emulator
, plutus-playground-lib
, plutus-tx
+
, plutus-tx-plugin
, plutus-wallet-api
, prettyprinter
, stdenv
plutus-emulator
plutus-playground-lib
plutus-tx
+
plutus-tx-plugin
plutus-wallet-api
prettyprinter
template-haskell
plutus-contract-tasty
plutus-emulator
plutus-tx
+
plutus-tx-plugin
plutus-wallet-api
prettyprinter
tasty
        plutus-wallet-api -any,
        plutus-tx -any,
        plutus-contract-tasty -any,
-
        aeson -any
\ No newline at end of file
+
        aeson -any
+

                      
+
    if !(impl(ghcjs) || os(ghcjs))
+
        build-depends: plutus-tx-plugin -any
        bytestring -any,
        freer-simple -any,
        aeson -any
+

                      
+
    if !(impl(ghcjs) || os(ghcjs))
+
        build-depends: plutus-tx-plugin -any
        time-units -any,
        transformers -any

                      
+
    if !(impl(ghcjs) || os(ghcjs))
+
        build-depends: plutus-tx-plugin -any
+

                      
library plutus-playground-usecases
    hs-source-dirs: usecases
    other-modules:
        time-units -any,
        transformers -any

                      
+
    if !(impl(ghcjs) || os(ghcjs))
+
        build-depends: plutus-tx-plugin -any
+

                      
    if flag(defer-plugin-errors)
        ghc-options: -fplugin-opt Language.PlutusTx.Plugin:defer-errors

                      
        warp -any,
        yaml -any

                      
+
    if !(impl(ghcjs) || os(ghcjs))
+
        build-depends: plutus-tx-plugin -any
+

                      
test-suite plutus-playground-server-test
    type: exitcode-stdio-1.0
    main-is: Spec.hs
        time-units -any,
        transformers -any,
        plutus-wallet-api -any
+

                      
+
    if !(impl(ghcjs) || os(ghcjs))
+
        build-depends: plutus-tx-plugin -any
    -- runghc is interpreting our code
    , "-fno-ignore-interface-pragmas"
    , "-fobject-code"
-
    -- FIXME: stupid GHC bug still
-
    , "-package plutus-tx"
-
    , "-package plutus-wallet-api"
    ]

                      
mkExpr :: (MonadError PlaygroundError m, MonadIO m) => Evaluation -> m String
+
Apache License
+

                      
+
Version 2.0, January 2004
+

                      
+
http://www.apache.org/licenses/
+

                      
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+

                      
+
1. Definitions.
+

                      
+
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+

                      
+
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+

                      
+
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+

                      
+
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+

                      
+
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+

                      
+
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+

                      
+
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+

                      
+
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+

                      
+
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+

                      
+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+

                      
+
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+

                      
+
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+

                      
+
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+

                      
+
You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
You must cause any modified files to carry prominent notices stating that You changed the files; and
+
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. 
+

                      
+
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+

                      
+
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+

                      
+
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+

                      
+
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+

                      
+
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+

                      
+
END OF TERMS AND CONDITIONS
+
Copyright 2019 Input Output (Hong Kong) Ltd.
+

                      
+
   Licensed under the Apache License, Version 2.0 (the "License");
+
   you may not use this file except in compliance with the License.
+
   You may obtain a copy of the License at
+

                      
+
       http://www.apache.org/licenses/LICENSE-2.0
+

                      
+
   Unless required by applicable law or agreed to in writing, software
+
   distributed under the License is distributed on an "AS IS" BASIS,
+
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
   See the License for the specific language governing permissions and
+
   limitations under the License.
+

                      
+
# plutus-tx-plugin: Plutus Tx compiler plugin
+

                      
+
This contains the Plutus Tx compiler plugin itself. This should
+
be added as a dependency, but used via the functions in the 
+
`plutus-tx` package.
+

                      
+
This is in a separate package because it depends on `ghc`. Packages
+
which need to be cross-compiled should depend on this conditional on
+
`!(impl(ghcjs) || os(ghcjs))`, since when cross-compiling this plugin
+
needs to be provided as a "native" dependency instead.
+
cabal-version: 2.2
+
name: plutus-tx-plugin
+
version: 0.1.0.0
+
license: Apache-2.0
+
license-files:
+
  LICENSE
+
  NOTICE
+
maintainer: [email protected]
+
author: Michael Peyton Jones
+
synopsis: The Plutus Tx compiler and GHC plugin
+
description:
+
    The Plutus Tx compiler and GHC plugin.
+
category: Language
+
build-type: Simple
+
extra-doc-files: README.md
+

                      
+
source-repository head
+
    type: git
+
    location: https://github.com/input-output-hk/plutus
+

                      
+
common lang
+
    default-language: Haskell2010
+
    default-extensions: ExplicitForAll ScopedTypeVariables
+
                        DeriveGeneric StandaloneDeriving DeriveLift
+
                        GeneralizedNewtypeDeriving DeriveFunctor DeriveFoldable
+
                        DeriveTraversable
+
    other-extensions: DeriveAnyClass FlexibleContexts FlexibleInstances
+
                      MultiParamTypeClasses TypeFamilies OverloadedStrings
+
                      MonadComprehensions ConstrainedClassMethods TupleSections GADTs
+
                      RankNTypes TemplateHaskell QuasiQuotes TypeApplications
+
                      ExistentialQuantification
+
    ghc-options: -Wall -Wnoncanonical-monad-instances
+
                 -Wincomplete-uni-patterns -Wincomplete-record-updates
+
                 -Wredundant-constraints -Widentities
+
                 -- See Plutus Tx readme
+
                 -fobject-code -fno-ignore-interface-pragmas -fno-omit-interface-pragmas
+

                      
+
library
+
    import: lang
+
    hs-source-dirs: src
+
    exposed-modules:
+
        Language.PlutusTx.Plugin
+
    other-modules:
+
        Language.PlutusTx.PLCTypes
+
        Language.PlutusTx.PIRTypes
+
        Language.PlutusTx.Compiler.Error
+
        Language.PlutusTx.Compiler.Binders
+
        Language.PlutusTx.Compiler.Builtins
+
        Language.PlutusTx.Compiler.Laziness
+
        Language.PlutusTx.Compiler.Expr
+
        Language.PlutusTx.Compiler.Names
+
        Language.PlutusTx.Compiler.Kind
+
        Language.PlutusTx.Compiler.Primitives
+
        Language.PlutusTx.Compiler.Type
+
        Language.PlutusTx.Compiler.Types
+
        Language.PlutusTx.Compiler.Utils
+
        Language.PlutusTx.Compiler.ValueRestriction
+
    build-depends:
+
        base >=4.9 && <5,
+
        bytestring -any,
+
        containers -any,
+
        extra -any,
+
        ghc >=8.6 && <8.7,
+
        language-plutus-core -any,
+
        lens -any,
+
        mtl -any,
+
        plutus-ir -any,
+
        prettyprinter -any,
+
        serialise -any,
+
        template-haskell -any,
+
        text -any,
+
        transformers -any,
+
        plutus-tx -any,
+

                      
+
test-suite plutus-tx-tests
+
    type: exitcode-stdio-1.0
+
    hs-source-dirs: test
+
    main-is: Spec.hs
+
    other-modules:
+
        Lift.Spec
+
        Plugin.Spec
+
        Plugin.Basic.Spec
+
        Plugin.Data.Spec
+
        Plugin.Errors.Spec
+
        Plugin.Functions.Spec
+
        Plugin.Laziness.Spec
+
        Plugin.Primitives.Spec
+
        Plugin.ReadValue.Spec
+
        Plugin.Typeclasses.Spec
+
        Plugin.Typeclasses.Lib
+
        Plugin.Lib
+
        StdLib.Spec
+
        TH.Spec
+
        TH.TestTH
+
    default-language: Haskell2010
+
    build-depends:
+
        base >=4.9 && <5,
+
        integer-gmp -any,
+
        language-plutus-core -any,
+
        plutus-tx -any,
+
        plutus-tx-plugin -any,
+
        plutus-ir -any,
+
        prettyprinter -any,
+
        mtl -any,
+
        bytestring -any,
+
        template-haskell -any,
+
        tasty -any,
+
        tasty-hunit -any,
+
        tasty-hedgehog -any,
+
        hedgehog -any,
+
    -- this makes the plugin give better errors
+
    ghc-options: -g
import           Language.PlutusTx.Compiler.Utils
import           Language.PlutusTx.Compiler.ValueRestriction
import           Language.PlutusTx.PIRTypes
-
import           Language.PlutusTx.Utils

                      
import qualified Language.PlutusIR                           as PIR
import qualified Language.PlutusIR.Compiler.Definitions      as PIR
(\ x,y : <builtin int> . <builtin addInteger> x y) -- No type error any more, abstraction is gone
-}

                      
+
mkBuiltin :: PLC.BuiltinName -> PIR.Term tyname name ()
+
mkBuiltin n = PIR.Builtin () $ PLC.BuiltinName () n
+

                      
+
mkDynBuiltin :: PLC.DynamicBuiltinName -> PIR.Term tyname name ()
+
mkDynBuiltin n = PIR.Builtin () $ PLC.DynBuiltinName () n
+

                      
-- | The 'TH.Name's for which 'BuiltinNameInfo' needs to be provided.
builtinNames :: [TH.Name]
builtinNames = [