Explicit export lists in the DAML-LF Haskell module (digital-asset#813)

* Delete an entirely unused module * Delete an entirely unused module * Switch the compiler to use EUnit over mkEUnit * Delete an unused module * Whitespace only * Clean up the API for World, don't expose the internals, better creation functions * Clean up the type checker environment, don't expose the internals of Gamma, add a few helper functions * Delete unused functions * Explicit module export lists * Fix the nub replacement hints * Turn on the warning that we require module export lists * Add an explicit export list
FlashSheridan · May 2, 2019 · 536b1ea · 536b1ea
1 parent 935155c
commit 536b1ea
Show file tree

Hide file tree

Showing 22 changed files with 112 additions and 248 deletions.
diff --git a/.hlint.yaml b/.hlint.yaml
@@ -28,11 +28,14 @@
 # Under Linux/MacOS, Foreign function interface language pragma is unused.
 - ignore: {name: Unused LANGUAGE pragma, within: DA.Sdk.Cli.System}
 
+# Off by default hints we like
+- warn: {name: Use module export list}
+
 # Condemn nub and friends
-- warn: {lhs: nub (sort x), rhs: Data.List.Extended.nubSort x}
-- warn: {lhs: nub, rhs: Data.List.Extended.nubOrd}
-- warn: {lhs: nubBy, rhs: Data.List.Extended.nubOrdBy}
-- warn: {lhs: Data.List.Extra.nubOn, rhs: Data.List.Extended.nubOrdOn}
+- warn: {lhs: nub (sort x), rhs: Data.List.Extra.nubSort x}
+- warn: {lhs: nub, rhs: Data.List.Extra.nubOrd}
+- warn: {lhs: nubBy, rhs: Data.List.Extra.nubOrdBy}
+- warn: {lhs: Data.List.Extra.nubOn, rhs: Data.List.Extra.nubOrdOn}
 
 # DA specific hints
 - warn: {lhs: Data.Text.pack (DA.Pretty.renderPlain x), rhs: DA.Pretty.renderPlain x}

diff --git a/bazel_tools/client_server_test/runner/Main.hs b/bazel_tools/client_server_test/runner/Main.hs
@@ -2,7 +2,7 @@
 -- SPDX-License-Identifier: Apache-2.0
 
 {-# LANGUAGE OverloadedStrings #-}
-module Main where
+module Main(main) where
 
 import qualified Data.Text as T
 import qualified Data.Text.IO as T

diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast.hs
@@ -6,9 +6,8 @@ module DA.Daml.LF.Ast
   ( module LF
   ) where
 
-import DA.Daml.LF.Ast.Base   as LF
-import DA.Daml.LF.Ast.Make   as LF
-import DA.Daml.LF.Ast.Util   as LF
+import DA.Daml.LF.Ast.Base as LF
+import DA.Daml.LF.Ast.Util as LF
 import DA.Daml.LF.Ast.Version as LF
-import DA.Daml.LF.Ast.World  as LF
+import DA.Daml.LF.Ast.World as LF
 import DA.Daml.LF.Ast.Pretty ()
diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Base.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Base.hs
@@ -8,7 +8,9 @@
 {-# LANGUAGE TemplateHaskell    #-}
 {-# LANGUAGE TypeFamilies #-}
 -- | Types and pretty-printer for the AST of the DAML Ledger Fragment.
-module DA.Daml.LF.Ast.Base where
+module DA.Daml.LF.Ast.Base(
+    module DA.Daml.LF.Ast.Base
+    ) where
 
 import DA.Prelude
 

diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Conversion.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Conversion.hs
diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Make.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Make.hs
diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Optics.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Optics.hs
@@ -5,7 +5,16 @@
 {-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE MultiParamTypeClasses #-}
 {-# LANGUAGE RankNTypes #-}
-module DA.Daml.LF.Ast.Optics where
+module DA.Daml.LF.Ast.Optics(
+    moduleModuleRef,
+    unlocate,
+    moduleExpr,
+    dataConsType,
+    _PRSelfModule,
+    exprPartyLiteral,
+    exprValueRef,
+    templateExpr
+    ) where
 
 import DA.Prelude
 
@@ -75,10 +84,6 @@ moduleExpr f (Module name path flags dataTypes values templates) =
   <$> (NM.traverse . _dvalBody) f values
   <*> (NM.traverse . templateExpr) f templates
 
-packageExpr :: Traversal' Package Expr
-packageExpr f (Package version modules) =
-    Package version <$> (NM.traverse . moduleExpr) f modules
-
 dataConsType :: Traversal' DataCons Type
 dataConsType f = \case
   DataRecord  fs -> DataRecord  <$> (traverse . _2) f fs

diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Pretty.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Pretty.hs
@@ -5,7 +5,12 @@
 {-# LANGUAGE FlexibleInstances  #-}
 {-# LANGUAGE OverloadedStrings  #-}
 {-# LANGUAGE PatternSynonyms #-}
-module DA.Daml.LF.Ast.Pretty where
+module DA.Daml.LF.Ast.Pretty(
+    prettyName,
+    prettyDottedName,
+    prettyQualified,
+    (<:>)
+    ) where
 
 import DA.Prelude
 
@@ -265,9 +270,6 @@ prettyTyArg t = type_ ("@" <> pPrintPrec prettyNormal precHighest t)
 prettyBTyArg :: BuiltinType -> Doc ann
 prettyBTyArg = prettyTyArg . TBuiltin
 
-prettyTyArgTpl :: Qualified TypeConName -> Doc ann
-prettyTyArgTpl tpl = prettyTyArg (TCon tpl)
-
 prettyTmArg :: Expr -> Doc ann
 prettyTmArg = pPrintPrec prettyNormal (succ precEApp)
 

diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Recursive.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Recursive.hs
@@ -6,7 +6,14 @@
 
 -- | This module provides all the boilerplate necessary to make the DAML-LF AST
 -- work with the recursion-schemes package.
-module DA.Daml.LF.Ast.Recursive where
+module DA.Daml.LF.Ast.Recursive(
+    ExprF(..),
+    UpdateF(..),
+    ScenarioF(..),
+    BindingF(..),
+    TypeF(..),
+    retrieveByKeyFKey
+    ) where
 
 import Data.Functor.Foldable
 

diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Subst.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Subst.hs
diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Util.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Util.hs
@@ -4,7 +4,7 @@
 {-# LANGUAGE TypeOperators #-}
 {-# LANGUAGE PatternSynonyms #-}
 {-# LANGUAGE OverloadedStrings #-}
-module DA.Daml.LF.Ast.Util where
+module DA.Daml.LF.Ast.Util(module DA.Daml.LF.Ast.Util) where
 
 import DA.Prelude
 

diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Version.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/Version.hs
@@ -3,7 +3,7 @@
 
 {-# LANGUAGE DeriveAnyClass #-}
 {-# LANGUAGE OverloadedStrings #-}
-module DA.Daml.LF.Ast.Version where
+module DA.Daml.LF.Ast.Version(module DA.Daml.LF.Ast.Version) where
 
 import           DA.Prelude
 import           DA.Pretty

diff --git a/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/World.hs b/compiler/daml-lf-ast/src/DA/Daml/LF/Ast/World.hs
@@ -3,9 +3,20 @@
 
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE TemplateHaskell #-}
-module DA.Daml.LF.Ast.World where
 
-import DA.Prelude
+module DA.Daml.LF.Ast.World(
+    World,
+    initWorld,
+    initWorldSelf,
+    extendWorldSelf,
+    LookupError,
+    lookupTemplate,
+    lookupDataType,
+    lookupChoice,
+    lookupValue,
+    lookupModule
+    ) where
+
 import DA.Pretty
 
 import           Control.Lens
@@ -21,14 +32,11 @@ import DA.Daml.LF.Ast.Version
 -- the modules of the current package. The latter shall always be closed under
 -- module dependencies but we don't enforce this here.
 data World = World
-  { worldImported :: HMS.HashMap PackageId Package
-  , worldSelf :: Package
+  { _worldImported :: HMS.HashMap PackageId Package
+  , _worldSelf :: Package
   }
 
-makeUnderscoreLenses ''World
-
-emptyWorld :: Version -> World
-emptyWorld = initWorld []
+makeLensesFor [("_worldSelf","worldSelf")] ''World
 
 -- | Construct the 'World' from only the imported packages.
 initWorld :: [(PackageId, Package)] -> Version -> World
@@ -46,12 +54,13 @@ initWorld importedPkgs version =
       PRSelf -> PRImport pkgId
       ref@PRImport{} -> ref
 
-singlePackageWorld :: Package -> World
-singlePackageWorld = World HMS.empty
+-- | Create a World with an initial self package
+initWorldSelf :: [(PackageId, Package)] -> Version -> Package -> World
+initWorldSelf a b c = (initWorld a b){_worldSelf = c}
 
 -- | Extend the 'World' by a module in the current package.
-extendWorld :: Module -> World -> World
-extendWorld = over (_worldSelf . _packageModules) . NM.insert
+extendWorldSelf :: Module -> World -> World
+extendWorldSelf = over (worldSelf . _packageModules) . NM.insert
 
 data LookupError
   = LEPackage !PackageId

diff --git a/compiler/daml-lf-tools/src/DA/Daml/LF/InferSerializability.hs b/compiler/daml-lf-tools/src/DA/Daml/LF/InferSerializability.hs
@@ -43,5 +43,5 @@ inferPackage :: [(PackageId, Package)] -> Package -> Either String Package
 inferPackage pkgDeps (Package version mods0) = do
       let infer1 (mods1, world0) mod0 = do
             mod1 <- inferModule world0 mod0
-            pure (NM.insert mod1 mods1, extendWorld mod1 world0)
+            pure (NM.insert mod1 mods1, extendWorldSelf mod1 world0)
       Package version . fst <$> foldlM infer1 (NM.empty, initWorld pkgDeps version) mods0