on master help sign in
245 files changed+27014−15291
since splitsnapshots
unifiedsplit
.github/CONTRIBUTING.md+18−20 .github/PULL_REQUEST_TEMPLATE.md+18 .github/workflows/set-issue-expectations.yml+21 .github/workflows/set-pull-expectations.yml+19 .gitignore+1 .travis.yml+28 ContributorAgreement.pdf LICENSE+6−25 README.md+10−5 builder/src/BackgroundWriter.hs+42 builder/src/Build.hs+1251 builder/src/Deps/Bump.hs+37 builder/src/Deps/Cache.hs−248 builder/src/Deps/Diff.hs+56−36 builder/src/Deps/Explorer.hs−116 builder/src/Deps/Plan.hs−64 builder/src/Deps/Registry.hs+213 builder/src/Deps/Solver.hs+396−54 builder/src/Deps/Verify.hs−388 builder/src/Deps/Website.hs+13−330 builder/src/Elm/Bump.hs−138 builder/src/Elm/Details.hs+833 builder/src/Elm/Diff.hs−283 builder/src/Elm/Install.hs−448 builder/src/Elm/Outline.hs+407 builder/src/Elm/PerUserCache.hs−46 builder/src/Elm/Project.hs−101 builder/src/Elm/Project/Json.hs−385 builder/src/Elm/Project/Root.hs−95 builder/src/Elm/Project/Summary.hs−108 builder/src/Elm/Publish.hs−255 builder/src/File/IO.hs → builder/src/File.hs+104−110 builder/src/File/Args.hs−40 builder/src/File/Compile.hs−191 builder/src/File/Crawl.hs−297 builder/src/File/Find.hs−114 builder/src/File/Hash.hs−110 builder/src/File/Header.hs−190 builder/src/File/Plan.hs−205 builder/src/File/Watcher.hs−76 builder/src/Generate.hs+211 builder/src/Generate/Artifacts.hs−138 builder/src/Generate/Output.hs−295 builder/src/Http.hs+244 builder/src/Reporting.hs+474 builder/src/Reporting/Exit.hs+2015−64 builder/src/Reporting/Exit/Assets.hs−227 builder/src/Reporting/Exit/Bump.hs−51 builder/src/Reporting/Exit/Compile.hs−105 builder/src/Reporting/Exit/Crawl.hs−346 builder/src/Reporting/Exit/Deps.hs−123 builder/src/Reporting/Exit/Diff.hs−72 builder/src/Reporting/Exit/Help.hs+18−18 builder/src/Reporting/Exit/Http.hs−104 builder/src/Reporting/Exit/Init.hs−49 builder/src/Reporting/Exit/Install.hs−82 builder/src/Reporting/Exit/Make.hs−75 builder/src/Reporting/Exit/Publish.hs−241 builder/src/Reporting/Progress.hs−117 builder/src/Reporting/Progress/Bar.hs−43 builder/src/Reporting/Progress/Json.hs−34 builder/src/Reporting/Progress/Repl.hs−30 builder/src/Reporting/Progress/Terminal.hs−379 builder/src/Reporting/Task.hs+76−151 builder/src/Reporting/Task/Http.hs−195 builder/src/Stuff.hs+179 builder/src/Stuff/Paths.hs−93 builder/src/Stuff/Verify.hs−119 cabal.config+2 compiler/src/AST/Canonical.hs+24−13 compiler/src/AST/Optimized.hs+116−23 compiler/src/AST/Source.hs+47−15 compiler/src/AST/Utils/Binop.hs+5−6 compiler/src/AST/Utils/Shader.hs+51−4 compiler/src/AST/Utils/Type.hs−1 compiler/src/Canonicalize/Environment.hs+50−20 compiler/src/Canonicalize/Environment/Dups.hs+6−3 compiler/src/Canonicalize/Environment/Foreign.hs+80−82 compiler/src/Canonicalize/Environment/Local.hs+8−8 compiler/src/Canonicalize/Expression.hs+6−7 compiler/src/Canonicalize/Module.hs+35−28 compiler/src/Canonicalize/Pattern.hs+3−2 compiler/src/Compile.hs+39−74 compiler/src/Data/Map/Utils.hs+43 compiler/src/Data/Name.hs+166−177 compiler/src/Data/NonEmptyList.hs+78 compiler/src/Data/OneOrMore.hs+51−16 compiler/src/Data/Utf8.hs+158−300 compiler/src/Elm/Compiler.hs−94 compiler/src/Elm/Compiler/Imports.hs+4−13 compiler/src/Elm/Compiler/Objects.hs−108 compiler/src/Elm/Compiler/Type.hs+33−35 compiler/src/Elm/Compiler/Type/Extract.hs+69−20 builder/src/Elm/Constraint.hs → compiler/src/Elm/Constraint.hs+55−77 compiler/src/Elm/Docs.hs+218−158 compiler/src/Elm/Float.hs+51 compiler/src/Elm/Header.hs−73 compiler/src/Elm/Interface.hs+95−67 compiler/src/Elm/Kernel.hs+133−128 builder/src/Elm/Licenses.hs → compiler/src/Elm/Licenses.hs+48−65 compiler/src/Elm/Magnitude.hs+24 compiler/src/Elm/ModuleName.hs+81−55 compiler/src/Elm/Package.hs+220−89 compiler/src/Elm/String.hs+133 compiler/src/Elm/Version.hs+79−68 builder/src/Generate/Html.hs → compiler/src/Generate/Html.hs+17−4 compiler/src/Generate/JavaScript.hs+109−98 compiler/src/Generate/JavaScript/Builder.hs+207−217 compiler/src/Generate/JavaScript/Expression.hs+80−79 builder/src/Generate/Functions.hs → compiler/src/Generate/JavaScript/Functions.hs+6−3 compiler/src/Generate/JavaScript/Name.hs+22−12 compiler/src/Generate/JavaScript/Mode.hs → compiler/src/Generate/Mode.hs+10−53 compiler/src/Json/Decode.hs+333−180 compiler/src/Json/Encode.hs+41−26 compiler/src/Json/String.hs+192 builder/src/Generate/Nitpick.hs → compiler/src/Nitpick/Debug.hs+7−19 compiler/src/Nitpick/PatternMatches.hs+10−9 compiler/src/Optimize/DecisionTree.hs+5−5 compiler/src/Optimize/Module.hs+35−38 compiler/src/Optimize/Names.hs+1−7 compiler/src/Optimize/Port.hs+3−3 compiler/src/Parse/Declaration.hs+180−131 compiler/src/Parse/Docs.hs−275 compiler/src/Parse/Expression.hs+330−341 compiler/src/Parse/Keyword.hs+83−84 compiler/src/Parse/Module.hs+330−259 compiler/src/Parse/Number.hs+37−34 compiler/src/Parse/Pattern.hs+138−130 compiler/src/Parse/Primitives.hs+199−123 compiler/src/Parse/Repl.hs−117 compiler/src/Parse/Shader.hs+28−28 compiler/src/Parse/Space.hs+273 compiler/src/Parse/String.hs+343 compiler/src/Parse/Symbol.hs+22−37 compiler/src/Parse/Type.hs+101−103 compiler/src/Parse/Utf8.hs−333 compiler/src/Parse/Utils.hs−256 compiler/src/Parse/Variable.hs+54−49 compiler/src/Reporting/Annotation.hs+1−1 compiler/src/Reporting/Doc.hs+96−54 compiler/src/Reporting/Error.hs+175−22 compiler/src/Reporting/Error/Canonicalize.hs+221−234 compiler/src/Reporting/Error/Docs.hs+144−35 compiler/src/Reporting/Error/Import.hs+162 compiler/src/Reporting/Error/Json.hs+280−270 compiler/src/Reporting/Error/Main.hs+11−11 compiler/src/Reporting/Error/Pattern.hs+9−8 compiler/src/Reporting/Error/Syntax.hs+5688−627 compiler/src/Reporting/Error/Type.hs+111−90 compiler/src/Reporting/Render/Code.hs+181−44 compiler/src/Reporting/Render/Type/Localizer.hs+16−38 compiler/src/Reporting/Report.hs+2−65 compiler/src/Reporting/Result.hs+12−2 compiler/src/Reporting/Warning.hs+13−13 compiler/src/Type/Constrain/Module.hs+3−3 compiler/src/Type/Error.hs+17−126 compiler/src/Type/Solve.hs+11−3 compiler/src/Type/Unify.hs+12−10 docs/elm.json/application.md+2−2 docs/elm.json/package.md+1−1 upgrade-docs/0.16.md → docs/upgrade-instructions/0.16.md upgrade-docs/0.17.md → docs/upgrade-instructions/0.17.md upgrade-docs/0.18.md → docs/upgrade-instructions/0.18.md upgrade-docs/0.19.md → docs/upgrade-instructions/0.19.0.md docs/upgrade-instructions/0.19.1.md+60 upgrade-docs/earlier.md → docs/upgrade-instructions/earlier.md elm.cabal+69−98 hints/bad-recursion.md+133 hints/comparing-custom-types.md+98 hints/comparing-records.md+85 hints/implicit-casts.md+50 hints/import-cycles.md+184 hints/imports.md+126 hints/infinite-type.md+42 hints/init.md+55 hints/missing-patterns.md+139 hints/optimize.md+59 hints/port-modules.md+32 hints/recursive-alias.md+162 hints/repl.md+73 hints/shadowing.md+70 hints/tuples.md+19 hints/type-annotations.md+60 installers/README.md+32 installers/linux/Dockerfile+39 installers/linux/README.md+93 installers/mac/Distribution.xml+5−3 installers/mac/README.md+93 installers/mac/Resources/en.lproj/background.png installers/mac/Resources/en.lproj/conclusion.rtf+13−6 installers/mac/Resources/en.lproj/welcome.rtf+9−4 installers/mac/helper-scripts/elm-startup.sh+1−1 installers/mac/make-installer.sh+30−3 installers/npm/PUBLISHING.md+29−141 installers/npm/README.md+30−23 installers/npm/bin/elm+47−41 installers/npm/download.js+114 installers/npm/index.js−21 installers/npm/install.js+4 installers/npm/package.json+13−15 installers/npm/troubleshooting.md+76 installers/win/Nsisfile.nsi+16−16 installers/win/README.md+18−3 installers/win/file.ico installers/win/inst.dat+1−2 installers/win/logo.ico installers/win/uninst.dat+1−2 installers/win/welcome.bmp reactor/assets/waiting.gif reactor/elm.json+11−9 reactor/src/Deps.elm+1210 reactor/src/Index.elm+20−15 reactor/src/Index/Navigator.elm+1−1 reactor/src/mock.txt+33 roadmap.md+29 terminal/src/Terminal/Args.hs → terminal/impl/Terminal.hs+36−31 terminal/src/Terminal/Args/Chomp.hs → terminal/impl/Terminal/Chomp.hs+4−5 terminal/src/Terminal/Args/Error.hs → terminal/impl/Terminal/Error.hs+28−18 terminal/impl/Terminal/Helpers.hs+148 terminal/src/Terminal/Args/Internal.hs → terminal/impl/Terminal/Internal.hs+8−8 terminal/src/Bump.hs+158−8 terminal/src/Develop.hs+70−77 terminal/src/Develop/Generate/Index.hs+149−74 terminal/src/Develop/StaticFiles.hs+1−7 terminal/src/Develop/StaticFiles/Build.hs+46−29 terminal/src/Diff.hs+348−6 terminal/src/Init.hs+43−39 terminal/src/Install.hs+401−14 terminal/src/Main.hs+34−39 terminal/src/Make.hs+257−32 terminal/src/Publish.hs+529−8 terminal/src/Repl.hs+522−197 terminal/src/Terminal/Args/Helpers.hs−125 worker/elm.cabal+210 worker/elm.json+26 worker/nginx.conf+22 worker/outlines/compile/elm.json+32 worker/outlines/repl/elm.json+19 worker/src/Artifacts.hs+155 worker/src/Cors.hs+48 worker/src/Endpoint/Compile.hs+323 worker/src/Endpoint/Quotes.hs+114 worker/src/Endpoint/Repl.hs+244 worker/src/Errors.elm+217 worker/src/Main.hs+73
.github/CONTRIBUTING.md+18−20
@@ -4,10 +4,15 @@ Thanks helping with the development of Elm! This document describes the basic
44standards for opening pull requests and making the review process as smooth as
55possible.
66
7−## Licensing
87
9−You need to sign the [contributor agreement](ContributorAgreement.pdf)
10−and send it to <info@elm-lang.org> before opening your pull request.
8+## Expectations
9+
10+- Pull requests are reviewed in [batches](https://github.com/elm/expectations/blob/master/batching.md), so it can take some time to get a response.
11+- Smaller pull requests are easier to review. To fix nine typos, nine specific issues will always go faster than one big one. Learn why [here](https://github.com/elm/expectations/blob/master/small-pull-requests.md).
12+- Reviewers may not know as much as you about certain situations, so add links to supporting evidence for important claims, especially regarding standards for CSS, HTTP, URI, etc.
13+
14+Finally, please be patient with the core team. They are trying their best with limited resources!
15+
1116
1217## Style Guide
1318
@@ -17,27 +22,20 @@ and send it to <info@elm-lang.org> before opening your pull request.
1722[haskell]: https://gist.github.com/evancz/0a1f3717c92fe71702be
1823[js]: https://google.github.io/styleguide/javascriptguide.xml
1924
20−## Branches
2125
22− * [The master branch][master] is the home of the next release of the compiler
23− so new features and improvements get merged there. Most pull requests
24− should target this branch!
26+## Branches
2527
26− * [The stable branch][stable] is for tagging releases and critical bug fixes.
27− This branch is handy for folks who want to build the most recent public
28− release from source.
28+[The master branch][master] is the home of the next release of the compiler
29+so new features and improvements get merged there. Most pull requests
30+should target this branch!
2931
3032[master]: http://github.com/elm-lang/elm/tree/master
31−[stable]: http://github.com/elm-lang/elm/tree/stable
3233
33−If you are working on a fairly large feature, we will probably want to merge it
34−in as its own branch and do some testing before bringing it into the master
35−branch. This way we can keep releases of the master branch independent of new
36−features.
3734
38−Note that the master branch of the compiler should always be in sync with the
39−master branch of the [website][], and the stable branch of the compiler should
40−always be in sync with the stable branch of the [website][]. Make sure that
41−your changes maintain this compatibility.
35+## Licensing
36+
37+Nothing extra to do for this. The default on GitHub described [here](https://docs.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license) is that:
38+
39+> Whenever you add Content to a repository containing notice of a license, you license that Content under the same terms, and you agree that you have the right to license that Content under those terms. If you have a separate agreement to license that Content under different terms, such as a contributor license agreement, that agreement will supersede.
40+
4241
43−[website]: https://github.com/elm-lang/elm-lang.org
.github/PULL_REQUEST_TEMPLATE.mdnew file+18
@@ -0,0 +1,18 @@
1+
2+**Quick Summary:** ???
3+
4+
5+## SSCCE
6+
7+```elm
8+
9+```
10+
11+- **Elm:** ???
12+- **Browser:** ???
13+- **Operating System:** ???
14+
15+
16+## Additional Details
17+
18+???
.github/workflows/set-issue-expectations.ymlnew file+21
@@ -0,0 +1,21 @@
1+name: Set Issue Expectations
2+on:
3+ issues:
4+ types: [opened]
5+jobs:
6+ comment-on-issue:
7+ name: Comment On Issue
8+ runs-on: ubuntu-latest
9+ steps:
10+ - uses: actions/github@v1.0.0
11+ env:
12+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
13+ with:
14+ args: |
15+ comment "Thanks for reporting this! To set expectations:
16+
17+ - Issues are reviewed in [batches](https://github.com/elm/expectations/blob/master/batching.md), so it can take some time to get a response.
18+ - Ask questions in a [community forum](https://elm-lang.org/community). You will get an answer quicker that way!
19+ - If you experience something similar, open a new issue. [We like duplicates](https://github.com/elm/expectations/blob/master/duplicates.md).
20+
21+ Finally, please be patient with the core team. They are trying their best with limited resources."
.github/workflows/set-pull-expectations.ymlnew file+19
@@ -0,0 +1,19 @@
1+on:
2+ pull_request_target:
3+ types: [opened]
4+
5+jobs:
6+ comment-on-pull:
7+ name: Comment On Pull
8+ runs-on: ubuntu-latest
9+ steps:
10+ - uses: actions/github-script@v3
11+ with:
12+ github-token: ${{secrets.GITHUB_TOKEN}}
13+ script: |
14+ github.issues.createComment({
15+ issue_number: context.issue.number,
16+ owner: context.repo.owner,
17+ repo: context.repo.repo,
18+ body: "Thanks for suggesting these code changes. To set expectations:\n\n- Pull requests are reviewed in [batches](https://github.com/elm/expectations/blob/master/batching.md), so it can take some time to get a response.\n- Smaller pull requests are easier to review. To fix nine typos, nine specific issues will always go faster than one big one. Learn why [here](https://github.com/elm/expectations/blob/master/small-pull-requests.md).\n- Reviewers may not know as much as you about certain situations, so add links to supporting evidence for important claims, especially regarding standards for CSS, HTTP, URI, etc.\n\nFinally, please be patient with the core team. They are trying their best with limited resources."
19+ })
.gitignore+1
@@ -5,3 +5,4 @@ cabal-dev
55cabal.sandbox.config
66.DS_Store
77*~
8+travis.log
.travis.ymlnew file+28
@@ -0,0 +1,28 @@
1+language: minimal
2+services: docker
3+
4+env:
5+ global:
6+ - LINUX_ARCHIVE=binary-for-linux-64-bit.gz
7+
8+before_install:
9+ - docker build -t elm -f installers/linux/Dockerfile .
10+ - docker cp $(docker create elm):/usr/local/bin/elm .
11+ - gzip -9 -c elm > $LINUX_ARCHIVE
12+
13+deploy:
14+ provider: releases
15+ api_key:
16+ secure: Yz2Lo4u9rZQ7Ee7ohAsrZpkqsYDUerCSMdSQIH8ryrf7phHhiloPEkTKsM+NupHqU/LEAVsunxbau4QrCEjA2vPavAPVk8cKomRUWK/YjbXHKa24hPkal2c+A2bnMQ6w3qYk/PjL9rW+Goq++/SNLcYZwHBV0Chl2blivMwWCSA=
17+ file: $LINUX_ARCHIVE
18+ skip_cleanup: true
19+ on:
20+ branch: master
21+ tags: true
22+
23+notifications:
24+ email:
25+ recipients:
26+ - rlefevre@dmy.fr
27+ on_success: change
28+ on_failure: change
ContributorAgreement.pdfdeleted

Binary file not shown.

LICENSE+6−25
@@ -1,30 +1,11 @@
1−Copyright (c) 2012-present, Evan Czaplicki
1+Copyright 2012-present Evan Czaplicki
22
3−All rights reserved.
3+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
44
5−Redistribution and use in source and binary forms, with or without
6−modification, are permitted provided that the following conditions are met:
5+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
76
8− * Redistributions of source code must retain the above copyright
9− notice, this list of conditions and the following disclaimer.
7+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
108
11− * Redistributions in binary form must reproduce the above
12− copyright notice, this list of conditions and the following
13− disclaimer in the documentation and/or other materials provided
14− with the distribution.
9+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
1510
16− * Neither the name of Evan Czaplicki nor the names of other
17− contributors may be used to endorse or promote products derived
18− from this software without specific prior written permission.
19−
20−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
11+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
README.md+10−5
@@ -1,17 +1,22 @@
1−# The Elm Compiler
1+# Elm
22
3−Learn about the Elm programming language at [elm-lang.org](http://elm-lang.org/).
3+A delightful language for reliable webapps.
44
5+Check out the [Home Page](http://elm-lang.org/), [Try Online](http://elm-lang.org/try), or [The Official Guide](http://guide.elm-lang.org/)
6+
7+
8+<br>
59
610## Install
711
8−Follow [these instructions][installer]!
12+✨ [Install](https://guide.elm-lang.org/install/elm.html) ✨
913
10− [installer]: https://guide.elm-lang.org/install.html
14+For multiple versions, previous versions, and uninstallation, see the instructions [here](https://github.com/elm/compiler/blob/master/installers/README.md).
1115
16+<br>
1217
1318## Help
1419
1520If you are stuck, ask around on [the Elm slack channel][slack]. Folks are friendly and happy to help with questions!
1621
17−[slack]: http://elmlang.herokuapp.com/
22+[slack]: http://elmlang.herokuapp.com/
builder/src/BackgroundWriter.hsnew file+42
@@ -0,0 +1,42 @@
1+{-# LANGUAGE BangPatterns #-}
2+module BackgroundWriter
3+ ( Scope
4+ , withScope
5+ , writeBinary
6+ )
7+ where
8+
9+
10+import Control.Concurrent (forkIO)
11+import Control.Concurrent.MVar (MVar, newEmptyMVar, newMVar, putMVar, takeMVar)
12+import qualified Data.Binary as Binary
13+import Data.Foldable (traverse_)
14+
15+import qualified File
16+
17+
18+
19+-- BACKGROUND WRITER
20+
21+
22+newtype Scope =
23+ Scope (MVar [MVar ()])
24+
25+
26+withScope :: (Scope -> IO a) -> IO a
27+withScope callback =
28+ do workList <- newMVar []
29+ result <- callback (Scope workList)
30+ mvars <- takeMVar workList
31+ traverse_ takeMVar mvars
32+ return result
33+
34+
35+writeBinary :: (Binary.Binary a) => Scope -> FilePath -> a -> IO ()
36+writeBinary (Scope workList) path value =
37+ do mvar <- newEmptyMVar
38+ _ <- forkIO (File.writeBinary path value >> putMVar mvar ())
39+ oldWork <- takeMVar workList
40+ let !newWork = mvar:oldWork
41+ putMVar workList newWork
42+
builder/src/Build.hsnew file+1251
@@ -0,0 +1,1251 @@
1+{-# OPTIONS_GHC -Wno-unused-do-bind #-}
2+{-# LANGUAGE BangPatterns, GADTs, OverloadedStrings #-}
3+module Build
4+ ( fromExposed
5+ , fromPaths
6+ , fromRepl
7+ , Artifacts(..)
8+ , Root(..)
9+ , Module(..)
10+ , CachedInterface(..)
11+ , ReplArtifacts(..)
12+ , DocsGoal(..)
13+ , getRootNames
14+ )
15+ where
16+
17+
18+import Control.Concurrent (forkIO)
19+import Control.Concurrent.MVar
20+import Control.Monad (filterM, mapM_, sequence_)
21+import qualified Data.ByteString as B
22+import qualified Data.Char as Char
23+import qualified Data.Graph as Graph
24+import qualified Data.List as List
25+import qualified Data.Map.Utils as Map
26+import qualified Data.Map.Strict as Map
27+import Data.Map.Strict ((!))
28+import qualified Data.Maybe as Maybe
29+import qualified Data.Name as Name
30+import qualified Data.NonEmptyList as NE
31+import qualified Data.OneOrMore as OneOrMore
32+import qualified Data.Set as Set
33+import qualified System.Directory as Dir
34+import qualified System.FilePath as FP
35+import System.FilePath ((</>), (<.>))
36+
37+import qualified AST.Canonical as Can
38+import qualified AST.Source as Src
39+import qualified AST.Optimized as Opt
40+import qualified Compile
41+import qualified Elm.Details as Details
42+import qualified Elm.Docs as Docs
43+import qualified Elm.Interface as I
44+import qualified Elm.ModuleName as ModuleName
45+import qualified Elm.Outline as Outline
46+import qualified Elm.Package as Pkg
47+import qualified File
48+import qualified Json.Encode as E
49+import qualified Parse.Module as Parse
50+import qualified Reporting
51+import qualified Reporting.Annotation as A
52+import qualified Reporting.Error as Error
53+import qualified Reporting.Error.Docs as EDocs
54+import qualified Reporting.Error.Syntax as Syntax
55+import qualified Reporting.Error.Import as Import
56+import qualified Reporting.Exit as Exit
57+import qualified Reporting.Render.Type.Localizer as L
58+import qualified Stuff
59+
60+
61+
62+-- ENVIRONMENT
63+
64+
65+data Env =
66+ Env
67+ { _key :: Reporting.BKey
68+ , _root :: FilePath
69+ , _project :: Parse.ProjectType
70+ , _srcDirs :: [AbsoluteSrcDir]
71+ , _buildID :: Details.BuildID
72+ , _locals :: Map.Map ModuleName.Raw Details.Local
73+ , _foreigns :: Map.Map ModuleName.Raw Details.Foreign
74+ }
75+
76+
77+makeEnv :: Reporting.BKey -> FilePath -> Details.Details -> IO Env
78+makeEnv key root (Details.Details _ validOutline buildID locals foreigns _) =
79+ case validOutline of
80+ Details.ValidApp givenSrcDirs ->
81+ do srcDirs <- traverse (toAbsoluteSrcDir root) (NE.toList givenSrcDirs)
82+ return $ Env key root Parse.Application srcDirs buildID locals foreigns
83+
84+ Details.ValidPkg pkg _ _ ->
85+ do srcDir <- toAbsoluteSrcDir root (Outline.RelativeSrcDir "src")
86+ return $ Env key root (Parse.Package pkg) [srcDir] buildID locals foreigns
87+
88+
89+
90+-- SOURCE DIRECTORY
91+
92+
93+newtype AbsoluteSrcDir =
94+ AbsoluteSrcDir FilePath
95+
96+
97+toAbsoluteSrcDir :: FilePath -> Outline.SrcDir -> IO AbsoluteSrcDir
98+toAbsoluteSrcDir root srcDir =
99+ AbsoluteSrcDir <$> Dir.canonicalizePath
100+ (
101+ case srcDir of
102+ Outline.AbsoluteSrcDir dir -> dir
103+ Outline.RelativeSrcDir dir -> root </> dir
104+ )
105+
106+
107+addRelative :: AbsoluteSrcDir -> FilePath -> FilePath
108+addRelative (AbsoluteSrcDir srcDir) path =
109+ srcDir </> path
110+
111+
112+
113+-- FORK
114+
115+
116+-- PERF try using IORef semephore on file crawl phase?
117+-- described in Chapter 13 of Parallel and Concurrent Programming in Haskell by Simon Marlow
118+-- https://www.oreilly.com/library/view/parallel-and-concurrent/9781449335939/ch13.html#sec_conc-par-overhead
119+--
120+fork :: IO a -> IO (MVar a)
121+fork work =
122+ do mvar <- newEmptyMVar
123+ _ <- forkIO $ putMVar mvar =<< work
124+ return mvar
125+
126+
127+{-# INLINE forkWithKey #-}
128+forkWithKey :: (k -> a -> IO b) -> Map.Map k a -> IO (Map.Map k (MVar b))
129+forkWithKey func dict =
130+ Map.traverseWithKey (\k v -> fork (func k v)) dict
131+
132+
133+
134+-- FROM EXPOSED
135+
136+
137+fromExposed :: Reporting.Style -> FilePath -> Details.Details -> DocsGoal docs -> NE.List ModuleName.Raw -> IO (Either Exit.BuildProblem docs)
138+fromExposed style root details docsGoal exposed@(NE.List e es) =
139+ Reporting.trackBuild style $ \key ->
140+ do env <- makeEnv key root details
141+ dmvar <- Details.loadInterfaces root details
142+
143+ -- crawl
144+ mvar <- newEmptyMVar
145+ let docsNeed = toDocsNeed docsGoal
146+ roots <- Map.fromKeysA (fork . crawlModule env mvar docsNeed) (e:es)
147+ putMVar mvar roots
148+ mapM_ readMVar roots
149+ statuses <- traverse readMVar =<< readMVar mvar
150+
151+ -- compile
152+ midpoint <- checkMidpoint dmvar statuses
153+ case midpoint of
154+ Left problem ->
155+ return (Left (Exit.BuildProjectProblem problem))
156+
157+ Right foreigns ->
158+ do rmvar <- newEmptyMVar
159+ resultMVars <- forkWithKey (checkModule env foreigns rmvar) statuses
160+ putMVar rmvar resultMVars
161+ results <- traverse readMVar resultMVars
162+ writeDetails root details results
163+ finalizeExposed root docsGoal exposed results
164+
165+
166+
167+-- FROM PATHS
168+
169+
170+data Artifacts =
171+ Artifacts
172+ { _name :: Pkg.Name
173+ , _deps :: Dependencies
174+ , _roots :: NE.List Root
175+ , _modules :: [Module]
176+ }
177+
178+
179+data Module
180+ = Fresh ModuleName.Raw I.Interface Opt.LocalGraph
181+ | Cached ModuleName.Raw Bool (MVar CachedInterface)
182+
183+
184+type Dependencies =
185+ Map.Map ModuleName.Canonical I.DependencyInterface
186+
187+
188+fromPaths :: Reporting.Style -> FilePath -> Details.Details -> NE.List FilePath -> IO (Either Exit.BuildProblem Artifacts)
189+fromPaths style root details paths =
190+ Reporting.trackBuild style $ \key ->
191+ do env <- makeEnv key root details
192+
193+ elroots <- findRoots env paths
194+ case elroots of
195+ Left problem ->
196+ return (Left (Exit.BuildProjectProblem problem))
197+
198+ Right lroots ->
199+ do -- crawl
200+ dmvar <- Details.loadInterfaces root details
201+ smvar <- newMVar Map.empty
202+ srootMVars <- traverse (fork . crawlRoot env smvar) lroots
203+ sroots <- traverse readMVar srootMVars
204+ statuses <- traverse readMVar =<< readMVar smvar
205+
206+ midpoint <- checkMidpointAndRoots dmvar statuses sroots
207+ case midpoint of
208+ Left problem ->
209+ return (Left (Exit.BuildProjectProblem problem))
210+
211+ Right foreigns ->
212+ do -- compile
213+ rmvar <- newEmptyMVar
214+ resultsMVars <- forkWithKey (checkModule env foreigns rmvar) statuses
215+ putMVar rmvar resultsMVars
216+ rrootMVars <- traverse (fork . checkRoot env resultsMVars) sroots
217+ results <- traverse readMVar resultsMVars
218+ writeDetails root details results
219+ toArtifacts env foreigns results <$> traverse readMVar rrootMVars
220+
221+
222+
223+-- GET ROOT NAMES
224+
225+
226+getRootNames :: Artifacts -> NE.List ModuleName.Raw
227+getRootNames (Artifacts _ _ roots _) =
228+ fmap getRootName roots
229+
230+
231+getRootName :: Root -> ModuleName.Raw
232+getRootName root =
233+ case root of
234+ Inside name -> name
235+ Outside name _ _ -> name
236+
237+
238+
239+-- CRAWL
240+
241+
242+type StatusDict =
243+ Map.Map ModuleName.Raw (MVar Status)
244+
245+
246+data Status
247+ = SCached Details.Local
248+ | SChanged Details.Local B.ByteString Src.Module DocsNeed
249+ | SBadImport Import.Problem
250+ | SBadSyntax FilePath File.Time B.ByteString Syntax.Error
251+ | SForeign Pkg.Name
252+ | SKernel
253+
254+
255+crawlDeps :: Env -> MVar StatusDict -> [ModuleName.Raw] -> a -> IO a
256+crawlDeps env mvar deps blockedValue =
257+ do statusDict <- takeMVar mvar
258+ let depsDict = Map.fromKeys (\_ -> ()) deps
259+ let newsDict = Map.difference depsDict statusDict
260+ statuses <- Map.traverseWithKey crawlNew newsDict
261+ putMVar mvar (Map.union statuses statusDict)
262+ mapM_ readMVar statuses
263+ return blockedValue
264+ where
265+ crawlNew name () = fork (crawlModule env mvar (DocsNeed False) name)
266+
267+
268+crawlModule :: Env -> MVar StatusDict -> DocsNeed -> ModuleName.Raw -> IO Status
269+crawlModule env@(Env _ root projectType srcDirs buildID locals foreigns) mvar docsNeed name =
270+ do let fileName = ModuleName.toFilePath name <.> "elm"
271+
272+ paths <- filterM File.exists (map (`addRelative` fileName) srcDirs)
273+
274+ case paths of
275+ [path] ->
276+ case Map.lookup name foreigns of
277+ Just (Details.Foreign dep deps) ->
278+ return $ SBadImport $ Import.Ambiguous path [] dep deps
279+
280+ Nothing ->
281+ do newTime <- File.getTime path
282+ case Map.lookup name locals of
283+ Nothing ->
284+ crawlFile env mvar docsNeed name path newTime buildID
285+
286+ Just local@(Details.Local oldPath oldTime deps _ lastChange _) ->
287+ if path /= oldPath || oldTime /= newTime || needsDocs docsNeed
288+ then crawlFile env mvar docsNeed name path newTime lastChange
289+ else crawlDeps env mvar deps (SCached local)
290+
291+ p1:p2:ps ->
292+ return $ SBadImport $ Import.AmbiguousLocal (FP.makeRelative root p1) (FP.makeRelative root p2) (map (FP.makeRelative root) ps)
293+
294+ [] ->
295+ case Map.lookup name foreigns of
296+ Just (Details.Foreign dep deps) ->
297+ case deps of
298+ [] ->
299+ return $ SForeign dep
300+
301+ d:ds ->
302+ return $ SBadImport $ Import.AmbiguousForeign dep d ds
303+
304+ Nothing ->
305+ if Name.isKernel name && Parse.isKernel projectType then
306+ do exists <- File.exists ("src" </> ModuleName.toFilePath name <.> "js")
307+ return $ if exists then SKernel else SBadImport Import.NotFound
308+ else
309+ return $ SBadImport Import.NotFound
310+
311+
312+crawlFile :: Env -> MVar StatusDict -> DocsNeed -> ModuleName.Raw -> FilePath -> File.Time -> Details.BuildID -> IO Status
313+crawlFile env@(Env _ root projectType _ buildID _ _) mvar docsNeed expectedName path time lastChange =
314+ do source <- File.readUtf8 (root </> path)
315+
316+ case Parse.fromByteString projectType source of
317+ Left err ->
318+ return $ SBadSyntax path time source err
319+
320+ Right modul@(Src.Module maybeActualName _ _ imports values _ _ _ _) ->
321+ case maybeActualName of
322+ Nothing ->
323+ return $ SBadSyntax path time source (Syntax.ModuleNameUnspecified expectedName)
324+
325+ Just name@(A.At _ actualName) ->
326+ if expectedName == actualName then
327+ let
328+ deps = map Src.getImportName imports
329+ local = Details.Local path time deps (any isMain values) lastChange buildID
330+ in
331+ crawlDeps env mvar deps (SChanged local source modul docsNeed)
332+ else
333+ return $ SBadSyntax path time source (Syntax.ModuleNameMismatch expectedName name)
334+
335+
336+isMain :: A.Located Src.Value -> Bool
337+isMain (A.At _ (Src.Value (A.At _ name) _ _ _)) =
338+ name == Name._main
339+
340+
341+
342+-- CHECK MODULE
343+
344+
345+type ResultDict =
346+ Map.Map ModuleName.Raw (MVar Result)
347+
348+
349+data Result
350+ = RNew !Details.Local !I.Interface !Opt.LocalGraph !(Maybe Docs.Module)
351+ | RSame !Details.Local !I.Interface !Opt.LocalGraph !(Maybe Docs.Module)
352+ | RCached Bool Details.BuildID (MVar CachedInterface)
353+ | RNotFound Import.Problem
354+ | RProblem Error.Module
355+ | RBlocked
356+ | RForeign I.Interface
357+ | RKernel
358+
359+
360+data CachedInterface
361+ = Unneeded
362+ | Loaded I.Interface
363+ | Corrupted
364+
365+
366+checkModule :: Env -> Dependencies -> MVar ResultDict -> ModuleName.Raw -> Status -> IO Result
367+checkModule env@(Env _ root projectType _ _ _ _) foreigns resultsMVar name status =
368+ case status of
369+ SCached local@(Details.Local path time deps hasMain lastChange lastCompile) ->
370+ do results <- readMVar resultsMVar
371+ depsStatus <- checkDeps root results deps lastCompile
372+ case depsStatus of
373+ DepsChange ifaces ->
374+ do source <- File.readUtf8 path
375+ case Parse.fromByteString projectType source of
376+ Right modul -> compile env (DocsNeed False) local source ifaces modul
377+ Left err ->
378+ return $ RProblem $
379+ Error.Module name path time source (Error.BadSyntax err)
380+
381+ DepsSame _ _ ->
382+ do mvar <- newMVar Unneeded
383+ return (RCached hasMain lastChange mvar)
384+
385+ DepsBlock ->
386+ return RBlocked
387+
388+ DepsNotFound problems ->
389+ do source <- File.readUtf8 path
390+ return $ RProblem $ Error.Module name path time source $
391+ case Parse.fromByteString projectType source of
392+ Right (Src.Module _ _ _ imports _ _ _ _ _) ->
393+ Error.BadImports (toImportErrors env results imports problems)
394+
395+ Left err ->
396+ Error.BadSyntax err
397+
398+ SChanged local@(Details.Local path time deps _ _ lastCompile) source modul@(Src.Module _ _ _ imports _ _ _ _ _) docsNeed ->
399+ do results <- readMVar resultsMVar
400+ depsStatus <- checkDeps root results deps lastCompile
401+ case depsStatus of
402+ DepsChange ifaces ->
403+ compile env docsNeed local source ifaces modul
404+
405+ DepsSame same cached ->
406+ do maybeLoaded <- loadInterfaces root same cached
407+ case maybeLoaded of
408+ Nothing -> return RBlocked
409+ Just ifaces -> compile env docsNeed local source ifaces modul
410+
411+ DepsBlock ->
412+ return RBlocked
413+
414+ DepsNotFound problems ->
415+ return $ RProblem $ Error.Module name path time source $
416+ Error.BadImports (toImportErrors env results imports problems)
417+
418+ SBadImport importProblem ->
419+ return (RNotFound importProblem)
420+
421+ SBadSyntax path time source err ->
422+ return $ RProblem $ Error.Module name path time source $
423+ Error.BadSyntax err
424+
425+ SForeign home ->
426+ case foreigns ! ModuleName.Canonical home name of
427+ I.Public iface -> return (RForeign iface)
428+ I.Private _ _ _ -> error $ "mistakenly seeing private interface for " ++ Pkg.toChars home ++ " " ++ ModuleName.toChars name
429+
430+ SKernel ->
431+ return RKernel
432+
433+
434+
435+-- CHECK DEPS
436+
437+
438+data DepsStatus
439+ = DepsChange (Map.Map ModuleName.Raw I.Interface)
440+ | DepsSame [Dep] [CDep]
441+ | DepsBlock
442+ | DepsNotFound (NE.List (ModuleName.Raw, Import.Problem))
443+
444+
445+checkDeps :: FilePath -> ResultDict -> [ModuleName.Raw] -> Details.BuildID -> IO DepsStatus
446+checkDeps root results deps lastCompile =
447+ checkDepsHelp root results deps [] [] [] [] False 0 lastCompile
448+
449+
450+type Dep = (ModuleName.Raw, I.Interface)
451+type CDep = (ModuleName.Raw, MVar CachedInterface)
452+
453+
454+checkDepsHelp :: FilePath -> ResultDict -> [ModuleName.Raw] -> [Dep] -> [Dep] -> [CDep] -> [(ModuleName.Raw,Import.Problem)] -> Bool -> Details.BuildID -> Details.BuildID -> IO DepsStatus
455+checkDepsHelp root results deps new same cached importProblems isBlocked lastDepChange lastCompile =
456+ case deps of
457+ dep:otherDeps ->
458+ do result <- readMVar (results ! dep)
459+ case result of
460+ RNew (Details.Local _ _ _ _ lastChange _) iface _ _ ->
461+ checkDepsHelp root results otherDeps ((dep,iface) : new) same cached importProblems isBlocked (max lastChange lastDepChange) lastCompile
462+
463+ RSame (Details.Local _ _ _ _ lastChange _) iface _ _ ->
464+ checkDepsHelp root results otherDeps new ((dep,iface) : same) cached importProblems isBlocked (max lastChange lastDepChange) lastCompile
465+
466+ RCached _ lastChange mvar ->
467+ checkDepsHelp root results otherDeps new same ((dep,mvar) : cached) importProblems isBlocked (max lastChange lastDepChange) lastCompile
468+
469+ RNotFound prob ->
470+ checkDepsHelp root results otherDeps new same cached ((dep,prob) : importProblems) True lastDepChange lastCompile
471+
472+ RProblem _ ->
473+ checkDepsHelp root results otherDeps new same cached importProblems True lastDepChange lastCompile
474+
475+ RBlocked ->
476+ checkDepsHelp root results otherDeps new same cached importProblems True lastDepChange lastCompile
477+
478+ RForeign iface ->
479+ checkDepsHelp root results otherDeps new ((dep,iface) : same) cached importProblems isBlocked lastDepChange lastCompile
480+
481+ RKernel ->
482+ checkDepsHelp root results otherDeps new same cached importProblems isBlocked lastDepChange lastCompile
483+
484+
485+ [] ->
486+ case reverse importProblems of
487+ p:ps ->
488+ return $ DepsNotFound (NE.List p ps)
489+
490+ [] ->
491+ if isBlocked then
492+ return $ DepsBlock
493+
494+ else if null new && lastDepChange <= lastCompile then
495+ return $ DepsSame same cached
496+
497+ else
498+ do maybeLoaded <- loadInterfaces root same cached
499+ case maybeLoaded of
500+ Nothing -> return DepsBlock
501+ Just ifaces -> return $ DepsChange $ Map.union (Map.fromList new) ifaces
502+
503+
504+
505+-- TO IMPORT ERROR
506+
507+
508+toImportErrors :: Env -> ResultDict -> [Src.Import] -> NE.List (ModuleName.Raw, Import.Problem) -> NE.List Import.Error
509+toImportErrors (Env _ _ _ _ _ locals foreigns) results imports problems =
510+ let
511+ knownModules =
512+ Set.unions
513+ [ Map.keysSet foreigns
514+ , Map.keysSet locals
515+ , Map.keysSet results
516+ ]
517+
518+ unimportedModules =
519+ Set.difference knownModules (Set.fromList (map Src.getImportName imports))
520+
521+ regionDict =
522+ Map.fromList (map (\(Src.Import (A.At region name) _ _) -> (name, region)) imports)
523+
524+ toError (name, problem) =
525+ Import.Error (regionDict ! name) name unimportedModules problem
526+ in
527+ fmap toError problems
528+
529+
530+
531+-- LOAD CACHED INTERFACES
532+
533+
534+loadInterfaces :: FilePath -> [Dep] -> [CDep] -> IO (Maybe (Map.Map ModuleName.Raw I.Interface))
535+loadInterfaces root same cached =
536+ do loading <- traverse (fork . loadInterface root) cached
537+ maybeLoaded <- traverse readMVar loading
538+ case sequence maybeLoaded of
539+ Nothing ->
540+ return Nothing
541+
542+ Just loaded ->
543+ return $ Just $ Map.union (Map.fromList loaded) (Map.fromList same)
544+
545+
546+loadInterface :: FilePath -> CDep -> IO (Maybe Dep)
547+loadInterface root (name, ciMvar) =
548+ do cachedInterface <- takeMVar ciMvar
549+ case cachedInterface of
550+ Corrupted ->
551+ do putMVar ciMvar cachedInterface
552+ return Nothing
553+
554+ Loaded iface ->
555+ do putMVar ciMvar cachedInterface
556+ return (Just (name, iface))
557+
558+ Unneeded ->
559+ do maybeIface <- File.readBinary (Stuff.elmi root name)
560+ case maybeIface of
561+ Nothing ->
562+ do putMVar ciMvar Corrupted
563+ return Nothing
564+
565+ Just iface ->
566+ do putMVar ciMvar (Loaded iface)
567+ return (Just (name, iface))
568+
569+
570+
571+-- CHECK PROJECT
572+
573+
574+checkMidpoint :: MVar (Maybe Dependencies) -> Map.Map ModuleName.Raw Status -> IO (Either Exit.BuildProjectProblem Dependencies)
575+checkMidpoint dmvar statuses =
576+ case checkForCycles statuses of
577+ Nothing ->
578+ do maybeForeigns <- readMVar dmvar
579+ case maybeForeigns of
580+ Nothing -> return (Left Exit.BP_CannotLoadDependencies)
581+ Just fs -> return (Right fs)
582+
583+ Just (NE.List name names) ->
584+ do _ <- readMVar dmvar
585+ return (Left (Exit.BP_Cycle name names))
586+
587+
588+checkMidpointAndRoots :: MVar (Maybe Dependencies) -> Map.Map ModuleName.Raw Status -> NE.List RootStatus -> IO (Either Exit.BuildProjectProblem Dependencies)
589+checkMidpointAndRoots dmvar statuses sroots =
590+ case checkForCycles statuses of
591+ Nothing ->
592+ case checkUniqueRoots statuses sroots of
593+ Nothing ->
594+ do maybeForeigns <- readMVar dmvar
595+ case maybeForeigns of
596+ Nothing -> return (Left Exit.BP_CannotLoadDependencies)
597+ Just fs -> return (Right fs)
598+
599+ Just problem ->
600+ do _ <- readMVar dmvar
601+ return (Left problem)
602+
603+ Just (NE.List name names) ->
604+ do _ <- readMVar dmvar
605+ return (Left (Exit.BP_Cycle name names))
606+
607+
608+
609+-- CHECK FOR CYCLES
610+
611+
612+checkForCycles :: Map.Map ModuleName.Raw Status -> Maybe (NE.List ModuleName.Raw)
613+checkForCycles modules =
614+ let
615+ !graph = Map.foldrWithKey addToGraph [] modules
616+ !sccs = Graph.stronglyConnComp graph
617+ in
618+ checkForCyclesHelp sccs
619+
620+
621+checkForCyclesHelp :: [Graph.SCC ModuleName.Raw] -> Maybe (NE.List ModuleName.Raw)
622+checkForCyclesHelp sccs =
623+ case sccs of
624+ [] ->
625+ Nothing
626+
627+ scc:otherSccs ->
628+ case scc of
629+ Graph.AcyclicSCC _ -> checkForCyclesHelp otherSccs
630+ Graph.CyclicSCC [] -> checkForCyclesHelp otherSccs
631+ Graph.CyclicSCC (m:ms) -> Just (NE.List m ms)
632+
633+
634+type Node =
635+ ( ModuleName.Raw, ModuleName.Raw, [ModuleName.Raw] )
636+
637+
638+addToGraph :: ModuleName.Raw -> Status -> [Node] -> [Node]
639+addToGraph name status graph =
640+ let
641+ dependencies =
642+ case status of
643+ SCached (Details.Local _ _ deps _ _ _) -> deps
644+ SChanged (Details.Local _ _ deps _ _ _) _ _ _ -> deps
645+ SBadImport _ -> []
646+ SBadSyntax _ _ _ _ -> []
647+ SForeign _ -> []
648+ SKernel -> []
649+ in
650+ (name, name, dependencies) : graph
651+
652+
653+
654+-- CHECK UNIQUE ROOTS
655+
656+
657+checkUniqueRoots :: Map.Map ModuleName.Raw Status -> NE.List RootStatus -> Maybe Exit.BuildProjectProblem
658+checkUniqueRoots insides sroots =
659+ let
660+ outsidesDict =
661+ Map.fromListWith OneOrMore.more (Maybe.mapMaybe rootStatusToNamePathPair (NE.toList sroots))
662+ in
663+ case Map.traverseWithKey checkOutside outsidesDict of
664+ Left problem ->
665+ Just problem
666+
667+ Right outsides ->
668+ case sequence_ (Map.intersectionWithKey checkInside outsides insides) of
669+ Right () -> Nothing
670+ Left problem -> Just problem
671+
672+
673+rootStatusToNamePathPair :: RootStatus -> Maybe (ModuleName.Raw, OneOrMore.OneOrMore FilePath)
674+rootStatusToNamePathPair sroot =
675+ case sroot of
676+ SInside _ -> Nothing
677+ SOutsideOk (Details.Local path _ _ _ _ _) _ modul -> Just (Src.getName modul, OneOrMore.one path)
678+ SOutsideErr _ -> Nothing
679+
680+
681+checkOutside :: ModuleName.Raw -> OneOrMore.OneOrMore FilePath -> Either Exit.BuildProjectProblem FilePath
682+checkOutside name paths =
683+ case OneOrMore.destruct NE.List paths of
684+ NE.List p [] -> Right p
685+ NE.List p1 (p2:_) -> Left (Exit.BP_RootNameDuplicate name p1 p2)
686+
687+
688+checkInside :: ModuleName.Raw -> FilePath -> Status -> Either Exit.BuildProjectProblem ()
689+checkInside name p1 status =
690+ case status of
691+ SCached (Details.Local p2 _ _ _ _ _) -> Left (Exit.BP_RootNameDuplicate name p1 p2)
692+ SChanged (Details.Local p2 _ _ _ _ _) _ _ _ -> Left (Exit.BP_RootNameDuplicate name p1 p2)
693+ SBadImport _ -> Right ()
694+ SBadSyntax _ _ _ _ -> Right ()
695+ SForeign _ -> Right ()
696+ SKernel -> Right ()
697+
698+
699+
700+-- COMPILE MODULE
701+
702+
703+compile :: Env -> DocsNeed -> Details.Local -> B.ByteString -> Map.Map ModuleName.Raw I.Interface -> Src.Module -> IO Result
704+compile (Env key root projectType _ buildID _ _) docsNeed (Details.Local path time deps main lastChange _) source ifaces modul =
705+ let
706+ pkg = projectTypeToPkg projectType
707+ in
708+ case Compile.compile pkg ifaces modul of
709+ Right (Compile.Artifacts canonical annotations objects) ->
710+ case makeDocs docsNeed canonical of
711+ Left err ->
712+ return $ RProblem $
713+ Error.Module (Src.getName modul) path time source (Error.BadDocs err)
714+
715+ Right docs ->
716+ do let name = Src.getName modul
717+ let iface = I.fromModule pkg canonical annotations
718+ let elmi = Stuff.elmi root name
719+ File.writeBinary (Stuff.elmo root name) objects
720+ maybeOldi <- File.readBinary elmi
721+ case maybeOldi of
722+ Just oldi | oldi == iface ->
723+ do -- iface should be fully forced by equality check
724+ Reporting.report key Reporting.BDone
725+ let local = Details.Local path time deps main lastChange buildID
726+ return (RSame local iface objects docs)
727+
728+ _ ->
729+ do -- iface may be lazy still
730+ File.writeBinary elmi iface
731+ Reporting.report key Reporting.BDone
732+ let local = Details.Local path time deps main buildID buildID
733+ return (RNew local iface objects docs)
734+
735+ Left err ->
736+ return $ RProblem $
737+ Error.Module (Src.getName modul) path time source err
738+
739+
740+projectTypeToPkg :: Parse.ProjectType -> Pkg.Name
741+projectTypeToPkg projectType =
742+ case projectType of
743+ Parse.Package pkg -> pkg
744+ Parse.Application -> Pkg.dummyName
745+
746+
747+
748+-- WRITE DETAILS
749+
750+
751+writeDetails :: FilePath -> Details.Details -> Map.Map ModuleName.Raw Result -> IO ()
752+writeDetails root (Details.Details time outline buildID locals foreigns extras) results =
753+ File.writeBinary (Stuff.details root) $
754+ Details.Details time outline buildID (Map.foldrWithKey addNewLocal locals results) foreigns extras
755+
756+
757+addNewLocal :: ModuleName.Raw -> Result -> Map.Map ModuleName.Raw Details.Local -> Map.Map ModuleName.Raw Details.Local
758+addNewLocal name result locals =
759+ case result of
760+ RNew local _ _ _ -> Map.insert name local locals
761+ RSame local _ _ _ -> Map.insert name local locals
762+ RCached _ _ _ -> locals
763+ RNotFound _ -> locals
764+ RProblem _ -> locals
765+ RBlocked -> locals
766+ RForeign _ -> locals
767+ RKernel -> locals
768+
769+
770+
771+-- FINALIZE EXPOSED
772+
773+
774+finalizeExposed :: FilePath -> DocsGoal docs -> NE.List ModuleName.Raw -> Map.Map ModuleName.Raw Result -> IO (Either Exit.BuildProblem docs)
775+finalizeExposed root docsGoal exposed results =
776+ case foldr (addImportProblems results) [] (NE.toList exposed) of
777+ p:ps ->
778+ return $ Left $ Exit.BuildProjectProblem (Exit.BP_MissingExposed (NE.List p ps))
779+
780+ [] ->
781+ case Map.foldr addErrors [] results of
782+ [] -> Right <$> finalizeDocs docsGoal results
783+ e:es -> return $ Left $ Exit.BuildBadModules root e es
784+
785+
786+addErrors :: Result -> [Error.Module] -> [Error.Module]
787+addErrors result errors =
788+ case result of
789+ RNew _ _ _ _ -> errors
790+ RSame _ _ _ _ -> errors
791+ RCached _ _ _ -> errors
792+ RNotFound _ -> errors
793+ RProblem e -> e:errors
794+ RBlocked -> errors
795+ RForeign _ -> errors
796+ RKernel -> errors
797+
798+
799+addImportProblems :: Map.Map ModuleName.Raw Result -> ModuleName.Raw -> [(ModuleName.Raw, Import.Problem)] -> [(ModuleName.Raw, Import.Problem)]
800+addImportProblems results name problems =
801+ case results ! name of
802+ RNew _ _ _ _ -> problems
803+ RSame _ _ _ _ -> problems
804+ RCached _ _ _ -> problems
805+ RNotFound p -> (name, p) : problems
806+ RProblem _ -> problems
807+ RBlocked -> problems
808+ RForeign _ -> problems
809+ RKernel -> problems
810+
811+
812+
813+-- DOCS
814+
815+
816+data DocsGoal a where
817+ KeepDocs :: DocsGoal Docs.Documentation
818+ WriteDocs :: FilePath -> DocsGoal ()
819+ IgnoreDocs :: DocsGoal ()
820+
821+
822+newtype DocsNeed =
823+ DocsNeed { needsDocs :: Bool }
824+
825+
826+toDocsNeed :: DocsGoal a -> DocsNeed
827+toDocsNeed goal =
828+ case goal of
829+ IgnoreDocs -> DocsNeed False
830+ WriteDocs _ -> DocsNeed True
831+ KeepDocs -> DocsNeed True
832+
833+
834+makeDocs :: DocsNeed -> Can.Module -> Either EDocs.Error (Maybe Docs.Module)
835+makeDocs (DocsNeed isNeeded) modul =
836+ if isNeeded then
837+ case Docs.fromModule modul of
838+ Right docs -> Right (Just docs)
839+ Left err -> Left err
840+ else
841+ Right Nothing
842+
843+
844+finalizeDocs :: DocsGoal docs -> Map.Map ModuleName.Raw Result -> IO docs
845+finalizeDocs goal results =
846+ case goal of
847+ KeepDocs ->
848+ return $ Map.mapMaybe toDocs results
849+
850+ WriteDocs path ->
851+ E.writeUgly path $ Docs.encode $ Map.mapMaybe toDocs results
852+
853+ IgnoreDocs ->
854+ return ()
855+
856+
857+toDocs :: Result -> Maybe Docs.Module
858+toDocs result =
859+ case result of
860+ RNew _ _ _ d -> d
861+ RSame _ _ _ d -> d
862+ RCached _ _ _ -> Nothing
863+ RNotFound _ -> Nothing
864+ RProblem _ -> Nothing
865+ RBlocked -> Nothing
866+ RForeign _ -> Nothing
867+ RKernel -> Nothing
868+
869+
870+
871+--------------------------------------------------------------------------------
872+------ NOW FOR SOME REPL STUFF -------------------------------------------------
873+--------------------------------------------------------------------------------
874+
875+
876+-- FROM REPL
877+
878+
879+data ReplArtifacts =
880+ ReplArtifacts
881+ { _repl_home :: ModuleName.Canonical
882+ , _repl_modules :: [Module]
883+ , _repl_localizer :: L.Localizer
884+ , _repl_annotations :: Map.Map Name.Name Can.Annotation
885+ }
886+
887+
888+fromRepl :: FilePath -> Details.Details -> B.ByteString -> IO (Either Exit.Repl ReplArtifacts)
889+fromRepl root details source =
890+ do env@(Env _ _ projectType _ _ _ _) <- makeEnv Reporting.ignorer root details
891+ case Parse.fromByteString projectType source of
892+ Left syntaxError ->
893+ return $ Left $ Exit.ReplBadInput source $ Error.BadSyntax syntaxError
894+
895+ Right modul@(Src.Module _ _ _ imports _ _ _ _ _) ->
896+ do dmvar <- Details.loadInterfaces root details
897+
898+ let deps = map Src.getImportName imports
899+ mvar <- newMVar Map.empty
900+ crawlDeps env mvar deps ()
901+
902+ statuses <- traverse readMVar =<< readMVar mvar
903+ midpoint <- checkMidpoint dmvar statuses
904+
905+ case midpoint of
906+ Left problem ->
907+ return $ Left $ Exit.ReplProjectProblem problem
908+
909+ Right foreigns ->
910+ do rmvar <- newEmptyMVar
911+ resultMVars <- forkWithKey (checkModule env foreigns rmvar) statuses
912+ putMVar rmvar resultMVars
913+ results <- traverse readMVar resultMVars
914+ writeDetails root details results
915+ depsStatus <- checkDeps root resultMVars deps 0
916+ finalizeReplArtifacts env source modul depsStatus resultMVars results
917+
918+
919+finalizeReplArtifacts :: Env -> B.ByteString -> Src.Module -> DepsStatus -> ResultDict -> Map.Map ModuleName.Raw Result -> IO (Either Exit.Repl ReplArtifacts)
920+finalizeReplArtifacts env@(Env _ root projectType _ _ _ _) source modul@(Src.Module _ _ _ imports _ _ _ _ _) depsStatus resultMVars results =
921+ let
922+ pkg =
923+ projectTypeToPkg projectType
924+
925+ compileInput ifaces =
926+ case Compile.compile pkg ifaces modul of
927+ Right (Compile.Artifacts canonical annotations objects) ->
928+ let
929+ h = Can._name canonical
930+ m = Fresh (Src.getName modul) (I.fromModule pkg canonical annotations) objects
931+ ms = Map.foldrWithKey addInside [] results
932+ in
933+ return $ Right $ ReplArtifacts h (m:ms) (L.fromModule modul) annotations
934+
935+ Left errors ->
936+ return $ Left $ Exit.ReplBadInput source errors
937+ in
938+ case depsStatus of
939+ DepsChange ifaces ->
940+ compileInput ifaces
941+
942+ DepsSame same cached ->
943+ do maybeLoaded <- loadInterfaces root same cached
944+ case maybeLoaded of
945+ Just ifaces -> compileInput ifaces
946+ Nothing -> return $ Left $ Exit.ReplBadCache
947+
948+ DepsBlock ->
949+ case Map.foldr addErrors [] results of
950+ [] -> return $ Left $ Exit.ReplBlocked
951+ e:es -> return $ Left $ Exit.ReplBadLocalDeps root e es
952+
953+ DepsNotFound problems ->
954+ return $ Left $ Exit.ReplBadInput source $ Error.BadImports $
955+ toImportErrors env resultMVars imports problems
956+
957+
958+
959+--------------------------------------------------------------------------------
960+--------------------------------------------------------------------------------
961+------ AFTER THIS, EVERYTHING IS ABOUT HANDLING MODULES GIVEN BY FILEPATH ------
962+--------------------------------------------------------------------------------
963+--------------------------------------------------------------------------------
964+
965+
966+
967+-- FIND ROOT
968+
969+
970+data RootLocation
971+ = LInside ModuleName.Raw
972+ | LOutside FilePath
973+
974+
975+findRoots :: Env -> NE.List FilePath -> IO (Either Exit.BuildProjectProblem (NE.List RootLocation))
976+findRoots env paths =
977+ do mvars <- traverse (fork . getRootInfo env) paths
978+ einfos <- traverse readMVar mvars
979+ return $ checkRoots =<< sequence einfos
980+
981+
982+checkRoots :: NE.List RootInfo -> Either Exit.BuildProjectProblem (NE.List RootLocation)
983+checkRoots infos =
984+ let
985+ toOneOrMore loc@(RootInfo absolute _ _) =
986+ (absolute, OneOrMore.one loc)
987+
988+ fromOneOrMore loc locs =
989+ case locs of
990+ [] -> Right ()
991+ loc2:_ -> Left (Exit.BP_MainPathDuplicate (_relative loc) (_relative loc2))
992+ in
993+ fmap (\_ -> fmap _location infos) $
994+ traverse (OneOrMore.destruct fromOneOrMore) $
995+ Map.fromListWith OneOrMore.more $ map toOneOrMore (NE.toList infos)
996+
997+
998+
999+-- ROOT INFO
1000+
1001+
1002+data RootInfo =
1003+ RootInfo
1004+ { _absolute :: FilePath
1005+ , _relative :: FilePath
1006+ , _location :: RootLocation
1007+ }
1008+
1009+
1010+getRootInfo :: Env -> FilePath -> IO (Either Exit.BuildProjectProblem RootInfo)
1011+getRootInfo env path =
1012+ do exists <- File.exists path
1013+ if exists
1014+ then getRootInfoHelp env path =<< Dir.canonicalizePath path
1015+ else return (Left (Exit.BP_PathUnknown path))
1016+
1017+
1018+getRootInfoHelp :: Env -> FilePath -> FilePath -> IO (Either Exit.BuildProjectProblem RootInfo)
1019+getRootInfoHelp (Env _ _ _ srcDirs _ _ _) path absolutePath =
1020+ let
1021+ (dirs, file) = FP.splitFileName absolutePath
1022+ (final, ext) = FP.splitExtension file
1023+ in
1024+ if ext /= ".elm"
1025+ then
1026+ return $ Left $ Exit.BP_WithBadExtension path
1027+ else
1028+ let
1029+ absoluteSegments = FP.splitDirectories dirs ++ [final]
1030+ in
1031+ case Maybe.mapMaybe (isInsideSrcDirByPath absoluteSegments) srcDirs of
1032+ [] ->
1033+ return $ Right $ RootInfo absolutePath path (LOutside path)
1034+
1035+ [(_, Right names)] ->
1036+ do let name = Name.fromChars (List.intercalate "." names)
1037+ matchingDirs <- filterM (isInsideSrcDirByName names) srcDirs
1038+ case matchingDirs of
1039+ d1:d2:_ ->
1040+ do let p1 = addRelative d1 (FP.joinPath names <.> "elm")
1041+ let p2 = addRelative d2 (FP.joinPath names <.> "elm")
1042+ return $ Left $ Exit.BP_RootNameDuplicate name p1 p2
1043+
1044+ _ ->
1045+ return $ Right $ RootInfo absolutePath path (LInside name)
1046+
1047+ [(s, Left names)] ->
1048+ return $ Left $ Exit.BP_RootNameInvalid path s names
1049+
1050+ (s1,_):(s2,_):_ ->
1051+ return $ Left $ Exit.BP_WithAmbiguousSrcDir path s1 s2
1052+
1053+
1054+
1055+isInsideSrcDirByName :: [String] -> AbsoluteSrcDir -> IO Bool
1056+isInsideSrcDirByName names srcDir =
1057+ File.exists (addRelative srcDir (FP.joinPath names <.> "elm"))
1058+
1059+
1060+isInsideSrcDirByPath :: [String] -> AbsoluteSrcDir -> Maybe (FilePath, Either [String] [String])
1061+isInsideSrcDirByPath segments (AbsoluteSrcDir srcDir) =
1062+ case dropPrefix (FP.splitDirectories srcDir) segments of
1063+ Nothing ->
1064+ Nothing
1065+
1066+ Just names ->
1067+ if all isGoodName names
1068+ then Just (srcDir, Right names)
1069+ else Just (srcDir, Left names)
1070+
1071+
1072+isGoodName :: [Char] -> Bool
1073+isGoodName name =
1074+ case name of
1075+ [] ->
1076+ False
1077+
1078+ char:chars ->
1079+ Char.isUpper char && all (\c -> Char.isAlphaNum c || c == '_') chars
1080+
1081+
1082+-- INVARIANT: Dir.canonicalizePath has been run on both inputs
1083+--
1084+dropPrefix :: [FilePath] -> [FilePath] -> Maybe [FilePath]
1085+dropPrefix roots paths =
1086+ case roots of
1087+ [] ->
1088+ Just paths
1089+
1090+ r:rs ->
1091+ case paths of
1092+ [] -> Nothing
1093+ p:ps -> if r == p then dropPrefix rs ps else Nothing
1094+
1095+
1096+
1097+-- CRAWL ROOTS
1098+
1099+
1100+data RootStatus
1101+ = SInside ModuleName.Raw
1102+ | SOutsideOk Details.Local B.ByteString Src.Module
1103+ | SOutsideErr Error.Module
1104+
1105+
1106+crawlRoot :: Env -> MVar StatusDict -> RootLocation -> IO RootStatus
1107+crawlRoot env@(Env _ _ projectType _ buildID _ _) mvar root =
1108+ case root of
1109+ LInside name ->
1110+ do statusMVar <- newEmptyMVar
1111+ statusDict <- takeMVar mvar
1112+ putMVar mvar (Map.insert name statusMVar statusDict)
1113+ putMVar statusMVar =<< crawlModule env mvar (DocsNeed False) name
1114+ return (SInside name)
1115+
1116+ LOutside path ->
1117+ do time <- File.getTime path
1118+ source <- File.readUtf8 path
1119+ case Parse.fromByteString projectType source of
1120+ Right modul@(Src.Module _ _ _ imports values _ _ _ _) ->
1121+ do let deps = map Src.getImportName imports
1122+ let local = Details.Local path time deps (any isMain values) buildID buildID
1123+ crawlDeps env mvar deps (SOutsideOk local source modul)
1124+
1125+ Left syntaxError ->
1126+ return $ SOutsideErr $
1127+ Error.Module "???" path time source (Error.BadSyntax syntaxError)
1128+
1129+
1130+
1131+-- CHECK ROOTS
1132+
1133+
1134+data RootResult
1135+ = RInside ModuleName.Raw
1136+ | ROutsideOk ModuleName.Raw I.Interface Opt.LocalGraph
1137+ | ROutsideErr Error.Module
1138+ | ROutsideBlocked
1139+
1140+
1141+checkRoot :: Env -> ResultDict -> RootStatus -> IO RootResult
1142+checkRoot env@(Env _ root _ _ _ _ _) results rootStatus =
1143+ case rootStatus of
1144+ SInside name ->
1145+ return (RInside name)
1146+
1147+ SOutsideErr err ->
1148+ return (ROutsideErr err)
1149+
1150+ SOutsideOk local@(Details.Local path time deps _ _ lastCompile) source modul@(Src.Module _ _ _ imports _ _ _ _ _) ->
1151+ do depsStatus <- checkDeps root results deps lastCompile
1152+ case depsStatus of
1153+ DepsChange ifaces ->
1154+ compileOutside env local source ifaces modul
1155+
1156+ DepsSame same cached ->
1157+ do maybeLoaded <- loadInterfaces root same cached
1158+ case maybeLoaded of
1159+ Nothing -> return ROutsideBlocked
1160+ Just ifaces -> compileOutside env local source ifaces modul
1161+
1162+ DepsBlock ->
1163+ return ROutsideBlocked
1164+
1165+ DepsNotFound problems ->
1166+ return $ ROutsideErr $ Error.Module (Src.getName modul) path time source $
1167+ Error.BadImports (toImportErrors env results imports problems)
1168+
1169+
1170+compileOutside :: Env -> Details.Local -> B.ByteString -> Map.Map ModuleName.Raw I.Interface -> Src.Module -> IO RootResult
1171+compileOutside (Env key _ projectType _ _ _ _) (Details.Local path time _ _ _ _) source ifaces modul =
1172+ let
1173+ pkg = projectTypeToPkg projectType
1174+ name = Src.getName modul
1175+ in
1176+ case Compile.compile pkg ifaces modul of
1177+ Right (Compile.Artifacts canonical annotations objects) ->
1178+ do Reporting.report key Reporting.BDone
1179+ return $ ROutsideOk name (I.fromModule pkg canonical annotations) objects
1180+
1181+ Left errors ->
1182+ return $ ROutsideErr $ Error.Module name path time source errors
1183+
1184+
1185+
1186+-- TO ARTIFACTS
1187+
1188+
1189+data Root
1190+ = Inside ModuleName.Raw
1191+ | Outside ModuleName.Raw I.Interface Opt.LocalGraph
1192+
1193+
1194+toArtifacts :: Env -> Dependencies -> Map.Map ModuleName.Raw Result -> NE.List RootResult -> Either Exit.BuildProblem Artifacts
1195+toArtifacts (Env _ root projectType _ _ _ _) foreigns results rootResults =
1196+ case gatherProblemsOrMains results rootResults of
1197+ Left (NE.List e es) ->
1198+ Left (Exit.BuildBadModules root e es)
1199+
1200+ Right roots ->
1201+ Right $ Artifacts (projectTypeToPkg projectType) foreigns roots $
1202+ Map.foldrWithKey addInside (foldr addOutside [] rootResults) results
1203+
1204+
1205+gatherProblemsOrMains :: Map.Map ModuleName.Raw Result -> NE.List RootResult -> Either (NE.List Error.Module) (NE.List Root)
1206+gatherProblemsOrMains results (NE.List rootResult rootResults) =
1207+ let
1208+ addResult result (es, roots) =
1209+ case result of
1210+ RInside n -> ( es, Inside n : roots)
1211+ ROutsideOk n i o -> ( es, Outside n i o : roots)
1212+ ROutsideErr e -> (e:es, roots)
1213+ ROutsideBlocked -> ( es, roots)
1214+
1215+ errors = Map.foldr addErrors [] results
1216+ in
1217+ case (rootResult, foldr addResult (errors, []) rootResults) of
1218+ (RInside n , ( [], ms)) -> Right (NE.List (Inside n) ms)
1219+ (RInside _ , (e:es, _ )) -> Left (NE.List e es)
1220+ (ROutsideOk n i o, ( [], ms)) -> Right (NE.List (Outside n i o) ms)
1221+ (ROutsideOk _ _ _, (e:es, _ )) -> Left (NE.List e es)
1222+ (ROutsideErr e , ( es, _ )) -> Left (NE.List e es)
1223+ (ROutsideBlocked , ( [], _ )) -> error "seems like elm-stuff/ is corrupted"
1224+ (ROutsideBlocked , (e:es, _ )) -> Left (NE.List e es)
1225+
1226+
1227+addInside :: ModuleName.Raw -> Result -> [Module] -> [Module]
1228+addInside name result modules =
1229+ case result of
1230+ RNew _ iface objs _ -> Fresh name iface objs : modules
1231+ RSame _ iface objs _ -> Fresh name iface objs : modules
1232+ RCached main _ mvar -> Cached name main mvar : modules
1233+ RNotFound _ -> error (badInside name)
1234+ RProblem _ -> error (badInside name)
1235+ RBlocked -> error (badInside name)
1236+ RForeign _ -> modules
1237+ RKernel -> modules
1238+
1239+
1240+badInside :: ModuleName.Raw -> [Char]
1241+badInside name =
1242+ "Error from `" ++ Name.toChars name ++ "` should have been reported already."
1243+
1244+
1245+addOutside :: RootResult -> [Module] -> [Module]
1246+addOutside root modules =
1247+ case root of
1248+ RInside _ -> modules
1249+ ROutsideOk name iface objs -> Fresh name iface objs : modules
1250+ ROutsideErr _ -> modules
1251+ ROutsideBlocked -> modules
builder/src/Deps/Bump.hsnew file+37
@@ -0,0 +1,37 @@
1+module Deps.Bump
2+ ( getPossibilities
3+ )
4+ where
5+
6+
7+import qualified Data.List as List
8+
9+import qualified Deps.Registry as Registry
10+import qualified Elm.Magnitude as M
11+import qualified Elm.Version as V
12+
13+
14+
15+-- GET POSSIBILITIES
16+
17+
18+getPossibilities :: Registry.KnownVersions -> [(V.Version, V.Version, M.Magnitude)]
19+getPossibilities (Registry.KnownVersions latest previous) =
20+ let
21+ allVersions = reverse (latest:previous)
22+ minorPoints = map last (List.groupBy sameMajor allVersions)
23+ patchPoints = map last (List.groupBy sameMinor allVersions)
24+ in
25+ (latest, V.bumpMajor latest, M.MAJOR)
26+ : map (\v -> (v, V.bumpMinor v, M.MINOR)) minorPoints
27+ ++ map (\v -> (v, V.bumpPatch v, M.PATCH)) patchPoints
28+
29+
30+sameMajor :: V.Version -> V.Version -> Bool
31+sameMajor (V.Version major1 _ _) (V.Version major2 _ _) =
32+ major1 == major2
33+
34+
35+sameMinor :: V.Version -> V.Version -> Bool
36+sameMinor (V.Version major1 minor1 _) (V.Version major2 minor2 _) =
37+ major1 == major2 && minor1 == minor2
builder/src/Deps/Cache.hsdeleted−248
@@ -1,248 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module Deps.Cache
4− ( optionalUpdate
5− , mandatoryUpdate
6− , PackageRegistry
7− , getPackageRegistry
8− , getVersions
9− , getElmJson
10− , getDocs
11− )
12− where
13−
14−
15−import Prelude hiding (all)
16−import Control.Monad (liftM2)
17−import Control.Monad.Except (catchError, liftIO)
18−import Data.Binary (Binary, get, put)
19−import qualified Data.ByteString as BS
20−import Data.Function (on)
21−import qualified Data.List as List
22−import qualified Data.Map as Map
23−import qualified Data.Name as Name
24−import System.FilePath ((</>))
25−
26−import qualified Deps.Website as Website
27−import qualified Elm.Docs as Docs
28−import qualified Elm.Package as Pkg
29−import qualified Elm.Project.Json as Project
30−import qualified Elm.Version as V
31−import qualified File.IO as IO
32−import qualified Json.Decode as Decode
33−import qualified Reporting.Exit as Exit
34−import qualified Reporting.Exit.Assets as E
35−import qualified Reporting.Progress as Progress
36−import qualified Reporting.Suggest as Suggest
37−import qualified Reporting.Task as Task
38−
39−
40−
41−-- PACKAGE REGISTRY
42−
43−
44−data PackageRegistry =
45− PackageRegistry Int (Map.Map Pkg.Name [V.Version])
46−
47−
48−getPackageRegistry :: Task.Task PackageRegistry
49−getPackageRegistry =
50− do path <- getRegistryPath
51− exists <- liftIO $ IO.exists path
52− if exists
53− then unsafeGetRegistry path
54− else rebuild
55−
56−
57−getRegistryPath :: Task.Task FilePath
58−getRegistryPath =
59− do dir <- Task.getPackageCacheDir
60− return (dir </> "versions.dat")
61−
62−
63−unsafeGetRegistry :: FilePath -> Task.Task PackageRegistry
64−unsafeGetRegistry path =
65− do maybeRegistry <- liftIO $ IO.readBinary path
66− case maybeRegistry of
67− Just registry ->
68− return registry
69−
70− Nothing ->
71− liftIO (putStrLn path) >>
72− Task.throw (error "TODO corrupt binary 3")
73−
74−
75−
76−-- REBUILD
77−
78−
79−rebuild :: Task.Task PackageRegistry
80−rebuild =
81− do path <- getRegistryPath
82− packages <- Website.getAllPackages
83− let size = Map.foldr ((+) . length) 0 packages
84− let registry = PackageRegistry size packages
85− liftIO $ IO.writeBinary path registry
86− return registry
87−
88−
89−
90−-- UPDATE
91−
92−
93−optionalUpdate :: Task.Task PackageRegistry
94−optionalUpdate =
95− update False
96−
97−
98−mandatoryUpdate :: Task.Task PackageRegistry
99−mandatoryUpdate =
100− update True
101−
102−
103−update :: Bool -> Task.Task PackageRegistry
104−update isMandatory =
105− do path <- getRegistryPath
106− exists <- liftIO $ IO.exists path
107− if not exists
108− then rebuild
109− else
110− do registry <- unsafeGetRegistry path
111− if isMandatory
112− then attemptUpdate registry
113− else attemptUpdate registry `catchError` recoverUpdate registry
114−
115−
116−recoverUpdate :: PackageRegistry -> a -> Task.Task PackageRegistry
117−recoverUpdate registry _ =
118− do Task.report Progress.UnableToLoadLatestPackages
119− return registry
120−
121−
122−attemptUpdate :: PackageRegistry -> Task.Task PackageRegistry
123−attemptUpdate oldRegistry@(PackageRegistry size packages) =
124− do news <- Website.getNewPackages size
125− case news of
126− [] ->
127− return oldRegistry
128−
129− _:_ ->
130− let
131− newSize = size + length news
132− newPkgs = List.foldl' addNew packages news
133− newRegistry = PackageRegistry newSize newPkgs
134− in
135− do path <- getRegistryPath
136− liftIO $ IO.writeBinary path newRegistry
137− return newRegistry
138−
139−
140−addNew :: Map.Map Pkg.Name [V.Version] -> (Pkg.Name, V.Version) -> Map.Map Pkg.Name [V.Version]
141−addNew packages (name, version) =
142− Map.insertWith (++) name [version] packages
143−
144−
145−
146−-- GET VERSIONS
147−
148−
149−getVersions :: Pkg.Name -> PackageRegistry -> Either [Pkg.Name] [V.Version]
150−getVersions name (PackageRegistry _ pkgs) =
151− case Map.lookup name pkgs of
152− Just vsns ->
153− Right vsns
154−
155− Nothing ->
156− Left (nearbyNames name (Map.keys pkgs))
157−
158−
159−nearbyNames :: Pkg.Name -> [Pkg.Name] -> [Pkg.Name]
160−nearbyNames (Pkg.Name author1 project1) possibleNames =
161− let
162− authorDist = authorDistance (Name.toChars author1)
163− projectDist = projectDistance (Name.toChars project1)
164−
165− addDistance name@(Pkg.Name author2 project2) =
166− ( authorDist author2 + projectDist project2, name )
167− in
168− map snd $ take 4 $
169− List.sortBy (compare `on` fst) $
170− map addDistance possibleNames
171−
172−
173−authorDistance :: String -> Name.Name -> Int
174−authorDistance bad possibility =
175− abs (Suggest.distance bad (Name.toChars possibility))
176−
177−
178−projectDistance :: String -> Name.Name -> Int
179−projectDistance bad possibility =
180− if possibility == "elm" || possibility == "elm-explorations" then
181− 0
182− else
183− abs (Suggest.distance bad (Name.toChars possibility))
184−
185−
186−
187−-- PACKAGE INFO
188−
189−
190−getElmJson :: Pkg.Name -> V.Version -> Task.Task Project.PkgInfo
191−getElmJson name version =
192− do dir <- Task.getPackageCacheDirFor name version
193− let elmJson = dir </> "elm.json"
194−
195− exists <- liftIO $ IO.exists elmJson
196−
197− json <-
198− if exists
199− then liftIO (BS.readFile elmJson)
200− else
201− do bits <- Website.getElmJson name version
202− liftIO (BS.writeFile elmJson bits)
203− return bits
204−
205− case Decode.fromByteString Project.pkgDecoder json of
206− Right pkgInfo ->
207− return pkgInfo
208−
209− Left _ ->
210− do liftIO $ IO.remove elmJson
211− Task.throw $ Exit.Assets $ E.CorruptElmJson name version
212−
213−
214−
215−-- DOCS
216−
217−
218−getDocs :: Pkg.Name -> V.Version -> Task.Task Docs.Documentation
219−getDocs name version =
220− do dir <- Task.getPackageCacheDirFor name version
221− let docsJson = dir </> "docs.json"
222−
223− exists <- liftIO $ IO.exists docsJson
224−
225− json <-
226− if exists
227− then liftIO (BS.readFile docsJson)
228− else
229− do bits <- Website.getDocs name version
230− liftIO (BS.writeFile docsJson bits)
231− return bits
232−
233− case Decode.fromByteString (Docs.toDict <$> Decode.list Docs.decoder) json of
234− Right pkgInfo ->
235− return pkgInfo
236−
237− Left _ ->
238− do liftIO $ IO.remove docsJson
239− Task.throw $ Exit.Assets $ E.CorruptDocumentation name version
240−
241−
242−
243−-- BINARY
244−
245−
246−instance Binary PackageRegistry where
247− get = liftM2 PackageRegistry get get
248− put (PackageRegistry a b) = put a >> put b
builder/src/Deps/Diff.hs+56−36
@@ -4,11 +4,10 @@ module Deps.Diff
44 , PackageChanges(..)
55 , ModuleChanges(..)
66 , Changes(..)
7− , Magnitude(..)
87 , moduleChangeMagnitude
9− , magnitudeToString
108 , toMagnitude
119 , bump
10+ , getDocs
1211 )
1312 where
1413
@@ -19,12 +18,21 @@ import qualified Data.List as List
1918import qualified Data.Map as Map
2019import qualified Data.Name as Name
2120import qualified Data.Set as Set
22−import qualified Data.Utf8 as Utf8
21+import qualified System.Directory as Dir
22+import System.FilePath ((</>))
2323
24+import qualified Deps.Website as Website
2425import qualified Elm.Compiler.Type as Type
2526import qualified Elm.Docs as Docs
27+import qualified Elm.Magnitude as M
2628import qualified Elm.ModuleName as ModuleName
29+import qualified Elm.Package as Pkg
2730import qualified Elm.Version as V
31+import qualified File
32+import qualified Http
33+import qualified Json.Decode as D
34+import qualified Reporting.Exit as Exit
35+import qualified Stuff
2836
2937
3038
@@ -73,7 +81,7 @@ diff :: Docs.Documentation -> Docs.Documentation -> PackageChanges
7381diff oldDocs newDocs =
7482 let
7583 filterOutPatches chngs =
76− Map.filter (\chng -> moduleChangeMagnitude chng /= PATCH) chngs
84+ Map.filter (\chng -> moduleChangeMagnitude chng /= M.PATCH) chngs
7785
7886 (Changes added changed removed) =
7987 getChanges (\_ _ -> False) oldDocs newDocs
@@ -196,7 +204,7 @@ isSameName :: Name.Name -> Name.Name -> Bool
196204isSameName oldFullName newFullName =
197205 let
198206 dedot name =
199− reverse (Utf8.split 0x2E {-.-} (Name.toUtf8 name))
207+ reverse (Name.splitDots name)
200208 in
201209 case ( dedot oldFullName, dedot newFullName ) of
202210 (oldName:[], newName:_) ->
@@ -298,50 +306,30 @@ categorizeVar name
298306-- MAGNITUDE
299307
300308
301−data Magnitude
302− = PATCH
303− | MINOR
304− | MAJOR
305− deriving (Eq, Ord)
306−
307−
308−magnitudeToString :: Magnitude -> String
309−magnitudeToString magnitude =
310− case magnitude of
311− PATCH ->
312− "PATCH"
313−
314− MINOR ->
315− "MINOR"
316−
317− MAJOR ->
318− "MAJOR"
319−
320−
321309bump :: PackageChanges -> V.Version -> V.Version
322310bump changes version =
323311 case toMagnitude changes of
324− PATCH ->
312+ M.PATCH ->
325313 V.bumpPatch version
326314
327− MINOR ->
315+ M.MINOR ->
328316 V.bumpMinor version
329317
330− MAJOR ->
318+ M.MAJOR ->
331319 V.bumpMajor version
332320
333321
334−toMagnitude :: PackageChanges -> Magnitude
322+toMagnitude :: PackageChanges -> M.Magnitude
335323toMagnitude (PackageChanges added changed removed) =
336324 let
337− addMag = if null added then PATCH else MINOR
338− removeMag = if null removed then PATCH else MAJOR
325+ addMag = if null added then M.PATCH else M.MINOR
326+ removeMag = if null removed then M.PATCH else M.MAJOR
339327 changeMags = map moduleChangeMagnitude (Map.elems changed)
340328 in
341329 maximum (addMag : removeMag : changeMags)
342330
343331
344−moduleChangeMagnitude :: ModuleChanges -> Magnitude
332+moduleChangeMagnitude :: ModuleChanges -> M.Magnitude
345333moduleChangeMagnitude (ModuleChanges unions aliases values binops) =
346334 maximum
347335 [ changeMagnitude unions
@@ -351,13 +339,45 @@ moduleChangeMagnitude (ModuleChanges unions aliases values binops) =
351339 ]
352340
353341
354−changeMagnitude :: Changes k v -> Magnitude
342+changeMagnitude :: Changes k v -> M.Magnitude
355343changeMagnitude (Changes added changed removed) =
356344 if Map.size removed > 0 || Map.size changed > 0 then
357− MAJOR
345+ M.MAJOR
358346
359347 else if Map.size added > 0 then
360− MINOR
348+ M.MINOR
361349
362350 else
363− PATCH
351+ M.PATCH
352+
353+
354+
355+-- GET DOCS
356+
357+
358+getDocs :: Stuff.PackageCache -> Http.Manager -> Pkg.Name -> V.Version -> IO (Either Exit.DocsProblem Docs.Documentation)
359+getDocs cache manager name version =
360+ do let home = Stuff.package cache name version
361+ let path = home </> "docs.json"
362+ exists <- File.exists path
363+ if exists
364+ then
365+ do bytes <- File.readUtf8 path
366+ case D.fromByteString Docs.decoder bytes of
367+ Right docs ->
368+ return $ Right docs
369+
370+ Left _ ->
371+ do File.remove path
372+ return $ Left Exit.DP_Cache
373+ else
374+ do let url = Website.metadata name version "docs.json"
375+ Http.get manager url [] Exit.DP_Http $ \body ->
376+ case D.fromByteString Docs.decoder body of
377+ Right docs ->
378+ do Dir.createDirectoryIfMissing True home
379+ File.writeUtf8 path body
380+ return $ Right docs
381+
382+ Left _ ->
383+ return $ Left $ Exit.DP_Data url body
builder/src/Deps/Explorer.hsdeleted−116
@@ -1,116 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module Deps.Explorer
3− ( Explorer
4− , Metadata
5− , Info(..)
6− , run
7− , exists
8− , getVersions
9− , getConstraints
10− )
11− where
12−
13−{-| It is expensive to load ALL package metadata. You would need to:
14−
15− 1. Know all the packages and all their versions.
16− 2. Download or read the elm.json file for each version.
17−
18−The goal of this module is to only pay for (1) and pay for (2) as needed.
19−-}
20−
21−
22−import Control.Monad.Except (liftIO, lift, throwError)
23−import Control.Monad.State (StateT, evalStateT, gets, modify)
24−import qualified Data.Map as Map
25−
26−import qualified Deps.Cache as Cache
27−import qualified Elm.Constraint as C
28−import qualified Elm.Package as Pkg
29−import qualified Elm.PerUserCache as PerUserCache
30−import qualified Elm.Project.Json as Project
31−import qualified Elm.Version as V
32−import qualified Reporting.Exit as Exit
33−import qualified Reporting.Exit.Deps as E
34−import qualified Reporting.Task as Task
35−
36−
37−
38−-- EXPLORER
39−
40−
41−type Explorer =
42− StateT Metadata Task.Task
43−
44−
45−data Metadata =
46− Metadata
47− { _registry :: Cache.PackageRegistry
48− , _info :: Map.Map (Pkg.Name, V.Version) Info
49− }
50−
51−
52−data Info =
53− Info
54− { _elm :: C.Constraint
55− , _pkgs :: Map.Map Pkg.Name C.Constraint
56− }
57−
58−
59−run :: Cache.PackageRegistry -> Explorer a -> Task.Task a
60−run registry explorer =
61− evalStateT explorer (Metadata registry Map.empty)
62−
63−
64−
65−-- EXISTS
66−
67−
68−exists :: Pkg.Name -> Explorer ()
69−exists name =
70− do registry <- gets _registry
71− case Cache.getVersions name registry of
72− Right _ ->
73− return ()
74−
75− Left suggestions ->
76− throwError (Exit.Deps (E.PackageNotFound name suggestions))
77−
78−
79−
80−-- VERSIONS
81−
82−
83−getVersions :: Pkg.Name -> Explorer [V.Version]
84−getVersions name =
85− do registry <- gets _registry
86− case Cache.getVersions name registry of
87− Right versions ->
88− return versions
89−
90− Left _suggestions ->
91− do elmHome <- liftIO PerUserCache.getElmHome
92− throwError (Exit.Deps (E.CorruptVersionCache elmHome name))
93−
94−
95−
96−-- CONSTRAINTS
97−
98−
99−getConstraints :: Pkg.Name -> V.Version -> Explorer Info
100−getConstraints name version =
101− do allInfo <- gets _info
102− case Map.lookup (name, version) allInfo of
103− Just info ->
104− return info
105−
106− Nothing ->
107− do pkgInfo <- lift $ Cache.getElmJson name version
108−
109− let elm = Project._pkg_elm_version pkgInfo
110− let pkgs = Project._pkg_deps pkgInfo
111− let info = Info elm pkgs
112−
113− modify $ \(Metadata vsns infos) ->
114− Metadata vsns $ Map.insert (name, version) info infos
115−
116− return info
builder/src/Deps/Plan.hsdeleted−64
@@ -1,64 +0,0 @@
1−module Install.Plan where
2−
3−import qualified Data.Map as Map
4−
5−import qualified Elm.Package.Solution as S
6−import qualified Elm.Package as Package
7−
8−
9−data Plan =
10− Plan
11− { installs :: Map.Map Package.Name Package.Version
12− , upgrades :: Map.Map Package.Name (Package.Version, Package.Version)
13− , removals :: Map.Map Package.Name Package.Version
14− }
15−
16−
17−create :: S.Solution -> S.Solution -> Plan
18−create old new =
19− Plan
20− { installs = Map.difference new old
21− , upgrades = discardNoOps (Map.intersectionWith (,) old new)
22− , removals = Map.difference old new
23− }
24− where
25− discardNoOps updates =
26− Map.mapMaybe isChanged updates
27−
28− isChanged upgrade@(oldVersion,newVersion) =
29− if oldVersion == newVersion
30− then Nothing
31− else Just upgrade
32−
33−
34−isEmpty :: Plan -> Bool
35−isEmpty (Plan installs upgrades removals) =
36− Map.null installs
37− && Map.null upgrades
38− && Map.null removals
39−
40−
41−-- DISPLAY
42−
43−display :: Plan -> String
44−display (Plan installs upgrades removals) =
45− "\n"
46− ++ displayCategory "Install" displayInstall installs
47− ++ displayCategory "Upgrade" displayUpgrade upgrades
48− ++ displayCategory "Remove" displayRemove removals
49− where
50− displayCategory name render category =
51− if Map.null category then "" else
52− " " ++ name ++ ":"
53− ++ concatMap (\entry -> "\n " ++ render entry) (Map.toList category)
54− ++ "\n"
55−
56− displayInstall (name, version) =
57− Package.toString name ++ " " ++ Package.versionToString version
58−
59− displayUpgrade (name, (old, new)) =
60− Package.toString name ++ " ("
61− ++ Package.versionToString old ++ " => " ++ Package.versionToString new ++ ")"
62−
63− displayRemove (name, _version) =
64− Package.toString name
builder/src/Deps/Registry.hsnew file+213
@@ -0,0 +1,213 @@
1+{-# OPTIONS_GHC -Wall #-}
2+{-# LANGUAGE BangPatterns, OverloadedStrings #-}
3+module Deps.Registry
4+ ( Registry(..)
5+ , KnownVersions(..)
6+ , read
7+ , fetch
8+ , update
9+ , latest
10+ , getVersions
11+ , getVersions'
12+ )
13+ where
14+
15+
16+import Prelude hiding (read)
17+import Control.Monad (liftM2)
18+import Data.Binary (Binary, get, put)
19+import qualified Data.List as List
20+import qualified Data.Map.Strict as Map
21+
22+import qualified Deps.Website as Website
23+import qualified Elm.Package as Pkg
24+import qualified Elm.Version as V
25+import qualified File
26+import qualified Http
27+import qualified Json.Decode as D
28+import qualified Parse.Primitives as P
29+import qualified Reporting.Exit as Exit
30+import qualified Stuff
31+
32+
33+
34+-- REGISTRY
35+
36+
37+data Registry =
38+ Registry
39+ { _count :: !Int
40+ , _versions :: !(Map.Map Pkg.Name KnownVersions)
41+ }
42+
43+
44+data KnownVersions =
45+ KnownVersions
46+ { _newest :: V.Version
47+ , _previous :: ![V.Version]
48+ }
49+
50+
51+
52+-- READ
53+
54+
55+read :: Stuff.PackageCache -> IO (Maybe Registry)
56+read cache =
57+ File.readBinary (Stuff.registry cache)
58+
59+
60+
61+-- FETCH
62+
63+
64+fetch :: Http.Manager -> Stuff.PackageCache -> IO (Either Exit.RegistryProblem Registry)
65+fetch manager cache =
66+ post manager "/all-packages" allPkgsDecoder $
67+ \versions ->
68+ do let size = Map.foldr' addEntry 0 versions
69+ let registry = Registry size versions
70+ let path = Stuff.registry cache
71+ File.writeBinary path registry
72+ return registry
73+
74+
75+addEntry :: KnownVersions -> Int -> Int
76+addEntry (KnownVersions _ vs) count =
77+ count + 1 + length vs
78+
79+
80+allPkgsDecoder :: D.Decoder () (Map.Map Pkg.Name KnownVersions)
81+allPkgsDecoder =
82+ let
83+ keyDecoder =
84+ Pkg.keyDecoder bail
85+
86+ versionsDecoder =
87+ D.list (D.mapError (\_ -> ()) V.decoder)
88+
89+ toKnownVersions versions =
90+ case List.sortBy (flip compare) versions of
91+ v:vs -> return (KnownVersions v vs)
92+ [] -> D.failure ()
93+ in
94+ D.dict keyDecoder (toKnownVersions =<< versionsDecoder)
95+
96+
97+
98+-- UPDATE
99+
100+
101+update :: Http.Manager -> Stuff.PackageCache -> Registry -> IO (Either Exit.RegistryProblem Registry)
102+update manager cache oldRegistry@(Registry size packages) =
103+ post manager ("/all-packages/since/" ++ show size) (D.list newPkgDecoder) $
104+ \news ->
105+ case news of
106+ [] ->
107+ return oldRegistry
108+
109+ _:_ ->
110+ let
111+ newSize = size + length news
112+ newPkgs = foldr addNew packages news
113+ newRegistry = Registry newSize newPkgs
114+ in
115+ do File.writeBinary (Stuff.registry cache) newRegistry
116+ return newRegistry
117+
118+
119+addNew :: (Pkg.Name, V.Version) -> Map.Map Pkg.Name KnownVersions -> Map.Map Pkg.Name KnownVersions
120+addNew (name, version) versions =
121+ let
122+ add maybeKnowns =
123+ case maybeKnowns of
124+ Just (KnownVersions v vs) ->
125+ KnownVersions version (v:vs)
126+
127+ Nothing ->
128+ KnownVersions version []
129+ in
130+ Map.alter (Just . add) name versions
131+
132+
133+
134+-- NEW PACKAGE DECODER
135+
136+
137+newPkgDecoder :: D.Decoder () (Pkg.Name, V.Version)
138+newPkgDecoder =
139+ D.customString newPkgParser bail
140+
141+
142+newPkgParser :: P.Parser () (Pkg.Name, V.Version)
143+newPkgParser =
144+ do pkg <- P.specialize (\_ _ _ -> ()) Pkg.parser
145+ P.word1 0x40 {-@-} bail
146+ vsn <- P.specialize (\_ _ _ -> ()) V.parser
147+ return (pkg, vsn)
148+
149+
150+bail :: row -> col -> ()
151+bail _ _ =
152+ ()
153+
154+
155+
156+-- LATEST
157+
158+
159+latest :: Http.Manager -> Stuff.PackageCache -> IO (Either Exit.RegistryProblem Registry)
160+latest manager cache =
161+ do maybeOldRegistry <- read cache
162+ case maybeOldRegistry of
163+ Just oldRegistry ->
164+ update manager cache oldRegistry
165+
166+ Nothing ->
167+ fetch manager cache
168+
169+
170+
171+-- GET VERSIONS
172+
173+
174+getVersions :: Pkg.Name -> Registry -> Maybe KnownVersions
175+getVersions name (Registry _ versions) =
176+ Map.lookup name versions
177+
178+
179+getVersions' :: Pkg.Name -> Registry -> Either [Pkg.Name] KnownVersions
180+getVersions' name (Registry _ versions) =
181+ case Map.lookup name versions of
182+ Just kvs -> Right kvs
183+ Nothing -> Left $ Pkg.nearbyNames name (Map.keys versions)
184+
185+
186+
187+-- POST
188+
189+
190+post :: Http.Manager -> String -> D.Decoder x a -> (a -> IO b) -> IO (Either Exit.RegistryProblem b)
191+post manager path decoder callback =
192+ let
193+ url = Website.route path []
194+ in
195+ Http.post manager url [] Exit.RP_Http $
196+ \body ->
197+ case D.fromByteString decoder body of
198+ Right a -> Right <$> callback a
199+ Left _ -> return $ Left $ Exit.RP_Data url body
200+
201+
202+
203+-- BINARY
204+
205+
206+instance Binary Registry where
207+ get = liftM2 Registry get get
208+ put (Registry a b) = put a >> put b
209+
210+
211+instance Binary KnownVersions where
212+ get = liftM2 KnownVersions get get
213+ put (KnownVersions a b) = put a >> put b
builder/src/Deps/Solver.hs+396−54
@@ -1,88 +1,243 @@
1+{-# LANGUAGE OverloadedStrings, Rank2Types #-}
12module Deps.Solver
23 ( Solver
3− , run
4− , solve
4+ , Result(..)
5+ , Connection(..)
6+ --
7+ , Details(..)
8+ , verify
9+ --
10+ , AppSolution(..)
11+ , addToApp
12+ --
13+ , Env(..)
14+ , initEnv
515 )
616 where
717
818
9−import Control.Monad (foldM, guard, mzero, msum)
10−import Control.Monad.Logic (LogicT, runLogicT, lift)
11−import qualified Data.List as List
19+import Control.Monad (foldM)
20+import Control.Concurrent (forkIO, newEmptyMVar, putMVar, readMVar)
1221import qualified Data.Map as Map
13−import Data.Map (Map)
22+import Data.Map ((!))
23+import qualified System.Directory as Dir
24+import System.FilePath ((</>))
1425
15−import Deps.Explorer (Explorer)
16−import qualified Deps.Explorer as Explorer
26+import qualified Deps.Registry as Registry
27+import qualified Deps.Website as Website
1728import qualified Elm.Constraint as C
1829import qualified Elm.Package as Pkg
30+import qualified Elm.Outline as Outline
1931import qualified Elm.Version as V
32+import qualified File
33+import qualified Http
34+import qualified Json.Decode as D
35+import qualified Reporting.Exit as Exit
36+import qualified Stuff
2037
2138
2239
23−-- SOLVE
40+-- SOLVER
41+
42+
43+newtype Solver a =
44+ Solver
45+ (
46+ forall b.
47+ State
48+ -> (State -> a -> (State -> IO b) -> IO b)
49+ -> (State -> IO b)
50+ -> (Exit.Solver -> IO b)
51+ -> IO b
52+ )
53+
2454
55+data State =
56+ State
57+ { _cache :: Stuff.PackageCache
58+ , _connection :: Connection
59+ , _registry :: Registry.Registry
60+ , _constraints :: Map.Map (Pkg.Name, V.Version) Constraints
61+ }
2562
26−solve :: Map Pkg.Name C.Constraint -> Solver (Map Pkg.Name V.Version)
27−solve cons =
28− mkSolver (State Map.empty cons)
2963
64+data Constraints =
65+ Constraints
66+ { _elm :: C.Constraint
67+ , _deps :: Map.Map Pkg.Name C.Constraint
68+ }
3069
31−type Solver a =
32− LogicT Explorer a
3370
71+data Connection
72+ = Online Http.Manager
73+ | Offline
3474
35−run :: Solver a -> Explorer (Maybe a)
36−run solver =
37− runLogicT solver (const . return . Just) (return Nothing)
3875
3976
77+-- RESULT
4078
41−-- SOLVER
4279
80+data Result a
81+ = Ok a
82+ | NoSolution
83+ | NoOfflineSolution
84+ | Err Exit.Solver
4385
44−data State =
45− State
46− { _solution :: Map Pkg.Name V.Version
47− , _unsolved :: Map Pkg.Name C.Constraint
86+
87+
88+-- VERIFY -- used by Elm.Details
89+
90+
91+data Details =
92+ Details V.Version (Map.Map Pkg.Name C.Constraint)
93+
94+
95+verify :: Stuff.PackageCache -> Connection -> Registry.Registry -> Map.Map Pkg.Name C.Constraint -> IO (Result (Map.Map Pkg.Name Details))
96+verify cache connection registry constraints =
97+ Stuff.withRegistryLock cache $
98+ case try constraints of
99+ Solver solver ->
100+ solver (State cache connection registry Map.empty)
101+ (\s a _ -> return $ Ok (Map.mapWithKey (addDeps s) a))
102+ (\_ -> return $ noSolution connection)
103+ (\e -> return $ Err e)
104+
105+
106+addDeps :: State -> Pkg.Name -> V.Version -> Details
107+addDeps (State _ _ _ constraints) name vsn =
108+ case Map.lookup (name, vsn) constraints of
109+ Just (Constraints _ deps) -> Details vsn deps
110+ Nothing -> error "compiler bug manifesting in Deps.Solver.addDeps"
111+
112+
113+noSolution :: Connection -> Result a
114+noSolution connection =
115+ case connection of
116+ Online _ -> NoSolution
117+ Offline -> NoOfflineSolution
118+
119+
120+
121+-- ADD TO APP - used in Install
122+
123+
124+data AppSolution =
125+ AppSolution
126+ { _old :: Map.Map Pkg.Name V.Version
127+ , _new :: Map.Map Pkg.Name V.Version
128+ , _app :: Outline.AppOutline
48129 }
49130
50131
51−mkSolver :: State -> Solver (Map Pkg.Name V.Version)
52−mkSolver (State solution unsolved) =
53− case Map.minViewWithKey unsolved of
54− Nothing ->
55− return solution
132+addToApp :: Stuff.PackageCache -> Connection -> Registry.Registry -> Pkg.Name -> Outline.AppOutline -> IO (Result AppSolution)
133+addToApp cache connection registry pkg outline@(Outline.AppOutline _ _ direct indirect testDirect testIndirect) =
134+ Stuff.withRegistryLock cache $
135+ let
136+ allIndirects = Map.union indirect testIndirect
137+ allDirects = Map.union direct testDirect
138+ allDeps = Map.union allDirects allIndirects
139+
140+ attempt toConstraint deps =
141+ try (Map.insert pkg C.anything (Map.map toConstraint deps))
142+ in
143+ case
144+ oneOf
145+ ( attempt C.exactly allDeps )
146+ [ attempt C.exactly allDirects
147+ , attempt C.untilNextMinor allDirects
148+ , attempt C.untilNextMajor allDirects
149+ , attempt (\_ -> C.anything) allDirects
150+ ]
151+ of
152+ Solver solver ->
153+ solver (State cache connection registry Map.empty)
154+ (\s a _ -> return $ Ok (toApp s pkg outline allDeps a))
155+ (\_ -> return $ noSolution connection)
156+ (\e -> return $ Err e)
157+
158+
159+toApp :: State -> Pkg.Name -> Outline.AppOutline -> Map.Map Pkg.Name V.Version -> Map.Map Pkg.Name V.Version -> AppSolution
160+toApp (State _ _ _ constraints) pkg (Outline.AppOutline elm srcDirs direct _ testDirect _) old new =
161+ let
162+ d = Map.intersection new (Map.insert pkg V.one direct)
163+ i = Map.difference (getTransitive constraints new (Map.toList d) Map.empty) d
164+ td = Map.intersection new (Map.delete pkg testDirect)
165+ ti = Map.difference new (Map.unions [d,i,td])
166+ in
167+ AppSolution old new (Outline.AppOutline elm srcDirs d i td ti)
168+
169+
170+getTransitive :: Map.Map (Pkg.Name, V.Version) Constraints -> Map.Map Pkg.Name V.Version -> [(Pkg.Name,V.Version)] -> Map.Map Pkg.Name V.Version -> Map.Map Pkg.Name V.Version
171+getTransitive constraints solution unvisited visited =
172+ case unvisited of
173+ [] ->
174+ visited
175+
176+ info@(pkg,vsn) : infos ->
177+ if Map.member pkg visited
178+ then getTransitive constraints solution infos visited
179+ else
180+ let
181+ newDeps = _deps (constraints ! info)
182+ newUnvisited = Map.toList (Map.intersection solution (Map.difference newDeps visited))
183+ newVisited = Map.insert pkg vsn visited
184+ in
185+ getTransitive constraints solution infos $
186+ getTransitive constraints solution newUnvisited newVisited
187+
56188
57− Just ((name, constraint), otherUnsolved) ->
58− do allVersions <- lift $ Explorer.getVersions name
59− let versions =
60− reverse $ List.sort $
61− filter (C.satisfies constraint) allVersions
62189
63− let state1 = State solution otherUnsolved
64− state2 <- msum (map (addVersion state1 name) versions)
65− mkSolver state2
190+-- TRY
191+
192+
193+try :: Map.Map Pkg.Name C.Constraint -> Solver (Map.Map Pkg.Name V.Version)
194+try constraints =
195+ exploreGoals (Goals constraints Map.empty)
196+
197+
198+
199+-- EXPLORE GOALS
200+
201+
202+data Goals =
203+ Goals
204+ { _pending :: Map.Map Pkg.Name C.Constraint
205+ , _solved :: Map.Map Pkg.Name V.Version
206+ }
207+
208+
209+exploreGoals :: Goals -> Solver (Map.Map Pkg.Name V.Version)
210+exploreGoals (Goals pending solved) =
211+ case Map.minViewWithKey pending of
212+ Nothing ->
213+ return solved
66214
215+ Just ((name, constraint), otherPending) ->
216+ do let goals1 = Goals otherPending solved
217+ let addVsn = addVersion goals1 name
218+ (v,vs) <- getRelevantVersions name constraint
219+ goals2 <- oneOf (addVsn v) (map addVsn vs)
220+ exploreGoals goals2
67221
68−addVersion :: State -> Pkg.Name -> V.Version -> Solver State
69−addVersion (State solution unsolved) name version =
70− do (Explorer.Info elm cons) <-
71− lift $ Explorer.getConstraints name version
72222
73− guard (C.goodElm elm)
74− newUnsolved <- foldM (addConstraint solution) unsolved (Map.toList cons)
75− return (State (Map.insert name version solution) newUnsolved)
223+addVersion :: Goals -> Pkg.Name -> V.Version -> Solver Goals
224+addVersion (Goals pending solved) name version =
225+ do (Constraints elm deps) <- getConstraints name version
226+ if C.goodElm elm
227+ then
228+ do newPending <- foldM (addConstraint solved) pending (Map.toList deps)
229+ return (Goals newPending (Map.insert name version solved))
230+ else
231+ backtrack
76232
77233
78−addConstraint :: Map Pkg.Name V.Version -> Map Pkg.Name C.Constraint -> (Pkg.Name, C.Constraint) -> Solver (Map Pkg.Name C.Constraint)
79−addConstraint solution unsolved (name, newConstraint) =
80− case Map.lookup name solution of
234+addConstraint :: Map.Map Pkg.Name V.Version -> Map.Map Pkg.Name C.Constraint -> (Pkg.Name, C.Constraint) -> Solver (Map.Map Pkg.Name C.Constraint)
235+addConstraint solved unsolved (name, newConstraint) =
236+ case Map.lookup name solved of
81237 Just version ->
82− if C.satisfies newConstraint version then
83− return unsolved
84− else
85− mzero
238+ if C.satisfies newConstraint version
239+ then return unsolved
240+ else backtrack
86241
87242 Nothing ->
88243 case Map.lookup name unsolved of
@@ -92,11 +247,198 @@ addConstraint solution unsolved (name, newConstraint) =
92247 Just oldConstraint ->
93248 case C.intersect oldConstraint newConstraint of
94249 Nothing ->
95− mzero
250+ backtrack
96251
97252 Just mergedConstraint ->
98− if oldConstraint == mergedConstraint then
99− return unsolved
100− else
101− return (Map.insert name mergedConstraint unsolved)
253+ if oldConstraint == mergedConstraint
254+ then return unsolved
255+ else return (Map.insert name mergedConstraint unsolved)
256+
257+
258+
259+-- GET RELEVANT VERSIONS
260+
261+
262+getRelevantVersions :: Pkg.Name -> C.Constraint -> Solver (V.Version, [V.Version])
263+getRelevantVersions name constraint =
264+ Solver $ \state@(State _ _ registry _) ok back _ ->
265+ case Registry.getVersions name registry of
266+ Just (Registry.KnownVersions newest previous) ->
267+ case filter (C.satisfies constraint) (newest:previous) of
268+ [] -> back state
269+ v:vs -> ok state (v,vs) back
270+
271+ Nothing ->
272+ back state
273+
274+
275+
276+-- GET CONSTRAINTS
277+
278+
279+getConstraints :: Pkg.Name -> V.Version -> Solver Constraints
280+getConstraints pkg vsn =
281+ Solver $ \state@(State cache connection registry cDict) ok back err ->
282+ do let key = (pkg, vsn)
283+ case Map.lookup key cDict of
284+ Just cs ->
285+ ok state cs back
286+
287+ Nothing ->
288+ do let toNewState cs = State cache connection registry (Map.insert key cs cDict)
289+ let home = Stuff.package cache pkg vsn
290+ let path = home </> "elm.json"
291+ outlineExists <- File.exists path
292+ if outlineExists
293+ then
294+ do bytes <- File.readUtf8 path
295+ case D.fromByteString constraintsDecoder bytes of
296+ Right cs ->
297+ case connection of
298+ Online _ ->
299+ ok (toNewState cs) cs back
300+
301+ Offline ->
302+ do srcExists <- Dir.doesDirectoryExist (Stuff.package cache pkg vsn </> "src")
303+ if srcExists
304+ then ok (toNewState cs) cs back
305+ else back state
306+
307+ Left _ ->
308+ do File.remove path
309+ err (Exit.SolverBadCacheData pkg vsn)
310+ else
311+ case connection of
312+ Offline ->
313+ back state
314+
315+ Online manager ->
316+ do let url = Website.metadata pkg vsn "elm.json"
317+ result <- Http.get manager url [] id (return . Right)
318+ case result of
319+ Left httpProblem ->
320+ err (Exit.SolverBadHttp pkg vsn httpProblem)
321+
322+ Right body ->
323+ case D.fromByteString constraintsDecoder body of
324+ Right cs ->
325+ do Dir.createDirectoryIfMissing True home
326+ File.writeUtf8 path body
327+ ok (toNewState cs) cs back
328+
329+ Left _ ->
330+ err (Exit.SolverBadHttpData pkg vsn url)
331+
332+
333+constraintsDecoder :: D.Decoder () Constraints
334+constraintsDecoder =
335+ do outline <- D.mapError (const ()) Outline.decoder
336+ case outline of
337+ Outline.Pkg (Outline.PkgOutline _ _ _ _ _ deps _ elmConstraint) ->
338+ return (Constraints elmConstraint deps)
339+
340+ Outline.App _ ->
341+ D.failure ()
342+
343+
344+
345+-- ENVIRONMENT
346+
347+
348+data Env =
349+ Env Stuff.PackageCache Http.Manager Connection Registry.Registry
350+
351+
352+initEnv :: IO (Either Exit.RegistryProblem Env)
353+initEnv =
354+ do mvar <- newEmptyMVar
355+ _ <- forkIO $ putMVar mvar =<< Http.getManager
356+ cache <- Stuff.getPackageCache
357+ Stuff.withRegistryLock cache $
358+ do maybeRegistry <- Registry.read cache
359+ manager <- readMVar mvar
360+
361+ case maybeRegistry of
362+ Nothing ->
363+ do eitherRegistry <- Registry.fetch manager cache
364+ case eitherRegistry of
365+ Right latestRegistry ->
366+ return $ Right $ Env cache manager (Online manager) latestRegistry
367+
368+ Left problem ->
369+ return $ Left $ problem
370+
371+ Just cachedRegistry ->
372+ do eitherRegistry <- Registry.update manager cache cachedRegistry
373+ case eitherRegistry of
374+ Right latestRegistry ->
375+ return $ Right $ Env cache manager (Online manager) latestRegistry
376+
377+ Left _ ->
378+ return $ Right $ Env cache manager Offline cachedRegistry
379+
380+
381+
382+-- INSTANCES
383+
384+
385+instance Functor Solver where
386+ fmap func (Solver solver) =
387+ Solver $ \state ok back err ->
388+ let
389+ okA stateA arg backA = ok stateA (func arg) backA
390+ in
391+ solver state okA back err
392+
393+
394+instance Applicative Solver where
395+ pure a =
396+ Solver $ \state ok back _ -> ok state a back
397+
398+ (<*>) (Solver solverFunc) (Solver solverArg) =
399+ Solver $ \state ok back err ->
400+ let
401+ okF stateF func backF =
402+ let
403+ okA stateA arg backA = ok stateA (func arg) backA
404+ in
405+ solverArg stateF okA backF err
406+ in
407+ solverFunc state okF back err
408+
409+
410+instance Monad Solver where
411+ return a =
412+ Solver $ \state ok back _ -> ok state a back
413+
414+ (>>=) (Solver solverA) callback =
415+ Solver $ \state ok back err ->
416+ let
417+ okA stateA a backA =
418+ case callback a of
419+ Solver solverB -> solverB stateA ok backA err
420+ in
421+ solverA state okA back err
422+
423+
424+oneOf :: Solver a -> [Solver a] -> Solver a
425+oneOf solver@(Solver solverHead) solvers =
426+ case solvers of
427+ [] ->
428+ solver
429+
430+ s:ss ->
431+ Solver $ \state0 ok back err ->
432+ let
433+ tryTail state1 =
434+ let
435+ (Solver solverTail) = oneOf s ss
436+ in
437+ solverTail state1 ok back err
438+ in
439+ solverHead state0 ok tryTail err
440+
102441
442+backtrack :: Solver a
443+backtrack =
444+ Solver $ \state _ back _ -> back state
builder/src/Deps/Verify.hsdeleted−388
@@ -1,388 +0,0 @@
1−module Deps.Verify
2− ( verify
3− )
4− where
5−
6−
7−import Control.Concurrent (forkIO)
8−import Control.Concurrent.MVar (MVar, newMVar, newEmptyMVar, putMVar, readMVar, takeMVar)
9−import Control.Monad (filterM, void)
10−import Control.Monad.Trans (liftIO)
11−import qualified Data.Map as Map
12−import qualified Data.Map.Merge.Strict as Map
13−import qualified Data.Set as Set
14−import System.Directory (doesDirectoryExist)
15−import System.FilePath ((</>))
16−
17−import qualified Deps.Cache as Cache
18−import qualified Deps.Explorer as Explorer
19−import qualified Deps.Solver as Solver
20−import qualified Deps.Website as Website
21−import qualified Elm.Compiler as Compiler
22−import qualified Elm.Compiler.Objects as Obj
23−import qualified Elm.Constraint as Con
24−import qualified Elm.Interface as I
25−import qualified Elm.ModuleName as ModuleName
26−import qualified Elm.Package as Pkg
27−import qualified Elm.PerUserCache as PerUserCache
28−import Elm.Project.Json (Project(..), AppInfo(..), PkgInfo(..))
29−import qualified Elm.Project.Json as Project
30−import qualified Elm.Project.Summary as Summary
31−import qualified Elm.Version as V
32−import qualified File.Args as Args
33−import qualified File.Compile as Compile
34−import qualified File.Crawl as Crawl
35−import qualified File.IO as IO
36−import qualified File.Plan as Plan
37−import qualified Generate.Artifacts as Artifacts
38−import qualified Reporting.Exit as Exit
39−import qualified Reporting.Exit.Deps as E
40−import qualified Reporting.Progress as Progress
41−import qualified Reporting.Task as Task
42−import qualified Stuff.Paths as Paths
43−
44−
45−
46−-- VERIFY
47−
48−
49−verify :: FilePath -> Project -> Task.Task Summary.Summary
50−verify root project =
51− do solution <-
52− case project of
53− Project.App info -> verifyApp info
54− Project.Pkg info -> verifyPkg info
55−
56− (RawInfo infos ifaces) <- verifyArtifacts solution
57− return (Summary.init root project infos ifaces)
58−
59−
60−throw :: E.Exit -> Task.Task a
61−throw exit =
62− Task.throw (Exit.Deps exit)
63−
64−
65−
66−-- VERIFY APP
67−
68−
69−verifyApp :: AppInfo -> Task.Task (Map.Map Pkg.Name V.Version)
70−verifyApp info =
71− if _app_elm_version info /= V.compiler then
72− throw (E.AppBadElm (_app_elm_version info))
73−
74− else
75− do oldSolution <- appToSolution info
76− let solver = Solver.solve (Map.map Con.exactly oldSolution)
77− registry <- Cache.optionalUpdate
78− maybeSolution <- Explorer.run registry (Solver.run solver)
79− case maybeSolution of
80− Nothing ->
81− throw E.BadDeps
82−
83− Just newSolution ->
84− if Map.size oldSolution == Map.size newSolution then
85− return newSolution
86− else
87− throw (E.AppMissingTrans (Map.toList (Map.difference newSolution oldSolution)))
88−
89−
90−
91−-- VERIFY PKG
92−
93−
94−verifyPkg :: PkgInfo -> Task.Task (Map.Map Pkg.Name V.Version)
95−verifyPkg info =
96− if not (Con.goodElm (_pkg_elm_version info)) then
97− throw (E.PkgBadElm (_pkg_elm_version info))
98−
99− else
100− do deps <- union noDups (_pkg_deps info) (_pkg_test_deps info)
101− let solver = Solver.solve deps
102− registry <- Cache.optionalUpdate
103− maybeSolution <- Explorer.run registry (Solver.run solver)
104− case maybeSolution of
105− Nothing ->
106− throw E.BadDeps
107−
108− Just solution ->
109− return solution
110−
111−
112−
113−-- APP TO SOLUTION
114−
115−
116−appToSolution :: Project.AppInfo -> Task.Task (Map.Map Pkg.Name V.Version)
117−appToSolution (Project.AppInfo _ _ depsDirect depsTrans testDirect testTrans) =
118− do a <- union allowEqualDups depsTrans testDirect
119− b <- union noDups depsDirect testTrans
120− union noDups a b
121−
122−
123−noDups :: Pkg.Name -> a -> a -> Task.Task a
124−noDups _ _ _ =
125− throw E.BadDeps
126−
127−
128−allowEqualDups :: Pkg.Name -> V.Version -> V.Version -> Task.Task V.Version
129−allowEqualDups _ v1 v2 =
130− if v1 == v2 then
131− return v1
132− else
133− throw E.BadDeps
134−
135−
136−union :: (Pkg.Name -> a -> a -> Task.Task a) -> Map.Map Pkg.Name a -> Map.Map Pkg.Name a -> Task.Task (Map.Map Pkg.Name a)
137−union tieBreaker deps1 deps2 =
138− Map.mergeA Map.preserveMissing Map.preserveMissing (Map.zipWithAMatched tieBreaker) deps1 deps2
139−
140−
141−
142−-- VERIFY ARTIFACTS
143−
144−
145−verifyArtifacts :: Map.Map Pkg.Name V.Version -> Task.Task RawInfo
146−verifyArtifacts solution =
147− do Website.download =<< filterM noSrc (Map.toList solution)
148− verifyBuildArtifacts solution
149−
150−
151−noSrc :: (Pkg.Name, V.Version) -> Task.Task Bool
152−noSrc (name, version) =
153− do root <- Task.getPackageCacheDirFor name version
154− liftIO $ not <$> doesDirectoryExist (root </> "src")
155−
156−
157−
158−-- VERIFY BUILD ARTIFACTS
159−
160−
161−verifyBuildArtifacts :: Map.Map Pkg.Name V.Version -> Task.Task RawInfo
162−verifyBuildArtifacts solution =
163− do Task.report (Progress.BuildDepsStart (Map.size solution))
164− startMVar <- liftIO newEmptyMVar
165− ifacesMVar <- liftIO $ newMVar Map.empty
166− pkgInfoMVars <- Map.traverseWithKey (verifyBuild startMVar ifacesMVar) solution
167− liftIO $ putMVar startMVar pkgInfoMVars
168− answers <- liftIO $ traverse readMVar pkgInfoMVars
169− Task.report Progress.BuildDepsEnd
170− RawInfo
171− <$> Map.traverseMaybeWithKey toInfo answers
172− <*> liftIO (readMVar ifacesMVar)
173−
174−
175−data RawInfo =
176− RawInfo (Map.Map Pkg.Name PkgInfo) I.Interfaces
177−
178−
179−verifyBuild
180− :: MVar (Map.Map Pkg.Name (MVar Answer))
181− -> MVar I.Interfaces
182− -> Pkg.Name
183− -> V.Version
184− -> Task.Task (MVar Answer)
185−verifyBuild pkgInfoMVar ifacesMVar name version =
186− do mvar <- liftIO newEmptyMVar
187− info <- Cache.getElmJson name version
188− report <- Task.getReporter
189− runner <- Task.getSilentRunner
190−
191− liftIO $ void $ forkIO $
192− do allMVars <- readMVar pkgInfoMVar
193− let deps = Project._pkg_deps info
194− let depsMVars = Map.intersection allMVars deps
195− depAnswers <- traverse readMVar depsMVars
196−
197− answer <- ifNotBlocked depAnswers $ \infos ->
198− do ifacesBefore <- readMVar ifacesMVar
199− result <- runner (getIface name version info infos ifacesBefore)
200− case result of
201− Right ifaces ->
202− do ifacesNow <- takeMVar ifacesMVar
203− putMVar ifacesMVar (Map.union ifacesNow ifaces)
204− return (Ok info)
205−
206− Left _ ->
207− return (Err name version)
208−
209− report Progress.BuildDepsProgress
210− putMVar mvar answer
211−
212− return mvar
213−
214−
215−
216−-- ANSWERS
217−
218−
219−data Answer
220− = Ok PkgInfo
221− | Blocked
222− | Err Pkg.Name V.Version
223−
224−
225−toInfo :: Pkg.Name -> Answer -> Task.Task (Maybe PkgInfo)
226−toInfo _ answer =
227− case answer of
228− Ok info ->
229− return (Just info)
230−
231− Blocked ->
232− return Nothing
233−
234− Err name version ->
235− do elmHome <- liftIO PerUserCache.getElmHome
236− throw (E.BuildFailure elmHome name version)
237−
238−
239−ifNotBlocked :: Map.Map Pkg.Name Answer -> (Map.Map Pkg.Name PkgInfo -> IO Answer) -> IO Answer
240−ifNotBlocked answers callback =
241− case traverse isOk answers of
242− Nothing ->
243− return Blocked
244−
245− Just infos ->
246− callback infos
247−
248−
249−isOk :: Answer -> Maybe PkgInfo
250−isOk answer =
251− case answer of
252− Ok info -> Just info
253− Blocked -> Nothing
254− Err _ _ -> Nothing
255−
256−
257−
258−-- GET INTERFACE
259−
260−
261−getIface
262− :: Pkg.Name
263− -> V.Version
264− -> PkgInfo
265− -> Map.Map Pkg.Name PkgInfo
266− -> I.Interfaces
267− -> Task.Task I.Interfaces
268−getIface name version info infos depIfaces =
269− do root <- Task.getPackageCacheDirFor name version
270− let solution = Map.map _pkg_version infos
271−
272− cached <- liftIO $ isCached root solution
273−
274− if cached
275− then
276− do maybeIfaces <- liftIO $ IO.readBinary (root </> "ifaces.dat")
277− maybe (Task.throw (error "TODO corrupt binary 1")) return maybeIfaces
278− else
279− do Paths.removeStuff root
280− let summary = Summary.cheapInit root info infos depIfaces
281− args <- Args.fromSummary summary
282− graph <- Crawl.crawl summary args
283− (dirty, cachedIfaces) <- Plan.plan summary graph
284− answers <- Compile.compile (Pkg info) cachedIfaces dirty
285− results <- Artifacts.ignore answers
286− Paths.removeStuff root
287−
288− updateCache root name info solution graph results
289−
290−
291−
292−-- IS CACHED?
293−
294−
295−isCached :: FilePath -> Map.Map Pkg.Name V.Version -> IO Bool
296−isCached root solution =
297− IO.andM
298− [ IO.exists (root </> "cached.dat")
299− , IO.exists (root </> "ifaces.dat")
300− , IO.exists (root </> "objs.dat")
301− , isCachedHelp solution <$> IO.readBinary (root </> "cached.dat")
302− ]
303−
304−
305−isCachedHelp :: Map.Map Pkg.Name V.Version -> Maybe (Map.Map Pkg.Name (Set.Set V.Version)) -> Bool
306−isCachedHelp solution maybeCachedDeps =
307− case maybeCachedDeps of
308− Nothing ->
309− False
310−
311− Just cachedDeps ->
312− let
313− matches =
314− Map.intersectionWith Set.member solution cachedDeps
315− in
316− Map.size solution == Map.size matches
317− && Map.foldr (&&) True matches
318−
319−
320−
321−-- UPDATE CACHE
322−
323−
324−updateCache
325− :: FilePath
326− -> Pkg.Name
327− -> PkgInfo
328− -> Map.Map Pkg.Name V.Version
329− -> Crawl.Result
330− -> Map.Map ModuleName.Raw Compiler.Artifacts
331− -> Task.Task I.Interfaces
332−updateCache root name info solution graph results =
333− do let path = root </> "cached.dat"
334− let deps = Map.map Set.singleton solution
335− let elmi = crush name info results
336−
337− exists <- liftIO $ IO.exists path
338−
339− if exists
340− then
341− do maybeOldDeps <- liftIO $ IO.readBinary path
342− oldDeps <- maybe (error "TODO corrupt binary 2") return maybeOldDeps
343− liftIO $ IO.writeBinary path (Map.unionWith Set.union deps oldDeps)
344− else
345− liftIO $
346− do IO.writeBinary (root </> "ifaces.dat") elmi
347− IO.writeBinary path deps
348− IO.writeBinary (root </> "objs.dat") $
349− Map.foldr addGraph (objGraphFromKernels graph) results
350−
351− return elmi
352−
353−
354−
355−-- CRUSH INTERFACES
356−
357−
358−crush :: Pkg.Name -> PkgInfo -> Map.Map ModuleName.Raw Compiler.Artifacts -> I.Interfaces
359−crush pkg info results =
360− let
361− exposed =
362− Set.fromList (Project.getExposed info)
363− in
364− Map.mapKeys (ModuleName.Canonical pkg) $
365− Map.mapMaybeWithKey (crushHelp exposed) results
366−
367−
368−crushHelp :: Set.Set ModuleName.Raw -> ModuleName.Raw -> Compiler.Artifacts -> Maybe I.Interface
369−crushHelp exposed name (Compiler.Artifacts elmi _) =
370− if Set.member name exposed then
371− Just elmi
372−
373− else
374− Nothing
375−
376−
377−
378−-- OBJECT GRAPH
379−
380−
381−addGraph :: Compiler.Artifacts -> Obj.Graph -> Obj.Graph
382−addGraph (Compiler.Artifacts _ elmo) graph =
383− Obj.union elmo graph
384−
385−
386−objGraphFromKernels :: Crawl.Result -> Obj.Graph
387−objGraphFromKernels (Crawl.Graph _ _ kernels _ _) =
388− Obj.fromKernels kernels
builder/src/Deps/Website.hs+13−330
@@ -1,343 +1,26 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
31module Deps.Website
4− ( getElmJson
5− , getDocs
6− , getNewPackages
7− , getAllPackages
8− , download
9− , githubCommit
10− , githubDownload
11− , Sha
12− , register
2+ ( domain
3+ , route
4+ , metadata
135 )
146 where
157
168
17−import Prelude hiding (zip)
18−import qualified Codec.Archive.Zip as Zip
19−import Control.Monad (void)
20−import qualified Data.Binary as Binary
21−import qualified Data.Binary.Get as Binary
22−import qualified Data.ByteString.Char8 as BS
23−import qualified Data.ByteString.Lazy as LBS
24−import qualified Data.Digest.Pure.SHA as SHA
25−import qualified Data.Map as Map
26−import qualified Data.Utf8 as Utf8
27−import qualified Network.HTTP.Client as Client
28−import qualified Network.HTTP.Client.MultipartFormData as Multi
29−import qualified Network.HTTP.Types as Http
30−import qualified System.Directory as Dir
31−import System.FilePath ((</>), splitFileName)
32−
339import qualified Elm.Package as Pkg
3410import qualified Elm.Version as V
35−import qualified Json.Decode as D
36−
37−import qualified Reporting.Exit.Http as E
38−import qualified Reporting.Progress as Progress
39−import qualified Reporting.Task as Task
40−import qualified Reporting.Task.Http as Http
41−import qualified Stuff.Paths as Path
42−
43−
44−
45−-- GET PACKAGE INFO
46−
47−
48−getElmJson :: Pkg.Name -> V.Version -> Task.Task BS.ByteString
49−getElmJson name version =
50− Http.run $ fetchByteString $
51− "packages/" ++ Pkg.toUrl name ++ "/" ++ V.toChars version ++ "/elm.json"
52−
53−
54−getDocs :: Pkg.Name -> V.Version -> Task.Task BS.ByteString
55−getDocs name version =
56− Http.run $ fetchByteString $
57− "packages/" ++ Pkg.toUrl name ++ "/" ++ V.toChars version ++ "/docs.json"
58−
59−
60−
61−-- NEW PACKAGES
62−
63−
64−getNewPackages :: Int -> Task.Task [(Pkg.Name, V.Version)]
65−getNewPackages index =
66− Http.run $ fetchJson (D.list newPkgDecoder) ("all-packages/since/" ++ show index)
67−
68−
69−newPkgDecoder :: D.Decoder E.BadJson ( Pkg.Name, V.Version )
70−newPkgDecoder =
71− do str <- D.string
72− case Utf8.split 0x40 {-@-} str of
73− [key, value] ->
74− case Pkg.fromString key of
75− Right pkg ->
76− case V.fromString value of
77− Just vsn ->
78− return (pkg, vsn)
79−
80− Nothing ->
81− D.failure (E.BadNewPkg str)
82−
83− Left _ ->
84− D.failure (E.BadNewPkg str)
85−
86− _ ->
87− D.failure (E.BadNewPkg str)
88−
89−
90−
91−-- ALL PACKAGES
92−
93−
94−getAllPackages :: Task.Task (Map.Map Pkg.Name [V.Version])
95−getAllPackages =
96− Http.run $ fetchJson allPkgsDecoder "all-packages"
97−
98−
99−allPkgsDecoder :: D.Decoder E.BadJson (Map.Map Pkg.Name [V.Version])
100−allPkgsDecoder =
101− let
102− checkKeys pairs pkgs =
103− case pairs of
104− [] ->
105− return pkgs
106−
107− (key, versions) : rest ->
108− case Pkg.fromString key of
109− Right pkg ->
110− checkKeys rest (Map.insert pkg versions pkgs)
111−
112− Left badName ->
113− D.failure (E.BadAllPkg key badName)
114− in
115− do pairs <- D.pairs (D.list (D.mapError E.BadAllVsn V.decoder))
116− checkKeys pairs Map.empty
117−
118−
119−
120−-- HELPERS
121−
122−
123−fetchByteString :: String -> Http.Fetch BS.ByteString
124−fetchByteString path =
125− Http.package path [] $ \request manager ->
126− do response <- Client.httpLbs request manager
127− return $ Right $ LBS.toStrict $ Client.responseBody response
128−
129−
130−fetchJson :: D.Decoder e a -> String -> Http.Fetch a
131−fetchJson decoder path =
132− Http.package path [] $ \request manager ->
133− do response <- Client.httpLbs request manager
134− let bytes = LBS.toStrict (Client.responseBody response)
135− case D.fromByteString decoder bytes of
136− Right value ->
137− return $ Right value
138−
139− Left jsonProblem ->
140− return $ Left $ E.BadJson path (error "TODO give real HTTP problem" jsonProblem)
141−
142−
143−
144−-- DOWNLOAD
145−
146−
147−download :: [(Pkg.Name, V.Version)] -> Task.Task ()
148−download packages =
149− case packages of
150− [] ->
151− Task.report Progress.DownloadSkip
152−
153− _ ->
154− do cache <- Task.getPackageCacheDir
155−
156− let start = Progress.DownloadStart packages
157− let toEnd = Progress.DownloadEnd
158−
159− void $ Http.run $ Http.report start toEnd $
160− Http.parallel $ map (downloadHelp cache) packages
161−
162−
163−downloadHelp :: FilePath -> (Pkg.Name, V.Version) -> Http.Fetch ()
164−downloadHelp cache (name, version) =
165− let
166− endpointUrl =
167− "packages/" ++ Pkg.toUrl name ++ "/" ++ V.toChars version ++ "/endpoint.json"
168− in
169− Http.andThen (fetchJson endpointDecoder endpointUrl) $ \(endpoint, hash) ->
170− let
171− start = Progress.DownloadPkgStart name version
172− toEnd = Progress.DownloadPkgEnd name version
173− in
174− Http.report start toEnd $
175− Http.anything endpoint $ \request manager ->
176− Client.withResponse request manager (downloadArchive cache name version hash)
177−
178−
179−endpointDecoder :: D.Decoder e (String, String)
180−endpointDecoder =
181− (,)
182− <$> (Utf8.toChars <$> D.field "url" D.string)
183− <*> (Utf8.toChars <$> D.field "hash" D.string)
184−
185−
186−
187−-- DOWNLOAD ZIP ARCHIVE
188−
189−
190−downloadArchive :: FilePath -> Pkg.Name -> V.Version -> String -> Client.Response Client.BodyReader -> IO (Either E.Exit ())
191−downloadArchive cache name version expectedHash response =
192− do result <- readArchive (Client.responseBody response) initialArchiveState
193− case result of
194− Left msg ->
195− return (Left msg)
196−
197− Right (sha, archive) ->
198− if expectedHash == SHA.showDigest sha then
199− Right <$> writeArchive archive (cache </> Pkg.toFilePath name) (V.toChars version)
200− else
201− return $ Left $ E.BadZipSha expectedHash (SHA.showDigest sha)
202−
203−
204−
205−-- READ ARCHIVE
206−
207−
208−data ArchiveState =
209− AS
210− { _len :: !Int
211− , _sha :: !(Binary.Decoder SHA.SHA1State)
212− , _zip :: !(Binary.Decoder Zip.Archive)
213− }
214−
215−
216−initialArchiveState :: ArchiveState
217−initialArchiveState =
218− AS 0 SHA.sha1Incremental (Binary.runGetIncremental Binary.get)
219−
220−
221−type Sha = SHA.Digest SHA.SHA1State
222−
223−
224−readArchive :: Client.BodyReader -> ArchiveState -> IO (Either E.Exit (Sha, Zip.Archive))
225−readArchive body (AS len sha zip) =
226− case zip of
227− Binary.Fail _ _ _ ->
228− return $ Left E.BadZipData
229−
230− Binary.Partial k ->
231− do chunk <- Client.brRead body
232− readArchive body $ AS
233− { _len = len + BS.length chunk
234− , _sha = Binary.pushChunk sha chunk
235− , _zip = k (if BS.null chunk then Nothing else Just chunk)
236− }
237−
238− Binary.Done _ _ archive ->
239− return $ Right ( SHA.completeSha1Incremental sha len, archive )
240−
241−
242−
243−-- WRITE ARCHIVE
244−
245−
246−writeArchive :: Zip.Archive -> FilePath -> FilePath -> IO ()
247−writeArchive archive destination newRoot =
248− do Dir.createDirectoryIfMissing True destination
249− let opts = [Zip.OptDestination destination]
250− mapM_ (Zip.writeEntry opts . replaceRoot newRoot) (Zip.zEntries archive)
251−
252−
253−replaceRoot :: String -> Zip.Entry -> Zip.Entry
254−replaceRoot root entry =
255− let
256− rootless =
257− dropWhile (/='/') (Zip.eRelativePath entry)
258− in
259− entry { Zip.eRelativePath = root ++ rootless }
260−
261−
262−
263−-- FIND TAGGED COMMIT ON GITHUB
264−
265−
266−githubCommit :: Pkg.Name -> V.Version -> Task.Task String
267−githubCommit name version =
268− let
269− endpoint =
270− "https://api.github.com/repos/" ++ Pkg.toUrl name ++ "/git/refs/tags/" ++ V.toChars version
271−
272− headers =
273− [ ( Http.hUserAgent, "elm-cli" )
274− , ( Http.hAccept, "application/json" )
275− ]
276−
277− decoder =
278− D.field "object" (D.field "sha" D.string)
279− in
280− Http.run $ Http.anything endpoint $ \request manager ->
281− do response <- Client.httpLbs (request { Client.requestHeaders = headers }) manager
282− let bytes = LBS.toStrict (Client.responseBody response)
283− case D.fromByteString decoder bytes of
284− Right value ->
285− return $ Right (Utf8.toChars value)
286−
287− Left jsonProblem ->
288− return $ Left $ E.BadJson "github.json" jsonProblem
289−
290−
291−
292−-- DOWNLOAD FROM GITHUB
293−
294−
295−githubDownload :: Pkg.Name -> V.Version -> FilePath -> Task.Task Sha
296−githubDownload name version dir =
297− let
298− endpoint =
299− "https://github.com/" ++ Pkg.toUrl name ++ "/zipball/" ++ V.toChars version ++ "/"
300− in
301− Http.run $ Http.anything endpoint $ \request manager ->
302− Client.withResponse request manager (githubDownloadHelp dir)
303−
304−
305−githubDownloadHelp :: FilePath -> Client.Response Client.BodyReader -> IO (Either E.Exit Sha)
306−githubDownloadHelp targetDir response =
307− do result <- readArchive (Client.responseBody response) initialArchiveState
308− case result of
309− Left msg ->
310− return (Left msg)
311−
312− Right (sha, archive) ->
313− do let (dir, root) = splitFileName targetDir
314− writeArchive archive dir root
315− return $ Right sha
11+import qualified Http
31612
31713
14+domain :: String
15+domain =
16+ "https://package.elm-lang.org"
31817
319−-- REGISTER PACKAGES
32018
19+route :: String -> [(String,String)] -> String
20+route path params =
21+ Http.toUrl (domain ++ path) params
32122
322−register :: Pkg.Name -> V.Version -> String -> Sha -> Task.Task ()
323−register name version commitHash digest =
324− let
325− params =
326− [ ("name", Pkg.toChars name)
327− , ("version", V.toChars version)
328− , ("commit-hash", commitHash)
329− ]
33023
331− files =
332− [ Multi.partFileSource "elm.json" "elm.json"
333− , Multi.partFileSource "docs.json" Path.docs
334− , Multi.partFileSource "README.md" "README.md"
335− , Multi.partFileRequestBody "github-hash" "github-hash" $
336− Client.RequestBodyBS (BS.pack (SHA.showDigest digest))
337− ]
338− in
339− Http.run $ Http.package "register" params $ \rawRequest manager ->
340− do requestWithBody <- Multi.formDataBody files rawRequest
341− let request = requestWithBody { Client.responseTimeout = Client.responseTimeoutNone }
342− void $ Client.httpLbs request manager
343− return $ Right ()
24+metadata :: Pkg.Name -> V.Version -> String -> String
25+metadata name version file =
26+ domain ++ "/packages/" ++ Pkg.toUrl name ++ "/" ++ V.toChars version ++ "/" ++ file
builder/src/Elm/Bump.hsdeleted−138
@@ -1,138 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Elm.Bump
3− ( bump
4− , toPossibleBumps
5− )
6− where
7−
8−
9−import Control.Monad.Trans (liftIO)
10−import qualified Data.List as List
11−
12−import qualified Deps.Cache as Cache
13−import qualified Deps.Diff as Diff
14−import qualified Elm.Package as Pkg
15−import qualified Elm.Project as Project
16−import qualified Elm.Project.Json as Project
17−import qualified Elm.Project.Summary as Summary
18−import Reporting.Doc ((<>), (<+>))
19−import qualified Reporting.Doc as D
20−import qualified Reporting.Exit as Exit
21−import qualified Reporting.Exit.Bump as E
22−import qualified Reporting.Exit.Help as Help
23−import qualified Reporting.Progress.Terminal as Terminal
24−import qualified Reporting.Task as Task
25−
26−
27−
28−-- BUMP
29−
30−
31−bump :: Summary.Summary -> Task.Task ()
32−bump summary@(Summary.Summary root project _ _ _) =
33− case project of
34− Project.App _ ->
35− Task.throw (Exit.Bump E.Application)
36−
37− Project.Pkg info@(Project.PkgInfo name _ _ version _ _ _ _) ->
38− do registry <- Cache.mandatoryUpdate
39− case Cache.getVersions name registry of
40− Left _suggestions ->
41− checkNewPackage root info
42−
43− Right publishedVersions ->
44− let
45− bumpableVersions =
46− map (\(old, _, _) -> old) (toPossibleBumps publishedVersions)
47− in
48− if elem version bumpableVersions then
49− suggestVersion summary info
50− else
51− Task.throw $ Exit.Bump $ E.Unbumpable version $
52− map head (List.group (List.sort bumpableVersions))
53−
54−
55−
56−-- VALID BUMPS
57−
58−
59−toPossibleBumps :: [Pkg.Version] -> [(Pkg.Version, Pkg.Version, Diff.Magnitude)]
60−toPossibleBumps publishedVersions =
61− case publishedVersions of
62− [] ->
63− []
64−
65− _ ->
66− let
67− patchPoints =
68− Pkg.filterLatest Pkg.majorAndMinor publishedVersions
69−
70− minorPoints =
71− Pkg.filterLatest Pkg._major publishedVersions
72−
73− majorPoint =
74− maximum publishedVersions
75− in
76− (majorPoint, Pkg.bumpMajor majorPoint, Diff.MAJOR)
77− : map (\v -> (v, Pkg.bumpMinor v, Diff.MINOR)) minorPoints
78− ++ map (\v -> (v, Pkg.bumpPatch v, Diff.PATCH)) patchPoints
79−
80−
81−
82−-- CHECK NEW PACKAGE
83−
84−
85−checkNewPackage :: FilePath -> Project.PkgInfo -> Task.Task ()
86−checkNewPackage root info@(Project.PkgInfo _ _ _ version _ _ _ _) =
87− do liftIO $ putStrLn Terminal.newPackageOverview
88− if version == Pkg.initialVersion
89− then
90− liftIO $ putStrLn "The version number in elm.json is correct so you are all set!"
91− else
92− changeVersion root info Pkg.initialVersion $
93− "It looks like the version in elm.json has been changed though!\n\
94− \Would you like me to change it back to "
95− <> D.fromText (Pkg.versionToText Pkg.initialVersion) <> "? [Y/n] "
96−
97−
98−
99−-- SUGGEST VERSION
100−
101−
102−suggestVersion :: Summary.Summary -> Project.PkgInfo -> Task.Task ()
103−suggestVersion summary@(Summary.Summary root _ _ _ _) info@(Project.PkgInfo name _ _ version _ _ _ _) =
104− do oldDocs <- Cache.getDocs name version
105− newDocs <- Task.silently (Project.generateDocs summary)
106− let changes = Diff.diff oldDocs newDocs
107− let newVersion = Diff.bump changes version
108− changeVersion root info newVersion $
109− let
110− old = D.fromText $ Pkg.versionToText version
111− new = D.fromText $ Pkg.versionToText newVersion
112− mag = D.fromString $ Diff.magnitudeToString (Diff.toMagnitude changes)
113− in
114− "Based on your new API, this should be a" <+> D.green mag <+> "change (" <> old <> " => " <> new <> ")\n"
115− <> "Bail out of this command and run 'elm diff' for a full explanation.\n"
116− <> "\n"
117− <> "Should I perform the update (" <> old <> " => " <> new <> ") in elm.json? [Y/n] "
118−
119−
120−
121−-- CHANGE VERSION
122−
123−
124−changeVersion :: FilePath -> Project.PkgInfo -> Pkg.Version -> D.Doc -> Task.Task ()
125−changeVersion root info targetVersion explanation =
126− do approved <- Task.getApproval explanation
127− if not approved
128− then
129− liftIO $ putStrLn "Okay, I did not change anything!"
130−
131− else
132− do liftIO $ Project.write root $ Project.Pkg $
133− info { Project._pkg_version = targetVersion }
134−
135− liftIO $ Help.toStdout $
136− "Version changed to "
137− <> D.green (D.fromText (Pkg.versionToText targetVersion))
138− <> "!\n"
builder/src/Elm/Details.hsnew file+833
@@ -0,0 +1,833 @@
1+{-# OPTIONS_GHC -Wall #-}
2+{-# LANGUAGE BangPatterns, OverloadedStrings #-}
3+module Elm.Details
4+ ( Details(..)
5+ , BuildID
6+ , ValidOutline(..)
7+ , Local(..)
8+ , Foreign(..)
9+ , load
10+ , loadObjects
11+ , loadInterfaces
12+ , verifyInstall
13+ )
14+ where
15+
16+
17+import Control.Concurrent (forkIO)
18+import Control.Concurrent.MVar (MVar, newEmptyMVar, newMVar, putMVar, readMVar, takeMVar)
19+import Control.Monad (liftM, liftM2, liftM3)
20+import Data.Binary (Binary, get, put, getWord8, putWord8)
21+import qualified Data.Either as Either
22+import qualified Data.Map as Map
23+import qualified Data.Map.Utils as Map
24+import qualified Data.Map.Merge.Strict as Map
25+import qualified Data.Maybe as Maybe
26+import qualified Data.Name as Name
27+import qualified Data.NonEmptyList as NE
28+import qualified Data.OneOrMore as OneOrMore
29+import qualified Data.Set as Set
30+import qualified Data.Utf8 as Utf8
31+import Data.Word (Word64)
32+import qualified System.Directory as Dir
33+import System.FilePath ((</>), (<.>))
34+
35+import qualified AST.Canonical as Can
36+import qualified AST.Source as Src
37+import qualified AST.Optimized as Opt
38+import qualified BackgroundWriter as BW
39+import qualified Compile
40+import qualified Deps.Registry as Registry
41+import qualified Deps.Solver as Solver
42+import qualified Deps.Website as Website
43+import qualified Elm.Constraint as Con
44+import qualified Elm.Docs as Docs
45+import qualified Elm.Interface as I
46+import qualified Elm.Kernel as Kernel
47+import qualified Elm.ModuleName as ModuleName
48+import qualified Elm.Outline as Outline
49+import qualified Elm.Package as Pkg
50+import qualified Elm.Version as V
51+import qualified File
52+import qualified Http
53+import qualified Json.Decode as D
54+import qualified Json.Encode as E
55+import qualified Parse.Module as Parse
56+import qualified Reporting
57+import qualified Reporting.Annotation as A
58+import qualified Reporting.Exit as Exit
59+import qualified Reporting.Task as Task
60+import qualified Stuff
61+
62+
63+
64+-- DETAILS
65+
66+
67+data Details =
68+ Details
69+ { _outlineTime :: File.Time
70+ , _outline :: ValidOutline
71+ , _buildID :: BuildID
72+ , _locals :: Map.Map ModuleName.Raw Local
73+ , _foreigns :: Map.Map ModuleName.Raw Foreign
74+ , _extras :: Extras
75+ }
76+
77+
78+type BuildID = Word64
79+
80+
81+data ValidOutline
82+ = ValidApp (NE.List Outline.SrcDir)
83+ | ValidPkg Pkg.Name [ModuleName.Raw] (Map.Map Pkg.Name V.Version {- for docs in reactor -})
84+
85+
86+-- NOTE: we need two ways to detect if a file must be recompiled:
87+--
88+-- (1) _time is the modification time from the last time we compiled the file.
89+-- By checking EQUALITY with the current modification time, we can detect file
90+-- saves and `git checkout` of previous versions. Both need a recompile.
91+--
92+-- (2) _lastChange is the BuildID from the last time a new interface file was
93+-- generated, and _lastCompile is the BuildID from the last time the file was
94+-- compiled. These may be different if a file is recompiled but the interface
95+-- stayed the same. When the _lastCompile is LESS THAN the _lastChange of any
96+-- imports, we need to recompile. This can happen when a project has multiple
97+-- entrypoints and some modules are compiled less often than their imports.
98+--
99+data Local =
100+ Local
101+ { _path :: FilePath
102+ , _time :: File.Time
103+ , _deps :: [ModuleName.Raw]
104+ , _main :: Bool
105+ , _lastChange :: BuildID
106+ , _lastCompile :: BuildID
107+ }
108+
109+
110+data Foreign =
111+ Foreign Pkg.Name [Pkg.Name]
112+
113+
114+data Extras
115+ = ArtifactsCached
116+ | ArtifactsFresh Interfaces Opt.GlobalGraph
117+
118+
119+type Interfaces =
120+ Map.Map ModuleName.Canonical I.DependencyInterface
121+
122+
123+
124+-- LOAD ARTIFACTS
125+
126+
127+loadObjects :: FilePath -> Details -> IO (MVar (Maybe Opt.GlobalGraph))
128+loadObjects root (Details _ _ _ _ _ extras) =
129+ case extras of
130+ ArtifactsFresh _ o -> newMVar (Just o)
131+ ArtifactsCached -> fork (File.readBinary (Stuff.objects root))
132+
133+
134+loadInterfaces :: FilePath -> Details -> IO (MVar (Maybe Interfaces))
135+loadInterfaces root (Details _ _ _ _ _ extras) =
136+ case extras of
137+ ArtifactsFresh i _ -> newMVar (Just i)
138+ ArtifactsCached -> fork (File.readBinary (Stuff.interfaces root))
139+
140+
141+
142+-- VERIFY INSTALL -- used by Install
143+
144+
145+verifyInstall :: BW.Scope -> FilePath -> Solver.Env -> Outline.Outline -> IO (Either Exit.Details ())
146+verifyInstall scope root (Solver.Env cache manager connection registry) outline =
147+ do time <- File.getTime (root </> "elm.json")
148+ let key = Reporting.ignorer
149+ let env = Env key scope root cache manager connection registry
150+ case outline of
151+ Outline.Pkg pkg -> Task.run (verifyPkg env time pkg >> return ())
152+ Outline.App app -> Task.run (verifyApp env time app >> return ())
153+
154+
155+
156+-- LOAD -- used by Make, Repl, Reactor
157+
158+
159+load :: Reporting.Style -> BW.Scope -> FilePath -> IO (Either Exit.Details Details)
160+load style scope root =
161+ do newTime <- File.getTime (root </> "elm.json")
162+ maybeDetails <- File.readBinary (Stuff.details root)
163+ case maybeDetails of
164+ Nothing ->
165+ generate style scope root newTime
166+
167+ Just details@(Details oldTime _ buildID _ _ _) ->
168+ if oldTime == newTime
169+ then return (Right details { _buildID = buildID + 1 })
170+ else generate style scope root newTime
171+
172+
173+
174+-- GENERATE
175+
176+
177+generate :: Reporting.Style -> BW.Scope -> FilePath -> File.Time -> IO (Either Exit.Details Details)
178+generate style scope root time =
179+ Reporting.trackDetails style $ \key ->
180+ do result <- initEnv key scope root
181+ case result of
182+ Left exit ->
183+ return (Left exit)
184+
185+ Right (env, outline) ->
186+ case outline of
187+ Outline.Pkg pkg -> Task.run (verifyPkg env time pkg)
188+ Outline.App app -> Task.run (verifyApp env time app)
189+
190+
191+
192+-- ENV
193+
194+
195+data Env =
196+ Env
197+ { _key :: Reporting.DKey
198+ , _scope :: BW.Scope
199+ , _root :: FilePath
200+ , _cache :: Stuff.PackageCache
201+ , _manager :: Http.Manager
202+ , _connection :: Solver.Connection
203+ , _registry :: Registry.Registry
204+ }
205+
206+
207+initEnv :: Reporting.DKey -> BW.Scope -> FilePath -> IO (Either Exit.Details (Env, Outline.Outline))
208+initEnv key scope root =
209+ do mvar <- fork Solver.initEnv
210+ eitherOutline <- Outline.read root
211+ case eitherOutline of
212+ Left problem ->
213+ return $ Left $ Exit.DetailsBadOutline problem
214+
215+ Right outline ->
216+ do maybeEnv <- readMVar mvar
217+ case maybeEnv of
218+ Left problem ->
219+ return $ Left $ Exit.DetailsCannotGetRegistry problem
220+
221+ Right (Solver.Env cache manager connection registry) ->
222+ return $ Right (Env key scope root cache manager connection registry, outline)
223+
224+
225+
226+-- VERIFY PROJECT
227+
228+
229+type Task a = Task.Task Exit.Details a
230+
231+
232+verifyPkg :: Env -> File.Time -> Outline.PkgOutline -> Task Details
233+verifyPkg env time (Outline.PkgOutline pkg _ _ _ exposed direct testDirect elm) =
234+ if Con.goodElm elm
235+ then
236+ do solution <- verifyConstraints env =<< union noDups direct testDirect
237+ let exposedList = Outline.flattenExposed exposed
238+ let exactDeps = Map.map (\(Solver.Details v _) -> v) solution -- for pkg docs in reactor
239+ verifyDependencies env time (ValidPkg pkg exposedList exactDeps) solution direct
240+ else
241+ Task.throw $ Exit.DetailsBadElmInPkg elm
242+
243+
244+verifyApp :: Env -> File.Time -> Outline.AppOutline -> Task Details
245+verifyApp env time outline@(Outline.AppOutline elmVersion srcDirs direct _ _ _) =
246+ if elmVersion == V.compiler
247+ then
248+ do stated <- checkAppDeps outline
249+ actual <- verifyConstraints env (Map.map Con.exactly stated)
250+ if Map.size stated == Map.size actual
251+ then verifyDependencies env time (ValidApp srcDirs) actual direct
252+ else Task.throw $ Exit.DetailsHandEditedDependencies
253+ else
254+ Task.throw $ Exit.DetailsBadElmInAppOutline elmVersion
255+
256+
257+checkAppDeps :: Outline.AppOutline -> Task (Map.Map Pkg.Name V.Version)
258+checkAppDeps (Outline.AppOutline _ _ direct indirect testDirect testIndirect) =
259+ do x <- union allowEqualDups indirect testDirect
260+ y <- union noDups direct testIndirect
261+ union noDups x y
262+
263+
264+
265+-- VERIFY CONSTRAINTS
266+
267+
268+verifyConstraints :: Env -> Map.Map Pkg.Name Con.Constraint -> Task (Map.Map Pkg.Name Solver.Details)
269+verifyConstraints (Env _ _ _ cache _ connection registry) constraints =
270+ do result <- Task.io $ Solver.verify cache connection registry constraints
271+ case result of
272+ Solver.Ok details -> return details
273+ Solver.NoSolution -> Task.throw $ Exit.DetailsNoSolution
274+ Solver.NoOfflineSolution -> Task.throw $ Exit.DetailsNoOfflineSolution
275+ Solver.Err exit -> Task.throw $ Exit.DetailsSolverProblem exit
276+
277+
278+
279+-- UNION
280+
281+
282+union :: (Ord k) => (k -> v -> v -> Task v) -> Map.Map k v -> Map.Map k v -> Task (Map.Map k v)
283+union tieBreaker deps1 deps2 =
284+ Map.mergeA Map.preserveMissing Map.preserveMissing (Map.zipWithAMatched tieBreaker) deps1 deps2
285+
286+
287+noDups :: k -> v -> v -> Task v
288+noDups _ _ _ =
289+ Task.throw Exit.DetailsHandEditedDependencies
290+
291+
292+allowEqualDups :: (Eq v) => k -> v -> v -> Task v
293+allowEqualDups _ v1 v2 =
294+ if v1 == v2
295+ then return v1
296+ else Task.throw Exit.DetailsHandEditedDependencies
297+
298+
299+
300+-- FORK
301+
302+
303+fork :: IO a -> IO (MVar a)
304+fork work =
305+ do mvar <- newEmptyMVar
306+ _ <- forkIO $ putMVar mvar =<< work
307+ return mvar
308+
309+
310+
311+-- VERIFY DEPENDENCIES
312+
313+
314+verifyDependencies :: Env -> File.Time -> ValidOutline -> Map.Map Pkg.Name Solver.Details -> Map.Map Pkg.Name a -> Task Details
315+verifyDependencies env@(Env key scope root cache _ _ _) time outline solution directDeps =
316+ Task.eio id $
317+ do Reporting.report key (Reporting.DStart (Map.size solution))
318+ mvar <- newEmptyMVar
319+ mvars <- Stuff.withRegistryLock cache $
320+ Map.traverseWithKey (\k v -> fork (verifyDep env mvar solution k v)) solution
321+ putMVar mvar mvars
322+ deps <- traverse readMVar mvars
323+ case sequence deps of
324+ Left _ ->
325+ do home <- Stuff.getElmHome
326+ return $ Left $ Exit.DetailsBadDeps home $
327+ Maybe.catMaybes $ Either.lefts $ Map.elems deps
328+
329+ Right artifacts ->
330+ let
331+ objs = Map.foldr addObjects Opt.empty artifacts
332+ ifaces = Map.foldrWithKey (addInterfaces directDeps) Map.empty artifacts
333+ foreigns = Map.map (OneOrMore.destruct Foreign) $ Map.foldrWithKey gatherForeigns Map.empty $ Map.intersection artifacts directDeps
334+ details = Details time outline 0 Map.empty foreigns (ArtifactsFresh ifaces objs)
335+ in
336+ do BW.writeBinary scope (Stuff.objects root) objs
337+ BW.writeBinary scope (Stuff.interfaces root) ifaces
338+ BW.writeBinary scope (Stuff.details root) details
339+ return (Right details)
340+
341+
342+addObjects :: Artifacts -> Opt.GlobalGraph -> Opt.GlobalGraph
343+addObjects (Artifacts _ objs) graph =
344+ Opt.addGlobalGraph objs graph
345+
346+
347+addInterfaces :: Map.Map Pkg.Name a -> Pkg.Name -> Artifacts -> Interfaces -> Interfaces
348+addInterfaces directDeps pkg (Artifacts ifaces _) dependencyInterfaces =
349+ Map.union dependencyInterfaces $ Map.mapKeysMonotonic (ModuleName.Canonical pkg) $
350+ if Map.member pkg directDeps
351+ then ifaces
352+ else Map.map I.privatize ifaces
353+
354+
355+gatherForeigns :: Pkg.Name -> Artifacts -> Map.Map ModuleName.Raw (OneOrMore.OneOrMore Pkg.Name) -> Map.Map ModuleName.Raw (OneOrMore.OneOrMore Pkg.Name)
356+gatherForeigns pkg (Artifacts ifaces _) foreigns =
357+ let
358+ isPublic di =
359+ case di of
360+ I.Public _ -> Just (OneOrMore.one pkg)
361+ I.Private _ _ _ -> Nothing
362+ in
363+ Map.unionWith OneOrMore.more foreigns (Map.mapMaybe isPublic ifaces)
364+
365+
366+
367+-- VERIFY DEPENDENCY
368+
369+
370+data Artifacts =
371+ Artifacts
372+ { _ifaces :: Map.Map ModuleName.Raw I.DependencyInterface
373+ , _objects :: Opt.GlobalGraph
374+ }
375+
376+
377+type Dep =
378+ Either (Maybe Exit.DetailsBadDep) Artifacts
379+
380+
381+verifyDep :: Env -> MVar (Map.Map Pkg.Name (MVar Dep)) -> Map.Map Pkg.Name Solver.Details -> Pkg.Name -> Solver.Details -> IO Dep
382+verifyDep (Env key _ _ cache manager _ _) depsMVar solution pkg details@(Solver.Details vsn directDeps) =
383+ do let fingerprint = Map.intersectionWith (\(Solver.Details v _) _ -> v) solution directDeps
384+ exists <- Dir.doesDirectoryExist (Stuff.package cache pkg vsn </> "src")
385+ if exists
386+ then
387+ do Reporting.report key Reporting.DCached
388+ maybeCache <- File.readBinary (Stuff.package cache pkg vsn </> "artifacts.dat")
389+ case maybeCache of
390+ Nothing ->
391+ build key cache depsMVar pkg details fingerprint Set.empty
392+
393+ Just (ArtifactCache fingerprints artifacts) ->
394+ if Set.member fingerprint fingerprints
395+ then Reporting.report key Reporting.DBuilt >> return (Right artifacts)
396+ else build key cache depsMVar pkg details fingerprint fingerprints
397+ else
398+ do Reporting.report key Reporting.DRequested
399+ result <- downloadPackage cache manager pkg vsn
400+ case result of
401+ Left problem ->
402+ do Reporting.report key (Reporting.DFailed pkg vsn)
403+ return $ Left $ Just $ Exit.BD_BadDownload pkg vsn problem
404+
405+ Right () ->
406+ do Reporting.report key (Reporting.DReceived pkg vsn)
407+ build key cache depsMVar pkg details fingerprint Set.empty
408+
409+
410+
411+-- ARTIFACT CACHE
412+
413+
414+data ArtifactCache =
415+ ArtifactCache
416+ { _fingerprints :: Set.Set Fingerprint
417+ , _artifacts :: Artifacts
418+ }
419+
420+
421+type Fingerprint =
422+ Map.Map Pkg.Name V.Version
423+
424+
425+
426+-- BUILD
427+
428+
429+build :: Reporting.DKey -> Stuff.PackageCache -> MVar (Map.Map Pkg.Name (MVar Dep)) -> Pkg.Name -> Solver.Details -> Fingerprint -> Set.Set Fingerprint -> IO Dep
430+build key cache depsMVar pkg (Solver.Details vsn _) f fs =
431+ do eitherOutline <- Outline.read (Stuff.package cache pkg vsn)
432+ case eitherOutline of
433+ Left _ ->
434+ do Reporting.report key Reporting.DBroken
435+ return $ Left $ Just $ Exit.BD_BadBuild pkg vsn f
436+
437+ Right (Outline.App _) ->
438+ do Reporting.report key Reporting.DBroken
439+ return $ Left $ Just $ Exit.BD_BadBuild pkg vsn f
440+
441+ Right (Outline.Pkg (Outline.PkgOutline _ _ _ _ exposed deps _ _)) ->
442+ do allDeps <- readMVar depsMVar
443+ directDeps <- traverse readMVar (Map.intersection allDeps deps)
444+ case sequence directDeps of
445+ Left _ ->
446+ do Reporting.report key Reporting.DBroken
447+ return $ Left $ Nothing
448+
449+ Right directArtifacts ->
450+ do let src = Stuff.package cache pkg vsn </> "src"
451+ let foreignDeps = gatherForeignInterfaces directArtifacts
452+ let exposedDict = Map.fromKeys (\_ -> ()) (Outline.flattenExposed exposed)
453+ docsStatus <- getDocsStatus cache pkg vsn
454+ mvar <- newEmptyMVar
455+ mvars <- Map.traverseWithKey (const . fork . crawlModule foreignDeps mvar pkg src docsStatus) exposedDict
456+ putMVar mvar mvars
457+ mapM_ readMVar mvars
458+ maybeStatuses <- traverse readMVar =<< readMVar mvar
459+ case sequence maybeStatuses of
460+ Nothing ->
461+ do Reporting.report key Reporting.DBroken
462+ return $ Left $ Just $ Exit.BD_BadBuild pkg vsn f
463+
464+ Just statuses ->
465+ do rmvar <- newEmptyMVar
466+ rmvars <- traverse (fork . compile pkg rmvar) statuses
467+ putMVar rmvar rmvars
468+ maybeResults <- traverse readMVar rmvars
469+ case sequence maybeResults of
470+ Nothing ->
471+ do Reporting.report key Reporting.DBroken
472+ return $ Left $ Just $ Exit.BD_BadBuild pkg vsn f
473+
474+ Just results ->
475+ let
476+ path = Stuff.package cache pkg vsn </> "artifacts.dat"
477+ ifaces = gatherInterfaces exposedDict results
478+ objects = gatherObjects results
479+ artifacts = Artifacts ifaces objects
480+ fingerprints = Set.insert f fs
481+ in
482+ do writeDocs cache pkg vsn docsStatus results
483+ File.writeBinary path (ArtifactCache fingerprints artifacts)
484+ Reporting.report key Reporting.DBuilt
485+ return (Right artifacts)
486+
487+
488+
489+-- GATHER
490+
491+
492+gatherObjects :: Map.Map ModuleName.Raw Result -> Opt.GlobalGraph
493+gatherObjects results =
494+ Map.foldrWithKey addLocalGraph Opt.empty results
495+
496+
497+addLocalGraph :: ModuleName.Raw -> Result -> Opt.GlobalGraph -> Opt.GlobalGraph
498+addLocalGraph name status graph =
499+ case status of
500+ RLocal _ objs _ -> Opt.addLocalGraph objs graph
501+ RForeign _ -> graph
502+ RKernelLocal cs -> Opt.addKernel (Name.getKernel name) cs graph
503+ RKernelForeign -> graph
504+
505+
506+gatherInterfaces :: Map.Map ModuleName.Raw () -> Map.Map ModuleName.Raw Result -> Map.Map ModuleName.Raw I.DependencyInterface
507+gatherInterfaces exposed artifacts =
508+ let
509+ onLeft = Map.mapMissing (error "compiler bug manifesting in Elm.Details.gatherInterfaces")
510+ onRight = Map.mapMaybeMissing (\_ iface -> toLocalInterface I.private iface)
511+ onBoth = Map.zipWithMaybeMatched (\_ () iface -> toLocalInterface I.public iface)
512+ in
513+ Map.merge onLeft onRight onBoth exposed artifacts
514+
515+
516+toLocalInterface :: (I.Interface -> a) -> Result -> Maybe a
517+toLocalInterface func result =
518+ case result of
519+ RLocal iface _ _ -> Just (func iface)
520+ RForeign _ -> Nothing
521+ RKernelLocal _ -> Nothing
522+ RKernelForeign -> Nothing
523+
524+
525+
526+-- GATHER FOREIGN INTERFACES
527+
528+
529+data ForeignInterface
530+ = ForeignAmbiguous
531+ | ForeignSpecific I.Interface
532+
533+
534+gatherForeignInterfaces :: Map.Map Pkg.Name Artifacts -> Map.Map ModuleName.Raw ForeignInterface
535+gatherForeignInterfaces directArtifacts =
536+ Map.map (OneOrMore.destruct finalize) $
537+ Map.foldrWithKey gather Map.empty directArtifacts
538+ where
539+ finalize :: I.Interface -> [I.Interface] -> ForeignInterface
540+ finalize i is =
541+ case is of
542+ [] -> ForeignSpecific i
543+ _:_ -> ForeignAmbiguous
544+
545+ gather :: Pkg.Name -> Artifacts -> Map.Map ModuleName.Raw (OneOrMore.OneOrMore I.Interface) -> Map.Map ModuleName.Raw (OneOrMore.OneOrMore I.Interface)
546+ gather _ (Artifacts ifaces _) buckets =
547+ Map.unionWith OneOrMore.more buckets (Map.mapMaybe isPublic ifaces)
548+
549+ isPublic :: I.DependencyInterface -> Maybe (OneOrMore.OneOrMore I.Interface)
550+ isPublic di =
551+ case di of
552+ I.Public iface -> Just (OneOrMore.one iface)
553+ I.Private _ _ _ -> Nothing
554+
555+
556+
557+-- CRAWL
558+
559+
560+type StatusDict =
561+ Map.Map ModuleName.Raw (MVar (Maybe Status))
562+
563+
564+data Status
565+ = SLocal DocsStatus (Map.Map ModuleName.Raw ()) Src.Module
566+ | SForeign I.Interface
567+ | SKernelLocal [Kernel.Chunk]
568+ | SKernelForeign
569+
570+
571+crawlModule :: Map.Map ModuleName.Raw ForeignInterface -> MVar StatusDict -> Pkg.Name -> FilePath -> DocsStatus -> ModuleName.Raw -> IO (Maybe Status)
572+crawlModule foreignDeps mvar pkg src docsStatus name =
573+ do let path = src </> ModuleName.toFilePath name <.> "elm"
574+ exists <- File.exists path
575+ case Map.lookup name foreignDeps of
576+ Just ForeignAmbiguous ->
577+ return Nothing
578+
579+ Just (ForeignSpecific iface) ->
580+ if exists
581+ then return Nothing
582+ else return (Just (SForeign iface))
583+
584+ Nothing ->
585+ if exists then
586+ crawlFile foreignDeps mvar pkg src docsStatus name path
587+
588+ else if Pkg.isKernel pkg && Name.isKernel name then
589+ crawlKernel foreignDeps mvar pkg src name
590+
591+ else
592+ return Nothing
593+
594+
595+crawlFile :: Map.Map ModuleName.Raw ForeignInterface -> MVar StatusDict -> Pkg.Name -> FilePath -> DocsStatus -> ModuleName.Raw -> FilePath -> IO (Maybe Status)
596+crawlFile foreignDeps mvar pkg src docsStatus expectedName path =
597+ do bytes <- File.readUtf8 path
598+ case Parse.fromByteString (Parse.Package pkg) bytes of
599+ Right modul@(Src.Module (Just (A.At _ actualName)) _ _ imports _ _ _ _ _) | expectedName == actualName ->
600+ do deps <- crawlImports foreignDeps mvar pkg src imports
601+ return (Just (SLocal docsStatus deps modul))
602+
603+ _ ->
604+ return Nothing
605+
606+
607+crawlImports :: Map.Map ModuleName.Raw ForeignInterface -> MVar StatusDict -> Pkg.Name -> FilePath -> [Src.Import] -> IO (Map.Map ModuleName.Raw ())
608+crawlImports foreignDeps mvar pkg src imports =
609+ do statusDict <- takeMVar mvar
610+ let deps = Map.fromList (map (\i -> (Src.getImportName i, ())) imports)
611+ let news = Map.difference deps statusDict
612+ mvars <- Map.traverseWithKey (const . fork . crawlModule foreignDeps mvar pkg src DocsNotNeeded) news
613+ putMVar mvar (Map.union mvars statusDict)
614+ mapM_ readMVar mvars
615+ return deps
616+
617+
618+crawlKernel :: Map.Map ModuleName.Raw ForeignInterface -> MVar StatusDict -> Pkg.Name -> FilePath -> ModuleName.Raw -> IO (Maybe Status)
619+crawlKernel foreignDeps mvar pkg src name =
620+ do let path = src </> ModuleName.toFilePath name <.> "js"
621+ exists <- File.exists path
622+ if exists
623+ then
624+ do bytes <- File.readUtf8 path
625+ case Kernel.fromByteString pkg (Map.mapMaybe getDepHome foreignDeps) bytes of
626+ Nothing ->
627+ return Nothing
628+
629+ Just (Kernel.Content imports chunks) ->
630+ do _ <- crawlImports foreignDeps mvar pkg src imports
631+ return (Just (SKernelLocal chunks))
632+ else
633+ return (Just SKernelForeign)
634+
635+
636+getDepHome :: ForeignInterface -> Maybe Pkg.Name
637+getDepHome fi =
638+ case fi of
639+ ForeignSpecific (I.Interface pkg _ _ _ _) -> Just pkg
640+ ForeignAmbiguous -> Nothing
641+
642+
643+
644+-- COMPILE
645+
646+
647+data Result
648+ = RLocal !I.Interface !Opt.LocalGraph (Maybe Docs.Module)
649+ | RForeign I.Interface
650+ | RKernelLocal [Kernel.Chunk]
651+ | RKernelForeign
652+
653+
654+compile :: Pkg.Name -> MVar (Map.Map ModuleName.Raw (MVar (Maybe Result))) -> Status -> IO (Maybe Result)
655+compile pkg mvar status =
656+ case status of
657+ SLocal docsStatus deps modul ->
658+ do resultsDict <- readMVar mvar
659+ maybeResults <- traverse readMVar (Map.intersection resultsDict deps)
660+ case sequence maybeResults of
661+ Nothing ->
662+ return Nothing
663+
664+ Just results ->
665+ case Compile.compile pkg (Map.mapMaybe getInterface results) modul of
666+ Left _ ->
667+ return Nothing
668+
669+ Right (Compile.Artifacts canonical annotations objects) ->
670+ let
671+ ifaces = I.fromModule pkg canonical annotations
672+ docs = makeDocs docsStatus canonical
673+ in
674+ return (Just (RLocal ifaces objects docs))
675+
676+ SForeign iface ->
677+ return (Just (RForeign iface))
678+
679+ SKernelLocal chunks ->
680+ return (Just (RKernelLocal chunks))
681+
682+ SKernelForeign ->
683+ return (Just RKernelForeign)
684+
685+
686+getInterface :: Result -> Maybe I.Interface
687+getInterface result =
688+ case result of
689+ RLocal iface _ _ -> Just iface
690+ RForeign iface -> Just iface
691+ RKernelLocal _ -> Nothing
692+ RKernelForeign -> Nothing
693+
694+
695+
696+-- MAKE DOCS
697+
698+
699+data DocsStatus
700+ = DocsNeeded
701+ | DocsNotNeeded
702+
703+
704+getDocsStatus :: Stuff.PackageCache -> Pkg.Name -> V.Version -> IO DocsStatus
705+getDocsStatus cache pkg vsn =
706+ do exists <- File.exists (Stuff.package cache pkg vsn </> "docs.json")
707+ if exists
708+ then return DocsNotNeeded
709+ else return DocsNeeded
710+
711+
712+makeDocs :: DocsStatus -> Can.Module -> Maybe Docs.Module
713+makeDocs status modul =
714+ case status of
715+ DocsNeeded ->
716+ case Docs.fromModule modul of
717+ Right docs -> Just docs
718+ Left _ -> Nothing
719+
720+ DocsNotNeeded ->
721+ Nothing
722+
723+
724+writeDocs :: Stuff.PackageCache -> Pkg.Name -> V.Version -> DocsStatus -> Map.Map ModuleName.Raw Result -> IO ()
725+writeDocs cache pkg vsn status results =
726+ case status of
727+ DocsNeeded ->
728+ E.writeUgly (Stuff.package cache pkg vsn </> "docs.json") $
729+ Docs.encode $ Map.mapMaybe toDocs results
730+
731+ DocsNotNeeded ->
732+ return ()
733+
734+
735+toDocs :: Result -> Maybe Docs.Module
736+toDocs result =
737+ case result of
738+ RLocal _ _ docs -> docs
739+ RForeign _ -> Nothing
740+ RKernelLocal _ -> Nothing
741+ RKernelForeign -> Nothing
742+
743+
744+
745+-- DOWNLOAD PACKAGE
746+
747+
748+downloadPackage :: Stuff.PackageCache -> Http.Manager -> Pkg.Name -> V.Version -> IO (Either Exit.PackageProblem ())
749+downloadPackage cache manager pkg vsn =
750+ let
751+ url = Website.metadata pkg vsn "endpoint.json"
752+ in
753+ do eitherByteString <-
754+ Http.get manager url [] id (return . Right)
755+
756+ case eitherByteString of
757+ Left err ->
758+ return $ Left $ Exit.PP_BadEndpointRequest err
759+
760+ Right byteString ->
761+ case D.fromByteString endpointDecoder byteString of
762+ Left _ ->
763+ return $ Left $ Exit.PP_BadEndpointContent url
764+
765+ Right (endpoint, expectedHash) ->
766+ Http.getArchive manager endpoint Exit.PP_BadArchiveRequest (Exit.PP_BadArchiveContent endpoint) $
767+ \(sha, archive) ->
768+ if expectedHash == Http.shaToChars sha
769+ then Right <$> File.writePackage (Stuff.package cache pkg vsn) archive
770+ else return $ Left $ Exit.PP_BadArchiveHash endpoint expectedHash (Http.shaToChars sha)
771+
772+
773+endpointDecoder :: D.Decoder e (String, String)
774+endpointDecoder =
775+ do url <- D.field "url" D.string
776+ hash <- D.field "hash" D.string
777+ return (Utf8.toChars url, Utf8.toChars hash)
778+
779+
780+
781+-- BINARY
782+
783+
784+instance Binary Details where
785+ put (Details a b c d e _) = put a >> put b >> put c >> put d >> put e
786+ get =
787+ do a <- get
788+ b <- get
789+ c <- get
790+ d <- get
791+ e <- get
792+ return (Details a b c d e ArtifactsCached)
793+
794+
795+instance Binary ValidOutline where
796+ put outline =
797+ case outline of
798+ ValidApp a -> putWord8 0 >> put a
799+ ValidPkg a b c -> putWord8 1 >> put a >> put b >> put c
800+
801+ get =
802+ do n <- getWord8
803+ case n of
804+ 0 -> liftM ValidApp get
805+ 1 -> liftM3 ValidPkg get get get
806+ _ -> fail "binary encoding of ValidOutline was corrupted"
807+
808+
809+instance Binary Local where
810+ put (Local a b c d e f) = put a >> put b >> put c >> put d >> put e >> put f
811+ get =
812+ do a <- get
813+ b <- get
814+ c <- get
815+ d <- get
816+ e <- get
817+ f <- get
818+ return (Local a b c d e f)
819+
820+
821+instance Binary Foreign where
822+ get = liftM2 Foreign get get
823+ put (Foreign a b) = put a >> put b
824+
825+
826+instance Binary Artifacts where
827+ get = liftM2 Artifacts get get
828+ put (Artifacts a b) = put a >> put b
829+
830+
831+instance Binary ArtifactCache where
832+ get = liftM2 ArtifactCache get get
833+ put (ArtifactCache a b) = put a >> put b
builder/src/Elm/Diff.hsdeleted−283
@@ -1,283 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module Elm.Diff
4− ( Args(..)
5− , diff
6− )
7− where
8−
9−
10−import Control.Monad.Except (liftIO)
11−import qualified Data.List as List
12−import qualified Data.Map as Map
13−import qualified Data.Maybe as Maybe
14−import qualified Data.Name as Name
15−
16−import qualified Deps.Cache as Cache
17−import Deps.Diff (PackageChanges(..), ModuleChanges(..), Changes(..), Magnitude(..))
18−import qualified Deps.Diff as Diff
19−import qualified Elm.Compiler.Type as Type
20−import qualified Elm.Docs as Docs
21−import qualified Elm.ModuleName as ModuleName
22−import qualified Elm.Package as Pkg
23−import qualified Elm.Project as Project
24−import qualified Elm.Project.Json as Project
25−import qualified Elm.Project.Summary as Summary
26−import Reporting.Doc ((<>), (<+>))
27−import qualified Reporting.Doc as D
28−import qualified Reporting.Exit as Exit
29−import qualified Reporting.Exit.Diff as E
30−import qualified Reporting.Exit.Help as Help
31−import qualified Reporting.Render.Type.Localizer as L
32−import qualified Reporting.Task as Task
33−
34−
35−
36−-- DIFF
37−
38−
39−data Args
40− = CodeVsLatest
41− | CodeVsExactly Pkg.Version
42− | LocalInquiry Pkg.Version Pkg.Version
43− | GlobalInquiry Pkg.Name Pkg.Version Pkg.Version
44−
45−
46−diff :: Args -> Task.Task ()
47−diff args =
48− case args of
49− GlobalInquiry name v1 v2 ->
50− do registry <- Cache.mandatoryUpdate
51− case Cache.getVersions name registry of
52− Left suggestions ->
53− throw $ E.UnknownPackage name suggestions
54−
55− Right vsns ->
56− do oldDocs <- getDocs name vsns (min v1 v2)
57− newDocs <- getDocs name vsns (max v1 v2)
58− writeDiff oldDocs newDocs
59−
60− LocalInquiry v1 v2 ->
61− do (_, name, vsns) <- getPackageInfo
62− oldDocs <- getDocs name vsns (min v1 v2)
63− newDocs <- getDocs name vsns (max v1 v2)
64− writeDiff oldDocs newDocs
65−
66− CodeVsLatest ->
67− do (summary, name, vsns) <- getPackageInfo
68− oldDocs <- getDocs name vsns (maximum vsns)
69− newDocs <- Task.silently (Project.generateDocs summary)
70− writeDiff oldDocs newDocs
71−
72− CodeVsExactly version ->
73− do (summary, name, vsns) <- getPackageInfo
74− oldDocs <- getDocs name vsns version
75− newDocs <- Task.silently (Project.generateDocs summary)
76− writeDiff oldDocs newDocs
77−
78−
79−throw :: E.Exit -> Task.Task a
80−throw exit =
81− Task.throw $ Exit.Diff exit
82−
83−
84−
85−-- DIFF HELPERS
86−
87−
88−getDocs :: Pkg.Name -> [Pkg.Version] -> Pkg.Version -> Task.Task Docs.Documentation
89−getDocs name allVersions version =
90− if elem version allVersions then
91− Cache.getDocs name version
92− else
93− throw $ E.UnknownVersion name version allVersions
94−
95−
96−getPackageInfo :: Task.Task (Summary.Summary, Pkg.Name, [Pkg.Version])
97−getPackageInfo =
98− do summary <- Project.getRoot
99− case Summary._project summary of
100− Project.App _ ->
101− throw $ E.Application
102−
103− Project.Pkg (Project.PkgInfo name _ _ _ _ _ _ _) ->
104− do registry <- Cache.mandatoryUpdate
105− case Cache.getVersions name registry of
106− Right vsns ->
107− return ( summary, name, vsns )
108−
109− Left _ ->
110− throw E.Unpublished
111−
112−
113−
114−-- WRITE DOC
115−
116−
117−writeDiff :: Docs.Documentation -> Docs.Documentation -> Task.Task ()
118−writeDiff oldDocs newDocs =
119− let
120− changes = Diff.diff oldDocs newDocs
121− localizer = L.fromNames (Map.union oldDocs newDocs)
122− in
123− liftIO $ Help.toStdout (toDoc localizer changes <> "\n")
124−
125−
126−
127−-- TO DOC
128−
129−
130−toDoc :: L.Localizer -> PackageChanges -> D.Doc
131−toDoc localizer changes@(PackageChanges added changed removed) =
132− if null added && Map.null changed && null removed then
133− "No API changes detected, so this is a" <+> D.green "PATCH" <+> "change."
134− else
135− let
136− magDoc =
137− D.fromString (Diff.magnitudeToString (Diff.toMagnitude changes))
138−
139− header =
140− "This is a" <+> D.green magDoc <+> "change."
141−
142− addedChunk =
143− if null added then [] else
144− [ Chunk "ADDED MODULES" MINOR $
145− D.vcat $ map (D.fromString . ModuleName.nameToString) added
146− ]
147−
148− removedChunk =
149− if null removed then [] else
150− [ Chunk "REMOVED MODULES" MAJOR $
151− D.vcat $ map (D.fromString . ModuleName.nameToString) removed
152− ]
153−
154− chunks =
155− addedChunk ++ removedChunk ++ map (changesToChunk localizer) (Map.toList changed)
156− in
157− D.vcat (header : "" : map chunkToDoc chunks)
158−
159−
160−data Chunk =
161− Chunk
162− { _title :: String
163− , _magnitude :: Magnitude
164− , _details :: D.Doc
165− }
166−
167−
168−chunkToDoc :: Chunk -> D.Doc
169−chunkToDoc (Chunk title magnitude details) =
170− let
171− magDoc =
172− Diff.magnitudeToString magnitude
173−
174− header =
175− "----" <+> D.fromString title <+> "-" <+> D.fromString magDoc <+> "----"
176− in
177− D.vcat
178− [ D.dullcyan header
179− , ""
180− , D.indent 4 details
181− , ""
182− , ""
183− ]
184−
185−
186−changesToChunk :: L.Localizer -> (Name.Name, ModuleChanges) -> Chunk
187−changesToChunk localizer (name, changes@(ModuleChanges unions aliases values binops)) =
188− let
189− magnitude =
190− Diff.moduleChangeMagnitude changes
191−
192− (unionAdd, unionChange, unionRemove) =
193− changesToDocTriple (unionToDoc localizer) unions
194−
195− (aliasAdd, aliasChange, aliasRemove) =
196− changesToDocTriple (aliasToDoc localizer) aliases
197−
198− (valueAdd, valueChange, valueRemove) =
199− changesToDocTriple (valueToDoc localizer) values
200−
201− (binopAdd, binopChange, binopRemove) =
202− changesToDocTriple (binopToDoc localizer) binops
203− in
204− Chunk (Name.toString name) magnitude $
205− D.vcat $ List.intersperse "" $ Maybe.catMaybes $
206− [ changesToDoc "Added" unionAdd aliasAdd valueAdd binopAdd
207− , changesToDoc "Removed" unionRemove aliasRemove valueRemove binopRemove
208− , changesToDoc "Changed" unionChange aliasChange valueChange binopChange
209− ]
210−
211−
212−changesToDocTriple :: (k -> v -> D.Doc) -> Changes k v -> ([D.Doc], [D.Doc], [D.Doc])
213−changesToDocTriple entryToDoc (Changes added changed removed) =
214− let
215− indented (name, value) =
216− D.indent 4 (entryToDoc name value)
217−
218− diffed (name, (oldValue, newValue)) =
219− D.vcat
220− [ " - " <> entryToDoc name oldValue
221− , " + " <> entryToDoc name newValue
222− , ""
223− ]
224− in
225− ( map indented (Map.toList added)
226− , map diffed (Map.toList changed)
227− , map indented (Map.toList removed)
228− )
229−
230−
231−changesToDoc :: String -> [D.Doc] -> [D.Doc] -> [D.Doc] -> [D.Doc] -> Maybe D.Doc
232−changesToDoc categoryName unions aliases values binops =
233− if null unions && null aliases && null values && null binops then
234− Nothing
235−
236− else
237− Just $ D.vcat $
238− D.fromString categoryName <> ":" : unions ++ aliases ++ binops ++ values
239−
240−
241−unionToDoc :: L.Localizer -> Name.Name -> Docs.Union -> D.Doc
242−unionToDoc localizer name (Docs.Union _ tvars ctors) =
243− let
244− setup =
245− "type" <+> D.fromName name <+> D.hsep (map D.fromName tvars)
246−
247− ctorDoc (ctor, tipes) =
248− typeDoc localizer (Type.Type ctor tipes)
249− in
250− D.hang 4 (D.sep (setup : zipWith (<+>) ("=" : repeat "|") (map ctorDoc ctors)))
251−
252−
253−aliasToDoc :: L.Localizer -> Name.Name -> Docs.Alias -> D.Doc
254−aliasToDoc localizer name (Docs.Alias _ tvars tipe) =
255− let
256− declaration =
257− "type" <+> "alias" <+> D.hsep (map D.fromName (name:tvars)) <+> "="
258− in
259− D.hang 4 (D.sep [ declaration, typeDoc localizer tipe ])
260−
261−
262−valueToDoc :: L.Localizer -> Name.Name -> Docs.Value -> D.Doc
263−valueToDoc localizer name (Docs.Value _ tipe) =
264− D.hang 4 $ D.sep [ D.fromName name <+> ":", typeDoc localizer tipe ]
265−
266−
267−binopToDoc :: L.Localizer -> Name.Name -> Docs.Binop -> D.Doc
268−binopToDoc localizer name (Docs.Binop _ tipe associativity (Docs.Precedence n)) =
269− "(" <> D.fromName name <> ")" <+> ":" <+> typeDoc localizer tipe <> D.black details
270− where
271− details =
272− " (" <> D.fromName assoc <> "/" <> D.fromInt n <> ")"
273−
274− assoc =
275− case associativity of
276− Docs.Left -> "left"
277− Docs.Non -> "non"
278− Docs.Right -> "right"
279−
280−
281−typeDoc :: L.Localizer -> Type.Type -> D.Doc
282−typeDoc localizer tipe =
283− Type.toDoc localizer Type.None tipe
builder/src/Elm/Install.hsdeleted−448
@@ -1,448 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Elm.Install
3− ( install
4− )
5− where
6−
7−
8−import Control.Monad (filterM, foldM, forM, msum, void)
9−import Control.Monad.Except (catchError, lift, liftIO)
10−import Data.Map ((!))
11−import qualified Data.Map as Map
12−import qualified Data.Map.Merge.Lazy as Map
13−
14−import qualified Elm.Package as Pkg
15−
16−import qualified Deps.Cache as Cache
17−import Deps.Explorer (Explorer)
18−import qualified Deps.Explorer as Explorer
19−import qualified Deps.Verify as Verify
20−import qualified Deps.Solver as Solver
21−import Elm.Project.Constraint (Constraint)
22−import qualified Elm.Project.Constraint as Con
23−import qualified Elm.Project.Json as Project
24−import qualified Elm.Project.Root as Root
25−import Reporting.Doc ((<>), (<+>))
26−import qualified Reporting.Doc as D
27−import qualified Reporting.Exit as Exit
28−import qualified Reporting.Exit.Install as E
29−import qualified Reporting.Task as Task
30−
31−
32−
33−-- INSTALL
34−
35−
36−install :: Pkg.Name -> Task.Task ()
37−install pkg =
38− do (root, oldProject) <- Root.unsafeGet
39− registry <- Cache.optionalUpdate
40−
41− case oldProject of
42− Project.App info ->
43− do changes <- makeAppPlan registry pkg info
44− attemptElmJsonChange root oldProject Pkg.versionToString changes
45−
46− Project.Pkg info ->
47− do changes <- makePkgPlan registry pkg info
48− attemptElmJsonChange root oldProject Con.toString changes
49−
50−
51−attemptElmJsonChange :: FilePath -> Project.Project -> (a -> String) -> Changes a -> Task.Task ()
52−attemptElmJsonChange root oldProject toString changes =
53− let
54− attempt newProject question =
55− do approved <- Task.getApproval question
56− if approved
57− then upgrade newProject `catchError` revert
58− else liftIO $ putStrLn "Okay, I did not change anything!"
59−
60− upgrade newProject =
61− do liftIO $ Project.write root newProject
62− void $ Verify.verify root newProject
63−
64− revert err =
65− do liftIO $ Project.write root oldProject
66− Task.throw err
67− in
68− case changes of
69− AlreadyInstalled ->
70− do liftIO $ putStrLn "It is already installed!"
71−
72− PromoteTrans newProject ->
73− attempt newProject $
74− D.vcat
75− [ D.fillSep
76− ["I","found","it","in","your","elm.json","file,"
77− ,"but","in","the",D.dullyellow "\"indirect\"","dependencies."
78− ]
79− , D.fillSep
80− ["Should","I","move","it","into",D.green "\"direct\""
81− ,"dependencies","for","more","general","use?","[Y/n]: "
82− ]
83− ]
84−
85− PromoteTest newProject ->
86− attempt newProject $
87− D.vcat
88− [ D.fillSep
89− ["I","found","it","in","your","elm.json","file,"
90− ,"but","in","the",D.dullyellow "\"test-dependencies\"","field."
91− ]
92− , D.fillSep
93− ["Should","I","move","it","into",D.green "\"dependencies\""
94− ,"for","more","general","use?","[Y/n]: "
95− ]
96− ]
97−
98− Changes changeDict newProject ->
99− let
100− widths = Map.foldrWithKey (widen toString) (Widths 0 0 0) changeDict
101− changeDocs = Map.foldrWithKey (addChange toString widths) (Docs [] [] []) changeDict
102− in
103− attempt newProject $ D.vcat $
104− [ "Here is my plan:"
105− , viewChangeDocs changeDocs
106− , ""
107− , "Would you like me to update your elm.json accordingly? [Y/n]: "
108− ]
109−
110−
111−
112−-- MAKE PLANS
113−
114−
115−data Changes vsn
116− = AlreadyInstalled
117− | PromoteTest Project.Project
118− | PromoteTrans Project.Project
119− | Changes (Map.Map Pkg.Name (Change vsn)) Project.Project
120−
121−
122−makeAppPlan :: Cache.PackageRegistry -> Pkg.Name -> Project.AppInfo -> Task.Task (Changes Pkg.Version)
123−makeAppPlan registry pkg info@(Project.AppInfo _ _ depsDirect depsTrans testDirect testTrans) =
124− if Map.member pkg depsDirect then
125− return AlreadyInstalled
126− else
127− do (AppAnswer old new newInfo) <- toAppAnswer registry pkg info
128−
129− return $
130− if Map.member pkg depsTrans then
131− PromoteTrans (Project.App newInfo)
132−
133− else if Map.member pkg testDirect || Map.member pkg testTrans then
134− PromoteTest (Project.App newInfo)
135−
136− else
137− Changes (detectChanges old new) (Project.App newInfo)
138−
139−
140−makePkgPlan :: Cache.PackageRegistry -> Pkg.Name -> Project.PkgInfo -> Task.Task (Changes Constraint)
141−makePkgPlan registry pkg info@(Project.PkgInfo _ _ _ _ _ deps test _) =
142− if Map.member pkg deps then
143− return AlreadyInstalled
144− else
145− case Map.lookup pkg test of
146− Just con ->
147− return $ PromoteTest $ Project.Pkg $
148− info
149− { Project._pkg_deps = Map.insert pkg con deps
150− , Project._pkg_test_deps = Map.delete pkg test
151− }
152−
153− Nothing ->
154− do changes <- addToPkg registry pkg info
155− let news = Map.mapMaybe keepNew changes
156− return $ Changes changes $ Project.Pkg $
157− info
158− { Project._pkg_deps = addNews (Just pkg) news deps
159− , Project._pkg_test_deps = addNews Nothing news test
160− }
161−
162−
163−addNews :: Maybe Pkg.Name -> Map.Map Pkg.Name a -> Map.Map Pkg.Name a -> Map.Map Pkg.Name a
164−addNews pkg new old =
165− Map.merge
166− Map.preserveMissing
167− (Map.mapMaybeMissing (\k v -> if Just k == pkg then Just v else Nothing))
168− (Map.zipWithMatched (\_ _ n -> n))
169− old
170− new
171−
172−
173−
174−-- CHANGES
175−
176−
177−data Change a
178− = Insert a
179− | Change a a
180− | Remove a
181−
182−
183−detectChanges :: (Eq a) => Map.Map Pkg.Name a -> Map.Map Pkg.Name a -> Map.Map Pkg.Name (Change a)
184−detectChanges old new =
185− Map.merge
186− (Map.mapMissing (\_ v -> Remove v))
187− (Map.mapMissing (\_ v -> Insert v))
188− (Map.zipWithMaybeMatched keepChange)
189− old
190− new
191−
192−
193−keepChange :: (Eq v) => k -> v -> v -> Maybe (Change v)
194−keepChange _ old new =
195− if old == new then
196− Nothing
197− else
198− Just (Change old new)
199−
200−
201−keepNew :: Change a -> Maybe a
202−keepNew change =
203− case change of
204− Insert a ->
205− Just a
206−
207− Change _ a ->
208− Just a
209−
210− Remove _ ->
211− Nothing
212−
213−
214−
215−-- ADD TO APP
216−
217−
218−data AppAnswer =
219− AppAnswer
220− { _old :: Map.Map Pkg.Name Pkg.Version
221− , _new :: Map.Map Pkg.Name Pkg.Version
222− , _info :: Project.AppInfo
223− }
224−
225−
226−toAppAnswer :: Cache.PackageRegistry -> Pkg.Name -> Project.AppInfo -> Task.Task AppAnswer
227−toAppAnswer registry pkg info@(Project.AppInfo _ _ depsDirect depsTrans testDirect testTrans) =
228− Explorer.run registry $
229− do Explorer.exists pkg
230− result <- Solver.run (toAppAnswerHelp pkg info)
231− case result of
232− Just answer ->
233− return answer
234−
235− Nothing ->
236− do badNames <-
237− filterM isBadElm $
238− pkg : Map.keys depsDirect
239− ++ Map.keys depsTrans
240− ++ Map.keys testDirect
241− ++ Map.keys testTrans
242− lift $ Task.throw (Exit.Install (E.NoSolution badNames))
243−
244−
245−toAppAnswerHelp :: Pkg.Name -> Project.AppInfo -> Solver.Solver AppAnswer
246−toAppAnswerHelp pkg (Project.AppInfo elm srcDirs depsDirect depsTrans testDirect testTrans) =
247− let
248− directs =
249− Map.union depsDirect testDirect
250−
251− directAndTrans =
252− Map.union directs (Map.union depsTrans testTrans)
253−
254− try toConstraint deps =
255− do solution <- Solver.solve $ Map.insert pkg Con.anything (Map.map toConstraint deps)
256− let newDepsDirect = Map.intersection solution (Map.insert pkg Pkg.dummyVersion depsDirect)
257− newDeps <- lift $ foldM (collectTransitive solution) Map.empty (Map.keys newDepsDirect)
258− return $
259− AppAnswer
260− { _old = directAndTrans
261− , _new = solution
262− , _info =
263− Project.AppInfo
264− elm
265− srcDirs
266− newDepsDirect
267− (Map.difference newDeps newDepsDirect)
268− (Map.intersection solution testDirect)
269− (Map.difference (Map.difference solution newDeps) testDirect)
270− }
271− in
272− msum
273− [ try Con.exactly directAndTrans
274− , try Con.exactly directs
275− , try Con.untilNextMinor directs
276− , try Con.untilNextMajor directs
277− , try (\_ -> Con.anything) directs
278− ]
279−
280−
281−collectTransitive
282− :: Map.Map Pkg.Name Pkg.Version
283− -> Map.Map Pkg.Name Pkg.Version
284− -> Pkg.Name
285− -> Explorer (Map.Map Pkg.Name Pkg.Version)
286−collectTransitive solution state name =
287− do let version = solution ! name
288− (Explorer.Info _ trans) <- Explorer.getConstraints name version
289− foldM
290− (collectTransitive solution)
291− (Map.insert name version state)
292− (Map.keys trans)
293−
294−
295−
296−
297−
298−-- ADD TO PKG
299−
300−
301−addToPkg :: Cache.PackageRegistry -> Pkg.Name -> Project.PkgInfo -> Task.Task (Map.Map Pkg.Name (Change Constraint))
302−addToPkg registry pkg info@(Project.PkgInfo _ _ _ _ _ deps tests _) =
303− Explorer.run registry $
304− do Explorer.exists pkg
305− let old = Map.union deps tests
306− result <- Solver.run (addToPkgHelp pkg info)
307− case result of
308− Just new ->
309− return $ detectChanges old new
310−
311− Nothing ->
312− do let pkgs = Map.keys deps ++ Map.keys tests
313− badNames <- filterM isBadElm (pkg : pkgs)
314− lift $ Task.throw (Exit.Install (E.NoSolution badNames))
315−
316−
317−addToPkgHelp :: Pkg.Name -> Project.PkgInfo -> Solver.Solver (Map.Map Pkg.Name Constraint)
318−addToPkgHelp pkg (Project.PkgInfo _ _ _ _ _ deps tests _) =
319− do let directs = Map.union deps tests
320− let newCons = Map.insert pkg Con.anything directs
321− solution <- Solver.solve newCons
322− let con = Con.untilNextMajor (solution ! pkg)
323− return $ Map.insert pkg con directs
324−
325−
326−
327−-- FAILURE HINTS
328−
329−
330−isBadElm :: Pkg.Name -> Explorer Bool
331−isBadElm name =
332− do versions <- Explorer.getVersions name
333−
334− elmVersions <- forM versions $ \vsn ->
335− Explorer._elm <$> Explorer.getConstraints name vsn
336−
337− return (not (any Con.goodElm elmVersions))
338−
339−
340−
341−-- VIEW CHANGE DOCS
342−
343−
344−data ChangeDocs =
345− Docs
346− { _doc_inserts :: [D.Doc]
347− , _doc_changes :: [D.Doc]
348− , _doc_removes :: [D.Doc]
349− }
350−
351−
352−viewChangeDocs :: ChangeDocs -> D.Doc
353−viewChangeDocs (Docs inserts changes removes) =
354− D.indent 2 $ D.vcat $ concat $
355− [ viewNonZero "Add:" inserts
356− , viewNonZero "Change:" changes
357− , viewNonZero "Remove:" removes
358− ]
359−
360−
361−viewNonZero :: String -> [D.Doc] -> [D.Doc]
362−viewNonZero title entries =
363− if null entries then
364− []
365− else
366− [ ""
367− , D.fromString title
368− , D.indent 2 (D.vcat entries)
369− ]
370−
371−
372−
373−-- VIEW CHANGE
374−
375−
376−addChange :: (a -> String) -> Widths -> Pkg.Name -> Change a -> ChangeDocs -> ChangeDocs
377−addChange toString widths name change (Docs inserts changes removes) =
378− case change of
379− Insert new ->
380− Docs (viewInsert toString widths name new : inserts) changes removes
381−
382− Change old new ->
383− Docs inserts (viewChange toString widths name old new : changes) removes
384−
385− Remove old ->
386− Docs inserts changes (viewRemove toString widths name old : removes)
387−
388−
389−viewInsert :: (a -> String) -> Widths -> Pkg.Name -> a -> D.Doc
390−viewInsert toString (Widths nameWidth leftWidth _) name new =
391− viewName nameWidth name <+> pad leftWidth (toString new)
392−
393−
394−viewChange :: (a -> String) -> Widths -> Pkg.Name -> a -> a -> D.Doc
395−viewChange toString (Widths nameWidth leftWidth rightWidth) name old new =
396− D.hsep
397− [ viewName nameWidth name
398− , pad leftWidth (toString old)
399− , "=>"
400− , pad rightWidth (toString new)
401− ]
402−
403−
404−viewRemove :: (a -> String) -> Widths -> Pkg.Name -> a -> D.Doc
405−viewRemove toString (Widths nameWidth leftWidth _) name old =
406− viewName nameWidth name <+> pad leftWidth (toString old)
407−
408−
409−viewName :: Int -> Pkg.Name -> D.Doc
410−viewName width name =
411− D.fill (width + 3) (D.fromText (Pkg.toText name))
412−
413−
414−pad :: Int -> String -> D.Doc
415−pad width string =
416− D.fromString (replicate (width - length string) ' ') <> D.fromString string
417−
418−
419−
420−-- WIDTHS
421−
422−
423−data Widths =
424− Widths
425− { _name :: !Int
426− , _left :: !Int
427− , _right :: !Int
428− }
429−
430−
431−widen :: (a -> String) -> Pkg.Name -> Change a -> Widths -> Widths
432−widen toString pkg change (Widths name left right) =
433− let
434− toLength a =
435− length (toString a)
436−
437− newName =
438− max name (length (Pkg.toString pkg))
439− in
440− case change of
441− Insert new ->
442− Widths newName (max left (toLength new)) right
443−
444− Change old new ->
445− Widths newName (max left (toLength old)) (max right (toLength new))
446−
447− Remove old ->
448− Widths newName (max left (toLength old)) right
builder/src/Elm/Outline.hsnew file+407
@@ -0,0 +1,407 @@
1+{-# OPTIONS_GHC -Wall #-}
2+{-# LANGUAGE MultiWayIf, OverloadedStrings #-}
3+module Elm.Outline
4+ ( Outline(..)
5+ , AppOutline(..)
6+ , PkgOutline(..)
7+ , Exposed(..)
8+ , SrcDir(..)
9+ , read
10+ , write
11+ , encode
12+ , decoder
13+ , defaultSummary
14+ , flattenExposed
15+ )
16+ where
17+
18+
19+import Prelude hiding (read)
20+import Control.Monad (filterM, liftM)
21+import Data.Binary (Binary, get, put, getWord8, putWord8)
22+import qualified Data.Map as Map
23+import qualified Data.NonEmptyList as NE
24+import qualified Data.OneOrMore as OneOrMore
25+import Foreign.Ptr (minusPtr)
26+import qualified System.Directory as Dir
27+import qualified System.FilePath as FP
28+import System.FilePath ((</>))
29+
30+import qualified Elm.Constraint as Con
31+import qualified Elm.Licenses as Licenses
32+import qualified Elm.ModuleName as ModuleName
33+import qualified Elm.Package as Pkg
34+import qualified Elm.Version as V
35+import qualified File
36+import qualified Json.Decode as D
37+import qualified Json.Encode as E
38+import Json.Encode ((==>))
39+import qualified Json.String as Json
40+import qualified Parse.Primitives as P
41+import qualified Reporting.Exit as Exit
42+
43+
44+
45+-- OUTLINE
46+
47+
48+data Outline
49+ = App AppOutline
50+ | Pkg PkgOutline
51+
52+
53+data AppOutline =
54+ AppOutline
55+ { _app_elm_version :: V.Version
56+ , _app_source_dirs :: NE.List SrcDir
57+ , _app_deps_direct :: Map.Map Pkg.Name V.Version
58+ , _app_deps_indirect :: Map.Map Pkg.Name V.Version
59+ , _app_test_direct :: Map.Map Pkg.Name V.Version
60+ , _app_test_indirect :: Map.Map Pkg.Name V.Version
61+ }
62+
63+
64+data PkgOutline =
65+ PkgOutline
66+ { _pkg_name :: Pkg.Name
67+ , _pkg_summary :: Json.String
68+ , _pkg_license :: Licenses.License
69+ , _pkg_version :: V.Version
70+ , _pkg_exposed :: Exposed
71+ , _pkg_deps :: Map.Map Pkg.Name Con.Constraint
72+ , _pkg_test_deps :: Map.Map Pkg.Name Con.Constraint
73+ , _pkg_elm_version :: Con.Constraint
74+ }
75+
76+
77+data Exposed
78+ = ExposedList [ModuleName.Raw]
79+ | ExposedDict [(Json.String, [ModuleName.Raw])]
80+
81+
82+data SrcDir
83+ = AbsoluteSrcDir FilePath
84+ | RelativeSrcDir FilePath
85+
86+
87+
88+-- DEFAULTS
89+
90+
91+defaultSummary :: Json.String
92+defaultSummary =
93+ Json.fromChars "helpful summary of your project, less than 80 characters"
94+
95+
96+
97+-- HELPERS
98+
99+
100+flattenExposed :: Exposed -> [ModuleName.Raw]
101+flattenExposed exposed =
102+ case exposed of
103+ ExposedList names ->
104+ names
105+
106+ ExposedDict sections ->
107+ concatMap snd sections
108+
109+
110+
111+-- WRITE
112+
113+
114+write :: FilePath -> Outline -> IO ()
115+write root outline =
116+ E.write (root </> "elm.json") (encode outline)
117+
118+
119+
120+-- JSON ENCODE
121+
122+
123+encode :: Outline -> E.Value
124+encode outline =
125+ case outline of
126+ App (AppOutline elm srcDirs depsDirect depsTrans testDirect testTrans) ->
127+ E.object
128+ [ "type" ==> E.chars "application"
129+ , "source-directories" ==> E.list encodeSrcDir (NE.toList srcDirs)
130+ , "elm-version" ==> V.encode elm
131+ , "dependencies" ==>
132+ E.object
133+ [ "direct" ==> encodeDeps V.encode depsDirect
134+ , "indirect" ==> encodeDeps V.encode depsTrans
135+ ]
136+ , "test-dependencies" ==>
137+ E.object
138+ [ "direct" ==> encodeDeps V.encode testDirect
139+ , "indirect" ==> encodeDeps V.encode testTrans
140+ ]
141+ ]
142+
143+ Pkg (PkgOutline name summary license version exposed deps tests elm) ->
144+ E.object
145+ [ "type" ==> E.string (Json.fromChars "package")
146+ , "name" ==> Pkg.encode name
147+ , "summary" ==> E.string summary
148+ , "license" ==> Licenses.encode license
149+ , "version" ==> V.encode version
150+ , "exposed-modules" ==> encodeExposed exposed
151+ , "elm-version" ==> Con.encode elm
152+ , "dependencies" ==> encodeDeps Con.encode deps
153+ , "test-dependencies" ==> encodeDeps Con.encode tests
154+ ]
155+
156+
157+encodeExposed :: Exposed -> E.Value
158+encodeExposed exposed =
159+ case exposed of
160+ ExposedList modules ->
161+ E.list encodeModule modules
162+
163+ ExposedDict chunks ->
164+ E.object (map (fmap (E.list encodeModule)) chunks)
165+
166+
167+encodeModule :: ModuleName.Raw -> E.Value
168+encodeModule name =
169+ E.name name
170+
171+
172+encodeDeps :: (a -> E.Value) -> Map.Map Pkg.Name a -> E.Value
173+encodeDeps encodeValue deps =
174+ E.dict Pkg.toJsonString encodeValue deps
175+
176+
177+encodeSrcDir :: SrcDir -> E.Value
178+encodeSrcDir srcDir =
179+ case srcDir of
180+ AbsoluteSrcDir dir -> E.chars dir
181+ RelativeSrcDir dir -> E.chars dir
182+
183+
184+
185+-- PARSE AND VERIFY
186+
187+
188+read :: FilePath -> IO (Either Exit.Outline Outline)
189+read root =
190+ do bytes <- File.readUtf8 (root </> "elm.json")
191+ case D.fromByteString decoder bytes of
192+ Left err ->
193+ return $ Left (Exit.OutlineHasBadStructure err)
194+
195+ Right outline ->
196+ case outline of
197+ Pkg (PkgOutline pkg _ _ _ _ deps _ _) ->
198+ return $
199+ if Map.notMember Pkg.core deps && pkg /= Pkg.core
200+ then Left Exit.OutlineNoPkgCore
201+ else Right outline
202+
203+ App (AppOutline _ srcDirs direct indirect _ _)
204+ | Map.notMember Pkg.core direct ->
205+ return $ Left Exit.OutlineNoAppCore
206+
207+ | Map.notMember Pkg.json direct && Map.notMember Pkg.json indirect ->
208+ return $ Left Exit.OutlineNoAppJson
209+
210+ | otherwise ->
211+ do badDirs <- filterM (isSrcDirMissing root) (NE.toList srcDirs)
212+ case map toGiven badDirs of
213+ d:ds ->
214+ return $ Left (Exit.OutlineHasMissingSrcDirs d ds)
215+
216+ [] ->
217+ do maybeDups <- detectDuplicates root (NE.toList srcDirs)
218+ case maybeDups of
219+ Nothing ->
220+ return $ Right outline
221+
222+ Just (canonicalDir, (dir1,dir2)) ->
223+ return $ Left (Exit.OutlineHasDuplicateSrcDirs canonicalDir dir1 dir2)
224+
225+
226+isSrcDirMissing :: FilePath -> SrcDir -> IO Bool
227+isSrcDirMissing root srcDir =
228+ not <$> Dir.doesDirectoryExist (toAbsolute root srcDir)
229+
230+
231+toGiven :: SrcDir -> FilePath
232+toGiven srcDir =
233+ case srcDir of
234+ AbsoluteSrcDir dir -> dir
235+ RelativeSrcDir dir -> dir
236+
237+
238+toAbsolute :: FilePath -> SrcDir -> FilePath
239+toAbsolute root srcDir =
240+ case srcDir of
241+ AbsoluteSrcDir dir -> dir
242+ RelativeSrcDir dir -> root </> dir
243+
244+
245+detectDuplicates :: FilePath -> [SrcDir] -> IO (Maybe (FilePath, (FilePath, FilePath)))
246+detectDuplicates root srcDirs =
247+ do pairs <- traverse (toPair root) srcDirs
248+ return $ Map.lookupMin $ Map.mapMaybe isDup $
249+ Map.fromListWith OneOrMore.more pairs
250+
251+
252+toPair :: FilePath -> SrcDir -> IO (FilePath, OneOrMore.OneOrMore FilePath)
253+toPair root srcDir =
254+ do key <- Dir.canonicalizePath (toAbsolute root srcDir)
255+ return (key, OneOrMore.one (toGiven srcDir))
256+
257+
258+isDup :: OneOrMore.OneOrMore FilePath -> Maybe (FilePath, FilePath)
259+isDup paths =
260+ case paths of
261+ OneOrMore.One _ -> Nothing
262+ OneOrMore.More a b -> Just (OneOrMore.getFirstTwo a b)
263+
264+
265+
266+-- JSON DECODE
267+
268+
269+type Decoder a =
270+ D.Decoder Exit.OutlineProblem a
271+
272+
273+decoder :: Decoder Outline
274+decoder =
275+ let
276+ application = Json.fromChars "application"
277+ package = Json.fromChars "package"
278+ in
279+ do tipe <- D.field "type" D.string
280+ if | tipe == application -> App <$> appDecoder
281+ | tipe == package -> Pkg <$> pkgDecoder
282+ | otherwise -> D.failure Exit.OP_BadType
283+
284+
285+appDecoder :: Decoder AppOutline
286+appDecoder =
287+ AppOutline
288+ <$> D.field "elm-version" versionDecoder
289+ <*> D.field "source-directories" dirsDecoder
290+ <*> D.field "dependencies" (D.field "direct" (depsDecoder versionDecoder))
291+ <*> D.field "dependencies" (D.field "indirect" (depsDecoder versionDecoder))
292+ <*> D.field "test-dependencies" (D.field "direct" (depsDecoder versionDecoder))
293+ <*> D.field "test-dependencies" (D.field "indirect" (depsDecoder versionDecoder))
294+
295+
296+pkgDecoder :: Decoder PkgOutline
297+pkgDecoder =
298+ PkgOutline
299+ <$> D.field "name" nameDecoder
300+ <*> D.field "summary" summaryDecoder
301+ <*> D.field "license" (Licenses.decoder Exit.OP_BadLicense)
302+ <*> D.field "version" versionDecoder
303+ <*> D.field "exposed-modules" exposedDecoder
304+ <*> D.field "dependencies" (depsDecoder constraintDecoder)
305+ <*> D.field "test-dependencies" (depsDecoder constraintDecoder)
306+ <*> D.field "elm-version" constraintDecoder
307+
308+
309+
310+-- JSON DECODE HELPERS
311+
312+
313+nameDecoder :: Decoder Pkg.Name
314+nameDecoder =
315+ D.mapError (uncurry Exit.OP_BadPkgName) Pkg.decoder
316+
317+
318+summaryDecoder :: Decoder Json.String
319+summaryDecoder =
320+ D.customString
321+ (boundParser 80 Exit.OP_BadSummaryTooLong)
322+ (\_ _ -> Exit.OP_BadSummaryTooLong)
323+
324+
325+versionDecoder :: Decoder V.Version
326+versionDecoder =
327+ D.mapError (uncurry Exit.OP_BadVersion) V.decoder
328+
329+
330+constraintDecoder :: Decoder Con.Constraint
331+constraintDecoder =
332+ D.mapError Exit.OP_BadConstraint Con.decoder
333+
334+
335+depsDecoder :: Decoder a -> Decoder (Map.Map Pkg.Name a)
336+depsDecoder valueDecoder =
337+ D.dict (Pkg.keyDecoder Exit.OP_BadDependencyName) valueDecoder
338+
339+
340+dirsDecoder :: Decoder (NE.List SrcDir)
341+dirsDecoder =
342+ fmap (toSrcDir . Json.toChars) <$> D.nonEmptyList D.string Exit.OP_NoSrcDirs
343+
344+
345+toSrcDir :: FilePath -> SrcDir
346+toSrcDir path =
347+ if FP.isRelative path
348+ then RelativeSrcDir path
349+ else AbsoluteSrcDir path
350+
351+
352+
353+-- EXPOSED MODULES DECODER
354+
355+
356+exposedDecoder :: Decoder Exposed
357+exposedDecoder =
358+ D.oneOf
359+ [ ExposedList <$> D.list moduleDecoder
360+ , ExposedDict <$> D.pairs headerKeyDecoder (D.list moduleDecoder)
361+ ]
362+
363+
364+moduleDecoder :: Decoder ModuleName.Raw
365+moduleDecoder =
366+ D.mapError (uncurry Exit.OP_BadModuleName) ModuleName.decoder
367+
368+
369+headerKeyDecoder :: D.KeyDecoder Exit.OutlineProblem Json.String
370+headerKeyDecoder =
371+ D.KeyDecoder
372+ (boundParser 20 Exit.OP_BadModuleHeaderTooLong)
373+ (\_ _ -> Exit.OP_BadModuleHeaderTooLong)
374+
375+
376+
377+-- BOUND PARSER
378+
379+
380+boundParser :: Int -> x -> P.Parser x Json.String
381+boundParser bound tooLong =
382+ P.Parser $ \(P.State src pos end indent row col) cok _ cerr _ ->
383+ let
384+ len = minusPtr end pos
385+ newCol = col + fromIntegral len
386+ in
387+ if len < bound
388+ then cok (Json.fromPtr pos end) (P.State src end end indent row newCol)
389+ else cerr row newCol (\_ _ -> tooLong)
390+
391+
392+
393+-- BINARY
394+
395+
396+instance Binary SrcDir where
397+ put outline =
398+ case outline of
399+ AbsoluteSrcDir a -> putWord8 0 >> put a
400+ RelativeSrcDir a -> putWord8 1 >> put a
401+
402+ get =
403+ do n <- getWord8
404+ case n of
405+ 0 -> liftM AbsoluteSrcDir get
406+ 1 -> liftM RelativeSrcDir get
407+ _ -> fail "binary encoding of SrcDir was corrupted"
builder/src/Elm/PerUserCache.hsdeleted−46
@@ -1,46 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module Elm.PerUserCache
3− ( getPackageRoot
4− , getReplRoot
5− , getElmHome
6− )
7− where
8−
9−import qualified System.Directory as Dir
10−import qualified System.Environment as Env
11−import System.FilePath ((</>))
12−
13−import qualified Elm.Version as V
14−
15−
16−
17−-- ROOTS
18−
19−
20−getPackageRoot :: IO FilePath
21−getPackageRoot =
22− getRoot "package"
23−
24−
25−getReplRoot :: IO FilePath
26−getReplRoot =
27− getRoot "repl"
28−
29−
30−getRoot :: FilePath -> IO FilePath
31−getRoot projectName =
32− do home <- getElmHome
33− let root = home </> version </> projectName
34− Dir.createDirectoryIfMissing True root
35− return root
36−
37−
38−version :: FilePath
39−version =
40− V.toChars V.compiler
41−
42−
43−getElmHome :: IO FilePath
44−getElmHome =
45− do maybeHome <- Env.lookupEnv "ELM_HOME"
46− maybe (Dir.getAppUserDataDirectory "elm") return maybeHome
builder/src/Elm/Project.hsdeleted−101
@@ -1,101 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module Elm.Project
4− ( getRoot
5− , getRootWithReplFallback
6− , compile
7− , compileForRepl
8− , generateDocs
9− )
10− where
11−
12−
13−import qualified Data.ByteString as BS
14−import Data.Map ((!))
15−import qualified Data.Name as Name
16−import System.FilePath ((</>))
17−
18−import qualified Elm.Compiler as Compiler
19−import qualified Elm.Docs as Docs
20−import qualified Elm.Project.Json as Project
21−import qualified Elm.Project.Root as Root
22−import qualified Elm.Project.Summary as Summary
23−import Elm.Project.Summary (Summary)
24−import qualified File.Args as Args
25−import qualified File.Compile as Compile
26−import qualified File.Crawl as Crawl
27−import qualified File.Plan as Plan
28−import qualified Generate.Artifacts as Artifacts
29−import qualified Generate.Output as Output
30−import qualified Reporting.Render.Type.Localizer as L
31−import qualified Reporting.Task as Task
32−import qualified Stuff.Paths as Path
33−
34−
35−
36−-- GET ROOT
37−
38−
39−getRoot :: Task.Task Summary
40−getRoot =
41− Root.get
42−
43−
44−getRootWithReplFallback :: IO FilePath
45−getRootWithReplFallback =
46− Root.getWithReplFallback
47−
48−
49−
50−-- COMPILE
51−
52−
53−compile
54− :: Output.Mode
55− -> Output.Target
56− -> Maybe Output.Output
57− -> Maybe FilePath
58− -> Summary
59− -> [FilePath]
60− -> Task.Task ()
61−compile mode target maybeOutput docs summary@(Summary.Summary root project _ _ _) paths =
62− do Project.check project
63− args <- Args.fromPaths summary paths
64− graph <- Crawl.crawl summary args
65− (dirty, ifaces) <- Plan.plan docs summary graph
66− answers <- Compile.compile project docs ifaces dirty
67− results <- Artifacts.write root answers
68− _ <- traverse (Artifacts.writeDocs results) docs
69− Output.generate mode target maybeOutput summary graph results
70−
71−
72−
73−-- COMPILE FOR REPL
74−
75−
76−compileForRepl :: Bool -> L.Localizer -> BS.ByteString -> Maybe Name.Name -> Task.Task (Maybe FilePath)
77−compileForRepl noColors localizer source maybeName =
78− do summary@(Summary.Summary root project _ _ _) <- getRoot
79− Project.check project
80− graph <- Crawl.crawlFromSource summary source
81− (dirty, ifaces) <- Plan.plan Nothing summary graph
82− answers <- Compile.compile project Nothing ifaces dirty
83− results <- Artifacts.write root answers
84− let (Compiler.Artifacts elmi _ _) = results ! Name.replModule
85− traverse (Output.generateReplFile noColors localizer summary graph elmi) maybeName
86−
87−
88−
89−-- GENERATE DOCS
90−
91−
92−generateDocs :: Summary.Summary -> Task.Task Docs.Documentation
93−generateDocs summary@(Summary.Summary root project _ _ _) =
94− do let docsPath = root </> Path.docs
95− args <- Args.fromSummary summary
96− graph <- Crawl.crawl summary args
97− (dirty, ifaces) <- Plan.plan (Just docsPath) summary graph
98− answers <- Compile.compile project (Just docsPath) ifaces dirty
99− results <- Artifacts.write root answers
100− Output.noDebugUsesInPackage summary graph
101− Artifacts.writeDocs results docsPath
builder/src/Elm/Project/Json.hsdeleted−385
@@ -1,385 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module Elm.Project.Json
4− ( Project(..)
5− , AppInfo(..)
6− , PkgInfo(..)
7− , Exposed(..)
8− , defaultSummary
9− -- json
10− , write
11− , encode
12− , read
13− , pkgDecoder
14− -- queries
15− , isPlatformPackage
16− , getName
17− , getExposed
18− , check
19− )
20− where
21−
22−
23−import Prelude hiding (read)
24−import Control.Monad.Trans (liftIO)
25−import Data.Foldable (traverse_)
26−import qualified Data.Map as Map
27−import qualified Data.Utf8 as Utf8
28−import qualified System.Directory as Dir
29−import System.FilePath ((</>))
30−
31−import qualified Elm.Constraint as Con
32−import qualified Elm.Licenses as Licenses
33−import qualified Elm.ModuleName as ModuleName
34−import qualified Elm.Package as Pkg
35−import qualified Elm.Version as V
36−import qualified Json.Decode as D
37−import qualified Json.Encode as E
38−import qualified Reporting.Exit as Exit
39−import qualified Reporting.Exit.Assets as E
40−import qualified Reporting.Task as Task
41−
42−
43−
44−-- PROJECT
45−
46−
47−data Project
48− = App AppInfo
49− | Pkg PkgInfo
50−
51−
52−
53−-- APPLICATION
54−
55−
56−data AppInfo =
57− AppInfo
58− { _app_elm_version :: V.Version
59− , _app_source_dirs :: [FilePath]
60− , _app_deps_direct :: Map.Map Pkg.Name V.Version
61− , _app_deps_trans :: Map.Map Pkg.Name V.Version
62− , _app_test_direct :: Map.Map Pkg.Name V.Version
63− , _app_test_trans :: Map.Map Pkg.Name V.Version
64− }
65−
66−
67−
68−-- PACKAGE
69−
70−
71−data PkgInfo =
72− PkgInfo
73− { _pkg_name :: Pkg.Name
74− , _pkg_summary :: Utf8.String
75− , _pkg_license :: Licenses.License
76− , _pkg_version :: V.Version
77− , _pkg_exposed :: Exposed
78− , _pkg_deps :: Map.Map Pkg.Name Con.Constraint
79− , _pkg_test_deps :: Map.Map Pkg.Name Con.Constraint
80− , _pkg_elm_version :: Con.Constraint
81− }
82−
83−
84−data Exposed
85− = ExposedList [ModuleName.Raw]
86− | ExposedDict [(Utf8.String, [ModuleName.Raw])]
87−
88−
89−
90−-- DEFAULTS
91−
92−
93−defaultSummary :: Utf8.String
94−defaultSummary =
95− "helpful summary of your project, less than 80 characters"
96−
97−
98−
99−-- QUERIES
100−
101−
102−isPlatformPackage :: Project -> Bool
103−isPlatformPackage project =
104− case project of
105− App _ ->
106− False
107−
108− Pkg info ->
109− let
110− (Pkg.Name author _) =
111− _pkg_name info
112− in
113− author == "elm" || author == "elm-explorations"
114−
115−
116−getName :: Project -> Pkg.Name
117−getName project =
118− case project of
119− App _ ->
120− Pkg.dummyName
121−
122− Pkg info ->
123− _pkg_name info
124−
125−
126−getExposed :: PkgInfo -> [ModuleName.Raw]
127−getExposed info =
128− case _pkg_exposed info of
129− ExposedList modules ->
130− modules
131−
132− ExposedDict chunks ->
133− concatMap snd chunks
134−
135−
136−check :: Project -> Task.Task ()
137−check project =
138− case project of
139− Pkg (PkgInfo name _ _ _ _ deps _ _) ->
140− if name == Pkg.core || Map.member Pkg.core deps
141− then return ()
142− else throwBadJson E.NoPkgCore
143−
144− App (AppInfo _ _ direct indirect _ _) ->
145− if Map.member Pkg.core direct then
146−
147− if Map.member Pkg.json direct || Map.member Pkg.json indirect
148− then return ()
149− else throwBadJson E.NoAppJson
150−
151− else
152− throwBadJson E.NoAppCore
153−
154−
155−
156−-- WRITE
157−
158−
159−write :: FilePath -> Project -> IO ()
160−write root project =
161− E.write (root </> "elm.json") (encode project)
162−
163−
164−
165−-- JSON ENCODE
166−
167−
168−encode :: Project -> E.Value
169−encode project =
170− case project of
171− App (AppInfo elm srcDirs depsDirect depsTrans testDirect testTrans) ->
172− E.object
173− [ "type" ==> E.string "application"
174− , "source-directories" ==> E.list (E.string . Utf8.fromChars) srcDirs
175− , "elm-version" ==> V.encode elm
176− , "dependencies" ==>
177− E.object
178− [ "direct" ==> encodeDeps V.encode depsDirect
179− , "indirect" ==> encodeDeps V.encode depsTrans
180− ]
181− , "test-dependencies" ==>
182− E.object
183− [ "direct" ==> encodeDeps V.encode testDirect
184− , "indirect" ==> encodeDeps V.encode testTrans
185− ]
186− ]
187−
188− Pkg (PkgInfo name summary license version exposed deps tests elm) ->
189− E.object
190− [ "type" ==> E.string "package"
191− , "name" ==> E.string (Pkg.toString name)
192− , "summary" ==> E.string summary
193− , "license" ==> Licenses.encode license
194− , "version" ==> V.encode version
195− , "exposed-modules" ==> encodeExposed exposed
196− , "elm-version" ==> Con.encode elm
197− , "dependencies" ==> encodeDeps Con.encode deps
198− , "test-dependencies" ==> encodeDeps Con.encode tests
199− ]
200−
201−
202−(==>) :: a -> b -> (a, b)
203−(==>) a b =
204− (a, b)
205−
206−
207−encodeExposed :: Exposed -> E.Value
208−encodeExposed exposed =
209− case exposed of
210− ExposedList modules ->
211− E.list encodeModule modules
212−
213− ExposedDict chunks ->
214− E.object (map (fmap (E.list encodeModule)) chunks)
215−
216−
217−encodeModule :: ModuleName.Raw -> E.Value
218−encodeModule name =
219− E.name name
220−
221−
222−encodeDeps :: (a -> E.Value) -> Map.Map Pkg.Name a -> E.Value
223−encodeDeps encodeValue deps =
224− E.dict Pkg.toString encodeValue deps
225−
226−
227−
228−-- PARSE AND VERIFY
229−
230−
231−read :: FilePath -> Task.Task Project
232−read path =
233− do result <- liftIO $ D.fromFile decoder path
234− case result of
235− Right project ->
236− case project of
237− Pkg _ ->
238− do return project
239−
240− App (AppInfo _ srcDirs _ _ _ _) ->
241− do mapM_ doesDirectoryExist srcDirs
242− return project
243−
244− Left err ->
245− throwBadJson (error "TODO bad json" err)
246−
247−
248−throwBadJson :: E.ElmJsonProblem -> Task.Task a
249−throwBadJson problem =
250− Task.throw (Exit.Assets (E.BadElmJson problem))
251−
252−
253−doesDirectoryExist :: FilePath -> Task.Task ()
254−doesDirectoryExist dir =
255− do exists <- liftIO $ Dir.doesDirectoryExist dir
256− if exists
257− then return ()
258− else throwBadJson (E.BadSrcDir dir)
259−
260−
261−
262−-- JSON DECODE
263−
264−
265−type Decoder a =
266− D.Decoder E.BadElmJsonContent a
267−
268−
269−decoder :: Decoder Project
270−decoder =
271− do tipe <- D.field "type" D.string
272− case tipe of
273− "application" ->
274− App <$> appDecoder
275−
276− "package" ->
277− Pkg <$> pkgDecoder
278−
279− other ->
280− D.failure (E.BadType other)
281−
282−
283−appDecoder :: Decoder AppInfo
284−appDecoder =
285− AppInfo
286− <$> D.field "elm-version" versionDecoder
287− <*> D.field "source-directories" (D.list dirDecoder)
288− <*> D.field "dependencies" (D.field "direct" (depsDecoder versionDecoder))
289− <*> D.field "dependencies" (D.field "indirect" (depsDecoder versionDecoder))
290− <*> D.field "test-dependencies" (D.field "direct" (depsDecoder versionDecoder))
291− <*> D.field "test-dependencies" (D.field "indirect" (depsDecoder versionDecoder))
292−
293−
294−pkgDecoder :: Decoder PkgInfo
295−pkgDecoder =
296− PkgInfo
297− <$> D.field "name" pkgNameDecoder
298− <*> D.field "summary" summaryDecoder
299− <*> D.field "license" licenseDecoder
300− <*> D.field "version" versionDecoder
301− <*> D.field "exposed-modules" exposedDecoder
302− <*> D.field "dependencies" (depsDecoder constraintDecoder)
303− <*> D.field "test-dependencies" (depsDecoder constraintDecoder)
304− <*> D.field "elm-version" constraintDecoder
305−
306−
307−
308−-- JSON DECODE HELPERS
309−
310−
311−pkgNameDecoder :: Decoder Pkg.Name
312−pkgNameDecoder =
313− D.mapError E.BadPkgName Pkg.decoder
314−
315−
316−summaryDecoder :: Decoder Utf8.String
317−summaryDecoder =
318− do summary <- D.string
319− if Utf8.size summary < 80
320− then return summary
321− else D.failure E.BadSummaryTooLong
322−
323−
324−licenseDecoder :: Decoder Licenses.License
325−licenseDecoder =
326− Licenses.decoder E.BadLicense
327−
328−
329−versionDecoder :: Decoder V.Version
330−versionDecoder =
331− D.mapError E.BadVersion V.decoder
332−
333−
334−constraintDecoder :: Decoder Con.Constraint
335−constraintDecoder =
336− D.mapError E.BadConstraint Con.decoder
337−
338−
339−depsDecoder :: Decoder a -> Decoder (Map.Map Pkg.Name a)
340−depsDecoder valueDecoder =
341− Map.fromList <$> (
342− traverse validateKey =<< D.pairs valueDecoder
343− )
344−
345−
346−validateKey :: (Utf8.String, a) -> Decoder (Pkg.Name, a)
347−validateKey (key, value) =
348− case Pkg.fromString key of
349− Right name ->
350− return (name, value)
351−
352− Left _ ->
353− D.failure (E.BadDependencyName key)
354−
355−
356−dirDecoder :: Decoder FilePath
357−dirDecoder =
358− Utf8.toChars <$> D.string
359−
360−
361−
362−-- EXPOSED MODULES DECODER
363−
364−
365−exposedDecoder :: Decoder Exposed
366−exposedDecoder =
367− D.oneOf
368− [ ExposedList <$> D.list moduleDecoder
369− , do pairs <- D.pairs (D.list moduleDecoder)
370− traverse_ (checkHeader . fst) pairs
371− return (ExposedDict pairs)
372− ]
373−
374−
375−moduleDecoder :: Decoder ModuleName.Raw
376−moduleDecoder =
377− D.mapError E.BadModuleName ModuleName.decoder
378−
379−
380−checkHeader :: Utf8.String -> Decoder ()
381−checkHeader header =
382− if Utf8.size header < 20 then
383− return ()
384− else
385− D.failure (E.BadModuleHeaderTooLong header)
builder/src/Elm/Project/Root.hsdeleted−95
@@ -1,95 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Elm.Project.Root
3− ( get
4− , unsafeGet
5− , getWithReplFallback
6− )
7− where
8−
9−
10−import Control.Monad.Trans (liftIO)
11−import qualified Data.Map as Map
12−import qualified System.Directory as Dir
13−import System.FilePath ((</>))
14−
15−import qualified Elm.Constraint as Con
16−import qualified Elm.Licenses as Licenses
17−import qualified Elm.Package as Pkg
18−import qualified Elm.Project.Json as Project
19−import qualified Elm.Project.Summary as Summary
20−import qualified Elm.PerUserCache as PerUserCache
21−import qualified Elm.Version as V
22−import qualified File.IO as IO
23−import qualified Reporting.Exit as Exit
24−import qualified Reporting.Task as Task
25−import qualified Stuff.Verify as Verify
26−import qualified Json.Encode as Encode
27−
28−
29−
30−-- GET
31−
32−
33−get :: Task.Task Summary.Summary
34−get =
35− do root <- moveToRoot
36− project <- Project.read "elm.json"
37− Verify.verify root project
38−
39−
40−unsafeGet :: Task.Task (FilePath, Project.Project)
41−unsafeGet =
42− (,) <$> moveToRoot <*> Project.read "elm.json"
43−
44−
45−
46−-- MOVE TO ROOT
47−
48−
49−moveToRoot :: Task.Task FilePath
50−moveToRoot =
51− do maybeRoot <- liftIO $ IO.find "elm.json"
52− case maybeRoot of
53− Just root ->
54− do liftIO $ Dir.setCurrentDirectory root
55− return root
56−
57− Nothing ->
58− Task.throw Exit.NoElmJson
59−
60−
61−
62−-- GET WITH FALLBACK
63−
64−
65−getWithReplFallback :: IO FilePath
66−getWithReplFallback =
67− do maybeRoot <- IO.find "elm.json"
68−
69− case maybeRoot of
70− Just root ->
71− do Dir.setCurrentDirectory root
72− return root
73−
74− Nothing ->
75− do cache <- PerUserCache.getReplRoot
76− let root = cache </> "tmp"
77− Dir.createDirectoryIfMissing True root
78− Dir.setCurrentDirectory root
79− IO.removeDir "elm-stuff"
80− Encode.write "elm.json" (Project.encode (Project.Pkg replInfo))
81− return root
82−
83−
84−replInfo :: Project.PkgInfo
85−replInfo =
86− Project.PkgInfo
87− { Project._pkg_name = Pkg.dummyName
88− , Project._pkg_summary = "dummy code for the REPL"
89− , Project._pkg_license = Licenses.bsd3
90− , Project._pkg_version = V.one
91− , Project._pkg_exposed = Project.ExposedList []
92− , Project._pkg_deps = Map.singleton Pkg.core Con.anything
93− , Project._pkg_test_deps = Map.empty
94− , Project._pkg_elm_version = Con.defaultElm
95− }
builder/src/Elm/Project/Summary.hsdeleted−108
@@ -1,108 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module Elm.Project.Summary
3− ( Summary(..)
4− , ExposedModules
5− , DepsGraph
6− , init
7− , cheapInit
8− )
9− where
10−
11−
12−import Prelude hiding (init)
13−import qualified Data.List as List
14−import qualified Data.Map as Map
15−
16−import qualified Elm.Interface as I
17−import qualified Elm.ModuleName as ModuleName
18−import qualified Elm.Package as Pkg
19−import qualified Elm.Version as V
20−import Elm.Project.Json (Project(..), AppInfo(..), PkgInfo(..))
21−import qualified Elm.Project.Json as Project
22−
23−
24−
25−-- SUMMARY
26−
27−
28−data Summary =
29− Summary
30− { _root :: FilePath
31− , _project :: Project
32− , _exposed :: ExposedModules
33− , _ifaces :: I.Interfaces
34− , _depsGraph :: DepsGraph
35− }
36−
37−
38−type ExposedModules =
39− Map.Map ModuleName.Raw [Pkg.Canonical]
40−
41−
42−type DepsGraph =
43− Map.Map Pkg.Name ( V.Version, [Pkg.Name] )
44−
45−
46−
47−-- MAKE SUMMARY
48−
49−
50−init :: FilePath -> Project -> Map.Map Pkg.Name PkgInfo -> I.Interfaces -> Summary
51−init root project deps ifaces =
52− let
53− exposed =
54− case project of
55− Project.App info ->
56− getExposed deps (_app_deps_direct info)
57−
58− Project.Pkg info ->
59− getExposed deps (_pkg_deps info)
60−
61− privatizedInterfaces =
62− Map.mapMaybeWithKey (privatize exposed) ifaces
63−
64− depsGraph =
65− Map.foldr toNode Map.empty deps
66− in
67− Summary root project exposed privatizedInterfaces depsGraph
68−
69−
70−privatize :: ExposedModules -> ModuleName.Canonical -> I.Interface -> Maybe I.Interface
71−privatize exposed (ModuleName.Canonical _ name) iface =
72− case Map.lookup name exposed of
73− Just [_] ->
74− Just iface
75−
76− _ ->
77− Nothing
78−
79−
80−toNode :: PkgInfo -> DepsGraph -> DepsGraph
81−toNode (PkgInfo name _ _ version _ deps _ _) graph =
82− Map.insert name (version, Map.keys deps) graph
83−
84−
85−
86−-- MAKE CHEAP SUMMARY
87−
88−
89−cheapInit :: FilePath -> PkgInfo -> Map.Map Pkg.Name PkgInfo -> I.Interfaces -> Summary
90−cheapInit root info deps ifaces =
91− Summary root (Pkg info) (getExposed deps (_pkg_deps info)) ifaces Map.empty
92−
93−
94−getExposed :: Map.Map Pkg.Name PkgInfo -> Map.Map Pkg.Name a -> ExposedModules
95−getExposed deps directs =
96− Map.foldl insertExposed Map.empty (Map.intersection deps directs)
97−
98−
99−insertExposed :: ExposedModules -> PkgInfo -> ExposedModules
100−insertExposed exposed info =
101− let
102− home =
103− Pkg.Canonical (_pkg_name info) (_pkg_version info)
104−
105− insertModule dict modul =
106− Map.insertWith (++) modul [home] dict
107− in
108− List.foldl' insertModule exposed (Project.getExposed info)
builder/src/Elm/Publish.hsdeleted−255
@@ -1,255 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module Elm.Publish (publish) where
3−
4−
5−import Control.Monad (when)
6−import Control.Monad.Except (catchError, runExceptT)
7−import Control.Monad.Trans (liftIO, lift)
8−import qualified Data.List as List
9−import qualified Data.Text as Text
10−import qualified System.Directory as Dir
11−import qualified System.Exit as Exit
12−import System.FilePath ((</>))
13−import qualified System.IO as IO
14−import qualified System.Process as Process
15−
16−import qualified Deps.Cache as Cache
17−import qualified Deps.Diff as Diff
18−import qualified Deps.Website as Website
19−import qualified Elm.Bump as Bump
20−import qualified Elm.Docs as Docs
21−import qualified Elm.Package as Pkg
22−import qualified Elm.Project as Project
23−import qualified Elm.Project.Json as Project
24−import qualified Elm.Project.Summary as Summary
25−import qualified Reporting.Exit as Exit
26−import qualified Reporting.Exit.Publish as E
27−import qualified Reporting.Progress as Progress
28−import qualified Reporting.Task as Task
29−import qualified Stuff.Paths as Path
30−
31−
32−
33−-- PUBLISH
34−
35−
36−publish :: Summary.Summary -> Task.Task ()
37−publish summary@(Summary.Summary root project _ _ _) =
38− case project of
39− Project.App _ ->
40− throw E.Application
41−
42− Project.Pkg (Project.PkgInfo name smry _ version exposed _ _ _) ->
43− do
44− registry <- Cache.mandatoryUpdate
45− let maybePublishedVersions = either (const Nothing) Just (Cache.getVersions name registry)
46−
47− Task.report (Progress.PublishStart name version maybePublishedVersions)
48−
49− when (noExposed exposed) $ throw E.NoExposed
50− when (badSummary smry) $ throw E.NoSummary
51−
52− verifyReadme root
53− verifyLicense root
54− docs <- Task.silently (Project.generateDocs summary)
55− verifyVersion name version docs maybePublishedVersions
56− commitHash <- verifyTag name version
57− verifyNoChanges commitHash version
58− zipHash <- verifyZip name version
59−
60− Website.register name version commitHash zipHash
61−
62− Task.report Progress.PublishEnd
63−
64−
65−throw :: E.Exit -> Task.Task a
66−throw exit =
67− Task.throw (Exit.Publish exit)
68−
69−
70−
71−-- VERIFY SUMMARY
72−
73−
74−badSummary :: Text.Text -> Bool
75−badSummary summary =
76− Text.null summary || Project.defaultSummary == summary
77−
78−
79−noExposed :: Project.Exposed -> Bool
80−noExposed exposed =
81− case exposed of
82− Project.ExposedList modules ->
83− null modules
84−
85− Project.ExposedDict chunks ->
86− all (null . snd) chunks
87−
88−
89−
90−-- VERIFY README
91−
92−
93−verifyReadme :: FilePath -> Task.Task ()
94−verifyReadme root =
95− phase Progress.CheckReadme $
96− do let readmePath = root </> "README.md"
97− exists <- liftIO $ Dir.doesFileExist readmePath
98− case exists of
99− False ->
100− throw E.NoReadme
101−
102− True ->
103− do size <- liftIO $ IO.withFile readmePath IO.ReadMode IO.hFileSize
104− if size < 300
105− then throw E.ShortReadme
106− else return ()
107−
108−
109−
110−-- VERIFY LICENSE
111−
112−
113−verifyLicense :: FilePath -> Task.Task ()
114−verifyLicense root =
115− phase Progress.CheckLicense $
116− do let licensePath = root </> "LICENSE"
117− exists <- liftIO $ Dir.doesFileExist licensePath
118− if exists
119− then return ()
120− else throw E.NoLicense
121−
122−
123−
124−-- VERIFY GITHUB TAG
125−
126−
127−verifyTag :: Pkg.Name -> Pkg.Version -> Task.Task String
128−verifyTag name version =
129− phase (Progress.CheckTag version) $
130− Website.githubCommit name version `catchError` \_ ->
131− throw (E.MissingTag version)
132−
133−
134−
135−-- VERIFY NO LOCAL CHANGES SINCE TAG
136−
137−
138−verifyNoChanges :: String -> Pkg.Version -> Task.Task ()
139−verifyNoChanges commitHash version =
140− phase Progress.CheckChanges $
141− do maybeGit <- liftIO $ Dir.findExecutable "git"
142− case maybeGit of
143− Nothing ->
144− throw E.NoGit
145−
146− Just git ->
147− do -- https://stackoverflow.com/questions/3878624/how-do-i-programmatically-determine-if-there-are-uncommited-changes
148− exitCode <- liftIO $
149− Process.rawSystem git [ "diff-index", "--quiet", commitHash, "--" ]
150−
151− case exitCode of
152− Exit.ExitSuccess ->
153− return ()
154−
155− Exit.ExitFailure _ ->
156− throw (E.LocalChanges version)
157−
158−
159−
160−-- VERIFY THAT ZIP BUILDS / COMPUTE HASH
161−
162−
163−verifyZip :: Pkg.Name -> Pkg.Version -> Task.Task Website.Sha
164−verifyZip name version =
165− withTempDir $ \dir ->
166− do hash <- phase Progress.CheckDownload $
167− Website.githubDownload name version dir
168−
169− phase Progress.CheckBuild $
170− do runner <- Task.getSilentRunner
171− result <- liftIO $ Dir.withCurrentDirectory dir $ runner $
172− Task.silently $ Project.generateDocs =<< Project.getRoot
173− either Task.throw (\_ -> return ()) result
174−
175− return hash
176−
177−
178−withTempDir :: (FilePath -> Task.Task a) -> Task.Task a
179−withTempDir callback =
180− do liftIO $ Dir.createDirectoryIfMissing True Path.prepublishDir
181− result <- lift $ runExceptT $ callback Path.prepublishDir
182− liftIO $ Dir.removeDirectoryRecursive Path.prepublishDir
183− either Task.throw return result
184−
185−
186−
187−-- PHASE REPORTING
188−
189−
190−phase :: Progress.PublishPhase -> Task.Task a -> Task.Task a
191−phase publishPhase task =
192− do Task.report $ Progress.PublishProgress publishPhase Nothing
193−
194− result <- task `catchError` \exit ->
195− do Task.report $ Progress.PublishProgress publishPhase (Just Progress.Bad)
196− Task.throw exit
197−
198− Task.report $ Progress.PublishProgress publishPhase (Just Progress.Good)
199−
200− return result
201−
202−
203−
204−-- VERIFY VERSION
205−
206−
207−verifyVersion :: Pkg.Name -> Pkg.Version -> Docs.Documentation -> Maybe [Pkg.Version] -> Task.Task ()
208−verifyVersion name version docs maybePublishedVersions =
209− let
210− reportBumpPhase bumpPhase =
211− Task.report $ Progress.PublishCheckBump version bumpPhase
212− in
213− do reportBumpPhase Progress.StatedVersion
214− case maybePublishedVersions of
215− Nothing ->
216− if version == Pkg.initialVersion then
217− reportBumpPhase Progress.GoodStart
218− else
219− throw (E.NotInitialVersion version)
220−
221− Just publishedVersions ->
222− if elem version publishedVersions then
223− throw $ E.AlreadyPublished version
224− else
225− do (old, magnitude) <- verifyBump name version docs publishedVersions
226− reportBumpPhase (Progress.GoodBump old magnitude)
227−
228− `catchError` \exit ->
229− do reportBumpPhase Progress.BadBump
230− Task.throw exit
231−
232−
233−verifyBump :: Pkg.Name -> Pkg.Version -> Docs.Documentation -> [Pkg.Version] -> Task.Task (Pkg.Version, Diff.Magnitude)
234−verifyBump name statedVersion newDocs publishedVersions =
235− let
236− possibleBumps =
237− Bump.toPossibleBumps publishedVersions
238−
239− isTheBump (_ ,new, _) =
240− statedVersion == new
241− in
242− case List.find isTheBump possibleBumps of
243− Nothing ->
244− throw $ E.InvalidBump statedVersion (last publishedVersions)
245−
246− Just (old, new, magnitude) ->
247− do oldDocs <- Cache.getDocs name old
248− let changes = Diff.diff oldDocs newDocs
249− let realNew = Diff.bump changes old
250− if new == realNew
251− then
252− return (old, magnitude)
253− else
254− throw $ E.BadBump old new magnitude realNew $
255− Diff.toMagnitude changes
builder/src/File/IO.hs → builder/src/File.hsrenamed+104−110
@@ -1,36 +1,66 @@
1−module File.IO
2− ( writeBinary, readBinary
3− , writeUtf8, readUtf8
1+module File
2+ ( Time
3+ , getTime
4+ , zeroTime
5+ , writeBinary
6+ , readBinary
7+ , writeUtf8
8+ , readUtf8
49 , writeBuilder
5− , Writer
6− , put
7− , putByteString
8− , putBuilder
9− , putFile
10+ , writePackage
1011 , exists
11− , remove, removeDir
12− , find
13− , andM
12+ , remove
13+ , removeDir
1414 )
1515 where
1616
1717
18+import qualified Codec.Archive.Zip as Zip
1819import Control.Exception (catch)
1920import qualified Data.Binary as Binary
2021import qualified Data.ByteString as BS
2122import qualified Data.ByteString.Internal as BS
2223import qualified Data.ByteString.Builder as B
23−import qualified Data.ByteString.Builder.Extra as B (defaultChunkSize)
24+import qualified Data.ByteString.Lazy as LBS
25+import qualified Data.Fixed as Fixed
26+import qualified Data.List as List
27+import qualified Data.Time.Clock as Time
28+import qualified Data.Time.Clock.POSIX as Time
2429import qualified Foreign.ForeignPtr as FPtr
2530import GHC.IO.Exception (IOException, IOErrorType(InvalidArgument))
2631import qualified System.Directory as Dir
27−import System.FilePath ((</>))
2832import qualified System.FilePath as FP
33+import System.FilePath ((</>))
2934import qualified System.IO as IO
3035import System.IO.Error (ioeGetErrorType, annotateIOError, modifyIOError)
3136
3237
3338
39+-- TIME
40+
41+
42+newtype Time = Time Fixed.Pico
43+ deriving (Eq, Ord)
44+
45+
46+getTime :: FilePath -> IO Time
47+getTime path =
48+ fmap
49+ (Time . Time.nominalDiffTimeToSeconds . Time.utcTimeToPOSIXSeconds)
50+ (Dir.getModificationTime path)
51+
52+
53+zeroTime :: Time
54+zeroTime =
55+ Time 0
56+
57+
58+instance Binary.Binary Time where
59+ put (Time time) = Binary.put time
60+ get = Time <$> Binary.get
61+
62+
63+
3464-- BINARY
3565
3666
@@ -43,17 +73,28 @@ writeBinary path value =
4373
4474readBinary :: (Binary.Binary a) => FilePath -> IO (Maybe a)
4575readBinary path =
46− do exists_ <- Dir.doesFileExist path
47− if not exists_
48− then return Nothing
49− else
76+ do pathExists <- Dir.doesFileExist path
77+ if pathExists
78+ then
5079 do result <- Binary.decodeFileOrFail path
5180 case result of
52− Left _ ->
53− return Nothing
54−
55− Right value ->
56− return value
81+ Right a ->
82+ return (Just a)
83+
84+ Left (offset, message) ->
85+ do IO.hPutStrLn IO.stderr $ unlines $
86+ [ "+-------------------------------------------------------------------------------"
87+ , "| Corrupt File: " ++ path
88+ , "| Byte Offset: " ++ show offset
89+ , "| Message: " ++ message
90+ , "|"
91+ , "| Please report this to https://github.com/elm/compiler/issues"
92+ , "| Trying to continue anyway."
93+ , "+-------------------------------------------------------------------------------"
94+ ]
95+ return Nothing
96+ else
97+ return Nothing
5798
5899
59100
@@ -61,14 +102,14 @@ readBinary path =
61102
62103
63104writeUtf8 :: FilePath -> BS.ByteString -> IO ()
64−writeUtf8 filePath content =
65− withUtf8 filePath IO.WriteMode $ \handle ->
105+writeUtf8 path content =
106+ withUtf8 path IO.WriteMode $ \handle ->
66107 BS.hPut handle content
67108
68109
69110withUtf8 :: FilePath -> IO.IOMode -> (IO.Handle -> IO a) -> IO a
70−withUtf8 filePath mode callback =
71− IO.withFile filePath mode $ \handle ->
111+withUtf8 path mode callback =
112+ IO.withFile path mode $ \handle ->
72113 do IO.hSetEncoding handle IO.utf8
73114 callback handle
74115
@@ -78,9 +119,9 @@ withUtf8 filePath mode callback =
78119
79120
80121readUtf8 :: FilePath -> IO BS.ByteString
81−readUtf8 filePath =
82− withUtf8 filePath IO.ReadMode $ \handle ->
83− modifyIOError (encodingError filePath) $
122+readUtf8 path =
123+ withUtf8 path IO.ReadMode $ \handle ->
124+ modifyIOError (encodingError path) $
84125 do fileSize <- catch (IO.hFileSize handle) useZeroIfNotRegularFile
85126 let readSize = max 0 (fromIntegral fileSize) + 1
86127 hGetContentsSizeHint handle readSize (max 255 readSize)
@@ -105,14 +146,14 @@ hGetContentsSizeHint handle =
105146
106147
107148encodingError :: FilePath -> IOError -> IOError
108−encodingError filePath ioErr =
149+encodingError path ioErr =
109150 case ioeGetErrorType ioErr of
110151 InvalidArgument ->
111152 annotateIOError
112153 (userError "Bad encoding; the file must be valid UTF-8")
113154 ""
114155 Nothing
115− (Just filePath)
156+ (Just path)
116157
117158 _ ->
118159 ioErr
@@ -130,45 +171,35 @@ writeBuilder path builder =
130171
131172
132173
133−-- WRITER
134−
135−
136−newtype Writer =
137− Writer (IO.Handle -> IO ())
138−
139−
140−put :: FilePath -> Writer -> IO ()
141−put path (Writer callback) =
142− IO.withBinaryFile path IO.WriteMode callback
143−
144−
145−putByteString :: BS.ByteString -> Writer
146−putByteString chunk =
147− Writer $ \handle ->
148− BS.hPut handle chunk
149−
174+-- WRITE PACKAGE
150175
151−putBuilder :: B.Builder -> Writer
152−putBuilder builder =
153− Writer $ \handle ->
154− B.hPutBuilder handle builder
155176
156−
157−putFile :: FilePath -> Writer
158−putFile path =
159− Writer $ \sink ->
160− IO.withBinaryFile path IO.ReadMode $ \source ->
161− putHelp source sink
162−
163−
164−putHelp :: IO.Handle -> IO.Handle -> IO ()
165−putHelp source sink =
166− do chunk <- BS.hGet source B.defaultChunkSize
167− if BS.null chunk
168− then return ()
169− else
170− do BS.hPut sink chunk
171− putHelp source sink
177+writePackage :: FilePath -> Zip.Archive -> IO ()
178+writePackage destination archive =
179+ case Zip.zEntries archive of
180+ [] ->
181+ return ()
182+
183+ entry:entries ->
184+ do let root = length (Zip.eRelativePath entry)
185+ mapM_ (writeEntry destination root) entries
186+
187+
188+writeEntry :: FilePath -> Int -> Zip.Entry -> IO ()
189+writeEntry destination root entry =
190+ let
191+ path = drop root (Zip.eRelativePath entry)
192+ in
193+ if List.isPrefixOf "src/" path
194+ || path == "LICENSE"
195+ || path == "README.md"
196+ || path == "elm.json"
197+ then
198+ if not (null path) && last path == '/'
199+ then Dir.createDirectoryIfMissing True (destination </> path)
200+ else LBS.writeFile (destination </> path) (Zip.fromEntry entry)
201+ else
202+ return ()
172203
173204
174205
@@ -176,8 +207,8 @@ putHelp source sink =
176207
177208
178209exists :: FilePath -> IO Bool
179−exists =
180− Dir.doesFileExist
210+exists path =
211+ Dir.doesFileExist path
181212
182213
183214
@@ -185,10 +216,10 @@ exists =
185216
186217
187218remove :: FilePath -> IO ()
188−remove filePath =
189− do exists_ <- Dir.doesFileExist filePath
219+remove path =
220+ do exists_ <- Dir.doesFileExist path
190221 if exists_
191− then Dir.removeFile filePath
222+ then Dir.removeFile path
192223 else return ()
193224
194225
@@ -198,40 +229,3 @@ removeDir path =
198229 if exists_
199230 then Dir.removeDirectoryRecursive path
200231 else return ()
201−
202−
203−
204−-- FIND FILES
205−
206−
207−find :: FilePath -> IO (Maybe FilePath)
208−find name =
209− do subDir <- Dir.getCurrentDirectory
210− findHelp name (FP.splitDirectories subDir)
211−
212−
213−findHelp :: FilePath -> [String] -> IO (Maybe FilePath)
214−findHelp name dirs =
215− if null dirs then
216− return Nothing
217−
218− else
219− do exists_ <- Dir.doesFileExist (FP.joinPath dirs </> name)
220− if exists_
221− then return (Just (FP.joinPath dirs))
222− else findHelp name (init dirs)
223−
224−
225−
226−-- HELPER
227−
228−
229−andM :: (Monad m) => [m Bool] -> m Bool
230−andM checks =
231− case checks of
232− [] ->
233− return True
234−
235− check : otherChecks ->
236− do bool <- check
237− if bool then andM otherChecks else return False
builder/src/File/Args.hsdeleted−40
@@ -1,40 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module File.Args
3− ( Args(..)
4− , fromPaths
5− , fromSummary
6− )
7− where
8−
9−
10−import qualified Elm.ModuleName as ModuleName
11−import qualified Elm.Project.Json as Project
12−import qualified Elm.Project.Summary as Summary
13−import qualified Reporting.Exit as Exit
14−import qualified Reporting.Exit.Make as E
15−import qualified Reporting.Task as Task
16−
17−
18−data Args root
19− = Pkg [ModuleName.Raw]
20− | Roots root [root]
21−
22−
23−fromPaths :: Summary.Summary -> [FilePath] -> Task.Task (Args FilePath)
24−fromPaths summary paths =
25− case paths of
26− [] ->
27− fromSummary summary
28−
29− first : rest ->
30− return $ Roots first rest
31−
32−
33−fromSummary :: Summary.Summary -> Task.Task (Args a)
34−fromSummary (Summary.Summary _ project _ _ _) =
35− case project of
36− Project.Pkg info ->
37− return $ Pkg (Project.getExposed info)
38−
39− Project.App _ ->
40− Task.throw (Exit.Make E.CannotMakeNothing)
builder/src/File/Compile.hsdeleted−191
@@ -1,191 +0,0 @@
1−module File.Compile
2− ( compile
3− , Answer(..)
4− )
5− where
6−
7−import Control.Concurrent (forkIO)
8−import Control.Concurrent.MVar (MVar, newEmptyMVar, newMVar, putMVar, readMVar, takeMVar)
9−import Control.Monad (void)
10−import Control.Monad.Except (liftIO)
11−import qualified Data.ByteString as BS
12−import qualified Data.Map as Map
13−import qualified Data.Time.Clock as Time
14−
15−import qualified Elm.Compiler as Compiler
16−import qualified Elm.Interface as I
17−import qualified Elm.ModuleName as ModuleName
18−import Elm.Project.Json (Project)
19−import qualified Elm.Project.Json as Project
20−import qualified File.Plan as Plan
21−import qualified Reporting.Progress as Progress
22−import qualified Reporting.Task as Task
23−
24−
25−
26−-- COMPILE
27−
28−
29−compile :: Project -> Maybe FilePath -> I.Interfaces -> Dict Plan.Info -> Task.Task (Dict Answer)
30−compile project maybeDocsPath ifaces modules =
31− do Task.report (Progress.CompileStart (Map.size modules))
32−
33− tell <- Task.getReporter
34−
35− answers <- liftIO $
36− do mvar <- newEmptyMVar
37− iMVar <- newMVar ifaces
38− answerMVars <- Map.traverseWithKey (compileModule tell project maybeDocsPath mvar iMVar) modules
39− putMVar mvar answerMVars
40− traverse readMVar answerMVars
41−
42− Task.report Progress.CompileEnd
43−
44− return answers
45−
46−
47−
48−-- ANSWERS
49−
50−
51−data Answer
52− = Blocked
53− | Bad FilePath Time.UTCTime BS.ByteString [Compiler.Error]
54− | Good Compiler.Artifacts
55−
56−
57−type Dict a = Map.Map ModuleName.Raw a
58−
59−
60−
61−-- COMPILE MODULE
62−
63−
64−compileModule
65− :: (Progress.Progress -> IO ())
66− -> Project
67− -> Maybe FilePath
68− -> MVar (Dict (MVar Answer))
69− -> MVar I.Interfaces
70− -> ModuleName.Raw
71− -> Plan.Info
72− -> IO (MVar Answer)
73−compileModule tell project maybeDocsPath answersMVar ifacesMVar name info =
74− do mvar <- newEmptyMVar
75−
76− void $ forkIO $
77− do answers <- readMVar answersMVar
78− blocked <- isBlocked answers info
79− if blocked
80− then putMVar mvar Blocked
81− else
82− do tell (Progress.CompileFileStart name)
83− let pkg = Project.getName project
84− let docs = toDocsFlag name project maybeDocsPath
85− let imports = makeImports project info
86− ifaces <- readMVar ifacesMVar
87− let source = Plan._src info
88− case Compiler.compile docs pkg imports ifaces source of
89− (_warnings, Left errors) ->
90− do tell (Progress.CompileFileEnd name Progress.Bad)
91− let time = Plan._time info
92− let path = Plan._path info
93− putMVar mvar (Bad path time source errors)
94−
95− (_warnings, Right result@(Compiler.Artifacts elmi _ _)) ->
96− do tell (Progress.CompileFileEnd name Progress.Good)
97− let canonicalName = ModuleName.Canonical pkg name
98− lock <- takeMVar ifacesMVar
99− putMVar ifacesMVar (Map.insert canonicalName elmi lock)
100− putMVar mvar (Good result)
101−
102− return mvar
103−
104−
105−
106−-- TO DOCS FLAG
107−
108−
109−toDocsFlag :: ModuleName.Raw -> Project -> Maybe FilePath -> Compiler.DocsFlag
110−toDocsFlag name project maybeDocsPath =
111− case maybeDocsPath of
112− Nothing ->
113− Compiler.NoDocs
114−
115− Just _ ->
116− case project of
117− Project.App _ ->
118− Compiler.NoDocs
119−
120− Project.Pkg info ->
121− if isExposed name (Project._pkg_exposed info) then
122− Compiler.YesDocs
123− else
124− Compiler.NoDocs
125−
126−
127−isExposed :: ModuleName.Raw -> Project.Exposed -> Bool
128−isExposed name exposed =
129− case exposed of
130− Project.ExposedList modules ->
131− elem name modules
132−
133− Project.ExposedDict chunks ->
134− elem name (concatMap snd chunks)
135−
136−
137−
138−-- IMPORTS
139−
140−
141−makeImports :: Project -> Plan.Info -> Dict ModuleName.Canonical
142−makeImports project (Plan.Info _ _ _ clean dirty foreign) =
143− let
144− pkgName =
145− Project.getName project
146−
147− mkLocal name =
148− ( name, ModuleName.Canonical pkgName name )
149−
150− mkForeign canonicalName@(ModuleName.Canonical _ name) =
151− ( name, canonicalName )
152− in
153− Map.fromList $
154− map mkLocal clean
155− ++ map mkLocal dirty
156− ++ map mkForeign foreign
157−
158−
159−
160−-- INTERFACES
161−
162−
163−isBlocked :: Dict (MVar Answer) -> Plan.Info -> IO Bool
164−isBlocked answers info =
165− anyBlock <$> traverse (get answers) (Plan._dirty info)
166−
167−
168−get :: Dict (MVar Answer) -> ModuleName.Raw -> IO Answer
169−get names name =
170− case Map.lookup name names of
171− Nothing ->
172− error "bug manifesting in File.Complie.get, please report at <TODO>!"
173−
174− Just mvar ->
175− readMVar mvar
176−
177−
178−anyBlock :: [Answer] -> Bool
179−anyBlock answers =
180− case answers of
181− [] ->
182− False
183−
184− Blocked : _ ->
185− True
186−
187− Bad _ _ _ _ : _ ->
188− True
189−
190− Good _ : otherAnswers ->
191− anyBlock otherAnswers
builder/src/File/Crawl.hsdeleted−297
@@ -1,297 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module File.Crawl
4− ( Result
5− , Graph(..)
6− , crawl
7− , crawlFromSource
8− )
9− where
10−
11−import Control.Concurrent.Chan (Chan, newChan, readChan)
12−import Control.Monad (foldM)
13−import Control.Monad.Except (liftIO)
14−import qualified Data.ByteString as BS
15−import qualified Data.Graph as Graph
16−import qualified Data.Map as Map
17−import qualified Data.Set as Set
18−
19−import qualified Elm.Compiler.Objects as Obj
20−import qualified Elm.Kernel as Kernel
21−import qualified Elm.ModuleName as ModuleName
22−import qualified Elm.Package as Pkg
23−
24−import qualified Elm.Project.Json as Project
25−import Elm.Project.Summary (Summary(..))
26−import qualified File.Args as Args
27−import qualified File.Find as Find
28−import qualified File.Header as Header
29−import qualified File.IO as IO
30−import qualified Reporting.Exit as Exit
31−import qualified Reporting.Exit.Crawl as E
32−import qualified Reporting.Task as Task
33−
34−
35−
36−-- GRAPH
37−
38−
39−data Graph kernel problems =
40− Graph
41− { _args :: Args.Args ModuleName.Raw
42− , _locals :: Map.Map ModuleName.Raw Header.Info
43− , _kernels :: Map.Map ModuleName.Raw kernel
44− , _foreigns :: Map.Map ModuleName.Raw Pkg.Canonical
45− , _problems :: problems
46− }
47−
48−
49−type Result =
50− Graph Obj.Kernel ()
51−
52−
53−type WorkGraph =
54− Graph (FilePath, Maybe FilePath) [E.Problem]
55−
56−
57−initWorkGraph :: Args.Args ModuleName.Raw -> Map.Map ModuleName.Raw Header.Info -> WorkGraph
58−initWorkGraph args locals =
59− Graph args locals Map.empty Map.empty []
60−
61−
62−
63−-- CRAWL
64−
65−
66−crawl :: Summary -> Args.Args FilePath -> Task.Task Result
67−crawl summary args =
68− case args of
69− Args.Pkg names ->
70− do let roots = map (Unvisited E.ElmJson) names
71− let graph = initWorkGraph (Args.Pkg names) Map.empty
72− depthFirstSearch summary roots graph
73−
74− Args.Roots path [] ->
75− crawlHelp summary =<< Header.readOneFile summary path
76−
77− Args.Roots p ps ->
78− do (h,hs) <- Header.readManyFiles summary p ps
79− let unvisited = concatMap toUnvisited (h:hs)
80− let graph = initWorkGraph (Args.Roots (fst h) (map fst hs)) (Map.fromList (h:hs))
81− depthFirstSearch summary unvisited graph
82− where
83− toUnvisited (name, Header.Info path _ _ deps) =
84− map (Unvisited (E.Module path name)) deps
85−
86−
87−crawlFromSource :: Summary -> BS.ByteString -> Task.Task Result
88−crawlFromSource summary@(Summary _ project _ _ _) source =
89− crawlHelp summary =<<
90− Header.readSource project source
91−
92−
93−crawlHelp :: Summary -> ( Maybe ModuleName.Raw, Header.Info ) -> Task.Task Result
94−crawlHelp summary ( maybeName, info@(Header.Info path _ _ deps) ) =
95− do let name = maybe "Main" id maybeName
96− let toUnvisited dep = Unvisited (maybe (E.File path) (E.Module path) maybeName) dep
97− let roots = map toUnvisited deps
98− let graph = initWorkGraph (Args.Roots name []) (Map.singleton name info)
99− depthFirstSearch summary roots graph
100−
101−
102−
103−-- DEPTH FIRST SEARCH
104−
105−
106−depthFirstSearch :: Summary -> [Unvisited] -> WorkGraph -> Task.Task Result
107−depthFirstSearch summary unvisited startGraph =
108− do chan <- liftIO newChan
109−
110− (Graph args locals kernelPaths foreigns problems) <-
111− dfs summary chan 0 Set.empty unvisited startGraph
112−
113− case problems of
114− [] ->
115− do checkForCycles locals
116− kernels <- visitKernels summary locals kernelPaths
117− return $ Graph args locals kernels foreigns ()
118−
119− problem : otherProblems ->
120− Task.throw (Exit.Crawl (E.DependencyProblems problem otherProblems))
121−
122−
123−
124−-- CHECK FOR CYCLES
125−
126−
127−checkForCycles :: Map.Map ModuleName.Raw Header.Info -> Task.Task ()
128−checkForCycles locals =
129− let
130− toNode (name, Header.Info _ _ _ imports) =
131− (name, name, imports)
132−
133− components =
134− Graph.stronglyConnComp (map toNode (Map.toList locals))
135− in
136− mapM_ checkComponent components
137−
138−
139−checkComponent :: Graph.SCC ModuleName.Raw -> Task.Task ()
140−checkComponent scc =
141− case scc of
142− Graph.AcyclicSCC _ ->
143− return ()
144−
145− Graph.CyclicSCC names ->
146− Task.throw (Exit.Cycle names)
147−
148−
149−
150−-- CONCURRENT DEPTH FIRST SEARCH
151−
152−
153−dfs
154− :: Summary
155− -> Chan (Either E.Problem Asset)
156− -> Int
157− -> Set.Set ModuleName.Raw
158− -> [Unvisited]
159− -> WorkGraph
160− -> Task.Task WorkGraph
161−dfs summary chan oldPending oldSeen unvisited graph =
162− do (seen, pending) <-
163− foldM (spawnVisitor summary chan) (oldSeen, oldPending) unvisited
164−
165− if pending == 0
166− then return graph
167− else
168− do asset <- liftIO $ readChan chan
169− case asset of
170− Right (Local name info@(Header.Info path _ _ imports)) ->
171− do let newGraph = graph { _locals = Map.insert name info (_locals graph) }
172− let deps = map (Unvisited (E.Module path name)) imports
173− dfs summary chan (pending - 1) seen deps newGraph
174−
175− Right (Kernel name info) ->
176− do let kernels = Map.insert name info (_kernels graph)
177− let newGraph = graph { _kernels = kernels }
178− dfs summary chan (pending - 1) seen [] newGraph
179−
180− Right (Foreign name pkg) ->
181− do let foreigns = Map.insert name pkg (_foreigns graph)
182− let newGraph = graph { _foreigns = foreigns }
183− dfs summary chan (pending - 1) seen [] newGraph
184−
185− Right ForeignKernel ->
186− dfs summary chan (pending - 1) seen [] graph
187−
188− Left problem ->
189− do let problems = problem : _problems graph
190− let newGraph = graph { _problems = problems }
191− dfs summary chan (pending - 1) seen [] newGraph
192−
193−
194−spawnVisitor
195− :: Summary
196− -> Chan (Either E.Problem Asset)
197− -> (Set.Set ModuleName.Raw, Int)
198− -> Unvisited
199− -> Task.Task (Set.Set ModuleName.Raw, Int)
200−spawnVisitor summary chan (seen, n) unvisited@(Unvisited _ name) =
201− if Set.member name seen then
202− return (seen, n)
203− else
204− do Task.workerChan chan (toVisitor summary unvisited)
205− return (Set.insert name seen, n + 1)
206−
207−
208−
209−-- VISITOR
210−
211−
212−data Unvisited =
213− Unvisited
214− { _origin :: E.Origin
215− , _name :: ModuleName.Raw
216− }
217−
218−
219−data Asset
220− = Local ModuleName.Raw Header.Info
221− | Kernel ModuleName.Raw (FilePath, Maybe FilePath)
222− | Foreign ModuleName.Raw Pkg.Canonical
223− | ForeignKernel
224−
225−
226−toVisitor :: Summary -> Unvisited -> Task.Task_ E.Problem Asset
227−toVisitor summary (Unvisited origin name) =
228− do asset <- Find.find summary origin name
229− case asset of
230− Find.Local path ->
231− uncurry Local <$> Header.readModule summary name path
232−
233− Find.Foreign pkg ->
234− return $ Foreign name pkg
235−
236− Find.Kernel clientPath maybeServerPath ->
237− return $ Kernel name (clientPath, maybeServerPath)
238−
239− Find.ForeignKernel ->
240− return ForeignKernel
241−
242−
243−
244−-- VISIT KERNELS
245−
246−
247−visitKernels
248− :: Summary
249− -> Map.Map ModuleName.Raw Header.Info
250− -> Map.Map ModuleName.Raw (FilePath, Maybe FilePath)
251− -> Task.Task (Map.Map ModuleName.Raw Obj.Kernel)
252−visitKernels summary locals kernelPaths =
253− if Map.null kernelPaths then
254− return Map.empty
255− else
256− -- TODO do this concurrently?
257− -- Need better concurrency primitives in Task
258− traverse (readKernel (toImportDict summary locals)) kernelPaths
259−
260−
261−readKernel :: ImportDict -> (FilePath, Maybe FilePath) -> Task.Task Obj.Kernel
262−readKernel importDict (clientPath, maybeServerPath) =
263− Obj.Kernel
264− <$> readKContent importDict clientPath
265− <*> traverse (readKContent importDict) maybeServerPath
266−
267−
268−readKContent :: ImportDict -> FilePath -> Task.Task Kernel.KContent
269−readKContent importDict path =
270− do source <- liftIO $ IO.readUtf8 path
271− case Kernel.parse importDict source of
272− Right content ->
273− return content
274−
275− Left _ ->
276− Task.throw (Exit.Crawl (E.BadKernelHeader path))
277−
278−
279−
280−-- IMPORT DICT
281−
282−
283−type ImportDict =
284− Map.Map ModuleName.Raw [Pkg.Name]
285−
286−
287−toImportDict :: Summary -> Map.Map ModuleName.Raw info -> ImportDict
288−toImportDict (Summary _ project exposed _ _) locals =
289− let
290− localPkg =
291− [Project.getName project]
292−
293− addLocal name _ dict =
294− Map.insertWith (++) name localPkg dict
295− in
296− Map.foldrWithKey addLocal (Map.map (map Pkg._name) exposed) locals
297−
builder/src/File/Find.hsdeleted−114
@@ -1,114 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module File.Find
4− ( Asset(..)
5− , find
6− )
7− where
8−
9−import Control.Monad.Except (liftIO)
10−import qualified Data.Map as Map
11−import qualified Data.Maybe as Maybe
12−import qualified Data.Name as Name
13−import qualified System.FilePath as FP
14−import qualified System.Directory as Dir
15−import System.FilePath ((</>), (<.>))
16−
17−import qualified Elm.ModuleName as ModuleName
18−import qualified Elm.Package as Pkg
19−
20−import qualified Elm.Project.Json as Project
21−import qualified Elm.Project.Summary as Summary
22−import qualified Reporting.Exit.Crawl as E
23−import qualified Reporting.Task as Task
24−
25−
26−
27−-- ASSET
28−
29−
30−data Asset
31− = Local FilePath
32− | Kernel FilePath (Maybe FilePath)
33− | Foreign Pkg.Canonical
34− | ForeignKernel
35−
36−
37−
38−-- FIND
39−
40−
41−find :: Summary.Summary -> E.Origin -> ModuleName.Raw -> Task.Task_ E.Problem Asset
42−find (Summary.Summary root project exposed _ _) origin name =
43− do here <- liftIO Dir.getCurrentDirectory
44− let toRoot dir = FP.makeRelative here (root </> dir)
45− case project of
46− Project.App info ->
47− do let srcDirs = map toRoot (Project._app_source_dirs info)
48− findElm project srcDirs exposed origin name
49−
50− Project.Pkg _ ->
51− if Name.isKernel name then
52− if Project.isPlatformPackage project then
53− findKernel (toRoot "src") exposed origin name
54− else
55− Task.throw $ E.ModuleNameReservedForKernel origin name
56−
57− else
58− findElm project [ toRoot "src" ] exposed origin name
59−
60−
61−
62−-- FIND ELM
63−
64−
65−findElm :: Project.Project -> [FilePath] -> Summary.ExposedModules -> E.Origin -> ModuleName.Raw -> Task.Task_ E.Problem Asset
66−findElm project srcDirs exposed origin name =
67− do
68− paths <- liftIO $ Maybe.catMaybes <$> mapM (elmExists name) srcDirs
69−
70− case (paths, Map.lookup name exposed) of
71− ([path], Nothing) ->
72− return (Local path)
73−
74− ([], Just [pkg]) ->
75− return (Foreign pkg)
76−
77− ([], Nothing) ->
78− case project of
79− Project.App _ ->
80− Task.throw $ E.ModuleNotFound origin name (E.App srcDirs)
81−
82− Project.Pkg _ ->
83− Task.throw $ E.ModuleNotFound origin name E.Pkg
84−
85− (_, maybePkgs) ->
86− Task.throw $ E.ModuleAmbiguous origin name paths (maybe [] id maybePkgs)
87−
88−
89−elmExists :: ModuleName.Raw -> FilePath -> IO (Maybe FilePath)
90−elmExists name srcDir =
91− do let path = srcDir </> ModuleName.nameToSlashPath name <.> "elm"
92− exists <- Dir.doesFileExist path
93− return $ if exists then Just path else Nothing
94−
95−
96−
97−-- FIND KERNEL
98−
99−
100−findKernel :: FilePath -> Summary.ExposedModules -> E.Origin -> ModuleName.Raw -> Task.Task_ E.Problem Asset
101−findKernel srcDir exposed origin name =
102− do let clientPath = srcDir </> ModuleName.nameToSlashPath name <.> "js"
103− let serverPath = srcDir </> ModuleName.nameToSlashPath name <.> "server.js"
104− client <- liftIO $ Dir.doesFileExist clientPath
105− server <- liftIO $ Dir.doesFileExist serverPath
106− if client
107− then return $ Kernel clientPath (if server then Just serverPath else Nothing)
108− else
109− case Map.lookup (Name.getKernel name) exposed of
110− Just [Pkg.Canonical pkg _vsn] | pkg == Pkg.core || pkg == Pkg.virtualDom ->
111− return ForeignKernel
112−
113− _ ->
114− Task.throw $ E.ModuleNotFound origin name E.Pkg
builder/src/File/Hash.hsdeleted−110
@@ -1,110 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module File.Hash
3− ( Hasher
4− , put
5− , Digest
6− , toString
7− , putByteString
8− , putBuilder
9− , putFile
10− )
11− where
12−
13−
14−import Prelude hiding (appendFile)
15−import Control.Monad (foldM)
16−import qualified Control.Monad.State as State
17−import qualified Data.Binary.Get as Binary
18−import qualified Data.ByteString as BS
19−import qualified Data.ByteString.Builder as BS
20−import qualified Data.ByteString.Builder.Extra as BS (defaultChunkSize)
21−import qualified Data.ByteString.Lazy as LBS
22−import qualified Data.Digest.Pure.SHA as SHA
23−import qualified System.IO as IO
24−
25−
26−
27−-- HASHER
28−
29−
30−type Hasher = State.StateT State IO ()
31−
32−
33−type Digest = SHA.Digest SHA.SHA1State
34−
35−
36−put :: FilePath -> Hasher -> IO Digest
37−put path hasher =
38− IO.withBinaryFile path IO.WriteMode $ \handle ->
39− do let state = State handle 0 SHA.sha1Incremental
40− (State _ len decoder) <- State.execStateT hasher state
41− return (SHA.completeSha1Incremental decoder len)
42−
43−
44−toString :: Digest -> String
45−toString =
46− SHA.showDigest
47−
48−
49−
50−-- HASH STATE
51−
52−
53−data State =
54− State
55− { _handle :: !IO.Handle
56− , _length :: !Int
57− , _decoder :: !(Binary.Decoder SHA.SHA1State)
58− }
59−
60−
61−
62−-- PUBLIC API
63−
64−
65−putByteString :: BS.ByteString -> Hasher
66−putByteString chunk =
67− do state <- State.get
68− State.put =<< State.liftIO (appendByteString state chunk)
69−
70−
71−putBuilder :: BS.Builder -> Hasher
72−putBuilder builder =
73− do state <- State.get
74− State.put =<< State.liftIO (appendBuilder builder state)
75−
76−
77−putFile :: FilePath -> Hasher
78−putFile path =
79− do state <- State.get
80− State.put =<< State.liftIO (appendFile path state)
81−
82−
83−
84−-- PRIMITIVES
85−
86−
87−appendByteString :: State -> BS.ByteString -> IO State
88−appendByteString (State handle len decoder) chunk =
89− do BS.hPut handle chunk
90− return $ State handle (len + BS.length chunk) (Binary.pushChunk decoder chunk)
91−
92−
93−appendBuilder :: BS.Builder -> State -> IO State
94−appendBuilder builder state =
95− foldM appendByteString state $
96− LBS.toChunks (BS.toLazyByteString builder)
97−
98−
99−appendFile :: FilePath -> State -> IO State
100−appendFile path state =
101− IO.withBinaryFile path IO.ReadMode $ \handle ->
102− appendHelp handle state
103−
104−
105−appendHelp :: IO.Handle -> State -> IO State
106−appendHelp handle state =
107− do chunk <- BS.hGet handle BS.defaultChunkSize
108− if BS.null chunk
109− then return state
110− else appendHelp handle =<< appendByteString state chunk
builder/src/File/Header.hsdeleted−190
@@ -1,190 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module File.Header
4− ( Info(..)
5− , readModule
6− , readOneFile
7− , readManyFiles
8− , readSource
9− )
10− where
11−
12−import Control.Monad.Except (liftIO)
13−import qualified Data.ByteString as BS
14−import qualified Data.Map as Map
15−import qualified Data.Time.Calendar as Day
16−import qualified Data.Time.Clock as Time
17−import qualified System.Directory as Dir
18−
19−import qualified Elm.Header as Header
20−import qualified Elm.ModuleName as ModuleName
21−import qualified Elm.Project.Json as Project
22−import Elm.Project.Json (Project)
23−import Elm.Project.Summary (Summary(..))
24−import qualified File.IO as IO
25−import qualified Reporting.Exit as Exit
26−import qualified Reporting.Exit.Crawl as E
27−import qualified Reporting.Task as Task
28−
29−
30−
31−-- INFO
32−
33−
34−data Info =
35− Info
36− { _path :: FilePath
37− , _time :: Time.UTCTime
38− , _source :: BS.ByteString
39− , _imports :: [ModuleName.Raw]
40− }
41−
42−
43−atRoot :: Task.Task_ E.Problem a -> Task.Task_ E.Exit a
44−atRoot task =
45− Task.mapError (\problem -> E.DependencyProblems problem []) task
46−
47−
48−-- READ MODULE
49−
50−
51−readModule :: Summary -> ModuleName.Raw -> FilePath -> Task.Task_ E.Problem (ModuleName.Raw, Info)
52−readModule summary expectedName path =
53− do time <- liftIO $ Dir.getModificationTime path
54− source <- liftIO $ IO.readUtf8 path
55− (maybeName, info) <- parse (_project summary) path time source
56− name <- checkName path expectedName maybeName
57− return (name, info)
58−
59−
60−checkName :: FilePath -> ModuleName.Raw -> Maybe ModuleName.Raw -> Task.Task_ E.Problem ModuleName.Raw
61−checkName path expectedName maybeName =
62− case maybeName of
63− Nothing ->
64− Task.throw (E.ModuleNameMissing path expectedName)
65−
66− Just actualName ->
67− if expectedName == actualName
68− then return expectedName
69− else Task.throw (E.ModuleNameMismatch path expectedName actualName)
70−
71−
72−
73−-- READ ONE FILE
74−
75−
76−readOneFile :: Summary -> FilePath -> Task.Task (Maybe ModuleName.Raw, Info)
77−readOneFile summary path =
78− Task.mapError Exit.Crawl $
79− do (time, source) <- readOneHelp path
80− atRoot $ parse (_project summary) path time source
81−
82−
83−readOneHelp :: FilePath -> Task.Task_ E.Exit (Time.UTCTime, BS.ByteString)
84−readOneHelp path =
85− do exists <- IO.exists path
86− if exists
87− then liftIO $ (,) <$> Dir.getModificationTime path <*> IO.readUtf8 path
88− else Task.throw $ E.RootFileNotFound path
89−
90−
91−
92−-- READ MANY FILES
93−
94−
95−readManyFiles :: Summary -> FilePath -> [FilePath] -> Task.Task ((ModuleName.Raw, Info), [(ModuleName.Raw, Info)])
96−readManyFiles summary file files =
97− Task.mapError Exit.Crawl $
98− do info <- readManyFilesHelp summary file
99− infos <- traverse (readManyFilesHelp summary) files
100− let nameTable = foldr insert Map.empty (info:infos)
101− _ <- Map.traverseWithKey detectDuplicateNames nameTable
102− return (info, infos)
103− where
104− append (x,xs) (y,ys) = (x, xs ++ y : ys)
105− insert (k,v) dict = Map.insertWith append k (v, []) dict
106−
107−
108−readManyFilesHelp :: Summary -> FilePath -> Task.Task_ E.Exit (ModuleName.Raw, Info)
109−readManyFilesHelp summary path =
110− do (time, source) <- readOneHelp path
111− (maybeName, info) <- atRoot $ parse (_project summary) path time source
112− case maybeName of
113− Nothing ->
114− Task.throw (E.RootNameless path)
115−
116− Just name ->
117− return (name, info)
118−
119−
120−detectDuplicateNames :: ModuleName.Raw -> (Info, [Info]) -> Task.Task_ E.Exit ()
121−detectDuplicateNames name (info, otherInfos) =
122− case otherInfos of
123− [] ->
124− return ()
125−
126− _ ->
127− Task.throw (E.RootModuleNameDuplicate name (map _path (info : otherInfos)))
128−
129−
130−
131−
132−-- READ SOURCE
133−
134−
135−readSource :: Project -> BS.ByteString -> Task.Task (Maybe ModuleName.Raw, Info)
136−readSource project source =
137− Task.mapError Exit.Crawl $
138− atRoot $ parse project "elm" fakeTime source
139−
140−
141−fakeTime :: Time.UTCTime
142−fakeTime =
143− Time.UTCTime (Day.fromGregorian 3000 1 1) 0
144−
145−
146−
147−-- PARSE HEADER
148−
149−
150−parse :: Project -> FilePath -> Time.UTCTime -> BS.ByteString -> Task.Task_ E.Problem (Maybe ModuleName.Raw, Info)
151−parse project path time source =
152− -- TODO get regions on data extracted here
153− case Header.parse (Project.getName project) source of
154− Right (maybeDecl, deps) ->
155− do maybeName <- checkTag project path maybeDecl
156− return ( maybeName, Info path time source deps )
157−
158− Left msg ->
159− Task.throw (E.BadHeader path time source msg)
160−
161−
162−checkTag :: Project -> FilePath -> Maybe (Header.Tag, ModuleName.Raw) -> Task.Task_ E.Problem (Maybe ModuleName.Raw)
163−checkTag project path maybeDecl =
164− case maybeDecl of
165− Nothing ->
166− return Nothing
167−
168− Just (tag, name) ->
169− let
170− success =
171− return (Just name)
172− in
173− case tag of
174− Header.Normal ->
175− success
176−
177− Header.Port ->
178− case project of
179− Project.App _ ->
180− success
181−
182− Project.Pkg _ ->
183− Task.throw (E.PortsInPackage path name)
184−
185− Header.Effect ->
186− if Project.isPlatformPackage project then
187− success
188−
189− else
190− Task.throw (E.EffectsUnexpected path name)
builder/src/File/Plan.hsdeleted−205
@@ -1,205 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module File.Plan
4− ( plan
5− , Info(..)
6− )
7− where
8−
9−import Control.Concurrent (forkIO)
10−import Control.Concurrent.Chan (Chan, newChan, readChan, writeChan)
11−import Control.Concurrent.MVar (MVar, newEmptyMVar, putMVar, readMVar)
12−import Control.Monad (foldM, void, when)
13−import Control.Monad.Except (liftIO)
14−import qualified Data.Binary as Binary
15−import qualified Data.ByteString as BS
16−import qualified Data.Map as Map
17−import qualified Data.Time.Clock as Time
18−import qualified System.Directory as Dir
19−
20−import qualified Elm.Interface as I
21−import qualified Elm.ModuleName as ModuleName
22−import qualified Elm.Package as Pkg
23−import qualified Elm.Project.Json as Project
24−import qualified Elm.Project.Summary as Summary
25−import qualified File.Crawl as Crawl
26−import qualified File.Header as Header
27−import qualified Reporting.Task as Task
28−import qualified Stuff.Paths
29−
30−
31−
32−-- PLAN
33−
34−
35−type Dict value = Map.Map ModuleName.Raw value
36−
37−
38−plan :: Maybe FilePath -> Summary.Summary -> Crawl.Result -> Task.Task (Dict Info, I.Interfaces)
39−plan docs (Summary.Summary root project _ ifaces _) (Crawl.Graph _ locals _ foreigns _) =
40− liftIO $
41− do queue <- newChan
42− let env = Env queue root (Project.getName project) docs
43−
44− mvar <- newEmptyMVar
45− statusMVars <- Map.traverseWithKey (getStatus env mvar foreigns) locals
46− putMVar mvar statusMVars
47−
48− void $ forkIO $
49− do graph <- Map.traverseMaybeWithKey (\_ -> readMVar) statusMVars
50− writeChan queue (EndLoop graph)
51−
52− ifaceLoader queue ifaces
53−
54−
55−data Env =
56− Env
57− { _queue :: Chan Msg
58− , _root :: FilePath
59− , _pkg :: Pkg.Name
60− , _docs :: Maybe FilePath
61− }
62−
63−
64−
65−-- STATUS
66−
67−
68−type Status = Maybe Info
69− -- Nothing == clean
70− -- Just info == dirty
71−
72−
73−data Info =
74− Info
75− { _path :: FilePath
76− , _time :: Time.UTCTime
77− , _src :: BS.ByteString
78− , _clean :: [ModuleName.Raw]
79− , _dirty :: [ModuleName.Raw]
80− , _foreign :: [ModuleName.Canonical] -- TODO is this needed?
81− }
82−
83−
84−
85−-- GET STATUS
86−
87−
88−getStatus
89− :: Env
90− -> MVar (Dict (MVar Status))
91− -> Dict Pkg.Canonical
92− -> ModuleName.Raw
93− -> Header.Info
94− -> IO (MVar Status)
95−getStatus env statusMVars foreigns name (Header.Info path time src deps) =
96− do mvar <- newEmptyMVar
97−
98− void $ forkIO $ putMVar mvar =<<
99− do statuses <- readMVar statusMVars
100− info <- foldM (addDep statuses foreigns) (Info path time src [] [] []) deps
101−
102− let elmi = Stuff.Paths.elmi (_root env) name
103− let docs = Stuff.Paths.moduleDocs (_root env) name
104−
105− case _dirty info of
106− _ : _ ->
107− do remove elmi
108− remove docs
109− return (Just info)
110−
111− [] ->
112− do freshElmi <- isFresh time elmi
113− freshDocs <-
114− case _docs env of
115− Nothing -> return True
116− Just _ -> isFresh time docs
117−
118− if name /= "Main" && freshElmi && freshDocs
119− then
120− do let canonical = ModuleName.Canonical (_pkg env) name
121− writeChan (_queue env) (Get canonical elmi)
122− return Nothing
123− else
124− do remove elmi
125− remove docs
126− return (Just info)
127−
128− return mvar
129−
130−
131−addDep :: Dict (MVar Status) -> Dict Pkg.Canonical -> Info -> ModuleName.Raw -> IO Info
132−addDep locals foreigns info name =
133− case Map.lookup name locals of
134− Just mvar ->
135− do status <- readMVar mvar
136− case status of
137− Nothing ->
138− return $ info { _clean = name : _clean info }
139−
140− Just _ ->
141− return $ info { _dirty = name : _dirty info }
142−
143− Nothing ->
144− case Map.lookup name foreigns of
145− Just (Pkg.Canonical pkg _vsn) ->
146− return $ info { _foreign = ModuleName.Canonical pkg name : _foreign info }
147−
148− Nothing ->
149− return info -- must be native
150−
151−
152−
153−-- IS FRESH
154−
155−
156−isFresh :: Time.UTCTime -> FilePath -> IO Bool
157−isFresh srcTime cachedFile =
158− andM
159− [ Dir.doesFileExist cachedFile
160− , do cacheTime <- Dir.getModificationTime cachedFile
161− return (cacheTime >= srcTime)
162− ]
163−
164−
165−andM :: [IO Bool] -> IO Bool
166−andM checks =
167− case checks of
168− [] ->
169− return True
170−
171− check : otherChecks ->
172− do bool <- check
173− if bool then andM otherChecks else return False
174−
175−
176−remove :: FilePath -> IO ()
177−remove path =
178− do exists <- Dir.doesFileExist path
179− when exists (Dir.removeFile path)
180−
181−
182−
183−-- INTERFACE LOADER
184−
185−
186−data Msg
187− = EndLoop (Dict Info)
188− | Get ModuleName.Canonical FilePath
189−
190−
191−ifaceLoader :: Chan Msg -> I.Interfaces -> IO (Dict Info, I.Interfaces)
192−ifaceLoader queue ifaces =
193− do msg <- readChan queue
194− case msg of
195− EndLoop dirty ->
196− return ( dirty, ifaces )
197−
198− Get canonical elmi ->
199− case Map.lookup canonical ifaces of
200− Just _ ->
201− ifaceLoader queue ifaces
202−
203− Nothing ->
204− do iface <- Binary.decodeFile elmi
205− ifaceLoader queue $ Map.insert canonical iface ifaces
builder/src/File/Watcher.hsdeleted−76
@@ -1,76 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module File.Watcher where
3−
4−import Control.Concurrent (forkIO, threadDelay)
5−import Control.Concurrent.Chan (newChan, readChan, writeChan)
6−import qualified System.FSNotify as Notify
7−
8−import qualified Elm.Project as Project
9−import Elm.Project (Project)
10−
11−
12−
13−-- GRAPH
14−
15−
16−data Graph =
17− Graph
18− { _elm :: Map.Map Module.Raw Node
19− , _js :: Map.Map Module.Raw FilePath
20− }
21−
22−
23−data Node =
24− Node
25− { _path :: FilePath
26− , _time :: UTCTime
27− , _needs :: Set.Set Module.Raw
28− , _blocks :: Set.Set Module.Raw
29− , _iface :: Maybe (UTCTime, Interface)
30− }
31−
32−
33−
34−-- ABC
35−
36−
37−action :: Notify.Event -> IO ()
38−action event =
39− case event of
40− Notify.Added path time ->
41− return ()
42−
43− Notify.Modified path time ->
44− return ()
45−
46− Notify.Removed path time ->
47− return ()
48−
49−
50−watcher :: Project -> IO ()
51−watcher project =
52− let
53− srcDir =
54− Project.toSourceDir project
55−
56− action event =
57− case event of
58− Notify.Added _ _ ->
59− return ()
60−
61− Notify.Modified path time ->
62−
63− Notify.Removed path time ->
64−
65− in
66− do killer <- newChan
67− mapM_ (watcherHelp killer action) [srcDir]
68−
69−
70−
71−watcherHelp :: Notify.Action -> FilePath -> IO ()
72−watcherHelp killer action dir =
73− void $ forkIO $ Notify.withManager $ \manager ->
74− do stop <- Notify.watchTree manager dir (const True) action
75− _ <- readChan killer
76− stop
builder/src/Generate.hsnew file+211
@@ -0,0 +1,211 @@
1+{-# LANGUAGE BangPatterns #-}
2+module Generate
3+ ( debug
4+ , dev
5+ , prod
6+ , repl
7+ )
8+ where
9+
10+
11+import Prelude hiding (cycle, print)
12+import Control.Concurrent (MVar, forkIO, newEmptyMVar, newMVar, putMVar, readMVar)
13+import Control.Monad (liftM2)
14+import qualified Data.ByteString.Builder as B
15+import Data.Map ((!))
16+import qualified Data.Map as Map
17+import qualified Data.Maybe as Maybe
18+import qualified Data.Name as N
19+import qualified Data.NonEmptyList as NE
20+
21+import qualified AST.Optimized as Opt
22+import qualified Build
23+import qualified Elm.Compiler.Type.Extract as Extract
24+import qualified Elm.Details as Details
25+import qualified Elm.Interface as I
26+import qualified Elm.ModuleName as ModuleName
27+import qualified Elm.Package as Pkg
28+import qualified File
29+import qualified Generate.JavaScript as JS
30+import qualified Generate.Mode as Mode
31+import qualified Nitpick.Debug as Nitpick
32+import qualified Reporting.Exit as Exit
33+import qualified Reporting.Task as Task
34+import qualified Stuff
35+
36+
37+-- NOTE: This is used by Make, Repl, and Reactor right now. But it may be
38+-- desireable to have Repl and Reactor to keep foreign objects in memory
39+-- to make things a bit faster?
40+
41+
42+
43+-- GENERATORS
44+
45+
46+type Task a =
47+ Task.Task Exit.Generate a
48+
49+
50+debug :: FilePath -> Details.Details -> Build.Artifacts -> Task B.Builder
51+debug root details (Build.Artifacts pkg ifaces roots modules) =
52+ do loading <- loadObjects root details modules
53+ types <- loadTypes root ifaces modules
54+ objects <- finalizeObjects loading
55+ let mode = Mode.Dev (Just types)
56+ let graph = objectsToGlobalGraph objects
57+ let mains = gatherMains pkg objects roots
58+ return $ JS.generate mode graph mains
59+
60+
61+dev :: FilePath -> Details.Details -> Build.Artifacts -> Task B.Builder
62+dev root details (Build.Artifacts pkg _ roots modules) =
63+ do objects <- finalizeObjects =<< loadObjects root details modules
64+ let mode = Mode.Dev Nothing
65+ let graph = objectsToGlobalGraph objects
66+ let mains = gatherMains pkg objects roots
67+ return $ JS.generate mode graph mains
68+
69+
70+prod :: FilePath -> Details.Details -> Build.Artifacts -> Task B.Builder
71+prod root details (Build.Artifacts pkg _ roots modules) =
72+ do objects <- finalizeObjects =<< loadObjects root details modules
73+ checkForDebugUses objects
74+ let graph = objectsToGlobalGraph objects
75+ let mode = Mode.Prod (Mode.shortenFieldNames graph)
76+ let mains = gatherMains pkg objects roots
77+ return $ JS.generate mode graph mains
78+
79+
80+repl :: FilePath -> Details.Details -> Bool -> Build.ReplArtifacts -> N.Name -> Task B.Builder
81+repl root details ansi (Build.ReplArtifacts home modules localizer annotations) name =
82+ do objects <- finalizeObjects =<< loadObjects root details modules
83+ let graph = objectsToGlobalGraph objects
84+ return $ JS.generateForRepl ansi localizer graph home name (annotations ! name)
85+
86+
87+
88+-- CHECK FOR DEBUG
89+
90+
91+checkForDebugUses :: Objects -> Task ()
92+checkForDebugUses (Objects _ locals) =
93+ case Map.keys (Map.filter Nitpick.hasDebugUses locals) of
94+ [] -> return ()
95+ m:ms -> Task.throw (Exit.GenerateCannotOptimizeDebugValues m ms)
96+
97+
98+
99+-- GATHER MAINS
100+
101+
102+gatherMains :: Pkg.Name -> Objects -> NE.List Build.Root -> Map.Map ModuleName.Canonical Opt.Main
103+gatherMains pkg (Objects _ locals) roots =
104+ Map.fromList $ Maybe.mapMaybe (lookupMain pkg locals) (NE.toList roots)
105+
106+
107+lookupMain :: Pkg.Name -> Map.Map ModuleName.Raw Opt.LocalGraph -> Build.Root -> Maybe (ModuleName.Canonical, Opt.Main)
108+lookupMain pkg locals root =
109+ let
110+ toPair name (Opt.LocalGraph maybeMain _ _) =
111+ (,) (ModuleName.Canonical pkg name) <$> maybeMain
112+ in
113+ case root of
114+ Build.Inside name -> toPair name =<< Map.lookup name locals
115+ Build.Outside name _ g -> toPair name g
116+
117+
118+
119+-- LOADING OBJECTS
120+
121+
122+data LoadingObjects =
123+ LoadingObjects
124+ { _foreign_mvar :: MVar (Maybe Opt.GlobalGraph)
125+ , _local_mvars :: Map.Map ModuleName.Raw (MVar (Maybe Opt.LocalGraph))
126+ }
127+
128+
129+loadObjects :: FilePath -> Details.Details -> [Build.Module] -> Task LoadingObjects
130+loadObjects root details modules =
131+ Task.io $
132+ do mvar <- Details.loadObjects root details
133+ mvars <- traverse (loadObject root) modules
134+ return $ LoadingObjects mvar (Map.fromList mvars)
135+
136+
137+loadObject :: FilePath -> Build.Module -> IO (ModuleName.Raw, MVar (Maybe Opt.LocalGraph))
138+loadObject root modul =
139+ case modul of
140+ Build.Fresh name _ graph ->
141+ do mvar <- newMVar (Just graph)
142+ return (name, mvar)
143+
144+ Build.Cached name _ _ ->
145+ do mvar <- newEmptyMVar
146+ _ <- forkIO $ putMVar mvar =<< File.readBinary (Stuff.elmo root name)
147+ return (name, mvar)
148+
149+
150+
151+-- FINALIZE OBJECTS
152+
153+
154+data Objects =
155+ Objects
156+ { _foreign :: Opt.GlobalGraph
157+ , _locals :: Map.Map ModuleName.Raw Opt.LocalGraph
158+ }
159+
160+
161+finalizeObjects :: LoadingObjects -> Task Objects
162+finalizeObjects (LoadingObjects mvar mvars) =
163+ Task.eio id $
164+ do result <- readMVar mvar
165+ results <- traverse readMVar mvars
166+ case liftM2 Objects result (sequence results) of
167+ Just loaded -> return (Right loaded)
168+ Nothing -> return (Left Exit.GenerateCannotLoadArtifacts)
169+
170+
171+objectsToGlobalGraph :: Objects -> Opt.GlobalGraph
172+objectsToGlobalGraph (Objects globals locals) =
173+ foldr Opt.addLocalGraph globals locals
174+
175+
176+
177+-- LOAD TYPES
178+
179+
180+loadTypes :: FilePath -> Map.Map ModuleName.Canonical I.DependencyInterface -> [Build.Module] -> Task Extract.Types
181+loadTypes root ifaces modules =
182+ Task.eio id $
183+ do mvars <- traverse (loadTypesHelp root) modules
184+ let !foreigns = Extract.mergeMany (Map.elems (Map.mapWithKey Extract.fromDependencyInterface ifaces))
185+ results <- traverse readMVar mvars
186+ case sequence results of
187+ Just ts -> return (Right (Extract.merge foreigns (Extract.mergeMany ts)))
188+ Nothing -> return (Left Exit.GenerateCannotLoadArtifacts)
189+
190+
191+loadTypesHelp :: FilePath -> Build.Module -> IO (MVar (Maybe Extract.Types))
192+loadTypesHelp root modul =
193+ case modul of
194+ Build.Fresh name iface _ ->
195+ newMVar (Just (Extract.fromInterface name iface))
196+
197+ Build.Cached name _ ciMVar ->
198+ do cachedInterface <- readMVar ciMVar
199+ case cachedInterface of
200+ Build.Unneeded ->
201+ do mvar <- newEmptyMVar
202+ _ <- forkIO $
203+ do maybeIface <- File.readBinary (Stuff.elmi root name)
204+ putMVar mvar (Extract.fromInterface name <$> maybeIface)
205+ return mvar
206+
207+ Build.Loaded iface ->
208+ newMVar (Just (Extract.fromInterface name iface))
209+
210+ Build.Corrupted ->
211+ newMVar Nothing
builder/src/Generate/Artifacts.hsdeleted−138
@@ -1,138 +0,0 @@
1−module Generate.Artifacts
2− ( ignore
3− , write
4− , writeDocs
5− )
6− where
7−
8−
9−import Control.Concurrent (forkIO)
10−import Control.Concurrent.MVar (newEmptyMVar, putMVar, readMVar)
11−import Control.Monad (foldM, void)
12−import Control.Monad.Except (liftIO)
13−import qualified Data.Binary as Binary
14−import Data.Map (Map)
15−import qualified Data.Map as Map
16−import qualified Data.Maybe as Maybe
17−import qualified Data.Text.Encoding as Text
18−
19−import qualified Elm.Compiler as Compiler
20−import qualified Elm.Docs as Docs
21−import qualified Elm.ModuleName as ModuleName
22−import qualified Json.Encode as Encode
23−
24−import File.Compile (Answer(..))
25−import qualified Reporting.Exit.Compile as E
26−import qualified Reporting.Exit as Exit
27−import qualified Reporting.Task as Task
28−import qualified Stuff.Paths as Path
29−
30−
31−
32−-- IGNORE
33−
34−
35−ignore :: Map ModuleName.Raw Answer -> Task.Task (Map ModuleName.Raw Compiler.Artifacts)
36−ignore answers =
37− let
38− ignorer _name result =
39− return result
40− in
41− gather ignorer answers
42−
43−
44−
45−-- WRITE
46−
47−
48−write :: FilePath -> Map ModuleName.Raw Answer -> Task.Task (Map ModuleName.Raw Compiler.Artifacts)
49−write root answers =
50− let
51− writer name result@(Compiler.Artifacts elmi elmo _) =
52− do mvar <- newEmptyMVar
53− void $ forkIO $
54− do Binary.encodeFile (Path.elmi root name) elmi
55− Binary.encodeFile (Path.elmo root name) elmo
56− putMVar mvar result
57− return mvar
58− in
59− do mvars <- gather writer answers
60− liftIO $ traverse readMVar mvars
61−
62−
63−writeDocs :: Map ModuleName.Raw Compiler.Artifacts -> FilePath -> Task.Task Docs.Documentation
64−writeDocs results path =
65− let
66− getDocs (Compiler.Artifacts _ _ docs) =
67− docs
68− in
69− case Maybe.mapMaybe getDocs (Map.elems results) of
70− [] ->
71− return Map.empty
72−
73− docs ->
74− do liftIO $ Encode.writeUgly path $ Encode.list Docs.encode docs
75− return $ Docs.toDict docs
76−
77−
78−
79−-- GATHER
80−
81−
82−gather :: OnGood a -> Map ModuleName.Raw Answer -> Task.Task (Map ModuleName.Raw a)
83−gather onGood answers =
84− do summary <- liftIO $
85− foldM (gatherHelp onGood) (Right Map.empty) (Map.toList answers)
86−
87− case summary of
88− Left (err, errors) ->
89− Task.throw (Exit.Compile err errors)
90−
91− Right results ->
92− return results
93−
94−
95−type OnGood a = ModuleName.Raw -> Compiler.Artifacts -> IO a
96−
97−
98−gatherHelp :: OnGood a -> Summary a -> (ModuleName.Raw, Answer) -> IO (Summary a)
99−gatherHelp onGood summary (name, answer) =
100− case answer of
101− Blocked ->
102− return summary
103−
104− Bad path time src errors ->
105− do let err = E.Exit name path time (Text.decodeUtf8 src) errors
106− return (addErr err summary)
107−
108− Good result ->
109− do value <- onGood name result
110− return (addOk name value summary)
111−
112−
113−
114−-- DICT RESULT
115−
116−
117−type Summary a =
118− Either (E.Exit, [E.Exit]) (Map ModuleName.Raw a)
119−
120−
121−addOk :: ModuleName.Raw -> a -> Summary a -> Summary a
122−addOk name result acc =
123− case acc of
124− Left _ ->
125− acc
126−
127− Right results ->
128− Right (Map.insert name result results)
129−
130−
131−addErr :: E.Exit -> Summary a -> Summary a
132−addErr err acc =
133− case acc of
134− Left (e, es) ->
135− Left (err, e:es)
136−
137− Right _ ->
138− Left (err, [])
builder/src/Generate/Output.hsdeleted−295
@@ -1,295 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module Generate.Output
4− ( Mode(..)
5− , Mode.Target(..)
6− , generate
7− , generateReplFile
8− , noDebugUsesInPackage
9− , Output(..)
10− , output
11− )
12− where
13−
14−
15−import Control.Concurrent.MVar (MVar, putMVar)
16−import Control.Monad.Trans (liftIO)
17−import qualified Data.ByteString.Builder as B
18−import qualified Data.Map as Map
19−import Data.Monoid ((<>))
20−import qualified Data.Name as Name
21−import qualified System.Directory as Dir
22−import qualified System.FilePath as FP
23−import System.FilePath ((</>))
24−
25−import qualified Elm.Compiler as Compiler
26−import qualified Elm.Compiler.Objects as Obj
27−import qualified Elm.Interface as I
28−import qualified Elm.ModuleName as ModuleName
29−import qualified Elm.Package as Pkg
30−import qualified Elm.Project.Json as Project
31−import qualified Elm.Project.Summary as Summary
32−import qualified File.Args as Args
33−import qualified File.Crawl as Crawl
34−import qualified File.IO as IO
35−import qualified Generate.Functions as Functions
36−import qualified Generate.Html as Html
37−import qualified Generate.Nitpick as Nitpick
38−import qualified Generate.JavaScript.Mode as Mode
39−import qualified Reporting.Exit as Exit
40−import qualified Reporting.Exit.Make as E
41−import qualified Reporting.Render.Type.Localizer as L
42−import qualified Reporting.Task as Task
43−import qualified Stuff.Paths as Paths
44−import Terminal.Args (Parser(..))
45−
46−
47−
48−-- GENERATE
49−
50−
51−data Mode = Debug | Dev | Prod
52−
53−
54−generate
55− :: Mode
56− -> Mode.Target
57− -> Maybe Output
58− -> Summary.Summary
59− -> Crawl.Result
60− -> Map.Map ModuleName.Raw Compiler.Artifacts
61− -> Task.Task ()
62−generate mode target maybeOutput summary graph@(Crawl.Graph args locals _ _ _) artifacts =
63− case args of
64− Args.Pkg _ ->
65− return ()
66−
67− Args.Roots name names ->
68− do objectGraph <- organize summary graph
69−
70− realMode <-
71− case mode of
72− Debug ->
73− do interfaces <- getInterfaces summary locals artifacts
74− return $ Mode.debug target interfaces
75−
76− Dev ->
77− return $ Mode.dev target
78−
79− Prod ->
80− do noDebugUses summary objectGraph
81− return $ Mode.prod target objectGraph
82−
83− generateMonolith realMode maybeOutput summary objectGraph (name:names)
84−
85−
86−getInterfaces
87− :: Summary.Summary
88− -> Map.Map ModuleName.Raw a
89− -> Map.Map ModuleName.Raw Compiler.Artifacts
90− -> Task.Task I.Interfaces
91−getInterfaces (Summary.Summary root project _ interfaces _) locals artifacts =
92− let
93− pkg =
94− Project.getName project
95−
96− addArtifact home (Compiler.Artifacts elmi _ _) ifaces =
97− (ModuleName.Canonical pkg home, elmi) : ifaces
98−
99− addInterface home iface ifaces =
100− (ModuleName.Canonical pkg home, iface) : ifaces
101−
102− readInterface home _ =
103− IO.readBinary (Paths.elmi root home)
104− in
105− do cached <- Map.traverseWithKey readInterface (Map.difference locals artifacts)
106− return $
107− Map.union interfaces $ Map.fromList $
108− Map.foldrWithKey addInterface (Map.foldrWithKey addArtifact [] artifacts) cached
109−
110−
111−
112−-- GENERATE MONOLITH
113−
114−
115−generateMonolith
116− :: Mode.Mode
117− -> Maybe Output
118− -> Summary.Summary
119− -> Obj.Graph
120− -> [ModuleName.Raw]
121− -> Task.Task ()
122−generateMonolith mode maybeOutput (Summary.Summary _ project _ _ _) graph rootNames =
123− do let pkg = Project.getName project
124− let roots = map (ModuleName.Canonical pkg) rootNames
125− case Obj.generate mode graph roots of
126− Obj.None ->
127− return ()
128−
129− Obj.Some name _names builder ->
130− let
131− monolith =
132− "(function(scope){\n'use strict';"
133− <> Functions.functions <> builder <> "}(this));"
134− in
135− liftIO $
136− case maybeOutput of
137− Nothing ->
138− IO.writeBuilder "index.html" (Html.sandwich name monolith)
139−
140− Just output_ ->
141− case output_ of
142− None ->
143− return ()
144−
145− JavaScript maybeDir fileName ->
146− do path <- toWritablePath maybeDir fileName
147− IO.writeBuilder path monolith
148−
149− HtmlBuilder mvar ->
150− putMVar mvar (Html.sandwich name monolith)
151−
152− Html maybeDir fileName ->
153− do path <- toWritablePath maybeDir fileName
154− IO.writeBuilder path (Html.sandwich name monolith)
155−
156−
157−
158−-- GENERATE REPL MONOLITH
159−
160−
161−generateReplFile
162− :: Bool
163− -> L.Localizer
164− -> Summary.Summary
165− -> Crawl.Result
166− -> I.Interface
167− -> Name.Name
168− -> Task.Task FilePath
169−generateReplFile noColors localizer summary@(Summary.Summary _ project _ _ _) graph iface name =
170− do
171− objectGraph <- organize summary graph
172−
173− let home = ModuleName.Canonical (Project.getName project) Name.replModule
174− let builder = Obj.generateForRepl (not noColors) localizer objectGraph iface home name
175−
176− liftIO $ IO.writeBuilder (Paths.temp "js") $
177− replRecovery <> "(function(){\n'use strict';" <> Functions.functions <> builder <> "}());"
178−
179− return (Paths.temp "js")
180−
181−
182−replRecovery :: B.Builder
183−replRecovery =
184− "process.on('uncaughtException', function(err) { process.stderr.write(err.toString()); process.exit(1); });"
185−
186−
187−
188−-- ORGANIZE
189−
190−
191−organize :: Summary.Summary -> Crawl.Result -> Task.Task Obj.Graph
192−organize (Summary.Summary root _ _ _ deps) (Crawl.Graph _ locals _ _ _) =
193− do localObjs <- Obj.unions <$> traverse (loadModuleObj root) (Map.keys locals)
194− foreignObjs <- Obj.unions <$> traverse loadPackageObj (Map.toList deps)
195− return (Obj.union localObjs foreignObjs)
196−
197−
198−loadModuleObj :: FilePath -> ModuleName.Raw -> Task.Task Obj.Graph
199−loadModuleObj root name =
200− IO.readBinary (Paths.elmo root name)
201−
202−
203−loadPackageObj :: ( Pkg.Name, (Pkg.Version, deps) ) -> Task.Task Obj.Graph
204−loadPackageObj ( name, (version,_) ) =
205− do dir <- Task.getPackageCacheDirFor name version
206− IO.readBinary (dir </> "objs.dat")
207−
208−
209−
210−-- NO DEBUG USES
211−
212−
213−noDebugUses :: Summary.Summary -> Obj.Graph -> Task.Task ()
214−noDebugUses (Summary.Summary _ project _ _ _) graph =
215− case Nitpick.findDebugUses (Project.getName project) graph of
216− [] ->
217− return ()
218−
219− m:ms ->
220− Task.throw (Exit.Make (E.CannotOptimizeDebugValues m ms))
221−
222−
223−noDebugUsesInPackage :: Summary.Summary -> Crawl.Result -> Task.Task ()
224−noDebugUsesInPackage summary graph =
225− noDebugUses summary =<< organize summary graph
226−
227−
228−
229−-- OUTPUT
230−
231−
232−data Output
233− = None
234− | Html (Maybe FilePath) FilePath
235− | JavaScript (Maybe FilePath) FilePath
236− | HtmlBuilder (MVar B.Builder)
237−
238−
239−toWritablePath :: Maybe FilePath -> FilePath -> IO FilePath
240−toWritablePath maybeDir fileName =
241− case maybeDir of
242− Nothing ->
243− do return fileName
244−
245− Just dir ->
246− do Dir.createDirectoryIfMissing True dir
247− return (dir </> fileName)
248−
249−
250−
251−-- OUTPUT PARSER
252−
253−
254−output :: Parser Output
255−output =
256− Parser
257− { _singular = "output file"
258− , _plural = "output files"
259− , _parser = parseOutput
260− , _suggest = \_ -> return []
261− , _examples = exampleOutput
262− }
263−
264−
265−parseOutput :: String -> Maybe Output
266−parseOutput string =
267− if string == "/dev/null" || string == "NUL" || string == "$null" then
268− Just None
269−
270− else if FP.takeExtension string == ".html" && length string > 5 then
271− splitOutput Html string
272−
273− else if FP.takeExtension string == ".js" && length string > 3 then
274− splitOutput JavaScript string
275−
276− else
277− Nothing
278−
279−
280−splitOutput :: (Maybe FilePath -> FilePath -> Output) -> String -> Maybe Output
281−splitOutput toOutput string =
282− case FP.splitPath string of
283− [] ->
284− Nothing
285−
286− [name] ->
287− Just $ toOutput Nothing name
288−
289− segments ->
290− Just $ toOutput (Just (FP.joinPath (init segments))) (last segments)
291−
292−
293−exampleOutput :: String -> IO [String]
294−exampleOutput _ =
295− return [ "elm.js", "index.html", "/dev/null" ]
builder/src/Http.hsnew file+244
@@ -0,0 +1,244 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Http
3+ ( Manager
4+ , getManager
5+ , toUrl
6+ -- fetch
7+ , get
8+ , post
9+ , Header
10+ , accept
11+ , Error(..)
12+ -- archives
13+ , Sha
14+ , shaToChars
15+ , getArchive
16+ -- upload
17+ , upload
18+ , filePart
19+ , jsonPart
20+ , stringPart
21+ )
22+ where
23+
24+
25+import Prelude hiding (zip)
26+import qualified Codec.Archive.Zip as Zip
27+import Control.Exception (SomeException, handle)
28+import qualified Data.Binary as Binary
29+import qualified Data.Binary.Get as Binary
30+import qualified Data.ByteString.Builder as B
31+import qualified Data.ByteString.Char8 as BS
32+import qualified Data.Digest.Pure.SHA as SHA
33+import qualified Data.String as String
34+import Network.HTTP (urlEncodeVars)
35+import Network.HTTP.Client
36+import Network.HTTP.Client.TLS (tlsManagerSettings)
37+import Network.HTTP.Types.Header (Header, hAccept, hAcceptEncoding, hUserAgent)
38+import Network.HTTP.Types.Method (Method, methodGet, methodPost)
39+import qualified Network.HTTP.Client as Multi (RequestBody(RequestBodyLBS))
40+import qualified Network.HTTP.Client.MultipartFormData as Multi
41+
42+import qualified Json.Encode as Encode
43+import qualified Elm.Version as V
44+
45+
46+
47+-- MANAGER
48+
49+
50+getManager :: IO Manager
51+getManager =
52+ newManager tlsManagerSettings
53+
54+
55+
56+-- URL
57+
58+
59+toUrl :: String -> [(String,String)] -> String
60+toUrl url params =
61+ case params of
62+ [] -> url
63+ _:_ -> url ++ "?" ++ urlEncodeVars params
64+
65+
66+
67+-- FETCH
68+
69+
70+get :: Manager -> String -> [Header] -> (Error -> e) -> (BS.ByteString -> IO (Either e a)) -> IO (Either e a)
71+get =
72+ fetch methodGet
73+
74+
75+post :: Manager -> String -> [Header] -> (Error -> e) -> (BS.ByteString -> IO (Either e a)) -> IO (Either e a)
76+post =
77+ fetch methodPost
78+
79+
80+fetch :: Method -> Manager -> String -> [Header] -> (Error -> e) -> (BS.ByteString -> IO (Either e a)) -> IO (Either e a)
81+fetch methodVerb manager url headers onError onSuccess =
82+ handle (handleSomeException url onError) $
83+ handle (handleHttpException url onError) $
84+ do req0 <- parseUrlThrow url
85+ let req1 =
86+ req0
87+ { method = methodVerb
88+ , requestHeaders = addDefaultHeaders headers
89+ }
90+ withResponse req1 manager $ \response ->
91+ do chunks <- brConsume (responseBody response)
92+ onSuccess (BS.concat chunks)
93+
94+
95+addDefaultHeaders :: [Header] -> [Header]
96+addDefaultHeaders headers =
97+ (hUserAgent, userAgent) : (hAcceptEncoding, "gzip") : headers
98+
99+
100+{-# NOINLINE userAgent #-}
101+userAgent :: BS.ByteString
102+userAgent =
103+ BS.pack ("elm/" ++ V.toChars V.compiler)
104+
105+
106+accept :: BS.ByteString -> Header
107+accept mime =
108+ (hAccept, mime)
109+
110+
111+
112+-- EXCEPTIONS
113+
114+
115+data Error
116+ = BadUrl String String
117+ | BadHttp String HttpExceptionContent
118+ | BadMystery String SomeException
119+
120+
121+handleHttpException :: String -> (Error -> e) -> HttpException -> IO (Either e a)
122+handleHttpException url onError httpException =
123+ case httpException of
124+ InvalidUrlException _ reason ->
125+ return (Left (onError (BadUrl url reason)))
126+
127+ HttpExceptionRequest _ content ->
128+ return (Left (onError (BadHttp url content)))
129+
130+
131+handleSomeException :: String -> (Error -> e) -> SomeException -> IO (Either e a)
132+handleSomeException url onError exception =
133+ return (Left (onError (BadMystery url exception)))
134+
135+
136+
137+-- SHA
138+
139+
140+type Sha = SHA.Digest SHA.SHA1State
141+
142+
143+shaToChars :: Sha -> String
144+shaToChars =
145+ SHA.showDigest
146+
147+
148+
149+-- FETCH ARCHIVE
150+
151+
152+getArchive
153+ :: Manager
154+ -> String
155+ -> (Error -> e)
156+ -> e
157+ -> ((Sha, Zip.Archive) -> IO (Either e a))
158+ -> IO (Either e a)
159+getArchive manager url onError err onSuccess =
160+ handle (handleSomeException url onError) $
161+ handle (handleHttpException url onError) $
162+ do req0 <- parseUrlThrow url
163+ let req1 =
164+ req0
165+ { method = methodGet
166+ , requestHeaders = addDefaultHeaders []
167+ }
168+ withResponse req1 manager $ \response ->
169+ do result <- readArchive (responseBody response)
170+ case result of
171+ Nothing -> return (Left err)
172+ Just shaAndArchive -> onSuccess shaAndArchive
173+
174+
175+readArchive :: BodyReader -> IO (Maybe (Sha, Zip.Archive))
176+readArchive body =
177+ readArchiveHelp body $
178+ AS 0 SHA.sha1Incremental (Binary.runGetIncremental Binary.get)
179+
180+
181+data ArchiveState =
182+ AS
183+ { _len :: !Int
184+ , _sha :: !(Binary.Decoder SHA.SHA1State)
185+ , _zip :: !(Binary.Decoder Zip.Archive)
186+ }
187+
188+
189+readArchiveHelp :: BodyReader -> ArchiveState -> IO (Maybe (Sha, Zip.Archive))
190+readArchiveHelp body (AS len sha zip) =
191+ case zip of
192+ Binary.Fail _ _ _ ->
193+ return Nothing
194+
195+ Binary.Partial k ->
196+ do chunk <- brRead body
197+ readArchiveHelp body $
198+ AS
199+ { _len = len + BS.length chunk
200+ , _sha = Binary.pushChunk sha chunk
201+ , _zip = k (if BS.null chunk then Nothing else Just chunk)
202+ }
203+
204+ Binary.Done _ _ archive ->
205+ return $ Just ( SHA.completeSha1Incremental sha len, archive )
206+
207+
208+
209+-- UPLOAD
210+
211+
212+upload :: Manager -> String -> [Multi.Part] -> IO (Either Error ())
213+upload manager url parts =
214+ handle (handleSomeException url id) $
215+ handle (handleHttpException url id) $
216+ do req0 <- parseUrlThrow url
217+ req1 <-
218+ Multi.formDataBody parts $
219+ req0
220+ { method = methodPost
221+ , requestHeaders = addDefaultHeaders []
222+ , responseTimeout = responseTimeoutNone
223+ }
224+ withResponse req1 manager $ \_ ->
225+ return (Right ())
226+
227+
228+filePart :: String -> FilePath -> Multi.Part
229+filePart name filePath =
230+ Multi.partFileSource (String.fromString name) filePath
231+
232+
233+jsonPart :: String -> FilePath -> Encode.Value -> Multi.Part
234+jsonPart name filePath value =
235+ let
236+ body =
237+ Multi.RequestBodyLBS $ B.toLazyByteString $ Encode.encodeUgly value
238+ in
239+ Multi.partFileRequestBody (String.fromString name) filePath body
240+
241+
242+stringPart :: String -> String -> Multi.Part
243+stringPart name string =
244+ Multi.partBS (String.fromString name) (BS.pack string)
builder/src/Reporting.hsnew file+474
@@ -0,0 +1,474 @@
1+{-# LANGUAGE BangPatterns, OverloadedStrings #-}
2+module Reporting
3+ ( Style
4+ , silent
5+ , json
6+ , terminal
7+ --
8+ , attempt
9+ , attemptWithStyle
10+ --
11+ , Key
12+ , report
13+ , ignorer
14+ , ask
15+ --
16+ , DKey
17+ , DMsg(..)
18+ , trackDetails
19+ --
20+ , BKey
21+ , BMsg(..)
22+ , trackBuild
23+ --
24+ , reportGenerate
25+ )
26+ where
27+
28+
29+import Control.Concurrent
30+import Control.Exception (SomeException, AsyncException(UserInterrupt), catch, fromException, throw)
31+import Control.Monad (when)
32+import qualified Data.ByteString.Builder as B
33+import qualified Data.NonEmptyList as NE
34+import qualified System.Exit as Exit
35+import qualified System.Info as Info
36+import System.IO (hFlush, hPutStr, hPutStrLn, stderr, stdout)
37+
38+import qualified Elm.ModuleName as ModuleName
39+import qualified Elm.Package as Pkg
40+import qualified Elm.Version as V
41+import qualified Json.Encode as Encode
42+import Reporting.Doc ((<+>), (<>))
43+import qualified Reporting.Doc as D
44+import qualified Reporting.Exit as Exit
45+import qualified Reporting.Exit.Help as Help
46+
47+
48+
49+-- STYLE
50+
51+
52+data Style
53+ = Silent
54+ | Json
55+ | Terminal (MVar ())
56+
57+
58+silent :: Style
59+silent =
60+ Silent
61+
62+
63+json :: Style
64+json =
65+ Json
66+
67+
68+terminal :: IO Style
69+terminal =
70+ Terminal <$> newMVar ()
71+
72+
73+
74+-- ATTEMPT
75+
76+
77+attempt :: (x -> Help.Report) -> IO (Either x a) -> IO a
78+attempt toReport work =
79+ do result <- work `catch` reportExceptionsNicely
80+ case result of
81+ Right a ->
82+ return a
83+
84+ Left x ->
85+ do Exit.toStderr (toReport x)
86+ Exit.exitFailure
87+
88+
89+attemptWithStyle :: Style -> (x -> Help.Report) -> IO (Either x a) -> IO a
90+attemptWithStyle style toReport work =
91+ do result <- work `catch` reportExceptionsNicely
92+ case result of
93+ Right a ->
94+ return a
95+
96+ Left x ->
97+ case style of
98+ Silent ->
99+ do Exit.exitFailure
100+
101+ Json ->
102+ do B.hPutBuilder stderr (Encode.encodeUgly (Exit.toJson (toReport x)))
103+ Exit.exitFailure
104+
105+ Terminal mvar ->
106+ do readMVar mvar
107+ Exit.toStderr (toReport x)
108+ Exit.exitFailure
109+
110+
111+
112+-- MARKS
113+
114+
115+goodMark :: D.Doc
116+goodMark =
117+ D.green $ if isWindows then "+" else "●"
118+
119+
120+badMark :: D.Doc
121+badMark =
122+ D.red $ if isWindows then "X" else "✗"
123+
124+
125+isWindows :: Bool
126+isWindows =
127+ Info.os == "mingw32"
128+
129+
130+
131+-- KEY
132+
133+
134+newtype Key msg = Key (msg -> IO ())
135+
136+
137+report :: Key msg -> msg -> IO ()
138+report (Key send) msg =
139+ send msg
140+
141+
142+ignorer :: Key msg
143+ignorer =
144+ Key (\_ -> return ())
145+
146+
147+
148+-- ASK
149+
150+
151+ask :: D.Doc -> IO Bool
152+ask doc =
153+ do Help.toStdout doc
154+ askHelp
155+
156+
157+askHelp :: IO Bool
158+askHelp =
159+ do hFlush stdout
160+ input <- getLine
161+ case input of
162+ "" -> return True
163+ "Y" -> return True
164+ "y" -> return True
165+ "n" -> return False
166+ _ ->
167+ do putStr "Must type 'y' for yes or 'n' for no: "
168+ askHelp
169+
170+
171+-- DETAILS
172+
173+
174+type DKey = Key DMsg
175+
176+
177+trackDetails :: Style -> (DKey -> IO a) -> IO a
178+trackDetails style callback =
179+ case style of
180+ Silent ->
181+ callback (Key (\_ -> return ()))
182+
183+ Json ->
184+ callback (Key (\_ -> return ()))
185+
186+ Terminal mvar ->
187+ do chan <- newChan
188+
189+ _ <- forkIO $
190+ do takeMVar mvar
191+ detailsLoop chan (DState 0 0 0 0 0 0 0)
192+ putMVar mvar ()
193+
194+ answer <- callback (Key (writeChan chan . Just))
195+ writeChan chan Nothing
196+ return answer
197+
198+
199+detailsLoop :: Chan (Maybe DMsg) -> DState -> IO ()
200+detailsLoop chan state@(DState total _ _ _ _ built _) =
201+ do msg <- readChan chan
202+ case msg of
203+ Just dmsg ->
204+ detailsLoop chan =<< detailsStep dmsg state
205+
206+ Nothing ->
207+ putStrLn $ clear (toBuildProgress total total) $
208+ if built == total
209+ then "Dependencies ready!"
210+ else "Dependency problem!"
211+
212+
213+data DState =
214+ DState
215+ { _total :: !Int
216+ , _cached :: !Int
217+ , _requested :: !Int
218+ , _received :: !Int
219+ , _failed :: !Int
220+ , _built :: !Int
221+ , _broken :: !Int
222+ }
223+
224+
225+data DMsg
226+ = DStart Int
227+ | DCached
228+ | DRequested
229+ | DReceived Pkg.Name V.Version
230+ | DFailed Pkg.Name V.Version
231+ | DBuilt
232+ | DBroken
233+
234+
235+detailsStep :: DMsg -> DState -> IO DState
236+detailsStep msg (DState total cached rqst rcvd failed built broken) =
237+ case msg of
238+ DStart numDependencies ->
239+ return (DState numDependencies 0 0 0 0 0 0)
240+
241+ DCached ->
242+ putTransition (DState total (cached + 1) rqst rcvd failed built broken)
243+
244+ DRequested ->
245+ do when (rqst == 0) (putStrLn "Starting downloads...\n")
246+ return (DState total cached (rqst + 1) rcvd failed built broken)
247+
248+ DReceived pkg vsn ->
249+ do putDownload goodMark pkg vsn
250+ putTransition (DState total cached rqst (rcvd + 1) failed built broken)
251+
252+ DFailed pkg vsn ->
253+ do putDownload badMark pkg vsn
254+ putTransition (DState total cached rqst rcvd (failed + 1) built broken)
255+
256+ DBuilt ->
257+ putBuilt (DState total cached rqst rcvd failed (built + 1) broken)
258+
259+ DBroken ->
260+ putBuilt (DState total cached rqst rcvd failed built (broken + 1))
261+
262+
263+putDownload :: D.Doc -> Pkg.Name -> V.Version -> IO ()
264+putDownload mark pkg vsn =
265+ Help.toStdout $ D.indent 2 $
266+ mark
267+ <+> D.fromPackage pkg
268+ <+> D.fromVersion vsn
269+ <> "\n"
270+
271+
272+putTransition :: DState -> IO DState
273+putTransition state@(DState total cached _ rcvd failed built broken) =
274+ if cached + rcvd + failed < total then
275+ return state
276+
277+ else
278+ do let char = if rcvd + failed == 0 then '\r' else '\n'
279+ putStrFlush (char : toBuildProgress (built + broken + failed) total)
280+ return state
281+
282+
283+putBuilt :: DState -> IO DState
284+putBuilt state@(DState total cached _ rcvd failed built broken) =
285+ do when (total == cached + rcvd + failed) $
286+ putStrFlush $ '\r' : toBuildProgress (built + broken + failed) total
287+ return state
288+
289+
290+toBuildProgress :: Int -> Int -> [Char]
291+toBuildProgress built total =
292+ "Verifying dependencies (" ++ show built ++ "/" ++ show total ++ ")"
293+
294+
295+clear :: [Char] -> [Char] -> [Char]
296+clear before after =
297+ '\r' : replicate (length before) ' ' ++ '\r' : after
298+
299+
300+
301+-- BUILD
302+
303+
304+type BKey = Key BMsg
305+
306+type BResult a = Either Exit.BuildProblem a
307+
308+
309+trackBuild :: Style -> (BKey -> IO (BResult a)) -> IO (BResult a)
310+trackBuild style callback =
311+ case style of
312+ Silent ->
313+ callback (Key (\_ -> return ()))
314+
315+ Json ->
316+ callback (Key (\_ -> return ()))
317+
318+ Terminal mvar ->
319+ do chan <- newChan
320+
321+ _ <- forkIO $
322+ do takeMVar mvar
323+ putStrFlush "Compiling ..."
324+ buildLoop chan 0
325+ putMVar mvar ()
326+
327+ result <- callback (Key (writeChan chan . Left))
328+ writeChan chan (Right result)
329+ return result
330+
331+
332+data BMsg
333+ = BDone
334+
335+
336+buildLoop :: Chan (Either BMsg (BResult a)) -> Int -> IO ()
337+buildLoop chan done =
338+ do msg <- readChan chan
339+ case msg of
340+ Left BDone ->
341+ do let !done1 = done + 1
342+ putStrFlush $ "\rCompiling (" ++ show done1 ++ ")"
343+ buildLoop chan done1
344+
345+ Right result ->
346+ let
347+ !message = toFinalMessage done result
348+ !width = 12 + length (show done)
349+ in
350+ putStrLn $
351+ if length message < width
352+ then '\r' : replicate width ' ' ++ '\r' : message
353+ else '\r' : message
354+
355+
356+toFinalMessage :: Int -> BResult a -> [Char]
357+toFinalMessage done result =
358+ case result of
359+ Right _ ->
360+ case done of
361+ 0 -> "Success!"
362+ 1 -> "Success! Compiled 1 module."
363+ n -> "Success! Compiled " ++ show n ++ " modules."
364+
365+ Left problem ->
366+ case problem of
367+ Exit.BuildBadModules _ _ [] ->
368+ "Detected problems in 1 module."
369+
370+ Exit.BuildBadModules _ _ (_:ps) ->
371+ "Detected problems in " ++ show (2 + length ps) ++ " modules."
372+
373+ Exit.BuildProjectProblem _ ->
374+ "Detected a problem."
375+
376+
377+
378+-- GENERATE
379+
380+
381+reportGenerate :: Style -> NE.List ModuleName.Raw -> FilePath -> IO ()
382+reportGenerate style names output =
383+ case style of
384+ Silent ->
385+ return ()
386+
387+ Json ->
388+ return ()
389+
390+ Terminal mvar ->
391+ do readMVar mvar
392+ let cnames = fmap ModuleName.toChars names
393+ putStrLn ('\n' : toGenDiagram cnames output)
394+
395+
396+toGenDiagram :: NE.List [Char] -> FilePath -> [Char]
397+toGenDiagram (NE.List name names) output =
398+ let
399+ width = 3 + foldr (max . length) (length name) names
400+ in
401+ case names of
402+ [] ->
403+ toGenLine width name ('>' : ' ' : output ++ "\n")
404+
405+ _:_ ->
406+ unlines $
407+ toGenLine width name (vtop : hbar : hbar : '>' : ' ' : output)
408+ : reverse (zipWith (toGenLine width) (reverse names) ([vbottom] : repeat [vmiddle]))
409+
410+
411+toGenLine :: Int -> [Char] -> [Char] -> [Char]
412+toGenLine width name end =
413+ " " ++ name ++ ' ' : replicate (width - length name) hbar ++ end
414+
415+
416+hbar :: Char
417+hbar = if isWindows then '-' else '─'
418+
419+vtop :: Char
420+vtop = if isWindows then '+' else '┬'
421+
422+vmiddle :: Char
423+vmiddle = if isWindows then '+' else '┤'
424+
425+vbottom :: Char
426+vbottom = if isWindows then '+' else '┘'
427+
428+
429+--
430+
431+
432+putStrFlush :: String -> IO ()
433+putStrFlush str =
434+ hPutStr stdout str >> hFlush stdout
435+
436+
437+
438+-- REPORT EXCEPTIONS NICELY
439+
440+
441+reportExceptionsNicely :: SomeException -> IO a
442+reportExceptionsNicely e =
443+ case fromException e of
444+ Just UserInterrupt -> throw e
445+ _ -> putException e >> throw e
446+
447+
448+putException :: SomeException -> IO ()
449+putException e = do
450+ hPutStrLn stderr ""
451+ Help.toStderr $ D.stack $
452+ [ D.dullyellow "-- ERROR -----------------------------------------------------------------------"
453+ , D.reflow $
454+ "I ran into something that bypassed the normal error reporting process!\
455+ \ I extracted whatever information I could from the internal error:"
456+ , D.vcat $ map (\line -> D.red ">" <> " " <> D.fromChars line) (lines (show e))
457+ , D.reflow $
458+ "These errors are usually pretty confusing, so start by asking around on one of\
459+ \ forums listed at https://elm-lang.org/community to see if anyone can get you\
460+ \ unstuck quickly."
461+ , D.dullyellow "-- REQUEST ---------------------------------------------------------------------"
462+ , D.reflow $
463+ "If you are feeling up to it, please try to get your code down to the smallest\
464+ \ version that still triggers this message. Ideally in a single Main.elm and\
465+ \ elm.json file."
466+ , D.reflow $
467+ "From there open a NEW issue at https://github.com/elm/compiler/issues with\
468+ \ your reduced example pasted in directly. (Not a link to a repo or gist!) Do not\
469+ \ worry about if someone else saw something similar. More examples is better!"
470+ , D.reflow $
471+ "This kind of error is usually tied up in larger architectural choices that are\
472+ \ hard to change, so even when we have a couple good examples, it can take some\
473+ \ time to resolve in a solid way."
474+ ]
builder/src/Reporting/Exit.hs+2015−64
@@ -1,6 +1,27 @@
11{-# LANGUAGE OverloadedStrings #-}
22module Reporting.Exit
3− ( Exit(..)
3+ ( Init(..), initToReport
4+ , Diff(..), diffToReport
5+ , Make(..), makeToReport
6+ , Bump(..), bumpToReport
7+ , Repl(..), replToReport
8+ , Publish(..), publishToReport
9+ , Install(..), installToReport
10+ , Reactor(..), reactorToReport
11+ , newPackageOverview
12+ --
13+ , Solver(..)
14+ , Outline(..)
15+ , OutlineProblem(..)
16+ , Details(..)
17+ , DetailsBadDep(..)
18+ , PackageProblem(..)
19+ , RegistryProblem(..)
20+ , BuildProblem(..)
21+ , BuildProjectProblem(..)
22+ , DocsProblem(..)
23+ , Generate(..)
24+ --
425 , toString
526 , toStderr
627 , toJson
@@ -8,66 +29,1579 @@ module Reporting.Exit
829 where
930
1031
32+import qualified Data.ByteString as BS
33+import qualified Data.ByteString.UTF8 as BS_UTF8
34+import qualified Data.List as List
35+import qualified Data.Map as Map
36+import qualified Data.Name as N
37+import qualified Data.NonEmptyList as NE
38+import qualified Network.HTTP.Client as HTTP
39+import qualified Network.HTTP.Types.Header as HTTP
40+import qualified Network.HTTP.Types.Status as HTTP
41+import qualified System.FilePath as FP
42+import System.FilePath ((</>), (<.>))
43+
44+import qualified Elm.Constraint as C
45+import qualified Elm.Magnitude as M
1146import qualified Elm.ModuleName as ModuleName
47+import qualified Elm.Package as Pkg
48+import qualified Elm.Version as V
49+import qualified File
50+import qualified Http
51+import qualified Json.Decode as Decode
1252import qualified Json.Encode as Encode
53+import qualified Json.String as Json
54+import Parse.Primitives (Row, Col)
55+import qualified Reporting.Annotation as A
56+import Reporting.Doc ((<>))
1357import qualified Reporting.Doc as D
14−import qualified Reporting.Exit.Assets as Asset
15−import qualified Reporting.Exit.Bump as Bump
16−import qualified Reporting.Exit.Compile as Compile
17−import qualified Reporting.Exit.Crawl as Crawl
18−import qualified Reporting.Exit.Deps as Deps
19−import qualified Reporting.Exit.Diff as Diff
58+import qualified Reporting.Error.Import as Import
59+import qualified Reporting.Error.Json as Json
2060import qualified Reporting.Exit.Help as Help
21−import qualified Reporting.Exit.Http as Http
22−import qualified Reporting.Exit.Make as Make
23−import qualified Reporting.Exit.Init as Init
24−import qualified Reporting.Exit.Install as Install
25−import qualified Reporting.Exit.Publish as Publish
61+import qualified Reporting.Error as Error
62+import qualified Reporting.Render.Code as Code
2663
2764
2865
29−-- ALL POSSIBLE ERRORS
66+-- RENDERERS
3067
3168
32−data Exit
33− = NoElmJson
34− | Assets Asset.Exit
35− | Bump Bump.Exit
36− | Compile Compile.Exit [Compile.Exit]
37− | Crawl Crawl.Exit
38− | Cycle [ModuleName.Raw] -- TODO write docs to help with this scenario
39− | Deps Deps.Exit
40− | Diff Diff.Exit
41− | Make Make.Exit
42− | Init Init.Exit
43− | Install Install.Exit
44− | Publish Publish.Exit
45− | BadHttp String Http.Exit
69+toString :: Help.Report -> String
70+toString report =
71+ Help.toString (Help.reportToDoc report)
4672
4773
74+toStderr :: Help.Report -> IO ()
75+toStderr report =
76+ Help.toStderr (Help.reportToDoc report)
4877
49−-- RENDERERS
5078
79+toJson :: Help.Report -> Encode.Value
80+toJson report =
81+ Help.reportToJson report
82+
83+
84+
85+-- INIT
86+
87+
88+data Init
89+ = InitNoSolution [Pkg.Name]
90+ | InitNoOfflineSolution [Pkg.Name]
91+ | InitSolverProblem Solver
92+ | InitAlreadyExists
93+ | InitRegistryProblem RegistryProblem
94+
95+
96+initToReport :: Init -> Help.Report
97+initToReport exit =
98+ case exit of
99+ InitNoSolution pkgs ->
100+ Help.report "NO SOLUTION" Nothing
101+ "I tried to create an elm.json with the following direct dependencies:"
102+ [ D.indent 4 $ D.vcat $
103+ map (D.dullyellow . D.fromChars . Pkg.toChars) pkgs
104+ , D.reflow $
105+ "I could not find compatible versions though! This should not happen, so please\
106+ \ ask around one of the community forums at https://elm-lang.org/community to learn\
107+ \ what is going on!"
108+ ]
109+
110+ InitNoOfflineSolution pkgs ->
111+ Help.report "NO OFFLINE SOLUTION" Nothing
112+ "I tried to create an elm.json with the following direct dependencies:"
113+ [ D.indent 4 $ D.vcat $
114+ map (D.dullyellow . D.fromChars . Pkg.toChars) pkgs
115+ , D.reflow $
116+ "I could not find compatible versions though, but that may be because I could not\
117+ \ connect to https://package.elm-lang.org to get the latest list of packages. Are\
118+ \ you able to connect to the internet? Please ask around one of the community\
119+ \ forums at https://elm-lang.org/community for help!"
120+ ]
121+
122+ InitSolverProblem solver ->
123+ toSolverReport solver
124+
125+ InitAlreadyExists ->
126+ Help.report "EXISTING PROJECT" Nothing
127+ "You already have an elm.json file, so there is nothing for me to initialize!"
128+ [ D.fillSep
129+ ["Maybe",D.green (D.fromChars (D.makeLink "init")),"can","help"
130+ ,"you","figure","out","what","to","do","next?"
131+ ]
132+ ]
133+
134+ InitRegistryProblem problem ->
135+ toRegistryProblemReport "PROBLEM LOADING PACKAGE LIST" problem $
136+ "I need the list of published packages before I can start initializing projects"
137+
138+
139+
140+-- DIFF
141+
142+
143+data Diff
144+ = DiffNoOutline
145+ | DiffBadOutline Outline
146+ | DiffApplication
147+ | DiffNoExposed
148+ | DiffUnpublished
149+ | DiffUnknownPackage Pkg.Name [Pkg.Name]
150+ | DiffUnknownVersion Pkg.Name V.Version [V.Version]
151+ | DiffDocsProblem V.Version DocsProblem
152+ | DiffMustHaveLatestRegistry RegistryProblem
153+ | DiffBadDetails Details
154+ | DiffBadBuild BuildProblem
155+
156+
157+diffToReport :: Diff -> Help.Report
158+diffToReport diff =
159+ case diff of
160+ DiffNoOutline ->
161+ Help.report "DIFF WHAT?" Nothing
162+ "I cannot find an elm.json so I am not sure what you want me to diff.\
163+ \ Normally you run `elm diff` from within a project!"
164+ [ D.reflow $ "If you are just curious to see a diff, try running this command:"
165+ , D.indent 4 $ D.green $ "elm diff elm/http 1.0.0 2.0.0"
166+ ]
167+
168+ DiffBadOutline outline ->
169+ toOutlineReport outline
170+
171+ DiffApplication ->
172+ Help.report "CANNOT DIFF APPLICATIONS" (Just "elm.json")
173+ "Your elm.json says this project is an application, but `elm diff` only works\
174+ \ with packages. That way there are previously published versions of the API to\
175+ \ diff against!"
176+ [ D.reflow $ "If you are just curious to see a diff, try running this command:"
177+ , D.indent 4 $ D.dullyellow $ "elm diff elm/json 1.0.0 1.1.2"
178+ ]
179+
180+ DiffNoExposed ->
181+ Help.report "NO EXPOSED MODULES" (Just "elm.json")
182+ "Your elm.json has no \"exposed-modules\" which means there is no public API at\
183+ \ all right now! What am I supposed to diff?"
184+ [ D.reflow $
185+ "Try adding some modules back to the \"exposed-modules\" field."
186+ ]
187+
188+ DiffUnpublished ->
189+ Help.report "UNPUBLISHED" Nothing
190+ "This package is not published yet. There is nothing to diff against!"
191+ []
192+
193+ DiffUnknownPackage pkg suggestions ->
194+ Help.report "UNKNOWN PACKAGE" Nothing
195+ ( "I cannot find a package called:"
196+ )
197+ [ D.indent 4 $ D.red $ D.fromChars $ Pkg.toChars pkg
198+ , "Maybe you want one of these instead?"
199+ , D.indent 4 $ D.dullyellow $ D.vcat $ map (D.fromChars . Pkg.toChars) suggestions
200+ , "But check <https://package.elm-lang.org> to see all possibilities!"
201+ ]
202+
203+ DiffUnknownVersion _pkg vsn realVersions ->
204+ Help.docReport "UNKNOWN VERSION" Nothing
205+ ( D.fillSep $
206+ [ "Version", D.red (D.fromVersion vsn)
207+ , "has", "never", "been", "published,", "so", "I"
208+ , "cannot", "diff", "against", "it."
209+ ]
210+ )
211+ [ "Here are all the versions that HAVE been published:"
212+ , D.indent 4 $ D.dullyellow $ D.vcat $
213+ let
214+ sameMajor v1 v2 = V._major v1 == V._major v2
215+ mkRow vsns = D.hsep $ map D.fromVersion vsns
216+ in
217+ map mkRow $ List.groupBy sameMajor (List.sort realVersions)
218+ , "Want one of those instead?"
219+ ]
220+
221+ DiffDocsProblem version problem ->
222+ toDocsProblemReport problem $
223+ "I need the docs for " ++ V.toChars version ++ " to compute this diff"
224+
225+ DiffMustHaveLatestRegistry problem ->
226+ toRegistryProblemReport "PROBLEM UPDATING PACKAGE LIST" problem $
227+ "I need the latest list of published packages before I do this diff"
228+
229+ DiffBadDetails details ->
230+ toDetailsReport details
231+
232+ DiffBadBuild buildProblem ->
233+ toBuildProblemReport buildProblem
234+
235+
236+
237+-- BUMP
238+
239+
240+data Bump
241+ = BumpNoOutline
242+ | BumpBadOutline Outline
243+ | BumpApplication
244+ | BumpUnexpectedVersion V.Version [V.Version]
245+ | BumpMustHaveLatestRegistry RegistryProblem
246+ | BumpCannotFindDocs Pkg.Name V.Version DocsProblem
247+ | BumpBadDetails Details
248+ | BumpNoExposed
249+ | BumpBadBuild BuildProblem
250+
251+
252+bumpToReport :: Bump -> Help.Report
253+bumpToReport bump =
254+ case bump of
255+ BumpNoOutline ->
256+ Help.report "BUMP WHAT?" Nothing
257+ "I cannot find an elm.json so I am not sure what you want me to bump."
258+ [ D.reflow $
259+ "Elm packages always have an elm.json that says current the version number. If\
260+ \ you run this command from a directory with an elm.json file, I will try to bump\
261+ \ the version in there based on the API changes."
262+ ]
263+
264+ BumpBadOutline outline ->
265+ toOutlineReport outline
266+
267+ BumpApplication ->
268+ Help.report "CANNOT BUMP APPLICATIONS" (Just "elm.json")
269+ "Your elm.json says this is an application. That means it cannot be published\
270+ \ on <https://package.elm-lang.org> and therefore has no version to bump!"
271+ []
272+
273+ BumpUnexpectedVersion vsn versions ->
274+ Help.docReport "CANNOT BUMP" (Just "elm.json")
275+ ( D.fillSep
276+ ["Your","elm.json","says","I","should","bump","relative","to","version"
277+ ,D.red (D.fromVersion vsn) <> ","
278+ ,"but","I","cannot","find","that","version","on","<https://package.elm-lang.org>."
279+ ,"That","means","there","is","no","API","for","me","to","diff","against","and"
280+ ,"figure","out","if","these","are","MAJOR,","MINOR,","or","PATCH","changes."
281+ ]
282+ )
283+ [ D.fillSep $
284+ ["Try","bumping","again","after","changing","the",D.dullyellow "\"version\"","in","elm.json"]
285+ ++ if length versions == 1 then ["to:"] else ["to","one","of","these:"]
286+ , D.vcat $ map (D.green . D.fromVersion) versions
287+ ]
288+
289+ BumpMustHaveLatestRegistry problem ->
290+ toRegistryProblemReport "PROBLEM UPDATING PACKAGE LIST" problem $
291+ "I need the latest list of published packages before I can bump any versions"
292+
293+ BumpCannotFindDocs _ version problem ->
294+ toDocsProblemReport problem $
295+ "I need the docs for " ++ V.toChars version ++ " to compute the next version number"
296+
297+ BumpBadDetails details ->
298+ toDetailsReport details
299+
300+ BumpNoExposed ->
301+ Help.docReport "NO EXPOSED MODULES" (Just "elm.json")
302+ ( D.fillSep $
303+ [ "To", "bump", "a", "package,", "the"
304+ , D.dullyellow "\"exposed-modules\"", "field", "of", "your"
305+ , "elm.json", "must", "list", "at", "least", "one", "module."
306+ ]
307+ )
308+ [ D.reflow $
309+ "Try adding some modules back to the \"exposed-modules\" field."
310+ ]
311+
312+ BumpBadBuild problem ->
313+ toBuildProblemReport problem
314+
315+
316+
317+-- OVERVIEW OF VERSIONING
318+
319+
320+newPackageOverview :: String
321+newPackageOverview =
322+ unlines
323+ [ "This package has never been published before. Here's how things work:"
324+ , ""
325+ , " - Versions all have exactly three parts: MAJOR.MINOR.PATCH"
326+ , ""
327+ , " - All packages start with initial version " ++ V.toChars V.one
328+ , ""
329+ , " - Versions are incremented based on how the API changes:"
330+ , ""
331+ , " PATCH = the API is the same, no risk of breaking code"
332+ , " MINOR = values have been added, existing values are unchanged"
333+ , " MAJOR = existing values have been changed or removed"
334+ , ""
335+ , " - I will bump versions for you, automatically enforcing these rules"
336+ , ""
337+ ]
338+
339+
340+
341+-- PUBLISH
342+
343+
344+data Publish
345+ = PublishNoOutline
346+ | PublishBadOutline Outline
347+ | PublishBadDetails Details
348+ | PublishMustHaveLatestRegistry RegistryProblem
349+ | PublishApplication
350+ | PublishNotInitialVersion V.Version
351+ | PublishAlreadyPublished V.Version
352+ | PublishInvalidBump V.Version V.Version
353+ | PublishBadBump V.Version V.Version M.Magnitude V.Version M.Magnitude
354+ | PublishNoSummary
355+ | PublishNoExposed
356+ | PublishNoReadme
357+ | PublishShortReadme
358+ | PublishNoLicense
359+ | PublishBuildProblem BuildProblem
360+ | PublishMissingTag V.Version
361+ | PublishCannotGetTag V.Version Http.Error
362+ | PublishCannotGetTagData V.Version String BS.ByteString
363+ | PublishCannotGetZip Http.Error
364+ | PublishCannotDecodeZip String
365+ | PublishCannotGetDocs V.Version V.Version DocsProblem
366+ | PublishCannotRegister Http.Error
367+ | PublishNoGit
368+ | PublishLocalChanges V.Version
369+ --
370+ | PublishZipBadDetails Details
371+ | PublishZipApplication
372+ | PublishZipNoExposed
373+ | PublishZipBuildProblem BuildProblem
374+
375+
376+publishToReport :: Publish -> Help.Report
377+publishToReport publish =
378+ case publish of
379+ PublishNoOutline ->
380+ Help.report "PUBLISH WHAT?" Nothing
381+ "I cannot find an elm.json so I am not sure what you want me to publish."
382+ [ D.reflow $
383+ "Elm packages always have an elm.json that states the version number,\
384+ \ dependencies, exposed modules, etc."
385+ ]
386+
387+ PublishBadOutline outline ->
388+ toOutlineReport outline
389+
390+ PublishBadDetails problem ->
391+ toDetailsReport problem
392+
393+ PublishMustHaveLatestRegistry problem ->
394+ toRegistryProblemReport "PROBLEM UPDATING PACKAGE LIST" problem $
395+ "I need the latest list of published packages to make sure this is safe to publish"
396+
397+ PublishApplication ->
398+ Help.report "UNPUBLISHABLE" Nothing "I cannot publish applications, only packages!" []
399+
400+ PublishNotInitialVersion vsn ->
401+ Help.docReport "INVALID VERSION" Nothing
402+ ( D.fillSep
403+ ["I","cannot","publish"
404+ ,D.red (D.fromVersion vsn)
405+ ,"as","the","initial","version."
406+ ]
407+ )
408+ [ D.fillSep
409+ ["Change","it","to",D.green "1.0.0","which","is"
410+ ,"the","initial","version","for","all","Elm","packages."
411+ ]
412+ ]
413+
414+ PublishAlreadyPublished vsn ->
415+ Help.docReport "ALREADY PUBLISHED" Nothing
416+ ( D.vcat
417+ [ D.fillSep
418+ [ "Version", D.green (D.fromVersion vsn)
419+ , "has", "already", "been", "published.", "You", "cannot"
420+ , "publish", "it", "again!"
421+ ]
422+ , "Try using the `bump` command:"
423+ ]
424+ )
425+ [ D.dullyellow $ D.indent 4 "elm bump"
426+ , D.reflow $
427+ "It computes the version number based on API changes, ensuring\
428+ \ that no breaking changes end up in PATCH releases!"
429+ ]
430+
431+ PublishInvalidBump statedVersion latestVersion ->
432+ Help.docReport "INVALID VERSION" (Just "elm.json")
433+ ( D.fillSep $
434+ ["Your","elm.json","says","the","next","version","should","be"
435+ ,D.red (D.fromVersion statedVersion) <> ","
436+ ,"but","that","is","not","valid","based","on","the","previously"
437+ ,"published","versions."
438+ ]
439+ )
440+ [ D.fillSep $
441+ ["Change","the","version","back","to"
442+ ,D.green (D.fromVersion latestVersion)
443+ ,"which","is","the","most","recently","published","version."
444+ ,"From","there,","have","Elm","bump","the","version","by","running:"
445+ ]
446+ , D.indent 4 $ D.green "elm bump"
447+ , D.reflow $
448+ "If you want more insight on the API changes Elm detects, you\
449+ \ can run `elm diff` at this point as well."
450+ ]
451+
452+ PublishBadBump old new magnitude realNew realMagnitude ->
453+ Help.docReport "INVALID VERSION" (Just "elm.json")
454+ (
455+ D.fillSep $
456+ ["Your","elm.json","says","the","next","version","should","be"
457+ ,D.red (D.fromVersion new) <> ","
458+ ,"indicating","a",D.fromChars (M.toChars magnitude)
459+ ,"change","to","the","public","API."
460+ ,"This","does","not","match","the","API","diff","given","by:"
461+ ]
462+ )
463+ [ D.indent 4 $ D.fromChars $
464+ "elm diff " ++ V.toChars old
465+
466+ , D.fillSep $
467+ ["This","command","says","this","is","a"
468+ ,D.fromChars (M.toChars realMagnitude)
469+ ,"change,","so","the","next","version","should","be"
470+ ,D.green (D.fromVersion realNew) <> "."
471+ ,"Double","check","everything","to","make","sure","you"
472+ ,"are","publishing","what","you","want!"
473+ ]
474+ , D.reflow $
475+ "Also, next time use `elm bump` and I'll figure all this out for you!"
476+ ]
477+
478+ PublishNoSummary ->
479+ Help.docReport "NO SUMMARY" (Just "elm.json")
480+ ( D.fillSep $
481+ [ "To", "publish", "a", "package,", "your", "elm.json", "must"
482+ , "have", "a", D.dullyellow "\"summary\"", "field", "that", "gives"
483+ , "a", "consice", "overview", "of", "your", "project."
484+ ]
485+ )
486+ [ D.reflow $
487+ "The summary must be less than 80 characters. It should describe\
488+ \ the concrete use of your package as clearly and as plainly as possible."
489+ ]
490+
491+ PublishNoExposed ->
492+ Help.docReport "NO EXPOSED MODULES" (Just "elm.json")
493+ ( D.fillSep $
494+ [ "To", "publish", "a", "package,", "the"
495+ , D.dullyellow "\"exposed-modules\"", "field", "of", "your"
496+ , "elm.json", "must", "list", "at", "least", "one", "module."
497+ ]
498+ )
499+ [ D.reflow $
500+ "Which modules do you want users of the package to have access to? Add their\
501+ \ names to the \"exposed-modules\" list."
502+ ]
503+
504+ PublishNoReadme ->
505+ toBadReadmeReport "NO README" $
506+ "Every published package must have a helpful README.md\
507+ \ file, but I do not see one in your project."
508+
509+ PublishShortReadme ->
510+ toBadReadmeReport "SHORT README" $
511+ "This README.md is too short. Having more details will help\
512+ \ people assess your package quickly and fairly."
513+
514+ PublishNoLicense ->
515+ Help.report "NO LICENSE FILE" (Just "LICENSE")
516+ "By publishing a package you are inviting the Elm community to build\
517+ \ upon your work. But without knowing your license, we have no idea if\
518+ \ that is legal!"
519+ [ D.reflow $
520+ "Once you pick an OSI approved license from <https://spdx.org/licenses/>,\
521+ \ you must share that choice in two places. First, the license\
522+ \ identifier must appear in your elm.json file. Second, the full\
523+ \ license text must appear in the root of your project in a file\
524+ \ named LICENSE. Add that file and you will be all set!"
525+ ]
526+
527+ PublishBuildProblem buildProblem ->
528+ toBuildProblemReport buildProblem
529+
530+ PublishMissingTag version ->
531+ let vsn = V.toChars version in
532+ Help.docReport "NO TAG" Nothing
533+ ( D.fillSep $
534+ [ "Packages", "must", "be", "tagged", "in", "git,", "but", "I"
535+ , "cannot", "find", "a", D.green (D.fromChars vsn), "tag."
536+ ]
537+ )
538+ [ D.vcat
539+ [ "These tags make it possible to find this specific version on GitHub."
540+ , "To tag the most recent commit and push it to GitHub, run this:"
541+ ]
542+ , D.indent 4 $ D.dullyellow $ D.vcat $ map D.fromChars $
543+ [ "git tag -a " ++ vsn ++ " -m \"new release\""
544+ , "git push origin " ++ vsn
545+ ]
546+ , "The -m flag is for a helpful message. Try to make it more informative!"
547+ ]
548+
549+ PublishCannotGetTag version httpError ->
550+ case httpError of
551+ Http.BadHttp _ (HTTP.StatusCodeException response _)
552+ | HTTP.statusCode (HTTP.responseStatus response) == 404 ->
553+ let vsn = V.toChars version in
554+ Help.report "NO TAG ON GITHUB" Nothing
555+ ("You have version " ++ vsn ++ " tagged locally, but not on GitHub.")
556+ [ D.reflow
557+ "Run the following command to make this tag available on GitHub:"
558+ , D.indent 4 $ D.dullyellow $ D.fromChars $
559+ "git push origin " ++ vsn
560+ , D.reflow
561+ "This will make it possible to find your code online based on the version number."
562+ ]
563+
564+ _ ->
565+ toHttpErrorReport "PROBLEM VERIFYING TAG" httpError
566+ "I need to check that the version tag is registered on GitHub"
567+
568+ PublishCannotGetTagData version url body ->
569+ Help.report "PROBLEM VERIFYING TAG" Nothing
570+ ("I need to check that version " ++ V.toChars version ++ " is tagged on GitHub, so I fetched:")
571+ [ D.indent 4 $ D.dullyellow $ D.fromChars url
572+ , D.reflow $
573+ "I got the data back, but it was not what I was expecting. The response\
574+ \ body contains " ++ show (BS.length body) ++ " bytes. Here is the "
575+ ++ if BS.length body <= 76 then "whole thing:" else "beginning:"
576+ , D.indent 4 $ D.dullyellow $ D.fromChars $
577+ if BS.length body <= 76
578+ then BS_UTF8.toString body
579+ else take 73 (BS_UTF8.toString body) ++ "..."
580+ , D.reflow $
581+ "Does this error keep showing up? Maybe there is something weird with your\
582+ \ internet connection. We have gotten reports that schools, businesses,\
583+ \ airports, etc. sometimes intercept requests and add things to the body\
584+ \ or change its contents entirely. Could that be the problem?"
585+ ]
586+
587+ PublishCannotGetZip httpError ->
588+ toHttpErrorReport "PROBLEM DOWNLOADING CODE" httpError $
589+ "I need to check that folks can download and build the source code when they\
590+ \ install this package"
591+
592+ PublishCannotDecodeZip url ->
593+ Help.report "PROBLEM DOWNLOADING CODE" Nothing
594+ "I need to check that folks can download and build the source code when they\
595+ \ install this package, so I downloaded the code from:"
596+ [ D.indent 4 $ D.dullyellow $ D.fromChars url
597+ , D.reflow $
598+ "I was unable to unzip the archive though. Maybe there is something weird with\
599+ \ your internet connection. We have gotten reports that schools, businesses,\
600+ \ airports, etc. sometimes intercept requests and add things to the body or\
601+ \ change its contents entirely. Could that be the problem?"
602+ ]
603+
604+ PublishCannotGetDocs old new docsProblem ->
605+ toDocsProblemReport docsProblem $
606+ "I need the docs for " ++ V.toChars old ++ " to verify that "
607+ ++ V.toChars new ++ " really does come next"
608+
609+ PublishCannotRegister httpError ->
610+ toHttpErrorReport "PROBLEM PUBLISHING PACKAGE" httpError $
611+ "I need to send information about your package to the package website"
612+
613+ PublishNoGit ->
614+ Help.report "NO GIT" Nothing
615+ "I searched your PATH environment variable for `git` and could not\
616+ \ find it. Is it available through your PATH?"
617+ [ D.reflow $
618+ "Who cares about this? Well, I currently use `git` to check if there\
619+ \ are any local changes in your code. Local changes are a good sign\
620+ \ that some important improvements have gotten mistagged, so this\
621+ \ check can be extremely helpful for package authors!"
622+ , D.toSimpleNote $
623+ "We plan to do this without the `git` binary in a future release."
624+ ]
625+
626+ PublishLocalChanges version ->
627+ let vsn = V.toChars version in
628+ Help.docReport "LOCAL CHANGES" Nothing
629+ ( D.fillSep $
630+ [ "The", "code", "tagged", "as", D.green (D.fromChars vsn), "in"
631+ , "git", "does", "not", "match", "the", "code", "in", "your"
632+ , "working", "directory.", "This", "means", "you", "have"
633+ , "commits", "or", "local", "changes", "that", "are", "not"
634+ , "going", "to", "be", "published!"
635+ ]
636+ )
637+ [ D.toSimpleNote $
638+ "If you are sure everything is in order, you can run `git checkout "
639+ ++ vsn ++ "` and publish your code from there."
640+ ]
641+
642+ PublishZipBadDetails _ ->
643+ badZipReport
644+
645+ PublishZipApplication ->
646+ badZipReport
647+
648+ PublishZipNoExposed ->
649+ badZipReport
650+
651+ PublishZipBuildProblem _ ->
652+ badZipReport
653+
654+
655+toBadReadmeReport :: String -> String -> Help.Report
656+toBadReadmeReport title summary =
657+ Help.report title (Just "README.md") summary
658+ [ D.reflow $
659+ "When people look at your README, they are wondering:"
660+ , D.vcat
661+ [ " - What does this package even do?"
662+ , " - Will it help me solve MY problems?"
663+ ]
664+ , D.reflow $
665+ "So I recommend starting your README with a small example of the\
666+ \ most common usage scenario. Show people what they can expect if\
667+ \ they learn more!"
668+ , D.toSimpleNote $
669+ "By publishing your package, you are inviting people to invest time in\
670+ \ understanding your work. Spending an hour on your README to communicate your\
671+ \ knowledge more clearly can save the community days or weeks of time in\
672+ \ aggregate, and saving time in aggregate is the whole point of publishing\
673+ \ packages! People really appreciate it, and it makes the whole ecosystem feel\
674+ \ nicer!"
675+ ]
676+
677+
678+badZipReport :: Help.Report
679+badZipReport =
680+ Help.report "PROBLEM VERIFYING PACKAGE" Nothing
681+ "Before publishing packages, I download the code from GitHub and try to build it\
682+ \ from scratch. That way I can be more confident that it will work for other\
683+ \ people too. But I am not able to build it!"
684+ [ D.reflow $
685+ "I was just able to build your local copy though. Is there some way the version\
686+ \ on GitHub could be different?"
687+ ]
688+
689+
690+
691+-- DOCS
692+
693+
694+data DocsProblem
695+ = DP_Http Http.Error
696+ | DP_Data String BS.ByteString
697+ | DP_Cache
698+
699+
700+toDocsProblemReport :: DocsProblem -> String -> Help.Report
701+toDocsProblemReport problem context =
702+ case problem of
703+ DP_Http httpError ->
704+ toHttpErrorReport "PROBLEM LOADING DOCS" httpError context
705+
706+ DP_Data url body ->
707+ Help.report "PROBLEM LOADING DOCS" Nothing (context ++ ", so I fetched:")
708+ [ D.indent 4 $ D.dullyellow $ D.fromChars url
709+ , D.reflow $
710+ "I got the data back, but it was not what I was expecting. The response\
711+ \ body contains " ++ show (BS.length body) ++ " bytes. Here is the "
712+ ++ if BS.length body <= 76 then "whole thing:" else "beginning:"
713+ , D.indent 4 $ D.dullyellow $ D.fromChars $
714+ if BS.length body <= 76
715+ then BS_UTF8.toString body
716+ else take 73 (BS_UTF8.toString body) ++ "..."
717+ , D.reflow $
718+ "Does this error keep showing up? Maybe there is something weird with your\
719+ \ internet connection. We have gotten reports that schools, businesses,\
720+ \ airports, etc. sometimes intercept requests and add things to the body\
721+ \ or change its contents entirely. Could that be the problem?"
722+ ]
723+
724+ DP_Cache ->
725+ Help.report "PROBLEM LOADING DOCS" Nothing (context ++ ", but the local copy seems to be corrupted.")
726+ [ D.reflow $
727+ "I deleted the cached version, so the next run should download a fresh copy of\
728+ \ the docs. Hopefully that will get you unstuck, but it will not resolve the root\
729+ \ problem if, for example, a 3rd party editor plugin is modifing cached files\
730+ \ for some reason."
731+ ]
51732
52−toString :: Exit -> String
53−toString exit =
54− Help.toString (Help.reportToDoc (toReport exit))
55733
56734
57−toStderr :: Exit -> IO ()
58−toStderr exit =
59− Help.toStderr (Help.reportToDoc (toReport exit))
735+-- INSTALL
60736
61737
62−toJson :: Exit -> Encode.Value
63−toJson exit =
64− Help.reportToJson (toReport exit)
738+data Install
739+ = InstallNoOutline
740+ | InstallBadOutline Outline
741+ | InstallBadRegistry RegistryProblem
742+ | InstallNoArgs FilePath
743+ | InstallNoOnlineAppSolution Pkg.Name
744+ | InstallNoOfflineAppSolution Pkg.Name
745+ | InstallNoOnlinePkgSolution Pkg.Name
746+ | InstallNoOfflinePkgSolution Pkg.Name
747+ | InstallHadSolverTrouble Solver
748+ | InstallUnknownPackageOnline Pkg.Name [Pkg.Name]
749+ | InstallUnknownPackageOffline Pkg.Name [Pkg.Name]
750+ | InstallBadDetails Details
65751
66752
67−toReport :: Exit -> Help.Report
68−toReport exit =
753+installToReport :: Install -> Help.Report
754+installToReport exit =
69755 case exit of
70− NoElmJson ->
756+ InstallNoOutline ->
757+ Help.report "NEW PROJECT?" Nothing
758+ "Are you trying to start a new project? Try this command instead:"
759+ [ D.indent 4 $ D.green "elm init"
760+ , D.reflow "It will help you get started!"
761+ ]
762+
763+ InstallBadOutline outline ->
764+ toOutlineReport outline
765+
766+ InstallBadRegistry problem ->
767+ toRegistryProblemReport "PROBLEM LOADING PACKAGE LIST" problem $
768+ "I need the list of published packages to figure out how to install things"
769+
770+ InstallNoArgs elmHome ->
771+ Help.report "INSTALL WHAT?" Nothing
772+ "I am expecting commands like:"
773+ [ D.green $ D.indent 4 $ D.vcat $
774+ [ "elm install elm/http"
775+ , "elm install elm/json"
776+ , "elm install elm/random"
777+ ]
778+ , D.toFancyHint
779+ ["In","JavaScript","folks","run","`npm install`","to","start","projects."
780+ ,"\"Gotta","download","everything!\"","But","why","download","packages"
781+ ,"again","and","again?","Instead,","Elm","caches","packages","in"
782+ ,D.dullyellow (D.fromChars elmHome)
783+ ,"so","each","one","is","downloaded","and","built","ONCE","on","your","machine."
784+ ,"Elm","projects","check","that","cache","before","trying","the","internet."
785+ ,"This","reduces","build","times,","reduces","server","costs,","and","makes","it"
786+ ,"easier","to","work","offline.","As","a","result"
787+ ,D.dullcyan "elm install","is","only","for","adding","dependencies","to","elm.json,"
788+ ,"whereas",D.dullcyan "elm make","is","in","charge","of","gathering","dependencies"
789+ ,"and","building","everything.","So","maybe","try",D.green "elm make","instead?"
790+ ]
791+ ]
792+
793+ InstallNoOnlineAppSolution pkg ->
794+ Help.report "CANNOT FIND COMPATIBLE VERSION" (Just "elm.json")
795+ (
796+ "I cannot find a version of " ++ Pkg.toChars pkg ++ " that is compatible\
797+ \ with your existing dependencies."
798+ )
799+ [ D.reflow $
800+ "I checked all the published versions. When that failed, I tried to find any\
801+ \ compatible combination of these packages, even if it meant changing all your\
802+ \ existing dependencies! That did not work either!"
803+ , D.reflow $
804+ "This is most likely to happen when a package is not upgraded yet. Maybe a new\
805+ \ version of Elm came out recently? Maybe a common package was changed recently?\
806+ \ Maybe a better package came along, so there was no need to upgrade this one?\
807+ \ Try asking around https://elm-lang.org/community to learn what might be going on\
808+ \ with this package."
809+ , D.toSimpleNote $
810+ "Whatever the case, please be kind to the relevant package authors! Having\
811+ \ friendly interactions with users is great motivation, and conversely, getting\
812+ \ berated by strangers on the internet sucks your soul dry. Furthermore, package\
813+ \ authors are humans with families, friends, jobs, vacations, responsibilities,\
814+ \ goals, etc. They face obstacles outside of their technical work you will never\
815+ \ know about, so please assume the best and try to be patient and supportive!"
816+ ]
817+
818+ InstallNoOfflineAppSolution pkg ->
819+ Help.report "CANNOT FIND COMPATIBLE VERSION LOCALLY" (Just "elm.json")
820+ (
821+ "I cannot find a version of " ++ Pkg.toChars pkg ++ " that is compatible\
822+ \ with your existing dependencies."
823+ )
824+ [ D.reflow $
825+ "I was not able to connect to https://package.elm-lang.org/ though, so I was only\
826+ \ able to look through packages that you have downloaded in the past."
827+ , D.reflow $
828+ "Try again later when you have internet!"
829+ ]
830+
831+ InstallNoOnlinePkgSolution pkg ->
832+ Help.report "CANNOT FIND COMPATIBLE VERSION" (Just "elm.json")
833+ (
834+ "I cannot find a version of " ++ Pkg.toChars pkg ++ " that is compatible\
835+ \ with your existing constraints."
836+ )
837+ [ D.reflow $
838+ "With applications, I try to broaden the constraints to see if anything works,\
839+ \ but messing with package constraints is much more delicate business. E.g. making\
840+ \ your constraints stricter may make it harder for applications to find compatible\
841+ \ dependencies. So fixing something here may break it for a lot of other people!"
842+ , D.reflow $
843+ "So I recommend making an application with the same dependencies as your package.\
844+ \ See if there is a solution at all. From there it may be easier to figure out\
845+ \ how to proceed in a way that will disrupt your users as little as possible. And\
846+ \ the solution may be to help other package authors to get their packages updated,\
847+ \ or to drop a dependency entirely."
848+ ]
849+
850+ InstallNoOfflinePkgSolution pkg ->
851+ Help.report "CANNOT FIND COMPATIBLE VERSION LOCALLY" (Just "elm.json")
852+ (
853+ "I cannot find a version of " ++ Pkg.toChars pkg ++ " that is compatible\
854+ \ with your existing constraints."
855+ )
856+ [ D.reflow $
857+ "I was not able to connect to https://package.elm-lang.org/ though, so I was only\
858+ \ able to look through packages that you have downloaded in the past."
859+ , D.reflow $
860+ "Try again later when you have internet!"
861+ ]
862+
863+ InstallHadSolverTrouble solver ->
864+ toSolverReport solver
865+
866+ InstallUnknownPackageOnline pkg suggestions ->
867+ Help.docReport "UNKNOWN PACKAGE" Nothing
868+ (
869+ D.fillSep
870+ ["I","cannot","find","a","package","named",D.red (D.fromPackage pkg) <> "."]
871+ )
872+ [ D.reflow $
873+ "I looked through https://package.elm-lang.org for packages with similar names\
874+ \ and found these:"
875+ , D.indent 4 $ D.dullyellow $ D.vcat $ map D.fromPackage suggestions
876+ , D.reflow $ "Maybe you want one of these instead?"
877+ ]
878+
879+ InstallUnknownPackageOffline pkg suggestions ->
880+ Help.docReport "UNKNOWN PACKAGE" Nothing
881+ (
882+ D.fillSep
883+ ["I","cannot","find","a","package","named",D.red (D.fromPackage pkg) <> "."]
884+ )
885+ [ D.reflow $
886+ "I could not connect to https://package.elm-lang.org though, so new packages may\
887+ \ have been published since I last updated my local cache of package names."
888+ , D.reflow $
889+ "Looking through the locally cached names, the closest ones are:"
890+ , D.indent 4 $ D.dullyellow $ D.vcat $ map D.fromPackage suggestions
891+ , D.reflow $ "Maybe you want one of these instead?"
892+ ]
893+
894+ InstallBadDetails details ->
895+ toDetailsReport details
896+
897+
898+
899+-- SOLVER
900+
901+
902+data Solver
903+ = SolverBadCacheData Pkg.Name V.Version
904+ | SolverBadHttpData Pkg.Name V.Version String
905+ | SolverBadHttp Pkg.Name V.Version Http.Error
906+
907+
908+toSolverReport :: Solver -> Help.Report
909+toSolverReport problem =
910+ case problem of
911+ SolverBadCacheData pkg vsn ->
912+ Help.report "PROBLEM SOLVING PACKAGE CONSTRAINTS" Nothing
913+ (
914+ "I need the elm.json of " ++ Pkg.toChars pkg ++ " " ++ V.toChars vsn ++ " to\
915+ \ help me search for a set of compatible packages. I had it cached locally, but\
916+ \ it looks like the file was corrupted!"
917+ )
918+ [ D.reflow $
919+ "I deleted the cached version, so the next run should download a fresh copy.\
920+ \ Hopefully that will get you unstuck, but it will not resolve the root\
921+ \ problem if a 3rd party tool is modifing cached files for some reason."
922+ ]
923+
924+ SolverBadHttpData pkg vsn url ->
925+ Help.report "PROBLEM SOLVING PACKAGE CONSTRAINTS" Nothing
926+ (
927+ "I need the elm.json of " ++ Pkg.toChars pkg ++ " " ++ V.toChars vsn ++ " to\
928+ \ help me search for a set of compatible packages, but I ran into corrupted\
929+ \ information from:"
930+ )
931+ [ D.indent 4 $ D.dullyellow $ D.fromChars url
932+ , D.reflow $
933+ "Is something weird with your internet connection. We have gotten reports that\
934+ \ schools, businesses, airports, etc. sometimes intercept requests and add things\
935+ \ to the body or change its contents entirely. Could that be the problem?"
936+ ]
937+
938+ SolverBadHttp pkg vsn httpError ->
939+ toHttpErrorReport "PROBLEM SOLVING PACKAGE CONSTRAINTS" httpError $
940+ "I need the elm.json of " ++ Pkg.toChars pkg ++ " " ++ V.toChars vsn
941+ ++ " to help me search for a set of compatible packages"
942+
943+
944+
945+-- OUTLINE
946+
947+
948+data Outline
949+ = OutlineHasBadStructure (Decode.Error OutlineProblem)
950+ | OutlineHasMissingSrcDirs FilePath [FilePath]
951+ | OutlineHasDuplicateSrcDirs FilePath FilePath FilePath
952+ | OutlineNoPkgCore
953+ | OutlineNoAppCore
954+ | OutlineNoAppJson
955+
956+
957+data OutlineProblem
958+ = OP_BadType
959+ | OP_BadPkgName Row Col
960+ | OP_BadVersion Row Col
961+ | OP_BadConstraint C.Error
962+ | OP_BadModuleName Row Col
963+ | OP_BadModuleHeaderTooLong
964+ | OP_BadDependencyName Row Col
965+ | OP_BadLicense Json.String [Json.String]
966+ | OP_BadSummaryTooLong
967+ | OP_NoSrcDirs
968+
969+
970+toOutlineReport :: Outline -> Help.Report
971+toOutlineReport problem =
972+ case problem of
973+ OutlineHasBadStructure decodeError ->
974+ Json.toReport "elm.json" (Json.FailureToReport toOutlineProblemReport) decodeError $
975+ Json.ExplicitReason "I ran into a problem with your elm.json file."
976+
977+ OutlineHasMissingSrcDirs dir dirs ->
978+ case dirs of
979+ [] ->
980+ Help.report "MISSING SOURCE DIRECTORY" (Just "elm.json")
981+ "I need a valid elm.json file, but the \"source-directories\" field lists the following directory:"
982+ [ D.indent 4 $ D.red $ D.fromChars dir
983+ , D.reflow $
984+ "I cannot find it though. Is it missing? Is there a typo?"
985+ ]
986+
987+ _:_ ->
988+ Help.report "MISSING SOURCE DIRECTORIES" (Just "elm.json")
989+ "I need a valid elm.json file, but the \"source-directories\" field lists the following directories:"
990+ [ D.indent 4 $ D.vcat $
991+ map (D.red . D.fromChars) (dir:dirs)
992+ , D.reflow $
993+ "I cannot find them though. Are they missing? Are there typos?"
994+ ]
995+
996+ OutlineHasDuplicateSrcDirs canonicalDir dir1 dir2 ->
997+ if dir1 == dir2 then
998+ Help.report "REDUNDANT SOURCE DIRECTORIES" (Just "elm.json")
999+ "I need a valid elm.json file, but the \"source-directories\" field lists the same directory twice:"
1000+ [ D.indent 4 $ D.vcat $
1001+ map (D.red . D.fromChars) [dir1,dir2]
1002+ , D.reflow $
1003+ "Remove one of the entries!"
1004+ ]
1005+ else
1006+ Help.report "REDUNDANT SOURCE DIRECTORIES" (Just "elm.json")
1007+ "I need a valid elm.json file, but the \"source-directories\" field has some redundant directories:"
1008+ [ D.indent 4 $ D.vcat $
1009+ map (D.red . D.fromChars) [dir1,dir2]
1010+ , D.reflow $
1011+ "These are two different ways of refering to the same directory:"
1012+ , D.indent 4 $ D.dullyellow $ D.fromChars canonicalDir
1013+ , D.reflow $
1014+ "Remove one of the redundant entries from your \"source-directories\" field."
1015+ ]
1016+
1017+ OutlineNoPkgCore ->
1018+ Help.report "MISSING DEPENDENCY" (Just "elm.json")
1019+ "I need to see an \"elm/core\" dependency your elm.json file. The default imports\
1020+ \ of `List` and `Maybe` do not work without it."
1021+ [ D.reflow $
1022+ "If you modified your elm.json by hand, try to change it back! And if you are\
1023+ \ having trouble getting back to a working elm.json, it may be easier to find a\
1024+ \ working package and start fresh with their elm.json file."
1025+ ]
1026+
1027+ OutlineNoAppCore ->
1028+ Help.report "MISSING DEPENDENCY" (Just "elm.json")
1029+ "I need to see an \"elm/core\" dependency your elm.json file. The default imports\
1030+ \ of `List` and `Maybe` do not work without it."
1031+ [ D.reflow $
1032+ "If you modified your elm.json by hand, try to change it back! And if you are\
1033+ \ having trouble getting back to a working elm.json, it may be easier to delete it\
1034+ \ and use `elm init` to start fresh."
1035+ ]
1036+
1037+ OutlineNoAppJson ->
1038+ Help.report "MISSING DEPENDENCY" (Just "elm.json")
1039+ "I need to see an \"elm/json\" dependency your elm.json file. It helps me handle\
1040+ \ flags and ports."
1041+ [ D.reflow $
1042+ "If you modified your elm.json by hand, try to change it back! And if you are\
1043+ \ having trouble getting back to a working elm.json, it may be easier to delete it\
1044+ \ and use `elm init` to start fresh."
1045+ ]
1046+
1047+
1048+toOutlineProblemReport :: FilePath -> Code.Source -> Json.Context -> A.Region -> OutlineProblem -> Help.Report
1049+toOutlineProblemReport path source _ region problem =
1050+ let
1051+ toHighlight row col =
1052+ Just $ A.Region (A.Position row col) (A.Position row col)
1053+
1054+ toSnippet title highlight pair =
1055+ Help.jsonReport title (Just path) $
1056+ Code.toSnippet source region highlight pair
1057+ in
1058+ case problem of
1059+ OP_BadType ->
1060+ toSnippet "UNEXPECTED TYPE" Nothing
1061+ ( D.reflow $
1062+ "I got stuck while reading your elm.json file. I cannot handle a \"type\" like this:"
1063+ , D.fillSep
1064+ ["Try","changing","the","\"type\"","to"
1065+ ,D.green "\"application\"","or",D.green "\"package\"","instead."
1066+ ]
1067+ )
1068+
1069+ OP_BadPkgName row col ->
1070+ toSnippet "INVALID PACKAGE NAME" (toHighlight row col)
1071+ ( D.reflow $
1072+ "I got stuck while reading your elm.json file. I ran into trouble with the package name:"
1073+ , D.stack
1074+ [ D.fillSep
1075+ ["Package","names","are","always","written","as"
1076+ ,D.green "\"author/project\""
1077+ ,"so","I","am","expecting","to","see","something","like:"
1078+ ]
1079+ , D.dullyellow $ D.indent 4 $ D.vcat $
1080+ [ "\"mdgriffith/elm-ui\""
1081+ , "\"w0rm/elm-physics\""
1082+ , "\"Microsoft/elm-json-tree-view\""
1083+ , "\"FordLabs/elm-star-rating\""
1084+ , "\"1602/json-schema\""
1085+ ]
1086+ , D.reflow
1087+ "The author name should match your GitHub name exactly, and the project name\
1088+ \ needs to follow these rules:"
1089+ , D.indent 4 $ D.vcat $
1090+ [ "+--------------------------------------+-----------+-----------+"
1091+ , "| RULE | BAD | GOOD |"
1092+ , "+--------------------------------------+-----------+-----------+"
1093+ , "| only lower case, digits, and hyphens | elm-HTTP | elm-http |"
1094+ , "| no leading digits | 3D | elm-3d |"
1095+ , "| no non-ASCII characters | elm-bjørn | elm-bear |"
1096+ , "| no underscores | elm_ui | elm-ui |"
1097+ , "| no double hyphens | elm--hash | elm-hash |"
1098+ , "| no starting or ending hyphen | -elm-tar- | elm-tar |"
1099+ , "+--------------------------------------+-----------+-----------+"
1100+ ]
1101+ , D.toSimpleNote $
1102+ "These rules only apply to the project name, so you should never need\
1103+ \ to change your GitHub name!"
1104+ ]
1105+ )
1106+
1107+ OP_BadVersion row col ->
1108+ toSnippet "PROBLEM WITH VERSION" (toHighlight row col)
1109+ ( D.reflow $
1110+ "I got stuck while reading your elm.json file. I was expecting a version number here:"
1111+ , D.fillSep
1112+ ["I","need","something","like",D.green "\"1.0.0\"","or",D.green "\"2.0.4\""
1113+ ,"that","explicitly","states","all","three","numbers!"
1114+ ]
1115+ )
1116+
1117+ OP_BadConstraint constraintError ->
1118+ case constraintError of
1119+ C.BadFormat row col ->
1120+ toSnippet "PROBLEM WITH CONSTRAINT" (toHighlight row col)
1121+ ( D.reflow $
1122+ "I got stuck while reading your elm.json file. I do not understand this version constraint:"
1123+ , D.stack
1124+ [ D.fillSep
1125+ ["I","need","something","like",D.green "\"1.0.0 <= v < 2.0.0\""
1126+ ,"that","explicitly","lists","the","lower","and","upper","bounds."
1127+ ]
1128+ , D.toSimpleNote $
1129+ "The spaces in there are required! Taking them out will confuse me. Adding\
1130+ \ extra spaces confuses me too. I recommend starting with a valid example\
1131+ \ and just changing the version numbers."
1132+ ]
1133+ )
1134+
1135+ C.InvalidRange before after ->
1136+ if before == after then
1137+ toSnippet "PROBLEM WITH CONSTRAINT" Nothing
1138+ ( D.reflow $
1139+ "I got stuck while reading your elm.json file. I ran into an invalid version constraint:"
1140+ , D.fillSep
1141+ ["Elm","checks","that","all","package","APIs","follow","semantic","versioning,"
1142+ ,"so","it","is","best","to","use","wide","constraints.","I","recommend"
1143+ ,D.green $ "\"" <> D.fromVersion before <> " <= v < " <> D.fromVersion (V.bumpMajor after) <> "\""
1144+ ,"since","it","is","guaranteed","that","breaking","API","changes","cannot"
1145+ ,"happen","in","any","of","the","versions","in","that","range."
1146+ ]
1147+ )
1148+
1149+ else
1150+ toSnippet "PROBLEM WITH CONSTRAINT" Nothing
1151+ ( D.reflow $
1152+ "I got stuck while reading your elm.json file. I ran into an invalid version constraint:"
1153+ , D.fillSep
1154+ ["Maybe","you","want","something","like"
1155+ ,D.green $ "\"" <> D.fromVersion before <> " <= v < " <> D.fromVersion (V.bumpMajor before) <> "\""
1156+ ,"instead?","Elm","checks","that","all","package","APIs","follow","semantic"
1157+ ,"versioning,","so","it","is","guaranteed","that","breaking","API","changes"
1158+ ,"cannot","happen","in","any","of","the","versions","in","that","range."
1159+ ]
1160+ )
1161+
1162+ OP_BadModuleName row col ->
1163+ toSnippet "PROBLEM WITH MODULE NAME" (toHighlight row col)
1164+ ( D.reflow $
1165+ "I got stuck while reading your elm.json file. I was expecting a module name here:"
1166+ , D.fillSep
1167+ ["I","need","something","like",D.green "\"Html.Events\""
1168+ ,"or",D.green "\"Browser.Navigation\""
1169+ ,"where","each","segment","starts","with","a","capital"
1170+ ,"letter","and","the","segments","are","separated","by","dots."
1171+ ]
1172+ )
1173+
1174+ OP_BadModuleHeaderTooLong ->
1175+ toSnippet "HEADER TOO LONG" Nothing
1176+ ( D.reflow $
1177+ "I got stuck while reading your elm.json file. This section header is too long:"
1178+ , D.stack
1179+ [ D.fillSep
1180+ ["I","need","it","to","be"
1181+ ,D.green "under",D.green "20",D.green "bytes"
1182+ ,"so","it","renders","nicely","on","the","package","website!"
1183+ ]
1184+ , D.toSimpleNote
1185+ "I count the length in bytes, so using non-ASCII characters costs extra.\
1186+ \ Please report your case at https://github.com/elm/compiler/issues if this seems\
1187+ \ overly restrictive for your needs."
1188+ ]
1189+ )
1190+
1191+ OP_BadDependencyName row col ->
1192+ toSnippet "PROBLEM WITH DEPENDENCY NAME" (toHighlight row col)
1193+ ( D.reflow $
1194+ "I got stuck while reading your elm.json file. There is something wrong with this dependency name:"
1195+ , D.stack
1196+ [ D.fillSep
1197+ ["Package","names","always","include","the","name","of","the","author,"
1198+ ,"so","I","am","expecting","to","see","dependencies","like"
1199+ ,D.dullyellow "\"mdgriffith/elm-ui\"","and"
1200+ ,D.dullyellow "\"Microsoft/elm-json-tree-view\"" <> "."
1201+ ]
1202+ , D.fillSep $
1203+ ["I","generally","recommend","finding","the","package","you","want","on"
1204+ ,"the","package","website,","and","installing","it","with","the"
1205+ ,D.green "elm install","command!"
1206+ ]
1207+ ]
1208+ )
1209+
1210+ OP_BadLicense _ suggestions ->
1211+ toSnippet "UNKNOWN LICENSE" Nothing
1212+ ( D.reflow $
1213+ "I got stuck while reading your elm.json file. I do not know about this type of license:"
1214+ ,
1215+ D.stack
1216+ [ D.fillSep
1217+ ["Elm","packages","generally","use"
1218+ ,D.green "\"BSD-3-Clause\"","or",D.green "\"MIT\"" <> ","
1219+ ,"but","I","accept","any","OSI","approved","SPDX","license."
1220+ ,"Here","some","that","seem","close","to","what","you","wrote:"
1221+ ]
1222+ , D.indent 4 $ D.dullyellow $ D.vcat $ map (D.fromChars . Json.toChars) suggestions
1223+ , D.reflow $
1224+ "Check out https://spdx.org/licenses/ for the full list of options."
1225+ ]
1226+ )
1227+
1228+ OP_BadSummaryTooLong ->
1229+ toSnippet "SUMMARY TOO LONG" Nothing
1230+ ( D.reflow $
1231+ "I got stuck while reading your elm.json file. Your \"summary\" is too long:"
1232+ , D.stack
1233+ [ D.fillSep
1234+ ["I","need","it","to","be"
1235+ ,D.green "under",D.green "80",D.green "bytes"
1236+ ,"so","it","renders","nicely","on","the","package","website!"
1237+ ]
1238+ , D.toSimpleNote
1239+ "I count the length in bytes, so using non-ASCII characters costs extra.\
1240+ \ Please report your case at https://github.com/elm/compiler/issues if this seems\
1241+ \ overly restrictive for your needs."
1242+ ]
1243+ )
1244+
1245+ OP_NoSrcDirs ->
1246+ toSnippet "NO SOURCE DIRECTORIES" Nothing
1247+ ( D.reflow $
1248+ "I got stuck while reading your elm.json file. You do not have any \"source-directories\" listed here:"
1249+ , D.fillSep
1250+ ["I","need","something","like",D.green "[\"src\"]"
1251+ ,"so","I","know","where","to","look","for","your","modules!"
1252+ ]
1253+ )
1254+
1255+
1256+
1257+-- DETAILS
1258+
1259+
1260+data Details
1261+ = DetailsNoSolution
1262+ | DetailsNoOfflineSolution
1263+ | DetailsSolverProblem Solver
1264+ | DetailsBadElmInPkg C.Constraint
1265+ | DetailsBadElmInAppOutline V.Version
1266+ | DetailsHandEditedDependencies
1267+ | DetailsBadOutline Outline
1268+ | DetailsCannotGetRegistry RegistryProblem
1269+ | DetailsBadDeps FilePath [DetailsBadDep]
1270+
1271+
1272+data DetailsBadDep
1273+ = BD_BadDownload Pkg.Name V.Version PackageProblem
1274+ | BD_BadBuild Pkg.Name V.Version (Map.Map Pkg.Name V.Version)
1275+
1276+
1277+toDetailsReport :: Details -> Help.Report
1278+toDetailsReport details =
1279+ case details of
1280+ DetailsNoSolution ->
1281+ Help.report "INCOMPATIBLE DEPENDENCIES" (Just "elm.json")
1282+ "The dependencies in your elm.json are not compatible."
1283+ [ D.fillSep
1284+ ["Did","you","change","them","by","hand?","Try","to","change","it","back!"
1285+ ,"It","is","much","more","reliable","to","add","dependencies","with",D.green "elm install" <> "."
1286+ ]
1287+ , D.reflow $
1288+ "Please ask for help on the community forums if you try those paths and are still\
1289+ \ having problems!"
1290+ ]
1291+
1292+ DetailsNoOfflineSolution ->
1293+ Help.report "TROUBLE VERIFYING DEPENDENCIES" (Just "elm.json")
1294+ "I could not connect to https://package.elm-lang.org to get the latest list of\
1295+ \ packages, and I was unable to verify your dependencies with the information I\
1296+ \ have cached locally."
1297+ [ D.reflow $
1298+ "Are you able to connect to the internet? These dependencies may work once you\
1299+ \ get access to the registry!"
1300+ , D.toFancyNote
1301+ ["If","you","changed","your","dependencies","by","hand,","try","to","change","them","back!"
1302+ ,"It","is","much","more","reliable","to","add","dependencies","with",D.green "elm install" <> "."
1303+ ]
1304+ ]
1305+
1306+ DetailsSolverProblem solver ->
1307+ toSolverReport solver
1308+
1309+ DetailsBadElmInPkg constraint ->
1310+ Help.report "ELM VERSION MISMATCH" (Just "elm.json")
1311+ "Your elm.json says this package needs a version of Elm in this range:"
1312+ [ D.indent 4 $ D.dullyellow $ D.fromChars $ C.toChars constraint
1313+ , D.fillSep
1314+ [ "But", "you", "are", "using", "Elm"
1315+ , D.red (D.fromVersion V.compiler)
1316+ , "right", "now."
1317+ ]
1318+ ]
1319+
1320+ DetailsBadElmInAppOutline version ->
1321+ Help.report "ELM VERSION MISMATCH" (Just "elm.json")
1322+ "Your elm.json says this application needs a different version of Elm."
1323+ [ D.fillSep
1324+ [ "It", "requires"
1325+ , D.green (D.fromVersion version) <> ","
1326+ , "but", "you", "are", "using"
1327+ , D.red (D.fromVersion V.compiler)
1328+ , "right", "now."
1329+ ]
1330+ ]
1331+
1332+ DetailsHandEditedDependencies ->
1333+ Help.report "ERROR IN DEPENDENCIES" (Just "elm.json")
1334+ "It looks like the dependencies elm.json in were edited by hand (or by a 3rd\
1335+ \ party tool) leaving them in an invalid state."
1336+ [ D.fillSep
1337+ ["Try","to","change","them","back","to","what","they","were","before!"
1338+ ,"It","is","much","more","reliable","to","add","dependencies","with",D.green "elm install" <> "."
1339+ ]
1340+ , D.reflow $
1341+ "Please ask for help on the community forums if you try those paths and are still\
1342+ \ having problems!"
1343+ ]
1344+
1345+ DetailsBadOutline outline ->
1346+ toOutlineReport outline
1347+
1348+ DetailsCannotGetRegistry problem ->
1349+ toRegistryProblemReport "PROBLEM LOADING PACKAGE LIST" problem $
1350+ "I need the list of published packages to verify your dependencies"
1351+
1352+ DetailsBadDeps cacheDir deps ->
1353+ case List.sortOn toBadDepRank deps of
1354+ [] ->
1355+ Help.report "PROBLEM BUILDING DEPENDENCIES" Nothing
1356+ "I am not sure what is going wrong though."
1357+ [ D.reflow $
1358+ "I would try deleting the " ++ cacheDir ++ " and elm-stuff/ directories, then\
1359+ \ trying to build again. That will work if some cached files got corrupted\
1360+ \ somehow."
1361+ , D.reflow $
1362+ "If that does not work, go to https://elm-lang.org/community and ask for\
1363+ \ help. This is a weird case!"
1364+ ]
1365+
1366+ d:_ ->
1367+ case d of
1368+ BD_BadDownload pkg vsn packageProblem ->
1369+ toPackageProblemReport pkg vsn packageProblem
1370+
1371+ BD_BadBuild pkg vsn fingerprint ->
1372+ Help.report "PROBLEM BUILDING DEPENDENCIES" Nothing
1373+ "I ran into a compilation error when trying to build the following package:"
1374+ [ D.indent 4 $ D.red $ D.fromChars $ Pkg.toChars pkg ++ " " ++ V.toChars vsn
1375+ , D.reflow $
1376+ "This probably means it has package constraints that are too wide. It may be\
1377+ \ possible to tweak your elm.json to avoid the root problem as a stopgap. Head\
1378+ \ over to https://elm-lang.org/community to get help figuring out how to take\
1379+ \ this path!"
1380+ , D.toSimpleNote $
1381+ "To help with the root problem, please report this to the package author along\
1382+ \ with the following information:"
1383+ , D.indent 4 $ D.vcat $
1384+ map (\(p,v) -> D.fromChars $ Pkg.toChars p ++ " " ++ V.toChars v) $
1385+ Map.toList fingerprint
1386+ , D.reflow $
1387+ "If you want to help out even more, try building the package locally. That should\
1388+ \ give you much more specific information about why this package is failing to\
1389+ \ build, which will in turn make it easier for the package author to fix it!"
1390+ ]
1391+
1392+
1393+toBadDepRank :: DetailsBadDep -> Int -- lower is better
1394+toBadDepRank badDep =
1395+ case badDep of
1396+ BD_BadDownload _ _ _ -> 0
1397+ BD_BadBuild _ _ _ -> 1
1398+
1399+
1400+
1401+-- PACKAGE PROBLEM
1402+
1403+
1404+data PackageProblem
1405+ = PP_BadEndpointRequest Http.Error
1406+ | PP_BadEndpointContent String
1407+ | PP_BadArchiveRequest Http.Error
1408+ | PP_BadArchiveContent String
1409+ | PP_BadArchiveHash String String String
1410+
1411+
1412+toPackageProblemReport :: Pkg.Name -> V.Version -> PackageProblem -> Help.Report
1413+toPackageProblemReport pkg vsn problem =
1414+ let
1415+ thePackage =
1416+ Pkg.toChars pkg ++ " " ++ V.toChars vsn
1417+ in
1418+ case problem of
1419+ PP_BadEndpointRequest httpError ->
1420+ toHttpErrorReport "PROBLEM DOWNLOADING PACKAGE" httpError $
1421+ "I need to find the latest download link for " ++ thePackage
1422+
1423+ PP_BadEndpointContent url ->
1424+ Help.report "PROBLEM DOWNLOADING PACKAGE" Nothing
1425+ (
1426+ "I need to find the latest download link for " ++ thePackage ++ ", but I ran into corrupted information from:"
1427+ )
1428+ [ D.indent 4 $ D.dullyellow $ D.fromChars url
1429+ , D.reflow $
1430+ "Is something weird with your internet connection. We have gotten reports that\
1431+ \ schools, businesses, airports, etc. sometimes intercept requests and add things\
1432+ \ to the body or change its contents entirely. Could that be the problem?"
1433+ ]
1434+
1435+ PP_BadArchiveRequest httpError ->
1436+ toHttpErrorReport "PROBLEM DOWNLOADING PACKAGE" httpError $
1437+ "I was trying to download the source code for " ++ thePackage
1438+
1439+ PP_BadArchiveContent url ->
1440+ Help.report "PROBLEM DOWNLOADING PACKAGE" Nothing
1441+ (
1442+ "I downloaded the source code for " ++ thePackage ++ " from:"
1443+ )
1444+ [ D.indent 4 $ D.dullyellow $ D.fromChars url
1445+ , D.reflow $
1446+ "But I was unable to unzip the data. Maybe there is something weird with\
1447+ \ your internet connection. We have gotten reports that schools, businesses,\
1448+ \ airports, etc. sometimes intercept requests and add things to the body or\
1449+ \ change its contents entirely. Could that be the problem?"
1450+ ]
1451+
1452+ PP_BadArchiveHash url expectedHash actualHash ->
1453+ Help.report "CORRUPT PACKAGE DATA" Nothing
1454+ (
1455+ "I downloaded the source code for " ++ thePackage ++ " from:"
1456+ )
1457+ [ D.indent 4 $ D.dullyellow $ D.fromChars url
1458+ , D.reflow "But it looks like the hash of the archive has changed since publication:"
1459+ , D.vcat $ map D.fromChars $
1460+ [ " Expected: " ++ expectedHash
1461+ , " Actual: " ++ actualHash
1462+ ]
1463+ , D.reflow $
1464+ "This usually means that the package author moved the version\
1465+ \ tag, so report it to them and see if that is the issue. Folks\
1466+ \ on Elm slack can probably help as well."
1467+ ]
1468+
1469+
1470+
1471+-- REGISTRY PROBLEM
1472+
1473+
1474+data RegistryProblem
1475+ = RP_Http Http.Error
1476+ | RP_Data String BS.ByteString
1477+
1478+
1479+toRegistryProblemReport :: String -> RegistryProblem -> String -> Help.Report
1480+toRegistryProblemReport title problem context =
1481+ case problem of
1482+ RP_Http err ->
1483+ toHttpErrorReport title err context
1484+
1485+ RP_Data url body ->
1486+ Help.report title Nothing (context ++ ", so I fetched:")
1487+ [ D.indent 4 $ D.dullyellow $ D.fromChars url
1488+ , D.reflow $
1489+ "I got the data back, but it was not what I was expecting. The response\
1490+ \ body contains " ++ show (BS.length body) ++ " bytes. Here is the "
1491+ ++ if BS.length body <= 76 then "whole thing:" else "beginning:"
1492+ , D.indent 4 $ D.dullyellow $ D.fromChars $
1493+ if BS.length body <= 76
1494+ then BS_UTF8.toString body
1495+ else take 73 (BS_UTF8.toString body) ++ "..."
1496+ , D.reflow $
1497+ "Does this error keep showing up? Maybe there is something weird with your\
1498+ \ internet connection. We have gotten reports that schools, businesses,\
1499+ \ airports, etc. sometimes intercept requests and add things to the body\
1500+ \ or change its contents entirely. Could that be the problem?"
1501+ ]
1502+
1503+
1504+toHttpErrorReport :: String -> Http.Error -> String -> Help.Report
1505+toHttpErrorReport title err context =
1506+ let
1507+ toHttpReport intro url details =
1508+ Help.report title Nothing intro $
1509+ D.indent 4 (D.dullyellow (D.fromChars url)) : details
1510+ in
1511+ case err of
1512+ Http.BadUrl url reason ->
1513+ toHttpReport (context ++ ", so I wanted to fetch:") url
1514+ [ D.reflow $ "But my HTTP library is saying this is not a valid URL. It is saying:"
1515+ , D.indent 4 $ D.fromChars reason
1516+ , D.reflow $
1517+ "This may indicate that there is some problem in the compiler, so please open an\
1518+ \ issue at https://github.com/elm/compiler/issues listing your operating system, Elm\
1519+ \ version, the command you ran, the terminal output, and any additional information\
1520+ \ that might help others reproduce the error."
1521+ ]
1522+
1523+ Http.BadHttp url httpExceptionContent ->
1524+ case httpExceptionContent of
1525+ HTTP.StatusCodeException response body ->
1526+ let
1527+ (HTTP.Status code message) = HTTP.responseStatus response
1528+ in
1529+ toHttpReport (context ++ ", so I tried to fetch:") url
1530+ [ D.fillSep $
1531+ ["But","it","came","back","as",D.red (D.fromInt code)]
1532+ ++ map D.fromChars (words (BS_UTF8.toString message))
1533+ , D.indent 4 $ D.reflow $ BS_UTF8.toString body
1534+ , D.reflow $
1535+ "This may mean some online endpoint changed in an unexpected way, so if does not\
1536+ \ seem like something on your side is causing this (e.g. firewall) please report\
1537+ \ this to https://github.com/elm/compiler/issues with your operating system, Elm\
1538+ \ version, the command you ran, the terminal output, and any additional information\
1539+ \ that can help others reproduce the error!"
1540+ ]
1541+
1542+ HTTP.TooManyRedirects responses ->
1543+ toHttpReport (context ++ ", so I tried to fetch:") url
1544+ [ D.reflow $ "But I gave up after following these " ++ show (length responses) ++ " redirects:"
1545+ , D.indent 4 $ D.vcat $ map toRedirectDoc responses
1546+ , D.reflow $
1547+ "Is it possible that your internet connection intercepts certain requests? That\
1548+ \ sometimes causes problems for folks in schools, businesses, airports, hotels,\
1549+ \ and certain countries. Try asking for help locally or in a community forum!"
1550+ ]
1551+
1552+ otherException ->
1553+ toHttpReport (context ++ ", so I tried to fetch:") url
1554+ [ D.reflow $ "But my HTTP library is giving me the following error message:"
1555+ , D.indent 4 $ D.fromChars (show otherException)
1556+ , D.reflow $
1557+ "Are you somewhere with a slow internet connection? Or no internet?\
1558+ \ Does the link I am trying to fetch work in your browser? Maybe the\
1559+ \ site is down? Does your internet connection have a firewall that\
1560+ \ blocks certain domains? It is usually something like that!"
1561+ ]
1562+
1563+ Http.BadMystery url someException ->
1564+ toHttpReport (context ++ ", so I tried to fetch:") url
1565+ [ D.reflow $ "But I ran into something weird! I was able to extract this error message:"
1566+ , D.indent 4 $ D.fromChars (show someException)
1567+ , D.reflow $
1568+ "Is it possible that your internet connection intercepts certain requests? That\
1569+ \ sometimes causes problems for folks in schools, businesses, airports, hotels,\
1570+ \ and certain countries. Try asking for help locally or in a community forum!"
1571+ ]
1572+
1573+
1574+toRedirectDoc :: HTTP.Response body -> D.Doc
1575+toRedirectDoc response =
1576+ let
1577+ (HTTP.Status code message) = HTTP.responseStatus response
1578+ in
1579+ case List.lookup HTTP.hLocation (HTTP.responseHeaders response) of
1580+ Just loc -> D.red (D.fromInt code) <> " - " <> D.fromChars (BS_UTF8.toString loc)
1581+ Nothing -> D.red (D.fromInt code) <> " - " <> D.fromChars (BS_UTF8.toString message)
1582+
1583+
1584+
1585+-- MAKE
1586+
1587+
1588+data Make
1589+ = MakeNoOutline
1590+ | MakeCannotOptimizeAndDebug
1591+ | MakeBadDetails Details
1592+ | MakeAppNeedsFileNames
1593+ | MakePkgNeedsExposing
1594+ | MakeMultipleFilesIntoHtml
1595+ | MakeNoMain
1596+ | MakeNonMainFilesIntoJavaScript ModuleName.Raw [ModuleName.Raw]
1597+ | MakeCannotBuild BuildProblem
1598+ | MakeBadGenerate Generate
1599+
1600+
1601+makeToReport :: Make -> Help.Report
1602+makeToReport make =
1603+ case make of
1604+ MakeNoOutline ->
711605 Help.report "NO elm.json FILE" Nothing
721606 "It looks like you are starting a new Elm project. Very exciting! Try running:"
731607 [ D.indent 4 $ D.green $ "elm init"
@@ -75,44 +1609,461 @@ toReport exit =
751609 "It will help you get set up. It is really simple!"
761610 ]
771611
78− Assets assetExit ->
79− Asset.toReport assetExit
1612+ MakeCannotOptimizeAndDebug ->
1613+ Help.docReport "CLASHING FLAGS" Nothing
1614+ ( D.fillSep
1615+ ["I","cannot","compile","with",D.red "--optimize","and"
1616+ ,D.red "--debug","at","the","same","time."
1617+ ]
1618+ )
1619+ [ D.reflow
1620+ "I need to take away information to optimize things, and I need to\
1621+ \ add information to add the debugger. It is impossible to do both\
1622+ \ at once though! Pick just one of those flags and it should work!"
1623+ ]
1624+
1625+ MakeBadDetails detailsProblem ->
1626+ toDetailsReport detailsProblem
1627+
1628+ MakeAppNeedsFileNames ->
1629+ Help.report "NO INPUT" Nothing
1630+ "What should I make though? I need specific files like:"
1631+ [ D.vcat
1632+ [ D.indent 4 $ D.green "elm make src/Main.elm"
1633+ , D.indent 4 $ D.green "elm make src/This.elm src/That.elm"
1634+ ]
1635+ , D.reflow $
1636+ "I recommend reading through https://guide.elm-lang.org for guidance on what to\
1637+ \ actually put in those files!"
1638+ ]
1639+
1640+ MakePkgNeedsExposing ->
1641+ Help.report "NO INPUT" Nothing
1642+ "What should I make though? I need specific files like:"
1643+ [ D.vcat
1644+ [ D.indent 4 $ D.green "elm make src/Main.elm"
1645+ , D.indent 4 $ D.green "elm make src/This.elm src/That.elm"
1646+ ]
1647+ , D.reflow $
1648+ "You can also entries to the \"exposed-modules\" list in your elm.json file, and\
1649+ \ I will try to compile the relevant files."
1650+ ]
1651+
1652+ MakeMultipleFilesIntoHtml ->
1653+ Help.report "TOO MANY FILES" Nothing
1654+ (
1655+ "When producing an HTML file, I can only handle one file."
1656+ )
1657+ [ D.fillSep
1658+ ["Switch","to",D.dullyellow "--output=/dev/null","if","you","just","want"
1659+ ,"to","get","compile","errors.","This","skips","the","code","gen","phase,"
1660+ ,"so","it","can","be","a","bit","faster","than","other","options","sometimes."
1661+ ]
1662+ , D.fillSep
1663+ ["Switch","to",D.dullyellow "--output=elm.js","if","you","want","multiple"
1664+ ,"`main`","values","available","in","a","single","JavaScript","file.","Then"
1665+ ,"you","can","make","your","own","customized","HTML","file","that","embeds"
1666+ ,"multiple","Elm","nodes.","The","generated","JavaScript","also","shares"
1667+ ,"dependencies","between","modules,","so","it","should","be","smaller","than"
1668+ ,"compiling","each","module","separately."
1669+ ]
1670+ ]
1671+
1672+ MakeNoMain ->
1673+ Help.report "NO MAIN" Nothing
1674+ (
1675+ "When producing an HTML file, I require that the given file has a `main` value.\
1676+ \ That way I have something to show on screen!"
1677+ )
1678+ [ D.reflow $
1679+ "Try adding a `main` value to your file? Or if you just want to verify that this\
1680+ \ module compiles, switch to --output=/dev/null to skip the code gen phase\
1681+ \ altogether."
1682+ , D.toSimpleNote $
1683+ "Adding a `main` value can be as brief as adding something like this:"
1684+ , D.vcat
1685+ [ D.fillSep [D.cyan "import","Html"]
1686+ , ""
1687+ , D.fillSep [D.green "main","="]
1688+ , D.indent 2 $ D.fillSep [D.cyan "Html" <> ".text",D.dullyellow "\"Hello!\""]
1689+ ]
1690+ , D.reflow $
1691+ "From there I can create an HTML file that says \"Hello!\" on screen. I recommend\
1692+ \ looking through https://guide.elm-lang.org for more guidance on how to fill in\
1693+ \ the `main` value."
1694+ ]
1695+
1696+ MakeNonMainFilesIntoJavaScript m ms ->
1697+ case ms of
1698+ [] ->
1699+ Help.report "NO MAIN" Nothing
1700+ (
1701+ "When producing a JS file, I require that the given file has a `main` value. That\
1702+ \ way Elm." ++ ModuleName.toChars m ++ ".init() is definitely defined in the\
1703+ \ resulting file!"
1704+ )
1705+ [ D.reflow $
1706+ "Try adding a `main` value to your file? Or if you just want to verify that this\
1707+ \ module compiles, switch to --output=/dev/null to skip the code gen phase\
1708+ \ altogether."
1709+ , D.toSimpleNote $
1710+ "Adding a `main` value can be as brief as adding something like this:"
1711+ , D.vcat
1712+ [ D.fillSep [D.cyan "import","Html"]
1713+ , ""
1714+ , D.fillSep [D.green "main","="]
1715+ , D.indent 2 $ D.fillSep [D.cyan "Html" <> ".text",D.dullyellow "\"Hello!\""]
1716+ ]
1717+ , D.reflow $
1718+ "Or use https://package.elm-lang.org/packages/elm/core/latest/Platform#worker to\
1719+ \ make a `main` with no user interface."
1720+ ]
1721+
1722+ _:_ ->
1723+ Help.report "NO MAIN" Nothing
1724+ (
1725+ "When producing a JS file, I require that given files all have `main` values.\
1726+ \ That way functions like Elm." ++ ModuleName.toChars m ++ ".init() are\
1727+ \ definitely defined in the resulting file. I am missing `main` values in:"
1728+ )
1729+ [ D.indent 4 $ D.red $ D.vcat $ map D.fromName (m:ms)
1730+ , D.reflow $
1731+ "Try adding a `main` value to them? Or if you just want to verify that these\
1732+ \ modules compile, switch to --output=/dev/null to skip the code gen phase\
1733+ \ altogether."
1734+ , D.toSimpleNote $
1735+ "Adding a `main` value can be as brief as adding something like this:"
1736+ , D.vcat
1737+ [ D.fillSep [D.cyan "import","Html"]
1738+ , ""
1739+ , D.fillSep [D.green "main","="]
1740+ , D.indent 2 $ D.fillSep [D.cyan "Html" <> ".text",D.dullyellow "\"Hello!\""]
1741+ ]
1742+ , D.reflow $
1743+ "Or use https://package.elm-lang.org/packages/elm/core/latest/Platform#worker to\
1744+ \ make a `main` with no user interface."
1745+ ]
1746+
1747+ MakeCannotBuild buildProblem ->
1748+ toBuildProblemReport buildProblem
1749+
1750+ MakeBadGenerate generateProblem ->
1751+ toGenerateReport generateProblem
1752+
1753+
1754+
1755+-- BUILD PROBLEM
1756+
1757+
1758+data BuildProblem
1759+ = BuildBadModules FilePath Error.Module [Error.Module]
1760+ | BuildProjectProblem BuildProjectProblem
1761+
1762+
1763+data BuildProjectProblem
1764+ = BP_PathUnknown FilePath
1765+ | BP_WithBadExtension FilePath
1766+ | BP_WithAmbiguousSrcDir FilePath FilePath FilePath
1767+ | BP_MainPathDuplicate FilePath FilePath
1768+ | BP_RootNameDuplicate ModuleName.Raw FilePath FilePath
1769+ | BP_RootNameInvalid FilePath FilePath [String]
1770+ | BP_CannotLoadDependencies
1771+ | BP_Cycle ModuleName.Raw [ModuleName.Raw]
1772+ | BP_MissingExposed (NE.List (ModuleName.Raw, Import.Problem))
1773+
1774+
1775+toBuildProblemReport :: BuildProblem -> Help.Report
1776+toBuildProblemReport problem =
1777+ case problem of
1778+ BuildBadModules root e es ->
1779+ Help.compilerReport root e es
1780+
1781+ BuildProjectProblem projectProblem ->
1782+ toProjectProblemReport projectProblem
1783+
1784+
1785+toProjectProblemReport :: BuildProjectProblem -> Help.Report
1786+toProjectProblemReport projectProblem =
1787+ case projectProblem of
1788+ BP_PathUnknown path ->
1789+ Help.report "FILE NOT FOUND" Nothing
1790+ "I cannot find this file:"
1791+ [ D.indent 4 $ D.red $ D.fromChars path
1792+ , D.reflow $ "Is there a typo?"
1793+ , D.toSimpleNote $
1794+ "If you are just getting started, try working through the examples in the\
1795+ \ official guide https://guide.elm-lang.org to get an idea of the kinds of things\
1796+ \ that typically go in a src/Main.elm file."
1797+ ]
1798+
1799+ BP_WithBadExtension path ->
1800+ Help.report "UNEXPECTED FILE EXTENSION" Nothing
1801+ "I can only compile Elm files (with a .elm extension) but you want me to compile:"
1802+ [ D.indent 4 $ D.red $ D.fromChars path
1803+ , D.reflow $ "Is there a typo? Can the file extension be changed?"
1804+ ]
1805+
1806+ BP_WithAmbiguousSrcDir path srcDir1 srcDir2 ->
1807+ Help.report "CONFUSING FILE" Nothing
1808+ "I am getting confused when I try to compile this file:"
1809+ [ D.indent 4 $ D.red $ D.fromChars path
1810+ , D.reflow $
1811+ "I always check if files appear in any of the \"source-directories\" listed in\
1812+ \ your elm.json to see if there might be some cached information about them. That\
1813+ \ can help me compile faster! But in this case, it looks like this file may be in\
1814+ \ either of these directories:"
1815+ , D.indent 4 $ D.red $ D.vcat $ map D.fromChars [srcDir1,srcDir2]
1816+ , D.reflow $
1817+ "Try to make it so no source directory contains another source directory!"
1818+ ]
801819
81− Bump bumpExit ->
82− Bump.toReport bumpExit
1820+ BP_MainPathDuplicate path1 path2 ->
1821+ Help.report "CONFUSING FILES" Nothing
1822+ "You are telling me to compile these two files:"
1823+ [ D.indent 4 $ D.red $ D.vcat $ map D.fromChars [ path1, path2 ]
1824+ , D.reflow $
1825+ if path1 == path2 then
1826+ "Why are you telling me twice? Is something weird going on with a script?\
1827+ \ I figured I would let you know about it just in case something is wrong.\
1828+ \ Only list it once and you should be all set!"
1829+ else
1830+ "But seem to be the same file though... It makes me think something tricky is\
1831+ \ going on with symlinks in your project, so I figured I would let you know\
1832+ \ about it just in case. Remove one of these files from your command to get\
1833+ \ unstuck!"
1834+ ]
1835+
1836+ BP_RootNameDuplicate name outsidePath otherPath ->
1837+ Help.report "MODULE NAME CLASH" Nothing
1838+ "These two files are causing a module name clash:"
1839+ [ D.indent 4 $ D.red $ D.vcat $ map D.fromChars [ outsidePath, otherPath ]
1840+ , D.reflow $
1841+ "They both say `module " ++ ModuleName.toChars name ++ " exposing (..)` up\
1842+ \ at the top, but they cannot have the same name!"
1843+ , D.reflow $
1844+ "Try changing to a different module name in one of them!"
1845+ ]
831846
84− Compile e es ->
85− Help.compilerReport e es
1847+ BP_RootNameInvalid givenPath srcDir _ ->
1848+ Help.report "UNEXPECTED FILE NAME" Nothing
1849+ "I am having trouble with this file name:"
1850+ [ D.indent 4 $ D.red $ D.fromChars givenPath
1851+ , D.reflow $
1852+ "I found it in your " ++ FP.addTrailingPathSeparator srcDir ++ " directory\
1853+ \ which is good, but I expect all of the files in there to use the following\
1854+ \ module naming convention:"
1855+ , toModuleNameConventionTable srcDir [ "Main", "HomePage", "Http.Helpers" ]
1856+ , D.reflow $
1857+ "Notice that the names always start with capital letters! Can you make your file\
1858+ \ use this naming convention?"
1859+ , D.toSimpleNote $
1860+ "Having a strict naming convention like this makes it a lot easier to find\
1861+ \ things in large projects. If you see a module imported, you know where to look\
1862+ \ for the corresponding file every time!"
1863+ ]
861864
87− Crawl crawlExit ->
88− Crawl.toReport crawlExit
1865+ BP_CannotLoadDependencies ->
1866+ corruptCacheReport
891867
90− Cycle names ->
1868+ BP_Cycle name names ->
911869 Help.report "IMPORT CYCLE" Nothing
921870 "Your module imports form a cycle:"
93− [ D.cycle 4 names
1871+ [ D.cycle 4 name names
941872 , D.reflow $
951873 "Learn more about why this is disallowed and how to break cycles here:"
961874 ++ D.makeLink "import-cycles"
971875 ]
981876
99− Deps depsExit ->
100− Deps.toReport depsExit
1877+ BP_MissingExposed (NE.List (name, problem) _) ->
1878+ case problem of
1879+ Import.NotFound ->
1880+ Help.report "MISSING MODULE" (Just "elm.json")
1881+ "The \"exposed-modules\" of your elm.json lists the following module:"
1882+ [ D.indent 4 $ D.red $ D.fromName name
1883+ , D.reflow $
1884+ "But I cannot find it in your src/ directory. Is there a typo? Was it renamed?"
1885+ ]
1886+
1887+ Import.Ambiguous _ _ pkg _ ->
1888+ Help.report "AMBIGUOUS MODULE NAME" (Just "elm.json")
1889+ "The \"exposed-modules\" of your elm.json lists the following module:"
1890+ [ D.indent 4 $ D.red $ D.fromName name
1891+ , D.reflow $
1892+ "But a module from " ++ Pkg.toChars pkg ++ " already uses that name. Try\
1893+ \ choosing a different name for your local file."
1894+ ]
1895+
1896+ Import.AmbiguousLocal path1 path2 paths ->
1897+ Help.report "AMBIGUOUS MODULE NAME" (Just "elm.json")
1898+ "The \"exposed-modules\" of your elm.json lists the following module:"
1899+ [ D.indent 4 $ D.red $ D.fromName name
1900+ , D.reflow $
1901+ "But I found multiple files with that name:"
1902+ , D.dullyellow $ D.indent 4 $ D.vcat $
1903+ map D.fromChars (path1:path2:paths)
1904+ , D.reflow $
1905+ "Change the module names to be distinct!"
1906+ ]
1907+
1908+ Import.AmbiguousForeign _ _ _ ->
1909+ Help.report "MISSING MODULE" (Just "elm.json")
1910+ "The \"exposed-modules\" of your elm.json lists the following module:"
1911+ [ D.indent 4 $ D.red $ D.fromName name
1912+ , D.reflow $
1913+ "But I cannot find it in your src/ directory. Is there a typo? Was it renamed?"
1914+ , D.toSimpleNote $
1915+ "It is not possible to \"re-export\" modules from other packages. You can only\
1916+ \ expose modules that you define in your own code."
1917+ ]
1918+
1919+
1920+toModuleNameConventionTable :: FilePath -> [String] -> D.Doc
1921+toModuleNameConventionTable srcDir names =
1922+ let
1923+ toPair name =
1924+ ( name
1925+ , srcDir </> map (\c -> if c == '.' then FP.pathSeparator else c) name <.> "elm"
1926+ )
1927+
1928+ namePairs = map toPair names
1929+ nameWidth = maximum (11 : map (length . fst) namePairs)
1930+ pathWidth = maximum ( 9 : map (length . snd) namePairs)
1931+
1932+ padded width str =
1933+ str ++ replicate (width - length str) ' '
1934+
1935+ toRow (name, path) =
1936+ D.fromChars $
1937+ "| " ++ padded nameWidth name ++ " | " ++ padded pathWidth path ++ " |"
1938+
1939+ bar =
1940+ D.fromChars $
1941+ "+-" ++ replicate nameWidth '-' ++ "-+-" ++ replicate pathWidth '-' ++ "-+"
1942+ in
1943+ D.indent 4 $ D.vcat $
1944+ [ bar, toRow ("Module Name", "File Path"), bar ] ++ map toRow namePairs ++ [ bar ]
1945+
1946+
1947+
1948+-- GENERATE
1949+
1950+
1951+data Generate
1952+ = GenerateCannotLoadArtifacts
1953+ | GenerateCannotOptimizeDebugValues ModuleName.Raw [ModuleName.Raw]
1954+
1955+
1956+toGenerateReport :: Generate -> Help.Report
1957+toGenerateReport problem =
1958+ case problem of
1959+ GenerateCannotLoadArtifacts ->
1960+ corruptCacheReport
1961+
1962+ GenerateCannotOptimizeDebugValues m ms ->
1963+ Help.report "DEBUG REMNANTS" Nothing
1964+ "There are uses of the `Debug` module in the following modules:"
1965+ [ D.indent 4 $ D.red $ D.vcat $ map (D.fromChars . ModuleName.toChars) (m:ms)
1966+ , D.reflow "But the --optimize flag only works if all `Debug` functions are removed!"
1967+ , D.toSimpleNote $
1968+ "The issue is that --optimize strips out info needed by `Debug` functions.\
1969+ \ Here are two examples:"
1970+ , D.indent 4 $ D.reflow $
1971+ "(1) It shortens record field names. This makes the generated JavaScript\
1972+ \ smaller, but `Debug.toString` cannot know the real field names anymore."
1973+ , D.indent 4 $ D.reflow $
1974+ "(2) Values like `type Height = Height Float` are unboxed. This reduces\
1975+ \ allocation, but it also means that `Debug.toString` cannot tell if it is\
1976+ \ looking at a `Height` or `Float` value."
1977+ , D.reflow $
1978+ "There are a few other cases like that, and it will be much worse once we start\
1979+ \ inlining code. That optimization could move `Debug.log` and `Debug.todo` calls,\
1980+ \ resulting in unpredictable behavior. I hope that clarifies why this restriction\
1981+ \ exists!"
1982+ ]
1983+
1984+
1985+
1986+-- CORRUPT CACHE
1987+
1988+
1989+corruptCacheReport :: Help.Report
1990+corruptCacheReport =
1991+ Help.report "CORRUPT CACHE" Nothing
1992+ "It looks like some of the information cached in elm-stuff/ has been corrupted."
1993+ [ D.reflow $
1994+ "Try deleting your elm-stuff/ directory to get unstuck."
1995+ , D.toSimpleNote $
1996+ "This almost certainly means that a 3rd party tool (or editor plugin) is\
1997+ \ causing problems your the elm-stuff/ directory. Try disabling 3rd party tools\
1998+ \ one by one until you figure out which it is!"
1999+ ]
2000+
2001+
2002+
2003+-- REACTOR
2004+
2005+
2006+data Reactor
2007+ = ReactorNoOutline
2008+ | ReactorBadDetails Details
2009+ | ReactorBadBuild BuildProblem
2010+ | ReactorBadGenerate Generate
2011+
2012+
2013+reactorToReport :: Reactor -> Help.Report
2014+reactorToReport problem =
2015+ case problem of
2016+ ReactorNoOutline ->
2017+ Help.report "NEW PROJECT?" Nothing
2018+ "Are you trying to start a new project? Try this command in the terminal:"
2019+ [ D.indent 4 $ D.green "elm init"
2020+ , D.reflow "It will help you get started!"
2021+ ]
2022+
2023+ ReactorBadDetails details ->
2024+ toDetailsReport details
2025+
2026+ ReactorBadBuild buildProblem ->
2027+ toBuildProblemReport buildProblem
2028+
2029+ ReactorBadGenerate generate ->
2030+ toGenerateReport generate
2031+
2032+
2033+
2034+-- REPL
2035+
2036+
2037+data Repl
2038+ = ReplBadDetails Details
2039+ | ReplBadInput BS.ByteString Error.Error
2040+ | ReplBadLocalDeps FilePath Error.Module [Error.Module]
2041+ | ReplProjectProblem BuildProjectProblem
2042+ | ReplBadGenerate Generate
2043+ | ReplBadCache
2044+ | ReplBlocked
2045+
2046+
2047+replToReport :: Repl -> Help.Report
2048+replToReport problem =
2049+ case problem of
2050+ ReplBadDetails details ->
2051+ toDetailsReport details
1012052
102− Diff commandsExit ->
103− Diff.toReport commandsExit
2053+ ReplBadInput source err ->
2054+ Help.compilerReport "/" (Error.Module N.replModule "REPL" File.zeroTime source err) []
1042055
105− Make makeExit ->
106− Make.toReport makeExit
2056+ ReplBadLocalDeps root e es ->
2057+ Help.compilerReport root e es
1072058
108− Init initExit ->
109− Init.toReport initExit
2059+ ReplProjectProblem projectProblem ->
2060+ toProjectProblemReport projectProblem
1102061
111− Install installExit ->
112− Install.toReport installExit
2062+ ReplBadGenerate generate ->
2063+ toGenerateReport generate
1132064
114− Publish publishExit ->
115− Publish.toReport publishExit
2065+ ReplBadCache ->
2066+ corruptCacheReport
1162067
117− BadHttp url httpExit ->
118− Http.toReport url httpExit
2068+ ReplBlocked ->
2069+ corruptCacheReport
builder/src/Reporting/Exit/Assets.hsdeleted−227
@@ -1,227 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Exit.Assets
3− ( Exit(..)
4− , ElmJsonProblem(..)
5− , toReport
6− , BadElmJsonContent(..)
7− , badContentToDocs
8− )
9− where
10−
11−
12−import qualified Data.Text as Text
13−
14−import qualified Elm.Package as Pkg
15−import Reporting.Doc ((<>))
16−import qualified Reporting.Doc as D
17−import qualified Reporting.Exit.Help as Help
18−
19−
20−
21−-- EXITS
22−
23−
24−data Exit
25− = BadElmJson ElmJsonProblem
26− | CorruptElmJson Pkg.Name Pkg.Version
27− | CorruptDocumentation Pkg.Name Pkg.Version
28− | CorruptBinary FilePath FilePath
29−
30−
31−
32−-- ELM JSON PROBLEM
33−
34−
35−data ElmJsonProblem
36− = BadJson D.Doc
37− | BadSrcDir FilePath
38− | NoPkgCore
39− | NoAppCore
40− | NoAppJson
41−
42−
43−
44−-- TO REPORT
45−
46−
47−toReport :: Exit -> Help.Report
48−toReport exit =
49− case exit of
50− CorruptElmJson pkg vsn ->
51− corruptJsonToReport "elm.json" pkg vsn
52−
53− CorruptDocumentation pkg vsn ->
54− corruptJsonToReport "docs.json" pkg vsn
55−
56− CorruptBinary elmHome path ->
57− Help.report "CORRUPT BINARY" (Just path)
58− ("The binary data at " ++ path ++ " is corrupt.")
59− [ D.reflow "Elm caches build artifacts in the following directories:"
60− , D.dullyellow $ D.indent 4 $ D.vcat $
61− [ D.fromString elmHome
62− , "elm-stuff/"
63− ]
64− , D.reflow
65− "Maybe you recently installed a command line tool or editor plugin that messes\
66− \ with them? They definitely should not be doing that, but you never know! So\
67− \ maybe try deleting them? Everything will be rebuilt from scratch. This may\
68− \ help reveal the corrupting influence."
69− ]
70−
71− BadElmJson problem ->
72− elmJsonProblemToReport problem
73−
74−
75−
76−-- CORRUPT JSON
77−
78−
79−corruptJsonToReport :: FilePath -> Pkg.Name -> Pkg.Version -> Help.Report
80−corruptJsonToReport path pkg vsn =
81− Help.report "CORRUPT JSON" Nothing
82− ( "The " ++ path ++ " for " ++ Pkg.toString pkg
83− ++ " " ++ Pkg.versionToString vsn ++ " got corrupted somehow."
84− )
85− [ D.reflow $
86− "I removed it from my file cache, so if it was some transient\
87− \ error it should be fixed if you try the same thing again.\
88− \ Please report this if it seems like an Elm problem though!"
89− ]
90−
91−
92−
93−-- BAD ELM JSON
94−
95−
96−elmJsonProblemToReport :: ElmJsonProblem -> Help.Report
97−elmJsonProblemToReport problem =
98− case problem of
99− BadJson doc ->
100− Help.jsonReport "BAD JSON" (Just "elm.json") doc
101−
102− BadSrcDir dir ->
103− Help.report "BAD JSON" (Just "elm.json")
104− "The \"source-directories\" in your elm.json lists the following directory:"
105− [ D.indent 4 (D.dullyellow (D.fromString dir))
106− , D.reflow "I cannot find that directory though! Is it missing? Is there a typo?"
107− ]
108−
109− NoPkgCore ->
110− Help.report "MISSING DEPENDENCY" (Just "elm.json")
111− "A package must have \"elm/core\" as a dependency. Try running:"
112− [ D.indent 4 $ D.green $ "elm install elm/core"
113− , D.reflow "I need it for the default imports that make `List` and `Maybe` available."
114− ]
115−
116− NoAppCore ->
117− Help.report "MISSING DEPENDENCY" (Just "elm.json")
118− "An application must have \"elm/core\" as a dependency. Try running:"
119− [ D.indent 4 $ D.green $ "elm install elm/core"
120− , D.reflow "It has some supporting code that is needed by every Elm application!"
121− ]
122−
123− NoAppJson ->
124− Help.report "MISSING DEPENDENCY" (Just "elm.json")
125− "An application must have \"elm/json\" as a dependency. Try running:"
126− [ D.indent 4 $ D.green $ "elm install elm/json"
127− , D.reflow "It helps me handle flags and ports."
128− ]
129−
130−
131−
132−-- PROBLEM TO DOCS
133−
134−
135−data BadElmJsonContent
136− = BadType Text.Text
137− | BadPkgName String
138− | BadVersion Text.Text
139− | BadConstraint String
140− | BadModuleName Text.Text
141− | BadModuleHeaderTooLong Text.Text
142− | BadDependencyName Text.Text
143− | BadLicense Text.Text [Text.Text]
144− | BadDirectoryNotString
145− | BadSummaryTooLong
146−
147−
148−badContentToDocs :: BadElmJsonContent -> [D.Doc]
149−badContentToDocs badContent =
150− case badContent of
151− BadType _ ->
152− ["The","only","valid","types","of","elm.json","are"
153− ,D.green "\"application\"","and",D.green "\"package\"" <> "."
154− ]
155−
156− BadPkgName problem ->
157− map D.fromString (words problem)
158−
159− BadVersion txt ->
160− ["You","provided",D.red (D.fromString (show txt))
161− ,"which","is","not","a","valid","version.","I","need","something","like"
162− ,D.green "\"1.0.0\"","or",D.green "\"2.0.4\"" <> "."
163− ]
164−
165− BadConstraint problem ->
166− map D.fromString (words ("It is not a valid constraint. " ++ problem))
167−
168− BadModuleName name ->
169− ["You","provided",D.fromString (show name),"which","is","not","a","valid","module","name."
170− ,"I","need","something","like",D.green "\"Html.Events\"","or",D.green "\"Browser.Navigation\"" <> "."
171− ]
172−
173− BadModuleHeaderTooLong header ->
174− ["The",D.fromString (show header),"header","is","too","long."
175− ,"I","need","it","to","be",D.green "under",D.green "20",D.green "characters"
176− ,"to","ensure","that","formatting","is","nice","on","the","package","website."
177− ]
178−
179− BadDependencyName name ->
180− ["The",D.fromString (show name),"entry","is","not","a","valid","package","name."
181− ,"I","recommend","deleting","it,","finding","the","package","you","want","on"
182− ,"the","package","website,","and","installing","it","with","the"
183− ,D.green "`elm install`","command","instead."
184− ]
185−
186− BadLicense _given suggestions ->
187− case suggestions of
188− [] ->
189− ["I","need","an","OSI","approved","SPDX","license,","like"
190− ,D.green "\"BSD-3-Clause\"","or",D.green "\"MIT\".","See"
191− ,"<https://spdx.org/licenses/>","for","a","full","list","of","options."
192− ]
193−
194− code:codes ->
195− ["I","need","an","OSI","approved","SPDX","license."]
196− ++ ["Maybe you wanted"] ++ oneOf code codes ++ ["instead?"]
197− ++ ["See","<https://spdx.org/licenses/>","for","a","full","list","of","options."]
198−
199− BadDirectoryNotString ->
200− ["I","need","a",D.green "STRING","that","points","to","a","directory","of","Elm","code."
201− ]
202−
203− BadSummaryTooLong ->
204− ["Your","summary","is","too","long.","I","need","it","to"
205− ,"be",D.green "under",D.green "80",D.green "characters."
206− ]
207−
208−
209−oneOf :: Text.Text -> [Text.Text] -> [D.Doc]
210−oneOf code codes =
211− let
212− toDoc spdx =
213− D.green (D.fromString (show spdx))
214− in
215− case codes of
216− [] ->
217− [toDoc code]
218−
219− [code2] ->
220− [toDoc code,"or",toDoc code2]
221−
222− _:_ ->
223− let
224− these = code : init codes
225− final = last codes
226− in
227− map (\spdx -> toDoc spdx <> ",") these ++ ["or",toDoc final]
builder/src/Reporting/Exit/Bump.hsdeleted−51
@@ -1,51 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Exit.Bump
3− ( Exit(..)
4− , toReport
5− )
6− where
7−
8−
9−import qualified Elm.Package as Pkg
10−import Reporting.Doc ((<>))
11−import qualified Reporting.Doc as D
12−import qualified Reporting.Exit.Help as Help
13−
14−
15−
16−-- EXITS
17−
18−
19−data Exit
20− = Application
21− | Unbumpable Pkg.Version [Pkg.Version]
22−
23−
24−
25−-- TO REPORT
26−
27−
28−toReport :: Exit -> Help.Report
29−toReport exit =
30− case exit of
31− Application ->
32− Help.report "UNBUMPABLE" (Just "elm.json")
33− "Your elm.json says this is an application. That means it cannot be published\
34− \ on <https://package.elm-lang.org> and therefore has no version to bump!"
35− []
36−
37− Unbumpable vsn versions ->
38− Help.docReport "UNBUMPABLE" (Just "elm.json")
39− ( D.fillSep
40− ["Your","elm.json","says","I","should","bump","relative","to","version"
41− ,D.red (D.fromText (Pkg.versionToText vsn)) <> ","
42− ,"but","I","cannot","find","that","version","on","<https://package.elm-lang.org>."
43− ,"That","means","there","is","no","API","for","me","to","diff","against","and"
44− ,"figure","out","if","these","are","MAJOR,","MINOR,","or","PATCH","changes."
45− ]
46− )
47− [ D.fillSep $
48− ["Try","bumping","again","after","changing","the",D.dullyellow "\"version\"","in","elm.json"]
49− ++ if length versions == 1 then ["to:"] else ["to","one","of","these:"]
50− , D.vcat $ map (D.green . D.fromText . Pkg.versionToText) versions
51− ]
builder/src/Reporting/Exit/Compile.hsdeleted−105
@@ -1,105 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module Reporting.Exit.Compile
4− ( Exit(..)
5− , toJson
6− , toDoc
7− )
8− where
9−
10−
11−import qualified Data.List as List
12−import qualified Data.Text as Text
13−import qualified Data.Time.Clock as Time
14−
15−import qualified Elm.Compiler as Compiler
16−import qualified Elm.ModuleName as ModuleName
17−import qualified Json.Encode as Encode
18−import qualified Reporting.Doc as D
19−
20−
21−
22−-- EXITS
23−
24−
25−data Exit =
26− Exit
27− { _name :: ModuleName.Raw
28− , _path :: FilePath
29− , _time :: Time.UTCTime
30− , _source :: Text.Text
31− , _errors :: [Compiler.Error]
32− }
33−
34−
35−
36−-- TO JSON
37−
38−
39−toJson :: Exit -> Encode.Value
40−toJson (Exit name path _ source errors) =
41− Compiler.errorsToJson name path source errors
42−
43−
44−
45−-- TO DOC
46−
47−
48−toDoc :: Exit -> [Exit] -> D.Doc
49−toDoc e es =
50− let
51− (exit, exits) = sortByTime e es
52− in
53− D.vcat (toDocHelp exit exits)
54−
55−
56−toDocHelp :: Exit -> [Exit] -> [D.Doc]
57−toDocHelp e1 exits =
58− case exits of
59− [] ->
60− [exitToDoc e1]
61−
62− e2 : otherErrors ->
63− exitToDoc e1 : separator (_name e1) (_name e2) : toDocHelp e2 otherErrors
64−
65−
66−exitToDoc :: Exit -> D.Doc
67−exitToDoc (Exit _name path _time source errors) =
68− Compiler.errorsToDoc path source errors
69−
70−
71−separator :: ModuleName.Raw -> ModuleName.Raw -> D.Doc
72−separator beforeName afterName =
73− let
74− before = ModuleName.nameToString beforeName ++ " ↑ "
75− after = " ↓ " ++ ModuleName.nameToString afterName
76− in
77− D.dullred $ D.vcat $
78− [ D.indent (80 - length before) (D.fromString before)
79− , "====o======================================================================o===="
80− , D.fromString after
81− , D.empty
82− , D.empty
83− ]
84−
85−
86−
87−-- SORT BY TIME
88−
89−
90−sortByTime :: Exit -> [Exit] -> (Exit, [Exit])
91−sortByTime exit exits =
92− case List.sortBy timeCompare exits of
93− [] ->
94− (exit, [])
95−
96− e:es ->
97− if _time exit < _time e then
98− (exit, e:es)
99− else
100− (e, List.insertBy timeCompare exit es)
101−
102−
103−timeCompare :: Exit -> Exit -> Ordering
104−timeCompare e1 e2 =
105− compare (_time e1) (_time e2)
builder/src/Reporting/Exit/Crawl.hsdeleted−346
@@ -1,346 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Exit.Crawl
3− ( Exit(..)
4− , Problem(..)
5− , Origin(..)
6− , SrcDirs(..)
7− , toReport
8− )
9− where
10−
11−
12−import qualified Data.ByteString as BS
13−import qualified Data.Char as Char
14−import qualified Data.Map as Map
15−import qualified Data.Text.Encoding as Text
16−import qualified Data.Time.Clock as Time
17−
18−import qualified Elm.Compiler as Compiler
19−import qualified Elm.ModuleName as ModuleName
20−import qualified Elm.Package as Pkg
21−import Reporting.Doc ((<+>), (<>))
22−import qualified Reporting.Doc as D
23−import qualified Reporting.Exit.Compile as Compile
24−import qualified Reporting.Exit.Help as Help
25−
26−
27−
28−-- EXIT
29−
30−
31−data Exit
32− = RootFileNotFound FilePath
33− | RootModuleNameDuplicate ModuleName.Raw [FilePath]
34− | RootNameless FilePath
35− | DependencyProblems Problem [Problem]
36− | BadKernelHeader FilePath
37−
38−
39−data Problem
40− = ModuleNotFound Origin ModuleName.Raw SrcDirs
41− | ModuleAmbiguous Origin ModuleName.Raw [FilePath] [Pkg.Canonical]
42− | BadHeader FilePath Time.UTCTime BS.ByteString Compiler.Error
43− | ModuleNameReservedForKernel Origin ModuleName.Raw
44− | ModuleNameMissing FilePath ModuleName.Raw
45− | ModuleNameMismatch
46− FilePath
47− ModuleName.Raw -- expected
48− ModuleName.Raw -- actual
49− | PortsInPackage FilePath ModuleName.Raw
50− | EffectsUnexpected FilePath ModuleName.Raw
51−
52−
53−data Origin
54− = ElmJson
55− | File FilePath
56− | Module FilePath ModuleName.Raw
57−
58−
59−data SrcDirs
60− = App [FilePath]
61− | Pkg
62−
63−
64−
65−-- TO REPORT
66−
67−
68−toReport :: Exit -> Help.Report
69−toReport exit =
70− case exit of
71− RootFileNotFound path ->
72− Help.report "FILE NOT FOUND" Nothing
73− "You want me to compile this file:"
74− [ D.indent 4 $ D.dullyellow $ D.fromString path
75− , "I cannot find it though! Is there a typo?"
76− ]
77−
78− RootModuleNameDuplicate name paths ->
79− Help.report "DUPLICATE NAMES" Nothing
80− "I am trying to compile multiple modules with the same name:"
81− [ D.indent 4 $ D.dullyellow $ D.vcat $
82− map D.fromString paths
83− , D.fillSep $
84− [ "These", "modules", if length paths == 2 then "both" else "all", "claim"
85− , "to", "be", "named", D.dullyellow (D.fromString (ModuleName.nameToString name)) <> "."
86− , "Change", "them", "to", "have", "unique", "names", "and", "you"
87− , "should", "be", "all", "set!"
88− ]
89− ]
90−
91− RootNameless path ->
92− namelessToDoc path "Main"
93−
94− DependencyProblems problem otherProblems ->
95− case otherProblems of
96− [] ->
97− problemToReport problem
98−
99− _ ->
100− problemToReport problem
101− -- error "TODO handle multiple dependency errors"
102−
103− BadKernelHeader filePath ->
104− Help.report "BAD KERNEL HEADER" Nothing
105− "I ran into a bad header in this file:"
106− [ D.indent 4 $ D.dullyellow $ D.fromString filePath
107− , D.reflow $
108− "NOTE: Kernel code is only available to core Elm libraries to ensure\
109− \ the portability and security of the Elm ecosystem. This restriction\
110− \ also makes it possible to improve code gen (i.e. performance) without\
111− \ disrupting the ecosystem."
112− ]
113−
114−
115−
116−-- PROBLEM TO REPORT
117−
118−
119−problemToReport :: Problem -> Help.Report
120−problemToReport problem =
121− case problem of
122− ModuleNotFound origin name srcDirs ->
123− notFoundToDoc origin name srcDirs
124−
125− ModuleAmbiguous origin child paths pkgs ->
126− ambiguousToDoc origin child paths pkgs
127−
128− BadHeader path time source compilerError ->
129− let
130− compilerExit =
131− Compile.Exit "???" path time (Text.decodeUtf8 source) [compilerError]
132− in
133− Help.compilerReport compilerExit []
134−
135− ModuleNameMissing path name ->
136− namelessToDoc path name
137−
138− ModuleNameMismatch path expected actual ->
139− Help.report "MODULE NAME MISMATCH" (Just path)
140− ( "The file at " ++ path ++ " has a typo in the module name. It says:"
141− )
142− [ D.indent 4 $ D.dullyellow $ "module" <+> D.red (D.fromString (ModuleName.nameToString actual)) <+> "exposing (..)"
143− , "Looks like a typo or copy/paste error. Instead it needs to say:"
144− , D.indent 4 $ D.dullyellow $ "module" <+> D.green (D.fromString (ModuleName.nameToString expected)) <+> "exposing (..)"
145− , "Make the change and you should be all set!"
146− ]
147−
148− ModuleNameReservedForKernel origin name ->
149− kernelNameToDoc origin name
150−
151− PortsInPackage path name ->
152− badTagToDoc path name "port" "port-modules" $
153− "Packages cannot have any `port` modules."
154−
155− EffectsUnexpected path name ->
156− badTagToDoc path name "effect" "effect-modules" $
157− "Creating `effect` modules is relatively experimental. There are a\
158− \ couple in @elm repos right now, but we have decided to be very\
159− \ cautious in expanding its usage."
160−
161−
162−badTagToDoc :: FilePath -> ModuleName.Raw -> String -> String -> String -> Help.Report
163−badTagToDoc path name tag hintName summary =
164− Help.report
165− ("UNEXPECTED " ++ map Char.toUpper tag ++ " MODULE")
166− (Just path)
167− summary
168− [ D.fillSep $
169− [ "Get", "rid", "of", "all", "the"
170− , D.red (D.fromString tag)
171− , "stuff", "in"
172− , D.dullyellow (D.fromString (ModuleName.nameToString name))
173− , "to", "proceed."
174− ]
175− , D.toSimpleNote $
176− "You can learn the reasoning behind this design choice at "
177− ++ D.makeLink hintName
178− ]
179−
180−
181−
182−-- NAMELESS
183−
184−
185−namelessToDoc :: FilePath -> ModuleName.Raw -> Help.Report
186−namelessToDoc path name =
187− Help.report "UNNAMED MODULE" (Just path)
188− ( "The `" ++ ModuleName.nameToString name
189− ++ "` module must start with a line like this:"
190− )
191− [ D.indent 4 $ D.dullyellow $ D.fromString $
192− "module " ++ ModuleName.nameToString name ++ " exposing (..)"
193− , D.reflow $
194− "Try adding that as the first line of your file!"
195− , D.toSimpleNote $
196− "It is best to replace (..) with an explicit list of types and\
197− \ functions you want to expose. If you know a value is only used\
198− \ WITHIN this module, it is extra easy to refactor. This kind of\
199− \ information is great, especially as your project grows!"
200− ]
201−
202−
203−
204−-- NOT FOUND
205−
206−
207−notFoundToDoc :: Origin -> ModuleName.Raw -> SrcDirs -> Help.Report
208−notFoundToDoc origin child srcDirs =
209− case origin of
210− ElmJson ->
211− Help.report "MODULE NOT FOUND" (Just "elm.json")
212− "Your elm.json says your project has the following module:"
213− [ D.indent 4 $ D.red $ D.fromString $ ModuleName.nameToString child
214− , D.reflow $
215− "When creating packages, all modules must live in the src/ directory."
216− ]
217−
218− File path ->
219− Help.report "UNKNOWN IMPORT" (Just path)
220− ("I cannot find a `" ++ ModuleName.nameToString child ++ "` module to import.")
221− (notFoundDetails child srcDirs)
222−
223− Module path parent ->
224− Help.report "UNKNOWN IMPORT" (Just path)
225− ("The " ++ ModuleName.nameToString parent ++ " module has a bad import:")
226− (notFoundDetails child srcDirs)
227−
228−
229−notFoundDetails :: ModuleName.Raw -> SrcDirs -> [D.Doc]
230−notFoundDetails child srcDirs =
231− let
232− simulatedCode =
233− D.indent 4 $ D.red $ D.fromString $ "import " ++ ModuleName.nameToString child
234− in
235− case Map.lookup child Pkg.suggestions of
236− Just pkg ->
237− [ simulatedCode
238− , D.reflow $
239− "Do you want the one from the " ++ Pkg.toString pkg
240− ++ " package? If so, run this command to add that dependency to your elm.json file:"
241− , D.indent 4 $ D.green $ D.fromString $ "elm install " ++ Pkg.toString pkg
242− , case srcDirs of
243− Pkg ->
244− D.reflow $
245− "If you want a local file, make sure the `"
246− ++ ModuleName.nameToString child
247− ++ "` module is in your src/ directory."
248−
249− App _ ->
250− D.reflow $
251− "If you want a local file, make sure the `"
252− ++ ModuleName.nameToString child
253− ++ "` module is in one of the \"source-directories\" listed in your elm.json file."
254− ]
255−
256− Nothing ->
257− [ simulatedCode
258− , "I cannot find that module! Is there a typo in the module name?"
259− , D.reflow $
260− case srcDirs of
261− Pkg ->
262− "When creating a package, all modules must live in the src/ directory."
263−
264− App [] ->
265− "The \"source-directories\" field of your elm.json is empty, so I only\
266− \ searched in packages. Maybe you need to add a \"src\" directory there?"
267−
268− App [dir] ->
269− "The \"source-directories\" field of your elm.json tells me to only look in the "
270− ++ dir ++ " directory, but it is not there. Maybe it is in a package that is not installed yet?"
271−
272− App (dir:_:_) ->
273− "The \"source-directories\" field of your elm.json tells me to look in directories like "
274− ++ dir ++ ", but it is not in any of them. Maybe it is in a package that is not installed yet?"
275− ]
276−
277−
278−ambiguousToDoc :: Origin -> ModuleName.Raw -> [FilePath] -> [Pkg.Canonical] -> Help.Report
279−ambiguousToDoc origin child paths pkgs =
280− let
281− pkgToString (Pkg.Canonical pkg vsn) =
282− "exposed by " ++ Pkg.toString pkg ++ " " ++ Pkg.versionToString vsn
283−
284− makeReport maybePath summary yellowString =
285− Help.report "AMBIGUOUS IMPORT" maybePath summary
286− [ D.indent 4 $ D.dullyellow $ D.fromString yellowString
287− , D.reflow $
288− "I found multiple module with that name though:"
289− , D.indent 4 $ D.dullyellow $ D.vcat $
290− map D.fromString $ paths ++ map pkgToString pkgs
291− , D.reflow $
292− if null paths then
293− "It looks like the name clash is in your dependencies, which is\
294− \ out of your control. Elm does not support this scenario right\
295− \ now, but it may be worthwhile. Please open an issue describing\
296− \ your scenario so we can gather more usage information!"
297− else
298− "Which is the right one? Try renaming your modules to have unique names."
299− ]
300− in
301− case origin of
302− ElmJson ->
303− makeReport
304− Nothing
305− "Your elm.json wants the following module:"
306− (ModuleName.nameToString child)
307−
308− File path ->
309− makeReport
310− (Just path)
311− ("The file at " ++ path ++ " has an ambiguous import:")
312− ("import " ++ ModuleName.nameToString child)
313−
314− Module path parent ->
315− makeReport
316− (Just path)
317− ("The " ++ ModuleName.nameToString parent ++ " module has an ambiguous import:")
318− ("import " ++ ModuleName.nameToString child)
319−
320−
321−kernelNameToDoc :: Origin -> ModuleName.Raw -> Help.Report
322−kernelNameToDoc origin kernelName =
323− let
324− (maybePath, statement) =
325− case origin of
326− ElmJson ->
327− ( Nothing
328− , "Your elm.json says your project has the following module:"
329− )
330−
331− File path ->
332− ( Just path
333− , "This file is trying to import the following module:"
334− )
335−
336− Module path parent ->
337− ( Just path
338− , "Your " ++ ModuleName.nameToString parent ++ " module is trying to import:"
339− )
340− in
341− Help.report "BAD MODULE NAME" maybePath statement
342− [ D.indent 4 $ D.dullyellow $ D.fromString $ ModuleName.nameToString kernelName
343− , D.reflow $
344− "But names like that are reserved for internal use.\
345− \ Switch to a name outside of the Elm/Kernel/ namespace."
346− ]
builder/src/Reporting/Exit/Deps.hsdeleted−123
@@ -1,123 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Exit.Deps
3− ( Exit(..)
4− , toReport
5− )
6− where
7−
8−
9−import qualified Elm.Compiler as Compiler
10−import qualified Elm.Package as Pkg
11−import qualified Elm.Project.Constraint as Con
12−import Reporting.Doc ((<>))
13−import qualified Reporting.Doc as D
14−import qualified Reporting.Exit.Help as Help
15−
16−
17−
18−-- EXITS
19−
20−
21−data Exit
22− = CorruptVersionCache FilePath Pkg.Name
23− | PackageNotFound Pkg.Name [Pkg.Name]
24− -- verify
25− | PkgBadElm Con.Constraint
26− | AppBadElm Pkg.Version
27− | AppMissingTrans [(Pkg.Name, Pkg.Version)]
28− | BadDeps
29− | BuildFailure FilePath Pkg.Name Pkg.Version
30−
31−
32−
33−-- TO DOC
34−
35−
36−toReport :: Exit -> Help.Report
37−toReport exit =
38− case exit of
39− CorruptVersionCache elmHome pkg ->
40− Help.report "CORRUPT CACHE" Nothing
41− ( "I ran into an unknown package while exploring dependencies:"
42− )
43− [ D.indent 4 $ D.dullyellow $ D.fromString $ Pkg.toString pkg
44− , D.reflow $
45− "This suggests that your " ++ elmHome ++ " directory has been corrupted.\
46− \ Maybe some program is messing with it? It is just cached files,\
47− \ so you can delete it and see if that fixes the issue."
48− ]
49−
50− PackageNotFound package suggestions ->
51− Help.docReport "PACKAGE NOT FOUND" Nothing
52− ( D.fillSep
53− ["I","cannot","find","a"
54− ,D.red (D.fromString (Pkg.toString package))
55− ,"package","on","the","package","website."
56− ]
57− )
58− [ "Maybe you want one of these instead?"
59− , D.indent 4 $ D.dullyellow $ D.vcat $ map (D.fromString . Pkg.toString) suggestions
60− , "But check <https://package.elm-lang.org> to see all possibilities!"
61− ]
62−
63− PkgBadElm constraint ->
64− Help.report "ELM VERSION MISMATCH" (Just "elm.json")
65− "Your elm.json says this package needs a version of Elm in this range:"
66− [ D.indent 4 $ D.dullyellow $ D.fromString $ Con.toString constraint
67− , D.fillSep
68− [ "But", "you", "are", "using", "Elm"
69− , D.red (D.fromString (Pkg.versionToString Compiler.version))
70− , "right", "now."
71− ]
72− ]
73−
74− AppBadElm version ->
75− Help.report "ELM VERSION MISMATCH" (Just "elm.json")
76− "Your elm.json says this application needs a different version of Elm."
77− [ D.fillSep
78− [ "It", "requires"
79− , D.green (D.fromString (Pkg.versionToString version)) <> ","
80− , "but", "you", "are", "using"
81− , D.red (D.fromString (Pkg.versionToString Compiler.version))
82− , "right", "now."
83− ]
84− ]
85−
86− AppMissingTrans missingDeps ->
87− let
88− toEntry (pkg, vsn) =
89− "\"" ++ Pkg.toString pkg ++ "\": \"" ++ Pkg.versionToString vsn ++ "\""
90− in
91− Help.report "MISSING DEPENDENCIES" (Just "elm.json")
92− "Your elm.json is missing some \"indirect\" dependencies:"
93− [ D.indent 4 $ D.dullyellow $ D.vcat $ map (D.fromString . toEntry) missingDeps
94− , D.fillSep
95− ["This","usually","means","you","are","editing","elm.json","by","hand."
96− ,"It","is","much","more","reliable","to","use","the"
97− ,D.green "elm install","command","instead."
98− ]
99− ]
100−
101− BadDeps ->
102− Help.report "INVALID PACKAGE DEPENDENCIES" (Just "elm.json")
103− "The dependencies in your elm.json are not compatible."
104− [ D.fillSep
105− ["Did","you","change","them","by","hand?","Try","to","change","it","back!"
106− ,"It","is","much","better","to","add","dependencies","with",D.green "elm install"
107− ,"or","the","dependency","management","tool","in",D.green "elm reactor" <> "."
108− ]
109− , D.reflow $
110− "Please ask for help on the Elm slack <http://elmlang.herokuapp.com/> if\
111− \ you try those paths and still cannot figure it out!"
112− ]
113−
114− BuildFailure elmHome pkg vsn ->
115− Help.report "CORRUPT DEPENDENCY" Nothing
116− "I ran into a problem while building the following package:"
117− [ D.indent 4 $ D.red $ D.fromString $ Pkg.toString pkg ++ " " ++ Pkg.versionToString vsn
118− , D.fillSep
119− ["This","probably","means","the","downloaded","files","got","corrupted","somehow."
120− ,"Try","deleting",D.dullyellow (D.fromString elmHome),"(a","directory","for"
121− ,"caching","build","artifacts)","and","see","if","that","resolves","the","issue."
122− ]
123− ]
builder/src/Reporting/Exit/Diff.hsdeleted−72
@@ -1,72 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Exit.Diff
3− ( Exit(..)
4− , toReport
5− )
6− where
7−
8−
9−import qualified Data.List as List
10−
11−import qualified Elm.Package as Pkg
12−import qualified Reporting.Doc as D
13−import qualified Reporting.Exit.Help as Help
14−
15−
16−
17−-- EXITS
18−
19−
20−data Exit
21− = Application
22− | Unpublished
23− | UnknownPackage Pkg.Name [Pkg.Name]
24− | UnknownVersion Pkg.Name Pkg.Version [Pkg.Version]
25−
26−
27−
28−-- TO DOC
29−
30−
31−toReport :: Exit -> Help.Report
32−toReport exit =
33− case exit of
34− Application ->
35− Help.report "CANNOT DIFF APPLICATIONS" Nothing
36− "I cannot perform diffs on applications, only packages! If you are\
37− \ just curious to see a diff, try running this command:"
38− [ D.indent 4 $ D.green $ "elm diff elm/html 5.1.1 6.0.0"
39− ]
40−
41− Unpublished ->
42− Help.report "UNPUBLISHED" Nothing
43− "This package is not published yet. There is nothing to diff against!"
44− []
45−
46− UnknownPackage pkg suggestions ->
47− Help.report "UNKNOWN PACKAGE" Nothing
48− ( "I cannot find a package called:"
49− )
50− [ D.indent 4 $ D.red $ D.fromText $ Pkg.toText pkg
51− , "Maybe you want one of these instead?"
52− , D.indent 4 $ D.dullyellow $ D.vcat $ map (D.fromText . Pkg.toText) suggestions
53− , "But check <https://package.elm-lang.org> to see all possibilities!"
54− ]
55−
56− UnknownVersion _pkg vsn realVersions ->
57− Help.docReport "UNKNOWN VERSION" Nothing
58− ( D.fillSep $
59− [ "Version", D.red (D.fromText (Pkg.versionToText vsn))
60− , "has", "never", "been", "published,", "so", "I"
61− , "cannot", "diff", "against", "it."
62− ]
63− )
64− [ "Here are all the versions that HAVE been published:"
65− , D.indent 4 $ D.dullyellow $ D.vcat $
66− let
67− sameMajor v1 v2 = Pkg._major v1 == Pkg._major v2
68− mkRow vsns = D.hsep $ map (D.fromText . Pkg.versionToText) vsns
69− in
70− map mkRow $ List.groupBy sameMajor (List.sort realVersions)
71− , "Want one of those instead?"
72− ]
builder/src/Reporting/Exit/Help.hs+18−18
@@ -14,14 +14,14 @@ module Reporting.Exit.Help
1414 where
1515
1616
17−import qualified Data.Text as Text
1817import GHC.IO.Handle (hIsTerminalDevice)
1918import System.IO (Handle, hPutStr, stderr, stdout)
2019
21−import qualified Json.Encode as Encode
20+import qualified Json.Encode as E
21+import Json.Encode ((==>))
2222import Reporting.Doc ((<+>))
2323import qualified Reporting.Doc as D
24−import qualified Reporting.Exit.Compile as Compile
24+import qualified Reporting.Error as Error
2525
2626
2727
@@ -29,7 +29,7 @@ import qualified Reporting.Exit.Compile as Compile
2929
3030
3131data Report
32− = CompilerReport Compile.Exit [Compile.Exit]
32+ = CompilerReport FilePath Error.Module [Error.Module]
3333 | Report
3434 { _title :: String
3535 , _path :: Maybe FilePath
@@ -52,7 +52,7 @@ jsonReport =
5252 Report
5353
5454
55−compilerReport :: Compile.Exit -> [Compile.Exit] -> Report
55+compilerReport :: FilePath -> Error.Module -> [Error.Module] -> Report
5656compilerReport =
5757 CompilerReport
5858
@@ -64,8 +64,8 @@ compilerReport =
6464reportToDoc :: Report -> D.Doc
6565reportToDoc report_ =
6666 case report_ of
67− CompilerReport e es ->
68− Compile.toDoc e es
67+ CompilerReport root e es ->
68+ Error.toDoc root e es
6969
7070 Report title maybePath message ->
7171 let
@@ -82,7 +82,7 @@ reportToDoc report_ =
8282
8383 errorBar =
8484 D.dullcyan $
85− "--" <+> D.fromString title <+> D.fromString errorBarEnd
85+ "--" <+> D.fromChars title <+> D.fromChars errorBarEnd
8686 in
8787 D.stack [errorBar, message, ""]
8888
@@ -91,21 +91,21 @@ reportToDoc report_ =
9191-- TO JSON
9292
9393
94−reportToJson :: Report -> Encode.Value
94+reportToJson :: Report -> E.Value
9595reportToJson report_ =
9696 case report_ of
97− CompilerReport e es ->
98− Encode.object
99− [ ("type", Encode.text "compile-errors")
100− , ("errors", Encode.list Compile.toJson (e:es))
97+ CompilerReport _ e es ->
98+ E.object
99+ [ "type" ==> E.chars "compile-errors"
100+ , "errors" ==> E.list Error.toJson (e:es)
101101 ]
102102
103103 Report title maybePath message ->
104− Encode.object
105− [ ("type", Encode.text "error")
106− , ("path", maybe Encode.null (Encode.text . Text.pack) maybePath)
107− , ("title", Encode.text (Text.pack title))
108− , ("message", D.encode message)
104+ E.object
105+ [ "type" ==> E.chars "error"
106+ , "path" ==> maybe E.null E.chars maybePath
107+ , "title" ==> E.chars title
108+ , "message" ==> D.encode message
109109 ]
110110
111111
builder/src/Reporting/Exit/Http.hsdeleted−104
@@ -1,104 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Exit.Http
3− ( Exit(..)
4− , toReport
5− , BadJson(..)
6− , badJsonToDocs
7− )
8− where
9−
10−
11−import qualified Data.Text as Text
12−
13−import Reporting.Doc ((<>))
14−import qualified Reporting.Doc as D
15−import qualified Reporting.Exit.Help as Help
16−
17−
18−
19−-- EXITS
20−
21−
22−data Exit
23− = Unknown String
24− | BadJson String D.Doc
25− | BadZipData
26− | BadZipSha String String
27−
28−
29−
30−-- TO REPORT
31−
32−
33−toReport :: String -> Exit -> Help.Report
34−toReport url exit =
35− let
36− urlDoc =
37− D.indent 4 $ D.dullyellow $ "<" <> D.fromString url <> ">"
38− in
39− case exit of
40− Unknown message ->
41− Help.report "HTTP PROBLEM" Nothing "The following HTTP request failed:"
42− [ urlDoc
43− , D.stack
44− [ "Here is the error message I was able to extract:"
45− , D.indent 4 $ D.reflow message
46− ]
47− ]
48−
49− BadJson path doc ->
50− Help.jsonReport "UNEXPECTED JSON" (Just path) doc
51−
52− BadZipData ->
53− Help.report "CORRUPT ZIP" Nothing "I could not unzip the file downloaded from:"
54− [ urlDoc
55− , D.reflow $
56− "If it is a transient issue, it should be fixed if you try this\
57− \ again. If it seems like an Elm problem, please report it though!"
58− ]
59−
60− BadZipSha expectedHash actualHash ->
61− Help.report "CORRUPT ZIP" Nothing "I got an unexpected zip file from:"
62− [ urlDoc
63− , D.reflow "I check the hash the zip, and it seems off:"
64− , D.vcat $ map D.fromString $
65− [ " Expected: " ++ expectedHash
66− , " Actual: " ++ actualHash
67− ]
68− , D.reflow $
69− "This usually means that the package author moved the version\
70− \ tag, so report it to them and see if that is the issue. Folks\
71− \ on Elm slack can probably help as well."
72− ]
73−
74−
75−
76−-- BAD JSON
77−
78−
79−data BadJson
80− = BadNewPkg Text.Text
81− | BadAllPkg Text.Text String
82− | BadAllVsn Text.Text
83−
84−
85−badJsonToDocs :: BadJson -> [D.Doc]
86−badJsonToDocs badJson =
87− case badJson of
88− BadNewPkg txt ->
89− ["I","ran","into",D.red (D.fromString (show txt)) <> ","
90− ,"but","I","need","entries","like"
91− ,D.green "\"elm/core@6.0.0\"" <> "."
92− ]
93−
94− BadAllPkg txt suggestion ->
95− ["The",D.red (D.fromString (show txt)),"value","is","not","a","valid","package","name."
96− ]
97− ++ map D.fromString (words suggestion)
98−
99− BadAllVsn txt ->
100− ["You","provided",D.red (D.fromString (show txt))
101− ,"which","is","not","a","valid","version.","I","need","something","like"
102− ,D.green "\"1.0.0\"","or",D.green "\"2.0.4\"" <> "."
103− ]
104−
builder/src/Reporting/Exit/Init.hsdeleted−49
@@ -1,49 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Exit.Init
3− ( Exit(..)
4− , toReport
5− )
6− where
7−
8−
9−import qualified Reporting.Doc as D
10−import qualified Reporting.Exit.Help as Help
11−
12−import qualified Elm.Package as Pkg
13−
14−
15−
16−-- EXITS
17−
18−
19−data Exit
20− = NoSolution [Pkg.Name]
21− | AlreadyStarted
22−
23−
24−
25−-- TO REPORT
26−
27−
28−toReport :: Exit -> Help.Report
29−toReport exit =
30− case exit of
31− NoSolution pkgs ->
32− Help.report "NO SOLUTION" Nothing
33− "I tried to create an elm.json with the following direct dependencies:"
34− [ D.indent 4 $ D.vcat $
35− map (D.dullyellow . D.fromString . Pkg.toString) pkgs
36− , D.reflow $
37− "I could not find compatible versions though! This should not happen, so please\
38− \ ask around one of the community forums <http://elm-lang.org/community> to learn\
39− \ what is going on!"
40− ]
41−
42− AlreadyStarted ->
43− Help.report "EXISTING PROJECT" Nothing
44− "You already have an elm.json file, so there is nothing for me to initialize!"
45− [ D.fillSep
46− ["Maybe",D.green (D.fromString (D.makeLink "init")),"can","help"
47− ,"you","figure","out","what","to","do","next?"
48− ]
49− ]
builder/src/Reporting/Exit/Install.hsdeleted−82
@@ -1,82 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Exit.Install
3− ( Exit(..)
4− , toReport
5− )
6− where
7−
8−
9−import qualified Elm.Compiler as Compiler
10−import qualified Elm.Package as Pkg
11−import qualified Reporting.Doc as D
12−import qualified Reporting.Exit.Help as Help
13−
14−
15−
16−-- EXITS
17−
18−
19−data Exit
20− = NoArgs FilePath
21− | NoSolution [Pkg.Name]
22−
23−
24−
25−-- TO REPORT
26−
27−
28−toReport :: Exit -> Help.Report
29−toReport exit =
30− case exit of
31− NoArgs elmHome ->
32− Help.report "INSTALL WHAT?" Nothing
33− "I am expecting commands like:"
34− [ D.green $ D.indent 4 $ D.vcat $
35− [ "elm install elm/http"
36− , "elm install elm/json"
37− , "elm install elm/random"
38− ]
39− , D.toFancyHint
40− ["In","JavaScript","folks","run","`npm install`","to","start","projects."
41− ,"\"Gotta","download","everything!\"","But","why","download","packages"
42− ,"again","and","again?","Instead,","Elm","caches","packages","in"
43− ,D.dullyellow (D.fromString elmHome)
44− ,"so","each","one","is","downloaded","and","built","ONCE","on","your","machine."
45− ,"Elm","projects","check","that","cache","before","trying","the","internet."
46− ,"This","reduces","build","times,","reduces","server","costs,","and","makes","it"
47− ,"easier","to","work","offline.","As","a","result"
48− ,D.dullcyan "elm install","is","only","for","adding","dependencies","to","elm.json,"
49− ,"whereas",D.dullcyan "elm make","is","in","charge","of","gathering","dependencies"
50− ,"and","building","everything.","So","maybe","try",D.green "elm make","instead?"
51− ]
52− ]
53−
54− NoSolution badPackages ->
55− case badPackages of
56− [] ->
57− Help.report "UNSOLVABLE DEPENDENCIES" (Just "elm.json")
58− "This usually happens if you try to modify dependency constraints by\
59− \ hand. I recommend deleting any dependency you added recently (or all\
60− \ of them if things are bad) and then adding them again with:"
61− [ D.indent 4 $ D.green "elm install"
62− , D.reflow $
63− "And do not be afaid to ask for help on Slack if you get stuck!"
64− ]
65−
66− _:_ ->
67− Help.report "OLD DEPENDENCIES" (Just "elm.json")
68− ( "The following packages do not work with Elm " ++ Pkg.versionToString Compiler.version ++ " right now:"
69− )
70− [ D.indent 4 $ D.vcat $ map (D.red . D.fromString . Pkg.toString) badPackages
71− , D.reflow $
72− "This may be because it is not upgraded yet. It may be because a\
73− \ better solution came along, so there was no need to upgrade it.\
74− \ Etc. Try asking around on Slack to learn more about the topic."
75− , D.toSimpleNote
76− "Whatever the case, please be kind to the relevant package authors! Having\
77− \ friendly interactions with users is great motivation, and conversely, getting\
78− \ berated by strangers on the internet sucks your soul dry. Furthermore, package\
79− \ authors are humans with families, friends, jobs, vacations, responsibilities,\
80− \ goals, etc. They face obstacles outside of their technical work you will never\
81− \ know about, so please assume the best and try to be patient and supportive!"
82− ]
builder/src/Reporting/Exit/Make.hsdeleted−75
@@ -1,75 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Exit.Make
3− ( Exit(..)
4− , toReport
5− )
6− where
7−
8−
9−import qualified Elm.ModuleName as ModuleName
10−import qualified Reporting.Doc as D
11−import qualified Reporting.Exit.Help as Help
12−
13−
14−
15−-- EXITS
16−
17−
18−data Exit
19− = CannotMakeNothing
20− | CannotOptimizeDebugValues ModuleName.Raw [ModuleName.Raw]
21− | CannotOptimizeAndDebug
22−
23−
24−
25−-- TO REPORT
26−
27−
28−toReport :: Exit -> Help.Report
29−toReport exit =
30− case exit of
31− CannotMakeNothing ->
32− Help.report "NO INPUT" Nothing
33− "What should I make though? I need more information, like:"
34− [ D.vcat
35− [ D.indent 4 $ D.green "elm make src/Main.elm"
36− , D.indent 4 $ D.green "elm make src/This.elm src/That.elm"
37− ]
38− , D.reflow
39− "However many files you give, I will create one JS file out of them."
40− ]
41−
42− CannotOptimizeDebugValues m ms ->
43− Help.report "DEBUG REMNANTS" Nothing
44− "There are uses of the `Debug` module in the following modules:"
45− [ D.indent 4 $ D.red $ D.vcat $ map (D.fromString . ModuleName.nameToString) (m:ms)
46− , D.reflow "But the --optimize flag only works if all `Debug` functions are removed!"
47− , D.toSimpleNote $
48− "The issue is that --optimize strips out info needed by `Debug` functions.\
49− \ Here are two examples:"
50− , D.indent 4 $ D.reflow $
51− "(1) It shortens record field names. This makes the generated JavaScript is\
52− \ smaller, but `Debug.toString` cannot know the real field names anymore."
53− , D.indent 4 $ D.reflow $
54− "(2) Values like `type Height = Height Float` are unboxed. This reduces\
55− \ allocation, but it also means that `Debug.toString` cannot tell if it is\
56− \ looking at a `Height` or `Float` value."
57− , D.reflow $
58− "There are a few other cases like that, and it will be much worse once we start\
59− \ inlining code. That optimization could move `Debug.log` and `Debug.todo` calls,\
60− \ resulting in unpredictable behavior. I hope that clarifies why this restriction\
61− \ exists!"
62− ]
63−
64− CannotOptimizeAndDebug ->
65− Help.docReport "CLASHING FLAGS" Nothing
66− ( D.fillSep
67− ["I","cannot","compile","with",D.red "--optimize","and"
68− ,D.red "--debug","at","the","same","time."
69− ]
70− )
71− [ D.reflow
72− "I need to take away information to optimize things, and I need to\
73− \ add information to add the debugger. It is impossible to do both\
74− \ at once, so pick just one of those flags."
75− ]
builder/src/Reporting/Exit/Publish.hsdeleted−241
@@ -1,241 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Exit.Publish
3− ( Exit(..)
4− , toReport
5− )
6− where
7−
8−
9−import Deps.Diff (Magnitude, magnitudeToString)
10−import qualified Elm.Package as Pkg
11−import Reporting.Doc ((<>))
12−import qualified Reporting.Doc as D
13−import qualified Reporting.Exit.Help as Help
14−
15−
16−
17−-- EXITS
18−
19−
20−data Exit
21− = Application
22− | NotInitialVersion Pkg.Version
23− | AlreadyPublished Pkg.Version
24− | InvalidBump Pkg.Version Pkg.Version
25− | BadBump Pkg.Version Pkg.Version Magnitude Pkg.Version Magnitude
26− | NoSummary
27− | NoExposed
28− | NoReadme
29− | ShortReadme
30− | NoLicense
31− | MissingTag Pkg.Version
32− | NoGit
33− | LocalChanges Pkg.Version
34−
35−
36−
37−-- TO REPORT
38−
39−
40−toReport :: Exit -> Help.Report
41−toReport exit =
42− case exit of
43− Application ->
44− Help.report "UNPUBLISHABLE" Nothing "I cannot publish applications, only packages!" []
45−
46− NotInitialVersion vsn ->
47− Help.docReport "INVALID VERSION" Nothing
48− ( D.fillSep
49− ["I","cannot","publish"
50− ,D.red (D.fromString (Pkg.versionToString vsn))
51− ,"as","the","initial","version."
52− ]
53− )
54− [ D.fillSep
55− ["Change","it","to",D.green "1.0.0","which","is"
56− ,"the","initial","version","for","all","Elm","packages."
57− ]
58− ]
59−
60− AlreadyPublished vsn ->
61− Help.docReport "ALREADY PUBLISHED" Nothing
62− ( D.vcat
63− [ D.fillSep
64− [ "Version", D.green (D.fromString (Pkg.versionToString vsn))
65− , "has", "already", "been", "published.", "You", "cannot"
66− , "publish", "it", "again!"
67− ]
68− , "Try using the `bump` command:"
69− ]
70− )
71− [ D.dullyellow $ D.indent 4 "elm bump"
72− , D.reflow $
73− "It computes the version number based on API changes, ensuring\
74− \ that no breaking changes end up in PATCH releases!"
75− ]
76−
77− InvalidBump statedVersion latestVersion ->
78− Help.docReport "INVALID VERSION" (Just "elm.json")
79− ( D.fillSep $
80− ["Your","elm.json","says","the","next","version","should","be"
81− ,D.red (D.fromString (Pkg.versionToString statedVersion)) <> ","
82− ,"but","that","is","not","valid","based","on","the","previously"
83− ,"published","versions."
84− ]
85− )
86− [ D.fillSep $
87− ["Change","the","version","back","to"
88− ,D.green (D.fromString (Pkg.versionToString latestVersion))
89− ,"which","is","the","most","recently","published","version."
90− ,"From","there,","have","Elm","bump","the","version","by","running:"
91− ]
92− , D.indent 4 $ D.green "elm bump"
93− , D.reflow $
94− "If you want more insight on the API changes Elm detects, you\
95− \ can run `elm diff` at this point as well."
96− ]
97−
98− BadBump old new magnitude realNew realMagnitude ->
99− Help.docReport "INVALID VERSION" (Just "elm.json")
100− (
101− D.fillSep $
102− ["Your","elm.json","says","the","next","version","should","be"
103− ,D.red (D.fromString (Pkg.versionToString new)) <> ","
104− ,"indicating","a",D.fromString (magnitudeToString magnitude)
105− ,"change","to","the","public","API."
106− ,"This","does","not","match","the","API","diff","given","by:"
107− ]
108− )
109− [ D.indent 4 $ D.fromString $
110− "elm diff " ++ Pkg.versionToString old
111−
112− , D.fillSep $
113− ["This","command","says","this","is","a"
114− ,D.fromString (magnitudeToString realMagnitude)
115− ,"change,","so","the","next","version","should","be"
116− ,D.green (D.fromString (Pkg.versionToString realNew)) <> "."
117− ,"Double","check","everything","to","make","sure","you"
118− ,"are","publishing","what","you","want!"
119− ]
120− , D.reflow $
121− "Also, next time use `elm bump` and I'll figure all this out for you!"
122− ]
123−
124− NoSummary ->
125− Help.docReport "NO SUMMARY" (Just "elm.json")
126− ( D.fillSep $
127− [ "To", "publish", "a", "package,", "your", "elm.json", "must"
128− , "have", "a", D.dullyellow "\"summary\"", "field", "that", "gives"
129− , "a", "consice", "overview", "of", "your", "project."
130− ]
131− )
132− [ D.reflow $
133− "The summary must be less than 80 characters. It should describe\
134− \ the concrete use of your package as clearly and as plainly as possible."
135− ]
136−
137− NoExposed ->
138− Help.docReport "NO EXPOSED MODULES" (Just "elm.json")
139− ( D.fillSep $
140− [ "To", "publish", "a", "package,", "the"
141− , D.dullyellow "\"exposed-modules\"", "field", "of", "your"
142− , "elm.json", "must", "list", "at", "least", "one", "module."
143− ]
144− )
145− [ D.reflow $
146− "What is the point of a package that has no modules?!"
147− ]
148−
149− NoReadme ->
150− badReadmeReport "NO README" $
151− "Every published package must have a helpful README.md\
152− \ file, but I do not see one in your project."
153−
154− ShortReadme ->
155− badReadmeReport "SHORT README" $
156− "This README.md is too short. Having more details will help\
157− \ people assess your package quickly and fairly."
158−
159− NoLicense ->
160− Help.report "NO LICENSE FILE" (Just "LICENSE")
161− "By publishing a package you are inviting the Elm community to build\
162− \ upon your work. But without knowing your license, we have no idea if\
163− \ that is legal!"
164− [ D.reflow $
165− "Once you pick an OSI approved license from <https://spdx.org/licenses/>,\
166− \ you must share that choice in two places. First, the license\
167− \ identifier must appear in your elm.json file. Second, the full\
168− \ license text must appear in the root of your project in a file\
169− \ named LICENSE. Add that file and you will be all set!"
170− ]
171−
172− MissingTag version ->
173− let vsn = Pkg.versionToString version in
174− Help.docReport "NO TAG" Nothing
175− ( D.fillSep $
176− [ "Packages", "must", "be", "tagged", "in", "git,", "but", "I"
177− , "cannot", "find", "a", D.green (D.fromString vsn), "tag."
178− ]
179− )
180− [ D.vcat
181− [ "These tags make it possible to find this specific version on GitHub."
182− , "To tag the most recent commit and push it to GitHub, run this:"
183− ]
184− , D.indent 4 $ D.dullyellow $ D.vcat $ map D.fromString $
185− [ "git tag -a " ++ vsn ++ " -m \"new release\""
186− , "git push origin " ++ vsn
187− ]
188− , "The -m flag is for a helpful message. Try to make it more informative!"
189− ]
190−
191− NoGit ->
192− Help.report "NO GIT" Nothing
193− "I searched your PATH environment variable for `git` and could not\
194− \ find it. Is it available through your PATH?"
195− [ D.reflow $
196− "Who cares about this? Well, I currently use `git` to check if there\
197− \ are any local changes in your code. Local changes are a good sign\
198− \ that some important improvements have gotten mistagged, so this\
199− \ check can be extremely helpful for package authors!"
200− , D.toSimpleNote $
201− "We plan to do this without the `git` binary in a future release."
202− ]
203−
204− LocalChanges version ->
205− let vsn = Pkg.versionToString version in
206− Help.docReport "LOCAL CHANGES" Nothing
207− ( D.fillSep $
208− [ "The", "code", "tagged", "as", D.green (D.fromString vsn), "in"
209− , "git", "does", "not", "match", "the", "code", "in", "your"
210− , "working", "directory.", "This", "means", "you", "have"
211− , "commits", "or", "local", "changes", "that", "are", "not"
212− , "going", "to", "be", "published!"
213− ]
214− )
215− [ D.toSimpleNote $
216− "If you are sure everything is in order, you can run `git checkout "
217− ++ vsn ++ "` and publish your code from there."
218− ]
219−
220−
221−badReadmeReport :: String -> String -> Help.Report
222−badReadmeReport title summary =
223− Help.report title (Just "README.md") summary
224− [ D.reflow $
225− "When people look at your README, they are wondering:"
226− , D.vcat
227− [ " - What does this package even do?"
228− , " - Will it help me solve MY problems?"
229− ]
230− , D.reflow $
231− "So I recommend starting your README with a small example of the\
232− \ most common usage scenario. Show people what they can expect if\
233− \ they learn more!"
234− , D.toSimpleNote $
235− "By publishing your package, you are inviting people to invest time\
236− \ in understanding your work. Spending an hour to communicate your\
237− \ knowledge more clearly can save the community days or weeks of time\
238− \ in aggregate, and saving time in aggregate is the whole point of\
239− \ publishing packages! People really appreciate it, and it makes the\
240− \ whole ecosystem feel nicer!"
241− ]
builder/src/Reporting/Progress.hsdeleted−117
@@ -1,117 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module Reporting.Progress
3− ( Reporter(..)
4− , makeReporter
5− , silentReporter
6− , Msg(..)
7− , Progress(..)
8− , Outcome(..)
9− , PublishPhase(..)
10− , BumpPhase(..)
11− )
12− where
13−
14−
15−import Control.Concurrent.Chan (Chan, writeChan)
16−import Control.Concurrent.MVar (MVar, newEmptyMVar, readMVar)
17−import qualified Elm.ModuleName as ModuleName
18−import Deps.Diff (Magnitude)
19−import Elm.Package (Name, Version)
20−import qualified Reporting.Doc as D
21−import Reporting.Exit (Exit)
22−
23−
24−
25−-- REPORTER
26−
27−
28−data Reporter =
29− Reporter
30− { _tell :: Progress -> IO ()
31− , _ask :: D.Doc -> IO Bool
32− , _end :: Maybe Exit -> IO ()
33− }
34−
35−
36−makeReporter :: Chan Msg -> MVar () -> Reporter
37−makeReporter chan mvar =
38− let
39− tell progress =
40− writeChan chan (Progress progress)
41−
42− ask doc =
43− do var <- newEmptyMVar
44− writeChan chan (Ask doc var)
45− readMVar var
46−
47− end maybeError =
48− do writeChan chan (End maybeError)
49− readMVar mvar
50− in
51− Reporter tell ask end
52−
53−
54−silentReporter :: Reporter
55−silentReporter =
56− Reporter
57− (\_ -> return ())
58− (\_ -> return True)
59− (\_ -> return ())
60−
61−
62−
63−-- MESSAGES
64−
65−
66−data Msg
67− = Progress Progress
68− | Ask D.Doc (MVar Bool)
69− | End (Maybe Exit)
70−
71−
72−data Progress
73− -- download packages
74− = DownloadSkip
75− | DownloadStart [(Name, Version)]
76− | DownloadPkgStart Name Version
77− | DownloadPkgEnd Name Version Outcome
78− | DownloadEnd Outcome
79−
80− -- build dependencies
81− | BuildDepsStart Int
82− | BuildDepsProgress
83− | BuildDepsEnd
84−
85− -- compile files
86− | CompileStart Int
87− | CompileFileStart ModuleName.Raw
88− | CompileFileEnd ModuleName.Raw Outcome
89− | CompileEnd
90−
91− -- publish
92− | PublishStart Name Version (Maybe [Version])
93− | PublishCheckBump Version BumpPhase
94− | PublishProgress PublishPhase (Maybe Outcome)
95− | PublishEnd
96−
97− -- solver
98− | UnableToLoadLatestPackages
99−
100−
101−data Outcome = Good | Bad
102−
103−
104−data PublishPhase
105− = CheckReadme
106− | CheckLicense
107− | CheckTag Version
108− | CheckDownload
109− | CheckBuild
110− | CheckChanges
111−
112−
113−data BumpPhase
114− = StatedVersion
115− | GoodStart
116− | GoodBump Version Magnitude
117− | BadBump
builder/src/Reporting/Progress/Bar.hsdeleted−43
@@ -1,43 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module Reporting.Progress.Bar
3− ( render
4− , clear
5− )
6− where
7−
8−
9−
10−-- PROGRESS BAR
11−
12−
13−width :: Float
14−width =
15− 50.0
16−
17−
18−render :: Int -> Int -> Int -> String
19−render successes failures total =
20− let
21− numDone =
22− successes + failures
23−
24− fraction =
25− fromIntegral numDone / fromIntegral total
26−
27− unitsDone =
28− truncate (fraction * width)
29−
30− unitsLeft =
31− truncate width - unitsDone
32− in
33− "\r["
34− ++ replicate unitsDone '='
35− ++ replicate unitsLeft ' '
36− ++ "] - "
37− ++ show numDone ++ " / " ++ show total
38−
39−
40−clear :: String
41−clear =
42− '\r' : replicate (length (render 49999 50000 99999)) ' ' ++ "\r"
43−
builder/src/Reporting/Progress/Json.hsdeleted−34
@@ -1,34 +0,0 @@
1−module Reporting.Progress.Json
2− ( reporter
3− )
4− where
5−
6−
7−import qualified Data.ByteString.Builder as B
8−import System.IO (stderr)
9−
10−import qualified Reporting.Exit as Exit
11−import qualified Reporting.Progress as Progress
12−import qualified Json.Encode as Encode
13−
14−
15−
16−-- REPORTER
17−
18−
19−reporter :: Progress.Reporter
20−reporter =
21− Progress.Reporter
22− (\_ -> return ())
23− (\_ -> return True)
24− end
25−
26−
27−end :: Maybe Exit.Exit -> IO ()
28−end maybeExit =
29− case maybeExit of
30− Just exit ->
31− B.hPutBuilder stderr (Encode.encodeUgly (Exit.toJson exit))
32−
33− Nothing ->
34− return ()
builder/src/Reporting/Progress/Repl.hsdeleted−30
@@ -1,30 +0,0 @@
1−module Reporting.Progress.Repl
2− ( reporter
3− )
4− where
5−
6−
7−import qualified Reporting.Exit as Exit
8−import qualified Reporting.Progress as Progress
9−
10−
11−
12−-- REPORTER
13−
14−
15−reporter :: Progress.Reporter
16−reporter =
17− Progress.Reporter
18− (\_ -> return ())
19− (\_ -> return True)
20− end
21−
22−
23−end :: Maybe Exit.Exit -> IO ()
24−end maybeExit =
25− case maybeExit of
26− Just exit ->
27− Exit.toStderr exit
28−
29− Nothing ->
30− return ()
builder/src/Reporting/Progress/Terminal.hsdeleted−379
@@ -1,379 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Reporting.Progress.Terminal
3− ( create
4− , newPackageOverview
5− )
6− where
7−
8−
9−import Control.Concurrent (forkIO)
10−import Control.Concurrent.Chan (Chan, newChan, readChan)
11−import Control.Concurrent.MVar (newEmptyMVar, putMVar)
12−import qualified System.Info as Info
13−import System.IO (hFlush, hPutStr, stdout)
14−import qualified Elm.Package as Pkg
15−import Elm.Package (Name, Version)
16−
17−import qualified Deps.Diff as Diff
18−import Reporting.Doc ((<>), (<+>))
19−import qualified Reporting.Doc as D
20−import qualified Reporting.Exit as Exit
21−import qualified Reporting.Exit.Help as Help
22−import Reporting.Progress (Msg(..), Progress(..), Outcome(..), PublishPhase(..), BumpPhase(..))
23−import qualified Reporting.Progress as Progress
24−import qualified Reporting.Progress.Bar as Bar
25−
26−
27−
28−-- CREATE
29−
30−
31−create :: IO Progress.Reporter
32−create =
33− do chan <- newChan
34− mvar <- newEmptyMVar
35− _ <- forkIO (loop chan (State 0 0 0) >>= putMVar mvar)
36− return (Progress.makeReporter chan mvar)
37−
38−
39−
40−-- STATE
41−
42−
43−data State =
44− State
45− { _total :: !Int
46− , _good :: !Int
47− , _bad :: !Int
48− }
49−
50−
51−
52−-- LOOP
53−
54−
55−loop :: Chan Msg -> State -> IO ()
56−loop chan state =
57− do msg <- readChan chan
58− case msg of
59− End (Just exit) ->
60− Exit.toStderr exit
61−
62− End Nothing ->
63− return ()
64−
65− Ask doc mvar ->
66− do Help.toStdout doc
67− putMVar mvar =<< getApproval
68− loop chan state
69−
70− Progress progress ->
71− loopHelp chan progress state
72−
73−
74−getApproval :: IO Bool
75−getApproval =
76− do hFlush stdout
77− input <- getLine
78− case input of
79− "" -> return True
80− "Y" -> return True
81− "y" -> return True
82− "n" -> return False
83− _ ->
84− do putStr "Must type 'y' for yes or 'n' for no: "
85− getApproval
86−
87−
88−loopHelp :: Chan Msg -> Progress -> State -> IO ()
89−loopHelp chan progress state@(State total good bad) =
90− case progress of
91−
92−
93− -- DOWNLOADS
94−
95− DownloadSkip ->
96− do putStrLn "Dependencies loaded from local cache."
97− loop chan state
98−
99− DownloadStart [] ->
100− loop chan state
101−
102− DownloadStart _ ->
103− do putStrLn "Starting downloads...\n"
104− loop chan state
105−
106− DownloadPkgStart _name _version ->
107− loop chan state
108−
109− DownloadPkgEnd name version outcome ->
110− do Help.toStdout (makeBullet name version outcome)
111− loop chan state
112−
113− DownloadEnd Bad ->
114− do putStrLn ""
115− loop chan state
116−
117− DownloadEnd Good ->
118− do putStrLn ""
119− loop chan state
120−
121−
122− -- BUILD DEPS
123−
124− BuildDepsStart size ->
125− do hPutStr stdout "Verifying dependencies..."
126− hFlush stdout
127− loop chan (State size 0 0)
128−
129− BuildDepsProgress ->
130− do let n = good + 1
131− let msg = "\rBuilding dependencies (" ++ show n ++ "/" ++ show total ++ ")"
132− hPutStr stdout msg
133− hFlush stdout
134− loop chan (State total n 0)
135−
136− BuildDepsEnd ->
137− do putStrLn "\rDependencies ready! "
138− loop chan (State 0 0 0)
139−
140−
141− -- COMPILE
142−
143− CompileStart size ->
144− loop chan (State size 0 0)
145−
146− CompileFileStart _ ->
147− loop chan state
148−
149− CompileFileEnd _ Good ->
150− do hPutStr stdout $ Bar.render (good + 1) bad total
151− hFlush stdout
152− loop chan (State total (good + 1) bad)
153−
154− CompileFileEnd _ Bad ->
155− do hPutStr stdout $ Bar.render good (bad + 1) total
156− hFlush stdout
157− loop chan (State total good (bad + 1))
158−
159− CompileEnd ->
160− let
161− message =
162− case (bad, total) of
163− (0, 0) -> "Success!"
164− (0, 1) -> "Success! Compiled 1 module."
165− (0, n) -> "Success! Compiled " ++ show n ++ " modules."
166− (1, _) -> "Detected errors in 1 module."
167− (n, _) -> "Detected errors in " ++ show n ++ " modules."
168− in
169− do hPutStr stdout $ Bar.clear
170− putStrLn message
171− loop chan (State 0 0 0)
172−
173−
174− -- PUBLISH
175−
176− PublishStart name version maybePublishedVersions ->
177− case maybePublishedVersions of
178− Nothing ->
179− do putStrLn newPackageOverview
180− putStrLn "I will now verify that everything is in order..."
181− putStrLn ""
182− loop chan state
183−
184− Just _ ->
185− do putStrLn $ unwords [ "Verifying", Pkg.toString name, Pkg.versionToString version, "..." ]
186− putStrLn ""
187− loop chan state
188−
189− PublishCheckBump version bumpPhase ->
190− do Help.toStdout $ bumpPhaseToChecklistDoc version bumpPhase
191− hFlush stdout
192− loop chan state
193−
194− PublishProgress phase status ->
195− do Help.toStdout $ toChecklistDoc status (toChecklistMessages phase)
196− hFlush stdout
197− loop chan state
198−
199− PublishEnd ->
200− do putStrLn "Success!"
201− loop chan state
202−
203−
204− -- SOLVER
205−
206− UnableToLoadLatestPackages ->
207− do putStrLn ""
208− Help.toStdout $ D.dullyellow "WARNING:" <+> "I normally check <https://package.elm-lang.org> for new packages\n"
209− putStrLn "here, but my request failed. Are you offline? I will try to continue anyway.\n"
210− loop chan state
211−
212−
213−
214−-- BULLETS
215−
216−
217−makeBullet :: Name -> Version -> Outcome -> D.Doc
218−makeBullet name version outcome =
219− let
220− nm = D.fromText (Pkg.toText name)
221− vsn = D.fromText (Pkg.versionToText version)
222−
223− bullet =
224− case outcome of
225− Good -> goodMark
226− Bad -> badMark
227− in
228− D.indent 2 $ bullet <+> nm <+> vsn <> "\n"
229−
230−
231−goodMark :: D.Doc
232−goodMark =
233− D.green $
234− if Info.os == "mingw32" then "+" else "●"
235−
236−
237−badMark :: D.Doc
238−badMark =
239− D.red $
240− if Info.os == "mingw32" then "X" else "✗"
241−
242−
243−waitingMark :: D.Doc
244−waitingMark =
245− D.dullyellow $
246− if Info.os == "mingw32" then "-" else "→"
247−
248−
249−
250−-- OVERVIEW OF VERSIONING
251−
252−
253−newPackageOverview :: String
254−newPackageOverview =
255− unlines
256− [ "This package has never been published before. Here's how things work:"
257− , ""
258− , " - Versions all have exactly three parts: MAJOR.MINOR.PATCH"
259− , ""
260− , " - All packages start with initial version " ++ Pkg.versionToString Pkg.initialVersion
261− , ""
262− , " - Versions are incremented based on how the API changes:"
263− , ""
264− , " PATCH = the API is the same, no risk of breaking code"
265− , " MINOR = values have been added, existing values are unchanged"
266− , " MAJOR = existing values have been changed or removed"
267− , ""
268− , " - I will bump versions for you, automatically enforcing these rules"
269− , ""
270− ]
271−
272−
273−
274−-- CHECKLIST
275−
276−
277−toChecklistDoc :: Maybe Outcome -> ChecklistMessages -> D.Doc
278−toChecklistDoc status (ChecklistMessages waiting success failure) =
279− let
280− padded message =
281− message ++ replicate (length waiting - length message) ' '
282− in
283− case status of
284− Nothing ->
285− " " <> waitingMark <+> D.fromString waiting
286−
287− Just Good ->
288− "\r " <> goodMark <+> D.fromString (padded success ++ "\n")
289−
290− Just Bad ->
291− "\r " <> badMark <+> D.fromString (padded failure ++ "\n\n")
292−
293−
294−data ChecklistMessages =
295− ChecklistMessages
296− { _waiting :: String
297− , _success :: String
298− , _failure :: String
299− }
300−
301−
302−toChecklistMessages :: PublishPhase -> ChecklistMessages
303−toChecklistMessages phase =
304− case phase of
305− CheckReadme ->
306− ChecklistMessages
307− "Looking for README.md"
308− "Found README.md"
309− "Problem with your README.md"
310−
311− CheckLicense ->
312− ChecklistMessages
313− "Looking for LICENSE"
314− "Found LICENSE"
315− "Problem with your LICENSE"
316−
317− CheckTag version ->
318− ChecklistMessages
319− ("Is version " ++ Pkg.versionToString version ++ " tagged on GitHub?")
320− ("Version " ++ Pkg.versionToString version ++ " is tagged on GitHub")
321− ("Version " ++ Pkg.versionToString version ++ " is not tagged on GitHub!")
322−
323− CheckDownload ->
324− ChecklistMessages
325− "Downloading code from GitHub..."
326− "Code downloaded successfully from GitHub"
327− "Could not download code from GitHub!"
328−
329− CheckBuild ->
330− ChecklistMessages
331− "Building downloaded code and generated docs..."
332− "Downloaded code compiles successfully / docs generated\n"
333− "Cannot compile downloaded code!"
334−
335− CheckChanges ->
336− ChecklistMessages
337− "Checking for uncommitted changes..."
338− "No uncommitted changes in local code"
339− "Your local code is different than the code tagged on GitHub"
340−
341−
342−
343−-- BUMP PHASE
344−
345−
346−bumpPhaseToChecklistDoc :: Pkg.Version -> BumpPhase -> D.Doc
347−bumpPhaseToChecklistDoc version bumpPhase =
348− let
349− mkMsgs success =
350− ChecklistMessages
351− ("Checking semantic versioning rules. Is " ++ Pkg.versionToString version ++ " correct?")
352− success
353− ("Version " ++ Pkg.versionToString version ++ " is not correct!")
354− in
355−
356− case bumpPhase of
357− StatedVersion ->
358− toChecklistDoc Nothing $ mkMsgs ""
359−
360− GoodStart ->
361− toChecklistDoc (Just Good) $ mkMsgs $
362− "All packages start at version " ++ Pkg.versionToString Pkg.initialVersion
363−
364− GoodBump old magnitude ->
365− toChecklistDoc (Just Good) $ mkMsgs $
366− toCheckVersionSuccessMessage old version magnitude
367−
368− BadBump ->
369− toChecklistDoc (Just Bad) $ mkMsgs ""
370−
371−
372−toCheckVersionSuccessMessage :: Pkg.Version -> Pkg.Version -> Diff.Magnitude -> String
373−toCheckVersionSuccessMessage oldVersion newVersion magnitude =
374− let
375− old = Pkg.versionToString oldVersion
376− new = Pkg.versionToString newVersion
377− mag = Diff.magnitudeToString magnitude
378− in
379− "Version number " ++ new ++ " verified (" ++ mag ++ " change, " ++ old ++ " => " ++ new ++ ")"
builder/src/Reporting/Task.hs+76−151
@@ -1,189 +1,114 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE Rank2Types #-}
22module Reporting.Task
3− ( Task, Task_
4− , try
3+ ( Task
54 , run
65 , throw
76 , mapError
8− , Env
9− , getPackageCacheDir
10− , getPackageCacheDirFor
11− , report
12− , getReporter
13− , getApproval
14− , silently
15− , getSilentRunner
16− , workerChan
17− , runHttp
7+ --
8+ , io
9+ , mio
10+ , eio
1811 )
1912 where
2013
21−import Control.Concurrent (forkIO)
22−import Control.Concurrent.Chan (Chan, newChan, readChan, writeChan)
23−import Control.Monad (forever, join, replicateM_)
24−import Control.Monad.Except (ExceptT, runExceptT, throwError, withExceptT)
25−import qualified Control.Monad.Reader as R
26−import Control.Monad.Trans (liftIO)
27−import qualified Network.HTTP.Client as Http
28−import qualified Network.HTTP.Client.TLS as Http
29−import qualified System.Directory as Dir
30−import qualified System.Exit as Exit
31−import System.FilePath ((</>))
32−
33−import Elm.Package (Name, Version)
34−import qualified Elm.Package as Pkg
35−import qualified Elm.PerUserCache as PerUserCache
36−import qualified Reporting.Doc as D
37−import qualified Reporting.Exit as Exit
38−import qualified Reporting.Progress as Progress
39−
4014
4115
4216-- TASKS
4317
4418
45−type Task =
46− Task_ Exit.Exit
47−
48−
49−type Task_ e =
50− ExceptT e (R.ReaderT Env IO)
51−
52−
53−data Env =
54− Env
55− { _cacheDir :: FilePath
56− , _worker :: IO () -> IO ()
57− , _httpManager :: Http.Manager
58− , _tell :: Progress.Progress -> IO ()
59− , _ask :: D.Doc -> IO Bool
60− }
61−
62−
63−try :: Progress.Reporter -> Task a -> IO (Maybe a)
64−try (Progress.Reporter tell ask end) task =
65− do root <- PerUserCache.getPackageRoot
66− pool <- initPool 4
67− httpManager <- Http.newManager Http.tlsManagerSettings
68− let env = Env root pool httpManager tell ask
69− result <- R.runReaderT (runExceptT task) env
70− case result of
71− Left err ->
72− do end (Just err)
73− return Nothing
74−
75− Right answer ->
76− do end Nothing
77− return (Just answer)
78−
79−
80−run :: Progress.Reporter -> Task a -> IO ()
81−run reporter task =
82− do maybeAnswer <- try reporter task
83− case maybeAnswer of
84− Nothing -> Exit.exitFailure
85− Just _ -> return ()
86−
87−
88−throw :: e -> Task_ e a
89−throw =
90− throwError
91−
92−
93−mapError :: (x -> y) -> Task_ x a -> Task_ y a
94−mapError =
95− withExceptT
96−
97−
98−
99−-- CACHING
100−
101−
102−getPackageCacheDir :: Task_ e FilePath
103−getPackageCacheDir =
104− R.asks _cacheDir
105−
106−
107−getPackageCacheDirFor :: Name -> Version -> Task_ e FilePath
108−getPackageCacheDirFor name version =
109− do cacheDir <- getPackageCacheDir
110− let dir = cacheDir </> Pkg.toFilePath name </> Pkg.versionToString version
111− liftIO (Dir.createDirectoryIfMissing True dir)
112− return dir
113−
114−
115−
116−-- REPORTER
117−
118−
119−report :: Progress.Progress -> Task_ e ()
120−report progress =
121− do tell <- R.asks _tell
122− liftIO (tell progress)
123−
124−
125−getReporter :: Task (Progress.Progress -> IO ())
126−getReporter =
127− R.asks _tell
128−
19+newtype Task x a =
20+ Task
21+ (
22+ forall result. (a -> IO result) -> (x -> IO result) -> IO result
23+ )
12924
13025
131−-- APPROVAL
26+run :: Task x a -> IO (Either x a)
27+run (Task task) =
28+ task (return . Right) (return . Left)
13229
13330
134−getApproval :: D.Doc -> Task_ e Bool
135−getApproval doc =
136− do ask <- R.asks _ask
137− liftIO (ask doc)
31+throw :: x -> Task x a
32+throw x =
33+ Task $ \_ err -> err x
13834
13935
36+mapError :: (x -> y) -> Task x a -> Task y a
37+mapError func (Task task) =
38+ Task $ \ok err ->
39+ task ok (err . func)
14040
141−-- RUNNER
14241
14342
144−silently :: Task_ e a -> Task_ e a
145−silently task =
146− do runner <- getSilentRunner
147− result <- liftIO (runner task)
148− either throw return result
43+-- IO
14944
15045
151−getSilentRunner :: Task_ x (Task_ e a -> IO (Either e a))
152−getSilentRunner =
153− do env <- R.ask
154− let silentEnv = env { _tell = \_ -> return () }
155− return $ \task -> R.runReaderT (runExceptT task) silentEnv
46+{-# INLINE io #-}
47+io :: IO a -> Task x a
48+io work =
49+ Task $ \ok _ -> work >>= ok
15650
15751
52+mio :: x -> IO (Maybe a) -> Task x a
53+mio x work =
54+ Task $ \ok err ->
55+ do result <- work
56+ case result of
57+ Just a -> ok a
58+ Nothing -> err x
15859
159−-- THREAD POOL
16060
61+eio :: (x -> y) -> IO (Either x a) -> Task y a
62+eio func work =
63+ Task $ \ok err ->
64+ do result <- work
65+ case result of
66+ Right a -> ok a
67+ Left x -> err (func x)
16168
162−workerChan :: Chan (Either e a) -> Task_ e a -> Task_ x ()
163−workerChan chan task =
164− do env <- R.ask
16569
166− liftIO $ _worker env $
167− do result <- R.runReaderT (runExceptT task) env
168− writeChan chan result
16970
71+-- INSTANCES
17072
171−initPool :: Int -> IO (IO () -> IO ())
172−initPool size =
173− do chan <- newChan
17473
175− replicateM_ size $ forkIO $ forever $
176− join (readChan chan)
74+instance Functor (Task x) where
75+ {-# INLINE fmap #-}
76+ fmap func (Task taskA) =
77+ Task $ \ok err ->
78+ let
79+ okA arg = ok (func arg)
80+ in
81+ taskA okA err
17782
178− return $ writeChan chan
17983
84+instance Applicative (Task x) where
85+ {-# INLINE pure #-}
86+ pure a =
87+ Task $ \ok _ -> ok a
18088
89+ {-# INLINE (<*>) #-}
90+ (<*>) (Task taskFunc) (Task taskArg) =
91+ Task $ \ok err ->
92+ let
93+ okFunc func =
94+ let
95+ okArg arg = ok (func arg)
96+ in
97+ taskArg okArg err
98+ in
99+ taskFunc okFunc err
181100
182−-- HTTP
183101
102+instance Monad (Task x) where
103+ {-# INLINE return #-}
104+ return = pure
184105
185−runHttp :: (Http.Manager -> (Progress.Progress -> IO ()) -> IO (Either Exit.Exit a)) -> Task a
186−runHttp fetcher =
187− do (Env _ _ manager tell _) <- R.ask
188− result <- liftIO $ fetcher manager tell
189− either throwError return result
106+ {-# INLINE (>>=) #-}
107+ (>>=) (Task taskA) callback =
108+ Task $ \ok err ->
109+ let
110+ okA a =
111+ case callback a of
112+ Task taskB -> taskB ok err
113+ in
114+ taskA okA err
builder/src/Reporting/Task/Http.hsdeleted−195
@@ -1,195 +0,0 @@
1−{-# LANGUAGE GADTs #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module Reporting.Task.Http
4− ( Fetch
5− , Handler
6− , run
7− , package
8− , anything
9− , andThen
10− , parallel
11− , report
12− )
13− where
14−
15−
16−import Control.Concurrent (forkIO)
17−import Control.Concurrent.Chan (Chan, newChan, readChan, writeChan)
18−import Control.Concurrent.MVar (MVar, newEmptyMVar, putMVar, readMVar)
19−import Control.Exception (Exception, SomeException, catch)
20−import Control.Monad (forever, join, replicateM_, void)
21−import qualified Data.ByteString.Char8 as BS
22−import qualified Network.HTTP as Http (urlEncodeVars)
23−import qualified Network.HTTP.Client as Http
24−import qualified Network.HTTP.Types.Header as Http (hAcceptEncoding, hUserAgent)
25−
26−import qualified Elm.Compiler as Compiler
27−import qualified Elm.Package as Pkg
28−import qualified Reporting.Exit as Exit
29−import qualified Reporting.Exit.Http as E
30−import qualified Reporting.Progress as Progress
31−import qualified Reporting.Task as Task
32−
33−
34−
35−-- FETCH
36−
37−
38−data Fetch a where
39− Package :: String -> [(String,String)] -> Handler a -> Fetch a
40− Anything :: String -> Handler a -> Fetch a
41− AndThen :: Fetch a -> (a -> Fetch b) -> Fetch b
42− Parallel :: [Fetch a] -> Fetch [a]
43− Report :: Progress.Progress -> (Progress.Outcome -> Progress.Progress) -> Fetch a -> Fetch a
44−
45−
46−type Handler a =
47− Http.Request -> Http.Manager -> IO (Either E.Exit a)
48−
49−
50−package :: String -> [(String,String)] -> Handler a -> Fetch a
51−package =
52− Package
53−
54−
55−anything :: String -> Handler a -> Fetch a
56−anything =
57− Anything
58−
59−
60−andThen :: Fetch a -> (a -> Fetch b) -> Fetch b
61−andThen =
62− AndThen
63−
64−
65−parallel :: [Fetch a] -> Fetch [a]
66−parallel =
67− Parallel
68−
69−
70−report :: Progress.Progress -> (Progress.Outcome -> Progress.Progress) -> Fetch a -> Fetch a
71−report =
72− Report
73−
74−
75−
76−-- RUN
77−
78−
79−run :: Fetch a -> Task.Task a
80−run fetch =
81− Task.runHttp $ \manager tell ->
82− do chan <- newChan
83− replicateM_ 4 $ forkIO $ forever $ join (readChan chan)
84− readMVar =<< runHelp chan manager tell fetch
85−
86−
87−runHelp :: Chan (IO ()) -> Http.Manager -> (Progress.Progress -> IO ()) -> Fetch a -> IO (MVar (Either Exit.Exit a))
88−runHelp chan manager tell fetch =
89− case fetch of
90− Package path params handler ->
91− do mvar <- newEmptyMVar
92− let url = makePackageUrl path params
93− writeChan chan $ putMVar mvar =<< fetchSafe url manager handler
94− return mvar
95−
96− Anything url handler ->
97− do mvar <- newEmptyMVar
98− writeChan chan $ putMVar mvar =<< fetchSafe url manager handler
99− return mvar
100−
101− AndThen subFetch callback ->
102− do subMVar <- runHelp chan manager tell subFetch
103− mvar <- newEmptyMVar
104− void $ forkIO $
105− do result <- readMVar subMVar
106− putMVar mvar =<<
107− case result of
108− Left err ->
109− return (Left err)
110− Right value ->
111− readMVar =<< runHelp chan manager tell (callback value)
112− return mvar
113−
114− Parallel fetches ->
115− do mvars <- mapM (runHelp chan manager tell) fetches
116− mvar <- newEmptyMVar
117− void $ forkIO $
118− do results <- mapM readMVar mvars
119− putMVar mvar (sequence results)
120− return mvar
121−
122− Report start toEnd subFetch ->
123− do tell start
124− subMVar <- runHelp chan manager tell subFetch
125− mvar <- newEmptyMVar
126− void $ forkIO $
127− do result <- readMVar subMVar
128− tell $ toEnd $
129− either (\_ -> Progress.Bad) (\_ -> Progress.Good) result
130− putMVar mvar result
131− return mvar
132−
133−
134−
135−-- PACKAGE URLS
136−
137−
138−packageDomain :: String
139−packageDomain =
140− "https://package.elm-lang.org"
141−
142−
143−makePackageUrl :: String -> [(String,String)] -> String
144−makePackageUrl path params =
145− let
146− query =
147− if null params then
148− ""
149− else
150− "?" ++ Http.urlEncodeVars params
151− in
152− packageDomain ++ "/" ++ path ++ query
153−
154−
155−
156−-- HTTP HELP
157−
158−
159−fetchSafe :: String -> Http.Manager -> Handler a -> IO (Either Exit.Exit a)
160−fetchSafe url manager handler =
161− fetchUnsafe url manager handler
162− `catch` \e -> handleAnyError url (e :: SomeException)
163−
164−
165−fetchUnsafe :: String -> Http.Manager -> Handler a -> IO (Either Exit.Exit a)
166−fetchUnsafe url manager handler =
167− do request <- Http.parseUrlThrow url
168− result <- handler (addHeaders request) manager
169− case result of
170− Right value ->
171− return (Right value)
172−
173− Left problem ->
174− return (Left (Exit.BadHttp url problem))
175−
176−
177−handleAnyError :: (Exception e) => String -> e -> IO (Either Exit.Exit a)
178−handleAnyError url exception =
179− return $ Left $ Exit.BadHttp url $ E.Unknown $ show exception
180−
181−
182−addHeaders :: Http.Request -> Http.Request
183−addHeaders request =
184− request
185− { Http.requestHeaders =
186− [ (Http.hUserAgent, userAgent)
187− , (Http.hAcceptEncoding, "gzip")
188− ]
189− }
190−
191−
192−{-# NOINLINE userAgent #-}
193−userAgent :: BS.ByteString
194−userAgent =
195− BS.pack ("elm/" ++ Pkg.versionToString Compiler.version)
builder/src/Stuff.hsnew file+179
@@ -0,0 +1,179 @@
1+{-# OPTIONS_GHC -Wall #-}
2+module Stuff
3+ ( details
4+ , interfaces
5+ , objects
6+ , prepublishDir
7+ , elmi
8+ , elmo
9+ , temp
10+ , findRoot
11+ , withRootLock
12+ , withRegistryLock
13+ , PackageCache
14+ , getPackageCache
15+ , registry
16+ , package
17+ , getReplCache
18+ , getElmHome
19+ )
20+ where
21+
22+
23+import qualified System.Directory as Dir
24+import qualified System.Environment as Env
25+import qualified System.FileLock as Lock
26+import qualified System.FilePath as FP
27+import System.FilePath ((</>), (<.>))
28+
29+import qualified Elm.ModuleName as ModuleName
30+import qualified Elm.Package as Pkg
31+import qualified Elm.Version as V
32+
33+
34+
35+-- PATHS
36+
37+
38+stuff :: FilePath -> FilePath
39+stuff root =
40+ root </> "elm-stuff" </> compilerVersion
41+
42+
43+details :: FilePath -> FilePath
44+details root =
45+ stuff root </> "d.dat"
46+
47+
48+interfaces :: FilePath -> FilePath
49+interfaces root =
50+ stuff root </> "i.dat"
51+
52+
53+objects :: FilePath -> FilePath
54+objects root =
55+ stuff root </> "o.dat"
56+
57+
58+prepublishDir :: FilePath -> FilePath
59+prepublishDir root =
60+ stuff root </> "prepublish"
61+
62+
63+compilerVersion :: FilePath
64+compilerVersion =
65+ V.toChars V.compiler
66+
67+
68+
69+-- ELMI and ELMO
70+
71+
72+elmi :: FilePath -> ModuleName.Raw -> FilePath
73+elmi root name =
74+ toArtifactPath root name "elmi"
75+
76+
77+elmo :: FilePath -> ModuleName.Raw -> FilePath
78+elmo root name =
79+ toArtifactPath root name "elmo"
80+
81+
82+toArtifactPath :: FilePath -> ModuleName.Raw -> String -> FilePath
83+toArtifactPath root name ext =
84+ stuff root </> ModuleName.toHyphenPath name <.> ext
85+
86+
87+
88+-- TEMP
89+
90+
91+temp :: FilePath -> String -> FilePath
92+temp root ext =
93+ stuff root </> "temp" <.> ext
94+
95+
96+
97+-- ROOT
98+
99+
100+findRoot :: IO (Maybe FilePath)
101+findRoot =
102+ do dir <- Dir.getCurrentDirectory
103+ findRootHelp (FP.splitDirectories dir)
104+
105+
106+findRootHelp :: [String] -> IO (Maybe FilePath)
107+findRootHelp dirs =
108+ case dirs of
109+ [] ->
110+ return Nothing
111+
112+ _:_ ->
113+ do exists <- Dir.doesFileExist (FP.joinPath dirs </> "elm.json")
114+ if exists
115+ then return (Just (FP.joinPath dirs))
116+ else findRootHelp (init dirs)
117+
118+
119+
120+-- LOCKS
121+
122+
123+withRootLock :: FilePath -> IO a -> IO a
124+withRootLock root work =
125+ do let dir = stuff root
126+ Dir.createDirectoryIfMissing True dir
127+ Lock.withFileLock (dir </> "lock") Lock.Exclusive (\_ -> work)
128+
129+
130+withRegistryLock :: PackageCache -> IO a -> IO a
131+withRegistryLock (PackageCache dir) work =
132+ Lock.withFileLock (dir </> "lock") Lock.Exclusive (\_ -> work)
133+
134+
135+
136+-- PACKAGE CACHES
137+
138+
139+newtype PackageCache = PackageCache FilePath
140+
141+
142+getPackageCache :: IO PackageCache
143+getPackageCache =
144+ PackageCache <$> getCacheDir "packages"
145+
146+
147+registry :: PackageCache -> FilePath
148+registry (PackageCache dir) =
149+ dir </> "registry.dat"
150+
151+
152+package :: PackageCache -> Pkg.Name -> V.Version -> FilePath
153+package (PackageCache dir) name version =
154+ dir </> Pkg.toFilePath name </> V.toChars version
155+
156+
157+
158+-- CACHE
159+
160+
161+getReplCache :: IO FilePath
162+getReplCache =
163+ getCacheDir "repl"
164+
165+
166+getCacheDir :: FilePath -> IO FilePath
167+getCacheDir projectName =
168+ do home <- getElmHome
169+ let root = home </> compilerVersion </> projectName
170+ Dir.createDirectoryIfMissing True root
171+ return root
172+
173+
174+getElmHome :: IO FilePath
175+getElmHome =
176+ do maybeCustomHome <- Env.lookupEnv "ELM_HOME"
177+ case maybeCustomHome of
178+ Just customHome -> return customHome
179+ Nothing -> Dir.getAppUserDataDirectory "elm"
builder/src/Stuff/Paths.hsdeleted−93
@@ -1,93 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module Stuff.Paths
3− ( docs
4− , summary
5− , prepublishDir
6− , removeStuff
7− , elmi
8− , elmo
9− , moduleDocs
10− , temp
11− )
12− where
13−
14−
15−import Control.Monad.Trans (liftIO)
16−import qualified System.Directory as Dir
17−import System.FilePath ((</>), (<.>))
18−
19−import qualified Elm.Compiler as Compiler
20−import qualified Elm.ModuleName as ModuleName
21−import qualified Elm.Package as Pkg
22−import qualified Reporting.Task as Task
23−
24−
25−
26−-- PATHS
27−
28−
29−stuff :: FilePath
30−stuff =
31− "elm-stuff" </> Pkg.versionToString Compiler.version
32−
33−
34−docs :: FilePath
35−docs =
36− stuff </> "docs.json"
37−
38−
39−summary :: FilePath
40−summary =
41− stuff </> "summary.dat"
42−
43−
44−prepublishDir :: FilePath
45−prepublishDir =
46− stuff </> "prepublish"
47−
48−
49−
50−-- REMOVE STUFF
51−
52−
53−removeStuff :: FilePath -> Task.Task_ e ()
54−removeStuff root =
55− liftIO $
56− do let dir = root </> "elm-stuff"
57− exists <- Dir.doesDirectoryExist dir
58− if exists
59− then Dir.removeDirectoryRecursive dir
60− else return ()
61−
62−
63−
64−-- ELMI and ELMO
65−
66−
67−elmi :: FilePath -> ModuleName.Raw -> FilePath
68−elmi root name =
69− toArtifactPath root name "elmi"
70−
71−
72−elmo :: FilePath -> ModuleName.Raw -> FilePath
73−elmo root name =
74− toArtifactPath root name "elmo"
75−
76−
77−moduleDocs :: FilePath -> ModuleName.Raw -> FilePath
78−moduleDocs root name =
79− toArtifactPath root name "json"
80−
81−
82−toArtifactPath :: FilePath -> ModuleName.Raw -> String -> FilePath
83−toArtifactPath root name ext =
84− root </> stuff </> ModuleName.nameToHyphenPath name <.> ext
85−
86−
87−
88−-- TEMP
89−
90−
91−temp :: String -> FilePath
92−temp ext =
93− stuff </> "temp" <.> ext
builder/src/Stuff/Verify.hsdeleted−119
@@ -1,119 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module Stuff.Verify
3− ( verify
4− )
5− where
6−
7−
8−import Control.Monad (liftM2, liftM4)
9−import Data.Binary
10−import Data.Map (Map)
11−
12−import qualified Deps.Verify as Verify
13−import qualified Elm.Interface as I
14−import Elm.Package (Name, Version)
15−import qualified Elm.Project.Json as Project
16−import qualified Elm.Project.Constraint as Con
17−import qualified Elm.Project.Summary as Summary
18−import qualified File.IO as IO
19−import qualified Reporting.Task as Task
20−import qualified Stuff.Paths as Path
21−
22−
23−
24−-- VERIFY
25−
26−
27−verify :: FilePath -> Project.Project -> Task.Task Summary.Summary
28−verify root project =
29− do exists <- IO.exists Path.summary
30− if exists
31− then
32− do (MiniSummary deps exposed ifaces graph) <- IO.readBinary Path.summary
33− if isValidMiniSummary deps project
34− then
35− return (Summary.Summary root project exposed ifaces graph)
36− else
37− do IO.remove Path.summary
38− cacheSummary root project
39− else
40− cacheSummary root project
41−
42−
43−cacheSummary :: FilePath -> Project.Project -> Task.Task Summary.Summary
44−cacheSummary root project =
45− do summary@(Summary.Summary _ _ exposed ifaces graph) <- Verify.verify root project
46− IO.writeBinary Path.summary (MiniSummary (getDeps project) exposed ifaces graph)
47− return summary
48−
49−
50−
51−-- MINI SUMMARY
52−
53−
54−data MiniSummary =
55− MiniSummary
56− { _deps :: ProjectDeps
57− , _exposed :: Summary.ExposedModules
58− , _ifaces :: I.Interfaces
59− , _depsGraph :: Summary.DepsGraph
60− }
61−
62−
63−data ProjectDeps
64− = App (Map Name Version) (Map Name Version) (Map Name Version) (Map Name Version)
65− | Pkg (Map Name Con.Constraint) (Map Name Con.Constraint)
66−
67−
68−getDeps :: Project.Project -> ProjectDeps
69−getDeps project =
70− case project of
71− Project.App (Project.AppInfo _ _ depsDirect depsTrans testDirect testTrans) ->
72− App depsDirect depsTrans testDirect testTrans
73−
74− Project.Pkg (Project.PkgInfo _ _ _ _ _ direct test _) ->
75− Pkg direct test
76−
77−
78−isValidMiniSummary :: ProjectDeps -> Project.Project -> Bool
79−isValidMiniSummary deps project =
80− case deps of
81− App a b c d ->
82− case project of
83− Project.Pkg _ ->
84− False
85−
86− Project.App (Project.AppInfo _ _ a2 b2 c2 d2) ->
87− a == a2 && b == b2 && c == c2 && d == d2
88−
89− Pkg a b ->
90− case project of
91− Project.Pkg (Project.PkgInfo _ _ _ _ _ a2 b2 _) ->
92− a == a2 && b == b2
93−
94− Project.App _ ->
95− False
96−
97−
98−
99−-- BINARY
100−
101−
102−instance Binary MiniSummary where
103− get = liftM4 MiniSummary get get get get
104− put (MiniSummary a b c d) = put a >> put b >> put c >> put d
105−
106−
107−
108−instance Binary ProjectDeps where
109− put deps =
110− case deps of
111− App a b c d -> putWord8 0 >> put a >> put b >> put c >> put d
112− Pkg a b -> putWord8 1 >> put a >> put b
113−
114− get =
115− do n <- getWord8
116− case n of
117− 0 -> liftM4 App get get get get
118− 1 -> liftM2 Pkg get get
119− _ -> error "binary encoding of ProjectDeps was corrupted"
cabal.confignew file+2
@@ -0,0 +1,2 @@
1+profiling: False
2+library-profiling: True
compiler/src/AST/Canonical.hs+24−13
@@ -56,12 +56,14 @@ import Data.Binary
5656import qualified Data.List as List
5757import qualified Data.Map as Map
5858import Data.Name (Name)
59−import qualified Data.Utf8 as Utf8
6059
60+import qualified AST.Source as Src
6161import qualified AST.Utils.Binop as Binop
6262import qualified AST.Utils.Shader as Shader
6363import qualified Data.Index as Index
64+import qualified Elm.Float as EF
6465import qualified Elm.ModuleName as ModuleName
66+import qualified Elm.String as ES
6567import qualified Reporting.Annotation as A
6668
6769
@@ -82,10 +84,10 @@ data Expr_
8284 | VarCtor CtorOpts ModuleName.Canonical Name Index.ZeroBased Annotation
8385 | VarDebug ModuleName.Canonical Name Annotation
8486 | VarOperator Name ModuleName.Canonical Name Annotation -- CACHE real name for optimization
85− | Chr Utf8.String
86− | Str Utf8.String
87+ | Chr ES.String
88+ | Str ES.String
8789 | Int Int
88− | Float (Utf8.Under256 Float)
90+ | Float EF.Float
8991 | List [Expr]
9092 | Negate Expr
9193 | Binop Name ModuleName.Canonical Name Annotation Expr Expr -- CACHE real name for optimization
@@ -128,7 +130,7 @@ data Def
128130
129131data Decls
130132 = Declare Def Decls
131− | DeclareRec [Def] Decls
133+ | DeclareRec Def [Def] Decls
132134 | SaveTheEnvironment
133135
134136
@@ -150,8 +152,8 @@ data Pattern_
150152 | PList [Pattern]
151153 | PCons Pattern Pattern
152154 | PBool Union Bool
153− | PChr Utf8.String
154− | PStr Utf8.String
155+ | PChr ES.String
156+ | PStr ES.String
155157 | PInt Int
156158 | PCtor
157159 { _p_home :: ModuleName.Canonical
@@ -180,6 +182,7 @@ data PatternCtorArg =
180182
181183
182184data Annotation = Forall FreeVars Type
185+ deriving (Eq)
183186
184187
185188type FreeVars = Map.Map Name ()
@@ -193,15 +196,17 @@ data Type
193196 | TUnit
194197 | TTuple Type Type (Maybe Type)
195198 | TAlias ModuleName.Canonical Name [(Name, Type)] AliasType
199+ deriving (Eq)
196200
197201
198202data AliasType
199203 = Holey Type
200204 | Filled Type
205+ deriving (Eq)
201206
202207
203−data FieldType =
204− FieldType {-# UNPACK #-} !Word16 Type
208+data FieldType = FieldType {-# UNPACK #-} !Word16 Type
209+ deriving (Eq)
205210
206211
207212-- NOTE: The Word16 marks the source order, but it may not be available
@@ -228,6 +233,7 @@ data Module =
228233 Module
229234 { _name :: ModuleName.Canonical
230235 , _exports :: Exports
236+ , _docs :: Src.Docs
231237 , _decls :: Decls
232238 , _unions :: Map.Map Name Union
233239 , _aliases :: Map.Map Name Alias
@@ -237,7 +243,11 @@ data Module =
237243
238244
239245data Alias = Alias [Name] Type
246+ deriving (Eq)
247+
248+
240249data Binop = Binop_ Binop.Associativity Binop.Precedence Name
250+ deriving (Eq)
241251
242252
243253data Union =
@@ -247,6 +257,7 @@ data Union =
247257 , _u_numAlts :: Int -- CACHE numAlts for exhaustiveness checking
248258 , _u_opts :: CtorOpts -- CACHE which optimizations are available
249259 }
260+ deriving (Eq)
250261
251262
252263data CtorOpts
@@ -256,8 +267,8 @@ data CtorOpts
256267 deriving (Eq, Ord)
257268
258269
259−data Ctor =
260− Ctor Name Index.ZeroBased Int [Type] -- CACHE length args
270+data Ctor = Ctor Name Index.ZeroBased Int [Type] -- CACHE length args
271+ deriving (Eq)
261272
262273
263274
@@ -331,7 +342,7 @@ instance Binary CtorOpts where
331342 0 -> return Normal
332343 1 -> return Enum
333344 2 -> return Unbox
334− _ -> error "binary encoding of CtorOpts was corrupted"
345+ _ -> fail "binary encoding of CtorOpts was corrupted"
335346
336347
337348instance Binary Annotation where
@@ -382,7 +393,7 @@ instance Binary AliasType where
382393 case n of
383394 0 -> liftM Holey get
384395 1 -> liftM Filled get
385− _ -> error "binary encoding of AliasType was corrupted"
396+ _ -> fail "binary encoding of AliasType was corrupted"
386397
387398
388399instance Binary FieldType where
compiler/src/AST/Optimized.hs+116−23
@@ -7,26 +7,35 @@ module AST.Optimized
77 , Destructor(..)
88 , Decider(..)
99 , Choice(..)
10− , Graph(..)
10+ , GlobalGraph(..)
11+ , LocalGraph(..)
1112 , Main(..)
1213 , Node(..)
1314 , EffectsType(..)
15+ , empty
16+ , addGlobalGraph
17+ , addLocalGraph
18+ , addKernel
19+ , toKernelGlobal
1420 )
1521 where
1622
1723
1824import Control.Monad (liftM, liftM2, liftM3, liftM4)
19−import Data.Binary
25+import Data.Binary (Binary, get, put, getWord8, putWord8)
2026import qualified Data.Map as Map
27+import qualified Data.Name as Name
2128import Data.Name (Name)
2229import qualified Data.Set as Set
23−import qualified Data.Utf8 as Utf8
2430
2531import qualified AST.Canonical as Can
2632import qualified AST.Utils.Shader as Shader
2733import qualified Data.Index as Index
34+import qualified Elm.Float as EF
2835import qualified Elm.Kernel as K
2936import qualified Elm.ModuleName as ModuleName
37+import qualified Elm.Package as Pkg
38+import qualified Elm.String as ES
3039import qualified Optimize.DecisionTree as DT
3140import qualified Reporting.Annotation as A
3241
@@ -37,10 +46,10 @@ import qualified Reporting.Annotation as A
3746
3847data Expr
3948 = Bool Bool
40− | Chr Utf8.String
41− | Str Utf8.String
49+ | Chr ES.String
50+ | Str ES.String
4251 | Int Int
43− | Float (Utf8.Under256 Float)
52+ | Float EF.Float
4453 | VarLocal Name
4554 | VarGlobal Global
4655 | VarEnum Global Index.ZeroBased
@@ -66,7 +75,6 @@ data Expr
6675
6776
6877data Global = Global ModuleName.Canonical Name
69− deriving (Eq, Ord)
7078
7179
7280
@@ -117,11 +125,18 @@ data Choice
117125-- OBJECT GRAPH
118126
119127
120−data Graph =
121− Graph
122− { _mains :: Map.Map ModuleName.Canonical Main
123− , _nodes :: Map.Map Global Node
124− , _fields :: Map.Map Name Int
128+data GlobalGraph =
129+ GlobalGraph
130+ { _g_nodes :: Map.Map Global Node
131+ , _g_fields :: Map.Map Name Int
132+ }
133+
134+
135+data LocalGraph =
136+ LocalGraph
137+ { _l_main :: Maybe Main
138+ , _l_nodes :: Map.Map Global Node -- PERF profile switching Global to Name
139+ , _l_fields :: Map.Map Name Int
125140 }
126141
127142
@@ -151,6 +166,79 @@ data EffectsType = Cmd | Sub | Fx
151166
152167
153168
169+-- GRAPHS
170+
171+
172+{-# NOINLINE empty #-}
173+empty :: GlobalGraph
174+empty =
175+ GlobalGraph Map.empty Map.empty
176+
177+
178+addGlobalGraph :: GlobalGraph -> GlobalGraph -> GlobalGraph
179+addGlobalGraph (GlobalGraph nodes1 fields1) (GlobalGraph nodes2 fields2) =
180+ GlobalGraph
181+ { _g_nodes = Map.union nodes1 nodes2
182+ , _g_fields = Map.union fields1 fields2
183+ }
184+
185+
186+addLocalGraph :: LocalGraph -> GlobalGraph -> GlobalGraph
187+addLocalGraph (LocalGraph _ nodes1 fields1) (GlobalGraph nodes2 fields2) =
188+ GlobalGraph
189+ { _g_nodes = Map.union nodes1 nodes2
190+ , _g_fields = Map.union fields1 fields2
191+ }
192+
193+
194+addKernel :: Name.Name -> [K.Chunk] -> GlobalGraph -> GlobalGraph
195+addKernel shortName chunks (GlobalGraph nodes fields) =
196+ let
197+ global = toKernelGlobal shortName
198+ node = Kernel chunks (foldr addKernelDep Set.empty chunks)
199+ in
200+ GlobalGraph
201+ { _g_nodes = Map.insert global node nodes
202+ , _g_fields = Map.union (K.countFields chunks) fields
203+ }
204+
205+
206+addKernelDep :: K.Chunk -> Set.Set Global -> Set.Set Global
207+addKernelDep chunk deps =
208+ case chunk of
209+ K.JS _ -> deps
210+ K.ElmVar home name -> Set.insert (Global home name) deps
211+ K.JsVar shortName _ -> Set.insert (toKernelGlobal shortName) deps
212+ K.ElmField _ -> deps
213+ K.JsField _ -> deps
214+ K.JsEnum _ -> deps
215+ K.Debug -> deps
216+ K.Prod -> deps
217+
218+
219+toKernelGlobal :: Name.Name -> Global
220+toKernelGlobal shortName =
221+ Global (ModuleName.Canonical Pkg.kernel shortName) Name.dollar
222+
223+
224+
225+-- INSTANCES
226+
227+
228+instance Eq Global where
229+ (==) (Global home1 name1) (Global home2 name2) =
230+ name1 == name2 && home1 == home2
231+
232+
233+instance Ord Global where
234+ compare (Global home1 name1) (Global home2 name2) =
235+ case compare name1 name2 of
236+ LT -> LT
237+ EQ -> compare home1 home2
238+ GT -> GT
239+
240+
241+
154242-- BINARY
155243
156244
@@ -220,7 +308,7 @@ instance Binary Expr where
220308 24 -> pure Unit
221309 25 -> liftM3 Tuple get get get
222310 26 -> liftM3 Shader get get get
223− _ -> error "problem getting Opt.Expr binary"
311+ _ -> fail "problem getting Opt.Expr binary"
224312
225313
226314instance Binary Def where
@@ -234,7 +322,7 @@ instance Binary Def where
234322 case word of
235323 0 -> liftM2 Def get get
236324 1 -> liftM3 TailDef get get get
237− _ -> error "problem getting Opt.Def binary"
325+ _ -> fail "problem getting Opt.Def binary"
238326
239327
240328instance Binary Destructor where
@@ -257,7 +345,7 @@ instance Binary Path where
257345 1 -> liftM2 Field get get
258346 2 -> liftM Unbox get
259347 3 -> liftM Root get
260− _ -> error "problem getting Opt.Path binary"
348+ _ -> fail "problem getting Opt.Path binary"
261349
262350
263351instance (Binary a) => Binary (Decider a) where
@@ -273,7 +361,7 @@ instance (Binary a) => Binary (Decider a) where
273361 0 -> liftM Leaf get
274362 1 -> liftM3 Chain get get get
275363 2 -> liftM3 FanOut get get get
276− _ -> error "problem getting Opt.Decider binary"
364+ _ -> fail "problem getting Opt.Decider binary"
277365
278366
279367instance Binary Choice where
@@ -287,13 +375,18 @@ instance Binary Choice where
287375 case word of
288376 0 -> liftM Inline get
289377 1 -> liftM Jump get
290− _ -> error "problem getting Opt.Choice binary"
378+ _ -> fail "problem getting Opt.Choice binary"
379+
380+
291381
382+instance Binary GlobalGraph where
383+ get = liftM2 GlobalGraph get get
384+ put (GlobalGraph a b) = put a >> put b
292385
293386
294−instance Binary Graph where
295− get = liftM3 Graph get get get
296− put (Graph a b c) = put a >> put b >> put c
387+instance Binary LocalGraph where
388+ get = liftM3 LocalGraph get get get
389+ put (LocalGraph a b c) = put a >> put b >> put c
297390
298391
299392instance Binary Main where
@@ -307,7 +400,7 @@ instance Binary Main where
307400 case word of
308401 0 -> return Static
309402 1 -> liftM2 Dynamic get get
310− _ -> error "problem getting Opt.Main binary"
403+ _ -> fail "problem getting Opt.Main binary"
311404
312405
313406instance Binary Node where
@@ -339,7 +432,7 @@ instance Binary Node where
339432 8 -> liftM2 Kernel get get
340433 9 -> liftM2 PortIncoming get get
341434 10 -> liftM2 PortOutgoing get get
342− _ -> error "problem getting Opt.Node binary"
435+ _ -> fail "problem getting Opt.Node binary"
343436
344437
345438instance Binary EffectsType where
@@ -355,4 +448,4 @@ instance Binary EffectsType where
355448 0 -> return Cmd
356449 1 -> return Sub
357450 2 -> return Fx
358− _ -> error "problem getting Opt.EffectsType binary"
451+ _ -> fail "problem getting Opt.EffectsType binary"
compiler/src/AST/Source.hs+47−15
@@ -5,14 +5,18 @@ module AST.Source
55 , Pattern, Pattern_(..)
66 , Type, Type_(..)
77 , Module(..)
8+ , getName
9+ , getImportName
810 , Import(..)
911 , Value(..)
1012 , Union(..)
1113 , Alias(..)
12− , Binop(..)
14+ , Infix(..)
1315 , Port(..)
1416 , Effects(..)
1517 , Manager(..)
18+ , Docs(..)
19+ , Comment(..)
1620 , Exposing(..)
1721 , Exposed(..)
1822 , Privacy(..)
@@ -21,10 +25,13 @@ module AST.Source
2125
2226
2327import Data.Name (Name)
24−import qualified Data.Utf8 as Utf8
28+import qualified Data.Name as Name
2529
2630import qualified AST.Utils.Binop as Binop
2731import qualified AST.Utils.Shader as Shader
32+import qualified Elm.Float as EF
33+import qualified Elm.String as ES
34+import qualified Parse.Primitives as P
2835import qualified Reporting.Annotation as A
2936
3037
@@ -36,10 +43,10 @@ type Expr = A.Located Expr_
3643
3744
3845data Expr_
39− = Chr Utf8.String
40− | Str Utf8.String
46+ = Chr ES.String
47+ | Str ES.String
4148 | Int Int
42− | Float (Utf8.Under256 Float)
49+ | Float EF.Float
4350 | Var VarType Name
4451 | VarQual VarType Name Name
4552 | List [Expr]
@@ -90,8 +97,8 @@ data Pattern_
9097 | PCtorQual A.Region Name Name [Pattern]
9198 | PList [Pattern]
9299 | PCons Pattern Pattern
93− | PChr Utf8.String
94− | PStr Utf8.String
100+ | PChr ES.String
101+ | PStr ES.String
95102 | PInt Int
96103
97104
@@ -119,17 +126,33 @@ data Type_
119126
120127data Module =
121128 Module
122− { _name :: Name
129+ { _name :: Maybe (A.Located Name)
123130 , _exports :: A.Located Exposing
131+ , _docs :: Docs
124132 , _imports :: [Import]
125133 , _values :: [A.Located Value]
126134 , _unions :: [A.Located Union]
127135 , _aliases :: [A.Located Alias]
128− , _binops :: [A.Located Binop]
136+ , _binops :: [A.Located Infix]
129137 , _effects :: Effects
130138 }
131139
132140
141+getName :: Module -> Name
142+getName (Module maybeName _ _ _ _ _ _ _ _) =
143+ case maybeName of
144+ Just (A.At _ name) ->
145+ name
146+
147+ Nothing ->
148+ Name._Main
149+
150+
151+getImportName :: Import -> Name
152+getImportName (Import (A.At _ name) _ _) =
153+ name
154+
155+
133156data Import =
134157 Import
135158 { _import :: A.Located Name
@@ -141,7 +164,7 @@ data Import =
141164data Value = Value (A.Located Name) [Pattern] Expr (Maybe Type)
142165data Union = Union (A.Located Name) [A.Located Name] [(A.Located Name, [Type])]
143166data Alias = Alias (A.Located Name) [A.Located Name] Type
144−data Binop = Binop Name Binop.Associativity Binop.Precedence Name
167+data Infix = Infix Name Binop.Associativity Binop.Precedence Name
145168data Port = Port (A.Located Name) Type
146169
147170
@@ -157,21 +180,30 @@ data Manager
157180 | Fx (A.Located Name) (A.Located Name)
158181
159182
183+data Docs
184+ = NoDocs A.Region
185+ | YesDocs Comment [(Name, Comment)]
186+
187+
188+newtype Comment =
189+ Comment P.Snippet
190+
191+
160192
161193-- EXPOSING
162194
163195
164196data Exposing
165197 = Open
166− | Explicit [A.Located Exposed]
198+ | Explicit [Exposed]
167199
168200
169201data Exposed
170− = Lower Name
171− | Upper Name Privacy
172− | Operator Name
202+ = Lower (A.Located Name)
203+ | Upper (A.Located Name) Privacy
204+ | Operator A.Region Name
173205
174206
175207data Privacy
176− = Public
208+ = Public A.Region
177209 | Private
compiler/src/AST/Utils/Binop.hs+5−6
@@ -41,12 +41,11 @@ instance Binary Precedence where
4141instance Binary Associativity where
4242 get =
4343 do n <- getWord8
44− return $
45− case n of
46− 0 -> Left
47− 1 -> Non
48− 2 -> Right
49− _ -> error "Error reading valid associativity from serialized string"
44+ case n of
45+ 0 -> return Left
46+ 1 -> return Non
47+ 2 -> return Right
48+ _ -> fail "Error reading valid associativity from serialized string"
5049
5150 put assoc =
5251 putWord8 $
compiler/src/AST/Utils/Shader.hs+51−4
@@ -4,22 +4,27 @@ module AST.Utils.Shader
44 ( Source
55 , Types(..)
66 , Type(..)
7+ , fromChars
8+ , toJsStringBuilder
79 )
810 where
911
1012
13+import Control.Monad (liftM)
14+import Data.Binary (Binary, get, put)
15+import qualified Data.ByteString as BS
16+import qualified Data.ByteString.Builder as B
17+import qualified Data.ByteString.UTF8 as BS_UTF8
1118import qualified Data.Map as Map
1219import qualified Data.Name as Name
13−import qualified Data.Utf8 as Utf8
1420
1521
1622
1723-- SOURCE
1824
1925
20−type Source = Utf8.VeryLong SOURCE
21−
22−data SOURCE
26+newtype Source =
27+ Source BS.ByteString
2328
2429
2530
@@ -42,3 +47,45 @@ data Type
4247 | V4
4348 | M4
4449 | Texture
50+
51+
52+
53+-- TO BUILDER
54+
55+
56+toJsStringBuilder :: Source -> B.Builder
57+toJsStringBuilder (Source src) =
58+ B.byteString src
59+
60+
61+
62+-- FROM CHARS
63+
64+
65+fromChars :: [Char] -> Source
66+fromChars chars =
67+ Source (BS_UTF8.fromString (escape chars))
68+
69+
70+escape :: [Char] -> [Char]
71+escape chars =
72+ case chars of
73+ [] ->
74+ []
75+
76+ c:cs
77+ | c == '\r' -> escape cs
78+ | c == '\n' -> '\\' : 'n' : escape cs
79+ | c == '\"' -> '\\' : '"' : escape cs
80+ | c == '\'' -> '\\' : '\'' : escape cs
81+ | c == '\\' -> '\\' : '\\' : escape cs
82+ | otherwise -> c : escape cs
83+
84+
85+
86+-- BINARY
87+
88+
89+instance Binary Source where
90+ get = liftM Source get
91+ put (Source a) = put a
compiler/src/AST/Utils/Type.hs−1
@@ -1,5 +1,4 @@
11{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
32module AST.Utils.Type
43 ( delambda
54 , dealias
compiler/src/Canonicalize/Environment.hs+50−20
@@ -4,6 +4,8 @@ module Canonicalize.Environment
44 ( Env(..)
55 , Exposed
66 , Qualified
7+ , Info(..)
8+ , mergeInfo
79 , Var(..)
810 , Type(..)
911 , Ctor(..)
@@ -20,8 +22,8 @@ module Canonicalize.Environment
2022
2123import qualified Data.Map.Merge.Strict as Map
2224import qualified Data.Map.Strict as Map
23−import qualified Data.Map.Strict.Internal as I
2425import qualified Data.Name as Name
26+import qualified Data.OneOrMore as OneOrMore
2527
2628import qualified AST.Utils.Binop as Binop
2729import qualified AST.Canonical as Can
@@ -58,11 +60,34 @@ data Env =
5860
5961
6062type Exposed a =
61− Map.Map Name.Name (Map.Map ModuleName.Canonical a)
63+ Map.Map Name.Name (Info a)
6264
6365
6466type Qualified a =
65− Map.Map Name.Name (Map.Map Name.Name (Map.Map ModuleName.Canonical a))
67+ Map.Map Name.Name (Map.Map Name.Name (Info a))
68+
69+
70+
71+-- INFO
72+
73+
74+data Info a
75+ = Specific ModuleName.Canonical a
76+ | Ambiguous ModuleName.Canonical (OneOrMore.OneOrMore ModuleName.Canonical)
77+
78+
79+mergeInfo :: Info a -> Info a -> Info a
80+mergeInfo info1 info2 =
81+ case info1 of
82+ Specific h1 _ ->
83+ case info2 of
84+ Specific h2 _ -> if h1 == h2 then info1 else Ambiguous h1 (OneOrMore.one h2)
85+ Ambiguous h2 hs2 -> Ambiguous h1 (OneOrMore.more (OneOrMore.one h2) hs2)
86+
87+ Ambiguous h1 hs1 ->
88+ case info2 of
89+ Specific h2 _ -> Ambiguous h1 (OneOrMore.more hs1 (OneOrMore.one h2))
90+ Ambiguous h2 hs2 -> Ambiguous h1 (OneOrMore.more hs1 (OneOrMore.more (OneOrMore.one h2) hs2))
6691
6792
6893
@@ -72,7 +97,8 @@ type Qualified a =
7297data Var
7398 = Local A.Region
7499 | TopLevel A.Region
75− | Foreign (Map.Map ModuleName.Canonical Can.Annotation)
100+ | Foreign ModuleName.Canonical Can.Annotation
101+ | Foreigns ModuleName.Canonical (OneOrMore.OneOrMore ModuleName.Canonical)
76102
77103
78104
@@ -139,7 +165,10 @@ addLocalLeft _ region =
139165addLocalBoth :: Name.Name -> A.Region -> Var -> Result i w Var
140166addLocalBoth name region var =
141167 case var of
142− Foreign _ ->
168+ Foreign _ _ ->
169+ Result.ok (Local region)
170+
171+ Foreigns _ _ ->
143172 Result.ok (Local region)
144173
145174 Local parentRegion ->
@@ -150,17 +179,18 @@ addLocalBoth name region var =
150179
151180
152181
182+
153183-- FIND TYPE
154184
155185
156186findType :: A.Region -> Env -> Name.Name -> Result i w Type
157187findType region (Env _ _ ts _ _ _ qts _) name =
158188 case Map.lookup name ts of
159− Just (I.Bin 1 _ tipe _ _) ->
189+ Just (Specific _ tipe) ->
160190 Result.ok tipe
161191
162− Just homes ->
163− Result.throw (Error.AmbiguousType region Nothing name (Map.keys homes))
192+ Just (Ambiguous h hs) ->
193+ Result.throw (Error.AmbiguousType region Nothing name h hs)
164194
165195 Nothing ->
166196 Result.throw (Error.NotFoundType region Nothing name (toPossibleNames ts qts))
@@ -171,11 +201,11 @@ findTypeQual region (Env _ _ ts _ _ _ qts _) prefix name =
171201 case Map.lookup prefix qts of
172202 Just qualified ->
173203 case Map.lookup name qualified of
174− Just (I.Bin 1 _ tipe _ _) ->
204+ Just (Specific _ tipe) ->
175205 Result.ok tipe
176206
177− Just homes ->
178− Result.throw (Error.AmbiguousType region (Just prefix) name (Map.keys homes))
207+ Just (Ambiguous h hs) ->
208+ Result.throw (Error.AmbiguousType region (Just prefix) name h hs)
179209
180210 Nothing ->
181211 Result.throw (Error.NotFoundType region (Just prefix) name (toPossibleNames ts qts))
@@ -191,11 +221,11 @@ findTypeQual region (Env _ _ ts _ _ _ qts _) prefix name =
191221findCtor :: A.Region -> Env -> Name.Name -> Result i w Ctor
192222findCtor region (Env _ _ _ cs _ _ _ qcs) name =
193223 case Map.lookup name cs of
194− Just (I.Bin 1 _ ctor _ _) ->
224+ Just (Specific _ ctor) ->
195225 Result.ok ctor
196226
197− Just homes ->
198− Result.throw (Error.AmbiguousVariant region Nothing name (Map.keys homes))
227+ Just (Ambiguous h hs) ->
228+ Result.throw (Error.AmbiguousVariant region Nothing name h hs)
199229
200230 Nothing ->
201231 Result.throw (Error.NotFoundVariant region Nothing name (toPossibleNames cs qcs))
@@ -206,11 +236,11 @@ findCtorQual region (Env _ _ _ cs _ _ _ qcs) prefix name =
206236 case Map.lookup prefix qcs of
207237 Just qualified ->
208238 case Map.lookup name qualified of
209− Just (I.Bin 1 _ pattern _ _) ->
239+ Just (Specific _ pattern) ->
210240 Result.ok pattern
211241
212− Just homes ->
213− Result.throw (Error.AmbiguousVariant region (Just prefix) name (Map.keys homes))
242+ Just (Ambiguous h hs) ->
243+ Result.throw (Error.AmbiguousVariant region (Just prefix) name h hs)
214244
215245 Nothing ->
216246 Result.throw (Error.NotFoundVariant region (Just prefix) name (toPossibleNames cs qcs))
@@ -226,11 +256,11 @@ findCtorQual region (Env _ _ _ cs _ _ _ qcs) prefix name =
226256findBinop :: A.Region -> Env -> Name.Name -> Result i w Binop
227257findBinop region (Env _ _ _ _ binops _ _ _) name =
228258 case Map.lookup name binops of
229− Just (I.Bin 1 _ binop _ _) ->
259+ Just (Specific _ binop) ->
230260 Result.ok binop
231261
232− Just homes ->
233− Result.throw (Error.AmbiguousBinop region name (Map.keys homes))
262+ Just (Ambiguous h hs) ->
263+ Result.throw (Error.AmbiguousBinop region name h hs)
234264
235265 Nothing ->
236266 Result.throw (Error.NotFoundBinop region name (Map.keysSet binops))
compiler/src/Canonicalize/Environment/Dups.hs+6−3
@@ -57,8 +57,11 @@ detectHelp toError name values =
5757 OneOrMore.One (Info _ value) ->
5858 return value
5959
60− OneOrMore.More _ _ ->
61− let (Info r1 _ : Info r2 _ : _) = OneOrMore.toList values in
60+ OneOrMore.More left right ->
61+ let
62+ (Info r1 _, Info r2 _) =
63+ OneOrMore.getFirstTwo left right
64+ in
6265 Result.throw (toError name r1 r2)
6366
6467
@@ -102,7 +105,7 @@ one name region value =
102105
103106insert :: Name.Name -> A.Region -> a -> Dict a -> Dict a
104107insert name region value dict =
105− Map.insertWith OneOrMore.more name (OneOrMore.one (Info region value)) dict
108+ Map.insertWith (\new old -> OneOrMore.more old new) name (OneOrMore.one (Info region value)) dict
106109
107110
108111union :: Dict a -> Dict a -> Dict a
compiler/src/Canonicalize/Environment/Foreign.hs+80−82
@@ -10,6 +10,7 @@ module Canonicalize.Environment.Foreign
1010import Control.Monad (foldM)
1111import qualified Data.List as List
1212import qualified Data.Map.Strict as Map
13+import Data.Map.Strict ((!))
1314import qualified Data.Name as Name
1415
1516import qualified AST.Canonical as Can
@@ -17,6 +18,7 @@ import qualified AST.Source as Src
1718import qualified Canonicalize.Environment as Env
1819import qualified Elm.Interface as I
1920import qualified Elm.ModuleName as ModuleName
21+import qualified Elm.Package as Pkg
2022import qualified Reporting.Annotation as A
2123import qualified Reporting.Error.Canonicalize as Error
2224import qualified Reporting.Result as Result
@@ -30,24 +32,17 @@ type Result i w a =
3032 Result.Result i w Error.Error a
3133
3234
35+createInitialEnv :: ModuleName.Canonical -> Map.Map ModuleName.Raw I.Interface -> [Src.Import] -> Result i w Env.Env
36+createInitialEnv home ifaces imports =
37+ do (State vs ts cs bs qvs qts qcs) <- foldM (addImport ifaces) emptyState (toSafeImports home imports)
38+ Result.ok (Env.Env home (Map.map infoToVar vs) ts cs bs qvs qts qcs)
3339
34−-- CREATE ENVIRONMENT
3540
36−
37−type ImportDict =
38− Map.Map Name.Name ModuleName.Canonical
39−
40−
41−createInitialEnv :: ModuleName.Canonical -> ImportDict -> I.Interfaces -> [Src.Import] -> Result i w Env.Env
42−createInitialEnv home importDict interfaces sourceImports =
43− do imports <- traverse (verifyImport importDict interfaces) (filter isNotKernel sourceImports)
44− (State vs ts cs bs qvs qts qcs) <- foldM addImport emptyState imports
45− Result.ok (Env.Env home (Map.map Env.Foreign vs) ts cs bs qvs qts qcs)
46−
47−
48−isNotKernel :: Src.Import -> Bool
49−isNotKernel (Src.Import (A.At _ name) _ _) =
50− not (Name.isKernel name)
41+infoToVar :: Env.Info Can.Annotation -> Env.Var
42+infoToVar info =
43+ case info of
44+ Env.Specific home tipe -> Env.Foreign home tipe
45+ Env.Ambiguous h hs -> Env.Foreigns h hs
5146
5247
5348
@@ -73,23 +68,49 @@ emptyState =
7368
7469emptyTypes :: Env.Exposed Env.Type
7570emptyTypes =
76− Map.singleton "List" (Map.singleton ModuleName.list (Env.Union 1 ModuleName.list))
71+ Map.singleton "List" (Env.Specific ModuleName.list (Env.Union 1 ModuleName.list))
72+
73+
74+
75+-- TO SAFE IMPORTS
76+
77+
78+toSafeImports :: ModuleName.Canonical -> [Src.Import] -> [Src.Import]
79+toSafeImports (ModuleName.Canonical pkg _) imports =
80+ if Pkg.isKernel pkg
81+ then filter isNormal imports
82+ else imports
83+
84+
85+isNormal :: Src.Import -> Bool
86+isNormal (Src.Import (A.At _ name) maybeAlias _) =
87+ if Name.isKernel name
88+ then
89+ case maybeAlias of
90+ Nothing -> False
91+ Just _ -> error "kernel imports cannot use `as`"
92+ else
93+ True
7794
7895
7996
8097-- ADD IMPORTS
8198
8299
83−addImport :: State -> Import -> Result i w State
84−addImport (State vs ts cs bs qvs qts qcs) (Import home (I.Interface defs unions aliases binops) prefix exposing) =
100+addImport :: Map.Map ModuleName.Raw I.Interface -> State -> Src.Import -> Result i w State
101+addImport ifaces (State vs ts cs bs qvs qts qcs) (Src.Import (A.At _ name) maybeAlias exposing) =
85102 let
103+ (I.Interface pkg defs unions aliases binops) = ifaces ! name
104+ !prefix = maybe name id maybeAlias
105+ !home = ModuleName.Canonical pkg name
106+
86107 !rawTypeInfo =
87108 Map.union
88109 (Map.mapMaybeWithKey (unionToType home) unions)
89110 (Map.mapMaybeWithKey (aliasToType home) aliases)
90111
91− !vars = Map.map (Map.singleton home) defs
92− !types = Map.map (Map.singleton home . fst) rawTypeInfo
112+ !vars = Map.map (Env.Specific home) defs
113+ !types = Map.map (Env.Specific home . fst) rawTypeInfo
93114 !ctors = Map.foldr (addExposed . snd) Map.empty rawTypeInfo
94115
95116 !qvs2 = addQualified prefix vars qvs
@@ -115,7 +136,7 @@ addImport (State vs ts cs bs qvs qts qcs) (Import home (I.Interface defs unions
115136
116137addExposed :: Env.Exposed a -> Env.Exposed a -> Env.Exposed a
117138addExposed =
118− Map.unionWith Map.union
139+ Map.unionWith Env.mergeInfo
119140
120141
121142addQualified :: Name.Name -> Env.Exposed a -> Env.Qualified a -> Env.Qualified a
@@ -136,7 +157,7 @@ unionToTypeHelp :: ModuleName.Canonical -> Name.Name -> Can.Union -> (Env.Type,
136157unionToTypeHelp home name union@(Can.Union vars ctors _ _) =
137158 let
138159 addCtor dict (Can.Ctor ctor index _ args) =
139− Map.insert ctor (Map.singleton home (Env.Ctor home name union index args)) dict
160+ Map.insert ctor (Env.Specific home (Env.Ctor home name union index args)) dict
140161 in
141162 ( Env.Union (length vars) home
142163 , List.foldl' addCtor Map.empty ctors
@@ -167,7 +188,7 @@ aliasToTypeHelp home name (Can.Alias vars tipe) =
167188 (Can.TAlias home name avars (Can.Filled tipe))
168189 (Can.fieldsToList fields)
169190 in
170− Map.singleton name (Map.singleton home (Env.RecordCtor home vars alias))
191+ Map.singleton name (Env.Specific home (Env.RecordCtor home vars alias))
171192
172193 _ ->
173194 Map.empty
@@ -178,9 +199,9 @@ aliasToTypeHelp home name (Can.Alias vars tipe) =
178199-- BINOP
179200
180201
181−binopToBinop :: ModuleName.Canonical -> Name.Name -> I.Binop -> Map.Map ModuleName.Canonical Env.Binop
202+binopToBinop :: ModuleName.Canonical -> Name.Name -> I.Binop -> Env.Info Env.Binop
182203binopToBinop home op (I.Binop name annotation associativity precedence) =
183− Map.singleton home (Env.Binop op home name annotation associativity precedence)
204+ Env.Specific home (Env.Binop op home name annotation associativity precedence)
184205
185206
186207
@@ -193,19 +214,19 @@ addExposedValue
193214 -> Map.Map Name.Name (Env.Type, Env.Exposed Env.Ctor)
194215 -> Map.Map Name.Name I.Binop
195216 -> State
196− -> A.Located Src.Exposed
217+ -> Src.Exposed
197218 -> Result i w State
198−addExposedValue home vars types binops (State vs ts cs bs qvs qts qcs) (A.At region exposed) =
219+addExposedValue home vars types binops (State vs ts cs bs qvs qts qcs) exposed =
199220 case exposed of
200− Src.Lower name ->
221+ Src.Lower (A.At region name) ->
201222 case Map.lookup name vars of
202223 Just info ->
203− Result.ok (State (Map.insert name info vs) ts cs bs qvs qts qcs)
224+ Result.ok (State (Map.insertWith Env.mergeInfo name info vs) ts cs bs qvs qts qcs)
204225
205226 Nothing ->
206227 Result.throw (Error.ImportExposingNotFound region home name (Map.keys vars))
207228
208− Src.Upper name privacy ->
229+ Src.Upper (A.At region name) privacy ->
209230 case privacy of
210231 Src.Private ->
211232 case Map.lookup name types of
@@ -213,43 +234,43 @@ addExposedValue home vars types binops (State vs ts cs bs qvs qts qcs) (A.At reg
213234 case tipe of
214235 Env.Union _ _ ->
215236 let
216− !ts2 = Map.insert name (Map.singleton home tipe) ts
237+ !ts2 = Map.insert name (Env.Specific home tipe) ts
217238 in
218239 Result.ok (State vs ts2 cs bs qvs qts qcs)
219240
220241 Env.Alias _ _ _ _ ->
221242 let
222− !ts2 = Map.insert name (Map.singleton home tipe) ts
243+ !ts2 = Map.insert name (Env.Specific home tipe) ts
223244 !cs2 = addExposed cs ctors
224245 in
225246 Result.ok (State vs ts2 cs2 bs qvs qts qcs)
226247
227248 Nothing ->
228− case Map.lookup name (toCtors types) of
229− Just tipe ->
249+ case checkForCtorMistake name types of
250+ tipe:_ ->
230251 Result.throw $ Error.ImportCtorByName region name tipe
231252
232− Nothing ->
253+ [] ->
233254 Result.throw $ Error.ImportExposingNotFound region home name (Map.keys types)
234255
235− Src.Public ->
256+ Src.Public dotDotRegion ->
236257 case Map.lookup name types of
237258 Just (tipe, ctors) ->
238259 case tipe of
239260 Env.Union _ _ ->
240261 let
241− !ts2 = Map.insert name (Map.singleton home tipe) ts
262+ !ts2 = Map.insert name (Env.Specific home tipe) ts
242263 !cs2 = addExposed cs ctors
243264 in
244265 Result.ok (State vs ts2 cs2 bs qvs qts qcs)
245266
246267 Env.Alias _ _ _ _ ->
247− Result.throw (Error.ImportOpenAlias region name)
268+ Result.throw (Error.ImportOpenAlias dotDotRegion name)
248269
249270 Nothing ->
250271 Result.throw (Error.ImportExposingNotFound region home name (Map.keys types))
251272
252− Src.Operator op ->
273+ Src.Operator region op ->
253274 case Map.lookup op binops of
254275 Just binop ->
255276 let
@@ -261,46 +282,23 @@ addExposedValue home vars types binops (State vs ts cs bs qvs qts qcs) (A.At reg
261282 Result.throw (Error.ImportExposingNotFound region home op (Map.keys binops))
262283
263284
264−
265−toCtors :: Map.Map Name.Name (Env.Type, Env.Exposed Env.Ctor) -> Map.Map Name.Name Name.Name
266−toCtors types =
267− Map.foldr addCtors Map.empty types
285+checkForCtorMistake :: Name.Name -> Map.Map Name.Name (Env.Type, Env.Exposed Env.Ctor) -> [Name.Name]
286+checkForCtorMistake givenName types =
287+ Map.foldr addMatches [] types
268288 where
269− addCtors (_, exposedCtors) dict =
270− Map.foldrWithKey addCtor dict exposedCtors
271−
272− addCtor ctorName homes dict =
273− case Map.elems homes of
274− [Env.Ctor _ tipeName _ _ _] ->
275− Map.insert ctorName tipeName dict
276−
277− _ ->
278− dict
279−
280−
281−
282−-- VERIFY IMPORT
283−
284−
285−data Import =
286− Import
287− { _name :: ModuleName.Canonical
288− , _interface :: I.Interface
289− , _prefix :: Name.Name
290− , _exposing :: Src.Exposing
291− }
292−
293−
294−verifyImport :: ImportDict -> I.Interfaces -> Src.Import -> Result i w Import
295−verifyImport importDict interfaces (Src.Import (A.At region name) alias exposing) =
296− case Map.lookup name importDict of
297− Just canonicalName ->
298− case Map.lookup canonicalName interfaces of
299− Just interface ->
300− Result.ok (Import canonicalName interface (maybe name id alias) exposing)
301−
302− Nothing ->
303− Result.throw $ Error.ImportNotFound region name (Map.keys interfaces)
304−
305− Nothing ->
306− Result.throw $ Error.ImportNotFound region name (Map.elems importDict)
289+ addMatches (_, exposedCtors) matches =
290+ Map.foldrWithKey addMatch matches exposedCtors
291+
292+ addMatch ctorName info matches =
293+ if ctorName /= givenName
294+ then matches
295+ else
296+ case info of
297+ Env.Specific _ (Env.Ctor _ tipeName _ _ _) ->
298+ tipeName : matches
299+
300+ Env.Specific _ (Env.RecordCtor _ _ _) ->
301+ matches
302+
303+ Env.Ambiguous _ _ ->
304+ matches
compiler/src/Canonicalize/Environment/Local.hs+8−8
@@ -54,7 +54,7 @@ addVars module_ (Env.Env home vs ts cs bs qvs qts qcs) =
5454
5555
5656collectVars :: Src.Module -> Result i w (Map.Map Name.Name Env.Var)
57−collectVars (Src.Module _ _ _ values _ _ _ effects) =
57+collectVars (Src.Module _ _ _ _ values _ _ _ effects) =
5858 let
5959 addDecl dict (A.At _ (Src.Value (A.At region name) _ _ _)) =
6060 Dups.insert name region (Env.TopLevel region) dict
@@ -95,7 +95,7 @@ toEffectDups effects =
9595
9696
9797addTypes :: Src.Module -> Env.Env -> Result i w Env.Env
98−addTypes (Src.Module _ _ _ _ unions aliases _ _) (Env.Env home vs ts cs bs qvs qts qcs) =
98+addTypes (Src.Module _ _ _ _ _ unions aliases _ _) (Env.Env home vs ts cs bs qvs qts qcs) =
9999 let
100100 addAliasDups dups (A.At _ (Src.Alias (A.At region name) _ _)) = Dups.insert name region () dups
101101 addUnionDups dups (A.At _ (Src.Union (A.At region name) _ _)) = Dups.insert name region () dups
@@ -110,7 +110,7 @@ addTypes (Src.Module _ _ _ _ unions aliases _ _) (Env.Env home vs ts cs bs qvs q
110110addUnion :: ModuleName.Canonical -> Env.Exposed Env.Type -> A.Located Src.Union -> Result i w (Env.Exposed Env.Type)
111111addUnion home types union@(A.At _ (Src.Union (A.At _ name) _ _)) =
112112 do arity <- checkUnionFreeVars union
113− let one = Map.singleton home (Env.Union arity home)
113+ let one = Env.Specific home (Env.Union arity home)
114114 Result.ok $ Map.insert name one types
115115
116116
@@ -133,7 +133,7 @@ addAlias env@(Env.Env home vs ts cs bs qvs qts qcs) scc =
133133 Graph.AcyclicSCC alias@(A.At _ (Src.Alias (A.At _ name) _ tipe)) ->
134134 do args <- checkAliasFreeVars alias
135135 ctype <- Type.canonicalize env tipe
136− let one = Map.singleton home (Env.Alias (length args) home args ctype)
136+ let one = Env.Specific home (Env.Alias (length args) home args ctype)
137137 let ts1 = Map.insert name one ts
138138 Result.ok $ Env.Env home vs ts1 cs bs qvs qts qcs
139139
@@ -262,7 +262,7 @@ addFreeVars freeVars (A.At region tipe) =
262262
263263
264264addCtors :: Src.Module -> Env.Env -> Result i w (Env.Env, Unions, Aliases)
265−addCtors (Src.Module _ _ _ _ unions aliases _ _) env@(Env.Env home vs ts cs bs qvs qts qcs) =
265+addCtors (Src.Module _ _ _ _ _ unions aliases _ _) env@(Env.Env home vs ts cs bs qvs qts qcs) =
266266 do unionInfo <- traverse (canonicalizeUnion env) unions
267267 aliasInfo <- traverse (canonicalizeAlias env) aliases
268268
@@ -281,7 +281,7 @@ addCtors (Src.Module _ _ _ _ unions aliases _ _) env@(Env.Env home vs ts cs bs q
281281 )
282282
283283
284−type CtorDups = Dups.Dict (Map.Map ModuleName.Canonical Env.Ctor)
284+type CtorDups = Dups.Dict (Env.Info Env.Ctor)
285285
286286
287287
@@ -297,7 +297,7 @@ canonicalizeAlias env@(Env.Env home _ _ _ _ _ _ _) (A.At _ (Src.Alias (A.At regi
297297 ,
298298 case ctipe of
299299 Can.TRecord fields Nothing ->
300− Dups.one name region (Map.singleton home (toRecordCtor home name vars fields))
300+ Dups.one name region (Env.Specific home (toRecordCtor home name vars fields))
301301
302302 _ ->
303303 Dups.none
@@ -351,5 +351,5 @@ toOpts ctors =
351351
352352toCtor :: ModuleName.Canonical -> Name.Name -> Can.Union -> A.Located Can.Ctor -> CtorDups
353353toCtor home typeName union (A.At region (Can.Ctor name index _ args)) =
354− Dups.one name region $ Map.singleton home $
354+ Dups.one name region $ Env.Specific home $
355355 Env.Ctor home typeName union index args
compiler/src/Canonicalize/Expression.hs+6−7
@@ -14,7 +14,6 @@ import Control.Monad (foldM)
1414import qualified Data.Graph as Graph
1515import qualified Data.List as List
1616import qualified Data.Map.Strict as Map
17−import qualified Data.Map.Strict.Internal as I
1817import qualified Data.Name as Name
1918
2019import qualified AST.Canonical as Can
@@ -696,15 +695,15 @@ findVar region (Env.Env localHome vs _ _ _ qvs _ _) name =
696695 Env.TopLevel _ ->
697696 logVar name (Can.VarTopLevel localHome name)
698697
699− Env.Foreign (I.Bin 1 home annotation _ _) ->
698+ Env.Foreign home annotation ->
700699 Result.ok $
701700 if home == ModuleName.debug then
702701 Can.VarDebug localHome name annotation
703702 else
704703 Can.VarForeign home name annotation
705704
706− Env.Foreign homes ->
707− Result.throw (Error.AmbiguousVar region Nothing name (Map.keys homes))
705+ Env.Foreigns h hs ->
706+ Result.throw (Error.AmbiguousVar region Nothing name h hs)
708707
709708 Nothing ->
710709 Result.throw (Error.NotFoundVar region Nothing name (toPossibleNames vs qvs))
@@ -715,15 +714,15 @@ findVarQual region (Env.Env localHome vs _ _ _ qvs _ _) prefix name =
715714 case Map.lookup prefix qvs of
716715 Just qualified ->
717716 case Map.lookup name qualified of
718− Just (I.Bin 1 home annotation _ _) ->
717+ Just (Env.Specific home annotation) ->
719718 Result.ok $
720719 if home == ModuleName.debug then
721720 Can.VarDebug localHome name annotation
722721 else
723722 Can.VarForeign home name annotation
724723
725− Just homes ->
726− Result.throw (Error.AmbiguousVar region (Just prefix) name (Map.keys homes))
724+ Just (Env.Ambiguous h hs) ->
725+ Result.throw (Error.AmbiguousVar region (Just prefix) name h hs)
727726
728727 Nothing ->
729728 Result.throw (Error.NotFoundVar region (Just prefix) name (toPossibleNames vs qvs))
compiler/src/Canonicalize/Module.hs+35−28
@@ -41,33 +41,28 @@ type Result i w a =
4141-- MODULES
4242
4343
44−canonicalize
45− :: Pkg.Name
46− -> Map.Map Name.Name ModuleName.Canonical
47− -> I.Interfaces
48− -> Src.Module
49− -> Result i [W.Warning] Can.Module
50−canonicalize pkg importDict interfaces module_@(Src.Module name exports imports values _ _ binops effects) =
51− do let home = ModuleName.Canonical pkg name
44+canonicalize :: Pkg.Name -> Map.Map ModuleName.Raw I.Interface -> Src.Module -> Result i [W.Warning] Can.Module
45+canonicalize pkg ifaces modul@(Src.Module _ exports docs imports values _ _ binops effects) =
46+ do let home = ModuleName.Canonical pkg (Src.getName modul)
5247 let cbinops = Map.fromList (map canonicalizeBinop binops)
5348
5449 (env, cunions, caliases) <-
55− Local.add module_ =<<
56− Foreign.createInitialEnv home importDict interfaces imports
50+ Local.add modul =<<
51+ Foreign.createInitialEnv home ifaces imports
5752
5853 cvalues <- canonicalizeValues env values
5954 ceffects <- Effects.canonicalize env values cunions effects
6055 cexports <- canonicalizeExports values cunions caliases cbinops ceffects exports
6156
62− return $ Can.Module home cexports cvalues cunions caliases cbinops ceffects
57+ return $ Can.Module home cexports docs cvalues cunions caliases cbinops ceffects
6358
6459
6560
6661-- CANONICALIZE BINOP
6762
6863
69−canonicalizeBinop :: A.Located Src.Binop -> ( Name.Name, Can.Binop )
70−canonicalizeBinop (A.At _ (Src.Binop op associativity precedence func)) =
64+canonicalizeBinop :: A.Located Src.Infix -> ( Name.Name, Can.Binop )
65+canonicalizeBinop (A.At _ (Src.Infix op associativity precedence func)) =
7166 ( op, Can.Binop_ associativity precedence func )
7267
7368
@@ -98,13 +93,11 @@ detectCycles sccs =
9893 Graph.AcyclicSCC (def, _, _) ->
9994 Can.Declare def <$> detectCycles otherSccs
10095
101− Graph.CyclicSCC [] ->
102− detectCycles otherSccs
103−
10496 Graph.CyclicSCC subNodes ->
105− Can.DeclareRec
106− <$> traverse detectBadCycles (Graph.stronglyConnComp subNodes)
107− <*> detectCycles otherSccs
97+ do defs <- traverse detectBadCycles (Graph.stronglyConnComp subNodes)
98+ case defs of
99+ [] -> detectCycles otherSccs
100+ d:ds -> Can.DeclareRec d ds <$> detectCycles otherSccs
108101
109102
110103detectBadCycles :: Graph.SCC Can.Def -> Result i w Can.Def
@@ -113,8 +106,22 @@ detectBadCycles scc =
113106 Graph.AcyclicSCC def ->
114107 Result.ok def
115108
116− Graph.CyclicSCC cyclicValueDefs ->
117− Result.throw (Error.RecursiveDecl cyclicValueDefs)
109+ Graph.CyclicSCC [] ->
110+ error "The definition of Data.Graph.SCC should not allow empty CyclicSCC!"
111+
112+ Graph.CyclicSCC (def:defs) ->
113+ let
114+ (A.At region name) = extractDefName def
115+ names = map (A.toValue . extractDefName) defs
116+ in
117+ Result.throw (Error.RecursiveDecl region name names)
118+
119+
120+extractDefName :: Can.Def -> A.Located Name.Name
121+extractDefName def =
122+ case def of
123+ Can.Def name _ _ -> name
124+ Can.TypedDef name _ _ _ _ -> name
118125
119126
120127
@@ -229,11 +236,11 @@ checkExposed
229236 -> Map.Map Name.Name alias
230237 -> Map.Map Name.Name binop
231238 -> Can.Effects
232− -> A.Located Src.Exposed
239+ -> Src.Exposed
233240 -> Result i w (Dups.Dict (A.Located Can.Export))
234−checkExposed values unions aliases binops effects (A.At region exposed) =
241+checkExposed values unions aliases binops effects exposed =
235242 case exposed of
236− Src.Lower name ->
243+ Src.Lower (A.At region name) ->
237244 if Map.member name values then
238245 ok name region Can.ExportValue
239246 else
@@ -245,23 +252,23 @@ checkExposed values unions aliases binops effects (A.At region exposed) =
245252 Result.throw $ Error.ExportNotFound region Error.BadVar name $
246253 ports ++ Map.keys values
247254
248− Src.Operator name ->
255+ Src.Operator region name ->
249256 if Map.member name binops then
250257 ok name region Can.ExportBinop
251258 else
252259 Result.throw $ Error.ExportNotFound region Error.BadOp name $
253260 Map.keys binops
254261
255− Src.Upper name Src.Public ->
262+ Src.Upper (A.At region name) (Src.Public dotDotRegion) ->
256263 if Map.member name unions then
257264 ok name region Can.ExportUnionOpen
258265 else if Map.member name aliases then
259− Result.throw $ Error.ExportOpenAlias region name
266+ Result.throw $ Error.ExportOpenAlias dotDotRegion name
260267 else
261268 Result.throw $ Error.ExportNotFound region Error.BadType name $
262269 Map.keys unions ++ Map.keys aliases
263270
264− Src.Upper name Src.Private ->
271+ Src.Upper (A.At region name) Src.Private ->
265272 if Map.member name unions then
266273 ok name region Can.ExportUnionClosed
267274 else if Map.member name aliases then
compiler/src/Canonicalize/Pattern.hs+3−2
@@ -8,6 +8,7 @@ module Canonicalize.Pattern
88 where
99
1010
11+import qualified Data.List as List
1112import qualified Data.Map.Strict as Map
1213import qualified Data.Name as Name
1314
@@ -173,8 +174,8 @@ logVar name region value =
173174logFields :: [A.Located Name.Name] -> a -> Result DupsDict w a
174175logFields fields value =
175176 let
176− addField (A.At region name) dict =
177+ addField dict (A.At region name) =
177178 Dups.insert name region region dict
178179 in
179180 Result.Result $ \bindings warnings _ ok ->
180− ok (foldr addField bindings fields) warnings value
181+ ok (List.foldl' addField bindings fields) warnings value
compiler/src/Compile.hs+39−74
@@ -1,30 +1,26 @@
11{-# OPTIONS_GHC -Wall -fno-warn-unused-do-bind #-}
22module Compile
3− ( DocsFlag(..)
3+ ( Artifacts(..)
44 , compile
5− , Artifacts(..)
65 )
76 where
87
98
10−import qualified Data.ByteString as BS
119import qualified Data.Map as Map
1210import qualified Data.Name as Name
1311
12+import qualified AST.Source as Src
1413import qualified AST.Canonical as Can
1514import qualified AST.Optimized as Opt
1615import qualified Canonicalize.Module as Canonicalize
17−import qualified Elm.Docs as Docs
1816import qualified Elm.Interface as I
1917import qualified Elm.ModuleName as ModuleName
2018import qualified Elm.Package as Pkg
2119import qualified Nitpick.PatternMatches as PatternMatches
2220import qualified Optimize.Module as Optimize
23−import qualified Parse.Parse as Parse
24−import qualified Reporting.Error as Error
25−import qualified Reporting.Render.Type.Localizer as L
26−import qualified Reporting.Result as Result
27−import qualified Reporting.Warning as Warning
21+import qualified Reporting.Error as E
22+import qualified Reporting.Result as R
23+import qualified Reporting.Render.Type.Localizer as Localizer
2824import qualified Type.Constrain.Module as Type
2925import qualified Type.Solve as Type
3026
@@ -35,93 +31,62 @@ import System.IO.Unsafe (unsafePerformIO)
3531-- COMPILE
3632
3733
38−type Result i a =
39− Result.Result i [Warning.Warning] Error.Error a
40−
41−
42−type ImportDict =
43− Map.Map Name.Name ModuleName.Canonical
44−
45−
4634data Artifacts =
4735 Artifacts
48− { _elmi :: I.Interface
49− , _elmo :: Opt.Graph
50− , _docs :: Maybe Docs.Module
36+ { _modul :: Can.Module
37+ , _types :: Map.Map Name.Name Can.Annotation
38+ , _graph :: Opt.LocalGraph
5139 }
5240
5341
54−compile :: DocsFlag -> Pkg.Name -> ImportDict -> I.Interfaces -> BS.ByteString -> Result i Artifacts
55−compile flag pkg importDict interfaces source =
56− do
57− valid <- Result.mapError Error.Syntax $
58− Parse.program pkg source
59−
60− canonical <- Result.mapError Error.Canonicalize $
61− Canonicalize.canonicalize pkg importDict interfaces valid
42+compile :: Pkg.Name -> Map.Map ModuleName.Raw I.Interface -> Src.Module -> Either E.Error Artifacts
43+compile pkg ifaces modul =
44+ do canonical <- canonicalize pkg ifaces modul
45+ annotations <- typeCheck modul canonical
46+ () <- nitpick canonical
47+ objects <- optimize modul annotations canonical
48+ return (Artifacts canonical annotations objects)
6249
63− let localizer = L.fromModule valid -- TODO should this be strict for GC?
6450
65− annotations <-
66− runTypeInference localizer canonical
6751
68− () <-
69− exhaustivenessCheck canonical
52+-- PHASES
7053
71− graph <- Result.mapError (Error.Main localizer) $
72− Optimize.optimize annotations canonical
7354
74− documentation <-
75− genarateDocs flag canonical
55+canonicalize :: Pkg.Name -> Map.Map ModuleName.Raw I.Interface -> Src.Module -> Either E.Error Can.Module
56+canonicalize pkg ifaces modul =
57+ case snd $ R.run $ Canonicalize.canonicalize pkg ifaces modul of
58+ Right canonical ->
59+ Right canonical
7660
77− Result.ok $
78− Artifacts
79− { _elmi = I.fromModule annotations canonical
80− , _elmo = graph
81− , _docs = documentation
82− }
83−
84−
85−
86−-- TYPE INFERENCE
61+ Left errors ->
62+ Left $ E.BadNames errors
8763
8864
89−runTypeInference :: L.Localizer -> Can.Module -> Result i (Map.Map Name.Name Can.Annotation)
90−runTypeInference localizer canonical =
65+typeCheck :: Src.Module -> Can.Module -> Either E.Error (Map.Map Name.Name Can.Annotation)
66+typeCheck modul canonical =
9167 case unsafePerformIO (Type.run =<< Type.constrain canonical) of
9268 Right annotations ->
93− Result.ok annotations
69+ Right annotations
9470
9571 Left errors ->
96− Result.throw (Error.Type localizer errors)
97−
72+ Left (E.BadTypes (Localizer.fromModule modul) errors)
9873
9974
100−-- EXHAUSTIVENESS CHECK
101−
102−
103−exhaustivenessCheck :: Can.Module -> Result i ()
104−exhaustivenessCheck canonical =
75+nitpick :: Can.Module -> Either E.Error ()
76+nitpick canonical =
10577 case PatternMatches.check canonical of
106− Left errors ->
107− Result.throw (Error.Pattern errors)
108−
10978 Right () ->
110− Result.ok ()
111−
79+ Right ()
11280
113−
114−-- DOCUMENTATION
115−
116−
117−data DocsFlag = YesDocs | NoDocs
81+ Left errors ->
82+ Left (E.BadPatterns errors)
11883
11984
120−genarateDocs :: DocsFlag -> Can.Module -> Result.Result i w Error.Error (Maybe Docs.Module)
121−genarateDocs flag modul =
122− case flag of
123− NoDocs ->
124− Result.ok Nothing
85+optimize :: Src.Module -> Map.Map Name.Name Can.Annotation -> Can.Module -> Either E.Error Opt.LocalGraph
86+optimize modul annotations canonical =
87+ case snd $ R.run $ Optimize.optimize annotations canonical of
88+ Right localGraph ->
89+ Right localGraph
12590
126− YesDocs ->
127− Just <$> Docs.fromModule modul
91+ Left errors ->
92+ Left (E.BadMains (Localizer.fromModule modul) errors)
compiler/src/Data/Map/Utils.hsnew file+43
@@ -0,0 +1,43 @@
1+module Data.Map.Utils
2+ ( fromKeys
3+ , fromKeysA
4+ , fromValues
5+ , any
6+ )
7+ where
8+
9+
10+import Prelude hiding (any)
11+import qualified Data.Map as Map
12+import Data.Map.Internal (Map(..))
13+
14+
15+
16+-- FROM KEYS
17+
18+
19+fromKeys :: (Ord k) => (k -> v) -> [k] -> Map.Map k v
20+fromKeys toValue keys =
21+ Map.fromList $ map (\k -> (k, toValue k)) keys
22+
23+
24+fromKeysA :: (Applicative f, Ord k) => (k -> f v) -> [k] -> f (Map.Map k v)
25+fromKeysA toValue keys =
26+ Map.fromList <$> traverse (\k -> (,) k <$> toValue k) keys
27+
28+
29+fromValues :: (Ord k) => (v -> k) -> [v] -> Map.Map k v
30+fromValues toKey values =
31+ Map.fromList $ map (\v -> (toKey v, v)) values
32+
33+
34+
35+-- ANY
36+
37+
38+{-# INLINE any #-}
39+any :: (v -> Bool) -> Map.Map k v -> Bool
40+any isGood = go
41+ where
42+ go Tip = False
43+ go (Bin _ _ v l r) = isGood v || go l || go r
compiler/src/Data/Name.hs+166−177
@@ -1,130 +1,119 @@
11{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
2−{-# LANGUAGE BangPatterns, EmptyDataDecls, MagicHash, OverloadedStrings, UnboxedTuples #-}
2+{-# LANGUAGE BangPatterns, EmptyDataDecls, FlexibleInstances, MagicHash, UnboxedTuples #-}
33module Data.Name
44 ( Name
5− , toUtf8
6− , fromUtf8
7− , toEscapedBuilder
8− , Utf8.toBuilder
9− , Utf8.fromPtr
10− , Utf8.fromChars
11− , Utf8.toChars
12− -- misc
5+ --
6+ , toChars
7+ , toElmString
8+ , toBuilder
9+ --
10+ , fromPtr
11+ , fromChars
12+ --
1313 , getKernel
1414 , hasDot
15+ , splitDots
1516 , isKernel
1617 , isNumberType
1718 , isComparableType
1819 , isAppendableType
1920 , isCompappendType
2021 , fromVarIndex
21− , fromReplCount
2222 , fromWords
2323 , fromManyNames
2424 , fromTypeVariable
2525 , fromTypeVariableScheme
2626 , sepBy
27− -- interned
27+ --
2828 , int, float, bool, char, string
2929 , maybe, result, list, array, dict, tuple, jsArray
3030 , task, router, cmd, sub, platform, virtualDom
3131 , shader, debug, debugger, bitwise, basics
3232 , utils, negate, true, false, value
33− , node, program, main, dollar, identity
34− , replModule
33+ , node, program, _main, _Main, dollar, identity
34+ , replModule, replValueToPrint
3535 )
3636 where
3737
3838
3939import Prelude hiding (length, maybe, negate)
4040import Control.Exception (assert)
41+import qualified Data.Binary as Binary
4142import qualified Data.ByteString.Builder.Internal as B
42−import Data.Coerce (coerce)
43+import qualified Data.Coerce as Coerce
4344import qualified Data.List as List
45+import qualified Data.String as Chars
4446import qualified Data.Utf8 as Utf8
45−import Foreign.Ptr (plusPtr, minusPtr)
4647import GHC.Exts
47− ( Int(I#), Ptr(Ptr)
48− , RealWorld
48+ ( Int(I#), Ptr
4949 , MutableByteArray#
5050 , isTrue#
5151 , newByteArray#
5252 , sizeofByteArray#
53− , writeWord8OffAddr#
54− , copyByteArrayToAddr#
5553 , unsafeFreezeByteArray#
5654 )
57−import GHC.IO
5855import GHC.ST (ST(ST), runST)
5956import GHC.Prim
6057import GHC.Word (Word8(W8#))
6158
59+import qualified Elm.String as ES
60+
6261
6362
6463-- NAME
6564
6665
67−type Name = Utf8.Under256 NAME
66+type Name =
67+ Utf8.Utf8 ELM_NAME
6868
6969
70−data NAME
70+data ELM_NAME
7171
7272
73−toUtf8 :: Name -> Utf8.String
74−toUtf8 =
75− coerce
7673
74+-- INSTANCES
7775
78−fromUtf8 :: Utf8.String -> Name
79−fromUtf8 =
80− coerce
8176
77+instance Chars.IsString (Utf8.Utf8 ELM_NAME) where
78+ fromString = Utf8.fromChars
8279
80+instance Binary.Binary (Utf8.Utf8 ELM_NAME) where
81+ get = Utf8.getUnder256
82+ put = Utf8.putUnder256
8383
84−-- TO ESCAPED BUILDER
8584
8685
87−{-# INLINE toEscapedBuilder #-}
88−toEscapedBuilder :: Word8 -> Word8 -> Name -> B.Builder
89−toEscapedBuilder before after =
90− \name -> B.builder (toEscapedBuilderHelp before after name)
86+-- TO
9187
9288
93−{-# INLINE toEscapedBuilderHelp #-}
94−toEscapedBuilderHelp :: Word8 -> Word8 -> Name -> B.BuildStep a -> B.BuildStep a
95−toEscapedBuilderHelp before after !name@(Utf8.Utf8 ba#) k =
96− go 0 (I# (sizeofByteArray# ba#))
97− where
98− go !offset !len !(B.BufferRange bOffset bEnd) =
99− let
100− !bLen = minusPtr bEnd bOffset
101− in
102− if len <= bLen then
103− do -- TODO test if writing word-by-word is faster
104− stToIO (copyToPtr name offset bOffset len)
105− stToIO (escape before after bOffset name offset len 0)
106− let !newBufferRange = B.BufferRange (plusPtr bOffset len) bEnd
107− k newBufferRange
108− else
109− do stToIO (copyToPtr name offset bOffset bLen)
110− stToIO (escape before after bOffset name offset bLen 0)
111− let !newOffset = offset + bLen
112− let !newLength = len - bLen
113− return $ B.bufferFull 1 bEnd (go newOffset newLength)
114−
115−
116−escape :: Word8 -> Word8 -> Ptr a -> Name -> Int -> Int -> Int -> ST RealWorld ()
117−escape before@(W8# before#) after ptr name@(Utf8.Utf8 ba#) offset@(I# offset#) len@(I# len#) i@(I# i#) =
118− if isTrue# (i# <# len#) then
119− if isTrue# (eqWord# before# (indexWord8Array# ba# (offset# +# i#)))
120− then
121− do writeWordToPtr ptr i after
122− escape before after ptr name offset len (i + 1)
123− else
124− do escape before after ptr name offset len (i + 1)
89+toChars :: Name -> [Char]
90+toChars =
91+ Utf8.toChars
12592
126− else
127− return ()
93+
94+toElmString :: Name -> ES.String
95+toElmString =
96+ Coerce.coerce
97+
98+
99+{-# INLINE toBuilder #-}
100+toBuilder :: Name -> B.Builder
101+toBuilder =
102+ Utf8.toBuilder
103+
104+
105+
106+-- FROM
107+
108+
109+fromPtr :: Ptr Word8 -> Ptr Word8 -> Name
110+fromPtr =
111+ Utf8.fromPtr
112+
113+
114+fromChars :: [Char] -> Name
115+fromChars =
116+ Utf8.fromChars
128117
129118
130119
@@ -133,7 +122,12 @@ escape before@(W8# before#) after ptr name@(Utf8.Utf8 ba#) offset@(I# offset#) l
133122
134123hasDot :: Name -> Bool
135124hasDot name =
136− Utf8.contains 0x2E {- . -} (coerce name)
125+ Utf8.contains 0x2E {- . -} name
126+
127+
128+splitDots :: Name -> [Name]
129+splitDots name =
130+ Utf8.split 0x2E {- . -} name
137131
138132
139133
@@ -181,23 +175,23 @@ isCompappendType = Utf8.startsWith prefix_compappend
181175
182176{-# NOINLINE prefix_kernel #-}
183177prefix_kernel :: Name
184−prefix_kernel = "Elm.Kernel."
178+prefix_kernel = fromChars "Elm.Kernel."
185179
186180{-# NOINLINE prefix_number #-}
187181prefix_number :: Name
188−prefix_number = "number"
182+prefix_number = fromChars "number"
189183
190184{-# NOINLINE prefix_comparable #-}
191185prefix_comparable :: Name
192−prefix_comparable = "comparable"
186+prefix_comparable = fromChars "comparable"
193187
194188{-# NOINLINE prefix_appendable #-}
195189prefix_appendable :: Name
196−prefix_appendable = "appendable"
190+prefix_appendable = fromChars "appendable"
197191
198192{-# NOINLINE prefix_compappend #-}
199193prefix_compappend :: Name
200−prefix_compappend = "compappend"
194+prefix_compappend = fromChars "compappend"
201195
202196
203197
@@ -208,11 +202,11 @@ fromVarIndex :: Int -> Name
208202fromVarIndex n =
209203 runST
210204 (
211− do let !size = getIndexSize n
205+ do let !size = 2 + getIndexSize n
212206 mba <- newByteArray size
213207 writeWord8 mba 0 0x5F {- _ -}
214208 writeWord8 mba 1 0x76 {- v -}
215− writeDigits mba (size - 1) n
209+ writeDigitsAtEnd mba size n
216210 freeze mba
217211 )
218212
@@ -220,19 +214,20 @@ fromVarIndex n =
220214{-# INLINE getIndexSize #-}
221215getIndexSize :: Int -> Int
222216getIndexSize n
223− | n < 10 = 3
224− | n < 100 = 4
225− | True = 2 + ceiling (logBase 10 (fromIntegral n + 1) :: Float)
217+ | n < 10 = 1
218+ | n < 100 = 2
219+ | True = ceiling (logBase 10 (fromIntegral n + 1) :: Float)
226220
227221
228222
229−writeDigits :: MBA s -> Int -> Int -> ST s ()
230−writeDigits !mba !offset !n =
223+writeDigitsAtEnd :: MBA s -> Int -> Int -> ST s ()
224+writeDigitsAtEnd !mba !oldOffset !n =
231225 do let (q,r) = quotRem n 10
232− writeWord8 mba offset (0x30 + fromIntegral r)
226+ let !newOffset = oldOffset - 1
227+ writeWord8 mba newOffset (0x30 + fromIntegral r)
233228 if q <= 0
234229 then return ()
235− else writeDigits mba (offset-1) q
230+ else writeDigitsAtEnd mba newOffset q
236231
237232
238233
@@ -255,7 +250,7 @@ fromTypeVariable name@(Utf8.Utf8 ba#) index =
255250 mba <- newByteArray size
256251 copyToMBA name mba
257252 writeWord8 mba (I# len#) 0x5F {- _ -}
258− writeDigits mba (size - 1) index
253+ writeDigitsAtEnd mba size index
259254 freeze mba
260255 )
261256 else
@@ -264,7 +259,7 @@ fromTypeVariable name@(Utf8.Utf8 ba#) index =
264259 do let !size = I# len# + getIndexSize index
265260 mba <- newByteArray size
266261 copyToMBA name mba
267− writeDigits mba (size - 1) index
262+ writeDigitsAtEnd mba size index
268263 freeze mba
269264 )
270265
@@ -283,61 +278,61 @@ fromTypeVariableScheme scheme =
283278 freeze mba
284279 else
285280 do let (extra, letter) = quotRem scheme 26
286− let !size = getIndexSize extra
281+ let !size = 1 + getIndexSize extra
287282 mba <- newByteArray size
288283 writeWord8 mba 0 (0x61 + fromIntegral letter)
289− writeDigits mba (size - 1) extra
284+ writeDigitsAtEnd mba size extra
290285 freeze mba
291286 )
292287
293288
294289
295−-- FROM REPL COUNT
296−
297−
298−fromReplCount :: Int -> Name
299−fromReplCount n =
300− Utf8.fromChars ("repl_value_" ++ show n)
301−
302−
303−
304290-- FROM MANY NAMES
291+--
292+-- Creating a unique name by combining all the subnames can create names
293+-- longer than 256 bytes relatively easily. So instead, the first given name
294+-- (e.g. foo) is prefixed chars that are valid in JS but not Elm (e.g. _M$foo)
295+--
296+-- This should be a unique name since 0.19 disallows shadowing. It would not
297+-- be possible for multiple top-level cycles to include values with the same
298+-- name, so the important thing is to make the cycle name distinct from the
299+-- normal name. Same logic for destructuring patterns like (x,y)
305300
306301
307302fromManyNames :: [Name] -> Name
308303fromManyNames names =
309− let
310− !(I# size#) = sum (map (\(Utf8.Utf8 ba#) -> I# (sizeofByteArray# ba# +# 1#)) names)
311− in
312− runST
313− (
314− ST $ \s ->
315− case newByteArray# size# s of
316− (# s, mba# #) ->
317− case writeNames mba# 0# names s of
318− s ->
319− case unsafeFreezeByteArray# mba# s of
320− (# s, ba# #) -> (# s, Utf8.Utf8 ba# #)
321− )
322−
323−
324−writeNames :: MutableByteArray# s -> Int# -> [Name] -> State# s -> State# s
325−writeNames mba# !offset# names s =
326304 case names of
327305 [] ->
328− s
329−
330− (Utf8.Utf8 ba#) : names ->
331− case writeWord8Array# mba# offset# 0x24## {- $ -} s of
332− s ->
333− let
334− !offset1# = offset# +# 1#
335− !len# = sizeofByteArray# ba#
336− !newOffset# = offset1# +# len#
337− in
338− case copyByteArray# ba# 0# mba# offset1# len# s of
339− s ->
340− writeNames mba# newOffset# names s
306+ blank
307+ -- NOTE: this case is needed for (let _ = Debug.log "x" x in ...)
308+ -- but maybe unused patterns should be stripped out instead
309+
310+ Utf8.Utf8 ba# : _ ->
311+ let
312+ len# = sizeofByteArray# ba#
313+ in
314+ runST
315+ (
316+ ST $ \s ->
317+ case newByteArray# (len# +# 3#) s of
318+ (# s, mba# #) ->
319+ case writeWord8Array# mba# 0# 0x5F## {-_-} s of
320+ s ->
321+ case writeWord8Array# mba# 1# 0x4D## {-M-} s of
322+ s ->
323+ case writeWord8Array# mba# 2# 0x24## {-$-} s of
324+ s ->
325+ case copyByteArray# ba# 0# mba# 3# len# s of
326+ s ->
327+ case unsafeFreezeByteArray# mba# s of
328+ (# s, ba# #) -> (# s, Utf8.Utf8 ba# #)
329+ )
330+
331+
332+{-# NOINLINE blank #-}
333+blank :: Name
334+blank =
335+ fromWords [0x5F,0x4D,0x24] {-_M$-}
341336
342337
343338
@@ -423,22 +418,6 @@ writeWord8 (MBA# mba#) (I# offset#) (W8# w#) =
423418 s -> (# s, () #)
424419
425420
426−{-# INLINE writeWordToPtr #-}
427−writeWordToPtr :: Ptr a -> Int -> Word8 -> ST s ()
428−writeWordToPtr (Ptr addr#) (I# offset#) (W8# word#) =
429− ST $ \s ->
430− case writeWord8OffAddr# addr# offset# word# s of
431− s -> (# s, () #)
432−
433−
434−{-# INLINE copyToPtr #-}
435−copyToPtr :: Name -> Int -> Ptr a -> Int -> ST RealWorld ()
436−copyToPtr (Utf8.Utf8 ba#) (I# offset#) (Ptr addr#) (I# len#) =
437− ST $ \s ->
438− case copyByteArrayToAddr# ba# offset# addr# len# s of
439− s -> (# s, () #)
440−
441−
442421{-# INLINE copyToMBA #-}
443422copyToMBA :: Name -> MBA s -> ST s ()
444423copyToMBA (Utf8.Utf8 ba#) (MBA# mba#) =
@@ -453,169 +432,179 @@ copyToMBA (Utf8.Utf8 ba#) (MBA# mba#) =
453432
454433{-# NOINLINE int #-}
455434int :: Name
456−int = "Int"
435+int = fromChars "Int"
457436
458437
459438{-# NOINLINE float #-}
460439float :: Name
461−float = "Float"
440+float = fromChars "Float"
462441
463442
464443{-# NOINLINE bool #-}
465444bool :: Name
466−bool = "Bool"
445+bool = fromChars "Bool"
467446
468447
469448{-# NOINLINE char #-}
470449char :: Name
471−char = "Char"
450+char = fromChars "Char"
472451
473452
474453{-# NOINLINE string #-}
475454string :: Name
476−string = "String"
455+string = fromChars "String"
477456
478457
479458{-# NOINLINE maybe #-}
480459maybe :: Name
481−maybe = "Maybe"
460+maybe = fromChars "Maybe"
482461
483462
484463{-# NOINLINE result #-}
485464result :: Name
486−result = "Result"
465+result = fromChars "Result"
487466
488467
489468{-# NOINLINE list #-}
490469list :: Name
491−list = "List"
470+list = fromChars "List"
492471
493472
494473{-# NOINLINE array #-}
495474array :: Name
496−array = "Array"
475+array = fromChars "Array"
497476
498477
499478{-# NOINLINE dict #-}
500479dict :: Name
501−dict = "Dict"
480+dict = fromChars "Dict"
502481
503482
504483{-# NOINLINE tuple #-}
505484tuple :: Name
506−tuple = "Tuple"
485+tuple = fromChars "Tuple"
507486
508487
509488{-# NOINLINE jsArray #-}
510489jsArray :: Name
511−jsArray = "JsArray"
490+jsArray = fromChars "JsArray"
512491
513492
514493{-# NOINLINE task #-}
515494task :: Name
516−task = "Task"
495+task = fromChars "Task"
517496
518497
519498{-# NOINLINE router #-}
520499router :: Name
521−router = "Router"
500+router = fromChars "Router"
522501
523502
524503{-# NOINLINE cmd #-}
525504cmd :: Name
526−cmd = "Cmd"
505+cmd = fromChars "Cmd"
527506
528507
529508{-# NOINLINE sub #-}
530509sub :: Name
531−sub = "Sub"
510+sub = fromChars "Sub"
532511
533512
534513{-# NOINLINE platform #-}
535514platform :: Name
536−platform = "Platform"
515+platform = fromChars "Platform"
537516
538517
539518{-# NOINLINE virtualDom #-}
540519virtualDom :: Name
541−virtualDom = "VirtualDom"
520+virtualDom = fromChars "VirtualDom"
542521
543522
544523{-# NOINLINE shader #-}
545524shader :: Name
546−shader = "Shader"
525+shader = fromChars "Shader"
547526
548527
549528{-# NOINLINE debug #-}
550529debug :: Name
551−debug = "Debug"
530+debug = fromChars "Debug"
552531
553532
554533{-# NOINLINE debugger #-}
555534debugger :: Name
556−debugger = "Debugger"
535+debugger = fromChars "Debugger"
557536
558537
559538{-# NOINLINE bitwise #-}
560539bitwise :: Name
561−bitwise = "Bitwise"
540+bitwise = fromChars "Bitwise"
562541
563542
564543{-# NOINLINE basics #-}
565544basics :: Name
566−basics = "Basics"
545+basics = fromChars "Basics"
567546
568547
569548{-# NOINLINE utils #-}
570549utils :: Name
571−utils = "Utils"
550+utils = fromChars "Utils"
572551
573552
574553{-# NOINLINE negate #-}
575554negate :: Name
576−negate = "negate"
555+negate = fromChars "negate"
577556
578557
579558{-# NOINLINE true #-}
580559true :: Name
581−true = "True"
560+true = fromChars "True"
582561
583562
584563{-# NOINLINE false #-}
585564false :: Name
586−false = "False"
565+false = fromChars "False"
587566
588567
589568{-# NOINLINE value #-}
590569value :: Name
591−value = "Value"
570+value = fromChars "Value"
592571
593572
594573{-# NOINLINE node #-}
595574node :: Name
596−node = "Node"
575+node = fromChars "Node"
597576
598577
599578{-# NOINLINE program #-}
600579program :: Name
601−program = "Program"
580+program = fromChars "Program"
581+
602582
583+{-# NOINLINE _main #-}
584+_main :: Name
585+_main = fromChars "main"
603586
604−{-# NOINLINE main #-}
605−main :: Name
606−main = "main"
587+
588+{-# NOINLINE _Main #-}
589+_Main :: Name
590+_Main = fromChars "Main"
607591
608592
609593{-# NOINLINE dollar #-}
610594dollar :: Name
611−dollar = "$"
595+dollar = fromChars "$"
612596
613597
614598{-# NOINLINE identity #-}
615599identity :: Name
616−identity = "identity"
600+identity = fromChars "identity"
617601
618602
619603{-# NOINLINE replModule #-}
620604replModule :: Name
621−replModule = "Elm_Repl"
605+replModule = fromChars "Elm_Repl"
606+
607+
608+{-# NOINLINE replValueToPrint #-}
609+replValueToPrint :: Name
610+replValueToPrint = fromChars "repl_input_value_"
compiler/src/Data/NonEmptyList.hsnew file+78
@@ -0,0 +1,78 @@
1+module Data.NonEmptyList
2+ ( List(..)
3+ , singleton
4+ , toList
5+ , sortBy
6+ )
7+ where
8+
9+
10+import Control.Monad (liftM2)
11+import Data.Binary (Binary, get, put)
12+import qualified Data.List as List
13+
14+
15+
16+-- LIST
17+
18+
19+data List a =
20+ List a [a]
21+
22+
23+singleton :: a -> List a
24+singleton a =
25+ List a []
26+
27+
28+toList :: List a -> [a]
29+toList (List x xs) =
30+ x:xs
31+
32+
33+
34+-- INSTANCES
35+
36+
37+instance Functor List where
38+ fmap func (List x xs) = List (func x) (map func xs)
39+
40+
41+instance Traversable List where
42+ traverse func (List x xs) = List <$> func x <*> traverse func xs
43+
44+
45+instance Foldable List where
46+ foldr step state (List x xs) = step x (foldr step state xs)
47+ foldl step state (List x xs) = foldl step (step state x) xs
48+ foldl1 step (List x xs) = foldl step x xs
49+
50+
51+
52+-- SORT BY
53+
54+
55+sortBy :: (Ord b) => (a -> b) -> List a -> List a
56+sortBy toRank (List x xs) =
57+ let
58+ comparison a b =
59+ compare (toRank a) (toRank b)
60+ in
61+ case List.sortBy comparison xs of
62+ [] ->
63+ List x []
64+
65+ y:ys ->
66+ case comparison x y of
67+ LT -> List x (y:ys)
68+ EQ -> List x (y:ys)
69+ GT -> List y (List.insertBy comparison x ys)
70+
71+
72+
73+-- BINARY
74+
75+
76+instance (Binary a) => Binary (List a) where
77+ put (List x xs) = put x >> put xs
78+ get = liftM2 List get get
compiler/src/Data/OneOrMore.hs+51−16
@@ -3,8 +3,9 @@ module Data.OneOrMore
33 ( OneOrMore(..)
44 , one
55 , more
6− , toList
76 , map
7+ , destruct
8+ , getFirstTwo
89 )
910 where
1011
@@ -32,33 +33,67 @@ more =
3233
3334
3435
35−-- TO LIST
36+-- MAP
37+
38+
39+map :: (a -> b) -> OneOrMore a -> OneOrMore b
40+map func oneOrMore =
41+ case oneOrMore of
42+ One value ->
43+ One (func value)
44+
45+ More left right ->
46+ More (map func left) (map func right)
47+
48+
49+
50+-- DESTRUCT
51+
52+
53+destruct :: (a -> [a] -> b) -> OneOrMore a -> b
54+destruct func oneOrMore =
55+ destructLeft func oneOrMore []
3656
3757
38−toList :: OneOrMore a -> [a]
39−toList oneOrMore =
40− toListHelp oneOrMore []
58+destructLeft :: (a -> [a] -> b) -> OneOrMore a -> [a] -> b
59+destructLeft func oneOrMore xs =
60+ case oneOrMore of
61+ One x ->
62+ func x xs
63+
64+ More a b ->
65+ destructLeft func a (destructRight b xs)
4166
4267
43−toListHelp :: OneOrMore a -> [a] -> [a]
44−toListHelp oneOrMore list =
68+destructRight :: OneOrMore a -> [a] -> [a]
69+destructRight oneOrMore xs =
4570 case oneOrMore of
4671 One x ->
47− x : list
72+ x : xs
4873
4974 More a b ->
50− toListHelp a (toListHelp b list)
75+ destructRight a (destructRight b xs)
5176
5277
5378
54−-- MAP
79+-- GET FIRST TWO
5580
5681
57−map :: (a -> b) -> OneOrMore a -> OneOrMore b
58−map func oneOrMore =
82+getFirstTwo :: OneOrMore a -> OneOrMore a -> (a,a)
83+getFirstTwo left right =
84+ case left of
85+ One x ->
86+ (x, getFirstOne right)
87+
88+ More lleft lright ->
89+ getFirstTwo lleft lright
90+
91+
92+getFirstOne :: OneOrMore a -> a
93+getFirstOne oneOrMore =
5994 case oneOrMore of
60− One value ->
61− One (func value)
95+ One x ->
96+ x
6297
63− More left right ->
64− More (map func left) (map func right)
98+ More left _ ->
99+ getFirstOne left
compiler/src/Data/Utf8.hs+158−300
@@ -1,36 +1,42 @@
11{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
2−{-# LANGUAGE BangPatterns, EmptyDataDecls, FlexibleInstances, MagicHash, UnboxedTuples #-}
2+{-# LANGUAGE BangPatterns, FlexibleInstances, MagicHash, UnboxedTuples #-}
33module Data.Utf8
4− ( String
5− , Utf8(..)
6− , VeryLong
7− , Under256
4+ ( Utf8(..)
85 , isEmpty
6+ , empty
97 , size
108 , contains
11− , containsDouble
129 , startsWith
1310 , startsWithChar
14− , endsWithWord
11+ , endsWithWord8
1512 , split
1613 , join
17− , all
18− , any
19− , toWord16
20− , fromWord16
21− -- conversions
22− , fromChars
14+ --
15+ , getUnder256
16+ , putUnder256
17+ --
18+ , getVeryLong
19+ , putVeryLong
20+ --
2321 , toChars
2422 , toBuilder
23+ , toEscapedBuilder
24+ --
2525 , fromPtr
26− , fromChunks
27− , Chunk(..)
26+ , fromSnippet
27+ , fromChars
28+ --
29+ , MBA
30+ , newByteArray
31+ , copyFromPtr
32+ , writeWord8
33+ , freeze
2834 )
2935 where
3036
3137
3238import Prelude hiding (String, all, any, concat)
33−import Data.Binary (Binary(..), Get, getWord8, putWord8)
39+import Data.Binary (Get, get, getWord8, Put, put, putWord8)
3440import Data.Binary.Put (putBuilder)
3541import Data.Binary.Get.Internal (readN)
3642import Data.Bits ((.&.), shiftR)
@@ -38,7 +44,6 @@ import qualified Data.ByteString.Internal as B
3844import qualified Data.ByteString.Builder.Internal as B
3945import qualified Data.Char as Char
4046import qualified Data.List as List
41−import Data.String (IsString(..))
4247import Foreign.ForeignPtr (touchForeignPtr)
4348import Foreign.ForeignPtr.Unsafe (unsafeForeignPtrToPtr)
4449import Foreign.Ptr (minusPtr, plusPtr)
@@ -53,36 +58,35 @@ import GHC.Exts
5358 , copyByteArray#
5459 , copyAddrToByteArray#
5560 , copyByteArrayToAddr#
56− , writeWord8Array#,
61+ , writeWord8Array#
5762 )
5863import GHC.IO
5964import GHC.ST (ST(ST), runST)
6065import GHC.Prim
61−import GHC.Word (Word8(W8#), Word16(W16#))
66+import GHC.Word (Word8(W8#))
67+
68+import qualified Parse.Primitives as P
6269
6370
6471
6572-- UTF-8
6673
6774
68−data Utf8 size tipe =
75+data Utf8 tipe =
6976 Utf8 ByteArray#
7077
7178
72−type String = Utf8 VERY_LONG STRING
73−type VeryLong t = Utf8 VERY_LONG t
74−type Under256 t = Utf8 UNDER_256 t
75−
76−data STRING
77−data VERY_LONG
78−data UNDER_256
7979
80+-- EMPTY
8081
8182
82−-- IS EMPTY
83+{-# NOINLINE empty #-}
84+empty :: Utf8 t
85+empty =
86+ runST (freeze =<< newByteArray 0)
8387
8488
85−isEmpty :: Utf8 l t -> Bool
89+isEmpty :: Utf8 t -> Bool
8690isEmpty (Utf8 ba#) =
8791 isTrue# (sizeofByteArray# ba# ==# 0#)
8892
@@ -91,7 +95,7 @@ isEmpty (Utf8 ba#) =
9195-- SIZE
9296
9397
94−size :: Utf8 l t -> Int
98+size :: Utf8 t -> Int
9599size (Utf8 ba#) =
96100 I# (sizeofByteArray# ba#)
97101
@@ -100,7 +104,7 @@ size (Utf8 ba#) =
100104-- CONTAINS
101105
102106
103−contains :: Word8 -> Utf8 l t -> Bool
107+contains :: Word8 -> Utf8 t -> Bool
104108contains (W8# word#) (Utf8 ba#) =
105109 containsHelp word# ba# 0# (sizeofByteArray# ba#)
106110
@@ -116,32 +120,11 @@ containsHelp word# ba# !offset# len# =
116120
117121
118122
119−-- CONTAINS DOUBLE
120−
121−
122−containsDouble :: Word8 -> Utf8 l t -> Bool
123−containsDouble (W8# word#) (Utf8 ba#) =
124− containsDoubleHelp word# ba# 0# (sizeofByteArray# ba#)
125−
126−
127−containsDoubleHelp :: Word# -> ByteArray# -> Int# -> Int# -> Bool
128−containsDoubleHelp word# ba# !offset# len# =
129− let !offset1# = offset# +# 1# in
130− if isTrue# (offset1# <# len#) then
131− if isTrue# (eqWord# word# (indexWord8Array# ba# offset# ))
132− && isTrue# (eqWord# word# (indexWord8Array# ba# offset1#))
133− then True
134− else containsDoubleHelp word# ba# (offset# +# 1#) len#
135− else
136− False
137−
138−
139−
140123-- STARTS WITH
141124
142125
143126{-# INLINE startsWith #-}
144−startsWith :: Utf8 l t -> Utf8 l t -> Bool
127+startsWith :: Utf8 t -> Utf8 t -> Bool
145128startsWith (Utf8 ba1#) (Utf8 ba2#) =
146129 let
147130 !len1# = sizeofByteArray# ba1#
@@ -156,9 +139,9 @@ startsWith (Utf8 ba1#) (Utf8 ba2#) =
156139-- STARTS WITH CHAR
157140
158141
159−startsWithChar :: (Char -> Bool) -> Utf8 l t -> Bool
160−startsWithChar isGood str@(Utf8 ba#) =
161− if isEmpty str then
142+startsWithChar :: (Char -> Bool) -> Utf8 t -> Bool
143+startsWithChar isGood bytes@(Utf8 ba#) =
144+ if isEmpty bytes then
162145 False
163146 else
164147 let
@@ -176,8 +159,8 @@ startsWithChar isGood str@(Utf8 ba#) =
176159-- ENDS WITH WORD
177160
178161
179−endsWithWord :: Word8 -> Utf8 l t -> Bool
180−endsWithWord (W8# w#) (Utf8 ba#) =
162+endsWithWord8 :: Word8 -> Utf8 t -> Bool
163+endsWithWord8 (W8# w#) (Utf8 ba#) =
181164 let len# = sizeofByteArray# ba# in
182165 isTrue# (len# ># 0#)
183166 &&
@@ -188,12 +171,12 @@ endsWithWord (W8# w#) (Utf8 ba#) =
188171-- SPLIT
189172
190173
191−split :: Word8 -> String -> [String]
174+split :: Word8 -> Utf8 t -> [Utf8 t]
192175split (W8# divider#) str@(Utf8 ba#) =
193176 splitHelp str 0 (findDividers divider# ba# 0# (sizeofByteArray# ba#) [])
194177
195178
196−splitHelp :: String -> Int -> [Int] -> [String]
179+splitHelp :: Utf8 t -> Int -> [Int] -> [Utf8 t]
197180splitHelp str start offsets =
198181 case offsets of
199182 [] ->
@@ -214,7 +197,7 @@ findDividers divider# ba# !offset# len# revOffsets =
214197 reverse revOffsets
215198
216199
217−unsafeSlice :: String -> Int -> Int -> String
200+unsafeSlice :: Utf8 t -> Int -> Int -> Utf8 t
218201unsafeSlice str start end =
219202 let !len = end - start in
220203 if len == 0 then
@@ -230,7 +213,7 @@ unsafeSlice str start end =
230213-- JOIN
231214
232215
233−join :: Word8 -> [String] -> String
216+join :: Word8 -> [Utf8 t] -> Utf8 t
234217join sep strings =
235218 case strings of
236219 [] ->
@@ -244,7 +227,7 @@ join sep strings =
244227 freeze mba
245228
246229
247−joinHelp :: Word8 -> MBA s -> Int -> String -> [String] -> ST s ()
230+joinHelp :: Word8 -> MBA s -> Int -> Utf8 t -> [Utf8 t] -> ST s ()
248231joinHelp sep mba offset str strings =
249232 let
250233 !len = size str
@@ -262,46 +245,10 @@ joinHelp sep mba offset str strings =
262245
263246
264247
265−-- ALL
266−
267−
268−all :: (Char -> Bool) -> Utf8 l t -> Bool
269−all isGood utf8 =
270− not (any (not . isGood) utf8)
271−
272−
273−
274−-- ANY
275−
276−
277−any :: (Char -> Bool) -> Utf8 l t -> Bool
278−any isGood (Utf8 ba#) =
279− anyHelp isGood ba# 0# (sizeofByteArray# ba#)
280−
281−
282−anyHelp :: (Char -> Bool) -> ByteArray# -> Int# -> Int# -> Bool
283−anyHelp isGood ba# offset# len# =
284− if isTrue# (offset# >=# len#) then
285− False
286− else
287− let
288− !w# = indexWord8Array# ba# offset#
289− !(# char, width# #)
290− | isTrue# (ltWord# w# 0xC0##) = (# C# (chr# (word2Int# w#)), 1# #)
291− | isTrue# (ltWord# w# 0xE0##) = (# chr2 ba# offset# w#, 2# #)
292− | isTrue# (ltWord# w# 0xF0##) = (# chr3 ba# offset# w#, 3# #)
293− | True = (# chr4 ba# offset# w#, 4# #)
294− in
295− if isGood char
296− then True
297− else anyHelp isGood ba# (offset# +# width#) len#
298−
299−
300−
301248-- EQUAL
302249
303250
304−instance Eq (Utf8 l t) where
251+instance Eq (Utf8 t) where
305252 (==) (Utf8 ba1#) (Utf8 ba2#) =
306253 let
307254 !len1# = sizeofByteArray# ba1#
@@ -314,9 +261,11 @@ instance Eq (Utf8 l t) where
314261
315262
316263-- COMPARE
264+--
265+-- TODO: is it fine to sort by length and only compare bytes on length ties?
266+--
317267
318−
319−instance Ord (Utf8 l t) where
268+instance Ord (Utf8 t) where
320269 compare (Utf8 ba1#) (Utf8 ba2#) =
321270 let
322271 !len1# = sizeofByteArray# ba1#
@@ -333,84 +282,20 @@ instance Ord (Utf8 l t) where
333282
334283
335284
336−-- TO WORD16
337−
338−
339−toWord16 :: String -> Maybe Word16
340−toWord16 (Utf8 ba#) =
341− let !len# = sizeofByteArray# ba# in
342− if isTrue# (len# ==# 0#) then
343− Nothing
344− else
345− let !w# = indexWord8Array# ba# 0# in
346− if isTrue# (eqWord# w# 0x30##) then
347− if isTrue# (len# ==# 1#) then Just 0 else Nothing
348− else
349− toWordHelp ba# 0# len# 0##
350−
351−
352−toWordHelp :: ByteArray# -> Int# -> Int# -> Word# -> Maybe Word16
353−toWordHelp ba# offset# len# number# =
354− if isTrue# (offset# <# len#) then
355− let !w# = indexWord8Array# ba# offset# in
356− if isTrue# (leWord# w# 0x39##) && isTrue# (geWord# w# 0x30##) then
357− let !newNumber# = plusWord# (timesWord# 10## number#) (minusWord# w# 0x30##) in
358− toWordHelp ba# (offset# +# 1#) len# newNumber#
359− else
360− Nothing
361− else
362− Just (W16# number#)
363−
364−
365−
366−-- FROM WORD16
367−
368−
369−fromWord16 :: Word16 -> String
370−fromWord16 n =
371− runST $
372− do let !size = getWordSize n
373− mba <- newByteArray size
374− writeDigits mba (size - 1) n
375− freeze mba
376−
377−
378−getWordSize :: Word16 -> Int
379−getWordSize n
380− | n < 10 = 1
381− | n < 100 = 2
382− | True = ceiling (logBase 10 (fromIntegral n + 1) :: Float)
383−
384−
385−writeDigits :: MBA s -> Int -> Word16 -> ST s ()
386−writeDigits !mba !offset !n =
387− do let (q,r) = quotRem n 10
388− writeWord8 mba offset (0x30 + fromIntegral r)
389− if q <= 0
390− then return ()
391− else writeDigits mba (offset-1) q
392−
393−
394−
395285-- FROM STRING
396286
397287
398−fromChars :: [Char] -> Utf8 l t
399−fromChars =
400− fromString
401−
402−
403−instance IsString (Utf8 l t) where
404− fromString str =
405− runST
406− (
407− do mba <- newByteArray (sum (map getWidth str))
408− writeString mba 0 str
409− )
288+fromChars :: [Char] -> Utf8 t
289+fromChars chars =
290+ runST
291+ (
292+ do mba <- newByteArray (sum (map getWidth chars))
293+ writeChars mba 0 chars
294+ )
410295
411296
412−writeString :: MBA s -> Int -> [Char] -> ST s (Utf8 l t)
413−writeString !mba !offset chars =
297+writeChars :: MBA s -> Int -> [Char] -> ST s (Utf8 t)
298+writeChars !mba !offset chars =
414299 case chars of
415300 [] ->
416301 freeze mba
@@ -418,25 +303,25 @@ writeString !mba !offset chars =
418303 char : chars
419304 | n < 0x80 ->
420305 do writeWord8 mba (offset ) (fromIntegral n)
421− writeString mba (offset + 1) chars
306+ writeChars mba (offset + 1) chars
422307
423308 | n < 0x800 ->
424309 do writeWord8 mba (offset ) (fromIntegral ((shiftR n 6 ) + 0xC0))
425310 writeWord8 mba (offset + 1) (fromIntegral (( n .&. 0x3F) + 0x80))
426− writeString mba (offset + 2) chars
311+ writeChars mba (offset + 2) chars
427312
428313 | n < 0x10000 ->
429314 do writeWord8 mba (offset ) (fromIntegral ((shiftR n 12 ) + 0xE0))
430315 writeWord8 mba (offset + 1) (fromIntegral ((shiftR n 6 .&. 0x3F) + 0x80))
431316 writeWord8 mba (offset + 2) (fromIntegral (( n .&. 0x3F) + 0x80))
432− writeString mba (offset + 3) chars
317+ writeChars mba (offset + 3) chars
433318
434319 | otherwise ->
435320 do writeWord8 mba (offset ) (fromIntegral ((shiftR n 18 ) + 0xF0))
436321 writeWord8 mba (offset + 1) (fromIntegral ((shiftR n 12 .&. 0x3F) + 0x80))
437322 writeWord8 mba (offset + 2) (fromIntegral ((shiftR n 6 .&. 0x3F) + 0x80))
438323 writeWord8 mba (offset + 3) (fromIntegral (( n .&. 0x3F) + 0x80))
439− writeString mba (offset + 4) chars
324+ writeChars mba (offset + 4) chars
440325
441326 where
442327 n = Char.ord char
@@ -454,10 +339,10 @@ getWidth char
454339
455340
456341
457−-- TO STRING
342+-- TO CHARS
458343
459344
460−toChars :: Utf8 l t -> [Char]
345+toChars :: Utf8 t -> [Char]
461346toChars (Utf8 ba#) =
462347 toCharsHelp ba# 0# (sizeofByteArray# ba#)
463348
@@ -527,13 +412,13 @@ chr4 ba# offset# firstWord# =
527412
528413
529414{-# INLINE toBuilder #-}
530−toBuilder :: Utf8 l t -> B.Builder
415+toBuilder :: Utf8 t -> B.Builder
531416toBuilder =
532417 \bytes -> B.builder (toBuilderHelp bytes)
533418
534419
535420{-# INLINE toBuilderHelp #-}
536−toBuilderHelp :: Utf8 l t -> B.BuildStep a -> B.BuildStep a
421+toBuilderHelp :: Utf8 t -> B.BuildStep a -> B.BuildStep a
537422toBuilderHelp !bytes@(Utf8 ba#) k =
538423 go 0 (I# (sizeofByteArray# ba#))
539424 where
@@ -553,144 +438,109 @@ toBuilderHelp !bytes@(Utf8 ba#) k =
553438
554439
555440
556−-- FROM PTR
441+-- TO ESCAPED BUILDER
557442
558443
559−fromPtr :: Ptr Word8 -> Ptr Word8 -> Utf8 l t
560−fromPtr pos end =
561− unsafeDupablePerformIO (stToIO (
562− do let !len = minusPtr end pos
563− mba <- newByteArray len
564− copyFromPtr pos mba 0 len
565− freeze mba
566− ))
444+{-# INLINE toEscapedBuilder #-}
445+toEscapedBuilder :: Word8 -> Word8 -> Utf8 t -> B.Builder
446+toEscapedBuilder before after =
447+ \name -> B.builder (toEscapedBuilderHelp before after name)
567448
568449
450+{-# INLINE toEscapedBuilderHelp #-}
451+toEscapedBuilderHelp :: Word8 -> Word8 -> Utf8 t -> B.BuildStep a -> B.BuildStep a
452+toEscapedBuilderHelp before after !name@(Utf8 ba#) k =
453+ go 0 (I# (sizeofByteArray# ba#))
454+ where
455+ go !offset !len !(B.BufferRange bOffset bEnd) =
456+ let
457+ !bLen = minusPtr bEnd bOffset
458+ in
459+ if len <= bLen then
460+ do -- PERF test if writing word-by-word is faster
461+ copyToPtr name offset bOffset len
462+ escape before after bOffset name offset len 0
463+ let !newBufferRange = B.BufferRange (plusPtr bOffset len) bEnd
464+ k newBufferRange
465+ else
466+ do copyToPtr name offset bOffset bLen
467+ escape before after bOffset name offset bLen 0
468+ let !newOffset = offset + bLen
469+ let !newLength = len - bLen
470+ return $ B.bufferFull 1 bEnd (go newOffset newLength)
471+
472+
473+escape :: Word8 -> Word8 -> Ptr a -> Utf8 t -> Int -> Int -> Int -> IO ()
474+escape before@(W8# before#) after ptr name@(Utf8 ba#) offset@(I# offset#) len@(I# len#) i@(I# i#) =
475+ if isTrue# (i# <# len#) then
476+ if isTrue# (eqWord# before# (indexWord8Array# ba# (offset# +# i#)))
477+ then
478+ do writeWordToPtr ptr i after
479+ escape before after ptr name offset len (i + 1)
480+ else
481+ do escape before after ptr name offset len (i + 1)
482+
483+ else
484+ return ()
569485
570−-- FROM CHUNKS
571486
572487
573−data Chunk
574− = Slice (Ptr Word8) Int
575− | Escape Word8
576− | CodePoint Int
488+-- FROM PTR
577489
578490
579−fromChunks :: [Chunk] -> Utf8 l t
580−fromChunks chunks =
491+fromPtr :: Ptr Word8 -> Ptr Word8 -> Utf8 t
492+fromPtr pos end =
581493 unsafeDupablePerformIO (stToIO (
582− do let !len = sum (map chunkToWidth chunks)
494+ do let !len = minusPtr end pos
583495 mba <- newByteArray len
584− writeChunks mba 0 chunks
496+ copyFromPtr pos mba 0 len
585497 freeze mba
586498 ))
587499
588500
589−chunkToWidth :: Chunk -> Int
590−chunkToWidth chunk =
591− case chunk of
592− Slice _ len ->
593− len
594−
595− Escape _ ->
596− 2
597−
598− CodePoint code ->
599− if code < 0xFFFF then 6 else 12
600−
601−
602−writeChunks :: MBA RealWorld -> Int -> [Chunk] -> ST RealWorld ()
603−writeChunks mba offset chunks =
604− case chunks of
605− [] ->
606− return ()
607−
608− chunk : chunks ->
609− case chunk of
610− Slice ptr len ->
611− do copyFromPtr ptr mba offset len
612− let !newOffset = offset + len
613− writeChunks mba newOffset chunks
614−
615− Escape word ->
616− do writeWord8 mba offset 0x5C {- \ -}
617− writeWord8 mba (offset + 1) word
618− let !newOffset = offset + 2
619− writeChunks mba newOffset chunks
620−
621− CodePoint code ->
622− if code < 0xFFFF then
623− do writeCode mba offset code
624− let !newOffset = offset + 6
625− writeChunks mba newOffset chunks
626− else
627− do let (hi,lo) = divMod (code - 0x10000) 0x400
628− writeCode mba (offset ) (hi + 0xD800)
629− writeCode mba (offset + 6) (lo + 0xDC00)
630− let !newOffset = offset + 12
631− writeChunks mba newOffset chunks
632−
633−
634−-- TODO see if it is faster to writeWord32 a block of hex-as-ascii
635−writeCode :: MBA RealWorld -> Int -> Int -> ST RealWorld ()
636−writeCode mba offset code =
637− do writeWord8 mba offset 0x5C {- \ -}
638− writeWord8 mba offset 0x75 {- u -}
639− writeHex mba (offset + 2) (shiftR code 12)
640− writeHex mba (offset + 3) (shiftR code 8)
641− writeHex mba (offset + 4) (shiftR code 4)
642− writeHex mba (offset + 5) code
643−
644−
645−writeHex :: MBA RealWorld -> Int -> Int -> ST RealWorld ()
646−writeHex mba !offset !bits =
647− do let !n = fromIntegral bits .&. 0x0F
648− writeWord8 mba offset (if n < 10 then 0x30 + n else 0x37 + n)
649501
502+-- FROM SNIPPET
650503
651504
652−-- UNDER 256 BINARY
653−
654−
655−instance Binary (Utf8 UNDER_256 t) where
656− put bytes@(Utf8 ba#) =
657− do putWord8 (W8# (int2Word# (sizeofByteArray# ba#)))
658− putBuilder (toBuilder bytes)
659− get =
660− getUnder256 =<< getWord8
505+fromSnippet :: P.Snippet -> Utf8 t
506+fromSnippet (P.Snippet fptr off len _ _) =
507+ unsafeDupablePerformIO (stToIO (
508+ do mba <- newByteArray len
509+ let !pos = plusPtr (unsafeForeignPtrToPtr fptr) off
510+ copyFromPtr pos mba 0 len
511+ freeze mba
512+ ))
661513
662514
663−{-# INLINE getUnder256 #-}
664−getUnder256 :: Word8 -> Get (Utf8 UNDER_256 t)
665−getUnder256 w =
666− let !n = fromIntegral w in
667− readN n (copyFromByteString n)
668515
516+-- BINARY
669517
670518
671−-- VERY LONG BINARY
519+putUnder256 :: Utf8 t -> Put
520+putUnder256 bytes =
521+ do putWord8 (fromIntegral (size bytes))
522+ putBuilder (toBuilder bytes)
672523
673524
674−instance Binary (Utf8 VERY_LONG t) where
675− put str =
676− do put (size str)
677− putBuilder (toBuilder str)
678− get =
679− getVeryLong =<< get
525+getUnder256 :: Get (Utf8 t)
526+getUnder256 =
527+ do word <- getWord8
528+ let !n = fromIntegral word
529+ readN n (copyFromByteString n)
680530
681531
682−{-# INLINE getVeryLong #-}
683−getVeryLong :: Int -> Get (Utf8 VERY_LONG t)
684−getVeryLong n =
685− if n > 0
686− then readN n (copyFromByteString n)
687− else return empty
532+putVeryLong :: Utf8 t -> Put
533+putVeryLong bytes =
534+ do put (size bytes)
535+ putBuilder (toBuilder bytes)
688536
689537
690−{-# NOINLINE empty #-}
691−empty :: Utf8 l t
692−empty =
693− runST (freeze =<< newByteArray 0)
538+getVeryLong :: Get (Utf8 t)
539+getVeryLong =
540+ do n <- get
541+ if n > 0
542+ then readN n (copyFromByteString n)
543+ else return empty
694544
695545
696546
@@ -698,7 +548,7 @@ empty =
698548
699549
700550{-# INLINE copyFromByteString #-}
701−copyFromByteString :: Int -> B.ByteString -> Utf8 l t
551+copyFromByteString :: Int -> B.ByteString -> Utf8 t
702552copyFromByteString len (B.PS fptr offset _) =
703553 unsafeDupablePerformIO
704554 (
@@ -717,21 +567,21 @@ data MBA s =
717567 MBA# (MutableByteArray# s)
718568
719569
720−newByteArray :: Int -> ST s (MBA s) -- TODO see if newPinnedByteArray for len > 256 is positive
570+newByteArray :: Int -> ST s (MBA s) -- PERF see if newPinnedByteArray for len > 256 is positive
721571newByteArray (I# len#) =
722572 ST $ \s ->
723573 case newByteArray# len# s of
724574 (# s, mba# #) -> (# s, MBA# mba# #)
725575
726576
727−freeze :: MBA s -> ST s (Utf8 l t)
577+freeze :: MBA s -> ST s (Utf8 t)
728578freeze (MBA# mba#) =
729579 ST $ \s ->
730580 case unsafeFreezeByteArray# mba# s of
731581 (# s, ba# #) -> (# s, Utf8 ba# #)
732582
733583
734−copy :: Utf8 l t -> Int -> MBA s -> Int -> Int -> ST s ()
584+copy :: Utf8 t -> Int -> MBA s -> Int -> Int -> ST s ()
735585copy (Utf8 ba#) (I# offset#) (MBA# mba#) (I# i#) (I# len#) =
736586 ST $ \s ->
737587 case copyByteArray# ba# offset# mba# i# len# s of
@@ -745,11 +595,11 @@ copyFromPtr (Ptr src#) (MBA# mba#) (I# offset#) (I# len#) =
745595 s -> (# s, () #)
746596
747597
748−copyToPtr :: Utf8 l t -> Int -> Ptr a -> Int -> IO ()
598+copyToPtr :: Utf8 t -> Int -> Ptr a -> Int -> IO ()
749599copyToPtr (Utf8 ba#) (I# offset#) (Ptr mba#) (I# len#) =
750− IO $ \s ->
751− case copyByteArrayToAddr# ba# offset# mba# len# s of
752− s -> (# s, () #)
600+ IO $ \s ->
601+ case copyByteArrayToAddr# ba# offset# mba# len# s of
602+ s -> (# s, () #)
753603
754604
755605{-# INLINE writeWord8 #-}
@@ -758,3 +608,11 @@ writeWord8 (MBA# mba#) (I# offset#) (W8# w#) =
758608 ST $ \s ->
759609 case writeWord8Array# mba# offset# w# s of
760610 s -> (# s, () #)
611+
612+
613+{-# INLINE writeWordToPtr #-}
614+writeWordToPtr :: Ptr a -> Int -> Word8 -> IO ()
615+writeWordToPtr (Ptr addr#) (I# offset#) (W8# word#) =
616+ IO $ \s ->
617+ case writeWord8OffAddr# addr# offset# word# s of
618+ s -> (# s, () #)
compiler/src/Elm/Compiler.hsdeleted−94
@@ -1,94 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Elm.Compiler
3− ( version
4− , Compile.DocsFlag(..)
5− , Compile.Artifacts(..)
6− , compile
7− , Error.Error
8− , errorsToDoc
9− , errorsToJson
10− , Warning.Warning
11− )
12− where
13−
14−
15−import qualified Data.ByteString as BS
16−import qualified Data.Map as Map
17−import qualified Data.Text as Text
18−
19−import qualified Compile
20−import qualified Elm.Compiler.Version
21−import qualified Elm.Interface as I
22−import qualified Elm.ModuleName as ModuleName
23−import qualified Elm.Package as Pkg
24−import qualified Json.Encode as Encode
25−import qualified Reporting.Doc as D
26−import qualified Reporting.Error as Error
27−import qualified Reporting.Render.Code as Code
28−import qualified Reporting.Region as Region
29−import qualified Reporting.Report as Report
30−import qualified Reporting.Result as Result
31−import qualified Reporting.Warning as Warning
32−
33−
34−
35−-- VERSION
36−
37−
38−version :: Pkg.Version
39−version =
40− Elm.Compiler.Version.version
41−
42−
43−
44−-- COMPILE
45−
46−
47−compile
48− :: Compile.DocsFlag
49− -> Pkg.Name
50− -> Map.Map ModuleName.Raw ModuleName.Canonical
51− -> I.Interfaces
52− -> BS.ByteString
53− -> ( [Warning.Warning], Either [Error.Error] Compile.Artifacts )
54−compile docsFlag pkg importDict interfaces source =
55− Result.run $ Compile.compile docsFlag pkg importDict interfaces source
56−
57−
58−
59−-- ERRORS TO DOC
60−
61−
62−errorsToDoc :: FilePath -> Text.Text -> [Error.Error] -> D.Doc
63−errorsToDoc filePath source errors =
64− let
65− reports =
66− concatMap (Error.toReports (Code.toSource source)) errors
67− in
68− D.vcat $ map (Report.toDoc filePath) reports
69−
70−
71−
72−-- ERRORS TO JSON
73−
74−
75−errorsToJson :: ModuleName.Raw -> FilePath -> Text.Text -> [Error.Error] -> Encode.Value
76−errorsToJson moduleName filePath source errors =
77− let
78− reports =
79− concatMap (Error.toReports (Code.toSource source)) errors
80− in
81− Encode.object
82− [ ("path", Encode.text (Text.pack filePath))
83− , ("name", Encode.name moduleName)
84− , ("problems", Encode.array (map reportToJson reports))
85− ]
86−
87−
88−reportToJson :: Report.Report -> Encode.Value
89−reportToJson (Report.Report title region _sgstns message) =
90− Encode.object
91− [ ("title", Encode.text (Text.pack title))
92− , ("region", Region.encode region)
93− , ("message", D.encode message)
94− ]
compiler/src/Elm/Compiler/Imports.hs+4−13
@@ -1,7 +1,7 @@
11{-# OPTIONS_GHC -Wall #-}
22{-# LANGUAGE OverloadedStrings #-}
33module Elm.Compiler.Imports
4− ( addDefaults
4+ ( defaults
55 )
66 where
77
@@ -14,15 +14,6 @@ import qualified Reporting.Annotation as A
1414
1515
1616
17−-- ADD DEFAULTS
18−
19−
20−addDefaults :: [Src.Import] -> [Src.Import]
21−addDefaults imports =
22− defaults ++ imports
23−
24−
25−
2617-- DEFAULTS
2718
2819
@@ -58,14 +49,14 @@ closed =
5849
5950typeOpen :: Name.Name -> Src.Exposing
6051typeOpen name =
61− Src.Explicit [ A.At A.zero (Src.Upper name Src.Public) ]
52+ Src.Explicit [ Src.Upper (A.At A.zero name) (Src.Public A.zero) ]
6253
6354
6455typeClosed :: Name.Name -> Src.Exposing
6556typeClosed name =
66− Src.Explicit [ A.At A.zero (Src.Upper name Src.Private) ]
57+ Src.Explicit [ Src.Upper (A.At A.zero name) Src.Private ]
6758
6859
6960operator :: Name.Name -> Src.Exposing
7061operator op =
71− Src.Explicit [ A.At A.zero (Src.Operator op) ]
62+ Src.Explicit [ Src.Operator A.zero op ]
compiler/src/Elm/Compiler/Objects.hsdeleted−108
@@ -1,108 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module Elm.Compiler.Objects
3− ( JS.Output(..)
4− , JS.generate
5− , JS.generateForRepl
6− , Opt.Graph
7− , empty
8− , union
9− , unions
10− , Kernel(..)
11− , fromKernels
12− )
13− where
14−
15−
16−import qualified Data.List as List
17−import qualified Data.Map as Map
18−import qualified Data.Name as Name
19−
20−import qualified AST.Optimized as Opt
21−import qualified Elm.ModuleName as ModuleName
22−import qualified Elm.Package as Pkg
23−import qualified Generate.JavaScript as JS
24−
25−
26−
27−-- COMBINE GRAPHS
28−
29−
30−{-# NOINLINE empty #-}
31−empty :: Opt.Graph
32−empty =
33− Opt.Graph Map.empty Map.empty Map.empty
34−
35−
36−union :: Opt.Graph -> Opt.Graph -> Opt.Graph
37−union (Opt.Graph mains1 graph1 fields1) (Opt.Graph mains2 graph2 fields2) =
38− Opt.Graph
39− (Map.union mains1 mains2)
40− (Map.union graph1 graph2)
41− (Map.union fields1 fields2)
42−
43−
44−unions :: [Opt.Graph] -> Opt.Graph
45−unions graphs =
46− case graphs of
47− [] ->
48− empty
49−
50− g:gs ->
51− List.foldl' union g gs
52−
53−
54−
55−-- KERNEL GRAPHS
56−
57−
58−data Kernel =
59− Kernel
60− { _client :: Opt.KContent
61− , _server :: Maybe Opt.KContent
62− }
63−
64−
65−fromKernels :: Map.Map Name.Name Kernel -> Opt.Graph
66−fromKernels kernels =
67− Opt.Graph
68− Map.empty
69− (Map.mapKeys toGlobal (Map.map toNode kernels))
70− (Map.foldl' addKernel Map.empty kernels)
71−
72−
73−
74−-- KERNEL TO NODES
75−
76−
77−toGlobal :: Name.Name -> Opt.Global
78−toGlobal home =
79− Opt.Global (ModuleName.Canonical Pkg.kernel (Name.getKernel home)) Name.dollar
80−
81−
82−toNode :: Kernel -> Opt.Node
83−toNode (Kernel client server) =
84− Opt.Kernel client server
85−
86−
87−
88−-- KERNEL TO ELM FIELDS
89−
90−
91−addKernel :: Map.Map Name.Name Int -> Kernel -> Map.Map Name.Name Int
92−addKernel fields (Kernel client maybeServer) =
93− addContent (maybe fields (addContent fields) maybeServer) client
94−
95−
96−addContent :: Map.Map Name.Name Int -> Opt.KContent -> Map.Map Name.Name Int
97−addContent fields (Opt.KContent chunks _) =
98− List.foldl' addChunk fields chunks
99−
100−
101−addChunk :: Map.Map Name.Name Int -> Opt.KChunk -> Map.Map Name.Name Int
102−addChunk fields chunk =
103− case chunk of
104− Opt.ElmField name ->
105− Map.insertWith (+) name 1 fields
106−
107− _ ->
108− fields
compiler/src/Elm/Compiler/Type.hs+33−35
@@ -15,21 +15,19 @@ module Elm.Compiler.Type
1515
1616
1717import qualified Data.Name as Name
18−import qualified Data.Text as Text
19−import qualified Data.Text.Encoding as Text
2018
2119import qualified AST.Source as Src
22−import qualified Parse.Primitives as Parse
20+import qualified Json.Decode as D
21+import qualified Json.Encode as E
22+import Json.Encode ((==>))
23+import qualified Json.String as Json
24+import qualified Parse.Primitives as P
2325import qualified Parse.Type as Type
2426import qualified Reporting.Annotation as A
2527import qualified Reporting.Doc as D
2628import qualified Reporting.Render.Type as RT
2729import qualified Reporting.Render.Type.Localizer as L
2830
29−import qualified Json.Decode as Decode
30−import qualified Json.Encode as Encode
31−import Json.Encode ((==>))
32−
3331
3432
3533-- TYPES
@@ -113,20 +111,18 @@ collectLambdas tipe =
113111-- JSON for TYPE
114112
115113
116−encode :: Type -> Encode.Value
114+encode :: Type -> E.Value
117115encode tipe =
118− Encode.text $ Text.pack $ D.toLine (toDoc L.empty RT.None tipe)
116+ E.chars $ D.toLine (toDoc L.empty RT.None tipe)
119117
120118
121−decoder :: Decode.Decoder () Type
119+decoder :: D.Decoder () Type
122120decoder =
123− do txt <- Decode.text
124− case Parse.run Type.expression (Text.encodeUtf8 (Text.replace "'" "_" txt)) of
125− Left _ ->
126− Decode.fail ()
127−
128− Right (tipe, _, _) ->
129− Decode.succeed (fromRawType tipe)
121+ let
122+ parser =
123+ P.specialize (\_ _ _ -> ()) (fromRawType . fst <$> Type.expression)
124+ in
125+ D.customString parser (\_ _ -> ())
130126
131127
132128fromRawType :: Src.Type -> Type
@@ -164,33 +160,35 @@ fromRawType (A.At _ astType) =
164160-- JSON for PROGRAM
165161
166162
167−encodeMetadata :: DebugMetadata -> Encode.Value
163+encodeMetadata :: DebugMetadata -> E.Value
168164encodeMetadata (DebugMetadata msg aliases unions) =
169− Encode.object
165+ E.object
170166 [ "message" ==> encode msg
171− , "aliases" ==> Encode.object (map toAliasField aliases)
172− , "unions" ==> Encode.object (map toUnionField unions)
167+ , "aliases" ==> E.object (map toTypeAliasField aliases)
168+ , "unions" ==> E.object (map toCustomTypeField unions)
173169 ]
174170
175171
176−toAliasField :: Alias -> ( Text.Text, Encode.Value )
177−toAliasField (Alias name args tipe) =
178− Name.toText name ==>
179− Encode.object
180− [ "args" ==> Encode.list Encode.name args
172+toTypeAliasField :: Alias -> ( Json.String, E.Value )
173+toTypeAliasField (Alias name args tipe) =
174+ ( Json.fromName name
175+ , E.object
176+ [ "args" ==> E.list E.name args
181177 , "type" ==> encode tipe
182178 ]
179+ )
183180
184181
185−toUnionField :: Union -> ( Text.Text, Encode.Value )
186−toUnionField (Union name args constructors) =
187− Name.toText name ==>
188− Encode.object
189− [ "args" ==> Encode.list Encode.name args
190− , "tags" ==> Encode.object (map toCtorObject constructors)
182+toCustomTypeField :: Union -> ( Json.String, E.Value )
183+toCustomTypeField (Union name args constructors) =
184+ ( Json.fromName name
185+ , E.object
186+ [ "args" ==> E.list E.name args
187+ , "tags" ==> E.object (map toVariantObject constructors)
191188 ]
189+ )
192190
193191
194−toCtorObject :: (Name.Name, [Type]) -> ( Text.Text, Encode.Value )
195−toCtorObject (name, args) =
196− Name.toText name ==> Encode.list encode args
192+toVariantObject :: (Name.Name, [Type]) -> ( Json.String, E.Value )
193+toVariantObject (name, args) =
194+ ( Json.fromName name, E.list encode args )
compiler/src/Elm/Compiler/Type/Extract.hs+69−20
@@ -1,15 +1,20 @@
11{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE Rank2Types #-}
2+{-# LANGUAGE BangPatterns, OverloadedStrings, Rank2Types #-}
43module Elm.Compiler.Type.Extract
54 ( fromAnnotation
65 , fromType
6+ , Types(..)
7+ , mergeMany
8+ , merge
9+ , fromInterface
10+ , fromDependencyInterface
711 , fromMsg
812 )
913 where
1014
1115
1216import Data.Map ((!))
17+import qualified Data.Map as Map
1318import qualified Data.Maybe as Maybe
1419import qualified Data.Name as Name
1520import qualified Data.Set as Set
@@ -77,23 +82,70 @@ toPublicName (ModuleName.Canonical _ home) name =
7782
7883
7984
85+-- TRANSITIVELY AVAILABLE TYPES
86+
87+
88+newtype Types =
89+ Types (Map.Map ModuleName.Canonical Types_)
90+ -- PERF profile Opt.Global representation
91+ -- current representation needs less allocation
92+ -- but maybe the lookup is much worse
93+
94+
95+data Types_ =
96+ Types_
97+ { _union_info :: Map.Map Name.Name Can.Union
98+ , _alias_info :: Map.Map Name.Name Can.Alias
99+ }
100+
101+
102+mergeMany :: [Types] -> Types
103+mergeMany listOfTypes =
104+ case listOfTypes of
105+ [] -> Types Map.empty
106+ t:ts -> foldr merge t ts
107+
108+
109+merge :: Types -> Types -> Types
110+merge (Types types1) (Types types2) =
111+ Types (Map.union types1 types2)
112+
113+
114+fromInterface :: ModuleName.Raw -> I.Interface -> Types
115+fromInterface name (I.Interface pkg _ unions aliases _) =
116+ Types $ Map.singleton (ModuleName.Canonical pkg name) $
117+ Types_ (Map.map I.extractUnion unions) (Map.map I.extractAlias aliases)
118+
119+
120+fromDependencyInterface :: ModuleName.Canonical -> I.DependencyInterface -> Types
121+fromDependencyInterface home di =
122+ Types $ Map.singleton home $
123+ case di of
124+ I.Public (I.Interface _ _ unions aliases _) ->
125+ Types_ (Map.map I.extractUnion unions) (Map.map I.extractAlias aliases)
126+
127+ I.Private _ unions aliases ->
128+ Types_ unions aliases
129+
130+
131+
80132-- EXTRACT MODEL, MSG, AND ANY TRANSITIVE DEPENDENCIES
81133
82134
83−fromMsg :: I.Interfaces -> Can.Type -> T.DebugMetadata
84−fromMsg interfaces message =
135+fromMsg :: Types -> Can.Type -> T.DebugMetadata
136+fromMsg types message =
85137 let
86138 (msgDeps, msgType) =
87139 run (extract message)
88140
89141 (aliases, unions) =
90− extractTransitive interfaces noDeps msgDeps
142+ extractTransitive types noDeps msgDeps
91143 in
92144 T.DebugMetadata msgType aliases unions
93145
94146
95−extractTransitive :: I.Interfaces -> Deps -> Deps -> ( [T.Alias], [T.Union] )
96−extractTransitive interfaces (Deps seenAliases seenUnions) (Deps nextAliases nextUnions) =
147+extractTransitive :: Types -> Deps -> Deps -> ( [T.Alias], [T.Union] )
148+extractTransitive types (Deps seenAliases seenUnions) (Deps nextAliases nextUnions) =
97149 let
98150 aliases = Set.difference nextAliases seenAliases
99151 unions = Set.difference nextUnions seenUnions
@@ -106,39 +158,36 @@ extractTransitive interfaces (Deps seenAliases seenUnions) (Deps nextAliases nex
106158 (newDeps, result) =
107159 run $
108160 (,)
109− <$> traverse (extractAlias interfaces) (Set.toList aliases)
110− <*> traverse (extractUnion interfaces) (Set.toList unions)
161+ <$> traverse (extractAlias types) (Set.toList aliases)
162+ <*> traverse (extractUnion types) (Set.toList unions)
111163
112164 oldDeps =
113165 Deps (Set.union seenAliases nextAliases) (Set.union seenUnions nextUnions)
114166
115167 remainingResult =
116− extractTransitive interfaces oldDeps newDeps
168+ extractTransitive types oldDeps newDeps
117169 in
118170 mappend result remainingResult
119171
120172
121−extractAlias :: I.Interfaces -> Opt.Global -> Extractor T.Alias
122−extractAlias interfaces (Opt.Global home name) =
173+extractAlias :: Types -> Opt.Global -> Extractor T.Alias
174+extractAlias (Types dict) (Opt.Global home name) =
123175 let
124− (I.Interface _ _ aliases _) = interfaces ! home
125− (Can.Alias args aliasType) = I.toAliasInternals (aliases ! name)
176+ (Can.Alias args aliasType) = _alias_info (dict ! home) ! name
126177 in
127178 T.Alias (toPublicName home name) args <$> extract aliasType
128179
129180
130−extractUnion :: I.Interfaces -> Opt.Global -> Extractor T.Union
131−extractUnion interfaces (Opt.Global home name) =
181+extractUnion :: Types -> Opt.Global -> Extractor T.Union
182+extractUnion (Types dict) (Opt.Global home name) =
132183 if name == Name.list && home == ModuleName.list
133184 then return $ T.Union (toPublicName home name) ["a"] []
134185 else
135186 let
136187 pname = toPublicName home name
137− unions = I._unions (interfaces ! home)
188+ (Can.Union vars ctors _ _) = _union_info (dict ! home) ! name
138189 in
139− case I.toUnionInternals (unions ! name) of
140− Can.Union vars ctors _ _ ->
141− T.Union pname vars <$> traverse extractCtor ctors
190+ T.Union pname vars <$> traverse extractCtor ctors
142191
143192
144193extractCtor :: Can.Ctor -> Extractor (Name.Name, [T.Type])
builder/src/Elm/Constraint.hs → compiler/src/Elm/Constraint.hsrenamed+55−77
@@ -5,9 +5,6 @@ module Elm.Constraint
55 , exactly
66 , anything
77 , toChars
8− , toString
9− , Error(..)
10− , fromString
118 , satisfies
129 , check
1310 , intersect
@@ -16,6 +13,8 @@ module Elm.Constraint
1613 , untilNextMajor
1714 , untilNextMinor
1815 , expand
16+ --
17+ , Error(..)
1918 , decoder
2019 , encode
2120 )
@@ -24,11 +23,12 @@ module Elm.Constraint
2423
2524import Control.Monad (liftM4)
2625import Data.Binary (Binary, get, put, getWord8, putWord8)
27−import qualified Data.Utf8 as Utf8
2826
2927import qualified Elm.Version as V
3028import qualified Json.Decode as D
3129import qualified Json.Encode as E
30+import qualified Parse.Primitives as P
31+import Parse.Primitives (Row, Col)
3232
3333
3434
@@ -61,78 +61,21 @@ anything =
6161
6262
6363
64−-- TO STRING
64+-- TO CHARS
6565
6666
67−toChars :: Constraint -> String
67+toChars :: Constraint -> [Char]
6868toChars constraint =
69− Utf8.toChars (toString constraint)
70−
71−
72−toString :: Constraint -> Utf8.String
73−toString constraint =
7469 case constraint of
7570 Range lower lowerOp upperOp upper ->
76− Utf8.join 0x20 {- -}
77− [ V.toString lower
78− , toStringHelp lowerOp
79− , "v"
80− , toStringHelp upperOp
81− , V.toString upper
82− ]
71+ V.toChars lower ++ opToChars lowerOp ++ "v" ++ opToChars upperOp ++ V.toChars upper
8372
8473
85−toStringHelp :: Op -> Utf8.String
86−toStringHelp op =
74+opToChars :: Op -> [Char]
75+opToChars op =
8776 case op of
88− Less -> "<"
89− LessOrEqual -> "<="
90−
91−
92−
93−-- FROM STRING
94−
95−
96−data Error
97− = BadLower Utf8.String
98− | BadUpper Utf8.String
99− | BadFormat
100− | InvalidOp
101− | InvalidRange V.Version V.Version
102−
103−
104−fromString :: Utf8.String -> Either Error Constraint
105−fromString string =
106− case Utf8.split 0x20 {- -} string of
107− [lower, lowerOp, "v", upperOp, upper] ->
108− do lo <- versionFromString lower BadLower
109− lop <- opFromString lowerOp
110− hop <- opFromString upperOp
111− hi <- versionFromString upper BadUpper
112− if lo < hi
113− then Right (Range lo lop hop hi)
114− else Left (InvalidRange lo hi)
115−
116− _ ->
117− Left BadFormat
118−
119−
120−versionFromString :: Utf8.String -> (Utf8.String -> Error) -> Either Error V.Version
121−versionFromString string toError =
122− case V.fromString string of
123− Just vsn ->
124− Right vsn
125−
126− Nothing ->
127− Left (toError string)
128−
129−
130−opFromString :: Utf8.String -> Either Error Op
131−opFromString text =
132− case text of
133− "<=" -> Right LessOrEqual
134− "<" -> Right Less
135− _ -> Left InvalidOp
77+ Less -> " < "
78+ LessOrEqual -> " <= "
13679
13780
13881
@@ -245,18 +188,12 @@ expand constraint@(Range lower lowerOp upperOp upper) version
245188
246189encode :: Constraint -> E.Value
247190encode constraint =
248− E.string (toString constraint)
191+ E.chars (toChars constraint)
249192
250193
251194decoder :: D.Decoder Error Constraint
252195decoder =
253− do str <- D.string
254− case fromString str of
255− Right constraint ->
256− return constraint
257−
258− Left err ->
259− D.failure err
196+ D.customString parser BadFormat
260197
261198
262199
@@ -279,4 +216,45 @@ instance Binary Op where
279216 case n of
280217 0 -> return Less
281218 1 -> return LessOrEqual
282− _ -> error "binary encoding of Op was corrupted"
219+ _ -> fail "binary encoding of Op was corrupted"
220+
221+
222+
223+-- PARSER
224+
225+
226+data Error
227+ = BadFormat Row Col
228+ | InvalidRange V.Version V.Version
229+
230+
231+parser :: P.Parser Error Constraint
232+parser =
233+ do lower <- parseVersion
234+ P.word1 0x20 {- -} BadFormat
235+ loOp <- parseOp
236+ P.word1 0x20 {- -} BadFormat
237+ P.word1 0x76 {-v-} BadFormat
238+ P.word1 0x20 {- -} BadFormat
239+ hiOp <- parseOp
240+ P.word1 0x20 {- -} BadFormat
241+ higher <- parseVersion
242+ P.Parser $ \state@(P.State _ _ _ _ row col) _ eok _ eerr ->
243+ if lower < higher
244+ then eok (Range lower loOp hiOp higher) state
245+ else eerr row col (\_ _ -> InvalidRange lower higher)
246+
247+
248+parseVersion :: P.Parser Error V.Version
249+parseVersion =
250+ P.specialize (\(r,c) _ _ -> BadFormat r c) V.parser
251+
252+
253+parseOp :: P.Parser Error Op
254+parseOp =
255+ do P.word1 0x3C {-<-} BadFormat
256+ P.oneOfWithFallback
257+ [ do P.word1 0x3D {-=-} BadFormat
258+ return LessOrEqual
259+ ]
260+ Less
compiler/src/Elm/Docs.hs+218−158
@@ -1,8 +1,7 @@
11{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE BangPatterns, MultiWayIf, OverloadedStrings, UnboxedTuples #-}
33module Elm.Docs
44 ( Documentation
5− , toDict
65 , Module(..)
76 , fromModule
87 , Union(..)
@@ -18,33 +17,35 @@ module Elm.Docs
1817 where
1918
2019
21−import qualified Data.ByteString as B
20+import qualified Data.Coerce as Coerce
2221import qualified Data.List as List
2322import Data.Map ((!))
2423import qualified Data.Map as Map
24+import qualified Data.Map.Merge.Strict as Map
2525import qualified Data.Name as Name
26−import qualified Data.Text as Text
27−import qualified Data.Text.Encoding as Text
26+import qualified Data.NonEmptyList as NE
27+import qualified Data.OneOrMore as OneOrMore
28+import Data.Word (Word8)
29+import Foreign.Ptr (Ptr, plusPtr)
2830
2931import qualified AST.Canonical as Can
32+import qualified AST.Source as Src
3033import qualified AST.Utils.Binop as Binop
31−import qualified Data.OneOrMore as OneOrMore
3234import qualified Elm.Compiler.Type as Type
3335import qualified Elm.Compiler.Type.Extract as Extract
3436import qualified Elm.ModuleName as ModuleName
3537import qualified Json.Decode as D
3638import qualified Json.Encode as E
3739import Json.Encode ((==>))
40+import qualified Json.String as Json
41+import Parse.Primitives (Row, Col, word1)
42+import qualified Parse.Primitives as P
43+import qualified Parse.Space as Space
44+import qualified Parse.Symbol as Symbol
45+import qualified Parse.Variable as Var
3846import qualified Reporting.Annotation as A
39−import qualified Reporting.Error as Error
4047import qualified Reporting.Error.Docs as E
41−import qualified Reporting.Region as R
4248import qualified Reporting.Result as Result
43−import Parse.Primitives (Parser)
44−import qualified Parse.Primitives as P
45−import qualified Parse.Primitives.Symbol as Symbol
46−import qualified Parse.Primitives.Variable as Var
47−import qualified Parse.Primitives.Whitespace as W
4849
4950
5051
@@ -55,21 +56,6 @@ type Documentation =
5556 Map.Map Name.Name Module
5657
5758
58−toDict :: [Module] -> Documentation
59−toDict modules =
60− Map.fromList (map toPair modules)
61−
62−
63−
64−toPair :: Module -> (Name.Name, Module)
65−toPair modul@(Module name _ _ _ _ _) =
66− (name, modul)
67−
68−
69−
70−-- MODULES
71−
72−
7359data Module =
7460 Module
7561 { _name :: Name.Name
@@ -80,9 +66,7 @@ data Module =
8066 , _binops :: Map.Map Name.Name Binop
8167 }
8268
83−
84−type Comment = Text.Text
85−
69+type Comment = Json.String
8670
8771data Alias = Alias Comment [Name.Name] Type.Type
8872data Union = Union Comment [Name.Name] [(Name.Name, [Type.Type])]
@@ -91,14 +75,19 @@ data Binop = Binop Comment Type.Type Binop.Associativity Binop.Precedence
9175
9276
9377
94−-- JSON ENCODE / DECODE
78+-- JSON
79+
80+
81+encode :: Documentation -> E.Value
82+encode docs =
83+ E.list encodeModule (Map.elems docs)
9584
9685
97−encode :: Module -> E.Value
98−encode (Module name comment unions aliases values binops) =
86+encodeModule :: Module -> E.Value
87+encodeModule (Module name comment unions aliases values binops) =
9988 E.object $
10089 [ "name" ==> ModuleName.encode name
101− , "comment" ==> E.text comment
90+ , "comment" ==> E.string comment
10291 , "unions" ==> E.list encodeUnion (Map.toList unions)
10392 , "aliases" ==> E.list encodeAlias (Map.toList aliases)
10493 , "values" ==> E.list encodeValue (Map.toList values)
@@ -107,16 +96,31 @@ encode (Module name comment unions aliases values binops) =
10796
10897
10998data Error
110− = BadAssociativity Text.Text
111− | BadName
99+ = BadAssociativity
100+ | BadModuleName
112101 | BadType
113102
114103
115−decoder :: D.Decoder Error Module
104+decoder :: D.Decoder Error Documentation
116105decoder =
106+ toDict <$> D.list moduleDecoder
107+
108+
109+toDict :: [Module] -> Documentation
110+toDict modules =
111+ Map.fromList (map toDictHelp modules)
112+
113+
114+toDictHelp :: Module -> (Name.Name, Module)
115+toDictHelp modul@(Module name _ _ _ _ _) =
116+ (name, modul)
117+
118+
119+moduleDecoder :: D.Decoder Error Module
120+moduleDecoder =
117121 Module
118− <$> D.field "name" nameDecoder
119− <*> D.field "comment" D.text
122+ <$> D.field "name" moduleNameDecoder
123+ <*> D.field "comment" D.string
120124 <*> D.field "unions" (dictDecoder union)
121125 <*> D.field "aliases" (dictDecoder alias)
122126 <*> D.field "values" (dictDecoder value)
@@ -131,13 +135,18 @@ dictDecoder entryDecoder =
131135named :: D.Decoder Error a -> D.Decoder Error (Name.Name, a)
132136named entryDecoder =
133137 (,)
134− <$> D.field "name" D.name
138+ <$> D.field "name" nameDecoder
135139 <*> entryDecoder
136140
137141
138−nameDecoder :: D.Decoder Error Name.Name
142+nameDecoder :: D.Decoder e Name.Name
139143nameDecoder =
140− D.mapError (const BadName) ModuleName.decoder
144+ fmap Coerce.coerce D.string
145+
146+
147+moduleNameDecoder :: D.Decoder Error ModuleName.Raw
148+moduleNameDecoder =
149+ D.mapError (const BadModuleName) ModuleName.decoder
141150
142151
143152typeDecoder :: D.Decoder Error Type.Type
@@ -153,7 +162,7 @@ encodeUnion :: (Name.Name, Union) -> E.Value
153162encodeUnion (name, Union comment args cases) =
154163 E.object
155164 [ "name" ==> E.name name
156− , "comment" ==> E.text comment
165+ , "comment" ==> E.string comment
157166 , "args" ==> E.list E.name args
158167 , "cases" ==> E.list encodeCase cases
159168 ]
@@ -162,8 +171,8 @@ encodeUnion (name, Union comment args cases) =
162171union :: D.Decoder Error Union
163172union =
164173 Union
165− <$> D.field "comment" D.text
166− <*> D.field "args" (D.list D.name)
174+ <$> D.field "comment" D.string
175+ <*> D.field "args" (D.list nameDecoder)
167176 <*> D.field "cases" (D.list caseDecoder)
168177
169178
@@ -174,7 +183,7 @@ encodeCase ( tag, args ) =
174183
175184caseDecoder :: D.Decoder Error ( Name.Name, [Type.Type] )
176185caseDecoder =
177− D.pair D.name (D.list typeDecoder)
186+ D.pair nameDecoder (D.list typeDecoder)
178187
179188
180189
@@ -185,7 +194,7 @@ encodeAlias :: (Name.Name, Alias) -> E.Value
185194encodeAlias ( name, Alias comment args tipe) =
186195 E.object
187196 [ "name" ==> E.name name
188− , "comment" ==> E.text comment
197+ , "comment" ==> E.string comment
189198 , "args" ==> E.list E.name args
190199 , "type" ==> Type.encode tipe
191200 ]
@@ -194,8 +203,8 @@ encodeAlias ( name, Alias comment args tipe) =
194203alias :: D.Decoder Error Alias
195204alias =
196205 Alias
197− <$> D.field "comment" D.text
198− <*> D.field "args" (D.list D.name)
206+ <$> D.field "comment" D.string
207+ <*> D.field "args" (D.list nameDecoder)
199208 <*> D.field "type" typeDecoder
200209
201210
@@ -207,7 +216,7 @@ encodeValue :: (Name.Name, Value) -> E.Value
207216encodeValue (name, Value comment tipe) =
208217 E.object
209218 [ "name" ==> E.name name
210− , "comment" ==> E.text comment
219+ , "comment" ==> E.string comment
211220 , "type" ==> Type.encode tipe
212221 ]
213222
@@ -215,7 +224,7 @@ encodeValue (name, Value comment tipe) =
215224value :: D.Decoder Error Value
216225value =
217226 Value
218− <$> D.field "comment" D.text
227+ <$> D.field "comment" D.string
219228 <*> D.field "type" typeDecoder
220229
221230
@@ -227,7 +236,7 @@ encodeBinop :: (Name.Name, Binop) -> E.Value
227236encodeBinop (name, Binop comment tipe assoc prec) =
228237 E.object
229238 [ "name" ==> E.name name
230− , "comment" ==> E.text comment
239+ , "comment" ==> E.string comment
231240 , "type" ==> Type.encode tipe
232241 , "associativity" ==> encodeAssoc assoc
233242 , "precedence" ==> encodePrec prec
@@ -237,7 +246,7 @@ encodeBinop (name, Binop comment tipe assoc prec) =
237246binop :: D.Decoder Error Binop
238247binop =
239248 Binop
240− <$> D.field "comment" D.text
249+ <$> D.field "comment" D.string
241250 <*> D.field "type" typeDecoder
242251 <*> D.field "associativity" assocDecoder
243252 <*> D.field "precedence" precDecoder
@@ -250,19 +259,23 @@ binop =
250259encodeAssoc :: Binop.Associativity -> E.Value
251260encodeAssoc assoc =
252261 case assoc of
253− Binop.Left -> E.text "left"
254− Binop.Non -> E.text "non"
255− Binop.Right -> E.text "right"
262+ Binop.Left -> E.chars "left"
263+ Binop.Non -> E.chars "non"
264+ Binop.Right -> E.chars "right"
256265
257266
258267assocDecoder :: D.Decoder Error Binop.Associativity
259268assocDecoder =
260− do txt <- D.text
261− case txt of
262− "left" -> D.succeed Binop.Left
263− "non" -> D.succeed Binop.Non
264− "right" -> D.succeed Binop.Right
265− _ -> D.fail (BadAssociativity txt)
269+ let
270+ left = Json.fromChars "left"
271+ non = Json.fromChars "non"
272+ right = Json.fromChars "right"
273+ in
274+ do str <- D.string
275+ if | str == left -> return Binop.Left
276+ | str == non -> return Binop.Non
277+ | str == right -> return Binop.Right
278+ | otherwise -> D.failure BadAssociativity
266279
267280
268281
@@ -283,142 +296,190 @@ precDecoder =
283296-- FROM MODULE
284297
285298
286−fromModule :: Can.Module -> Result.Result i w Error.Error Module
287−fromModule (Can.Module name docs exports decls unions aliases binops effects) =
299+fromModule :: Can.Module -> Either E.Error Module
300+fromModule modul@(Can.Module _ exports docs _ _ _ _ _) =
288301 case exports of
289302 Can.ExportEverything region ->
290− Result.throw $ Error.Docs $ E.ImplicitExposing region
303+ Left (E.ImplicitExposing region)
291304
292305 Can.Export exportDict ->
293306 case docs of
294− Can.NoDocs region ->
295− Result.throw $ Error.Docs $ E.NoDocs region
307+ Src.NoDocs region ->
308+ Left (E.NoDocs region)
296309
297− Can.YesDocs region overview comments ->
298− do names <- parseOverview region overview
299− Result.mapError Error.Docs $
300− do checkNames exportDict names
301− let types = gatherTypes decls Map.empty
302− let info = Info comments types unions aliases binops effects
303− inserters <- Map.traverseWithKey (checkExport info) exportDict
304− return $ foldr ($) (emptyModule name overview) inserters
305−
306−
307−emptyModule :: ModuleName.Canonical -> B.ByteString -> Module
308−emptyModule (ModuleName.Canonical _ name) overview =
309− Module name (Text.decodeUtf8 overview) Map.empty Map.empty Map.empty Map.empty
310+ Src.YesDocs overview comments ->
311+ do names <- parseOverview overview
312+ checkNames exportDict names
313+ checkDefs exportDict overview (Map.fromList comments) modul
310314
311315
312316
313317-- PARSE OVERVIEW
314318
315319
316−parseOverview :: R.Region -> B.ByteString -> Result.Result i w Error.Error [A.Located Name.Name]
317−parseOverview (R.Region (R.Position row col) _) overview =
318− case P.runAt row (col + 3) (chompOverview []) overview of
320+parseOverview :: Src.Comment -> Either E.Error [A.Located Name.Name]
321+parseOverview (Src.Comment snippet) =
322+ case P.fromSnippet (chompOverview []) E.BadEnd snippet of
319323 Left err ->
320− Result.throw (Error.Syntax err)
324+ Left (E.SyntaxProblem err)
321325
322326 Right names ->
323− Result.ok names
327+ Right names
328+
329+
330+type Parser a =
331+ P.Parser E.SyntaxProblem a
324332
325333
326334chompOverview :: [A.Located Name.Name] -> Parser [A.Located Name.Name]
327335chompOverview names =
328− do isDocs <- W.chompUntilDocs
336+ do isDocs <- chompUntilDocs
329337 if isDocs
330− then chompOverviewHelp names
331− else return names
332−
333−
334−chompOverviewHelp :: [A.Located Name.Name] -> Parser [A.Located Name.Name]
335−chompOverviewHelp names =
336− do pos <- P.getPosition
337− (W.SPos spos) <- W.whitespace
338− if pos == spos
339− then chompOverview names
340− else chompOverview =<< chompDocs names
338+ then
339+ do Space.chomp E.Space
340+ chompOverview =<< chompDocs names
341+ else
342+ return names
341343
342344
343345chompDocs :: [A.Located Name.Name] -> Parser [A.Located Name.Name]
344346chompDocs names =
345− do name <- P.addLocation (P.oneOf [ Var.lower, Var.upper, chompBinop ])
346− spos <- W.whitespace
347− P.oneOf
348− [ do P.checkSpace spos
349− Symbol.comma
350− P.spaces
347+ do name <-
348+ P.addLocation $
349+ P.oneOf E.Name
350+ [ Var.lower E.Name
351+ , Var.upper E.Name
352+ , chompOperator
353+ ]
354+
355+ Space.chomp E.Space
356+
357+ P.oneOfWithFallback
358+ [ do pos <- P.getPosition
359+ Space.checkIndent pos E.Comma
360+ word1 0x2C {-,-} E.Comma
361+ Space.chomp E.Space
351362 chompDocs (name:names)
352− , return (name:names)
353363 ]
354−
355−
356−chompBinop :: Parser Name.Name
357−chompBinop =
358− do Symbol.leftParen
359− name <- Symbol.binop
360− Symbol.rightParen
361− return name
364+ (name:names)
365+
366+
367+chompOperator :: Parser Name.Name
368+chompOperator =
369+ do word1 0x28 {-(-} E.Op
370+ op <- Symbol.operator E.Op E.OpBad
371+ word1 0x29 {-)-} E.Op
372+ return op
373+
374+
375+-- TODO add rule that @docs must be after newline in 0.20
376+--
377+chompUntilDocs :: Parser Bool
378+chompUntilDocs =
379+ P.Parser $ \(P.State src pos end indent row col) cok _ _ _ ->
380+ let
381+ (# isDocs, newPos, newRow, newCol #) = untilDocs pos end row col
382+ !newState = P.State src newPos end indent newRow newCol
383+ in
384+ cok isDocs newState
385+
386+
387+untilDocs :: Ptr Word8 -> Ptr Word8 -> Row -> Col -> (# Bool, Ptr Word8, Row, Col #)
388+untilDocs pos end row col =
389+ if pos >= end then
390+ (# False, pos, row, col #)
391+ else
392+ let !word = P.unsafeIndex pos in
393+ if word == 0x0A {-\n-} then
394+ untilDocs (plusPtr pos 1) end (row + 1) 1
395+ else
396+ let !pos5 = plusPtr pos 5 in
397+ if pos5 <= end
398+ && P.unsafeIndex ( pos ) == 0x40 {-@-}
399+ && P.unsafeIndex (plusPtr pos 1) == 0x64 {-d-}
400+ && P.unsafeIndex (plusPtr pos 2) == 0x6F {-o-}
401+ && P.unsafeIndex (plusPtr pos 3) == 0x63 {-c-}
402+ && P.unsafeIndex (plusPtr pos 4) == 0x73 {-s-}
403+ && Var.getInnerWidth pos5 end == 0
404+ then
405+ (# True, pos5, row, col + 5 #)
406+ else
407+ let !newPos = plusPtr pos (P.getCharWidth word) in
408+ untilDocs newPos end row (col + 1)
362409
363410
364411
365412-- CHECK NAMES
366413
367414
368−type Result i w a =
369− Result.Result i w E.Error a
370−
371−
372−type Dups =
373− Map.Map Name.Name (OneOrMore.OneOrMore R.Region)
415+checkNames :: Map.Map Name.Name (A.Located Can.Export) -> [A.Located Name.Name] -> Either E.Error ()
416+checkNames exports names =
417+ let
418+ docs = List.foldl' addName Map.empty names
419+ loneDoc = Map.traverseMissing onlyInDocs
420+ loneExport = Map.traverseMissing onlyInExports
421+ checkBoth = Map.zipWithAMatched (\n _ r -> isUnique n r)
422+ in
423+ case Result.run (Map.mergeA loneExport loneDoc checkBoth exports docs) of
424+ (_, Right _) -> Right ()
425+ (_, Left es) -> Left (E.NameProblems (OneOrMore.destruct NE.List es))
374426
375427
376−checkNames :: Map.Map Name.Name (A.Located Can.Export) -> [A.Located Name.Name] -> Result i w ()
377−checkNames exports names =
378− do docs <- Map.traverseWithKey isUnique (List.foldl' addName Map.empty names)
379− let overlap = Map.size (Map.intersection docs exports)
380− if Map.size exports == overlap && overlap == Map.size docs
381− then Result.ok ()
382− else
383− do _ <- Map.traverseWithKey onlyInDocs (Map.difference docs exports)
384− _ <- Map.traverseWithKey onlyInExports (Map.difference exports docs)
385− Result.ok ()
428+type DocNameRegions =
429+ Map.Map Name.Name (OneOrMore.OneOrMore A.Region)
386430
387431
388−addName :: Dups -> A.Located Name.Name -> Dups
432+addName :: DocNameRegions -> A.Located Name.Name -> DocNameRegions
389433addName dict (A.At region name) =
390434 Map.insertWith OneOrMore.more name (OneOrMore.one region) dict
391435
392436
393−isUnique :: Name.Name -> OneOrMore.OneOrMore R.Region -> Result i w R.Region
437+isUnique :: Name.Name -> OneOrMore.OneOrMore A.Region -> Result.Result i w E.NameProblem A.Region
394438isUnique name regions =
395439 case regions of
396440 OneOrMore.One region ->
397441 Result.ok region
398442
399− OneOrMore.More _ _ ->
400− let (r1:r2:_) = OneOrMore.toList regions in
401− Result.throw (E.Duplicate name r1 r2)
443+ OneOrMore.More left right ->
444+ let (r1, r2) = OneOrMore.getFirstTwo left right in
445+ Result.throw (E.NameDuplicate name r1 r2)
402446
403447
404−onlyInDocs :: Name.Name -> R.Region -> Result i w a
405−onlyInDocs name region =
406− Result.throw $ E.OnlyInDocs name region
448+onlyInDocs :: Name.Name -> OneOrMore.OneOrMore A.Region -> Result.Result i w E.NameProblem a
449+onlyInDocs name regions =
450+ do region <- isUnique name regions
451+ Result.throw $ E.NameOnlyInDocs name region
407452
408453
409−onlyInExports :: Name.Name -> A.Located Can.Export -> Result i w a
454+onlyInExports :: Name.Name -> A.Located Can.Export -> Result.Result i w E.NameProblem a
410455onlyInExports name (A.At region _) =
411− Result.throw $ E.OnlyInExports name region
456+ Result.throw $ E.NameOnlyInExports name region
457+
458+
459+
460+-- CHECK DEFS
461+
412462
463+checkDefs :: Map.Map Name.Name (A.Located Can.Export) -> Src.Comment -> Map.Map Name.Name Src.Comment -> Can.Module -> Either E.Error Module
464+checkDefs exportDict overview comments (Can.Module name _ _ decls unions aliases infixes effects) =
465+ let
466+ types = gatherTypes decls Map.empty
467+ info = Info comments types unions aliases infixes effects
468+ in
469+ case Result.run (Map.traverseWithKey (checkExport info) exportDict) of
470+ (_, Left problems ) -> Left $ E.DefProblems (OneOrMore.destruct NE.List problems)
471+ (_, Right inserters) -> Right $ foldr ($) (emptyModule name overview) inserters
413472
414473
415−-- CHECK EXPORTS
474+emptyModule :: ModuleName.Canonical -> Src.Comment -> Module
475+emptyModule (ModuleName.Canonical _ name) (Src.Comment overview) =
476+ Module name (Json.fromComment overview) Map.empty Map.empty Map.empty Map.empty
416477
417478
418479data Info =
419480 Info
420− { _iComments :: Map.Map Name.Name Comment
421− , _iValues :: Types
481+ { _iComments :: Map.Map Name.Name Src.Comment
482+ , _iValues :: Map.Map Name.Name (Either A.Region Can.Type)
422483 , _iUnions :: Map.Map Name.Name Can.Union
423484 , _iAliases :: Map.Map Name.Name Can.Alias
424485 , _iBinops :: Map.Map Name.Name Can.Binop
@@ -426,7 +487,7 @@ data Info =
426487 }
427488
428489
429−checkExport :: Info -> Name.Name -> A.Located Can.Export -> Result i w (Module -> Module)
490+checkExport :: Info -> Name.Name -> A.Located Can.Export -> Result.Result i w E.DefProblem (Module -> Module)
430491checkExport info name (A.At region export) =
431492 case export of
432493 Can.ExportValue ->
@@ -467,23 +528,23 @@ checkExport info name (A.At region export) =
467528 m { _values = Map.insert name (Value comment tipe) (_values m) }
468529
469530
470−getComment :: R.Region -> Name.Name -> Info -> Result i w Comment
531+getComment :: A.Region -> Name.Name -> Info -> Result.Result i w E.DefProblem Comment
471532getComment region name info =
472533 case Map.lookup name (_iComments info) of
473534 Nothing ->
474535 Result.throw (E.NoComment name region)
475536
476− Just comment ->
477− Result.ok comment
537+ Just (Src.Comment snippet) ->
538+ Result.ok (Json.fromComment snippet)
478539
479540
480−getType :: Name.Name -> Info -> Result i w Type.Type
541+getType :: Name.Name -> Info -> Result.Result i w E.DefProblem Type.Type
481542getType name info =
482543 case _iValues info ! name of
483− A.At defRegion Nothing ->
484− Result.throw (E.NoAnnotation name defRegion)
544+ Left region ->
545+ Result.throw (E.NoAnnotation name region)
485546
486− A.At _ (Just tipe) ->
547+ Right tipe ->
487548 Result.ok (Extract.fromType tipe)
488549
489550
@@ -497,7 +558,7 @@ dector (Can.Ctor name _ _ args) =
497558
498559
499560type Types =
500− Map.Map Name.Name (A.Located (Maybe Can.Type))
561+ Map.Map Name.Name (Either A.Region Can.Type)
501562
502563
503564gatherTypes :: Can.Decls -> Types -> Types
@@ -506,8 +567,8 @@ gatherTypes decls types =
506567 Can.Declare def subDecls ->
507568 gatherTypes subDecls (addDef types def)
508569
509− Can.DeclareRec defs subDecls ->
510− gatherTypes subDecls (List.foldl' addDef types defs)
570+ Can.DeclareRec def defs subDecls ->
571+ gatherTypes subDecls (List.foldl' addDef (addDef types def) defs)
511572
512573 Can.SaveTheEnvironment ->
513574 types
@@ -517,11 +578,10 @@ addDef :: Types -> Can.Def -> Types
517578addDef types def =
518579 case def of
519580 Can.Def (A.At region name) _ _ ->
520− Map.insert name (A.At region Nothing) types
581+ Map.insert name (Left region) types
521582
522− Can.TypedDef (A.At region name) _ typedArgs _ resultType ->
583+ Can.TypedDef (A.At _ name) _ typedArgs _ resultType ->
523584 let
524− tipe =
525− foldr Can.TLambda resultType (map snd typedArgs)
585+ tipe = foldr Can.TLambda resultType (map snd typedArgs)
526586 in
527− Map.insert name (A.At region (Just tipe)) types
587+ Map.insert name (Right tipe) types
compiler/src/Elm/Float.hsnew file+51
@@ -0,0 +1,51 @@
1+{-# OPTIONS_GHC -Wall #-}
2+{-# LANGUAGE EmptyDataDecls, FlexibleInstances #-}
3+module Elm.Float
4+ ( Float
5+ , fromPtr
6+ , toBuilder
7+ )
8+ where
9+
10+
11+import Prelude hiding (Float)
12+import Data.Binary (Binary, get, put)
13+import qualified Data.ByteString.Builder as B
14+import qualified Data.Utf8 as Utf8
15+import Data.Word (Word8)
16+import Foreign.Ptr (Ptr)
17+
18+
19+
20+-- FLOATS
21+
22+
23+type Float =
24+ Utf8.Utf8 ELM_FLOAT
25+
26+
27+data ELM_FLOAT
28+
29+
30+
31+-- HELPERS
32+
33+
34+fromPtr :: Ptr Word8 -> Ptr Word8 -> Float
35+fromPtr =
36+ Utf8.fromPtr
37+
38+
39+{-# INLINE toBuilder #-}
40+toBuilder :: Float -> B.Builder
41+toBuilder =
42+ Utf8.toBuilder
43+
44+
45+
46+-- BINARY
47+
48+
49+instance Binary (Utf8.Utf8 ELM_FLOAT) where
50+ get = Utf8.getUnder256
51+ put = Utf8.putUnder256
compiler/src/Elm/Header.hsdeleted−73
@@ -1,73 +0,0 @@
1−{-# OPTIONS_GHC -Wall #-}
2−module Elm.Header
3− ( Tag(..)
4− , parse
5− )
6− where
7−
8−
9−import qualified Data.ByteString as B
10−import qualified Data.Name as Name
11−
12−import qualified AST.Source as Src
13−import qualified Elm.ModuleName as ModuleName
14−import qualified Elm.Package as Pkg
15−import qualified Parse.Primitives as Parser
16−import qualified Parse.Module as Module
17−import qualified Reporting.Annotation as A
18−import qualified Reporting.Error as Error
19−
20−
21−
22−-- HEADER TAGS
23−
24−
25−data Tag = Normal | Effect | Port
26−
27−
28−
29−-- PARSE
30−
31−
32−parse :: Pkg.Name -> B.ByteString -> Either Error.Error (Maybe (Tag, ModuleName.Raw), [ModuleName.Raw])
33−parse pkgName sourceCode =
34− let
35− headerParser =
36− Module.module_ pkgName (return ())
37− in
38− case Parser.run headerParser sourceCode of
39− Right (Src.Module header imports _) ->
40− Right
41− ( fmap simplifyHeader header
42− , map getName imports
43− )
44−
45− Left err ->
46− Left (Error.Syntax err)
47−
48−
49−getName :: Src.Import -> Name.Name
50−getName (Src.Import (A.At _ name) _ _) =
51− name
52−
53−
54−
55−-- TO HEADER
56−
57−
58−simplifyHeader :: Src.Header -> (Tag, Name.Name)
59−simplifyHeader (Src.Header name effects _ _) =
60− ( toTag effects, name )
61−
62−
63−toTag :: Src.Effects -> Tag
64−toTag effects =
65− case effects of
66− Src.NoEffects ->
67− Normal
68−
69− Src.Ports _ ->
70− Port
71−
72− Src.Manager _ _ ->
73− Effect
compiler/src/Elm/Interface.hs+95−67
@@ -1,62 +1,61 @@
11{-# OPTIONS_GHC -Wall #-}
22module Elm.Interface
3− ( Interfaces
4− , Interface(..)
5− , Union
6− , Alias
3+ ( Interface(..)
4+ , Union(..)
5+ , Alias(..)
76 , Binop(..)
87 , fromModule
98 , toPublicUnion
109 , toPublicAlias
11− , toUnionInternals
12− , toAliasInternals
10+ , DependencyInterface(..)
11+ , public
12+ , private
13+ , privatize
14+ , extractUnion
15+ , extractAlias
1316 )
1417 where
1518
1619
17−import Control.Monad (liftM4)
20+import Control.Monad (liftM, liftM3, liftM4, liftM5)
1821import Data.Binary
19−import Data.Map ((!))
20−import qualified Data.Map as Map
22+import Data.Map.Strict ((!))
23+import qualified Data.Map.Strict as Map
2124import qualified Data.Map.Merge.Strict as Map
2225import qualified Data.Name as Name
2326
2427import qualified AST.Canonical as Can
2528import qualified AST.Utils.Binop as Binop
26−import qualified Elm.ModuleName as ModuleName
29+import qualified Elm.Package as Pkg
2730import qualified Reporting.Annotation as A
2831
2932
3033
31−-- INTERFACES
32−
33−
34−type Interfaces =
35− Map.Map ModuleName.Canonical Interface
36−
37−
38−
3934-- INTERFACE
4035
4136
4237data Interface =
4338 Interface
44− { _types :: Map.Map Name.Name Can.Annotation
39+ { _home :: Pkg.Name
40+ , _values :: Map.Map Name.Name Can.Annotation
4541 , _unions :: Map.Map Name.Name Union
4642 , _aliases :: Map.Map Name.Name Alias
4743 , _binops :: Map.Map Name.Name Binop
4844 }
45+ deriving (Eq)
4946
5047
5148data Union
5249 = OpenUnion Can.Union
5350 | ClosedUnion Can.Union
5451 | PrivateUnion Can.Union
52+ deriving (Eq)
5553
5654
5755data Alias
5856 = PublicAlias Can.Alias
5957 | PrivateAlias Can.Alias
58+ deriving (Eq)
6059
6160
6261data Binop =
@@ -66,24 +65,26 @@ data Binop =
6665 , _op_associativity :: Binop.Associativity
6766 , _op_precedence :: Binop.Precedence
6867 }
68+ deriving (Eq)
6969
7070
7171
7272-- FROM MODULE
7373
7474
75−fromModule :: Map.Map Name.Name Can.Annotation -> Can.Module -> Interface
76−fromModule types (Can.Module _ _ exports _ unions aliases binops _) =
75+fromModule :: Pkg.Name -> Can.Module -> Map.Map Name.Name Can.Annotation -> Interface
76+fromModule home (Can.Module _ exports _ _ unions aliases binops _) annotations =
7777 Interface
78− { _types = privatize exports types
79− , _unions = privatizeUnions exports unions
80− , _aliases = privatizeAliases exports aliases
81− , _binops = privatize exports (Map.map (toOp types) binops)
78+ { _home = home
79+ , _values = restrict exports annotations
80+ , _unions = restrictUnions exports unions
81+ , _aliases = restrictAliases exports aliases
82+ , _binops = restrict exports (Map.map (toOp annotations) binops)
8283 }
8384
8485
85−privatize :: Can.Exports -> Map.Map Name.Name a -> Map.Map Name.Name a
86−privatize exports dict =
86+restrict :: Can.Exports -> Map.Map Name.Name a -> Map.Map Name.Name a
87+restrict exports dict =
8788 case exports of
8889 Can.ExportEverything _ ->
8990 dict
@@ -97,8 +98,8 @@ toOp types (Can.Binop_ associativity precedence name) =
9798 Binop name (types ! name) associativity precedence
9899
99100
100−privatizeUnions :: Can.Exports -> Map.Map Name.Name Can.Union -> Map.Map Name.Name Union
101−privatizeUnions exports unions =
101+restrictUnions :: Can.Exports -> Map.Map Name.Name Can.Union -> Map.Map Name.Name Union
102+restrictUnions exports unions =
102103 case exports of
103104 Can.ExportEverything _ ->
104105 Map.map OpenUnion unions
@@ -107,16 +108,16 @@ privatizeUnions exports unions =
107108 Map.merge onLeft onRight onBoth explicitExports unions
108109 where
109110 onLeft = Map.dropMissing
110− onRight = Map.mapMissing (\_ u -> PrivateUnion u)
111− onBoth = Map.zipWithMatched $ \_ e u ->
112− case A.toValue e of
113− Can.ExportUnionOpen -> OpenUnion u
114− Can.ExportUnionClosed -> ClosedUnion u
115− _ -> error "impossible exports discovered in privatizeUnions"
111+ onRight = Map.mapMissing (\_ union -> PrivateUnion union)
112+ onBoth = Map.zipWithMatched $ \_ (A.At _ export) union ->
113+ case export of
114+ Can.ExportUnionOpen -> OpenUnion union
115+ Can.ExportUnionClosed -> ClosedUnion union
116+ _ -> error "impossible exports discovered in restrictUnions"
116117
117118
118−privatizeAliases :: Can.Exports -> Map.Map Name.Name Can.Alias -> Map.Map Name.Name Alias
119−privatizeAliases exports aliases =
119+restrictAliases :: Can.Exports -> Map.Map Name.Name Can.Alias -> Map.Map Name.Name Alias
120+restrictAliases exports aliases =
120121 case exports of
121122 Can.ExportEverything _ ->
122123 Map.map PublicAlias aliases
@@ -130,61 +131,75 @@ privatizeAliases exports aliases =
130131
131132
132133
133−-- PUBLICIZE
134+-- TO PUBLIC
134135
135136
136137toPublicUnion :: Union -> Maybe Can.Union
137138toPublicUnion iUnion =
138139 case iUnion of
139− OpenUnion union ->
140− Just union
141−
142− ClosedUnion (Can.Union vars _ _ opts) ->
143− Just (Can.Union vars [] 0 opts)
144−
145− PrivateUnion _ ->
146− Nothing
140+ OpenUnion union -> Just union
141+ ClosedUnion (Can.Union vars _ _ opts) -> Just (Can.Union vars [] 0 opts)
142+ PrivateUnion _ -> Nothing
147143
148144
149145toPublicAlias :: Alias -> Maybe Can.Alias
150146toPublicAlias iAlias =
151147 case iAlias of
152− PublicAlias alias ->
153− Just alias
148+ PublicAlias alias -> Just alias
149+ PrivateAlias _ -> Nothing
150+
151+
152+
153+-- DEPENDENCY INTERFACE
154+
155+
156+data DependencyInterface
157+ = Public Interface
158+ | Private
159+ Pkg.Name
160+ (Map.Map Name.Name Can.Union)
161+ (Map.Map Name.Name Can.Alias)
154162
155− PrivateAlias _ ->
156− Nothing
157163
164+public :: Interface -> DependencyInterface
165+public =
166+ Public
158167
159168
160−-- INTERNALS
169+private :: Interface -> DependencyInterface
170+private (Interface pkg _ unions aliases _) =
171+ Private pkg (Map.map extractUnion unions) (Map.map extractAlias aliases)
161172
162173
163−toUnionInternals :: Union -> Can.Union
164−toUnionInternals iUnion =
174+extractUnion :: Union -> Can.Union
175+extractUnion iUnion =
165176 case iUnion of
166177 OpenUnion union -> union
167178 ClosedUnion union -> union
168179 PrivateUnion union -> union
169180
170181
171−toAliasInternals :: Alias -> Can.Alias
172−toAliasInternals iAlias =
182+extractAlias :: Alias -> Can.Alias
183+extractAlias iAlias =
173184 case iAlias of
174185 PublicAlias alias -> alias
175186 PrivateAlias alias -> alias
176187
177188
189+privatize :: DependencyInterface -> DependencyInterface
190+privatize di =
191+ case di of
192+ Public i -> private i
193+ Private _ _ _ -> di
194+
195+
178196
179197-- BINARY
180198
181199
182200instance Binary Interface where
183− get =
184− liftM4 Interface get get get get
185−
186− put (Interface a b c d) =
187− put a >> put b >> put c >> put d
201+ get = liftM5 Interface get get get get get
202+ put (Interface a b c d e) = put a >> put b >> put c >> put d >> put e
188203
189204
190205instance Binary Union where
@@ -197,10 +212,10 @@ instance Binary Union where
197212 get =
198213 do n <- getWord8
199214 case n of
200− 0 -> OpenUnion <$> get
201− 1 -> ClosedUnion <$> get
202− 2 -> PrivateUnion <$> get
203− _ -> error "binary encoding of Union was corrupted"
215+ 0 -> liftM OpenUnion get
216+ 1 -> liftM ClosedUnion get
217+ 2 -> liftM PrivateUnion get
218+ _ -> fail "binary encoding of Union was corrupted"
204219
205220
206221instance Binary Alias where
@@ -212,9 +227,9 @@ instance Binary Alias where
212227 get =
213228 do n <- getWord8
214229 case n of
215− 0 -> PublicAlias <$> get
216− 1 -> PrivateAlias <$> get
217− _ -> error "binary encoding of Alias was corrupted"
230+ 0 -> liftM PublicAlias get
231+ 1 -> liftM PrivateAlias get
232+ _ -> fail "binary encoding of Alias was corrupted"
218233
219234
220235instance Binary Binop where
@@ -224,3 +239,16 @@ instance Binary Binop where
224239 put (Binop a b c d) =
225240 put a >> put b >> put c >> put d
226241
242+
243+instance Binary DependencyInterface where
244+ put union =
245+ case union of
246+ Public a -> putWord8 0 >> put a
247+ Private a b c -> putWord8 1 >> put a >> put b >> put c
248+
249+ get =
250+ do n <- getWord8
251+ case n of
252+ 0 -> liftM Public get
253+ 1 -> liftM3 Private get get get
254+ _ -> fail "binary encoding of DependencyInterface was corrupted"
compiler/src/Elm/Kernel.hs+133−128
@@ -1,57 +1,42 @@
11{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE EmptyDataDecls, OverloadedStrings, UnboxedTuples #-}
2+{-# LANGUAGE BangPatterns, EmptyDataDecls, OverloadedStrings, UnboxedTuples #-}
33module Elm.Kernel
44 ( Content(..)
55 , Chunk(..)
6− , Dep(..)
7− , parser
6+ , fromByteString
7+ , countFields
88 )
99 where
1010
1111
1212import Control.Monad (liftM, liftM2)
1313import Data.Binary (Binary, get, put, getWord8, putWord8)
14−import Data.Coerce (coerce)
14+import qualified Data.ByteString.Internal as B
1515import qualified Data.List as List
1616import qualified Data.Map as Map
1717import qualified Data.Name as Name
18−import qualified Data.Set as Set
19−import qualified Data.Utf8 as Utf8
20−import Data.Word (Word8, Word16)
21−import Foreign.Ptr (Ptr, plusPtr)
18+import Data.Word (Word8)
19+import Foreign.Ptr (Ptr, plusPtr, minusPtr)
20+import Foreign.ForeignPtr (ForeignPtr)
21+import Foreign.ForeignPtr.Unsafe (unsafeForeignPtrToPtr)
2222
2323import qualified AST.Source as Src
2424import qualified Elm.ModuleName as ModuleName
2525import qualified Elm.Package as Pkg
2626import qualified Parse.Module as Module
27+import qualified Parse.Space as Space
2728import qualified Parse.Variable as Var
28−import Parse.Utils
29−import Parse.Primitives hiding (Parser, State)
29+import Parse.Primitives hiding (fromByteString)
3030import qualified Parse.Primitives as P
3131import qualified Reporting.Annotation as A
32−import qualified Reporting.Error.Syntax as E
3332
3433
3534
36−-- CONTENT
37−
38−
39−data Content =
40− Content [Chunk] (Set.Set Dep)
41−
42−
43−data Dep
44− = ElmDep ModuleName.Canonical Name.Name
45− | KernelDep Name.Name
46− deriving (Eq, Ord)
47−
48−
49−
50−-- CHUNKS
35+-- CHUNK
5136
5237
5338data Chunk
54− = JS (Utf8.VeryLong UNCHECKED)
39+ = JS B.ByteString
5540 | ElmVar ModuleName.Canonical Name.Name
5641 | JsVar Name.Name Name.Name
5742 | ElmField Name.Name
@@ -61,56 +46,93 @@ data Chunk
6146 | Prod
6247
6348
64−data UNCHECKED
6549
50+-- COUNT FIELDS
51+
52+
53+countFields :: [Chunk] -> Map.Map Name.Name Int
54+countFields chunks =
55+ foldr addField Map.empty chunks
6656
6757
68−-- PARSE
58+addField :: Chunk -> Map.Map Name.Name Int -> Map.Map Name.Name Int
59+addField chunk fields =
60+ case chunk of
61+ JS _ -> fields
62+ ElmVar _ _ -> fields
63+ JsVar _ _ -> fields
64+ ElmField f -> Map.insertWith (+) f 1 fields
65+ JsField _ -> fields
66+ JsEnum _ -> fields
67+ Debug -> fields
68+ Prod -> fields
6969
7070
71−type ImportDict =
72− Map.Map Name.Name [Pkg.Name]
7371
72+-- FROM FILE
73+
74+
75+data Content =
76+ Content [Src.Import] [Chunk]
7477
75−parser :: ImportDict -> Parser Content
76−parser importDict =
77− do word2 0x2F 0x2A {-/*-} E.XXX
78− Module.freshLine
79− imports <- Module.chompImports []
80− word2 0x2A 0x2F {-*/-} E.XXX
81− let (vtable, deps) = processImports importDict imports
82− chunks <- parseChunks vtable Map.empty Map.empty
83− return $ Content chunks deps
78+
79+type Foreigns =
80+ Map.Map ModuleName.Raw Pkg.Name
81+
82+
83+fromByteString :: Pkg.Name -> Foreigns -> B.ByteString -> Maybe Content
84+fromByteString pkg foreigns bytes =
85+ case P.fromByteString (parser pkg foreigns) toError bytes of
86+ Right content ->
87+ Just content
88+
89+ Left () ->
90+ Nothing
91+
92+
93+parser :: Pkg.Name -> Foreigns -> Parser () Content
94+parser pkg foreigns =
95+ do word2 0x2F 0x2A {-/*-} toError
96+ Space.chomp ignoreError
97+ Space.checkFreshLine toError
98+ imports <- specialize ignoreError (Module.chompImports [])
99+ word2 0x2A 0x2F {-*/-} toError
100+ chunks <- parseChunks (toVarTable pkg foreigns imports) Map.empty Map.empty
101+ return (Content imports chunks)
102+
103+
104+toError :: Row -> Col -> ()
105+toError _ _ =
106+ ()
107+
108+
109+ignoreError :: a -> Row -> Col -> ()
110+ignoreError _ _ _ =
111+ ()
84112
85113
86114
87115-- PARSE CHUNKS
88116
89117
90−parseChunks :: VarTable -> Enums -> Fields -> Parser [Chunk]
118+parseChunks :: VarTable -> Enums -> Fields -> Parser () [Chunk]
91119parseChunks vtable enums fields =
92− P.Parser $ \(P.State pos end indent row col ctx) cok _ cerr _ ->
120+ P.Parser $ \(P.State src pos end indent row col) cok _ cerr _ ->
93121 let
94122 (# chunks, newPos, newRow, newCol #) =
95− chompChunks vtable enums fields pos end row col pos []
123+ chompChunks vtable enums fields src pos end row col pos []
96124 in
97125 if newPos == end then
98− cok chunks (P.State newPos end indent newRow newCol ctx)
126+ cok chunks (P.State src newPos end indent newRow newCol)
99127 else
100− cerr row col ctx E.XXX
101−
102−
103−addJS :: Ptr Word8 -> Ptr Word8 -> [Chunk] -> [Chunk]
104−addJS start end revChunks =
105− if start == end
106− then revChunks
107− else JS (Utf8.fromPtr start end) : revChunks
128+ cerr row col toError
108129
109130
110−chompChunks :: VarTable -> Enums -> Fields -> Ptr Word8 -> Ptr Word8 -> Word16 -> Word16 -> Ptr Word8 -> [Chunk] -> (# [Chunk], Ptr Word8, Word16, Word16 #)
111−chompChunks vs es fs pos end row col lastPos revChunks =
131+chompChunks :: VarTable -> Enums -> Fields -> ForeignPtr Word8 -> Ptr Word8 -> Ptr Word8 -> Row -> Col -> Ptr Word8 -> [Chunk] -> (# [Chunk], Ptr Word8, Row, Col #)
132+chompChunks vs es fs src pos end row col lastPos revChunks =
112133 if pos >= end then
113− (# reverse (addJS lastPos end revChunks), pos, row, col #)
134+ let !js = toByteString src lastPos end in
135+ (# reverse (JS js : revChunks), pos, row, col #)
114136
115137 else
116138 let !word = unsafeIndex pos in
@@ -120,31 +142,45 @@ chompChunks vs es fs pos end row col lastPos revChunks =
120142 !pos3 = plusPtr pos 3
121143 in
122144 if pos3 <= end && unsafeIndex pos1 == 0x5F {-_-} then
123− chompTag vs es fs pos3 end row (col + 3) (addJS lastPos pos revChunks)
145+ let !js = toByteString src lastPos pos in
146+ chompTag vs es fs src pos3 end row (col + 3) (JS js : revChunks)
124147 else
125− chompChunks vs es fs pos1 end row (col + 1) lastPos revChunks
148+ chompChunks vs es fs src pos1 end row (col + 1) lastPos revChunks
126149
127150 else if word == 0x0A {-\n-} then
128− chompChunks vs es fs (plusPtr pos 1) end (row + 1) 1 lastPos revChunks
151+ chompChunks vs es fs src (plusPtr pos 1) end (row + 1) 1 lastPos revChunks
129152
130153 else
131154 let
132− !newPos = plusPtr pos (getCharWidth pos end word)
155+ !newPos = plusPtr pos (getCharWidth word)
133156 in
134− chompChunks vs es fs newPos end row (col + 1) lastPos revChunks
157+ chompChunks vs es fs src newPos end row (col + 1) lastPos revChunks
158+
159+
160+toByteString :: ForeignPtr Word8 -> Ptr Word8 -> Ptr Word8 -> B.ByteString
161+toByteString src pos end =
162+ let
163+ !off = minusPtr pos (unsafeForeignPtrToPtr src)
164+ !len = minusPtr end pos
165+ in
166+ B.PS src off len
167+
135168
136169
137170-- relies on external checks in chompChunks
138−chompTag :: VarTable -> Enums -> Fields -> Ptr Word8 -> Ptr Word8 -> Word16 -> Word16 -> [Chunk] -> (# [Chunk], Ptr Word8, Word16, Word16 #)
139−chompTag vs es fs pos end row col revChunks =
171+chompTag :: VarTable -> Enums -> Fields -> ForeignPtr Word8 -> Ptr Word8 -> Ptr Word8 -> Row -> Col -> [Chunk] -> (# [Chunk], Ptr Word8, Row, Col #)
172+chompTag vs es fs src pos end row col revChunks =
140173 let
141174 (# newPos, newCol #) = Var.chompInnerChars pos end col
142175 !tagPos = plusPtr pos (-1)
143176 !word = unsafeIndex tagPos
144177 in
145178 if word == 0x24 {-$-} then
146− chompChunks vs es fs newPos end row newCol newPos $
147− ElmField (Name.fromPtr pos newPos) : revChunks
179+ let
180+ !name = Name.fromPtr pos newPos
181+ in
182+ chompChunks vs es fs src newPos end row newCol newPos $
183+ ElmField name : revChunks
148184 else
149185 let
150186 !name = Name.fromPtr tagPos newPos
@@ -154,7 +190,7 @@ chompTag vs es fs pos end row col revChunks =
154190 (enum, newEnums) =
155191 lookupEnum (word - 0x30) name es
156192 in
157− chompChunks vs newEnums fs newPos end row newCol newPos $
193+ chompChunks vs newEnums fs src newPos end row newCol newPos $
158194 JsEnum enum : revChunks
159195
160196 else if 0x61 {-a-} <= word && word <= 0x7A {-z-} then
@@ -162,19 +198,19 @@ chompTag vs es fs pos end row col revChunks =
162198 (field, newFields) =
163199 lookupField name fs
164200 in
165− chompChunks vs es newFields newPos end row newCol newPos $
201+ chompChunks vs es newFields src newPos end row newCol newPos $
166202 JsField field : revChunks
167203
168204 else if name == "DEBUG" then
169− chompChunks vs es fs newPos end row newCol newPos (Debug : revChunks)
205+ chompChunks vs es fs src newPos end row newCol newPos (Debug : revChunks)
170206
171207 else if name == "PROD" then
172− chompChunks vs es fs newPos end row newCol newPos (Prod : revChunks)
208+ chompChunks vs es fs src newPos end row newCol newPos (Prod : revChunks)
173209
174210 else
175211 case Map.lookup name vs of
176212 Just chunk ->
177− chompChunks vs es fs newPos end row newCol newPos (chunk : revChunks)
213+ chompChunks vs es fs src newPos end row newCol newPos (chunk : revChunks)
178214
179215 Nothing ->
180216 (# revChunks, pos, row, col #)
@@ -230,60 +266,34 @@ type VarTable =
230266 Map.Map Name.Name Chunk
231267
232268
233−type State =
234− (VarTable, Set.Set Dep)
269+toVarTable :: Pkg.Name -> Foreigns -> [Src.Import] -> VarTable
270+toVarTable pkg foreigns imports =
271+ List.foldl' (addImport pkg foreigns) Map.empty imports
235272
236273
237−processImports :: ImportDict -> [Src.Import] -> State
238−processImports importDict imports =
239− List.foldl' (addImport importDict) (Map.empty, Set.empty) imports
240−
241−
242−addImport :: ImportDict -> State -> Src.Import -> State
243−addImport importDict state (Src.Import (A.At _ home) maybeAlias exposing) =
244− if Name.isKernel home then
274+addImport :: Pkg.Name -> Foreigns -> VarTable -> Src.Import -> VarTable
275+addImport pkg foreigns vtable (Src.Import (A.At _ importName) maybeAlias exposing) =
276+ if Name.isKernel importName then
245277 case maybeAlias of
246278 Just _ ->
247− error ("Cannot use aliases on kernel import of: " ++ Name.toChars home)
279+ error ("cannot use `as` with kernel import of: " ++ Name.toChars importName)
248280
249281 Nothing ->
250− addKernelImport (Name.getKernel home) exposing state
251−
252− else
253− case Map.lookup home importDict of
254− Just [pkg] ->
255282 let
256− canonicalHome = ModuleName.Canonical pkg home
257− prefix = toPrefix home maybeAlias
283+ home = Name.getKernel importName
284+ add table name =
285+ Map.insert (Name.sepBy 0x5F {-_-} home name) (JsVar home name) table
258286 in
259− addNormalImport canonicalHome prefix exposing state
260−
261− _ ->
262− error ("Cannot find kernel import of: " ++ Name.toChars home)
263−
287+ List.foldl' add vtable (toNames exposing)
264288
265−-- INVARIANT: the `home` is the * in `Elm.Kernel.*`
266−--
267−addKernelImport :: Name.Name -> Src.Exposing -> State -> State
268−addKernelImport home exposing (vtable, deps) =
269− let
270− addVar table name =
271− Map.insert (Name.sepBy 0x5F {-_-} home name) (JsVar home name) table
272− in
273− ( List.foldl' addVar vtable (toNames exposing)
274− , Set.insert (KernelDep home) deps
275− )
276−
277−
278−addNormalImport :: ModuleName.Canonical -> Name.Name -> Src.Exposing -> State -> State
279−addNormalImport home prefix exposing state =
280− let
281− addVar (vtable, deps) name =
282− ( Map.insert (Name.sepBy 0x5F {-_-} prefix name) (ElmVar home name) vtable
283− , Set.insert (ElmDep home name) deps
284− )
285− in
286− List.foldl' addVar state (toNames exposing)
289+ else
290+ let
291+ home = ModuleName.Canonical (Map.findWithDefault pkg importName foreigns) importName
292+ prefix = toPrefix importName maybeAlias
293+ add table name =
294+ Map.insert (Name.sepBy 0x5F {-_-} prefix name) (ElmVar home name) table
295+ in
296+ List.foldl' add vtable (toNames exposing)
287297
288298
289299toPrefix :: Name.Name -> Maybe Name.Name -> Name.Name
@@ -303,25 +313,25 @@ toNames :: Src.Exposing -> [Name.Name]
303313toNames exposing =
304314 case exposing of
305315 Src.Open ->
306− error "Cannot have `exposing (..)` in kernel code."
316+ error "cannot have `exposing (..)` in kernel code."
307317
308318 Src.Explicit exposedList ->
309319 map toName exposedList
310320
311321
312−toName :: A.Located Src.Exposed -> Name.Name
313−toName (A.At _ exposed) =
322+toName :: Src.Exposed -> Name.Name
323+toName exposed =
314324 case exposed of
315− Src.Lower name ->
325+ Src.Lower (A.At _ name) ->
316326 name
317327
318− Src.Upper name Src.Private ->
328+ Src.Upper (A.At _ name) Src.Private ->
319329 name
320330
321− Src.Upper _ Src.Public ->
331+ Src.Upper _ (Src.Public _) ->
322332 error "cannot have Maybe(..) syntax in kernel code header"
323333
324− Src.Operator _ ->
334+ Src.Operator _ _ ->
325335 error "cannot use binops in kernel code"
326336
327337
@@ -332,7 +342,7 @@ toName (A.At _ exposed) =
332342instance Binary Chunk where
333343 put chunk =
334344 case chunk of
335− JS a -> putWord8 0 >> put (coerce a :: Utf8.String)
345+ JS a -> putWord8 0 >> put a
336346 ElmVar a b -> putWord8 1 >> put a >> put b
337347 JsVar a b -> putWord8 2 >> put a >> put b
338348 ElmField a -> putWord8 3 >> put a
@@ -344,7 +354,7 @@ instance Binary Chunk where
344354 get =
345355 do word <- getWord8
346356 case word of
347− 0 -> liftM toJS get
357+ 0 -> liftM JS get
348358 1 -> liftM2 ElmVar get get
349359 2 -> liftM2 JsVar get get
350360 3 -> liftM ElmField get
@@ -353,8 +363,3 @@ instance Binary Chunk where
353363 6 -> return Debug
354364 7 -> return Prod
355365 _ -> error "problem deserializing Elm.Kernel.Chunk"
356−
357−
358−toJS :: Utf8.String -> Chunk
359−toJS str =
360− JS (coerce str)
builder/src/Elm/Licenses.hs → compiler/src/Elm/Licenses.hsrenamed+48−65

This diff is too big to show here.

compiler/src/Elm/Magnitude.hsnew file+24

This diff is too big to show here.

compiler/src/Elm/ModuleName.hs+81−55

This diff is too big to show here.

compiler/src/Elm/Package.hs+220−89

This diff is too big to show here.

compiler/src/Elm/String.hsnew file+133

This diff is too big to show here.

compiler/src/Elm/Version.hs+79−68

This diff is too big to show here.

builder/src/Generate/Html.hs → compiler/src/Generate/Html.hsrenamed+17−4

This diff is too big to show here.

compiler/src/Generate/JavaScript.hs+109−98

This diff is too big to show here.

compiler/src/Generate/JavaScript/Builder.hs+207−217

This diff is too big to show here.

compiler/src/Generate/JavaScript/Expression.hs+80−79

This diff is too big to show here.

builder/src/Generate/Functions.hs → compiler/src/Generate/JavaScript/Functions.hsrenamed+6−3

This diff is too big to show here.

compiler/src/Generate/JavaScript/Name.hs+22−12

This diff is too big to show here.

compiler/src/Generate/JavaScript/Mode.hs → compiler/src/Generate/Mode.hsrenamed+10−53

This diff is too big to show here.

compiler/src/Json/Decode.hs+333−180

This diff is too big to show here.

compiler/src/Json/Encode.hs+41−26

This diff is too big to show here.

compiler/src/Json/String.hsnew file+192

This diff is too big to show here.

builder/src/Generate/Nitpick.hs → compiler/src/Nitpick/Debug.hsrenamed+7−19

This diff is too big to show here.

compiler/src/Nitpick/PatternMatches.hs+10−9

This diff is too big to show here.

compiler/src/Optimize/DecisionTree.hs+5−5

This diff is too big to show here.

compiler/src/Optimize/Module.hs+35−38

This diff is too big to show here.

compiler/src/Optimize/Names.hs+1−7

This diff is too big to show here.

compiler/src/Optimize/Port.hs+3−3

This diff is too big to show here.

compiler/src/Parse/Declaration.hs+180−131

This diff is too big to show here.

compiler/src/Parse/Docs.hsdeleted−275

This diff is too big to show here.

compiler/src/Parse/Expression.hs+330−341

This diff is too big to show here.

compiler/src/Parse/Keyword.hs+83−84

This diff is too big to show here.

compiler/src/Parse/Module.hs+330−259

This diff is too big to show here.

compiler/src/Parse/Number.hs+37−34

This diff is too big to show here.

compiler/src/Parse/Pattern.hs+138−130

This diff is too big to show here.

compiler/src/Parse/Primitives.hs+199−123

This diff is too big to show here.

compiler/src/Parse/Repl.hsdeleted−117

This diff is too big to show here.

compiler/src/Parse/Shader.hs+28−28

This diff is too big to show here.

compiler/src/Parse/Space.hsnew file+273

This diff is too big to show here.

compiler/src/Parse/String.hsnew file+343

This diff is too big to show here.

compiler/src/Parse/Symbol.hs+22−37

This diff is too big to show here.

compiler/src/Parse/Type.hs+101−103

This diff is too big to show here.

compiler/src/Parse/Utf8.hsdeleted−333

This diff is too big to show here.

compiler/src/Parse/Utils.hsdeleted−256

This diff is too big to show here.

compiler/src/Parse/Variable.hs+54−49

This diff is too big to show here.

compiler/src/Reporting/Annotation.hs+1−1

This diff is too big to show here.

compiler/src/Reporting/Doc.hs+96−54

This diff is too big to show here.

compiler/src/Reporting/Error.hs+175−22

This diff is too big to show here.

compiler/src/Reporting/Error/Canonicalize.hs+221−234

This diff is too big to show here.

compiler/src/Reporting/Error/Docs.hs+144−35

This diff is too big to show here.

compiler/src/Reporting/Error/Import.hsnew file+162

This diff is too big to show here.

compiler/src/Reporting/Error/Json.hs+280−270

This diff is too big to show here.

compiler/src/Reporting/Error/Main.hs+11−11

This diff is too big to show here.

compiler/src/Reporting/Error/Pattern.hs+9−8

This diff is too big to show here.

compiler/src/Reporting/Error/Syntax.hs+5688−627

This diff is too big to show here.

compiler/src/Reporting/Error/Type.hs+111−90

This diff is too big to show here.

compiler/src/Reporting/Render/Code.hs+181−44

This diff is too big to show here.

compiler/src/Reporting/Render/Type/Localizer.hs+16−38

This diff is too big to show here.

compiler/src/Reporting/Report.hs+2−65

This diff is too big to show here.

compiler/src/Reporting/Result.hs+12−2

This diff is too big to show here.

compiler/src/Reporting/Warning.hs+13−13

This diff is too big to show here.

compiler/src/Type/Constrain/Module.hs+3−3

This diff is too big to show here.

compiler/src/Type/Error.hs+17−126

This diff is too big to show here.

compiler/src/Type/Solve.hs+11−3

This diff is too big to show here.

compiler/src/Type/Unify.hs+12−10

This diff is too big to show here.

docs/elm.json/application.md+2−2

This diff is too big to show here.

docs/elm.json/package.md+1−1

This diff is too big to show here.

upgrade-docs/0.16.md → docs/upgrade-instructions/0.16.mdrenamed

The content is the same.

upgrade-docs/0.17.md → docs/upgrade-instructions/0.17.mdrenamed

The content is the same.

upgrade-docs/0.18.md → docs/upgrade-instructions/0.18.mdrenamed

The content is the same.

upgrade-docs/0.19.md → docs/upgrade-instructions/0.19.0.mdrenamed

The content is the same.

docs/upgrade-instructions/0.19.1.mdnew file+60

This diff is too big to show here.

upgrade-docs/earlier.md → docs/upgrade-instructions/earlier.mdrenamed

The content is the same.

elm.cabal+69−98

This diff is too big to show here.

hints/bad-recursion.mdnew file+133

This diff is too big to show here.

hints/comparing-custom-types.mdnew file+98

This diff is too big to show here.

hints/comparing-records.mdnew file+85

This diff is too big to show here.

hints/implicit-casts.mdnew file+50

This diff is too big to show here.

hints/import-cycles.mdnew file+184

This diff is too big to show here.

hints/imports.mdnew file+126

This diff is too big to show here.

hints/infinite-type.mdnew file+42

This diff is too big to show here.

hints/init.mdnew file+55

This diff is too big to show here.

hints/missing-patterns.mdnew file+139

This diff is too big to show here.

hints/optimize.mdnew file+59

This diff is too big to show here.

hints/port-modules.mdnew file+32

This diff is too big to show here.

hints/recursive-alias.mdnew file+162

This diff is too big to show here.

hints/repl.mdnew file+73

This diff is too big to show here.

hints/shadowing.mdnew file+70

This diff is too big to show here.

hints/tuples.mdnew file+19

This diff is too big to show here.

hints/type-annotations.mdnew file+60

This diff is too big to show here.

installers/README.mdnew file+32

This diff is too big to show here.

installers/linux/Dockerfilenew file+39

This diff is too big to show here.

installers/linux/README.mdnew file+93

This diff is too big to show here.

installers/mac/Distribution.xml+5−3

This diff is too big to show here.

installers/mac/README.mdnew file+93

This diff is too big to show here.

installers/mac/Resources/en.lproj/background.pngdeleted

Binary file not shown.

installers/mac/Resources/en.lproj/conclusion.rtf+13−6

This diff is too big to show here.

installers/mac/Resources/en.lproj/welcome.rtf+9−4

This diff is too big to show here.

installers/mac/helper-scripts/elm-startup.sh+1−1

This diff is too big to show here.

installers/mac/make-installer.sh+30−3

This diff is too big to show here.

installers/npm/PUBLISHING.md+29−141

This diff is too big to show here.

installers/npm/README.md+30−23

This diff is too big to show here.

installers/npm/bin/elmmode 100644 → 100755+47−41

This diff is too big to show here.

installers/npm/download.jsnew file+114

This diff is too big to show here.

installers/npm/index.jsdeleted−21

This diff is too big to show here.

installers/npm/install.jsnew file+4

This diff is too big to show here.

installers/npm/package.json+13−15

This diff is too big to show here.

installers/npm/troubleshooting.mdnew file+76

This diff is too big to show here.

installers/win/Nsisfile.nsi+16−16

This diff is too big to show here.

installers/win/README.md+18−3

This diff is too big to show here.

installers/win/file.icodeleted

Binary file not shown.

installers/win/inst.dat+1−2

This diff is too big to show here.

installers/win/logo.ico

Binary file not shown.

installers/win/uninst.dat+1−2

This diff is too big to show here.

installers/win/welcome.bmp

Binary file not shown.

reactor/assets/waiting.gifdeleted

Binary file not shown.

reactor/elm.json+11−9

This diff is too big to show here.

reactor/src/Deps.elmnew file+1210

This diff is too big to show here.

reactor/src/Index.elm+20−15

This diff is too big to show here.

reactor/src/Index/Navigator.elm+1−1

This diff is too big to show here.

reactor/src/mock.txtnew file+33

This diff is too big to show here.

roadmap.mdnew file+29

This diff is too big to show here.

terminal/src/Terminal/Args.hs → terminal/impl/Terminal.hsrenamed+36−31

This diff is too big to show here.

terminal/src/Terminal/Args/Chomp.hs → terminal/impl/Terminal/Chomp.hsrenamed+4−5

This diff is too big to show here.

terminal/src/Terminal/Args/Error.hs → terminal/impl/Terminal/Error.hsrenamed+28−18

This diff is too big to show here.

terminal/impl/Terminal/Helpers.hsnew file+148

This diff is too big to show here.

terminal/src/Terminal/Args/Internal.hs → terminal/impl/Terminal/Internal.hsrenamed+8−8

This diff is too big to show here.

terminal/src/Bump.hs+158−8

This diff is too big to show here.

terminal/src/Develop.hs+70−77

This diff is too big to show here.

terminal/src/Develop/Generate/Index.hs+149−74

This diff is too big to show here.

terminal/src/Develop/StaticFiles.hs+1−7

This diff is too big to show here.

terminal/src/Develop/StaticFiles/Build.hs+46−29

This diff is too big to show here.

terminal/src/Diff.hs+348−6

This diff is too big to show here.

terminal/src/Init.hs+43−39

This diff is too big to show here.

terminal/src/Install.hs+401−14

This diff is too big to show here.

terminal/src/Main.hs+34−39

This diff is too big to show here.

terminal/src/Make.hs+257−32

This diff is too big to show here.

terminal/src/Publish.hs+529−8

This diff is too big to show here.

terminal/src/Repl.hs+522−197

This diff is too big to show here.

terminal/src/Terminal/Args/Helpers.hsdeleted−125

This diff is too big to show here.

worker/elm.cabalnew file+210

This diff is too big to show here.

worker/elm.jsonnew file+26

This diff is too big to show here.

worker/nginx.confnew file+22

This diff is too big to show here.

worker/outlines/compile/elm.jsonnew file+32

This diff is too big to show here.

worker/outlines/repl/elm.jsonnew file+19

This diff is too big to show here.

worker/src/Artifacts.hsnew file+155

This diff is too big to show here.

worker/src/Cors.hsnew file+48

This diff is too big to show here.

worker/src/Endpoint/Compile.hsnew file+323

This diff is too big to show here.

worker/src/Endpoint/Quotes.hsnew file+114

This diff is too big to show here.

worker/src/Endpoint/Repl.hsnew file+244

This diff is too big to show here.

worker/src/Errors.elmnew file+217

This diff is too big to show here.

worker/src/Main.hsnew file+73

This diff is too big to show here.