on 397fc55 help sign in
.buildkite/pipeline.ymldeleted−18
since splitsnapshots
unifiedsplit
@@ -1,18 +0,0 @@
1−steps:
2− - label: Build and test with GHC 8.6.5
3− command: |
4− nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc865
5− timeout: 100
6− - label: Build and test with GHC 8.8.4
7− command: |
8− nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc884
9− timeout: 100
10− - label: Build and test with GHC 8.10.1
11− command: |
12− nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc8101
13− timeout: 100
14− - wait
15− - label: Check formatting
16− command: |
17− ./format.sh
18− git diff --exit-code --color=always
.circleci/config.ymlnew file+44
@@ -0,0 +1,44 @@
1+version: 2
2+
3+jobs:
4+ build:
5+ docker:
6+ - image: nixos/nix:2.1.3
7+ steps:
8+ - checkout
9+ - run:
10+ name: Add ca-certificates
11+ command: |
12+ apk --no-progress update
13+ apk --no-progress add ca-certificates
14+ - run:
15+ name: Setup Cachix
16+ command: |
17+ nix-env -iA cachix -f https://cachix.org/api/v1/install
18+ USER=dummy cachix use tweag
19+ - run:
20+ name: Build environment
21+ command: |
22+ nix-shell --pure --run :
23+ - run:
24+ name: Push Cachix
25+ command: |
26+ if [ -n "$CACHIX_SIGNING_KEY" ];
27+ then nix-store -qR --include-outputs $(nix-instantiate default.nix) | cachix push tweag;
28+ fi
29+ - run:
30+ name: Build the package (includes running the tests)
31+ command: nix-build --keep-going
32+ - run:
33+ name: Generate Haddocks
34+ command: nix-build --attr ormolu.doc
35+ - store_artifacts:
36+ path: result-doc/share/doc
37+ destination: haddock
38+
39+workflows:
40+ version: 2
41+ build:
42+ jobs:
43+ - build:
44+ context: org-global
.github/workflows/binaries.ymldeleted−39
@@ -1,39 +0,0 @@
1−name: Build binaries
2−on:
3− release:
4− types: [published]
5−jobs:
6− build:
7− strategy:
8− fail-fast: false
9− matrix:
10− os: [ubuntu-latest, macOS-latest, windows-latest]
11− runs-on: ${{ matrix.os }}
12− steps:
13− - uses: actions/checkout@v2
14− - uses: actions/setup-haskell@v1
15− if: runner.os != 'Linux'
16− with:
17− ghc-version: '8.10.1'
18− cabal-version: '3.2'
19− - name: Build Linux binary
20− if: runner.os == 'Linux'
21− run: |
22− docker run \
23− -v $(pwd):/mnt -w /mnt \
24− utdemir/ghc-musl:v14-ghc8101 \
25− bash .github/workflows/build.sh
26− - name: Build ${{ runner.os }} binary
27− if: runner.os != 'Linux'
28− shell: bash
29− run: |
30− cabal build exe:ormolu
31− cp $(find dist-newstyle \( -name ormolu -o -name ormolu.exe \) -type f) ormolu
32− - uses: actions/upload-release-asset@v1
33− env:
34− GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35− with:
36− upload_url: ${{ github.event.release.upload_url }}
37− asset_path: ormolu
38− asset_name: ormolu-${{ runner.os }}
39− asset_content_type: application/octet-stream
.github/workflows/build.shdeleted−7
@@ -1,7 +0,0 @@
1−set -e
2−
3−cabal update
4−cabal build exe:ormolu --enable-executable-static --ghc-options="-split-sections"
5−
6−cp $(find dist-newstyle -name ormolu -type f) .
7−strip -s ormolu
.gitignore−1
@@ -26,5 +26,4 @@ cabal.sandbox.config
26dist-*/
26dist-*/
27dist/
27dist/
28stack.yaml
28stack.yaml
29−stack.yaml.lock
30result*
29result*
CHANGELOG.md−231
@@ -1,234 +1,3 @@
1−## Unreleased
2−
3−* Ormolu no longer overwrites already formatted files. [PR
4− 649](https://github.com/tweag/ormolu/pull/649).
5−
6−## Ormolu 0.1.2.0
7−
8−* Fixed the bug when comments in different styles got glued together after
9− formatting. [Issue 589](https://github.com/tweag/ormolu/issues/589).
10−
11−* Added `-i` as a shortcut for `--mode inplace`. [Issue
12− 467](https://github.com/tweag/ormolu/issues/467).
13−
14−* Improved grouping of top-level declarations. [Issue
15− 466](https://github.com/tweag/ormolu/issues/466).
16−
17−## Ormolu 0.1.1.0
18−
19−* Imports in a import lists are now normalized: duplicate imports are
20− combined/eliminated intelligently.
21−
22−* Import declarations that can be merged are now automatically merged.
23− [Issue 414](https://github.com/tweag/ormolu/issues/414).
24−
25−* The magic comments for disabling and enabling Ormolu now can encompass any
26− fragment of code provided that the remaining code after exclusion of the
27− disabled part is still syntactically correct. [Issue
28− 601](https://github.com/tweag/ormolu/issues/601).
29−
30−* Improved sorting of operators in imports. [Issue
31− 602](https://github.com/tweag/ormolu/issues/602).
32−
33−* Fixed a bug related to trailing space in multiline comments in certain
34− cases. [Issue 603](https://github.com/tweag/ormolu/issues/602).
35−
36−* Added support for formatting linked lists with `(:)` as line terminator.
37− [Issue 478](https://github.com/tweag/ormolu/issues/478).
38−
39−* Fixed rendering of function arguments in multiline layout. [Issue
40− 609](https://github.com/tweag/ormolu/issues/609).
41−
42−* Blank lines between definitions in `let` and `while` bindings are now
43− preserved. [Issue 554](https://github.com/tweag/ormolu/issues/554).
44−
45−* Fixed the bug when type applications stuck to the `$` of TH splices that
46− followed them. [Issue 613](https://github.com/tweag/ormolu/issues/613).
47−
48−* Improved region formatting so that indented fragments—such as definitions
49− inside of `where` clauses—can be formatted. [Issue
50− 572](https://github.com/tweag/ormolu/issues/572).
51−
52−* Fixed the bug related to the de-association of pragma comments. [Issue
53− 619](https://github.com/tweag/ormolu/issues/619).
54−
55−## Ormolu 0.1.0.0
56−
57−* Fixed rendering of type signatures concerning several identifiers. [Issue
58− 566](https://github.com/tweag/ormolu/issues/566).
59−
60−* Fixed an idempotence issue with inline comments in tuples and parentheses.
61− [Issue 450](https://github.com/tweag/ormolu/issues/450).
62−
63−* Fixed an idempotence issue when certain comments were picked up as
64− “continuation” of a series of comments [Issue
65− 449](https://github.com/tweag/ormolu/issues/449).
66−
67−* Fixed an idempotence issue related to different indentation levels in a
68− comment series. [Issue 512](https://github.com/tweag/ormolu/issues/512).
69−
70−* Fixed an idempotence issue related to comments which may happen to be
71− separated from the elements they are attached to by the equality sign.
72− [Issue 340](https://github.com/tweag/ormolu/issues/340).
73−
74−* Fixed an idempotence issue with type synonym and data declarations where
75− the type has a Haddock. [Issue
76− 578](https://github.com/tweag/ormolu/issues/578).
77−
78−* Fix the false positive about AST differences in presence of comments with
79− multiple blank lines in a row. [Issue
80− 518](https://github.com/tweag/ormolu/issues/518).
81−
82−* Fixed rendering of comments around if expressions. [Issue
83− 458](https://github.com/tweag/ormolu/issues/458).
84−
85−* Unnamed fields of data constructors are now documented using the `-- ^`
86− syntax. [Issue 445](https://github.com/tweag/ormolu/issues/445) and [Issue
87− 428](https://github.com/tweag/ormolu/issues/428).
88−
89−* Fixed non-idempotent transformation of partly documented data definition.
90− [Issue 590](https://github.com/tweag/ormolu/issues/590).
91−
92−* Fixed an idempotence issue related to operators. [Issue
93− 522](https://github.com/tweag/ormolu/issues/522).
94−
95−* Renamed the `--check-idempotency` flag to `--check-idempotence`.
96− Apparently only the latter is correct.
97−
98−## Ormolu 0.0.5.0
99−
100−* Grouping of statements in `do`-blocks is now preserved. [Issue
101− 74](https://github.com/tweag/ormolu/issues/74).
102−
103−* Grouping of TH splices is now preserved. [Issue
104− 507](https://github.com/tweag/ormolu/issues/507).
105−
106−* Comments on pragmas are now preserved. [Issue
107− 216](https://github.com/tweag/ormolu/issues/216).
108−
109−* Ormolu can now be enabled and disabled via special comments. [Issue
110− 435](https://github.com/tweag/ormolu/issues/435).
111−
112−* Added experimental support for simple CPP. [Issue
113− 415](https://github.com/tweag/ormolu/issues/415).
114−
115−* Added two new options `--start-line` and `--end-line` that allow us to
116− select a region to format. [Issue
117− 516](https://github.com/tweag/ormolu/issues/516).
118−
119−* Fixed rendering of module headers in the presence of preceding comments or
120− Haddocks. [Issue 561](https://github.com/tweag/ormolu/issues/561).
121−
122−## Ormolu 0.0.4.0
123−
124−* When given several files to format, Ormolu does not stop on the first
125− failure, but tries to format all the files. [Issue
126− 502](https://github.com/tweag/ormolu/issues/502).
127−
128−* Made rendering of pattern matches involving operators consistent with
129− other cases of rendering of operators. [Issue
130− 500](https://github.com/tweag/ormolu/issues/500).
131−
132−* More compact rendering of type family injectivity constraints. [Issue
133− 482](https://github.com/tweag/ormolu/issues/482).
134−
135−* Improved rendering of the keyword `where` in class, data, and type family
136− declarations. When headers of these declarations are multi-line `where` is
137− now put on its own line. [Issue
138− 509](https://github.com/tweag/ormolu/issues/509).
139−
140−* Fixed the bug pertaining to rendering of arrow notation with multiline
141− expressions. [Issue 513](https://github.com/tweag/ormolu/issues/513).
142−
143−* Made rendering of data type definitions, value-level applications, and
144− application of types use the same style. Moreover, existential now doesn't
145− cause the data constructor be unconditionally rendered in multiline
146− layout. [Issue 427](https://github.com/tweag/ormolu/issues/427).
147−
148−* Records with a single data constructor are now formatted more compactly.
149− [Issue 425](https://github.com/tweag/ormolu/issues/425).
150−
151−* Switched to `ghc-lib-parser-8.10.1`.
152−
153−* Implemented support for the new language extensions `ImportQualifiedPost`
154− and `StandaloneKindSignatures`.
155−
156−## Ormolu 0.0.3.1
157−
158−* Fixed rendering of record updates with the record dot preprocessor syntax
159− [Issue 498](https://github.com/tweag/ormolu/issues/498).
160−
161−## Ormolu 0.0.3.0
162−
163−* Fixed an issue related to unnecessary use of curly braces. [Issue
164− 473](https://github.com/tweag/ormolu/issues/473).
165−
166−* Fixed the issue with formatting multi-way if when it happens to be a
167− function applied to arguments [Issue
168− 488](https://github.com/tweag/ormolu/issues/488). This changed the way
169− multi-line if is formatted in general.
170−
171−* Added support for record dot pre-processor when used via the plugin.
172− [Issue 486](https://github.com/tweag/ormolu/issues/486).
173−
174−* Stopped hanging record constructors and improved placing
175− potentially-hanging consturctions in the presence of comments. [Issue
176− 447](https://github.com/tweag/ormolu/issues/447).
177−
178−* Fixed indentation in presence of type applications. [Issue
179− 493](https://github.com/tweag/ormolu/issues/493).
180−
181−* Class and instance declarations now do not have a blank line after
182− `where`. Grouping of methods from the original input is also preserved
183− with some normalizations. [Issue
184− 431](https://github.com/tweag/ormolu/issues/431).
185−
186−## Ormolu 0.0.2.0
187−
188−* Switched to `ghc-lib-parser` instead of depending on the `ghc` package
189− directly. This should allow us to use newest features of GHC while not
190− necessarily depending on the newest version of the compiler. In addition
191− to that Ormolu is now GHCJS-compatible.
192−
193−* Now unrecognized GHC options passed with `--ghc-opt` cause Ormolu to fail
194− (exit code 7).
195−
196−* Fixed formatting of result type in closed type families. See [issue
197− 420](https://github.com/tweag/ormolu/issues/420).
198−
199−* Fixed a minor inconsistency between formatting of normal and foreign type
200− signatures. See [issue 408](https://github.com/tweag/ormolu/issues/408).
201−
202−* Fixed a bug when comment before module header with Haddock was moved
203− inside the export list. See [issue
204− 430](https://github.com/tweag/ormolu/issues/430).
205−
206−* Empty `forall`s are now correctly preserved. See [issue
207− 429](https://github.com/tweag/ormolu/issues/429).
208−
209−* Fixed [issue 446](https://github.com/tweag/ormolu/issues/446), which
210− involved braces and operators.
211−
212−* When there are comments between preceding Haddock (pipe-style) and its
213− corresponding declaration they are preserved like this in the output
214− instead of being shifted. To be clear, this is not a very good idea to
215− have comments in that position because the Haddock will end up not being
216− associated with the declarations. Issues
217− [440](https://github.com/tweag/ormolu/issues/440) and
218− [448](https://github.com/tweag/ormolu/issues/448).
219−
220−* Implemented correct handling of shebangs. [Issue
221− 377](https://github.com/tweag/ormolu/issues/377).
222−
223−* Implemented correct handling of stack headers. [Issue
224− 393](https://github.com/tweag/ormolu/issues/393).
225−
226−* Sorting language pragmas cannot not change meaning of the input program
227− anymore. [Issue 404](https://github.com/tweag/ormolu/issues/404).
228−
229−* Fixed formatting of applications where function is a complex expression.
230− [Issue 444](https://github.com/tweag/ormolu/issues/444).
231−
232## Ormolu 0.0.1.0
1## Ormolu 0.0.1.0
233
2
234* Initial release.
3* Initial release.
CONTRIBUTING.md+1−6
@@ -30,7 +30,7 @@ Testing is performed as following:
30* The result of printing is parsed back again and the AST is compared to the
30* The result of printing is parsed back again and the AST is compared to the
31 AST obtained from the original file. They should match.
31 AST obtained from the original file. They should match.
32* The output of printer is checked against the expected output.
32* The output of printer is checked against the expected output.
33−* Idempotence property is verified: formatting already formatted code
33+* Idempotency property is verified: formatting already formatted code
34 results in exactly the same output.
34 results in exactly the same output.
35
35
36Examples can be organized in sub-directories, see the existing ones for
36Examples can be organized in sub-directories, see the existing ones for
@@ -55,10 +55,5 @@ User settings -> Account integrations -> Refresh permissions
55
55
56in Circle CI app.
56in Circle CI app.
57
57
58−## Formatting
59−
60−Use `format.sh` script to format Ormolu with current version of Ormolu. If
61−Ormolu is not formatted like this, the CI will fail.
62−
63[issues]: https://github.com/tweag/ormolu/issues
58[issues]: https://github.com/tweag/ormolu/issues
64[bugs]: https://github.com/tweag/ormolu/issues?q=is%3Aissue+is%3Aopen+label%3Abug
59[bugs]: https://github.com/tweag/ormolu/issues?q=is%3Aissue+is%3Aopen+label%3Abug
DESIGN.md+11−14
@@ -1,8 +1,5 @@
1# Ormolu
1# Ormolu
2
2
3−*This document represents our discussions and plans at early stages of
4−development, it is no longer being updated.*
5−
6* [Analysis of the existing solutions](#analysis-of-the-existing-solutions)
3* [Analysis of the existing solutions](#analysis-of-the-existing-solutions)
7 * [Brittany](#brittany)
4 * [Brittany](#brittany)
8 * [Hindent](#hindent)
5 * [Hindent](#hindent)
@@ -24,7 +21,7 @@ It also includes recommendations for future implementers.
24
21
25We set for the following goals (mostly taken from
22We set for the following goals (mostly taken from
26[brittany](https://github.com/lspitzner/brittany)):
23[brittany](https://github.com/lspitzner/brittany)):
27−* Preserve the meaning of the formatted functions when no CPP is used;
24+* Preserve the meaning of the formatted functions;
28* Make reasonable use of screen space;
25* Make reasonable use of screen space;
29* Use linear space and computation time on the size of the input;
26* Use linear space and computation time on the size of the input;
30* Preserve comments;
27* Preserve comments;
@@ -140,10 +137,8 @@ impossible to guess what they'll be called on.
140
137
141### CPP
138### CPP
142
139
143−We allow CPP directives in the input, but we forgo the goal to preserve the
140+Formatting a module which uses CPP directives won't be supported. Instead,
144−meaning of the formatted functions in that case.
145−Instead of supporting CPP better, we hope for a solution to replace CPP to
146−do conditional compilation.
141+we hope for a solution to replace CPP to do conditional compilation.
147
142
148There are the following challenges when formatting a module with CPP:
143There are the following challenges when formatting a module with CPP:
149
144
@@ -182,15 +177,14 @@ True
182```
177```
183
178
184At the time of this writing, formatting this program with Hindent
179At the time of this writing, formatting this program with Hindent
185−or Ormolu produces the same output we would get if the CPP directives
180+produces the same output we would get if the CPP directives were
186−were considered comments:
181+considered comments:
187
182
188```
183```
189−$ ormolu --version
184+$ hindent --version
190−ormolu 0.0.5.0 HEAD fc64eada5c4da7a5b07d2872e253671b48aec115
185+hindent 5.2.7
191−using ghc-lib-parser 8.10.1.20200412
192
186
193−$ ormolu --mode inplace test.hs
187+$ hindent test.hs
194
188
195$ cat test.hs
189$ cat test.hs
196{-# LANGUAGE CPP #-}
190{-# LANGUAGE CPP #-}
@@ -230,6 +224,9 @@ to parse Haskell modules. If CPP is replaced with some language
230extension or mechanism to do conditional compilation, all tools
224extension or mechanism to do conditional compilation, all tools
231will benefit from it.
225will benefit from it.
232
226
227+Therefore, CPP won't be supported. If the CPP extension
228+is enabled, we should signal an error right away.
229+
233### Printing
230### Printing
234
231
235Just pretty-printing code (following the approach of Hindent) seems sane. It
232Just pretty-printing code (following the approach of Hindent) seems sane. It
README.md+29−73
@@ -4,26 +4,27 @@
4[![Hackage](https://img.shields.io/hackage/v/ormolu.svg?style=flat)](https://hackage.haskell.org/package/ormolu)
4[![Hackage](https://img.shields.io/hackage/v/ormolu.svg?style=flat)](https://hackage.haskell.org/package/ormolu)
5[![Stackage Nightly](http://stackage.org/package/ormolu/badge/nightly)](http://stackage.org/nightly/package/ormolu)
5[![Stackage Nightly](http://stackage.org/package/ormolu/badge/nightly)](http://stackage.org/nightly/package/ormolu)
6[![Stackage LTS](http://stackage.org/package/ormolu/badge/lts)](http://stackage.org/lts/package/ormolu)
6[![Stackage LTS](http://stackage.org/package/ormolu/badge/lts)](http://stackage.org/lts/package/ormolu)
7−[![Build status](https://badge.buildkite.com/8e3b0951f3652b77e1c422b361904136a539b0522029156354.svg?branch=master)](https://buildkite.com/tweag-1/ormolu)
7+[![CircleCI](https://circleci.com/gh/tweag/ormolu/tree/master.svg?style=svg&circle-token=cfd37a39265561eb44e608f97cf953cb2a394c03)](https://circleci.com/gh/tweag/ormolu/tree/master)
8
8
9Ormolu is a formatter for Haskell source code. The project was created with
9Ormolu is a formatter for Haskell source code. The project was created with
10the following goals in mind:
10the following goals in mind:
11
11
12* Using GHC's own parser to avoid parsing problems caused by
12* Using GHC's own parser to avoid parsing problems caused by
13 [`haskell-src-exts`][haskell-src-exts].
13 [`haskell-src-exts`][haskell-src-exts].
14−* Let some whitespace be programmable. The layout of the input influences
14+* Let some whitespace be programmable. The layout of the input
15− the layout choices in the output. This means that the choices between
15+ influence the layout choices in the output. This means that the
16− single-line/multi-line layouts in each particular situation are made by
16+ choices between single-line/multi-line layouts in each particular
17− the user, not by an algorithm. This makes the implementation simpler and
17+ situation are made by the user, not by an algorithm. This makes the
18− leaves some control to the user while still guaranteeing that the
18+ implementation simpler and leaves some control to the user while
19− formatted code is stylistically consistent.
19+ still guaranteeing that the formatted code is stylistically
20+ consistent.
20−* Writing code in such a way so it's easy to modify and maintain.
21+* Writing code in such a way so it's easy to modify and maintain. Roughly,
22+ it means that the project follows the path of [`hindent`][hindent] and is
23+ very much about printing AST in a particular way.
21* Implementing one “true” formatting style which admits no configuration.
24* Implementing one “true” formatting style which admits no configuration.
22* That formatting style aims to result in minimal diffs while still
25* That formatting style aims to result in minimal diffs while still
23 remaining very close to “conventional” Haskell formatting people use.
26 remaining very close to “conventional” Haskell formatting people use.
24−* Choose a style compatible with modern dialects of Haskell. As new Haskell
25− extensions enter broad use, we may change the style to accommodate them.
26−* Idempotence: formatting already formatted code doesn't change it.
27+* Idempotency: formatting already formatted code doesn't change it.
27* Be well-tested and robust to the point that it can be used in large
28* Be well-tested and robust to the point that it can be used in large
28 projects without exposing unfortunate, disappointing bugs here and there.
29 projects without exposing unfortunate, disappointing bugs here and there.
29
30
@@ -45,15 +46,14 @@ Alternatively, `stack` could be used with a `stack.yaml` file as follows.
45
46
46```console
47```console
47$ cat stack.yaml
48$ cat stack.yaml
48−resolver: lts-16.0
49+resolver: lts-14.3
49packages:
50packages:
50- '.'
51- '.'
51
52
52−$ stack build # to build
53+$ stack build
53−$ stack install # to install
54```
54```
55
55
56−To use Ormolu directly from GitHub with Nix, this snippet may come in handy:
56+To use Ormolu directly from GitHub with nix, this snippet may come in handy:
57
57
58```nix
58```nix
59# This overlay adds Ormolu straight from GitHub.
59# This overlay adds Ormolu straight from GitHub.
@@ -92,48 +92,25 @@ formatted output.
92$ ormolu --mode inplace Module.hs
92$ ormolu --mode inplace Module.hs
93```
93```
94
94
95−Use `find` to format a tree recursively:
95+## Current limitations
96−
97−```console
98−$ ormolu --mode inplace $(find . -name '*.hs')
99−```
100−
101−## Magic comments
102−
103−Ormolu understands two magic comments:
104−
105−```haskell
106−{- ORMOLU_DISABLE -}
107−```
108
96
109−and
97+* Does not handle CPP (wontfix, see [the design document][design]).
98+* Input modules should be parsable by Haddock, which is a bit stricter
99+ criterion than just being a valid Haskell modules.
100+* Various minor idempotence issues, most of them are related to comments †.
110
101
111−```haskell
102+† To be resolved in 0.0.2.0.
112−{- ORMOLU_ENABLE -}
113−```
114
103
115−This allows us to disable formatting selectively for code between these
104+## Editor integration
116−markers or disable it for the entire file. To achieve the latter, just put
117−`{- ORMOLU_DISABLE -}` at the very top. Note that the source code should
118−still be parseable even without the “excluded” part. Because of that the
119−magic comments cannot be placed arbitrary, but should rather enclose
120−independent top-level definitions.
121
105
122−## Current limitations
106+We know of the following editor integrations:
123
107
124−* CPP support is experimental. CPP is virtually impossible to handle
108+* [For Emacs][emacs-package]
125− correctly, so we process them as a sort of unchangeable snippets. This
126− works only in simple cases when CPP conditionals surround top-level
127− declarations. See the [CPP][design-cpp] section in the design notes for
128− a discussion of the dangers.
129−* Input modules should be parsable by Haddock, which is a bit stricter
130− criterion than just being valid Haskell modules.
131−* Various minor idempotence issues, most of them are related to comments.
132
109
133## Running on Hackage
110## Running on Hackage
134
111
135It's possible to try Ormolu on arbitrary packages from Hackage. For that
112It's possible to try Ormolu on arbitrary packages from Hackage. For that
136−execute (from the root of the cloned repo):
113+execute (from root of cloned repo):
137
114
138```console
115```console
139$ nix-build -A hackage.<package>
116$ nix-build -A hackage.<package>
@@ -144,38 +121,17 @@ also contain formatted `.hs` files for inspection and original inputs with
144`.hs-original` extension (those are with CPP dropped, exactly what is fed
121`.hs-original` extension (those are with CPP dropped, exactly what is fed
145into Ormolu).
122into Ormolu).
146
123
147−## Editor integration
148−
149−We know of the following editor integrations:
150−
151−* [Emacs][emacs-package]
152−* [VS Code][vs-code-plugin]
153−* vim: [neoformat][neoformat], [vim-ormolu][vim-ormolu]
154−
155−## Arch Linux
156−
157−To install Ormolu on Arch Linux, one can use [the package on AUR][aur]:
158−
159−```console
160−yay -S ormolu
161−```
162−
163## Contributing
124## Contributing
164
125
165−See [CONTRIBUTING.md][contributing].
126+See [CONTRIBUTING.md](./CONTRIBUTING.md).
166
127
167## License
128## License
168
129
169−See [LICENSE.md][license].
130+See [LICENSE.md](./LICENSE.md).
170
131
171Copyright © 2018–present Tweag I/O
132Copyright © 2018–present Tweag I/O
172
133
173−[design-cpp]: https://github.com/tweag/ormolu/blob/master/DESIGN.md#cpp
134+[design]: ./DESIGN.md#cpp
174−[contributing]: https://github.com/tweag/ormolu/blob/master/CONTRIBUTING.md
175−[license]: https://github.com/tweag/ormolu/blob/master/LICENSE.md
176[haskell-src-exts]: https://hackage.haskell.org/package/haskell-src-exts
135[haskell-src-exts]: https://hackage.haskell.org/package/haskell-src-exts
136+[hindent]: https://hackage.haskell.org/package/hindent
177[emacs-package]: https://github.com/vyorkin/ormolu.el
137[emacs-package]: https://github.com/vyorkin/ormolu.el
178−[vs-code-plugin]: https://marketplace.visualstudio.com/items?itemName=sjurmillidahl.ormolu-vscode
179−[vim-ormolu]: https://github.com/sdiehl/vim-ormolu
180−[neoformat]: https://github.com/sbdchd/neoformat
181−[aur]: https://aur.archlinux.org/packages/ormolu
app/Main.hs+95−133
@@ -1,17 +1,12 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE CPP #-}
2−{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE LambdaCase #-}
3{-# LANGUAGE RecordWildCards #-}
3{-# LANGUAGE RecordWildCards #-}
4{-# LANGUAGE TemplateHaskell #-}
4{-# LANGUAGE TemplateHaskell #-}
5−{-# LANGUAGE TypeApplications #-}
6
5
7module Main (main) where
6module Main (main) where
8
7
9−import Control.Exception (SomeException, displayException, try)
10import Control.Monad
8import Control.Monad
11−import Data.Bool (bool)
12−import Data.Either (lefts)
13import Data.List (intercalate, sort)
9import Data.List (intercalate, sort)
14−import qualified Data.Text.IO as TIO
15import Data.Version (showVersion)
10import Data.Version (showVersion)
16import Development.GitRev
11import Development.GitRev
17import Options.Applicative
12import Options.Applicative
@@ -21,8 +16,10 @@ import Ormolu.Utils (showOutputable)
21import Paths_ormolu (version)
16import Paths_ormolu (version)
22import System.Exit (ExitCode (..), exitWith)
17import System.Exit (ExitCode (..), exitWith)
23import System.IO (hPutStrLn, stderr)
18import System.IO (hPutStrLn, stderr)
19+import qualified Data.Text.IO as TIO
24
20
25-- | Entry point of the program.
21-- | Entry point of the program.
22+
26main :: IO ()
23main :: IO ()
27main = withPrettyOrmoluExceptions $ do
24main = withPrettyOrmoluExceptions $ do
28 Opts {..} <- execParser optsParserInfo
25 Opts {..} <- execParser optsParserInfo
@@ -30,50 +27,35 @@ main = withPrettyOrmoluExceptions $ do
30 case optInputFiles of
27 case optInputFiles of
31 [] -> formatOne' Nothing
28 [] -> formatOne' Nothing
32 ["-"] -> formatOne' Nothing
29 ["-"] -> formatOne' Nothing
33− [x] -> formatOne' (Just x)
30+ xs -> mapM_ (formatOne' . Just) xs
34− xs -> do
35− -- It is possible to get IOException, error's and 'OrmoluException's
36− -- from 'formatOne', so we just catch everything.
37− errs <-
38− lefts <$> mapM (try @SomeException . formatOne' . Just) (sort xs)
39− unless (null errs) $ do
40− mapM_ (hPutStrLn stderr . displayException) errs
41− exitWith (ExitFailure 102)
42
31
43-- | Format a single input.
32-- | Format a single input.
33+
44−formatOne ::
34+formatOne
45− -- | Mode of operation
35+ :: Mode -- ^ Mode of operation
46− Mode ->
47− -- | Configuration
36+ -> Config -- ^ Configuration
48− Config RegionIndices ->
49− -- | File to format or stdin as 'Nothing'
37+ -> Maybe FilePath -- ^ File to format or stdin as 'Nothing'
50− Maybe FilePath ->
51− IO ()
38+ -> IO ()
52formatOne mode config = \case
39formatOne mode config = \case
53 Nothing -> do
40 Nothing -> do
54 r <- ormoluStdin config
41 r <- ormoluStdin config
55 case mode of
42 case mode of
56 Stdout -> TIO.putStr r
43 Stdout -> TIO.putStr r
57− _ -> do
44+ _ -> do
58− hPutStrLn
45+ hPutStrLn stderr
59− stderr
60 "This feature is not supported when input comes from stdin."
46 "This feature is not supported when input comes from stdin."
61− -- 101 is different from all the other exit codes we already use.
47+ -- 101 is different from all the other exit codes we already use.
62 exitWith (ExitFailure 101)
48 exitWith (ExitFailure 101)
63 Just inputFile -> do
49 Just inputFile -> do
64− originalInput <- TIO.readFile inputFile
65− formattedInput <- ormoluFile config inputFile
50+ r <- ormoluFile config inputFile
66 case mode of
51 case mode of
67 Stdout ->
52 Stdout ->
68− TIO.putStr formattedInput
53+ TIO.putStr r
69− InPlace -> do
54+ InPlace ->
70− -- Only write when the contents have changed, in order to avoid
71− -- updating the modified timestamp if the file was already correctly
72− -- formatted.
73− when (formattedInput /= originalInput) $
74− TIO.writeFile inputFile formattedInput
55+ TIO.writeFile inputFile r
75 Check -> do
56 Check -> do
76− when (formattedInput /= originalInput) $
57+ r' <- TIO.readFile inputFile
58+ when (r /= r') $
77 -- 100 is different to all the other exit code that are emitted
59 -- 100 is different to all the other exit code that are emitted
78 -- either from an 'OrmoluException' or from 'error' and
60 -- either from an 'OrmoluException' or from 'error' and
79 -- 'notImplemented'.
61 -- 'notImplemented'.
@@ -83,121 +65,101 @@ formatOne mode config = \case
83-- Command line options parsing.
65-- Command line options parsing.
84
66
85data Opts = Opts
67data Opts = Opts
68+ { optMode :: !Mode
86− { -- | Mode of operation
69+ -- ^ Mode of operation
87− optMode :: !Mode,
70+ , optConfig :: !Config
88− -- | Ormolu 'Config'
71+ -- ^ Ormolu 'Config'
89− optConfig :: !(Config RegionIndices),
72+ , optInputFiles :: ![FilePath]
90− -- | Haskell source files to format or stdin (when the list is empty)
73+ -- ^ Haskell source files to format or stdin (when the list is empty)
91− optInputFiles :: ![FilePath]
92 }
74 }
93
75
94-- | Mode of operation.
76-- | Mode of operation.
77+
95data Mode
78data Mode
96− = -- | Output formatted source code to stdout
79+ = Stdout -- ^ Output formatted source code to stdout
97− Stdout
98− | -- | Overwrite original file
80+ | InPlace -- ^ Overwrite original file
99− InPlace
100− | -- | Exit with non-zero status code if
81+ | Check -- ^ Exit with non-zero status code if
101− -- source is not already formatted
82+ -- source is not already formatted
102− Check
103 deriving (Eq, Show)
83 deriving (Eq, Show)
104
84
105optsParserInfo :: ParserInfo Opts
85optsParserInfo :: ParserInfo Opts
106−optsParserInfo =
107− info (helper <*> ver <*> exts <*> optsParser) . mconcat $
86+optsParserInfo = info (helper <*> ver <*> exts <*> optsParser) . mconcat $
108− [ fullDesc,
87+ [ fullDesc
109− progDesc "",
88+ , progDesc ""
110− header ""
89+ , header ""
111− ]
90+ ]
112 where
91 where
113 ver :: Parser (a -> a)
92 ver :: Parser (a -> a)
114− ver =
115− infoOption verStr . mconcat $
93+ ver = infoOption verStr . mconcat $
116− [ long "version",
94+ [ long "version"
117− short 'v',
95+ , short 'v'
118− help "Print version of the program"
96+ , help "Print version of the program"
119− ]
97+ ]
120− verStr =
121− intercalate
98+ verStr = intercalate "\n"
122− "\n"
123− [ unwords
99+ [ unwords
124− [ "ormolu",
100+ [ "ormolu"
125− showVersion version,
101+ , showVersion version
126− $gitBranch,
102+ , $gitBranch
127− $gitHash
103+ , $gitHash
128− ],
129− "using ghc-lib-parser " ++ VERSION_ghc_lib_parser
130 ]
104 ]
105+ , "using ghc " ++ VERSION_ghc
106+ ]
131 exts :: Parser (a -> a)
107 exts :: Parser (a -> a)
132− exts =
133− infoOption displayExts . mconcat $
108+ exts = infoOption displayExts . mconcat $
134− [ long "manual-exts",
109+ [ long "manual-exts"
135− help "Display extensions that need to be enabled manually"
110+ , help "Display extensions that need to be enabled manually"
136− ]
111+ ]
137 displayExts = unlines $ sort (showOutputable <$> manualExts)
112 displayExts = unlines $ sort (showOutputable <$> manualExts)
138
113
139optsParser :: Parser Opts
114optsParser :: Parser Opts
140−optsParser =
115+optsParser = Opts
141− Opts
142− <$> ( (fmap (bool Stdout InPlace) . switch . mconcat)
143− [ short 'i',
144− help "A shortcut for --mode inplace"
145− ]
146− <|> (option parseMode . mconcat)
116+ <$> (option parseMode . mconcat)
147− [ long "mode",
117+ [ long "mode"
148− short 'm',
118+ , short 'm'
149− metavar "MODE",
119+ , metavar "MODE"
150− value Stdout,
120+ , value Stdout
151− help "Mode of operation: 'stdout' (default), 'inplace', or 'check'"
121+ , help "Mode of operation: 'stdout' (default), 'inplace', or 'check'"
152− ]
122+ ]
153− )
154− <*> configParser
123+ <*> configParser
155− <*> (many . strArgument . mconcat)
124+ <*> (many . strArgument . mconcat)
156− [ metavar "FILE",
125+ [ metavar "FILE"
157− help "Haskell source files to format or stdin (default)"
126+ , help "Haskell source files to format or stdin (default)"
158− ]
127+ ]
159
128
160−configParser :: Parser (Config RegionIndices)
129+configParser :: Parser Config
161−configParser =
130+configParser = Config
162− Config
163− <$> (fmap (fmap DynOption) . many . strOption . mconcat)
131+ <$> (fmap (fmap DynOption) . many . strOption . mconcat)
164− [ long "ghc-opt",
132+ [ long "ghc-opt"
165− short 'o',
133+ , short 'o'
166− metavar "OPT",
134+ , metavar "OPT"
167− help "GHC options to enable (e.g. language extensions)"
135+ , help "GHC options to enable (e.g. language extensions)"
168− ]
136+ ]
169− <*> (switch . mconcat)
137+ <*> (switch . mconcat)
170− [ long "unsafe",
138+ [ long "unsafe"
171− short 'u',
139+ , short 'u'
172− help "Do formatting faster but without automatic detection of defects"
140+ , help "Do formatting faster but without automatic detection of defects"
173− ]
141+ ]
174− <*> (switch . mconcat)
142+ <*> (switch . mconcat)
175− [ long "debug",
143+ [ long "debug"
176− short 'd',
144+ , short 'd'
177− help "Output information useful for debugging"
145+ , help "Output information useful for debugging"
178− ]
146+ ]
147+ <*> (switch . mconcat)
148+ [ long "tolerate-cpp"
149+ , short 'p'
150+ , help "Do not fail if CPP pragma is present"
151+ ]
179− <*> (switch . mconcat)
152+ <*> (switch . mconcat)
180− [ long "check-idempotence",
153+ [ long "check-idempotency"
181− short 'c',
154+ , short 'c'
182− help "Fail if formatting is not idempotent"
155+ , help "Fail if formatting is not idempotent"
183− ]
184− <*> ( RegionIndices
185− <$> (optional . option auto . mconcat)
186− [ long "start-line",
187− metavar "START",
188− help "Start line of the region to format (starts from 1)"
189− ]
156+ ]
190− <*> (optional . option auto . mconcat)
191− [ long "end-line",
192− metavar "END",
193− help "End line of the region to format (inclusive)"
194− ]
195− )
196
157
197----------------------------------------------------------------------------
158----------------------------------------------------------------------------
198-- Helpers
159-- Helpers
199
160
200-- | Parse 'Mode'.
161-- | Parse 'Mode'.
162+
201parseMode :: ReadM Mode
163parseMode :: ReadM Mode
202parseMode = eitherReader $ \case
164parseMode = eitherReader $ \case
203 "stdout" -> Right Stdout
165 "stdout" -> Right Stdout
data/examples/declaration/annotation/annotation-out.hs−1
@@ -18,5 +18,4 @@ foo = 5
18
18
19data Foo = Foo Int
19data Foo = Foo Int
20{-# ANN type Foo ("HLint: ignore") #-}
20{-# ANN type Foo ("HLint: ignore") #-}
21−
22{- Comment -}
21{- Comment -}
data/examples/declaration/class/associated-data1-out.hs+1
@@ -4,6 +4,7 @@ class Foo a where data FooBar a
4
4
5-- | Something.
5-- | Something.
6class Bar a where
6class Bar a where
7+
7 -- | Bar bar
8 -- | Bar bar
8 data BarBar a
9 data BarBar a
9
10
data/examples/declaration/class/associated-data2-out.hs+1
@@ -4,6 +4,7 @@ module Main where
4
4
5-- | Something more.
5-- | Something more.
6class Baz a where
6class Baz a where
7+
7 -- | Baz bar
8 -- | Baz bar
8 data
9 data
9 BazBar
10 BazBar
data/examples/declaration/class/associated-type-defaults-out.hs+2
@@ -4,6 +4,7 @@ class Foo a where type FooBar a = Int
4
4
5-- | Something.
5-- | Something.
6class Bar a where
6class Bar a where
7+
7 -- Define bar
8 -- Define bar
8 type
9 type
9 BarBar a =
10 BarBar a =
@@ -17,6 +18,7 @@ class Bar a where
17 a
18 a
18
19
19class Baz a where
20class Baz a where
21+
20 type
22 type
21 BazBar
23 BazBar
22 a
24 a
data/examples/declaration/class/associated-types1-out.hs+1
@@ -4,6 +4,7 @@ class Foo a where type FooBar a
4
4
5-- | Something.
5-- | Something.
6class Bar a where
6class Bar a where
7+
7 -- | Bar bar
8 -- | Bar bar
8 type BarBar a
9 type BarBar a
9
10
data/examples/declaration/class/associated-types2-out.hs+1
@@ -4,6 +4,7 @@ module Main where
4
4
5-- | Something more.
5-- | Something more.
6class Baz a where
6class Baz a where
7+
7 -- | Baz bar
8 -- | Baz bar
8 type
9 type
9 BazBar
10 BazBar
data/examples/declaration/class/default-implementations-comments-out.hs+1
@@ -2,6 +2,7 @@ module Main where
2
2
3-- | Baz
3-- | Baz
4class Baz a where
4class Baz a where
5+
5 foobar :: a -> a
6 foobar :: a -> a
6 foobar a =
7 foobar a =
7 barbaz (bazbar a)
8 barbaz (bazbar a)
data/examples/declaration/class/default-signatures-out.hs+2
@@ -4,11 +4,13 @@ module Main where
4
4
5-- | Something else.
5-- | Something else.
6class Bar a where
6class Bar a where
7+
7 -- | Bar
8 -- | Bar
8 bar ::
9 bar ::
9 String ->
10 String ->
10 String ->
11 String ->
11 a
12 a
13+
12 -- Pointless comment
14 -- Pointless comment
13 default bar ::
15 default bar ::
14 ( Read a,
16 ( Read a,
data/examples/declaration/class/default-signatures-simple-out.hs+2
@@ -2,7 +2,9 @@ module Main where
2
2
3-- | Something.
3-- | Something.
4class Foo a where
4class Foo a where
5+
5 -- | Foo
6 -- | Foo
6 foo :: a -> String
7 foo :: a -> String
8+
7 default foo :: Show a => a -> String
9 default foo :: Show a => a -> String
8 foo = show
10 foo = show
data/examples/declaration/class/dependency-super-classes-out.hs+4−2
@@ -4,7 +4,9 @@ module Main where
4
4
5-- | Something.
5-- | Something.
6class (MonadReader r s, MonadWriter w m) => MonadState s m | m -> s where
6class (MonadReader r s, MonadWriter w m) => MonadState s m | m -> s where
7+
7 get :: m s
8 get :: m s
9+
8 put :: s -> m ()
10 put :: s -> m ()
9
11
10-- | 'MonadParsec'
12-- | 'MonadParsec'
@@ -13,8 +15,8 @@ class
13 MonadPlus m -- Potential for failure
15 MonadPlus m -- Potential for failure
14 ) =>
16 ) =>
15 MonadParsec e s m
17 MonadParsec e s m
16− | m -> e s
17− where
18+ | m -> e s where
19+
18 -- | 'getState' returns state
20 -- | 'getState' returns state
19 getState ::
21 getState ::
20 m s
22 m s
data/examples/declaration/class/functional-dependencies-out.hs+1−2
@@ -14,6 +14,5 @@ class
14 b c -> a d, -- Bar
14 b c -> a d, -- Bar
15 a c -> b d, -- Baz
15 a c -> b d, -- Baz
16 a c d -> b,
16 a c d -> b,
17− a b d -> a b c d
17+ a b d -> a b c d where
18− where
19 baz :: a -> b
18 baz :: a -> b
data/examples/declaration/class/multi-parameters2-out.hs+3−2
@@ -10,10 +10,11 @@ class
10 c -- Baz bar
10 c -- Baz bar
11 d -- Baz baz
11 d -- Baz baz
12 e -- Rest
12 e -- Rest
13− f
13+ f where
14− where
14+
15 barbaz ::
15 barbaz ::
16 a -> f
16 a -> f
17+
17 bazbar ::
18 bazbar ::
18 e ->
19 e ->
19 f
20 f
data/examples/declaration/class/newlines-after-where-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−class Num a where
2− (+) :: a -> a -> a
3−
4−class Num a where
5− (+) :: a -> a -> a
data/examples/declaration/class/newlines-after-where.hsdeleted−7
@@ -1,7 +0,0 @@
1−class Num a where
2− (+) :: a -> a -> a
3−
4−class Num a where
5−
6−
7− (+) :: a -> a -> a
data/examples/declaration/class/newlines-and-default-decls-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−class Foo a where
2− foo :: a
3− default foo :: ()
4− foo = ()
5− bar :: a
6− default bar :: ()
7− bar = ()
8−
9− qux :: a
10− default qux :: ()
11− qux = ()
data/examples/declaration/class/newlines-and-default-decls.hsdeleted−13
@@ -1,13 +0,0 @@
1−class Foo a where
2− foo :: a
3− default foo :: ()
4− foo = ()
5− bar :: a
6− default bar :: ()
7− bar = ()
8−
9− qux :: a
10−
11− default qux :: ()
12−
13− qux = ()
data/examples/declaration/class/newlines-and-haddocks-out.hsdeleted−23
@@ -1,23 +0,0 @@
1−class Foo a where
2− -- | Haddock
3− foo :: a
4−
5− -- | Another Haddock
6− bar :: a
7−
8− baz :: a
9− -- ^ Post-Haddock
10−
11− raz :: a
12− -- ^ Another Post-Haddock
13−
14− -- | One more Haddock
15− qux :: a
16−
17− -- Comment before a Haddock
18−
19− -- | And one more Haddock
20− xyz :: a
21−
22− -- | Haddock followed by a blank line
23− abc :: a
data/examples/declaration/class/newlines-and-haddocks.hsdeleted−19
@@ -1,19 +0,0 @@
1−class Foo a where
2− -- | Haddock
3− foo :: a
4− -- | Another Haddock
5− bar :: a
6− baz :: a
7− -- ^ Post-Haddock
8− raz :: a
9− -- ^ Another Post-Haddock
10−
11− -- | One more Haddock
12− qux :: a
13− -- Comment before a Haddock
14− -- | And one more Haddock
15− xyz :: a
16−
17− -- | Haddock followed by a blank line
18−
19− abc :: a
data/examples/declaration/class/newlines-between-methods-out.hsdeleted−17
@@ -1,17 +0,0 @@
1−class Num a where
2− (+) :: a -> a -> a
3− (-) :: a -> a -> a
4− (*) :: a -> a -> a
5−
6− -- Comment before definition
7− negate :: a -> a
8−
9− -- Comment after definition
10−
11− -- Separator
12−
13− abs :: a -> a
14− signum :: a -> a
15−
16− -- Comment between unrelated definitions
17− fromInteger :: Integer -> a
data/examples/declaration/class/newlines-between-methods.hsdeleted−15
@@ -1,15 +0,0 @@
1−class Num a where
2− (+) :: a -> a -> a
3− (-) :: a -> a -> a
4− (*) :: a -> a -> a
5−
6− -- Comment before definition
7− negate :: a -> a
8− -- Comment after definition
9−
10− -- Separator
11−
12− abs :: a -> a
13− signum :: a -> a
14− -- Comment between unrelated definitions
15− fromInteger :: Integer -> a
data/examples/declaration/class/single-parameters-out.hs+2
@@ -21,6 +21,8 @@ class Baz a where
21 a
21 a
22
22
23class BarBaz a where
23class BarBaz a where
24+
24 barbaz ::
25 barbaz ::
25 a -> b
26 a -> b
27+
26 bazbar :: b -> a
28 bazbar :: b -> a
data/examples/declaration/class/type-operators3-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE PolyKinds #-}
2−{-# LANGUAGE TypeFamilies #-}
3−{-# LANGUAGE TypeOperators #-}
4−{-# LANGUAGE NoStarIsType #-}
5−
6−class PNum x where
7− type (a :: x) * (b :: x)
8−
9−instance PNum Nat where
10− type a * b = ()
data/examples/declaration/class/type-operators3.hsdeleted−7
@@ -1,7 +0,0 @@
1−{-# LANGUAGE TypeFamilies, TypeOperators, NoStarIsType, PolyKinds #-}
2−
3−class PNum x where
4− type (a :: x) * (b :: x)
5−
6−instance PNum Nat where
7− type a * b = ()
data/examples/declaration/data/existential-multiline-out.hs−12
@@ -3,15 +3,3 @@
3data Foo
3data Foo
4 = forall a. MkFoo a (a -> Bool)
4 = forall a. MkFoo a (a -> Bool)
5 | forall a. Eq a => MkBar a
5 | forall a. Eq a => MkBar a
6−
7−data Bar
8− = forall x y.
9− Bar x y x y
10−
11−data Baz
12− = forall x y.
13− Baz
14− x
15− y
16− x
17− y
data/examples/declaration/data/existential-multiline.hs−7
@@ -3,10 +3,3 @@
3data Foo
3data Foo
4 = forall a. MkFoo a (a -> Bool)
4 = forall a. MkFoo a (a -> Bool)
5 | forall a. Eq a => MkBar a
5 | forall a. Eq a => MkBar a
6−
7−data Bar = forall x y.
8− Bar x y x y
9−
10−data Baz = forall x y.
11− Baz x y x
12− y
data/examples/declaration/data/existential-out.hs−2
@@ -1,5 +1,3 @@
1{-# LANGUAGE ExistentialQuantification #-}
1{-# LANGUAGE ExistentialQuantification #-}
2
2
3data Foo = forall a. MkFoo a (a -> Bool)
3data Foo = forall a. MkFoo a (a -> Bool)
4−
5−data Bar = forall a b. a + b => Bar a b
data/examples/declaration/data/existential.hs−2
@@ -1,5 +1,3 @@
1{-# LANGUAGE ExistentialQuantification #-}
1{-# LANGUAGE ExistentialQuantification #-}
2
2
3data Foo = forall a. MkFoo a (a -> Bool)
3data Foo = forall a. MkFoo a (a -> Bool)
4−
5−data Bar = forall a b. a + b => Bar a b
data/examples/declaration/data/field-layout/gadt-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−data Foo a b where
5− -- | Something
6− Foo :: Foo Int Int
7− -- | Something else
8− Bar ::
9− Foo
10− Char
11− Char
data/examples/declaration/data/field-layout/gadt.hsdeleted−10
@@ -1,10 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−
5−data Foo a b where
6− -- | Something
7− Foo :: Foo Int Int
8− -- | Something else
9− Bar :: Foo Char
10− Char
data/examples/declaration/data/field-layout/record-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−data Foo = Foo
5− { -- | Something
6− foo :: Foo Int Int,
7− -- | Something else
8− bar ::
9− Bar
10− Char
11− Char
12− }
data/examples/declaration/data/field-layout/record.hsdeleted−11
@@ -1,11 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−
5−data Foo = Foo
6− { foo :: Foo Int Int
7− -- ^ Something
8− , bar :: Bar Char
9− Char
10− -- ^ Something else
11− }
data/examples/declaration/data/field-layout/variants-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−data Foo
5− = -- | Something
6− Foo Int Int
7− | -- | Something else
8− Bar
9− Char
10− Char
data/examples/declaration/data/field-layout/variants.hsdeleted−10
@@ -1,10 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−
5−data Foo =
6− Foo Int Int
7− -- ^ Something
8− | Bar Char
9− Char
10− -- ^ Something else
data/examples/declaration/data/gadt/multiline-out.hs+1−1
@@ -8,7 +8,7 @@ data Foo a where
8 Foo ::
8 Foo ::
9 forall a b.
9 forall a b.
10 (Show a, Eq b) => -- foo
10 (Show a, Eq b) => -- foo
11− -- bar
11+ -- bar
12 a ->
12 a ->
13 b ->
13 b ->
14 Foo 'Int
14 Foo 'Int
data/examples/declaration/data/gadt/multiline-where-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−data
2− Foo
3− a
4− b
5− c
6− where
7− Foo :: a -> b -> c -> Foo a b c
data/examples/declaration/data/gadt/multiline-where.hsdeleted−6
@@ -1,6 +0,0 @@
1−data
2− Foo
3− a
4− b
5− c where
6− Foo :: a -> b -> c -> Foo a b c
data/examples/declaration/data/gadt/strictness-out.hs+1−2
@@ -1,3 +1,2 @@
1data Foo a where
1data Foo a where
2− Foo1 :: !Int -> {-# UNPACK #-} !Bool -> Foo Int
2+ Foo :: !Int -> {-# UNPACK #-} !Bool -> Foo Int
3− Foo2 :: {-# UNPACK #-} Maybe Int && Bool -> Foo Int
data/examples/declaration/data/gadt/strictness.hs+1−2
@@ -1,3 +1,2 @@
1data Foo a where
1data Foo a where
2− Foo1 :: !Int -> {-# UNPACK #-} !Bool -> Foo Int
2+ Foo :: !Int -> {-# UNPACK #-} !Bool -> Foo Int
3− Foo2 :: {-# UNPACK #-} Maybe Int && Bool -> Foo Int
data/examples/declaration/data/kind-annotations-out.hs−8
@@ -1,11 +1,3 @@
1data Something (n :: Nat) = Something
1data Something (n :: Nat) = Something
2
2
3data Format (k :: *) (k' :: *) (k'' :: *)
3data Format (k :: *) (k' :: *) (k'' :: *)
4−
5−type Parens1 = Proxy '(a :: A, b :: (B :: *))
6−
7−type Parens2 = Proxy '((a :: A), (b :: B))
8−
9−type family Foo a where
10− Foo '(a :: Int, b :: Bool) = Int
11− Foo '((a :: Int), (b :: Bool)) = Int
data/examples/declaration/data/kind-annotations.hs−7
@@ -1,10 +1,3 @@
1data Something (n :: Nat) = Something
1data Something (n :: Nat) = Something
2
2
3data Format (k :: *) (k' :: *) (k'' :: *)
3data Format (k :: *) (k' :: *) (k'' :: *)
4−
5−type Parens1 = Proxy '(a :: A, b :: (B :: *))
6−type Parens2 = Proxy '((a :: A), (b :: B))
7−
8−type family Foo a where
9− Foo '(a :: Int, b :: Bool) = Int
10− Foo '((a :: Int), (b :: Bool)) = Int
data/examples/declaration/data/multiline-arg-parens-out.hs+1−1
@@ -5,6 +5,6 @@ data Foo
5 = Foo
5 = Foo
6 Bar
6 Bar
7 (Set Baz) -- and here we go
7 (Set Baz) -- and here we go
8− -- and that's it
8+ -- and that's it
9 Text
9 Text
10 deriving (Eq)
10 deriving (Eq)
data/examples/declaration/data/operators-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−data ErrorMessage' s
2− = -- | Show the text as is.
3− Text s
4− | -- | Pretty print the type.
5− -- @ShowType :: k -> ErrorMessage@
6− forall t. ShowType t
7− | -- | Put two pieces of error message next
8− -- to each other.
9− ErrorMessage' s :<>: ErrorMessage' s
10− | -- | Stack two pieces of error message on top
11− -- of each other.
12− ErrorMessage' s :$$: ErrorMessage' s
data/examples/declaration/data/operators.hsdeleted−12
@@ -1,12 +0,0 @@
1−data ErrorMessage' s
2− = -- | Show the text as is.
3− Text s
4− | -- | Pretty print the type.
5− -- @ShowType :: k -> ErrorMessage@
6− forall t. ShowType t
7− | -- | Put two pieces of error message next
8− -- to each other.
9− ErrorMessage' s :<>: ErrorMessage' s
10− | -- | Stack two pieces of error message on top
11− -- of each other.
12− ErrorMessage' s :$$: ErrorMessage' s
data/examples/declaration/data/partly-documented-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−data Optimisation
2− = PETransform
3− | -- | partial eval and associated transforms
4− GeneralisedNatHack
5− deriving (Show, Eq, Generic)
data/examples/declaration/data/partly-documented.hsdeleted−2
@@ -1,2 +0,0 @@
1−data Optimisation = PETransform | GeneralisedNatHack -- ^ partial eval and associated transforms
2− deriving (Show, Eq, Generic)
data/examples/declaration/data/record-multi-const-out.hsdeleted−17
@@ -1,17 +0,0 @@
1−module Main where
2−
3−-- | Something.
4−data Foo
5− = Foo
6− { -- | X
7− fooX :: Int,
8− -- | Y
9− fooY :: Int
10− }
11− | Bar
12− { -- | X
13− barX :: Int,
14− -- | Y
15− barY :: Int
16− }
17− deriving (Eq, Show)
data/examples/declaration/data/record-multi-const.hsdeleted−13
@@ -1,13 +0,0 @@
1−module Main where
2−
3−-- | Something.
4−
5−data Foo = Foo
6− { fooX :: Int -- ^ X
7− , fooY :: Int -- ^ Y
8− } |
9− Bar
10− { barX :: Int -- ^ X
11− , barY :: Int -- ^ Y
12− }
13− deriving (Eq, Show)
data/examples/declaration/data/record-out.hs+20−19
@@ -1,23 +1,24 @@
1module Main where
1module Main where
2
2
3-- | Something.
3-- | Something.
4−data Foo = Foo
4+data Foo
5+ = Foo
5− { -- | X
6+ { -- | X
6− fooX :: Int,
7+ fooX :: Int,
7− -- | Y
8+ -- | Y
8− fooY :: Int,
9+ fooY :: Int,
9− -- | BarBaz
10+ -- | BarBaz
10− fooBar, fooBaz :: NonEmpty (Identity Bool),
11+ fooBar, fooBaz :: NonEmpty (Identity Bool),
11− -- | GagGog
12+ -- | GagGog
12− fooGag,
13+ fooGag,
13− fooGog ::
14+ fooGog ::
14− NonEmpty
15+ NonEmpty
15− ( Indentity
16+ ( Indentity
16− Bool
17+ Bool
17− ),
18+ ),
18− -- | Huh!
19+ -- | Huh!
19− fooFoo,
20+ fooFoo,
20− barBar ::
21+ barBar ::
21− Int
22+ Int
22− }
23+ }
23 deriving (Eq, Show)
24 deriving (Eq, Show)
data/examples/declaration/data/simple-broken-out.hs+2−1
@@ -1,7 +1,8 @@
1module Main where
1module Main where
2
2
3-- | Here we go.
3-- | Here we go.
4+data Foo
4−data Foo = Foo {unFoo :: Int}
5+ = Foo {unFoo :: Int}
5 deriving (Eq)
6 deriving (Eq)
6
7
7-- | And once again.
8-- | And once again.
data/examples/declaration/data/strictness-out.hs+1−3
@@ -1,6 +1,4 @@
1module Main where
1module Main where
2
2
3-- | Something.
3-- | Something.
4−data Foo
5− = Foo1 !Int {-# UNPACK #-} !Bool {-# NOUNPACK #-} !String
4+data Foo = Foo !Int {-# UNPACK #-} !Bool {-# NOUNPACK #-} !String
6− | Foo2 {a :: {-# UNPACK #-} Maybe Int && Bool}
data/examples/declaration/data/strictness.hs+1−3
@@ -2,6 +2,4 @@ module Main where
2
2
3-- | Something.
3-- | Something.
4
4
5−data Foo
6− = Foo1 !Int {-# UNPACK #-} !Bool {-# NOUNPACK #-} !String
5+data Foo = Foo !Int {-# UNPACK #-} !Bool {-# NOUNPACK #-} !String
7− | Foo2 { a :: {-# UNPACK #-} Maybe Int && Bool }
data/examples/declaration/data/unnamed-field-comment-0-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−data Foo
2− = -- | Bar
3− Bar
4− Field1
5− -- ^ Field 1
6− Field2
7− -- ^ Field 2
data/examples/declaration/data/unnamed-field-comment-0.hsdeleted−5
@@ -1,5 +0,0 @@
1−data Foo
2− = -- | Bar
3− Bar
4− Field1 -- ^ Field 1
5− Field2 -- ^ Field 2
data/examples/declaration/data/unnamed-field-comment-1-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−data X
2− = B
3− !Int
4− -- ^ y
5− C
data/examples/declaration/data/unnamed-field-comment-1.hsdeleted−4
@@ -1,4 +0,0 @@
1−data X
2− = B
3− !Int -- ^ y
4− C
data/examples/declaration/data/with-comment-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−data A
2− = B -- C
3− | -- D
4− E
data/examples/declaration/data/with-comment.hsdeleted−5
@@ -1,5 +0,0 @@
1−data A =
2− B -- C
3−
4− -- D
5− | E
data/examples/declaration/data/with-weird-haddock-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−data PlusLevel' t
2− = -- | @n + ℓ@.
3− Plus Integer (LevelAtom' t)
4− deriving (Show, Data)
data/examples/declaration/data/with-weird-haddock.hsdeleted−2
@@ -1,2 +0,0 @@
1−data PlusLevel' t = Plus Integer (LevelAtom' t) -- ^ @n + ℓ@.
2− deriving (Show, Data)
data/examples/declaration/foreign/foreign-export-out.hs+1−2
@@ -2,8 +2,7 @@ foreign export ccall foo :: Int -> IO Int
2
2
3-- | 'foreignTomFun' is a very important thing
3-- | 'foreignTomFun' is a very important thing
4foreign export ccall "tomography"
4foreign export ccall "tomography"
5− foreignTomFun ::
6− StablePtr Storage {- Storage is bad -} -> TomForegin
5+ foreignTomFun :: StablePtr Storage {- Storage is bad -} -> TomForegin
7
6
8foreign export {- We can't use capi here -} ccall "dynamic"
7foreign export {- We can't use capi here -} ccall "dynamic"
9 export_nullaryMeth :: (IO HRESULT) -> IO (Ptr ())
8 export_nullaryMeth :: (IO HRESULT) -> IO (Ptr ())
data/examples/declaration/instance/associated-data-out.hs+2
@@ -11,7 +11,9 @@ instance Foo Double where
11 Double
11 Double
12
12
13instance Foo [a] where
13instance Foo [a] where
14+
14 data Bar [a]
15 data Bar [a]
15 = ListBar [Bar a]
16 = ListBar [Bar a]
17+
16 data Baz [a]
18 data Baz [a]
17 = ListBaz
19 = ListBaz
data/examples/declaration/instance/associated-data.hs−1
@@ -13,7 +13,6 @@ instance Foo Double where
13
13
14instance Foo [a]
14instance Foo [a]
15 where
15 where
16−
17 data Bar [a] =
16 data Bar [a] =
18 ListBar [Bar a]
17 ListBar [Bar a]
19 data Baz [a] =
18 data Baz [a] =
data/examples/declaration/instance/associated-types-out.hs+1
@@ -3,6 +3,7 @@
3instance Foo Int where type Bar Int = Double
3instance Foo Int where type Bar Int = Double
4
4
5instance Foo Double where
5instance Foo Double where
6+
6 type
7 type
7 Bar
8 Bar
8 Double =
9 Double =
data/examples/declaration/instance/associated-types.hs−2
@@ -9,7 +9,5 @@ instance Foo Double
9 Double
9 Double
10 =
10 =
11 [Double]
11 [Double]
12−
13−
14 type instance Baz Double
12 type instance Baz Double
15 = [Double]
13 = [Double]
data/examples/declaration/instance/data-family-instances-gadt-out.hs+2−4
@@ -3,11 +3,9 @@
3
3
4data instance Bar Int a where
4data instance Bar Int a where
5 SameBar ::
5 SameBar ::
6− Bar
6+ Bar Int
7− Int
8 Int
7 Int
9 CloseBar :: Bar Int Double
8 CloseBar :: Bar Int Double
10 OtherBar ::
9 OtherBar ::
11− Bar
10+ Bar Int
12− Int
13 a
11 a
data/examples/declaration/instance/data-family-instances-newtype-out.hs+4−3
@@ -1,6 +1,7 @@
1{-# LANGUAGE GADTSyntax #-}
1{-# LANGUAGE GADTSyntax #-}
2{-# LANGUAGE TypeFamilies #-}
2{-# LANGUAGE TypeFamilies #-}
3
3
4−newtype instance Foo [Double] = DoubleListFoo
4+newtype instance Foo [Double]
5+ = DoubleListFoo
5− { unDoubleListFoo :: Double
6+ { unDoubleListFoo :: Double
6− }
7+ }
data/examples/declaration/instance/instance-sigs-multiple-out.hs+2
@@ -1,10 +1,12 @@
1{-# LANGUAGE InstanceSigs #-}
1{-# LANGUAGE InstanceSigs #-}
2
2
3instance Applicative [] where
3instance Applicative [] where
4+
4 pure ::
5 pure ::
5 a ->
6 a ->
6 [a]
7 [a]
7 pure a = [a]
8 pure a = [a]
9+
8 (<*>) ::
10 (<*>) ::
9 [a] -> [a] -> [a]
11 [a] -> [a] -> [a]
10 (<*>) _ _ = []
12 (<*>) _ _ = []
data/examples/declaration/instance/multi-parameter-out.hs+2
@@ -1,5 +1,7 @@
1instance MonadReader a ((->) a) where ask = id
1instance MonadReader a ((->) a) where ask = id
2
2
3instance MonadState s (State s) where
3instance MonadState s (State s) where
4+
4 get = State.get
5 get = State.get
6+
5 put = State.put
7 put = State.put
data/examples/declaration/instance/newlines-after-where-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−instance Num X where
2− (+) = undefined
3−
4−instance Num Y where
5− (+) = undefined
data/examples/declaration/instance/newlines-after-where.hsdeleted−7
@@ -1,7 +0,0 @@
1−instance Num X where
2− (+) = undefined
3−
4−instance Num Y where
5−
6−
7− (+) = undefined
data/examples/declaration/instance/newlines-between-methods-out.hsdeleted−18
@@ -1,18 +0,0 @@
1−instance Num a => Num (Diff a) where
2− D u dudx + D v dvdx = D (u + v) (dudx + dvdx)
3− D u dudx - D v dvdx = D (u - v) (dudx - dvdx)
4− D u dudx * D v dvdx = D (u * v) (u * dvdx + v * dudx)
5−
6− -- Comment before definition
7− negate (D u dudx) = D (- u) (- dudx)
8− negate (Z u dudx) = undefined
9−
10− -- Comment after definition
11−
12− -- Separator
13−
14− abs (D u _) = D (abs u) (signum u)
15− signum (D u _) = D (signum u) 0
16−
17− -- Comment between unrelated definitions
18− fromInteger n = D (fromInteger n) 0
data/examples/declaration/instance/newlines-between-methods.hsdeleted−16
@@ -1,16 +0,0 @@
1−instance Num a => Num (Diff a) where
2− D u dudx + D v dvdx = D (u + v) (dudx + dvdx)
3− D u dudx - D v dvdx = D (u - v) (dudx - dvdx)
4− D u dudx * D v dvdx = D (u * v) (u * dvdx + v * dudx)
5−
6− -- Comment before definition
7− negate (D u dudx) = D (-u) (-dudx)
8− negate (Z u dudx) = undefined
9− -- Comment after definition
10−
11− -- Separator
12−
13− abs (D u _) = D (abs u) (signum u)
14− signum (D u _) = D (signum u) 0
15− -- Comment between unrelated definitions
16− fromInteger n = D (fromInteger n) 0
data/examples/declaration/instance/single-parameter-out.hs+2
@@ -1,7 +1,9 @@
1instance Monoid Int where (<>) x y = x + y
1instance Monoid Int where (<>) x y = x + y
2
2
3instance Enum Int where
3instance Enum Int where
4+
4 fromEnum x = x
5 fromEnum x = x
6+
5 toEnum =
7 toEnum =
6 \x ->
8 \x ->
7 x
9 x
data/examples/declaration/rewrite-rule/basic1-out.hs+1−2
@@ -10,8 +10,7 @@
10
10
11{-# RULES
11{-# RULES
12"map/map"
12"map/map"
13− map
13+ map f
14− f
15 (map g xs) =
14 (map g xs) =
16 map
15 map
17 (f . g)
16 (f . g)
data/examples/declaration/rewrite-rule/forall-1-out.hsdeleted−23
@@ -1,23 +0,0 @@
1−{-# RULES "rd_tyvs" forall a. forall (x :: a). id x = x #-}
2−
3−{-# RULES "rd_tyvs'" forall f a. forall (x :: f a). id x = x #-}
4−
5−{-# RULES "rd_tyvs''" forall (a :: *). forall (x :: a). id x = x #-}
6−
7−{-# RULES
8−"rd_tyvs_multiline1" forall (a :: *). forall (x :: a).
9− id x =
10− x
11− #-}
12−
13−{-# RULES
14−"rd_tyvs_multiline2" forall
15− ( a ::
16− *
17− ). forall
18− ( x ::
19− a
20− ).
21− id x =
22− x
23− #-}
data/examples/declaration/rewrite-rule/forall-1.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# RULES "rd_tyvs" forall a. forall (x :: a). id x = x #-}
2−
3−{-# RULES "rd_tyvs'" forall f a. forall (x :: f a). id x = x #-}
4−
5−{-# RULES "rd_tyvs''" forall (a :: *). forall (x :: a). id x = x #-}
6−
7−{-# RULES "rd_tyvs_multiline1"
8− forall (a :: *).
9− forall (x :: a).
10− id x = x #-}
11−
12−{-# RULES "rd_tyvs_multiline2"
13− forall (a ::
14− *).
15− forall (x ::
16− a).
17− id x = x #-}
data/examples/declaration/rewrite-rule/forall-0-out.hs → data/examples/declaration/rewrite-rule/forall-out.hsrenamed

The content is the same.

data/examples/declaration/rewrite-rule/forall-0.hs → data/examples/declaration/rewrite-rule/forall.hsrenamed

The content is the same.

data/examples/declaration/rewrite-rule/phase-out.hs+2−4
@@ -1,7 +1,6 @@
1{-# RULES
1{-# RULES
2"map/map" [2]
2"map/map" [2]
3− map
3+ map f
4− f
5 (map g xs) =
4 (map g xs) =
6 map
5 map
7 (f . g)
6 (f . g)
@@ -10,8 +9,7 @@
10
9
11{-# RULES
10{-# RULES
12"map/map" [1] forall x y z.
11"map/map" [1] forall x y z.
13− map
12+ map f
14− f
15 (map g xs) =
13 (map g xs) =
16 map
14 map
17 (f . g)
15 (f . g)
data/examples/declaration/signature/minimal/minimal-out.hs+2
@@ -1,4 +1,5 @@
1class Foo a where
1class Foo a where
2+
2 {-# MINIMAL (==) | ((/=), foo) #-}
3 {-# MINIMAL (==) | ((/=), foo) #-}
3
4
4 {-# MINIMAL
5 {-# MINIMAL
@@ -11,4 +12,5 @@ class Foo a where
11 #-}
12 #-}
12
13
13 (==) :: a -> a -> Bool
14 (==) :: a -> a -> Bool
15+
14 (/=) :: a -> a -> Bool
16 (/=) :: a -> a -> Bool
data/examples/declaration/signature/specialize/specialize-instance-out.hs+4
@@ -3,12 +3,16 @@ data Foo a = Foo a
3data VT v m r = VT v m r
3data VT v m r = VT v m r
4
4
5instance (Eq a) => Eq (Foo a) where
5instance (Eq a) => Eq (Foo a) where
6+
6 {-# SPECIALIZE instance Eq (Foo [(Int, Bar)]) #-}
7 {-# SPECIALIZE instance Eq (Foo [(Int, Bar)]) #-}
8+
7 (==) (Foo a) (Foo b) = (==) a b
9 (==) (Foo a) (Foo b) = (==) a b
8
10
9instance (Num r, V.Vector v r, Factored m r) => Num (VT v m r) where
11instance (Num r, V.Vector v r, Factored m r) => Num (VT v m r) where
12+
10 {-# SPECIALIZE instance
13 {-# SPECIALIZE instance
11 ( Factored m Int => Num (VT U.Vector m Int)
14 ( Factored m Int => Num (VT U.Vector m Int)
12 )
15 )
13 #-}
16 #-}
17+
14 VT x + VT y = VT $ V.zipWith (+) x y
18 VT x + VT y = VT $ V.zipWith (+) x y
data/examples/declaration/signature/standalone-kind-out.hsdeleted−13
@@ -1,13 +0,0 @@
1−{-# LANGUAGE StandaloneKindSignatures #-}
2−
3−type T ::
4− (k -> Type) ->
5− k ->
6− Type
7−data T m a = MkT (m a) (T Maybe (m a))
8−
9−type C1 :: Type -> Constraint
10−class C1 a
11−
12−type F :: Type -> Type
13−type family F
data/examples/declaration/signature/standalone-kind.hsdeleted−13
@@ -1,13 +0,0 @@
1−{-# LANGUAGE StandaloneKindSignatures #-}
2−
3−type T :: (k -> Type)
4− -> k
5− -> Type
6−
7−data T m a = MkT (m a) (T Maybe (m a))
8−
9−type C1 :: Type -> Constraint
10−class C1 a
11−
12−type F :: Type -> Type
13−type family F
data/examples/declaration/signature/type/infix-promoted-type-constructor-out.hs+1
@@ -1,2 +1,3 @@
1fun1 :: Def ('[Ref s (Stored Uint32), IBool] 'T.:-> IBool)
1fun1 :: Def ('[Ref s (Stored Uint32), IBool] 'T.:-> IBool)
2+
2fun2 :: Def ('[Ref s (Stored Uint32), IBool] ':-> IBool)
3fun2 :: Def ('[Ref s (Stored Uint32), IBool] ':-> IBool)
data/examples/declaration/signature/type/long-multiline-applications-out.hs−1
@@ -1,6 +1,5 @@
1functionName ::
1functionName ::
2 (C1, C2, C3, C4, C5) =>
2 (C1, C2, C3, C4, C5) =>
3− forall a b c.
4 a ->
3 a ->
5 b ->
4 b ->
6 ( LongDataTypeName
5 ( LongDataTypeName
data/examples/declaration/signature/type/long-multiline-applications.hs+1−2
@@ -1,7 +1,6 @@
1functionName
1functionName
2 :: (C1, C2, C3, C4, C5)
2 :: (C1, C2, C3, C4, C5)
3− => forall a b c
4− . a
3+ => a
5 -> b
4 -> b
6 -> ( LongDataTypeName
5 -> ( LongDataTypeName
7 AnotherLongDataTypeName
6 AnotherLongDataTypeName
data/examples/declaration/signature/type/multi-value-out.hs−5
@@ -2,11 +2,6 @@ foo, bar :: Int
2foo = 1
2foo = 1
3bar = 2
3bar = 2
4
4
5−a, b, c :: Int
6−a = 1
7−b = 2
8−c = 3
9−
10foo,
5foo,
11 bar,
6 bar,
12 baz ::
7 baz ::
data/examples/declaration/signature/type/multi-value.hs−5
@@ -2,11 +2,6 @@ foo, bar :: Int
2foo = 1
2foo = 1
3bar = 2
3bar = 2
4
4
5−a, b, c :: Int
6−a = 1
7−b = 2
8−c = 3
9−
10foo,
5foo,
11 bar,
6 bar,
12 baz :: Int
7 baz :: Int
data/examples/declaration/signature/type/unrelated-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−clientFunc1 :: SomeType1
2−clientFunc2 :: SomeType2
3−clientFunc3 :: SomeType3
4−clientFunc1 :<|> clientFunc2 :<|> clientFunc3 = hoistClient foo bar baz
data/examples/declaration/signature/type/unrelated.hsdeleted−4
@@ -1,4 +0,0 @@
1−clientFunc1 :: SomeType1
2−clientFunc2 :: SomeType2
3−clientFunc3 :: SomeType3
4−clientFunc1 :<|> clientFunc2 :<|> clientFunc3 = hoistClient foo bar baz
data/examples/declaration/splice/grouped-splices-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−$(deriveJSON fieldLabelMod ''A)
2−$(deriveJSON fieldLabelMod ''B)
3−$(deriveJSON fieldLabelMod ''C)
data/examples/declaration/splice/grouped-splices.hsdeleted−3
@@ -1,3 +0,0 @@
1−$(deriveJSON fieldLabelMod ''A)
2−$(deriveJSON fieldLabelMod ''B)
3−$(deriveJSON fieldLabelMod ''C)
data/examples/declaration/splice/splice-decl.hs+1
@@ -15,3 +15,4 @@ foo bar
15-- TemplateHaskell allows Q () at the top level
15-- TemplateHaskell allows Q () at the top level
16do
16do
17 pure []
17 pure []
18+
data/examples/declaration/type-families/closed-type-family/multi-line-out.hs+5−6
@@ -1,7 +1,7 @@
1type family
1type family
2 Id a =
2 Id a =
3− result | result -> a
3+ result
4− where
4+ | result -> a where
5 Id a =
5 Id a =
6 a
6 a
7
7
@@ -10,15 +10,14 @@ type family
10 (a :: k)
10 (a :: k)
11 b
11 b
12 c =
12 c =
13− foo | foo -> k b
13+ foo
14− where
14+ | foo -> k b where
15 G a b c =
15 G a b c =
16 (a, b)
16 (a, b)
17
17
18type family
18type family
19 F a ::
19 F a ::
20− * -> *
21− where
20+ * -> * where
22 F Int = Double
21 F Int = Double
23 F Bool =
22 F Bool =
24 Char
23 Char
data/examples/declaration/type-families/closed-type-family/with-equal-sign-out.hsdeleted−2
@@ -1,2 +0,0 @@
1−type family TF a b = result where
2− TF a b = Int
data/examples/declaration/type-families/closed-type-family/with-equal-sign.hsdeleted−2
@@ -1,2 +0,0 @@
1−type family TF a b = result where
2− TF a b = Int
data/examples/declaration/type-families/closed-type-family/with-forall-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−type family G a b where
2− forall x y. G [x] (Proxy y) = Double
3− forall z. z `G` z = Bool
data/examples/declaration/type-families/closed-type-family/with-forall.hsdeleted−3
@@ -1,3 +0,0 @@
1−type family G a b where
2− forall x y. G [x] (Proxy y) = Double
3− forall z. z `G` z = Bool
data/examples/declaration/type-families/type-family/operator-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−type family a ! b
2−
3−type family a . b
data/examples/declaration/type-families/type-family/operator.hsdeleted−2
@@ -1,2 +0,0 @@
1−type family a ! b
2−type family a . b
data/examples/declaration/type-synonyms/with-weird-haddock-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−type Elims =
2− -- | eliminations ordered left-to-right.
3− [Elim]
data/examples/declaration/type-synonyms/with-weird-haddock.hsdeleted−1
@@ -1 +0,0 @@
1−type Elims = [Elim] -- ^ eliminations ordered left-to-right.
data/examples/declaration/type/type-applications-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−{-# LANGUAGE TypeApplications #-}
2−
3−type P = K @Bool @(Bool :: *) 'True 'False
data/examples/declaration/type/type-applications.hsdeleted−3
@@ -1,3 +0,0 @@
1−{-# LANGUAGE TypeApplications #-}
2−
3−type P = K @Bool @(Bool :: *) 'True 'False
data/examples/declaration/type/visible-forall-out.hsdeleted−2
@@ -1,2 +0,0 @@
1−-- source: https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0081-forall-arrow.rst
2−data T :: forall k -> k -> Type
data/examples/declaration/type/visible-forall.hsdeleted−2
@@ -1,2 +0,0 @@
1−-- source: https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0081-forall-arrow.rst
2−data T :: forall k -> k -> Type
data/examples/declaration/value/function/application-0-out.hsdeleted−17
@@ -1,17 +0,0 @@
1−foo =
2− f1
3− p1
4− p2
5− p3
6−
7−foo' =
8− f2
9− p1
10− p2
11− p3
12−
13−foo'' =
14− f3
15− p1
16− p2
17− p3
data/examples/declaration/value/function/application-0.hsdeleted−12
@@ -1,12 +0,0 @@
1−foo =
2− f1
3− p1
4− p2 p3
5−
6−foo' = f2 p1
7− p2
8− p3
9−
10−foo'' =
11− f3 p1 p2
12− p3
data/examples/declaration/value/function/application-1-out.hsdeleted−19
@@ -1,19 +0,0 @@
1−main =
2− do
3− x
4− y
5− z
6−
7−main =
8− case foo of
9− x -> a
10− foo
11− a
12− b
13−
14−main =
15− do
16− if x then y else z
17− foo
18− a
19− b
data/examples/declaration/value/function/application-1.hsdeleted−14
@@ -1,14 +0,0 @@
1−main =
2− do
3− x
4− y
5− z
6−
7−main =
8− case foo of
9− x -> a
10− foo a b
11−
12−main = do
13− if x then y else z
14− foo a b
data/examples/declaration/value/function/arg-breakpoints-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo
2− bar =
3− body
data/examples/declaration/value/function/arg-breakpoints.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo
2− bar =
3− body
data/examples/declaration/value/function/arrow/expression-applications-out.hsnew file+9
@@ -0,0 +1,9 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo x y = x -< y
4+
5+bar f x =
6+ f x -< -- Hello
7+ x -- World
8+
9+baz x y = x -<< y
data/examples/declaration/value/function/arrow/expression-applications.hsnew file+9
@@ -0,0 +1,9 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo x y = x -< y
4+
5+bar f x
6+ = f x -- Hello
7+ -< x -- World
8+
9+baz x y = x -<< y
data/examples/declaration/value/function/arrow/expression-forms-out.hsnew file+14
@@ -0,0 +1,14 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo f g x y = (| test (f -< x) (g -< y) |)
4+
5+bar f g x y =
6+ (|
7+ test
8+ ( f -<
9+ x
10+ )
11+ ( g -<
12+ y
13+ )
14+ |)
data/examples/declaration/value/function/arrow/expression-forms.hsnew file+11
@@ -0,0 +1,11 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo f g x y = (| test (f -< x) (g -< y) |)
4+
5+bar f g x y = (|
6+ test
7+ (f
8+ -< x)
9+ (g
10+ -< y)
11+ |)
data/examples/declaration/value/function/arrow/multiline-case-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−f = proc x -> do
4− x <-
5− case x of X -> x
6− -<
7− y
8− a -< b
data/examples/declaration/value/function/arrow/multiline-case.hsdeleted−7
@@ -1,7 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−f = proc x -> do
4− x
5− <- case x of X -> x
6− -< y
7− a -< b
data/examples/declaration/value/function/arrow/proc-applications-out.hs+5−6
@@ -9,11 +9,10 @@ bar f x =
9 w
9 w
10 )
10 )
11 ->
11 ->
12− f -- The value
12+ f -< -- The value
13− -<
14− ( x, -- Foo
13+ ( x, -- Foo
15− w, -- Bar
14+ w, -- Bar
16− z -- Baz
15+ z -- Baz
17− )
16+ )
18
17
19baz x = proc a -> a -<< x
18baz x = proc a -> a -<< x
data/examples/declaration/value/function/arrow/proc-do-complex-out.hs+25−25
@@ -19,13 +19,13 @@ foo
19 )
19 )
20 ( b,
20 ( b,
21 d
21 d
22+ ) -<
23+ ( b + 1, -- Funnel into arrow
24+ d * b
22 )
25 )
23− -<
24− ( b + 1, -- Funnel into arrow
25− d * b
26− )
27 if x `mod` y == 0 -- Basic condition
26 if x `mod` y == 0 -- Basic condition
27+ then
28− then case e of -- Only left case is relevant
28+ case e of -- Only left case is relevant
29 Left
29 Left
30 ( z,
30 ( z,
31 w
31 w
@@ -33,30 +33,30 @@ foo
33 let v =
33 let v =
34 u -- Actually never used
34 u -- Actually never used
35 ^ 2
35 ^ 2
36+
36− in ( returnA
37+ in ( returnA -<
37− -<
38− -- Just do the calculation
38+ -- Just do the calculation
39− (x + y * z)
39+ (x + y * z)
40 )
40 )
41− else do
41+ else
42+ do
42 let u = x -- Let bindings bind expressions, not commands
43 let u = x -- Let bindings bind expressions, not commands
43− -- Could pattern match directly on x
44+ -- Could pattern match directly on x
45+ i <-
44− i <- case u of
46+ case u of
45− 0 -> (g . h -< u)
47+ 0 -> (g . h -< u)
46− n ->
48+ n ->
47− ( ( h . g
49+ ( ( h . g -<
48− -<
49 y -- First actual use of y
50 y -- First actual use of y
51+ )
50 )
52 )
51− )
52 returnA -< ()
53 returnA -< ()
53 -- Sometimes execute effects
54 -- Sometimes execute effects
54 if i > 0
55 if i > 0
55− then ma -< ()
56+ then ma -< ()
56− else returnA -< ()
57+ else returnA -< ()
57− returnA
58+ returnA -<
58− -<
59− ( i
59+ ( i
60− + x
60+ + x
61− * y -- Just do the calculation
61+ * y -- Just do the calculation
62− )
62+ )
data/examples/declaration/value/function/arrow/proc-do-simple1-out.hs+2−3
@@ -13,6 +13,5 @@ barbaz f g = proc (a, b) -> do
13
13
14bazbar f = proc a -> do
14bazbar f = proc a -> do
15 a <-
15 a <-
16− f
16+ f -<
17− -<
18− a
17+ a
data/examples/declaration/value/function/arrow/proc-do-simple2-out.hs+7−9
@@ -11,12 +11,10 @@ bazbaz f g h = proc (a, b, c) -> do
11 z <-
11 z <-
12 h
12 h
13 x
13 x
14− y
14+ y -<
15− -<
16− ( a,
15+ ( a,
17− b,
16+ b,
18− c
17+ c
19− )
18+ )
20− returnA
19+ returnA -<
21− -<
22− (x, y, z)
20+ (x, y, z)
data/examples/declaration/value/function/arrow/proc-forms1-out.hs+6−8
@@ -7,15 +7,13 @@ foo1 f g h x =
7 (|
7 (|
8 test
8 test
9 ( h f
9 ( h f
10− . h g
10+ . h g -<
11− -<
12− y x
11+ y x
13− . y z
12+ . y z
14 )
13 )
15 ( h g
14 ( h g
16− . h f
15+ . h f -<
17− -<
18− y z
16+ y z
19− . y x
17+ . y x
20 )
18 )
21 |)
19 |)
data/examples/declaration/value/function/arrow/proc-forms2-out.hs+6−10
@@ -4,19 +4,15 @@ bar0 f g h x =
4 proc (y, z) ->
4 proc (y, z) ->
5 (| test (h f . (h g) -< (y x) . y z) ((h g) . h f -< y z . (y x)) |)
5 (| test (h f . (h g) -< (y x) . y z) ((h g) . h f -< y z . (y x)) |)
6
6
7−bar1 f g x y = proc _ -> (f -< x) &&& (g -< y)
7+bar1 f g x y = proc _ -> f -< x &&& g -< y
8
8
9bar2 f g h x =
9bar2 f g h x =
10 proc (y, z) ->
10 proc (y, z) ->
11− (h f . (h g) -< (y x) . y z) ||| ((h g) . h f -< y z . (y x))
11+ h f . (h g) -< (y x) . y z ||| (h g) . h f -< y z . (y x)
12
12
13bar3 f g h x =
13bar3 f g h x =
14 proc (y, z) ->
14 proc (y, z) ->
15− ( (h f . h g)
15+ (h f . h g) -<
16− -<
17− (y x) . y z
16+ (y x) . y z
18− ) |||
19− ( (h g . h f)
17+ ||| (h g . h f) -<
20− -<
21− y z . (y x)
18+ y z . (y x)
22− )
data/examples/declaration/value/function/arrow/proc-forms2.hs+6−6
@@ -4,16 +4,16 @@ bar0 f g h x =
4 proc (y, z) ->
4 proc (y, z) ->
5 (| test (h f.(h g) -< (y x).y z)((h g) . h f-<y z . (y x)) |)
5 (| test (h f.(h g) -< (y x).y z)((h g) . h f-<y z . (y x)) |)
6
6
7−bar1 f g x y = proc _ -> (f -< x)&&&(g -< y)
7+bar1 f g x y = proc _ -> f -< x&&&g -< y
8
8
9bar2 f g h x =
9bar2 f g h x =
10 proc (y, z) ->
10 proc (y, z) ->
11− (h f.(h g) -< (y x).y z) ||| ((h g) . h f-<y z . (y x))
11+ h f.(h g) -< (y x).y z ||| (h g) . h f-<y z . (y x)
12
12
13bar3 f g h x =
13bar3 f g h x =
14 proc (y, z) ->
14 proc (y, z) ->
15− ((h f.h g)
15+ (h f.h g)
16− -< (y x).y z)
16+ -< (y x).y z
17 |||
17 |||
18− ((h g . h f)
18+ (h g . h f)
19− -<y z . (y x))
19+ -<y z . (y x)
data/examples/declaration/value/function/arrow/proc-ifs-out.hs+7−9
@@ -4,12 +4,10 @@ foo f = proc a -> if a then f -< 0 else f -< 1
4
4
5bar f g = proc a ->
5bar f g = proc a ->
6 if f a
6 if f a
7− then
7+ then
8− f
8+ f
9− . g
9+ . g -<
10− -<
11− a
10+ a
12− else
11+ else
13− g
12+ g -<
14− -<
15− b
13+ b
data/examples/declaration/value/function/arrow/proc-lets-out.hs+1
@@ -9,4 +9,5 @@ bar f g = proc a ->
9 j =
9 j =
10 g
10 g
11 . h
11 . h
12+
12 in id -< (h, j)
13 in id -< (h, j)
data/examples/declaration/value/function/arrow/proc-parentheses-out.hs+4−5
@@ -6,14 +6,13 @@ bar f g = proc a ->
6 ( ( (f)
6 ( ( (f)
7 ( g
7 ( g
8 )
8 )
9− )
9+ ) -<
10− -<
11− ( ( ( ( ( ( g
10+ ( ( ( ( ( ( g
12− a
11+ a
13− )
14 )
12 )
15 )
13 )
16 )
14 )
17 )
15 )
18 )
16 )
17+ )
19 )
18 )
data/examples/declaration/value/function/arrow/recursive-procs-out.hs+10−14
@@ -3,21 +3,17 @@
3foo f g = proc (x, y) -> do
3foo f g = proc (x, y) -> do
4 rec a <- f y -< x
4 rec a <- f y -< x
5 b <-
5 b <-
6− g x
6+ g x -<
7− -<
8− y
7+ y
9− bar
8+ bar -<
10− -<
11− ( a,
9+ ( a,
12− b
10+ b
13− )
11+ )
14 rec p <-
12 rec p <-
15 f
13 f
16− p
14+ p -<
17− -<
18− a
15+ a
19 rec q <-
16 rec q <-
20 g
17 g
21− q
18+ q -<
22− -<
23− b
19+ b
data/examples/declaration/value/function/awkward-comment-0-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−mergeErrorReply :: ParseError -> Reply s u a -> Reply s u a
2−mergeErrorReply err1 reply -- XXX where to put it?
3− =
4− case reply of
5− Ok x state err2 -> Ok x state (mergeError err1 err2)
6− Error err2 -> Error (mergeError err1 err2)
data/examples/declaration/value/function/awkward-comment-0.hsdeleted−5
@@ -1,5 +0,0 @@
1−mergeErrorReply :: ParseError -> Reply s u a -> Reply s u a
2−mergeErrorReply err1 reply -- XXX where to put it?
3− = case reply of
4− Ok x state err2 -> Ok x state (mergeError err1 err2)
5− Error err2 -> Error (mergeError err1 err2)
data/examples/declaration/value/function/awkward-comment-1-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−doForeign :: Vars -> [Name] -> [Term] -> Idris LExp
2−doForeign x = x
3− where
4− splitArg tm | (_, [_, _, l, r]) <- unApply tm -- pair, two implicits
5− =
6− do
7− let l' = toFDesc l
8− r' <- irTerm (sMN 0 "__foreignCall") vs env r
9− return (l', r')
data/examples/declaration/value/function/awkward-comment-1.hsdeleted−7
@@ -1,7 +0,0 @@
1−doForeign :: Vars -> [Name] -> [Term] -> Idris LExp
2−doForeign x = x
3− where
4− splitArg tm | (_, [_,_,l,r]) <- unApply tm -- pair, two implicits
5− = do let l' = toFDesc l
6− r' <- irTerm (sMN 0 "__foreignCall") vs env r
7− return (l', r')
data/examples/declaration/value/function/blank-lines-let-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−foo =
2− let x = 10
3−
4− y = 11
5− z = 12
6− in x + y + z
data/examples/declaration/value/function/blank-lines-let.hsdeleted−9
@@ -1,9 +0,0 @@
1−foo =
2− let
3−
4− x = 10
5−
6− y = 11
7− z = 12
8−
9− in x + y + z
data/examples/declaration/value/function/blank-lines-where-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−foo = x + y + z
2− where
3− x = 10
4−
5− y = 11
6− z = 12
data/examples/declaration/value/function/blank-lines-where.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo = x + y + z
2− where
3−
4− x = 10
5−
6− y = 11
7− z = 12
data/examples/declaration/value/function/block-arguments-out.hs−7
@@ -25,10 +25,3 @@ f7 = foo \x -> y
25
25
26f8 = foo \x ->
26f8 = foo \x ->
27 y
27 y
28−
29−f9 = foo do { bar } baz
30−
31−f10 = foo
32− do a
33− do b
34− do c
data/examples/declaration/value/function/block-arguments.hs−7
@@ -21,10 +21,3 @@ f7 = foo \x -> y
21
21
22f8 = foo \x ->
22f8 = foo \x ->
23 y
23 y
24−
25−f9 = foo do { bar } baz
26−
27−f10 = foo
28− do { a }
29− do { b }
30− do c
data/examples/declaration/value/function/do/blocks-out.hs−1
@@ -15,5 +15,4 @@ readInClause = do
15 <|> do
15 <|> do
16 optional g_Semi
16 optional g_Semi
17 void allspacing
17 void allspacing
18−
19 return things
18 return things
data/examples/declaration/value/function/do/comment-alignment-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−main = do
2− case blah of
3− Nothing -> return ()
4− Just xs -> do
5− forM_ xs foo
6− bar
7− -- and here it goes
8− unless bobla $
9− quux
data/examples/declaration/value/function/do/comment-alignment.hsdeleted−9
@@ -1,9 +0,0 @@
1−main = do
2− case blah of
3− Nothing -> return ()
4− Just xs -> do
5− forM_ xs foo
6− bar
7− -- and here it goes
8− unless bobla $
9− quux
data/examples/declaration/value/function/do/comment-spacing-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo = do
2− bar
3− -- foo
4− baz
5−
6− -- foo
7− quux
data/examples/declaration/value/function/do/comment-spacing.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo = do
2− bar
3− -- foo
4− baz
5−
6− -- foo
7− quux
data/examples/declaration/value/function/do/expr.hs+1
@@ -8,3 +8,4 @@ quux = something $ do
8 then x
8 then x
9 else y
9 else y
10 baz
10 baz
11+
data/examples/declaration/value/function/do/hang-rhs-arrow-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−foo = do
2− something <- case bar of
3− Foo -> return 1
4− Bar -> return 2
5− somethingElse <-
6− case boom of
7− Foo -> return 1
8− Bar -> return 2
9− quux something somethingElse
data/examples/declaration/value/function/do/hang-rhs-arrow.hsdeleted−9
@@ -1,9 +0,0 @@
1−foo = do
2− something <- case bar of
3− Foo -> return 1
4− Bar -> return 2
5− somethingElse <-
6− case boom of
7− Foo -> return 1
8− Bar -> return 2
9− quux something somethingElse
data/examples/declaration/value/function/do/recursive-do-rec-out.hs−5
@@ -2,18 +2,13 @@
2
2
3foo = do
3foo = do
4 rec a <- b + 5
4 rec a <- b + 5
5−
6 let d = c
5 let d = c
7−
8 b <- a * 5
6 b <- a * 5
9−
10 something
7 something
11−
12 c <- a + b
8 c <- a + b
13 print c
9 print c
14 rec something $ do
10 rec something $ do
15 x <- a
11 x <- a
16 print x
12 print x
17−
18 y <- c
13 y <- c
19 print y
14 print y
data/examples/declaration/value/function/if-with-comment-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo =
2− if undefined
3− then -- then comment
4− undefined
5− else -- else comment
6−
7− do
8− undefined
data/examples/declaration/value/function/if-with-comment.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo =
2− if undefined
3− -- then comment
4− then undefined
5− -- else comment
6− else
7− do
8− undefined
data/examples/declaration/value/function/implicit-params-out.hs−1
@@ -1,7 +1,6 @@
1{-# LANGUAGE ImplicitParams #-}
1{-# LANGUAGE ImplicitParams #-}
2
2
3sortBy :: (a -> a -> Bool) -> [a] -> [a]
3sortBy :: (a -> a -> Bool) -> [a] -> [a]
4−sortBy = undefined
5
4
6sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
5sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
7sort = sortBy ?cmp
6sort = sortBy ?cmp
data/examples/declaration/value/function/implicit-params.hs−2
@@ -1,8 +1,6 @@
1{-# LANGUAGE ImplicitParams #-}
1{-# LANGUAGE ImplicitParams #-}
2sortBy :: (a -> a -> Bool) -> [a] -> [a]
2sortBy :: (a -> a -> Bool) -> [a] -> [a]
3
3
4−sortBy = undefined
5−
6sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
4sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
7sort = sortBy ?cmp
5sort = sortBy ?cmp
8
6
data/examples/declaration/value/function/infix/dollar-chains-out.hs+3−7
@@ -13,10 +13,6 @@ foo =
13 throwIO (OrmoluCppEnabled path)
13 throwIO (OrmoluCppEnabled path)
14
14
15foo =
15foo =
16− bar $
16+ bar
17− baz $
17+ $ baz
18− quux
18+ $ quux
19−
20−x =
21− case l of { A -> B } $
22− case q of r -> s
data/examples/declaration/value/function/infix/dollar-chains.hs−4
@@ -16,7 +16,3 @@ foo =
16 bar
16 bar
17 $ baz
17 $ baz
18 $ quux
18 $ quux
19−
20−x =
21− case l of { A -> B } $
22− case q of r -> s
data/examples/declaration/value/function/infix/hanging-out.hs+6−7
@@ -4,9 +4,9 @@ f = unFoo . foo bar baz 3 $ do
4
4
5g = unFoo
5g = unFoo
6 . foo
6 . foo
7− bar
7+ bar
8− baz
8+ baz
9− 3
9+ 3
10 $ do
10 $ do
11 act
11 act
12 ret
12 ret
@@ -17,7 +17,6 @@ update =
17 `catch` \case
17 `catch` \case
18 a -> a
18 a -> a
19
19
20−foo =
20+foo = bar
21− bar
22− ++ case foo of
21+ ++ case foo of
23− a -> a
22+ a -> a
data/examples/declaration/value/function/infix/lenses-out.hs+7−8
@@ -1,12 +1,11 @@
1lenses =
1lenses =
2− Just $
3− M.fromList $
2+ Just $ M.fromList $
4− "type" .= ("user.connection" :: Text)
3+ "type" .= ("user.connection" :: Text)
5− # "connection" .= uc
4+ # "connection" .= uc
6− # "user" .= case name of
5+ # "user" .= case name of
7− Just n -> Just $ object ["name" .= n]
6+ Just n -> Just $ object ["name" .= n]
8− Nothing -> Nothing
7+ Nothing -> Nothing
9− # []
8+ # []
10
9
11foo =
10foo =
12 a
11 a
data/examples/declaration/value/function/let-single-line-out.hs+1
@@ -5,6 +5,7 @@ foo x = let x = z where { z = 2 }; a = 3 in x
5foo x = let g :: Int -> Int; g = id in ()
5foo x = let g :: Int -> Int; g = id in ()
6
6
7let a = b; c = do { foo; bar }; d = baz in b
7let a = b; c = do { foo; bar }; d = baz in b
8+
8let a = case True of { True -> foo; False -> bar }; b = foo a in b
9let a = case True of { True -> foo; False -> bar }; b = foo a in b
9
10
10foo x = let ?g = id; ?f = g in x
11foo x = let ?g = id; ?f = g in x
data/examples/declaration/value/function/list-notation-0-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−foo =
2− testCase "Foo" testFoo :
3− testCase "Bar" testBar :
4− testCase "Baz" testBaz :
5− []
data/examples/declaration/value/function/list-notation-0.hsdeleted−5
@@ -1,5 +0,0 @@
1−foo =
2− testCase "Foo" testFoo :
3− testCase "Bar" testBar :
4− testCase "Baz" testBaz :
5− []
data/examples/declaration/value/function/list-notation-1-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−instance A.ToJSON UpdateTable where
2− toJSON a =
3− A.object $
4− "TableName" .= updateTableName a :
5− "ProvisionedThroughput" .= updateProvisionedThroughput a :
6− case updateGlobalSecondaryIndexUpdates a of
7− [] -> []
8− l -> ["GlobalSecondaryIndexUpdates" .= l]
data/examples/declaration/value/function/list-notation-1.hsdeleted−7
@@ -1,7 +0,0 @@
1−instance A.ToJSON UpdateTable where
2− toJSON a = A.object
3− $ "TableName" .= updateTableName a
4− : "ProvisionedThroughput" .= updateProvisionedThroughput a
5− : case updateGlobalSecondaryIndexUpdates a of
6− [] -> []
7− l -> [ "GlobalSecondaryIndexUpdates" .= l ]
data/examples/declaration/value/function/list-notation-2-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−-- A list of the element and all its parents up to the root node.
2−getPath tree t =
3− t :
4− case Map.lookup (getId t) tree of
5− Nothing -> []
6− Just parent -> getPath tree parent
data/examples/declaration/value/function/list-notation-2.hsdeleted−5
@@ -1,5 +0,0 @@
1−-- A list of the element and all its parents up to the root node.
2−getPath tree t = t :
3− case Map.lookup (getId t) tree of
4− Nothing -> []
5− Just parent -> getPath tree parent
data/examples/declaration/value/function/list-notation-3-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−foo =
2− reportSDoc "tc.cc" 30 $
3− sep $ do
4− (prettyTCM q <+> " before compilation") : do
5− map (prettyTCM . map unArg . clPats) cls
6−
7−foo =
8− reportSDoc "tc.cc" 30 $
9− sep $ do
10− (prettyTCM q <+> " before compilation") :
11− do
12− map (prettyTCM . map unArg . clPats) cls
data/examples/declaration/value/function/list-notation-3.hsdeleted−10
@@ -1,10 +0,0 @@
1−foo =
2− reportSDoc "tc.cc" 30 $ sep $ do
3− (prettyTCM q <+> " before compilation") : do
4− map (prettyTCM . map unArg . clPats) cls
5−
6−foo =
7− reportSDoc "tc.cc" 30 $ sep $ do
8− (prettyTCM q <+> " before compilation") :
9− do
10− map (prettyTCM . map unArg . clPats) cls
data/examples/declaration/value/function/multi-way-if-out.hs+4−10
@@ -4,13 +4,7 @@ foo x = if | x == 5 -> 5
4
4
5bar x y =
5bar x y =
6 if
6 if
7− | x > y -> x
7+ | x > y -> x
8− | x < y ->
8+ | x < y ->
9− y
9+ y
10− | otherwise -> x
11−
12−baz =
13− if
14− | p -> f
15− | otherwise -> g
10+ | otherwise -> x
16− x
data/examples/declaration/value/function/multi-way-if.hs−5
@@ -7,8 +7,3 @@ bar x y = if
7 | x < y
7 | x < y
8 -> y
8 -> y
9 | otherwise -> x
9 | otherwise -> x
10−
11−baz =
12− if | p -> f
13− | otherwise -> g
14− x
data/examples/declaration/value/function/operator-comments-2-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−x =
2− y
3− ++ f g -- commentA
4− -- commentB
5− -- commentC
data/examples/declaration/value/function/operator-comments-2.hsdeleted−4
@@ -1,4 +0,0 @@
1−x =
2− y ++ -- commentA
3−-- commentB
4− f g -- commentC
data/examples/declaration/value/function/operators-0-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−a =
2− b & c .~ d
3− & e
4− %~ f
5− g
data/examples/declaration/value/function/operators-0.hsdeleted−4
@@ -1,4 +0,0 @@
1−a =
2− b & c .~ d
3− & e %~ f
4− g
data/examples/declaration/value/function/operators-1-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−foo =
2− f
3− . g
4− =<< h . i
data/examples/declaration/value/function/operators-1.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo = f
2− . g
3− =<< h . i
data/examples/declaration/value/function/operators-2-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−foo n
2− | x || y && z || n ** x
3− || x && n =
4− 42
data/examples/declaration/value/function/operators-2.hsdeleted−4
@@ -1,4 +0,0 @@
1−foo n
2− | x || y && z || n ** x
3− || x && n =
4− 42
data/examples/declaration/value/function/operators-3-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo =
2− op <> n <+> colon <+> prettySe <+> text "="
3− <+> prettySe <> text sc
data/examples/declaration/value/function/operators-3.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo =
2− op <> n <+> colon <+> prettySe <+> text "=" <+>
3− prettySe <> text sc
data/examples/declaration/value/function/operators-4-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo =
2− line <> bindingOf <+> text "=" <+> tPretty <+> colon
3− <+> align <> prettyPs
data/examples/declaration/value/function/operators-4.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo =
2− line <> bindingOf <+> text "=" <+> tPretty <+> colon <+>
3− align <> prettyPs
data/examples/declaration/value/function/operators-5-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−foo =
2− map bar $
3− [ baz
4− ]
5− ++ quux
data/examples/declaration/value/function/operators-5.hsdeleted−4
@@ -1,4 +0,0 @@
1−foo =
2− map bar $
3− [ baz
4− ] ++ quux
data/examples/declaration/value/function/operators-6-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−type PermuteRef =
2− "a"
3− :> ( "b" :> "c" :> End
4− :<|> "c" :> "b" :> End
5− )
6− :<|> "b"
7− :> ( "a" :> "c" :> End
8− :<|> "c" :> "a" :> End
9− )
data/examples/declaration/value/function/operators-6.hsdeleted−7
@@ -1,7 +0,0 @@
1−type PermuteRef =
2− "a" :> ( "b" :> "c" :> End
3− :<|> "c" :> "b" :> End
4− )
5− :<|> "b" :> ( "a" :> "c" :> End
6− :<|> "c" :> "a" :> End
7− )
data/examples/declaration/value/function/overindentation-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−reallyincrediblyLongName =
2− f
3− a
4− A
5− { reallyincrediblyLongName =
6− f
7− a
8− A
9− { reallyincrediblyLongName
10− }
11− }
data/examples/declaration/value/function/overindentation.hsdeleted−9
@@ -1,9 +0,0 @@
1−reallyincrediblyLongName = f
2− a
3− A
4− { reallyincrediblyLongName = f
5− a
6− A
7− { reallyincrediblyLongName
8− }
9− }
data/examples/declaration/value/function/parens-out.hsdeleted−1
@@ -1 +0,0 @@
1−f = p (do foo; bar) baz
data/examples/declaration/value/function/parens.hsdeleted−1
@@ -1 +0,0 @@
1−f = p (do foo; bar) baz
data/examples/declaration/value/function/pattern/famous-cardano-pattern-out.hs+8−8
@@ -1,8 +1,8 @@
1−( getNodeSettingsR
1+( getNodeSettingsR :<|>
2− :<|> getNodeInfoR
2+ getNodeInfoR :<|>
3− :<|> getNextUpdateR
3+ getNextUpdateR :<|>
4− :<|> restartNodeR
4+ restartNodeR
5− )
5+ ) :<|>
6− :<|> ( getUtxoR
6+ ( getUtxoR :<|>
7− :<|> getConfirmedProposalsR
7+ getConfirmedProposalsR
8− ) = client nodeV1Api
8+ ) = client nodeV1Api
data/examples/declaration/value/function/pattern/multiline-case-pattern-out.hs+2−2
@@ -10,6 +10,6 @@ f xs = case xs of
10 ] -> a + b
10 ] -> a + b
11
11
12g xs = case xs of
12g xs = case xs of
13− ( a
13+ ( a :
14− : bs
14+ bs
15 ) -> a + b
15 ) -> a + b
data/examples/declaration/value/function/pattern/view-pattern-out.hs+3
@@ -13,3 +13,6 @@ multiline
13 bar
13 bar
14 baz
14 baz
15 ) = True
15 ) = True
16+
17+-- https://github.com/tweag/ormolu/issues/343
18+foo = (f -> 4)
data/examples/declaration/value/function/pattern/view-pattern.hs+3
@@ -10,3 +10,6 @@ g ((f, _), f -> 4) = True
10multiline (t -> Foo
10multiline (t -> Foo
11 bar
11 bar
12 baz) = True
12 baz) = True
13+
14+-- https://github.com/tweag/ormolu/issues/343
15+foo = (f -> 4)
data/examples/declaration/value/function/record-constructors-out.hsnew file+27
@@ -0,0 +1,27 @@
1+foo = Foo {a = 3}
2+
3+bar = Bar
4+ { abc = foo,
5+ def = Foo {a = 10}
6+ }
7+
8+baz = Baz {}
9+
10+sym = Foo {(+) = 3}
11+
12+aLongVariableName =
13+ ALongRecordName
14+ { short = baz,
15+ aLongRecordFieldName = YetAnotherLongRecordName
16+ { yetAnotherLongRecordFieldName = "a long string"
17+ },
18+ aLongRecordFieldName2 = Just YetAnotherLongRecordName
19+ { yetAnotherLongRecordFieldName = "a long string",
20+ yetAnotherLongRecordFieldName =
21+ Just
22+ "a long string"
23+ },
24+ aLongRecordFieldName3 = do
25+ foo
26+ bar
27+ }
data/examples/declaration/value/function/record/constructors.hs → data/examples/declaration/value/function/record-constructors.hsrenamed

The content is the same.

data/examples/declaration/value/function/record/updaters-out.hs → data/examples/declaration/value/function/record-updaters-out.hsrenamed

The content is the same.

data/examples/declaration/value/function/record/updaters.hs → data/examples/declaration/value/function/record-updaters.hsrenamed

The content is the same.

data/examples/declaration/value/function/record/wildcards-out.hs → data/examples/declaration/value/function/record-wildcards-out.hsrenamed+6−7
@@ -3,12 +3,11 @@
3
3
4foo x y = Foo {x, y}
4foo x y = Foo {x, y}
5
5
6−bar x y z =
6+bar x y z = Bar
7− Bar
8− { x,
7+ { x,
9− y,
8+ y,
10− z,
9+ z,
11− ..
10+ ..
12− }
11+ }
13
12
14baz = Baz {..}
13baz = Baz {..}
data/examples/declaration/value/function/record/wildcards.hs → data/examples/declaration/value/function/record-wildcards.hsrenamed

The content is the same.

data/examples/declaration/value/function/record/constructors-out.hsdeleted−31
@@ -1,31 +0,0 @@
1−foo = Foo {a = 3}
2−
3−bar =
4− Bar
5− { abc = foo,
6− def = Foo {a = 10}
7− }
8−
9−baz = Baz {}
10−
11−sym = Foo {(+) = 3}
12−
13−aLongVariableName =
14− ALongRecordName
15− { short = baz,
16− aLongRecordFieldName =
17− YetAnotherLongRecordName
18− { yetAnotherLongRecordFieldName = "a long string"
19− },
20− aLongRecordFieldName2 =
21− Just
22− YetAnotherLongRecordName
23− { yetAnotherLongRecordFieldName = "a long string",
24− yetAnotherLongRecordFieldName =
25− Just
26− "a long string"
27− },
28− aLongRecordFieldName3 = do
29− foo
30− bar
31− }
data/examples/declaration/value/function/record/dot-out.hsdeleted−15
@@ -1,15 +0,0 @@
1−{-# OPTIONS_GHC -fplugin=RecordDotPreprocessor #-}
2−
3−data Foo = Foo {bar :: Int}
4−
5−mfoo = fmap (.bar) $ Nothing
6−
7−bar = (Foo 1).bar
8−
9−fooplus f n = f{foo = f.bar + n}
10−
11−fooplus' f n = f {foo = f.bar + n}
12−
13−fooplus'' f n = f {foo = f.bar + n}
14−
15−fooplus''' f n = f {foo = f.bar + n}
data/examples/declaration/value/function/record/dot.hsdeleted−14
@@ -1,14 +0,0 @@
1−{-# OPTIONS_GHC -fplugin=RecordDotPreprocessor #-}
2−data Foo = Foo { bar :: Int }
3−
4−mfoo = fmap (.bar) $ Nothing
5−
6−bar = ( Foo 1).bar
7−
8−fooplus f n = f{foo = f.bar + n}
9−
10−fooplus' f n = f { foo = f.bar + n}
11−
12−fooplus'' f n = f {foo = f.bar + n}
13−
14−fooplus''' f n = f{ foo = f.bar + n}
data/examples/declaration/value/function/record/hanging-after-equal-con-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo =
2− Foo
3− { foo =
4− -- Blah blah
5− case x of
6− Blah -> 1
7− Blim -> 2
8− }
data/examples/declaration/value/function/record/hanging-after-equal-con.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo = Foo
2− { foo =
3− -- Blah blah
4− case x of
5− Blah -> 1
6− Blim -> 2
7− }
data/examples/declaration/value/function/record/hanging-after-equal-update-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo =
2− foo
3− { foo =
4− -- Blah blah
5− case x of
6− Blah -> 1
7− Blim -> 2
8− }
data/examples/declaration/value/function/record/hanging-after-equal-update.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo = foo
2− { foo =
3− -- Blah blah
4− case x of
5− Blah -> 1
6− Blim -> 2
7− }
data/examples/declaration/value/function/record/inter-comments-out.hsdeleted−13
@@ -1,13 +0,0 @@
1−x =
2− Just
3− -- comment
4− A
5− { x
6− }
7−
8−x =
9− Just
10− -- comment
11− a
12− { x
13− }
data/examples/declaration/value/function/record/inter-comments.hsdeleted−11
@@ -1,11 +0,0 @@
1−x = Just
2− -- comment
3− A
4− { x
5− }
6−
7−x = Just
8− -- comment
9− a
10− { x
11− }
data/examples/declaration/value/function/static-pointers-out.hs+1−2
@@ -14,7 +14,6 @@ bar =
14baz :: StaticPtr Bool
14baz :: StaticPtr Bool
15baz =
15baz =
16 static
16 static
17− ( fun
17+ ( fun 1
18− 1
19 2
18 2
20 )
19 )
data/examples/declaration/value/function/type-applications-and-splice-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−{-# LANGUAGE TemplateHaskell #-}
2−{-# LANGUAGE TypeApplications #-}
3−
4−staticKey name = [|sing @ $(symFQN name)|]
data/examples/declaration/value/function/type-applications-and-splice.hsdeleted−4
@@ -1,4 +0,0 @@
1−{-# LANGUAGE TemplateHaskell #-}
2−{-# LANGUAGE TypeApplications #-}
3−
4−staticKey name = [| sing @ $(symFQN name) |]
data/examples/declaration/value/function/type-applications-out.hs−6
@@ -8,9 +8,3 @@ baz =
8 f @Int @String
8 f @Int @String
9 a
9 a
10 b
10 b
11−
12−goo =
13− hash
14− @(HASH TPraosStandardCrypto)
15− @ByteString
16− "And the lamb lies down on Broadway"
data/examples/declaration/value/function/type-applications.hs−5
@@ -6,8 +6,3 @@ bar = f @(Maybe Int) a b
6
6
7baz = f @Int @String
7baz = f @Int @String
8 a b
8 a b
9−
10−goo = hash
11− @(HASH TPraosStandardCrypto)
12− @ByteString
13− "And the lamb lies down on Broadway"
data/examples/import/deduplication-bug-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−import Foo1 (Bar1 (..), Baz1)
2−import Foo2 (Bar2 (..), Baz2)
3−import Foo3 (Bar3 (x1, x2, x3))
4−import Foo4 (Bar4 (x1, x2))
5−import Foo5 (Bar5 (x1))
6−import Foo6 (Bar6 (..))
data/examples/import/deduplication-bug.hsdeleted−6
@@ -1,6 +0,0 @@
1−import Foo1 (Bar1, Baz1, Bar1(..))
2−import Foo2 (Bar2(..), Baz2, Bar2)
3−import Foo3 (Bar3(x1,x3), Bar3(x1, x2))
4−import Foo4 (Bar4(x1), Bar4(x2))
5−import Foo5 (Bar5, Bar5(x1))
6−import Foo6 (Bar6(x1), Bar6(..))
data/examples/import/explicit-imports-out.hs+4−4
@@ -1,12 +1,12 @@
1import qualified MegaModule as M
1import qualified MegaModule as M
2+ ( (<<<),
3+ (>>>),
2− ( Either,
4+ Either,
3 Maybe (Just, Nothing),
5 Maybe (Just, Nothing),
4 MaybeT (..),
6 MaybeT (..),
5− Monad (return, (>>), (>>=)),
7+ Monad ((>>), (>>=), return),
6 MonadBaseControl,
8 MonadBaseControl,
7 join,
9 join,
8 liftIO,
10 liftIO,
9 void,
11 void,
10− (<<<),
11− (>>>),
12 )
12 )
data/examples/import/explicit-imports-with-comments-out.hs+2−3
@@ -1,7 +1,6 @@
1import qualified MegaModule as M
1import qualified MegaModule as M
2 ( -- (1)
2 ( -- (1)
3− -- (2)
4− Either, -- (3)
5− (<<<),
3+ (<<<), -- (2)
6 (>>>),
4 (>>>),
5+ Either, -- (3)
7 )
6 )
data/examples/import/merging-0-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−import Foo
2−import Foo (bar, foo)
3−import Foo as F
data/examples/import/merging-0.hsdeleted−4
@@ -1,4 +0,0 @@
1−import Foo
2−import Foo (foo)
3−import Foo (bar)
4−import Foo as F
data/examples/import/merging-1-out.hsdeleted−2
@@ -1,2 +0,0 @@
1−import "bar" Foo (bar)
2−import "foo" Foo (baz, foo)
data/examples/import/merging-1.hsdeleted−3
@@ -1,3 +0,0 @@
1−import "foo" Foo (foo)
2−import "bar" Foo (bar)
3−import "foo" Foo (baz)
data/examples/import/merging-2-out.hsdeleted−2
@@ -1,2 +0,0 @@
1−import Foo hiding (bar4, foo2)
2−import qualified Foo (bar3, foo1)
data/examples/import/merging-2.hsdeleted−4
@@ -1,4 +0,0 @@
1−import qualified Foo (foo1)
2−import Foo hiding (foo2)
3−import qualified Foo (bar3)
4−import Foo hiding (bar4)
data/examples/import/misc-out.hs+6
@@ -1,5 +1,11 @@
1import A hiding
1import A hiding
2 ( foobarbazqux,
2 ( foobarbazqux,
3+ foobarbazqux,
4+ foobarbazqux,
5+ foobarbazqux,
6+ foobarbazqux,
7+ foobarbazqux,
8+ foobarbazqux,
3 )
9 )
4import {-# SOURCE #-} safe qualified Module as M hiding (a, b, c, d, e, f)
10import {-# SOURCE #-} safe qualified Module as M hiding (a, b, c, d, e, f)
5import Name hiding ()
11import Name hiding ()
data/examples/import/nested-explicit-imports-out.hs+6−6
@@ -1,10 +1,10 @@
1import qualified MegaModule as M
1import qualified MegaModule as M
2+ ( (<<<),
3+ (>>>),
2− ( Either,
4+ Either,
3 Monad
5 Monad
4− ( return,
5− (>>),
6+ ( (>>),
6− (>>=)
7+ (>>=),
8+ return
7 ),
9 ),
8− (<<<),
9− (>>>),
10 )
10 )
data/examples/import/qualified-post-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−{-# LANGUAGE ImportQualifiedPost #-}
2−
3−import Data.Text qualified (a, b, c)
4−import Data.Text qualified hiding (a, b, c)
5−import Data.Text qualified as T
data/examples/import/qualified-post.hsdeleted−5
@@ -1,5 +0,0 @@
1−{-# LANGUAGE ImportQualifiedPost #-}
2−
3−import qualified Data.Text as T
4−import qualified Data.Text (a, c, b)
5−import Data.Text qualified hiding (c, b, a)
data/examples/import/qualified-prelude-out.hs+1−1
@@ -1,4 +1,4 @@
1module P where
1module P where
2
2
3−import Prelude hiding (id, (.))
3+import Prelude hiding ((.), id)
4import qualified Prelude
4import qualified Prelude
data/examples/import/simple-out.hs+3−2
@@ -1,5 +1,6 @@
1import Data.Text
1import Data.Text
2+import Data.Text
3+import qualified Data.Text as T
4+import qualified Data.Text (a, b, c)
2import Data.Text (a, b, c)
5import Data.Text (a, b, c)
3import Data.Text hiding (a, b, c)
6import Data.Text hiding (a, b, c)
4−import qualified Data.Text (a, b, c)
5−import qualified Data.Text as T
data/examples/import/simple.hs−2
@@ -4,5 +4,3 @@ import qualified Data.Text as T
4import qualified Data.Text (a, c, b)
4import qualified Data.Text (a, c, b)
5import Data.Text (a, b, c)
5import Data.Text (a, b, c)
6import Data.Text hiding (c, b, a)
6import Data.Text hiding (c, b, a)
7−import Data.Text (a, b, c, b, a)
8−import Data.Text hiding (c, b, a, b, c)
data/examples/import/sorted-export-list-out.hsdeleted−1
@@ -1 +0,0 @@
1−import Linear.Vector (Additive (..), (*^), (^*))
data/examples/import/sorted-export-list.hsdeleted−1
@@ -1 +0,0 @@
1−import Linear.Vector (Additive (..), (*^), (^*))
data/examples/module-header/double-dot-with-names-out.hs+6−1
@@ -1,6 +1,11 @@
1{-# LANGUAGE PatternSynonyms #-}
1{-# LANGUAGE PatternSynonyms #-}
2
2
3−module ExportSyntax (A (.., NoA), Q (F, ..), G (T, .., U)) where
3+module ExportSyntax
4+ ( A (.., NoA),
5+ Q (F, ..),
6+ G (T, .., U),
7+ )
8+where
4
9
5data A = A | B
10data A = A | B
6
11
data/examples/module-header/multiline2.hs+2−2
@@ -1,2 +1,2 @@
1−module Foo (
1+module Foo
2− foo, bar, baz) where
2+ (foo, bar, baz) where
data/examples/module-header/preceding-comment-with-haddock-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−{-
2− Here we go.
3−-}
4−
5−-- | This is the module's Haddock.
6−module Main (main) where
7−
8−main = return ()
data/examples/module-header/preceding-comment-with-haddock.hsdeleted−8
@@ -1,8 +0,0 @@
1−{-
2− Here we go.
3−-}
4−
5−-- | This is the module's Haddock.
6−module Main (main) where
7−
8−main = return ()
data/examples/module-header/shebang-out.hs−1
@@ -1,5 +1,4 @@
1#! /usr/bin/env runhaskell
1#! /usr/bin/env runhaskell
2−
3import Prelude
2import Prelude
4
3
5main :: IO ()
4main :: IO ()
data/examples/module-header/shebang-with-pragmas-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−#!/usr/bin/env stack
2−
3−{-# LANGUAGE OverloadedStrings #-}
4−
5−main = pure ()
data/examples/module-header/shebang-with-pragmas.hsdeleted−5
@@ -1,5 +0,0 @@
1−#!/usr/bin/env stack
2−
3−{-# LANGUAGE OverloadedStrings #-}
4−
5−main = pure ()
data/examples/module-header/shebang.hs−1
@@ -1,5 +1,4 @@
1#! /usr/bin/env runhaskell
1#! /usr/bin/env runhaskell
2−
3import Prelude
2import Prelude
4
3
5main :: IO ()
4main :: IO ()
data/examples/module-header/singleline-empty-out.hs+4−1
@@ -1,2 +1,5 @@
1-- | This demonstrates a BUG.
1-- | This demonstrates a BUG.
2−module Foo () where
2+module Foo
3+ (
4+ )
5+where
data/examples/module-header/stack-header-0-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−-- stack runhaskell
2−
3−{-# LANGUAGE OverloadedStrings #-}
4−
5−main = return ()
6−
7−-- stack runhaskell
data/examples/module-header/stack-header-0.hsdeleted−4
@@ -1,4 +0,0 @@
1−-- stack runhaskell
2−{-# LANGUAGE OverloadedStrings #-}
3−main = return ()
4−-- stack runhaskell
data/examples/module-header/stack-header-1-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−#!/usr/bin/env stack
2−-- stack runhaskell
3−
4−{-# LANGUAGE OverloadedStrings #-}
5−
6−main = return ()
7−
8−-- stack runhaskell
data/examples/module-header/stack-header-1.hsdeleted−5
@@ -1,5 +0,0 @@
1−#!/usr/bin/env stack
2−-- stack runhaskell
3−{-# LANGUAGE OverloadedStrings #-}
4−main = return ()
5−-- stack runhaskell
data/examples/module-header/stack-header-2-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−#!/usr/bin/env stack
2−{- stack
3− script
4− --resolver lts-6.25
5− --package turtle
6− --package "stm async"
7− --package http-client,http-conduit
8−-}
9−
10−{-# LANGUAGE OverloadedStrings #-}
11−
12−main = return ()
data/examples/module-header/stack-header-2.hsdeleted−12
@@ -1,12 +0,0 @@
1−#!/usr/bin/env stack
2−{- stack
3− script
4− --resolver lts-6.25
5− --package turtle
6− --package "stm async"
7− --package http-client,http-conduit
8−-}
9−
10−{-# LANGUAGE OverloadedStrings #-}
11−
12−main = return ()
data/examples/module-header/warning-pragma-multiline-out.hs+4−1
@@ -1,6 +1,9 @@
1module Test
1module Test
2 {-# DEPRECATED "This module is unstable" #-}
2 {-# DEPRECATED "This module is unstable" #-}
3− (foo, bar, baz)
3+ ( foo,
4+ bar,
5+ baz,
6+ )
4where
7where
5
8
6import Blah
9import Blah
data/examples/module-header/warning-pragma-out.hs+1−3
@@ -1,5 +1,3 @@
1module Test
1module Test
2− {-# WARNING
3− "This module is very internal"
2+ {-# WARNING "This module is very internal" #-}
4− #-}
5where
3where
data/examples/other/argument-comment-out.hs+1
@@ -9,6 +9,7 @@ foo ::
9 -- | Foo
9 -- | Foo
10 Int ->
10 Int ->
11 Int
11 Int
12+
12foo ::
13foo ::
13 Foo a =>
14 Foo a =>
14 -- | Foo
15 -- | Foo
data/examples/other/comment-after-preceding-haddock-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−module Main where
2−
3−-- | A
4−
5−-- B
6−
7−type D = E
8−
9−-- | This is 'f'
10−
11−-- * Comment
12−f :: a -> b
data/examples/other/comment-after-preceding-haddock.hsdeleted−12
@@ -1,12 +0,0 @@
1−module Main where
2−
3−-- | A
4−
5−-- B
6−
7−type D = E
8−
9−-- | This is 'f'
10−
11−-- * Comment
12−f :: a -> b
data/examples/other/comment-alignment-out.hs+1
@@ -1,4 +1,5 @@
1class Foo a where
1class Foo a where
2+
2 -- | Foo.
3 -- | Foo.
3 foo ::
4 foo ::
4 Int ->
5 Int ->
data/examples/other/comment-before-hanging-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−x = Just
2− -- comment
3− do
4− foo
5− bar
data/examples/other/comment-before-hanging.hsdeleted−5
@@ -1,5 +0,0 @@
1−x = Just
2− -- comment
3− do
4− foo
5− bar
data/examples/other/comment-glued-together-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−module Main (main) where
2−
3−-- | Foo.
4−
5−-- Bar
6−main :: IO ()
7−main = return ()
data/examples/other/comment-glued-together.hsdeleted−6
@@ -1,6 +0,0 @@
1−module Main (main) where
2−
3−{- | Foo. -}
4−-- Bar
5−main :: IO ()
6−main = return ()
data/examples/other/comment-trailing-space-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−data T
2− = {-
3−
4− some multi-line comment
5−
6− with empty lines
7−
8− -}
9− A
data/examples/other/comment-trailing-space.hsdeleted−9
@@ -1,9 +0,0 @@
1−data T
2− = {-
3−
4− some multi-line comment
5−
6− with empty lines
7−
8− -}
9− A
data/examples/other/comment-two-blocks-out.hs+2−2
@@ -2,7 +2,7 @@ newNames :: [(String, String)]
2newNames =
2newNames =
3 let (*) = flip (,)
3 let (*) = flip (,)
4 in [ "Control" * "Monad"
4 in [ "Control" * "Monad"
5− -- Foo
5+ -- Foo
6
6
7− -- Bar
7+ -- Bar
8 ]
8 ]
data/examples/other/cpp/continuation-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo :: Int
2−foo = 5
3−
4−#define message_for(a, b) \
5− printf(#a " and " #b ": We love you!\n")
6−
7−bar :: Int
8−bar = 6
data/examples/other/cpp/continuation.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo :: Int
2−foo = 5
3−
4−#define message_for(a, b) \
5− printf(#a " and " #b ": We love you!\n")
6−
7−bar :: Int
8−bar = 6
data/examples/other/cpp/lonely-hash-out.hsdeleted−14
@@ -1,14 +0,0 @@
1−module Main (main) where
2−
3−import Data.Void
4−import Test.Hspec
5−import Test.Hspec.Megaparsec
6−import Text.Megaparsec
7−import Text.Megaparsec.Char
8−
9−# if !MIN_VERSION_base(4,13,0)
10−import Data.Semigroup ((<>))
11−# endif
12−
13−main :: IO ()
14−main = return ()
data/examples/other/cpp/lonely-hash.hsdeleted−14
@@ -1,14 +0,0 @@
1−module Main (main) where
2−
3−import Data.Void
4−import Test.Hspec
5−import Test.Hspec.Megaparsec
6−import Text.Megaparsec
7−import Text.Megaparsec.Char
8−
9−# if !MIN_VERSION_base(4,13,0)
10−import Data.Semigroup ((<>))
11−# endif
12−
13−main :: IO ()
14−main = return ()
data/examples/other/cpp/separation-0a-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−instance Stream s => Monad (ParsecT e s m) where
2− return = pure
3− (>>=) = pBind
4−
5−#if !(MIN_VERSION_base(4,13,0))
6− fail = Fail.fail
7−#endif
data/examples/other/cpp/separation-0a.hsdeleted−6
@@ -1,6 +0,0 @@
1−instance Stream s => Monad (ParsecT e s m) where
2− return = pure
3− (>>=) = pBind
4−#if !(MIN_VERSION_base(4,13,0))
5− fail = Fail.fail
6−#endif
data/examples/other/cpp/separation-0b-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−instance Stream s => Monad (ParsecT e s m) where
2− return = pure
3− (>>=) = pBind
4−
5−#if !(MIN_VERSION_base(4,13,0))
6− fail = Fail.fail
7−#endif
8−
9−foo :: Int
10−foo = undefined
data/examples/other/cpp/separation-0b.hsdeleted−9
@@ -1,9 +0,0 @@
1−instance Stream s => Monad (ParsecT e s m) where
2− return = pure
3− (>>=) = pBind
4−#if !(MIN_VERSION_base(4,13,0))
5− fail = Fail.fail
6−#endif
7−
8−foo :: Int
9−foo = undefined
data/examples/other/cpp/separation-1a-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−decompressingPipe ::
2− (PrimMonad m, MonadThrow m, MonadResource m) =>
3− CompressionMethod ->
4− ConduitT ByteString ByteString m ()
5−decompressingPipe Store = C.awaitForever C.yield
6−decompressingPipe Deflate = Z.decompress $ Z.WindowBits (-15)
7−
8−#ifdef ENABLE_BZIP2
9−decompressingPipe BZip2 = BZ.bunzip2
10−#else
11−decompressingPipe BZip2 = throwM BZip2Unsupported
12−#endif
data/examples/other/cpp/separation-1a.hsdeleted−11
@@ -1,11 +0,0 @@
1−decompressingPipe
2− :: (PrimMonad m, MonadThrow m, MonadResource m)
3− => CompressionMethod
4− -> ConduitT ByteString ByteString m ()
5−decompressingPipe Store = C.awaitForever C.yield
6−decompressingPipe Deflate = Z.decompress $ Z.WindowBits (-15)
7−#ifdef ENABLE_BZIP2
8−decompressingPipe BZip2 = BZ.bunzip2
9−#else
10−decompressingPipe BZip2 = throwM BZip2Unsupported
11−#endif
data/examples/other/cpp/separation-1b-out.hsdeleted−15
@@ -1,15 +0,0 @@
1−decompressingPipe ::
2− (PrimMonad m, MonadThrow m, MonadResource m) =>
3− CompressionMethod ->
4− ConduitT ByteString ByteString m ()
5−decompressingPipe Store = C.awaitForever C.yield
6−decompressingPipe Deflate = Z.decompress $ Z.WindowBits (-15)
7−
8−#ifdef ENABLE_BZIP2
9−decompressingPipe BZip2 = BZ.bunzip2
10−#else
11−decompressingPipe BZip2 = throwM BZip2Unsupported
12−#endif
13−
14−foo :: Int
15−foo = undefined
data/examples/other/cpp/separation-1b.hsdeleted−14
@@ -1,14 +0,0 @@
1−decompressingPipe
2− :: (PrimMonad m, MonadThrow m, MonadResource m)
3− => CompressionMethod
4− -> ConduitT ByteString ByteString m ()
5−decompressingPipe Store = C.awaitForever C.yield
6−decompressingPipe Deflate = Z.decompress $ Z.WindowBits (-15)
7−#ifdef ENABLE_BZIP2
8−decompressingPipe BZip2 = BZ.bunzip2
9−#else
10−decompressingPipe BZip2 = throwM BZip2Unsupported
11−#endif
12−
13−foo :: Int
14−foo = undefined
data/examples/other/cpp/separation-2a-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−ffff, ffffffff :: Natural
2−
3−#ifdef HASKELL_ZIP_DEV_MODE
4−ffff = 200
5−ffffffff = 5000
6−#else
7−ffff = 0xffff
8−ffffffff = 0xffffffff
9−#endif
data/examples/other/cpp/separation-2a.hsdeleted−8
@@ -1,8 +0,0 @@
1−ffff, ffffffff :: Natural
2−#ifdef HASKELL_ZIP_DEV_MODE
3−ffff = 200
4−ffffffff = 5000
5−#else
6−ffff = 0xffff
7−ffffffff = 0xffffffff
8−#endif
data/examples/other/cpp/separation-2b-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−ffff, ffffffff :: Natural
2−#ifdef HASKELL_ZIP_DEV_MODE
3−ffff = 200
4−ffffffff = 5000
5−#else
6−ffff = 0xffff
7−ffffffff = 0xffffffff
8−#endif
9−
10−foo :: Int
11−foo = undefined
data/examples/other/cpp/separation-2b.hsdeleted−11
@@ -1,11 +0,0 @@
1−ffff, ffffffff :: Natural
2−#ifdef HASKELL_ZIP_DEV_MODE
3−ffff = 200
4−ffffffff = 5000
5−#else
6−ffff = 0xffff
7−ffffffff = 0xffffffff
8−#endif
9−
10−foo :: Int
11−foo = undefined
data/examples/other/cpp/shifted-out.hsdeleted−21
@@ -1,21 +0,0 @@
1−sinkData h compression = do
2− (uncompressedSize, crc32, compressedSize) <-
3− case compression of
4− Store ->
5− withCompression
6− dataSink
7− Deflate ->
8− withCompression $
9− Z.compress 9 (Z.WindowBits (-15)) .| dataSink
10−#ifdef ENABLE_BZIP2
11− BZip2 -> withCompression $
12− BZ.bzip2 .| dataSink
13−#else
14− BZip2 -> throwM BZip2Unsupported
15−#endif
16− return
17− DataDescriptor
18− { ddCRC32 = fromIntegral crc32,
19− ddCompressedSize = compressedSize,
20− ddUncompressedSize = uncompressedSize
21− }
data/examples/other/cpp/shifted.hsdeleted−17
@@ -1,17 +0,0 @@
1−sinkData h compression = do
2− (uncompressedSize, crc32, compressedSize) <-
3− case compression of
4− Store -> withCompression
5− dataSink
6− Deflate -> withCompression $
7− Z.compress 9 (Z.WindowBits (-15)) .| dataSink
8−#ifdef ENABLE_BZIP2
9− BZip2 -> withCompression $
10− BZ.bzip2 .| dataSink
11−#else
12− BZip2 -> throwM BZip2Unsupported
13−#endif
14− return DataDescriptor
15− { ddCRC32 = fromIntegral crc32
16− , ddCompressedSize = compressedSize
17− , ddUncompressedSize = uncompressedSize }
data/examples/other/cpp/simple-import-out.hsdeleted−14
@@ -1,14 +0,0 @@
1−module Main (main) where
2−
3−import Data.Void
4−import Test.Hspec
5−import Test.Hspec.Megaparsec
6−import Text.Megaparsec
7−import Text.Megaparsec.Char
8−
9−#if !MIN_VERSION_base(4,13,0)
10−import Data.Semigroup ((<>))
11−#endif
12−
13−main :: IO ()
14−main = return ()
data/examples/other/cpp/simple-import.hsdeleted−14
@@ -1,14 +0,0 @@
1−module Main (main) where
2−
3−import Data.Void
4−import Test.Hspec
5−import Test.Hspec.Megaparsec
6−import Text.Megaparsec
7−import Text.Megaparsec.Char
8−
9−#if !MIN_VERSION_base(4,13,0)
10−import Data.Semigroup ((<>))
11−#endif
12−
13−main :: IO ()
14−main = return ()
data/examples/other/disabling/indented-fragment-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo =
2− {- ORMOLU_DISABLE -}
3− testCase "Foo" testFoo :
4− testCase "Bar" testBar :
5− testCase "Baz" testBaz :
6− {- ORMOLU_ENABLE -}
7− []
data/examples/other/disabling/indented-fragment.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo =
2− {- ORMOLU_DISABLE -}
3− testCase "Foo" testFoo :
4− testCase "Bar" testBar :
5− testCase "Baz" testBaz :
6− {- ORMOLU_ENABLE -}
7− []
data/examples/other/disabling/single-definition-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−module Foo (foo, bar) where
2−
3−{- ORMOLU_DISABLE -}
4−foo :: Int -> Int
5−foo = (+5)
6−{- ORMOLU_ENABLE -}
7−
8−bar :: Bool -> Bool
9−bar True = True
10−bar False = True
data/examples/other/disabling/single-definition.hsdeleted−10
@@ -1,10 +0,0 @@
1−module Foo (foo,bar) where
2−
3−{- ORMOLU_DISABLE -}
4−foo :: Int -> Int
5−foo = (+5)
6−{- ORMOLU_ENABLE -}
7−
8−bar :: Bool -> Bool
9−bar True = True
10−bar False = True
data/examples/other/disabling/whole-file-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−{- ORMOLU_DISABLE -}
2−
3−module Foo (foo,bar) where
4−
5−foo :: Int -> Int
6−foo = (+5)
7−
8−bar :: Bool -> Bool
9−bar True = True
10−bar False = True
data/examples/other/disabling/whole-file.hsdeleted−10
@@ -1,10 +0,0 @@
1−{- ORMOLU_DISABLE -}
2−
3−module Foo (foo,bar) where
4−
5−foo :: Int -> Int
6−foo = (+5)
7−
8−bar :: Bool -> Bool
9−bar True = True
10−bar False = True
data/examples/other/empty-forall-out.hsdeleted−18
@@ -1,18 +0,0 @@
1−-- Empty foralls are handled correctly in different situations.
2−
3−data D = forall. D Int
4−
5−data G where
6− G :: forall. Int -> G
7−
8−f :: forall. a -> a
9−f x = x
10−
11−type family T x where
12− forall. T x = x
13−
14−{-# RULES
15−"r"
16− r a =
17− ()
18− #-}
data/examples/other/empty-forall.hsdeleted−17
@@ -1,17 +0,0 @@
1−-- Empty foralls are handled correctly in different situations.
2−
3−data D = forall. D Int
4−
5−data G where
6− G :: forall. Int -> G
7−
8−f :: forall. a -> a
9−f x = x
10−
11−type family T x where
12− forall. T x = x
13−
14−{-# RULES
15− "r"
16− forall. r a = ()
17−#-}
data/examples/other/haddock-sections-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−-- $weird #anchor#
2−--
3−-- Section 1
4−
5−-- $normal
6−--
7−-- Section 2
data/examples/other/haddock-sections.hsdeleted−7
@@ -1,7 +0,0 @@
1−-- $weird #anchor#
2−--
3−-- Section 1
4−
5−-- $normal
6−--
7−-- Section 2
data/examples/other/inline-comment-0-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−x = ({-a-} b, c)
2−
3−y = ({-a-} b)
data/examples/other/inline-comment-0.hsdeleted−3
@@ -1,3 +0,0 @@
1−x = ({-a-}b, c)
2−
3−y = ({-a-}b)
data/examples/other/inline-comment-1-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−showPs env ((n, _, Let _ t v) : bs) =
2− " " ++ show n ++ " : "
3− ++ showEnv env ({- normalise ctxt env -} t)
4− ++ " = "
5− ++ showEnv env ({- normalise ctxt env -} v)
6− ++ "\n"
7− ++ showPs env bs
8−showPs env ((n, _, b) : bs) =
9− " " ++ show n ++ " : "
10− ++ showEnv env ({- normalise ctxt env -} (binderTy b))
11− ++ "\n"
12− ++ showPs env bs
data/examples/other/inline-comment-1.hsdeleted−9
@@ -1,9 +0,0 @@
1−showPs env ((n, _, Let _ t v):bs)
2− = " " ++ show n ++ " : " ++
3− showEnv env ({- normalise ctxt env -} t) ++ " = " ++
4− showEnv env ({- normalise ctxt env -} v) ++
5− "\n" ++ showPs env bs
6−showPs env ((n, _, b):bs)
7− = " " ++ show n ++ " : " ++
8− showEnv env ({- normalise ctxt env -} (binderTy b)) ++
9− "\n" ++ showPs env bs
data/examples/other/multiline-forall-out.hsdeleted−58
@@ -1,58 +0,0 @@
1−{-# LANGUAGE GADTs #-}
2−{-# LANGUAGE PolyKinds #-}
3−{-# LANGUAGE RankNTypes #-}
4−{-# LANGUAGE TypeFamilies #-}
5−
6−-- Multiline foralls are consistent across all declarations
7−
8−data D
9− = forall
10− ( f ::
11− * -> * -> *
12− )
13− (x :: *)
14− (y :: *).
15− D (f x y)
16−
17−data G where
18− G ::
19− forall
20− ( f ::
21− * -> * -> *
22− )
23− (x :: *)
24− (y :: *).
25− f x y ->
26− G
27−
28−f ::
29− forall
30− ( f ::
31− * -> * -> *
32− )
33− (x :: *)
34− (y :: *).
35− f x y ->
36− ()
37−f = const ()
38−
39−type family T f x y where
40− forall
41− ( f ::
42− * -> * -> *
43− )
44− (x :: *)
45− (y :: *).
46− T f x y =
47− f x y
48−
49−{-# RULES
50−"r" forall
51− ( f ::
52− * -> * -> *
53− )
54− (x :: *)
55− (y :: *).
56− r (a :: f x y) =
57− ()
58− #-}
data/examples/other/multiline-forall.hsdeleted−46
@@ -1,46 +0,0 @@
1−{-# LANGUAGE RankNTypes, PolyKinds, GADTs, TypeFamilies #-}
2−
3−-- Multiline foralls are consistent across all declarations
4−
5−data D =
6− forall
7− (f ::
8− * -> * -> *)
9− (x :: *)
10− (y :: *)
11− . D (f x y)
12−
13−data G where
14− G :: forall
15− (f ::
16− * -> * -> *)
17− (x :: *)
18− (y :: *)
19− . f x y -> G
20−
21−f :: forall
22− (f ::
23− * -> * -> *)
24− (x :: *)
25− (y :: *)
26− . f x y -> ()
27−f = const ()
28−
29−type family T f x y where
30− forall
31− (f ::
32− * -> * -> *)
33− (x :: *)
34− (y :: *)
35− . T f x y = f x y
36−
37−{-# RULES
38− "r"
39− forall
40− (f ::
41− * -> * -> *)
42− (x :: *)
43− (y :: *)
44− . r (a :: f x y) =
45− ()
46− #-}
data/examples/other/multiple-blank-line-comment-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−module A where
2−
3−a =
4− b
5− [ f
6− {-,
7−
8− -}
9− ]
data/examples/other/multiple-blank-line-comment.hsdeleted−10
@@ -1,10 +0,0 @@
1−module A where
2−
3−a =
4− b
5− [ f
6− {-,
7−
8−
9− -}
10− ]
data/examples/other/pragma-comments-after-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−-- TODO: Fix and delete this pragma
4−{-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-}
data/examples/other/pragma-comments-after.hsdeleted−3
@@ -1,3 +0,0 @@
1−{-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-} -- TODO: Fix and delete this pragma
2−{-# LANGUAGE AllowAmbiguousTypes #-}
3−{-# LANGUAGE ConstraintKinds #-}
data/examples/other/pragma-comments-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−-- TODO This extension is probably too dangerous, remove it.
3−{-# LANGUAGE RecordWildCards #-}
4−-- Avoid warning produced by TH.
5−{-# OPTIONS_GHC -fno-warn-overlapping-patterns #-}
6−
7−-- | Header comment.
8−module Foo () where
data/examples/other/pragma-comments.hsdeleted−11
@@ -1,11 +0,0 @@
1−-- | Header comment.
2−
3−{-# LANGUAGE OverloadedStrings #-}
4−
5−-- Avoid warning produced by TH.
6−{-# OPTIONS_GHC -fno-warn-overlapping-patterns #-}
7−
8−-- TODO This extension is probably too dangerous, remove it.
9−{-# LANGUAGE RecordWildCards #-}
10−
11−module Foo () where
data/examples/other/pragma-out.hs+4−1
@@ -9,4 +9,7 @@
9{-# OPTIONS_HADDOCK prune, show-extensions #-}
9{-# OPTIONS_HADDOCK prune, show-extensions #-}
10
10
11-- | Header comment.
11-- | Header comment.
12−module Foo () where
12+module Foo
13+ (
14+ )
15+where
data/examples/other/pragma-sorting-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−{-# LANGUAGE NondecreasingIndentation #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE TypeFamilies #-}
4−-- This gap is necessary for stylish Haskell not to re-arrange
5−-- NoMonoLocalBinds before TypeFamilies
6−{-# LANGUAGE NoMonoLocalBinds #-}
7−
8−module Foo
9− ( bar,
10− )
11−where
data/examples/other/pragma-sorting.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE ScopedTypeVariables #-}
2−{-# LANGUAGE TypeFamilies #-}
3−{-# LANGUAGE NondecreasingIndentation #-}
4−-- This gap is necessary for stylish Haskell not to re-arrange
5−-- NoMonoLocalBinds before TypeFamilies
6−{-# LANGUAGE NoMonoLocalBinds #-}
7−
8−module Foo (
9− bar
10− ) where
default.nix+39−108
@@ -1,9 +1,7 @@
1−{ pkgs ? (import ./nix/nixpkgs { inherit system; })
1+{ pkgs ? (import ./nix/nixpkgs) }:
2−, system ? builtins.currentSystem
3−, ormoluCompiler ? "ghc884" # the shell doesn't work with ghc8101 yet
4−}:
5
2
6let
3let
4+ ormoluCompiler = "ghc865";
7 source = pkgs.lib.sourceByRegex ./. [
5 source = pkgs.lib.sourceByRegex ./. [
8 "^.*\.md$"
6 "^.*\.md$"
9 "^app.*$"
7 "^app.*$"
@@ -16,71 +14,46 @@ let
16 overrides = ormoluOverlay;
14 overrides = ormoluOverlay;
17 };
15 };
18 ormoluOverlay = self: super: {
16 ormoluOverlay = self: super: {
19− "ormolu" = super.callCabal2nixWithOptions "ormolu" source "-fdev" { };
17+ "ormolu" = super.callCabal2nix "ormolu" source { };
20 };
18 };
21 ormolize = import ./nix/ormolize {
19 ormolize = import ./nix/ormolize {
22 inherit pkgs;
20 inherit pkgs;
23 inherit haskellPackages;
21 inherit haskellPackages;
24 };
22 };
25− expectedFailures = [
23+ # NOTE We have to exclude some directories for some packages because
26− "Agda"
24+ # Ormolu needs files to be parsable by Haddock which is not always the
25+ # case. For example some tests and examples do not parse.
26+ excludedHackageDirs = {
27− "aws"
27+ "aws" = ["Examples"];
28− "distributed-process"
28+ "distributed-process" = ["benchmarks"];
29− "esqueleto"
29+ "esqueleto" = ["test"];
30− "fay"
30+ "fay" = ["examples"];
31− "hlint"
32− "idris"
33− "intero"
34− "leksah"
35− "pandoc"
36− "pipes"
37− "postgrest"
31+ "postgrest" = ["test"];
38− "purescript"
32+ };
39− "tensorflow"
40− ] ++ (if ormoluCompiler == "ghc8101" then [] else ["lens"]);
41 ormolizedPackages = doCheck:
33 ormolizedPackages = doCheck:
42 pkgs.lib.mapAttrs (name: p: ormolize {
34 pkgs.lib.mapAttrs (name: p: ormolize {
43 package = p;
35 package = p;
44 inherit doCheck;
36 inherit doCheck;
45− expectedFailures =
37+ excludedDirs =
46− if pkgs.lib.lists.any (x: x == name) expectedFailures
38+ if builtins.hasAttr name excludedHackageDirs
47− then ./expected-failures + "/${name}.txt"
39+ then excludedHackageDirs.${name}
48− else null;
40+ else [];
49 }) haskellPackages;
41 }) haskellPackages;
50in {
42in {
51 ormolu = haskellPackages.ormolu;
43 ormolu = haskellPackages.ormolu;
52− # We put the derivations in another attribute set to avoid building them
53− # when nix-build is run.
54− dev = {
55− ormoluShell =
56− haskellPackages.shellFor {
44+ ormoluShell = haskellPackages.shellFor {
57− packages = ps: [
45+ packages = ps: [ ps.ormolu ];
58− ps.ormolu
59− ];
60− buildInputs = [
61− haskellPackages.cabal-install
46+ buildInputs = [ haskellPackages.cabal-install haskellPackages.ghcid ];
62− haskellPackages.ghcid
63− ];
64− };
65− withOrmolu = haskellPackages.shellFor {
66− packages = ps: [];
67− buildInputs = [
68− haskellPackages.cabal-install
69− haskellPackages.ormolu
70− ];
71− };
72 };
47 };
73 inherit ormoluOverlay ormoluCompiler;
48 inherit ormoluOverlay ormoluCompiler;
74 hackage = ormolizedPackages false;
49 hackage = ormolizedPackages false;
75 hackageTests = with pkgs.lib; pkgs.recurseIntoAttrs (
50 hackageTests = with pkgs.lib; pkgs.recurseIntoAttrs (
76 let ps = [
51 let ps = [
77− "Agda"
78 "QuickCheck"
52 "QuickCheck"
79 "ShellCheck"
53 "ShellCheck"
80 "aeson"
54 "aeson"
81 "attoparsec"
55 "attoparsec"
82 "aws"
56 "aws"
83− "brick"
84 "capability"
57 "capability"
85 "cassava"
58 "cassava"
86 "conduit"
59 "conduit"
@@ -92,78 +65,36 @@ in {
92 "hakyll"
65 "hakyll"
93 "haxl"
66 "haxl"
94 "hedgehog"
67 "hedgehog"
95− "hledger"
96 "hlint"
68 "hlint"
97− "http-client"
98− "idris"
99− "intero"
100− "leksah"
101− "lens"
102 "megaparsec"
69 "megaparsec"
103− "optics"
104 "ormolu"
70 "ormolu"
105− "pandoc"
106− "parsec3"
107− "pipes"
108 "postgrest"
71 "postgrest"
109− "purescript"
110 "servant"
72 "servant"
111 "servant-server"
73 "servant-server"
112− "stack"
113 "tensorflow"
74 "tensorflow"
114 "text_1_2_4_0"
75 "text_1_2_4_0"
115 "tls"
76 "tls"
116 "yesod-core"
77 "yesod-core"
78+
79+ # Comment idempotence issue
80+
81+ # "Agda"
82+ # "brick"
83+ # "hledger"
84+ # "http-client"
85+ # "idris"
86+ # "intero"
87+ # "leksah"
88+ # "pandoc"
89+ # "pipes"
90+ # "stack"
91+
92+ # Missing language extension
93+
94+ # "lens" #fixed in master
95+ # "purescript"
96+
117 ];
97 ];
118 in listToAttrs (map (p: nameValuePair p (ormolizedPackages true).${p}) ps)
98 in listToAttrs (map (p: nameValuePair p (ormolizedPackages true).${p}) ps)
119 );
99 );
120− regionTests = pkgs.stdenv.mkDerivation {
121− name = "ormolu-region-tests";
122− src = ./region-tests;
123− buildInputs = [
124− haskellPackages.ormolu
125− pkgs.diffutils
126− ];
127− doCheck = true;
128− buildPhase = ''
129− cp src.hs result-all-implicit.hs
130− ormolu --check-idempotence --mode inplace result-all-implicit.hs
131− cp src.hs result-all-explicit.hs
132− ormolu --check-idempotence --mode inplace --start-line 1 --end-line 18 result-all-explicit.hs
133− cp src.hs result-only-start.hs
134− ormolu --check-idempotence --mode inplace --start-line 1 result-only-start.hs
135− cp src.hs result-only-end.hs
136− ormolu --check-idempotence --mode inplace --end-line 18 result-only-end.hs
137− cp src.hs result-6-7.hs
138− ormolu --check-idempotence --mode inplace --start-line 6 --end-line 7 result-6-7.hs
139− cp src.hs result-6-8.hs
140− ormolu --check-idempotence --mode inplace --start-line 6 --end-line 8 result-6-8.hs
141− cp src.hs result-9-12.hs
142− ormolu --check-idempotence --mode inplace --start-line 9 --end-line 12 result-9-12.hs
143− cp src.hs result-17-18.hs
144− ormolu --check-idempotence --mode inplace --start-line 17 --end-line 18 result-17-18.hs
145− '';
146− checkPhase = ''
147− echo result-all-implicit.hs
148− diff --color=always expected-result-all.hs result-all-implicit.hs
149− echo result-all-explicit.hs
150− diff --color=always expected-result-all.hs result-all-explicit.hs
151− echo result-only-start.hs
152− diff --color=always expected-result-all.hs result-only-start.hs
153− echo result-only-end.hs
154− diff --color=always expected-result-all.hs result-only-end.hs
155− echo result-6-7.hs
156− diff --color=always expected-result-6-7.hs result-6-7.hs
157− echo result-6-8.hs
158− diff --color=always expected-result-6-8.hs result-6-8.hs
159− echo result-9-12.hs
160− diff --color=always expected-result-9-12.hs result-9-12.hs
161− echo result-17-18.hs
162− diff --color=always expected-result-17-18.hs result-17-18.hs
163− '';
164− installPhase = ''
165− mkdir "$out"
166− find . -name '*.hs' -exec cp --parents {} $out \;
167− '';
168− };
169}
100}
expected-failures/Agda.txtdeleted−11
@@ -1,11 +0,0 @@
1−Formatting is not idempotent:
2− dist/build/Agda/Syntax/Parser/Lexer.hs<rendered>:1602:17
3− before: " = (check_ac"
4− after: " =\n "
5−Please, consider reporting the bug.
6−
7−Formatting is not idempotent:
8− src/full/Agda/Syntax/Translation/InternalToAbstract.hs<rendered>:769:4
9− before: " nes\n\n "
10− after: " nes\n\n -- Andreas"
11−Please, consider reporting the bug.
expected-failures/aws.txtdeleted−9
@@ -1,9 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− Examples/PutBucketNearLine.hs:5:1-6
3− parse error on input `import'
4−
5−The GHC parser (in Haddock mode) failed:
6− Examples/Sqs.hs:(88,3)-(90,4)
7− parse error on input `{- | Let's make sure the queue was actually deleted and that the same number of queues exist at when
8− | the program ends as when it started.
9− -}'
expected-failures/distributed-process.txtdeleted−7
@@ -1,7 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− benchmarks/Channels.hs:2:1-6
3− parse error on input `import'
4−
5−The GHC parser (in Haddock mode) failed:
6− benchmarks/Spawns.hs:5:1-6
7− parse error on input `import'
expected-failures/esqueleto.txtdeleted−7
@@ -1,7 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− src/Database/Esqueleto/Internal/Internal.hs:379:1
3− lexical error in string/character literal at character 's'
4−
5−The GHC parser (in Haddock mode) failed:
6− test/PostgreSQL/Test.hs:562:9-41
7− parse error on input `-- | Check the result is not null'
expected-failures/fay.txtdeleted−18
@@ -1,18 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− examples/Separated.hs:12:1-6
3− parse error on input `module'
4−
5−The GHC parser (in Haddock mode) failed:
6− examples/calc.hs:(4,1)-(6,2)
7− parse error on input `-- $ fay -p --html-wrapper --html-js-lib jquery.min.js examples/calc.hs
8−-- You also need to download jquery.min.js.
9−--'
10−
11−The GHC parser (in Haddock mode) failed:
12− examples/canvaswater.hs:(6,1)-(7,17)
13− parse error on input `-- | A demonstration of Fay using the canvas element to display a
14−-- simple effect.'
15−
16−The GHC parser (in Haddock mode) failed:
17− examples/data.hs:9:1-6
18− parse error on input `module'
expected-failures/hlint.txtdeleted−11
@@ -1,11 +0,0 @@
1−Formatting is not idempotent:
2− src/Extension.hs<rendered>:19:22
3− before: "DoRec , -} Recursive"
4− after: "DoRec , -}\n "
5−Please, consider reporting the bug.
6−
7−Formatting is not idempotent:
8− src/Hint/Bracket.hs<rendered>:249:50
9− before: "\" x y [r]) {ideaSpan"
10− after: "\" x y [r])\n "
11−Please, consider reporting the bug.
expected-failures/idris.txtdeleted−7
@@ -1,7 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− src/Idris/Parser.hs:1052:1
3− parse error on input `@'
4−
5−The GHC parser (in Haddock mode) failed:
6− src/Idris/Parser/Expr.hs:75:1
7− parse error on input `@'
expected-failures/intero.txtdeleted−5
@@ -1,5 +0,0 @@
1−Formatting is not idempotent:
2− src/InteractiveUI.hs<rendered>:3748:33
3− before: "text \"Try\" <+> doWha"
4− after: "text \"Try\"\n "
5−Please, consider reporting the bug.
expected-failures/leksah.txtdeleted−5
@@ -1,5 +0,0 @@
1−Formatting is not idempotent:
2− src/IDE/Pane/Modules.hs<rendered>:1184:7
3− before: "cr\n -- show"
4− after: "cr\n in -- show"
5−Please, consider reporting the bug.
expected-failures/lens.txtdeleted−3
@@ -1,3 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− src/Control/Exception/Lens.hs:180:13-37
3− parse error on input `AllocationLimitExceeded__'
expected-failures/pandoc.txtdeleted−9
@@ -1,9 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− benchmark/weigh-pandoc.hs:14:1-6
3− parse error on input `import'
4−
5−Formatting is not idempotent:
6− src/Text/Pandoc/Readers/Vimwiki.hs<rendered>:613:19
7− before: ".softbreak <$ endlin"
8− after: ".softbreak\n <$ en"
9−Please, consider reporting the bug.
expected-failures/pipes.txtdeleted−3
@@ -1,3 +0,0 @@
1−AST of input and AST of formatted code differ.
2− at src/Pipes/Core.hs:(128,1)-(151,2)
3−Please, consider reporting the bug.
expected-failures/postgrest.txtdeleted−5
@@ -1,5 +0,0 @@
1−Formatting is not idempotent:
2− src/PostgREST/DbRequestBuilder.hs<rendered>:149:24
3− before: " || -- clients"
4− after: " || ( origin ="
5−Please, consider reporting the bug.
expected-failures/purescript.txtdeleted−18
@@ -1,18 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− src/Language/PureScript/AST/Declarations.hs:479:1-17
3− Invalid type signature: pattern ValueDecl :: ...
4−Perhaps you meant to use PatternSynonyms?
5−
6−The GHC parser (in Haddock mode) failed:
7− src/Language/PureScript/AST/SourcePos.hs:99:1-22
8− Invalid type signature: pattern NullSourceSpan :: ...
9−Perhaps you meant to use PatternSynonyms?
10−
11−The GHC parser (in Haddock mode) failed:
12− src/Language/PureScript/Constants.hs:42:1-15
13− Invalid type signature: pattern Discard :: ...
14−Perhaps you meant to use PatternSynonyms?
15−
16−The GHC parser (in Haddock mode) failed:
17− src/Language/PureScript/Crash.hs:16:1-6
18− parse error on input `import'
expected-failures/tensorflow.txtdeleted−7
@@ -1,7 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− tensorflow-mnist/app/Main.hs:50:13-14
3− parse error on input `->'
4−
5−The GHC parser (in Haddock mode) failed:
6− tensorflow-ops/tests/RegressionTest.hs:3:1-6
7− parse error on input `import'
format.shdeleted−14
@@ -1,14 +0,0 @@
1−#!/usr/bin/env nix-shell
2−#!nix-shell default.nix -A dev.withOrmolu -i bash --pure
3−#
4−# Format Ormolu using current version of Ormolu.
5−
6−set -e
7−
8−export LANG="C.UTF-8"
9−
10−cabal format
11−
12−ormolu -m inplace $(find app -type f -name "*.hs")
13−ormolu -m inplace $(find src -type f \( -name "*.hs" -o -name "*.hs-boot" \))
14−ormolu -m inplace $(find tests -type f -name "*.hs")
nix/nixpkgs/default.nix+3−7
@@ -1,13 +1,9 @@
1−{ system ? builtins.currentSystem }:
2let
1let
3− rev = "32b46dd897ab2143a609988a04d87452f0bbef59";
2+ rev = "3f4144c30a6351dd79b177328ec4dea03e2ce45f";
4− sha256 = "1gzfrpjnr1bz9zljsyg3a4zrhk8r927sz761mrgcg56dwinkhpjk";
3+ sha256 = "1qg5n60n3fr6cypihnrjw451fadps5pysj5p0vvfb320mpfvlbjb";
5 nixpkgs = builtins.fetchTarball {
4 nixpkgs = builtins.fetchTarball {
6 url = "https://github.com/NixOS/nixpkgs/archive/${rev}.tar.gz";
5 url = "https://github.com/NixOS/nixpkgs/archive/${rev}.tar.gz";
7 inherit sha256;
6 inherit sha256;
8 };
7 };
9− pkgs = import nixpkgs {
10− inherit system;
11− config.allowUnfree = true;
8+ pkgs = import nixpkgs { config.allowUnfree = true; };
12− };
13in pkgs
9in pkgs
nix/ormolize/default.nix+13−29
@@ -2,48 +2,32 @@
2, haskellPackages
2, haskellPackages
3}:
3}:
4{ package
4{ package
5−, expectedFailures ? null
6, doCheck ? false
5, doCheck ? false
6+, excludedDirs ? []
7}:
7}:
8 pkgs.stdenv.mkDerivation rec {
8 pkgs.stdenv.mkDerivation rec {
9 name = package.name + "-ormolized";
9 name = package.name + "-ormolized";
10 src = package.src;
10 src = package.src;
11 buildInputs = [
11 buildInputs = [
12 haskellPackages.cpphs
12 haskellPackages.cpphs
13+ (if doCheck
13− haskellPackages.ormolu
14+ then haskellPackages.ormolu
14− pkgs.diffutils
15+ else pkgs.haskell.lib.dontCheck haskellPackages.ormolu)
15 pkgs.glibcLocales
16 pkgs.glibcLocales
16 ];
17 ];
17 LANG = "en_US.UTF-8";
18 LANG = "en_US.UTF-8";
19+ excludedDirsRendered =
20+ if excludedDirs == []
21+ then ""
22+ else pkgs.lib.concatMapStringsSep " " (x: "-not -path './" + x + "/*'") excludedDirs;
18 buildPhase = ''
23 buildPhase = ''
19− hs_files=$(find . -name '*.hs')
24+ find . -name '*.hs' ${excludedDirsRendered} -exec bash ${./ormolize.sh} {} \; 2> log.txt
20− for hs_file in $hs_files; do
25+ cat log.txt
21−
22− # drop includes
23− sed -i '/^#include/d' "$hs_file"
24−
25− # deal with CPP
26− cpphs "$hs_file" --noline -DARCH_X86 > "''${hs_file}-nocpp" 2> /dev/null
27−
28− # annoyingly, cpphs cannot modify files in place
29− mv "''${hs_file}-nocpp" "$hs_file"
30−
31− # preserve the original
32− cp "$hs_file" "''${hs_file}-original"
33− done
34−
35− (ormolu --check-idempotence --mode inplace $hs_files || true) 2> log.txt
36 '';
26 '';
37 inherit doCheck;
27 inherit doCheck;
38− checkPhase =
28+ checkPhase = ''
39− if expectedFailures == null
40− then ''
41− echo "No failures expected"
42− if [[ -s log.txt ]]; then exit 1; fi
29+ if [[ -s log.txt ]]; then exit 1; fi
43− ''
44− else ''
45− diff --ignore-blank-lines --color=always ${expectedFailures} log.txt
46− '';
30+ '';
47 installPhase = ''
31 installPhase = ''
48 mkdir "$out"
32 mkdir "$out"
49 find . -name '*.hs-original' -exec cp --parents {} $out \;
33 find . -name '*.hs-original' -exec cp --parents {} $out \;
nix/ormolize/ormolize.shnew file+17
@@ -0,0 +1,17 @@
1+set -euo pipefail
2+
3+# drop includes
4+sed -i '/^#include/d' "$1"
5+
6+# deal with CPP in a fairly straightforward way
7+cpphs "$1" --noline > "$1-nocpp" 2> /dev/null
8+
9+# annoyingly, cpphs cannot modify files in place
10+mv "$1-nocpp" "$1"
11+
12+# preserve the original
13+cp "$1" "$1-original"
14+
15+# run ormolu
16+ormolu --tolerate-cpp --check-idempotency --mode inplace "$1" ||
17+ ormolu --tolerate-cpp --unsafe --mode inplace "$1"
ormolu.cabal+155−174
@@ -1,184 +1,165 @@
1+name: ormolu
2+version: 0.0.1.0
1−cabal-version: 1.18
3+cabal-version: 1.18
2−name: ormolu
4+tested-with: GHC==8.6.5
3−version: 0.1.2.0
4−license: BSD3
5+license: BSD3
5−license-file: LICENSE.md
6+license-file: LICENSE.md
6−maintainer: Mark Karpov <mark.karpov@tweag.io>
7+maintainer: Mark Karpov <mark.karpov@tweag.io>
7−tested-with: ghc ==8.6.5 ghc ==8.8.4 ghc ==8.10.1
8−homepage: https://github.com/tweag/ormolu
8+homepage: https://github.com/tweag/ormolu
9−bug-reports: https://github.com/tweag/ormolu/issues
9+bug-reports: https://github.com/tweag/ormolu/issues
10−synopsis: A formatter for Haskell source code
11−description: A formatter for Haskell source code.
12−category: Development, Formatting
10+category: Development, Formatting
11+synopsis: A formatter for Haskell source code
13−build-type: Simple
12+build-type: Simple
14−data-files:
13+description: A formatter for Haskell source code.
14+extra-doc-files: CONTRIBUTING.md
15+ , CHANGELOG.md
16+ , DESIGN.md
17+ , README.md
15− data/examples/declaration/annotation/*.hs
18+data-files: data/examples/declaration/annotation/*.hs
16− data/examples/declaration/class/*.hs
19+ , data/examples/declaration/class/*.hs
17− data/examples/declaration/data/*.hs
20+ , data/examples/declaration/data/*.hs
18− data/examples/declaration/data/gadt/*.hs
21+ , data/examples/declaration/data/gadt/*.hs
19− data/examples/declaration/default/*.hs
22+ , data/examples/declaration/default/*.hs
20− data/examples/declaration/deriving/*.hs
23+ , data/examples/declaration/deriving/*.hs
21− data/examples/declaration/foreign/*.hs
24+ , data/examples/declaration/foreign/*.hs
22− data/examples/declaration/instance/*.hs
25+ , data/examples/declaration/instance/*.hs
23− data/examples/declaration/rewrite-rule/*.hs
26+ , data/examples/declaration/rewrite-rule/*.hs
24− data/examples/declaration/role-annotation/*.hs
27+ , data/examples/declaration/role-annotation/*.hs
25− data/examples/declaration/signature/complete/*.hs
28+ , data/examples/declaration/signature/complete/*.hs
26− data/examples/declaration/signature/fixity/*.hs
29+ , data/examples/declaration/signature/fixity/*.hs
27− data/examples/declaration/signature/inline/*.hs
30+ , data/examples/declaration/signature/inline/*.hs
28− data/examples/declaration/signature/minimal/*.hs
31+ , data/examples/declaration/signature/minimal/*.hs
29− data/examples/declaration/signature/pattern/*.hs
32+ , data/examples/declaration/signature/pattern/*.hs
30− data/examples/declaration/signature/set-cost-centre/*.hs
33+ , data/examples/declaration/signature/set-cost-centre/*.hs
31− data/examples/declaration/signature/specialize/*.hs
34+ , data/examples/declaration/signature/specialize/*.hs
32− data/examples/declaration/signature/type/*.hs
35+ , data/examples/declaration/signature/type/*.hs
33− data/examples/declaration/splice/*.hs
36+ , data/examples/declaration/splice/*.hs
34− data/examples/declaration/type-families/closed-type-family/*.hs
37+ , data/examples/declaration/type-families/closed-type-family/*.hs
35− data/examples/declaration/type-families/data-family/*.hs
38+ , data/examples/declaration/type-families/data-family/*.hs
36− data/examples/declaration/type-families/type-family/*.hs
39+ , data/examples/declaration/type-families/type-family/*.hs
37− data/examples/declaration/type-synonyms/*.hs
40+ , data/examples/declaration/type-synonyms/*.hs
38− data/examples/declaration/type/*.hs
41+ , data/examples/declaration/type/*.hs
39− data/examples/declaration/value/function/*.hs
42+ , data/examples/declaration/value/function/*.hs
40− data/examples/declaration/value/function/arrow/*.hs
43+ , data/examples/declaration/value/function/arrow/*.hs
41− data/examples/declaration/value/function/comprehension/*.hs
44+ , data/examples/declaration/value/function/comprehension/*.hs
42− data/examples/declaration/value/function/do/*.hs
45+ , data/examples/declaration/value/function/do/*.hs
43− data/examples/declaration/value/function/infix/*.hs
46+ , data/examples/declaration/value/function/infix/*.hs
44− data/examples/declaration/value/function/pattern/*.hs
47+ , data/examples/declaration/value/function/pattern/*.hs
45− data/examples/declaration/value/other/*.hs
48+ , data/examples/declaration/value/other/*.hs
46− data/examples/declaration/value/pattern-synonyms/*.hs
49+ , data/examples/declaration/value/pattern-synonyms/*.hs
47− data/examples/declaration/warning/*.hs
50+ , data/examples/declaration/warning/*.hs
48− data/examples/import/*.hs
51+ , data/examples/import/*.hs
49− data/examples/module-header/*.hs
52+ , data/examples/module-header/*.hs
50− data/examples/other/*.hs
53+ , data/examples/other/*.hs
51−
52−extra-doc-files:
53− CONTRIBUTING.md
54− CHANGELOG.md
55− DESIGN.md
56− README.md
57
54
58source-repository head
55source-repository head
59− type: git
56+ type: git
60− location: https://github.com/tweag/ormolu.git
57+ location: https://github.com/tweag/ormolu.git
61
58
62flag dev
59flag dev
63− description: Turn on development settings.
60+ description: Turn on development settings.
64− default: False
65− manual: True
61+ manual: True
62+ default: False
66
63
67library
64library
65+ hs-source-dirs: src
66+ build-depends: base >= 4.12 && < 5.0
67+ , bytestring >= 0.2 && < 0.11
68+ , containers >= 0.5 && < 0.7
69+ , dlist >= 0.8 && < 0.9
70+ , exceptions >= 0.6 && < 0.11
71+ , ghc == 8.6.5
72+ , ghc-boot-th == 8.6.5
73+ , ghc-paths >= 0.1 && < 0.2
74+ , mtl >= 2.0 && < 3.0
75+ , syb >= 0.7 && < 0.8
76+ , text >= 0.2 && < 1.3
68− exposed-modules:
77+ exposed-modules: Ormolu
69− Ormolu
70− Ormolu.Config
78+ , Ormolu.Config
71− Ormolu.Diff
79+ , Ormolu.Diff
72− Ormolu.Exception
80+ , Ormolu.Exception
73− Ormolu.Imports
81+ , Ormolu.Imports
74− Ormolu.Parser
82+ , Ormolu.Parser
75− Ormolu.Parser.Anns
83+ , Ormolu.Parser.Anns
76− Ormolu.Parser.CommentStream
84+ , Ormolu.Parser.CommentStream
77− Ormolu.Parser.Pragma
85+ , Ormolu.Parser.Pragma
78− Ormolu.Parser.Result
86+ , Ormolu.Parser.Result
79− Ormolu.Parser.Shebang
80− Ormolu.Printer
87+ , Ormolu.Printer
81− Ormolu.Printer.Combinators
88+ , Ormolu.Printer.Combinators
82− Ormolu.Printer.Comments
89+ , Ormolu.Printer.Comments
83− Ormolu.Printer.Internal
90+ , Ormolu.Printer.Internal
84− Ormolu.Printer.Meat.Common
91+ , Ormolu.Printer.Meat.Common
85− Ormolu.Printer.Meat.Declaration
92+ , Ormolu.Printer.Meat.Declaration
86− Ormolu.Printer.Meat.Declaration.Annotation
93+ , Ormolu.Printer.Meat.Declaration.Annotation
87− Ormolu.Printer.Meat.Declaration.Class
94+ , Ormolu.Printer.Meat.Declaration.Class
88− Ormolu.Printer.Meat.Declaration.Data
95+ , Ormolu.Printer.Meat.Declaration.Data
89− Ormolu.Printer.Meat.Declaration.Default
96+ , Ormolu.Printer.Meat.Declaration.Default
90− Ormolu.Printer.Meat.Declaration.Foreign
97+ , Ormolu.Printer.Meat.Declaration.Foreign
91− Ormolu.Printer.Meat.Declaration.Instance
98+ , Ormolu.Printer.Meat.Declaration.Instance
92− Ormolu.Printer.Meat.Declaration.RoleAnnotation
99+ , Ormolu.Printer.Meat.Declaration.RoleAnnotation
93− Ormolu.Printer.Meat.Declaration.Rule
100+ , Ormolu.Printer.Meat.Declaration.Rule
94− Ormolu.Printer.Meat.Declaration.Signature
101+ , Ormolu.Printer.Meat.Declaration.Signature
95− Ormolu.Printer.Meat.Declaration.Splice
102+ , Ormolu.Printer.Meat.Declaration.Splice
96− Ormolu.Printer.Meat.Declaration.Type
103+ , Ormolu.Printer.Meat.Declaration.Type
97− Ormolu.Printer.Meat.Declaration.TypeFamily
104+ , Ormolu.Printer.Meat.Declaration.TypeFamily
98− Ormolu.Printer.Meat.Declaration.Value
105+ , Ormolu.Printer.Meat.Declaration.Value
99− Ormolu.Printer.Meat.Declaration.Warning
106+ , Ormolu.Printer.Meat.Declaration.Warning
100− Ormolu.Printer.Meat.ImportExport
107+ , Ormolu.Printer.Meat.ImportExport
101− Ormolu.Printer.Meat.Module
108+ , Ormolu.Printer.Meat.Module
102− Ormolu.Printer.Meat.Pragma
109+ , Ormolu.Printer.Meat.Pragma
103− Ormolu.Printer.Meat.Type
110+ , Ormolu.Printer.Meat.Type
104− Ormolu.Printer.Operators
111+ , Ormolu.Printer.Operators
105− Ormolu.Printer.SpanStream
112+ , Ormolu.Printer.SpanStream
106− Ormolu.Processing.Common
107− Ormolu.Processing.Cpp
108− Ormolu.Processing.Postprocess
109− Ormolu.Processing.Preprocess
110− Ormolu.Utils
113+ , Ormolu.Utils
111−
112− hs-source-dirs: src
113− other-modules:
114− GHC
115− GHC.DynFlags
116−
117− default-language: Haskell2010
118− build-depends:
119− base >=4.12 && <5.0,
120− bytestring >=0.2 && <0.11,
121− containers >=0.5 && <0.7,
122− dlist >=0.8 && <2.0,
123− exceptions >=0.6 && <0.11,
124− ghc-lib-parser >=8.10 && <8.11,
125− mtl >=2.0 && <3.0,
126− syb >=0.7 && <0.8,
127− text >=0.2 && <1.3
128−
129− if flag(dev)
114+ if flag(dev)
130− ghc-options:
115+ ghc-options: -Wall -Werror -Wcompat
131− -Wall -Werror -Wcompat -Wincomplete-record-updates
116+ -Wincomplete-record-updates
117+ -Wincomplete-uni-patterns
132− -Wincomplete-uni-patterns -Wnoncanonical-monad-instances
118+ -Wnoncanonical-monad-instances
133− -Wno-missing-home-modules
119+ -Wnoncanonical-monadfail-instances
134−
135− else
120+ else
136− ghc-options: -O2 -Wall
121+ ghc-options: -O2 -Wall
137−
138−executable ormolu
139− main-is: Main.hs
140− hs-source-dirs: app
141− other-modules: Paths_ormolu
142− default-language: Haskell2010
122+ default-language: Haskell2010
143− build-depends:
144− base >=4.12 && <5.0,
145− ghc-lib-parser >=8.10 && <8.11,
146− gitrev >=1.3 && <1.4,
147− optparse-applicative >=0.14 && <0.17,
148− ormolu -any,
149− text >=0.2 && <1.3
150−
151− if flag(dev)
152− ghc-options:
153− -Wall -Werror -Wcompat -Wincomplete-record-updates
154− -Wincomplete-uni-patterns -Wnoncanonical-monad-instances
155− -optP-Wno-nonportable-include-path
156−
157− else
158− ghc-options: -O2 -Wall -rtsopts
159
123
160test-suite tests
124test-suite tests
161− type: exitcode-stdio-1.0
162− main-is: Spec.hs
125+ main-is: Spec.hs
163− build-tools: hspec-discover >=2.0 && <3.0
164− hs-source-dirs: tests
126+ hs-source-dirs: tests
127+ type: exitcode-stdio-1.0
128+ build-depends: base >= 4.12 && < 5.0
129+ , containers >= 0.5 && < 0.7
130+ , filepath >= 1.2 && < 1.5
131+ , hspec >= 2.0 && < 3.0
132+ , ormolu
133+ , path >= 0.6 && < 0.7
134+ , path-io >= 1.4.2 && < 2.0
135+ , text >= 0.2 && < 1.3
136+ build-tools: hspec-discover >= 2.0 && < 3.0
165− other-modules:
137+ other-modules:
166− Ormolu.Parser.PragmaSpec
138+ Ormolu.Parser.PragmaSpec
167− Ormolu.PrinterSpec
139+ , Ormolu.PrinterSpec
168
140
141+ if flag(dev)
142+ ghc-options: -Wall -Werror
143+ else
144+ ghc-options: -O2 -Wall
169− default-language: Haskell2010
145+ default-language: Haskell2010
170− build-depends:
171− base >=4.12 && <5.0,
172− containers >=0.5 && <0.7,
173− filepath >=1.2 && <1.5,
174− hspec >=2.0 && <3.0,
175− ormolu -any,
176− path >=0.6 && <0.8,
177− path-io >=1.4.2 && <2.0,
178− text >=0.2 && <1.3
179
146
147+executable ormolu
148+ main-is: Main.hs
149+ hs-source-dirs: app
150+ build-depends: base >= 4.12 && < 5.0
151+ , ghc == 8.6.5
152+ , gitrev >= 1.3 && < 1.4
153+ , optparse-applicative >= 0.14 && < 0.15
154+ , ormolu
155+ , text >= 0.2 && < 1.3
156+ other-modules: Paths_ormolu
180− if flag(dev)
157+ if flag(dev)
181− ghc-options: -Wall -Werror
158+ ghc-options: -Wall -Werror -Wcompat
182−
159+ -Wincomplete-record-updates
160+ -Wincomplete-uni-patterns
161+ -Wnoncanonical-monad-instances
162+ -Wnoncanonical-monadfail-instances
183− else
163+ else
184− ghc-options: -O2 -Wall
164+ ghc-options: -O2 -Wall
165+ default-language: Haskell2010
region-tests/expected-result-17-18.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo (
4− foo, bar, baz) where
5−
6−foo :: Int
7−foo = 5
8−
9−bar :: Int -> Int
10−bar = \case
11− 0 -> foo
12− x -> x - foo
13−
14−baz :: Int -> Int
15−baz = gege
16− where
17− gege = 1 + 2
region-tests/expected-result-6-7.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo (
4− foo, bar, baz) where
5−
6−foo :: Int
7−foo = 5
8−
9−bar :: Int -> Int
10−bar = \case
11− 0 -> foo
12− x -> x - foo
13−
14−baz :: Int -> Int
15−baz = gege
16− where
17− gege = 1 + 2
region-tests/expected-result-6-8.hsdeleted−16
@@ -1,16 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo (
4− foo, bar, baz) where
5−
6−foo :: Int
7−foo = 5
8−bar :: Int -> Int
9−bar = \case
10− 0 -> foo
11− x -> x - foo
12−
13−baz :: Int -> Int
14−baz = gege
15− where
16− gege = 1 + 2
region-tests/expected-result-9-12.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo (
4− foo, bar, baz) where
5−
6−foo :: Int
7−foo = 5
8−
9−bar :: Int -> Int
10−bar = \case
11− 0 -> foo
12− x -> x - foo
13−
14−baz :: Int -> Int
15−baz = gege
16− where
17− gege = 1 + 2
region-tests/expected-result-all.hsdeleted−21
@@ -1,21 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo
4− ( foo,
5− bar,
6− baz,
7− )
8−where
9−
10−foo :: Int
11−foo = 5
12−
13−bar :: Int -> Int
14−bar = \case
15− 0 -> foo
16− x -> x - foo
17−
18−baz :: Int -> Int
19−baz = gege
20− where
21− gege = 1 + 2
region-tests/src.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo (
4− foo, bar, baz) where
5−
6−foo :: Int
7−foo = 5
8−
9−bar :: Int -> Int
10−bar = \case
11− 0 -> foo
12− x -> x - foo
13−
14−baz :: Int -> Int
15−baz = gege
16− where
17− gege = 1 + 2
shell.nix+2−4
@@ -1,5 +1,3 @@
1−{ pkgs ? (import ./nix/nixpkgs { inherit system; })
1+{ pkgs ? (import ./nix/nixpkgs) }:
2−, system ? builtins.currentSystem
3−}:
4
2
5−(import ./default.nix { inherit pkgs; }).dev.ormoluShell
3+(import ./default.nix { inherit pkgs; }).ormoluShell
src/GHC.hsdeleted−12
@@ -1,12 +0,0 @@
1−module GHC
2− ( module X,
3− )
4−where
5−
6−import ApiAnnotation as X
7−import BasicTypes as X
8−import GHC.Hs as X
9−import GHC.Hs.Instances as X ()
10−import Module as X
11−import RdrName as X
12−import SrcLoc as X
src/GHC/DynFlags.hsdeleted−49
@@ -1,49 +0,0 @@
1−{-# OPTIONS_GHC -Wno-missing-fields #-}
2−
3−-- Modified from ghc-lib-api-ext.
4−
5−module GHC.DynFlags
6− ( baseDynFlags,
7− )
8−where
9−
10−import Config
11−import DynFlags
12−import Fingerprint
13−import GHC.Platform
14−import ToolSettings
15−
16−fakeSettings :: Settings
17−fakeSettings =
18− Settings
19− { sGhcNameVersion =
20− GhcNameVersion
21− { ghcNameVersion_programName = "ghc",
22− ghcNameVersion_projectVersion = cProjectVersion
23− },
24− sFileSettings = FileSettings {},
25− sTargetPlatform =
26− Platform
27− { platformWordSize = PW8,
28− platformMini =
29− PlatformMini
30− { platformMini_arch = ArchUnknown,
31− platformMini_os = OSUnknown
32− },
33− platformUnregisterised = True
34− },
35− sPlatformMisc = PlatformMisc {},
36− sPlatformConstants =
37− PlatformConstants {pc_DYNAMIC_BY_DEFAULT = False, pc_WORD_SIZE = 8},
38− sToolSettings =
39− ToolSettings
40− { toolSettings_opt_P_fingerprint = fingerprint0,
41− toolSettings_pgm_F = ""
42− }
43− }
44−
45−fakeLlvmConfig :: LlvmConfig
46−fakeLlvmConfig = LlvmConfig [] []
47−
48−baseDynFlags :: DynFlags
49−baseDynFlags = defaultDynFlags fakeSettings fakeLlvmConfig
src/Ormolu.hs+62−69
@@ -1,25 +1,24 @@
1−{-# LANGUAGE BangPatterns #-}
2−
3-- | A formatter for Haskell source code.
1-- | A formatter for Haskell source code.
2+
3+{-# LANGUAGE BangPatterns #-}
4+{-# LANGUAGE RecordWildCards #-}
5+
4module Ormolu
6module Ormolu
5− ( ormolu,
7+ ( ormolu
6− ormoluFile,
8+ , ormoluFile
7− ormoluStdin,
9+ , ormoluStdin
8− Config (..),
10+ , Config (..)
9− RegionIndices (..),
10− defaultConfig,
11+ , defaultConfig
11− DynOption (..),
12+ , DynOption (..)
12− OrmoluException (..),
13+ , OrmoluException (..)
13− withPrettyOrmoluExceptions,
14+ , withPrettyOrmoluExceptions
14 )
15 )
15where
16where
16
17
17−import qualified CmdLineParser as GHC
18import Control.Exception
18import Control.Exception
19import Control.Monad
19import Control.Monad
20import Control.Monad.IO.Class (MonadIO (..))
20import Control.Monad.IO.Class (MonadIO (..))
21import Data.Text (Text)
21import Data.Text (Text)
22−import qualified Data.Text as T
23import Debug.Trace
22import Debug.Trace
24import Ormolu.Config
23import Ormolu.Config
25import Ormolu.Diff
24import Ormolu.Diff
@@ -28,6 +27,9 @@ import Ormolu.Parser
28import Ormolu.Parser.Result
27import Ormolu.Parser.Result
29import Ormolu.Printer
28import Ormolu.Printer
30import Ormolu.Utils (showOutputable)
29import Ormolu.Utils (showOutputable)
30+import System.IO (hGetContents, stdin)
31+import qualified CmdLineParser as GHC
32+import qualified Data.Text as T
31import qualified SrcLoc as GHC
33import qualified SrcLoc as GHC
32
34
33-- | Format a 'String', return formatted version as 'Text'.
35-- | Format a 'String', return formatted version as 'Text'.
@@ -40,30 +42,27 @@ import qualified SrcLoc as GHC
40-- side-effects though.
42-- side-effects though.
41-- * Takes file name just to use it in parse error messages.
43-- * Takes file name just to use it in parse error messages.
42-- * Throws 'OrmoluException'.
44-- * Throws 'OrmoluException'.
45+
43−ormolu ::
46+ormolu
44− MonadIO m =>
47+ :: MonadIO m
45− -- | Ormolu configuration
48+ => Config -- ^ Ormolu configuration
46− Config RegionIndices ->
47− -- | Location of source file
49+ -> FilePath -- ^ Location of source file
48− FilePath ->
49− -- | Input to format
50+ -> String -- ^ Input to format
50− String ->
51− m Text
51+ -> m Text
52−ormolu cfgWithIndices path str = do
52+ormolu cfg path str = do
53− let totalLines = length (lines str)
54− cfg = regionIndicesToDeltas totalLines <$> cfgWithIndices
55− (warnings, result0) <-
53+ (ws, result0) <-
56 parseModule' cfg OrmoluParsingFailed path str
54 parseModule' cfg OrmoluParsingFailed path str
57 when (cfgDebug cfg) $ do
55 when (cfgDebug cfg) $ do
58 traceM "warnings:\n"
56 traceM "warnings:\n"
59− traceM (concatMap showWarn warnings)
57+ traceM (concatMap showWarn ws)
60 traceM (prettyPrintParseResult result0)
58 traceM (prettyPrintParseResult result0)
61− -- We're forcing 'txt' here because otherwise errors (such as messages
59+ -- NOTE We're forcing 'txt' here because otherwise errors (such as
62− -- about not-yet-supported functionality) will be thrown later when we try
60+ -- messages about not-yet-supported functionality) will be thrown later
63− -- to parse the rendered code back, inside of GHC monad wrapper which will
61+ -- when we try to parse the rendered code back, inside of GHC monad
64− -- lead to error messages presenting the exceptions as GHC bugs.
62+ -- wrapper which will lead to error messages presenting the exceptions as
63+ -- GHC bugs.
65 let !txt = printModule result0
64 let !txt = printModule result0
66− when (not (cfgUnsafe cfg) || cfgCheckIdempotence cfg) $ do
65+ when (not (cfgUnsafe cfg) || cfgCheckIdempotency cfg) $ do
67 let pathRendered = path ++ "<rendered>"
66 let pathRendered = path ++ "<rendered>"
68 -- Parse the result of pretty-printing again and make sure that AST
67 -- Parse the result of pretty-printing again and make sure that AST
69 -- is the same as AST of original snippet module span positions.
68 -- is the same as AST of original snippet module span positions.
@@ -79,13 +78,12 @@ ormolu cfgWithIndices path str = do
79 Different ss -> liftIO $ throwIO (OrmoluASTDiffers path ss)
78 Different ss -> liftIO $ throwIO (OrmoluASTDiffers path ss)
80 -- Try re-formatting the formatted result to check if we get exactly
79 -- Try re-formatting the formatted result to check if we get exactly
81 -- the same output.
80 -- the same output.
82− when (cfgCheckIdempotence cfg) $
81+ when (cfgCheckIdempotency cfg) $
83 let txt2 = printModule result1
82 let txt2 = printModule result1
84 in case diffText txt txt2 pathRendered of
83 in case diffText txt txt2 pathRendered of
85 Nothing -> return ()
84 Nothing -> return ()
86− Just (loc, l, r) ->
85+ Just (loc, l, r) -> liftIO $
87− liftIO $
88− throwIO (OrmoluNonIdempotentOutput loc l r)
86+ throwIO (OrmoluNonIdempotentOutput loc l r)
89 return txt
87 return txt
90
88
91-- | Load a file and format it. The file stays intact and the rendered
89-- | Load a file and format it. The file stays intact and the rendered
@@ -93,14 +91,12 @@ ormolu cfgWithIndices path str = do
93--
91--
94-- > ormoluFile cfg path =
92-- > ormoluFile cfg path =
95-- > liftIO (readFile path) >>= ormolu cfg path
93-- > liftIO (readFile path) >>= ormolu cfg path
94+
96−ormoluFile ::
95+ormoluFile
97− MonadIO m =>
96+ :: MonadIO m
98− -- | Ormolu configuration
97+ => Config -- ^ Ormolu configuration
99− Config RegionIndices ->
100− -- | Location of source file
98+ -> FilePath -- ^ Location of source file
101− FilePath ->
102− -- | Resulting rendition
99+ -> m Text -- ^ Resulting rendition
103− m Text
104ormoluFile cfg path =
100ormoluFile cfg path =
105 liftIO (readFile path) >>= ormolu cfg path
101 liftIO (readFile path) >>= ormolu cfg path
106
102
@@ -108,40 +104,37 @@ ormoluFile cfg path =
108--
104--
109-- > ormoluStdin cfg =
105-- > ormoluStdin cfg =
110-- > liftIO (hGetContents stdin) >>= ormolu cfg "<stdin>"
106-- > liftIO (hGetContents stdin) >>= ormolu cfg "<stdin>"
107+
111−ormoluStdin ::
108+ormoluStdin
112− MonadIO m =>
109+ :: MonadIO m
113− -- | Ormolu configuration
110+ => Config -- ^ Ormolu configuration
114− Config RegionIndices ->
115− -- | Resulting rendition
111+ -> m Text -- ^ Resulting rendition
116− m Text
117ormoluStdin cfg =
112ormoluStdin cfg =
118− liftIO getContents >>= ormolu cfg "<stdin>"
113+ liftIO (hGetContents stdin) >>= ormolu cfg "<stdin>"
119
114
120----------------------------------------------------------------------------
115----------------------------------------------------------------------------
121-- Helpers
116-- Helpers
122
117
123-- | A wrapper around 'parseModule'.
118-- | A wrapper around 'parseModule'.
119+
124−parseModule' ::
120+parseModule'
125− MonadIO m =>
121+ :: MonadIO m
126− -- | Ormolu configuration
122+ => Config -- ^ Ormolu configuration
127− Config RegionDeltas ->
123+ -> (GHC.SrcSpan -> String -> OrmoluException)
128− -- | How to obtain 'OrmoluException' to throw when parsing fails
124+ -- ^ How to obtain 'OrmoluException' to throw when parsing fails
129− (GHC.SrcSpan -> String -> OrmoluException) ->
130− -- | File name to use in errors
125+ -> FilePath -- ^ File name to use in errors
131− FilePath ->
132− -- | Actual input for the parser
126+ -> String -- ^ Actual input for the parser
133− String ->
134− m ([GHC.Warn], ParseResult)
127+ -> m ([GHC.Warn], ParseResult)
135parseModule' cfg mkException path str = do
128parseModule' cfg mkException path str = do
136− (warnings, r) <- parseModule cfg path str
129+ (ws, r) <- parseModule cfg path str
137 case r of
130 case r of
138 Left (spn, err) -> liftIO $ throwIO (mkException spn err)
131 Left (spn, err) -> liftIO $ throwIO (mkException spn err)
139− Right x -> return (warnings, x)
132+ Right x -> return (ws, x)
140
133
141-- | Pretty-print a 'GHC.Warn'.
134-- | Pretty-print a 'GHC.Warn'.
135+
142showWarn :: GHC.Warn -> String
136showWarn :: GHC.Warn -> String
143−showWarn (GHC.Warn reason l) =
137+showWarn (GHC.Warn reason l) = unlines
144− unlines
145− [ showOutputable reason,
138+ [ showOutputable reason
146− showOutputable l
139+ , showOutputable l
147− ]
140+ ]
src/Ormolu/Config.hs+35−70
@@ -1,89 +1,54 @@
1−{-# LANGUAGE DeriveFunctor #-}
1+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2+{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
3
4
4-- | Configuration options used by the tool.
5-- | Configuration options used by the tool.
6+
5module Ormolu.Config
7module Ormolu.Config
6− ( Config (..),
8+ ( Config (..)
7− RegionIndices (..),
8− RegionDeltas (..),
9− defaultConfig,
9+ , defaultConfig
10− regionIndicesToDeltas,
11− DynOption (..),
10+ , DynOption (..)
12− dynOptionToLocatedStr,
11+ , dynOptionToLocatedStr
13 )
12 )
14where
13where
15
14
16import qualified SrcLoc as GHC
15import qualified SrcLoc as GHC
17
16
18-- | Ormolu configuration.
17-- | Ormolu configuration.
19−data Config region = Config
20− { -- | Dynamic options to pass to GHC parser
21− cfgDynOptions :: ![DynOption],
22− -- | Do formatting faster but without automatic detection of defects
23− cfgUnsafe :: !Bool,
24− -- | Output information useful for debugging
25− cfgDebug :: !Bool,
26− -- | Checks if re-formatting the result is idempotent
27− cfgCheckIdempotence :: !Bool,
28− -- | Region selection
29− cfgRegion :: !region
30− }
31− deriving (Eq, Show, Functor)
32
18
33−-- | Region selection as the combination of start and end line numbers.
19+data Config = Config
34−data RegionIndices = RegionIndices
20+ { cfgDynOptions :: ![DynOption]
35− { -- | Start line of the region to format
21+ -- ^ Dynamic options to pass to GHC parser
36− regionStartLine :: !(Maybe Int),
22+ , cfgUnsafe :: !Bool
37− -- | End line of the region to format
23+ -- ^ Do formatting faster but without automatic detection of defects
38− regionEndLine :: !(Maybe Int)
24+ , cfgDebug :: !Bool
25+ -- ^ Output information useful for debugging
26+ , cfgTolerateCpp :: !Bool
27+ -- ^ Do not fail if CPP pragma is present (still doesn't handle CPP but
28+ -- useful for formatting of files that enable the extension without
29+ -- actually containing CPP macros)
30+ , cfgCheckIdempotency :: !Bool
31+ -- ^ Checks if re-formatting the result is idempotent.
32+ } deriving (Eq, Show)
33+
34+-- | Default 'Config'.
35+
36+defaultConfig :: Config
37+defaultConfig = Config
38+ { cfgDynOptions = []
39+ , cfgUnsafe = False
40+ , cfgDebug = False
41+ , cfgTolerateCpp = False
42+ , cfgCheckIdempotency = False
39 }
43 }
40− deriving (Eq, Show)
41−
42−-- | Region selection as the length of the literal prefix and the literal
43−-- suffix.
44−data RegionDeltas = RegionDeltas
45− { -- | Prefix length in number of lines
46− regionPrefixLength :: !Int,
47− -- | Suffix length in number of lines
48− regionSuffixLength :: !Int
49− }
50− deriving (Eq, Show)
51−
52−-- | Default @'Config' 'RegionIndices'@.
53−defaultConfig :: Config RegionIndices
54−defaultConfig =
55− Config
56− { cfgDynOptions = [],
57− cfgUnsafe = False,
58− cfgDebug = False,
59− cfgCheckIdempotence = False,
60− cfgRegion =
61− RegionIndices
62− { regionStartLine = Nothing,
63− regionEndLine = Nothing
64− }
65− }
66−
67−-- | Convert 'RegionIndices' into 'RegionDeltas'.
68−regionIndicesToDeltas ::
69− -- | Total number of lines in the input
70− Int ->
71− -- | Region indices
72− RegionIndices ->
73− -- | Region deltas
74− RegionDeltas
75−regionIndicesToDeltas total RegionIndices {..} =
76− RegionDeltas
77− { regionPrefixLength = maybe 0 (subtract 1) regionStartLine,
78− regionSuffixLength = maybe 0 (total -) regionEndLine
79− }
80
44
81-- | A wrapper for dynamic options.
45-- | A wrapper for dynamic options.
46+
82newtype DynOption = DynOption
47newtype DynOption = DynOption
83 { unDynOption :: String
48 { unDynOption :: String
84− }
85− deriving (Eq, Ord, Show)
49+ } deriving (Eq, Ord, Show)
86
50
87-- | Convert 'DynOption' to @'GHC.Located' 'String'@.
51-- | Convert 'DynOption' to @'GHC.Located' 'String'@.
52+
88dynOptionToLocatedStr :: DynOption -> GHC.Located String
53dynOptionToLocatedStr :: DynOption -> GHC.Located String
89dynOptionToLocatedStr (DynOption o) = GHC.L GHC.noSrcSpan o
54dynOptionToLocatedStr (DynOption o) = GHC.L GHC.noSrcSpan o
src/Ormolu/Diff.hs+72−83
@@ -1,30 +1,33 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
1−{-# LANGUAGE RankNTypes #-}
2+{-# LANGUAGE RankNTypes #-}
3+{-# LANGUAGE RecordWildCards #-}
2
4
3-- | Diffing GHC ASTs modulo span positions.
5-- | Diffing GHC ASTs modulo span positions.
6+
4module Ormolu.Diff
7module Ormolu.Diff
5− ( Diff (..),
8+ ( Diff(..)
6− diffParseResult,
9+ , diffParseResult
7− diffText,
10+ , diffText
8 )
11 )
9where
12where
10
13
14+import BasicTypes (SourceText)
11import Data.ByteString (ByteString)
15import Data.ByteString (ByteString)
12import Data.Generics
16import Data.Generics
13import Data.Text (Text)
17import Data.Text (Text)
14−import qualified Data.Text as T
15−import qualified FastString as GHC
16import GHC
18import GHC
17−import Ormolu.Imports (normalizeImports)
19+import Ormolu.Imports (sortImports)
18−import Ormolu.Parser.CommentStream
19import Ormolu.Parser.Result
20import Ormolu.Parser.Result
20import Ormolu.Utils
21import Ormolu.Utils
22+import qualified Data.Text as T
23+import qualified FastString as GHC
24+import qualified SrcLoc as GHC
21
25
22-- | Result of comparing two 'ParseResult's.
26-- | Result of comparing two 'ParseResult's.
27+
23data Diff
28data Diff
24− = -- | Two parse results are the same
29+ = Same -- ^ Two parse results are the same
25− Same
26− | -- | Two parse results differ
27− Different [SrcSpan]
30+ | Different [SrcSpan] -- ^ Two parse results differ
28
31
29instance Semigroup Diff where
32instance Semigroup Diff where
30 Same <> a = a
33 Same <> a = a
@@ -35,69 +38,58 @@ instance Monoid Diff where
35 mempty = Same
38 mempty = Same
36
39
37-- | Return 'Diff' of two 'ParseResult's.
40-- | Return 'Diff' of two 'ParseResult's.
41+
38diffParseResult :: ParseResult -> ParseResult -> Diff
42diffParseResult :: ParseResult -> ParseResult -> Diff
39diffParseResult
43diffParseResult
40− ParseResult
41− { prCommentStream = cstream0,
44+ ParseResult { prCommentStream = cstream0
42− prParsedSource = hs0
45+ , prParsedSource = ps0
43− }
46+ }
44− ParseResult
45− { prCommentStream = cstream1,
47+ ParseResult { prCommentStream = cstream1
46− prParsedSource = hs1
48+ , prParsedSource = ps1
47− } =
49+ } =
48− matchIgnoringSrcSpans cstream0 cstream1
50+ matchIgnoringSrcSpans cstream0 cstream1 <>
49− <> matchIgnoringSrcSpans
51+ matchIgnoringSrcSpans ps0 ps1
50− hs0 {hsmodImports = normalizeImports (hsmodImports hs0)}
51− hs1 {hsmodImports = normalizeImports (hsmodImports hs1)}
52
52
53-- | Compare two values for equality disregarding differences in 'SrcSpan's
53-- | Compare two values for equality disregarding differences in 'SrcSpan's
54-- and the ordering of import lists.
54-- and the ordering of import lists.
55+
55matchIgnoringSrcSpans :: Data a => a -> a -> Diff
56matchIgnoringSrcSpans :: Data a => a -> a -> Diff
56matchIgnoringSrcSpans = genericQuery
57matchIgnoringSrcSpans = genericQuery
57 where
58 where
58 genericQuery :: GenericQ (GenericQ Diff)
59 genericQuery :: GenericQ (GenericQ Diff)
59 genericQuery x y
60 genericQuery x y
60− -- 'ByteString' implements 'Data' instance manually and does not
61+ -- NOTE 'ByteString' implement 'Data' instance manually and does not
61 -- implement 'toConstr', so we have to deal with it in a special way.
62 -- implement 'toConstr', so we have to deal with it in a special way.
62− | Just x' <- cast x,
63+ | Just x' <- cast x, Just y' <- cast y =
63− Just y' <- cast y =
64 if x' == (y' :: ByteString)
64 if x' == (y' :: ByteString)
65 then Same
65 then Same
66 else Different []
66 else Different []
67− | typeOf x == typeOf y,
68− toConstr x == toConstr y =
67+ | typeOf x == typeOf y, toConstr x == toConstr y =
69− mconcat $
70− gzipWithQ
68+ mconcat $ gzipWithQ
71− ( genericQuery
69+ (genericQuery
72− `extQ` srcSpanEq
70+ `extQ` srcSpanEq
73− `extQ` commentEq
71+ `extQ` hsModuleEq
74− `extQ` sourceTextEq
72+ `extQ` sourceTextEq
75− `extQ` hsDocStringEq
73+ `extQ` hsDocStringEq
76− `extQ` importDeclQualifiedStyleEq
77− `ext2Q` forLocated
74+ `ext2Q` forLocated)
78− )
79− x
75+ x y
80− y
81 | otherwise = Different []
76 | otherwise = Different []
77+
82 srcSpanEq :: SrcSpan -> GenericQ Diff
78 srcSpanEq :: SrcSpan -> GenericQ Diff
83 srcSpanEq _ _ = Same
79 srcSpanEq _ _ = Same
84− commentEq :: Comment -> GenericQ Diff
80+
85− commentEq (Comment _ x) d =
81+ hsModuleEq :: HsModule GhcPs -> GenericQ Diff
82+ hsModuleEq hs0 hs1' =
86− case cast d :: Maybe Comment of
83+ case cast hs1' :: Maybe (HsModule GhcPs) of
87 Nothing -> Different []
84 Nothing -> Different []
88− Just (Comment _ y) ->
85+ Just hs1 ->
89− if x == y
86+ matchIgnoringSrcSpans
90− then Same
87+ hs0 { hsmodImports = sortImports (hsmodImports hs0) }
91− else Different []
88+ hs1 { hsmodImports = sortImports (hsmodImports hs1) }
89+
92 sourceTextEq :: SourceText -> GenericQ Diff
90 sourceTextEq :: SourceText -> GenericQ Diff
93 sourceTextEq _ _ = Same
91 sourceTextEq _ _ = Same
94− importDeclQualifiedStyleEq :: ImportDeclQualifiedStyle -> GenericQ Diff
92+
95− importDeclQualifiedStyleEq d0 d1' =
96− case (d0, cast d1' :: Maybe ImportDeclQualifiedStyle) of
97− (x, Just x') | x == x' -> Same
98− (QualifiedPre, Just QualifiedPost) -> Same
99− (QualifiedPost, Just QualifiedPre) -> Same
100− _ -> Different []
101 hsDocStringEq :: HsDocString -> GenericQ Diff
93 hsDocStringEq :: HsDocString -> GenericQ Diff
102 hsDocStringEq str0 str1' =
94 hsDocStringEq str0 str1' =
103 case cast str1' :: Maybe HsDocString of
95 case cast str1' :: Maybe HsDocString of
@@ -106,52 +98,49 @@ matchIgnoringSrcSpans = genericQuery
106 if splitDocString str0 == splitDocString str1
98 if splitDocString str0 == splitDocString str1
107 then Same
99 then Same
108 else Different []
100 else Different []
101+
109− forLocated ::
102+ forLocated
110− (Data e0, Data e1) =>
103+ :: (Data e0, Data e1)
111− GenLocated e0 e1 ->
104+ => GenLocated e0 e1
112− GenericQ Diff
105+ -> GenericQ Diff
113 forLocated x@(L mspn _) y =
106 forLocated x@(L mspn _) y =
114 maybe id appendSpan (cast mspn) (genericQuery x y)
107 maybe id appendSpan (cast mspn) (genericQuery x y)
108+
115 appendSpan :: SrcSpan -> Diff -> Diff
109 appendSpan :: SrcSpan -> Diff -> Diff
116− appendSpan s (Different ss) | fresh && helpful = Different (s : ss)
110+ appendSpan s (Different ss) | fresh && helpful = Different (s:ss)
117 where
111 where
118− fresh = not $ any (`isSubspanOf` s) ss
112+ fresh = not $ any (flip isSubspanOf s) ss
119 helpful = isGoodSrcSpan s
113 helpful = isGoodSrcSpan s
120 appendSpan _ d = d
114 appendSpan _ d = d
121
115
122-- | Diff two texts and return the location they start to differ, alongside
116-- | Diff two texts and return the location they start to differ, alongside
123-- with excerpts around that location.
117-- with excerpts around that location.
118+
124−diffText ::
119+diffText
125− -- | Text before
120+ :: Text -- ^ Text before
126− Text ->
127− -- | Text after
121+ -> Text -- ^ Text after
128− Text ->
129− -- | Path to use to construct 'GHC.RealSrcLoc'
122+ -> FilePath -- ^ Path to use to construct 'GHC.RealSrcLoc'
130− FilePath ->
131− Maybe (GHC.RealSrcLoc, Text, Text)
123+ -> Maybe (GHC.RealSrcLoc, Text, Text)
132diffText left right fp =
124diffText left right fp =
133 case go (0, 0, 0) left right of
125 case go (0, 0, 0) left right of
134 Nothing -> Nothing
126 Nothing -> Nothing
135− Just (row, col, loc) ->
127+ Just (row, col, loc) -> Just (
136− Just
137− ( GHC.mkRealSrcLoc (GHC.mkFastString fp) row col,
128+ GHC.mkRealSrcLoc (GHC.mkFastString fp) row col,
138− getSpan loc left,
129+ getSpan loc left,
139− getSpan loc right
130+ getSpan loc right
140− )
131+ )
141 where
132 where
142− go (row, col, loc) t1 t2 =
133+ go (row, col, loc) t1 t2 =
143 case (T.uncons t1, T.uncons t2) of
134 case (T.uncons t1, T.uncons t2) of
144 -- both text empty, all good
135 -- both text empty, all good
145 (Nothing, Nothing) ->
136 (Nothing, Nothing) ->
146 Nothing
137 Nothing
147 -- first chars are the same, adjust position and recurse
138 -- first chars are the same, adjust position and recurse
148− (Just (c1, r1), Just (c2, r2))
139+ (Just (c1, r1), Just (c2, r2)) | c1 == c2 ->
149− | c1 == c2 ->
150− let (row', col', loc') =
140+ let (row', col', loc') = if c1 == '\n'
151− if c1 == '\n'
152− then (row + 1, 0, loc + 1)
141+ then (row + 1, 0, loc + 1)
153− else (row, col + 1, loc + 1)
142+ else (row, col + 1, loc + 1)
154− in go (row', col', loc') r1 r2
143+ in go (row', col', loc') r1 r2
155 -- something is different, return the position
144 -- something is different, return the position
156 _ ->
145 _ ->
157 Just (row, col, loc)
146 Just (row, col, loc)
src/Ormolu/Exception.hs+48−56
@@ -1,72 +1,65 @@
1{-# LANGUAGE LambdaCase #-}
1{-# LANGUAGE LambdaCase #-}
2
2
3-- | 'OrmoluException' type and surrounding definitions.
3-- | 'OrmoluException' type and surrounding definitions.
4+
4module Ormolu.Exception
5module Ormolu.Exception
5− ( OrmoluException (..),
6+ ( OrmoluException (..)
6− withPrettyOrmoluExceptions,
7+ , withPrettyOrmoluExceptions
7 )
8 )
8where
9where
9
10
10import Control.Exception
11import Control.Exception
11−import Data.List.NonEmpty (NonEmpty (..))
12−import qualified Data.List.NonEmpty as NE
13import Data.Text (Text)
12import Data.Text (Text)
14−import qualified GHC
15import Ormolu.Utils (showOutputable)
13import Ormolu.Utils (showOutputable)
16−import qualified Outputable as GHC
17import System.Exit (ExitCode (..), exitWith)
14import System.Exit (ExitCode (..), exitWith)
18import System.IO
15import System.IO
16+import qualified GHC
17+import qualified Outputable as GHC
19
18
20-- | Ormolu exception representing all cases when Ormolu can fail.
19-- | Ormolu exception representing all cases when Ormolu can fail.
20+
21data OrmoluException
21data OrmoluException
22+ = OrmoluCppEnabled FilePath
23+ -- ^ Ormolu does not work with source files that use CPP
24+ | OrmoluParsingFailed GHC.SrcSpan String
22− = -- | Parsing of original source code failed
25+ -- ^ Parsing of original source code failed
23− OrmoluParsingFailed GHC.SrcSpan String
26+ | OrmoluOutputParsingFailed GHC.SrcSpan String
24− | -- | Parsing of formatted source code failed
27+ -- ^ Parsing of formatted source code failed
25− OrmoluOutputParsingFailed GHC.SrcSpan String
28+ | OrmoluASTDiffers FilePath [GHC.SrcSpan]
26− | -- | Original and resulting ASTs differ
29+ -- ^ Original and resulting ASTs differ
27− OrmoluASTDiffers FilePath [GHC.SrcSpan]
30+ | OrmoluNonIdempotentOutput GHC.RealSrcLoc Text Text
28− | -- | Formatted source code is not idempotent
31+ -- ^ Formatted source code is not idempotent
29− OrmoluNonIdempotentOutput GHC.RealSrcLoc Text Text
30− | -- | Some GHC options were not recognized
31− OrmoluUnrecognizedOpts (NonEmpty String)
32 deriving (Eq, Show)
32 deriving (Eq, Show)
33
33
34instance Exception OrmoluException where
34instance Exception OrmoluException where
35 displayException = \case
35 displayException = \case
36+ OrmoluCppEnabled path -> unlines
37+ [ "CPP is not supported:"
38+ , withIndent path
39+ ]
36 OrmoluParsingFailed s e ->
40 OrmoluParsingFailed s e ->
37− showParsingErr "The GHC parser (in Haddock mode) failed:" s [e]
41+ showParsingErr "Parsing of source code failed:" s [e]
38 OrmoluOutputParsingFailed s e ->
42 OrmoluOutputParsingFailed s e ->
39− showParsingErr "Parsing of formatted code failed:" s [e]
43+ showParsingErr "Parsing of formatted code failed:" s [e] ++
40− ++ "Please, consider reporting the bug.\n"
44+ "Please, consider reporting the bug.\n"
41− OrmoluASTDiffers path ss ->
45+ OrmoluASTDiffers path ss -> unlines $
42− unlines $
43− [ "AST of input and AST of formatted code differ."
46+ [ "AST of input and AST of formatted code differ."
44− ]
47+ ]
45− ++ fmap
46− withIndent
47− ( case fmap (\s -> "at " ++ showOutputable s) ss of
48+ ++ (fmap withIndent $ case fmap (\s -> "at " ++ showOutputable s) ss of
48− [] -> ["in " ++ path]
49+ [] -> ["in " ++ path]
49− xs -> xs
50+ xs -> xs) ++
50− )
51− ++ ["Please, consider reporting the bug."]
51+ [ "Please, consider reporting the bug." ]
52 OrmoluNonIdempotentOutput loc left right ->
52 OrmoluNonIdempotentOutput loc left right ->
53− showParsingErr
54− "Formatting is not idempotent:"
53+ showParsingErr "Formatting is not idempotent:" loc
55− loc
56− ["before: " ++ show left, "after: " ++ show right]
54+ [ "before: " ++ show left , "after: " ++ show right ]
57 ++ "Please, consider reporting the bug.\n"
55 ++ "Please, consider reporting the bug.\n"
58− OrmoluUnrecognizedOpts opts ->
59− unlines
60− [ "The following GHC options were not recognized:",
61− (withIndent . unwords . NE.toList) opts
62− ]
63
56
64-- | Inside this wrapper 'OrmoluException' will be caught and displayed
57-- | Inside this wrapper 'OrmoluException' will be caught and displayed
65-- nicely using 'displayException'.
58-- nicely using 'displayException'.
59+
66−withPrettyOrmoluExceptions ::
60+withPrettyOrmoluExceptions
67− -- | Action that may throw the exception
61+ :: IO a -- ^ Action that may throw the exception
68− IO a ->
69− IO a
62+ -> IO a
70withPrettyOrmoluExceptions m = m `catch` h
63withPrettyOrmoluExceptions m = m `catch` h
71 where
64 where
72 h :: OrmoluException -> IO a
65 h :: OrmoluException -> IO a
@@ -74,26 +67,25 @@ withPrettyOrmoluExceptions m = m `catch` h
74 hPutStrLn stderr (displayException e)
67 hPutStrLn stderr (displayException e)
75 exitWith . ExitFailure $
68 exitWith . ExitFailure $
76 case e of
69 case e of
77− -- Error code 1 is for 'error' or 'notImplemented'
70+ -- Error code 1 is for `error` or `notImplemented`
78− -- 2 used to be for erroring out on CPP
71+ OrmoluCppEnabled _ -> 2
79− OrmoluParsingFailed {} -> 3
72+ OrmoluParsingFailed _ _ -> 3
80− OrmoluOutputParsingFailed {} -> 4
73+ OrmoluOutputParsingFailed _ _ -> 4
81− OrmoluASTDiffers {} -> 5
74+ OrmoluASTDiffers _ _ -> 5
82− OrmoluNonIdempotentOutput {} -> 6
75+ OrmoluNonIdempotentOutput _ _ _ -> 6
83− OrmoluUnrecognizedOpts {} -> 7
84
76
85----------------------------------------------------------------------------
77----------------------------------------------------------------------------
86-- Helpers
78-- Helpers
87
79
88-- | Show a parse error.
80-- | Show a parse error.
81+
89showParsingErr :: GHC.Outputable a => String -> a -> [String] -> String
82showParsingErr :: GHC.Outputable a => String -> a -> [String] -> String
90−showParsingErr msg spn err =
83+showParsingErr msg spn err = unlines $
91− unlines $
92− [ msg,
84+ [ msg
93− withIndent (showOutputable spn)
85+ , withIndent (showOutputable spn)
94− ]
95− ++ map withIndent err
86+ ] ++ map withIndent err
96
87
97-- | Indent with 2 spaces for readability.
88-- | Indent with 2 spaces for readability.
89+
98withIndent :: String -> String
90withIndent :: String -> String
99withIndent txt = " " ++ txt
91withIndent txt = " " ++ txt
src/Ormolu/Imports.hs+62−176
@@ -1,202 +1,88 @@
1{-# LANGUAGE LambdaCase #-}
1{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE RankNTypes #-}
2{-# LANGUAGE RankNTypes #-}
3−{-# LANGUAGE RecordWildCards #-}
4
3
5-- | Manipulations on import lists.
4-- | Manipulations on import lists.
5+
6module Ormolu.Imports
6module Ormolu.Imports
7− ( normalizeImports,
7+ ( sortImports
8 )
8 )
9where
9where
10
10
11import Data.Bifunctor
11import Data.Bifunctor
12−import Data.Char (isAlphaNum)
13import Data.Function (on)
12import Data.Function (on)
14−import Data.List (foldl', nubBy, sortBy, sortOn)
13+import Data.Generics (gcompare)
15−import Data.Map.Strict (Map)
14+import Data.List (sortBy)
16−import qualified Data.Map.Strict as M
17−import FastString (FastString)
18import GHC hiding (GhcPs, IE)
15import GHC hiding (GhcPs, IE)
19−import GHC.Hs.Extension
16+import HsExtension
20−import GHC.Hs.ImpExp (IE (..))
17+import HsImpExp (IE (..))
21−import Ormolu.Utils (notImplemented, showOutputable)
18+import Ormolu.Utils (notImplemented)
22−
19+
23−-- | Sort and normalize imports.
20+-- | Sort imports by module name. This also sorts explicit import lists for
24−normalizeImports :: [LImportDecl GhcPs] -> [LImportDecl GhcPs]
21+-- each declaration.
25−normalizeImports =
22+
26− fmap snd
27− . M.toAscList
28− . M.fromListWith combineImports
29− . fmap (\x -> (importId x, g x))
30− where
31− g (L l ImportDecl {..}) =
32− L
33− l
34− ImportDecl
35− { ideclHiding = second (fmap normalizeLies) <$> ideclHiding,
36− ..
37− }
38− g _ = notImplemented "XImportDecl"
39−
40−-- | Combine two import declarations. It should be assumed that 'ImportId's
41−-- are equal.
42−combineImports ::
43− LImportDecl GhcPs ->
44− LImportDecl GhcPs ->
45− LImportDecl GhcPs
46−combineImports (L lx ImportDecl {..}) (L _ y) =
47− L
48− lx
49− ImportDecl
50− { ideclHiding = case (ideclHiding, GHC.ideclHiding y) of
51− (Just (hiding, L l' xs), Just (_, L _ ys)) ->
52− Just (hiding, (L l' (normalizeLies (xs ++ ys))))
53− _ -> Nothing,
54− ..
55− }
56−combineImports _ _ = notImplemented "XImportDecl"
57−
58−-- | Import id, a collection of all things that justify having a separate
59−-- import entry. This is used for merging of imports. If two imports have
60−-- the same 'ImportId' they can be merged.
61−data ImportId = ImportId
62− { importIsPrelude :: Bool,
63− importIdName :: ModuleName,
64− importPkgQual :: Maybe FastString,
65− importSource :: Bool,
66− importSafe :: Bool,
67− importQualified :: Bool,
68− importImplicit :: Bool,
69− importAs :: Maybe ModuleName,
70− importHiding :: Maybe Bool
71− }
72− deriving (Eq, Ord)
73−
74−-- | Obtain an 'ImportId' for a given import.
75−importId :: LImportDecl GhcPs -> ImportId
23+sortImports :: [LImportDecl GhcPs] -> [LImportDecl GhcPs]
76−importId (L _ ImportDecl {..}) =
24+sortImports = sortBy compareIdecl . fmap (fmap sortImportLists)
77− ImportId
78− { importIsPrelude = isPrelude,
79− importIdName = moduleName,
80− importPkgQual = sl_fs <$> ideclPkgQual,
81− importSource = ideclSource,
82− importSafe = ideclSafe,
83− importQualified = case ideclQualified of
84− QualifiedPre -> True
85− QualifiedPost -> True
86− NotQualified -> False,
87− importImplicit = ideclImplicit,
88− importAs = unLoc <$> ideclAs,
89− importHiding = fst <$> ideclHiding
90− }
91 where
25 where
92− isPrelude = moduleNameString moduleName == "Prelude"
26+ sortImportLists :: ImportDecl GhcPs -> ImportDecl GhcPs
93− moduleName = unLoc ideclName
27+ sortImportLists decl =
94−importId _ = notImplemented "XImportDecl"
28+ decl { ideclHiding = second (fmap sortLies) <$> ideclHiding decl
29+ }
95
30
96−-- | Normalize a collection of import\/export items.
31+-- | Compare two @'LImportDecl' 'GhcPs'@ things.
97−normalizeLies :: [LIE GhcPs] -> [LIE GhcPs]
32+
98−normalizeLies = sortOn (getIewn . unLoc) . M.elems . foldl' combine M.empty
33+compareIdecl :: LImportDecl GhcPs -> LImportDecl GhcPs -> Ordering
34+compareIdecl (L _ m0) (L _ m1) =
35+ case (isPrelude n0, isPrelude n1) of
36+ (False, False) -> n0 `compare` n1
37+ (True, False) -> GT
38+ (False, True) -> LT
39+ (True, True) -> m0 `gcompare` m1
99 where
40 where
100− combine ::
41+ n0 = unLoc (ideclName m0)
101− Map IEWrappedNameOrd (LIE GhcPs) ->
42+ n1 = unLoc (ideclName m1)
102− LIE GhcPs ->
43+ isPrelude = (== "Prelude") . moduleNameString
103− Map IEWrappedNameOrd (LIE GhcPs)
44+
104− combine m (L new_l new) =
45+-- | Sort located import or export.
105− let wname = getIewn new
46+
106− normalizeWNames =
47+sortLies :: [LIE GhcPs] -> [LIE GhcPs]
107− nubBy (\x y -> compareLIewn x y == EQ) . sortBy compareLIewn
48+sortLies = sortBy (compareIE `on` unLoc) . fmap (fmap sortThings)
108− alter = \case
49+
109− Nothing -> Just . L new_l $
50+-- | Sort imports\/exports inside of 'IEThingWith'.
110− case new of
51+
111− IEThingWith NoExtField n wildcard g flbl ->
52+sortThings :: IE GhcPs -> IE GhcPs
112− IEThingWith NoExtField n wildcard (normalizeWNames g) flbl
53+sortThings = \case
113− other -> other
54+ IEThingWith NoExt x w xs fl ->
114− Just old ->
55+ IEThingWith NoExt x w (sortBy (compareIewn `on` unLoc) xs) fl
115− let f = \case
56+ other -> other
116− IEVar NoExtField n -> IEVar NoExtField n
57+
117− IEThingAbs NoExtField _ -> new
58+-- | Compare two located imports or exports.
118− IEThingAll NoExtField n -> IEThingAll NoExtField n
59+
119− IEThingWith NoExtField n wildcard g flbl ->
60+compareIE :: IE GhcPs -> IE GhcPs -> Ordering
120− case new of
61+compareIE = compareIewn `on` getIewn
121− IEVar NoExtField _ ->
122− error "Ormolu.Imports broken presupposition"
123− IEThingAbs NoExtField _ ->
124− IEThingWith NoExtField n wildcard g flbl
125− IEThingAll NoExtField n' ->
126− IEThingAll NoExtField n'
127− IEThingWith NoExtField n' wildcard' g' flbl' ->
128− let combinedWildcard =
129− case (wildcard, wildcard') of
130− (IEWildcard _, _) -> IEWildcard 0
131− (_, IEWildcard _) -> IEWildcard 0
132− _ -> NoIEWildcard
133− in IEThingWith
134− NoExtField
135− n'
136− combinedWildcard
137− (normalizeWNames (g <> g'))
138− flbl'
139− IEModuleContents NoExtField _ -> notImplemented "IEModuleContents"
140− IEGroup NoExtField _ _ -> notImplemented "IEGroup"
141− IEDoc NoExtField _ -> notImplemented "IEDoc"
142− IEDocNamed NoExtField _ -> notImplemented "IEDocNamed"
143− XIE x -> noExtCon x
144− IEModuleContents NoExtField _ -> notImplemented "IEModuleContents"
145− IEGroup NoExtField _ _ -> notImplemented "IEGroup"
146− IEDoc NoExtField _ -> notImplemented "IEDoc"
147− IEDocNamed NoExtField _ -> notImplemented "IEDocNamed"
148− XIE x -> noExtCon x
149− in Just (f <$> old)
150− in M.alter alter wname m
151−
152−-- | A wrapper for @'IEWrappedName' 'RdrName'@ that allows us to define an
153−-- 'Ord' instance for it.
154−newtype IEWrappedNameOrd = IEWrappedNameOrd (IEWrappedName RdrName)
155− deriving (Eq)
156−
157−instance Ord IEWrappedNameOrd where
158− compare (IEWrappedNameOrd x) (IEWrappedNameOrd y) = compareIewn x y
159
62
160-- | Project @'IEWrappedName' 'RdrName'@ from @'IE' 'GhcPs'@.
63-- | Project @'IEWrappedName' 'RdrName'@ from @'IE' 'GhcPs'@.
64+
161−getIewn :: IE GhcPs -> IEWrappedNameOrd
65+getIewn :: IE GhcPs -> IEWrappedName RdrName
162getIewn = \case
66getIewn = \case
163− IEVar NoExtField x -> IEWrappedNameOrd (unLoc x)
67+ IEVar NoExt x -> unLoc x
164− IEThingAbs NoExtField x -> IEWrappedNameOrd (unLoc x)
68+ IEThingAbs NoExt x -> unLoc x
165− IEThingAll NoExtField x -> IEWrappedNameOrd (unLoc x)
69+ IEThingAll NoExt x -> unLoc x
166− IEThingWith NoExtField x _ _ _ -> IEWrappedNameOrd (unLoc x)
70+ IEThingWith NoExt x _ _ _ -> unLoc x
167− IEModuleContents NoExtField _ -> notImplemented "IEModuleContents"
71+ IEModuleContents NoExt _ -> notImplemented "IEModuleContents"
168− IEGroup NoExtField _ _ -> notImplemented "IEGroup"
72+ IEGroup NoExt _ _ -> notImplemented "IEGroup"
169− IEDoc NoExtField _ -> notImplemented "IEDoc"
73+ IEDoc NoExt _ -> notImplemented "IEDoc"
170− IEDocNamed NoExtField _ -> notImplemented "IEDocNamed"
74+ IEDocNamed NoExt _ -> notImplemented "IEDocNamed"
171− XIE x -> noExtCon x
75+ XIE NoExt -> notImplemented "XIE"
172−
173−-- | Like 'compareIewn' for located wrapped names.
174−compareLIewn :: LIEWrappedName RdrName -> LIEWrappedName RdrName -> Ordering
175−compareLIewn = compareIewn `on` unLoc
176
76
177-- | Compare two @'IEWrapppedName' 'RdrName'@ things.
77-- | Compare two @'IEWrapppedName' 'RdrName'@ things.
78+
178compareIewn :: IEWrappedName RdrName -> IEWrappedName RdrName -> Ordering
79compareIewn :: IEWrappedName RdrName -> IEWrappedName RdrName -> Ordering
179−compareIewn (IEName x) (IEName y) = unLoc x `compareRdrName` unLoc y
80+compareIewn (IEName x) (IEName y) = unLoc x `compare` unLoc y
180compareIewn (IEName _) (IEPattern _) = LT
81compareIewn (IEName _) (IEPattern _) = LT
181compareIewn (IEName _) (IEType _) = LT
82compareIewn (IEName _) (IEType _) = LT
182compareIewn (IEPattern _) (IEName _) = GT
83compareIewn (IEPattern _) (IEName _) = GT
183−compareIewn (IEPattern x) (IEPattern y) = unLoc x `compareRdrName` unLoc y
84+compareIewn (IEPattern x) (IEPattern y) = unLoc x `compare` unLoc y
184compareIewn (IEPattern _) (IEType _) = LT
85compareIewn (IEPattern _) (IEType _) = LT
185compareIewn (IEType _) (IEName _) = GT
86compareIewn (IEType _) (IEName _) = GT
186compareIewn (IEType _) (IEPattern _) = GT
87compareIewn (IEType _) (IEPattern _) = GT
187−compareIewn (IEType x) (IEType y) = unLoc x `compareRdrName` unLoc y
88+compareIewn (IEType x) (IEType y) = unLoc x `compare` unLoc y
188−
189−compareRdrName :: RdrName -> RdrName -> Ordering
190−compareRdrName x y =
191− case (getNameStr x, getNameStr y) of
192− ([], []) -> EQ
193− ((_ : _), []) -> GT
194− ([], (_ : _)) -> LT
195− ((x' : _), (y' : _)) ->
196− case (isAlphaNum x', isAlphaNum y') of
197− (False, False) -> x `compare` y
198− (True, False) -> LT
199− (False, True) -> GT
200− (True, True) -> x `compare` y
201− where
202− getNameStr = showOutputable . rdrNameOcc
src/Ormolu/Parser.hs+159−183
@@ -1,219 +1,195 @@
1−{-# LANGUAGE LambdaCase #-}
2−{-# LANGUAGE RecordWildCards #-}
1+{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE StandaloneDeriving #-}
3{-# OPTIONS_GHC -fno-warn-orphans #-}
3{-# OPTIONS_GHC -fno-warn-orphans #-}
4
4
5-- | Parser for Haskell source code.
5-- | Parser for Haskell source code.
6+
6module Ormolu.Parser
7module Ormolu.Parser
7− ( parseModule,
8+ ( parseModule
8− manualExts,
9+ , manualExts
9 )
10 )
10where
11where
11
12
12−import Bag (bagToList)
13−import qualified CmdLineParser as GHC
14import Control.Exception
13import Control.Exception
14+import Control.Monad
15import Control.Monad.IO.Class
15import Control.Monad.IO.Class
16−import qualified Data.List as L
16+import Data.List (isPrefixOf, foldl', (\\))
17−import qualified Data.List.NonEmpty as NE
18−import Data.Ord (Down (Down))
19−import qualified Data.Text as T
17+import Data.Maybe (catMaybes)
20−import DynFlags as GHC
21−import ErrUtils (Severity (..), errMsgSeverity, errMsgSpan)
22−import qualified FastString as GHC
23−import GHC hiding (IE, UnicodeSyntax)
18+import GHC hiding (IE, parseModule, parser)
24−import GHC.DynFlags (baseDynFlags)
25import GHC.LanguageExtensions.Type (Extension (..))
19import GHC.LanguageExtensions.Type (Extension (..))
26−import qualified HeaderInfo as GHC
20+import GHC.Paths (libdir)
27−import qualified HscTypes as GHC
28−import qualified Lexer as GHC
29import Ormolu.Config
21import Ormolu.Config
30import Ormolu.Exception
22import Ormolu.Exception
31import Ormolu.Parser.Anns
23import Ormolu.Parser.Anns
32import Ormolu.Parser.CommentStream
24import Ormolu.Parser.CommentStream
33import Ormolu.Parser.Result
25import Ormolu.Parser.Result
34−import Ormolu.Processing.Preprocess (preprocess)
26+import qualified CmdLineParser as GHC
35−import Ormolu.Utils (incSpanLine, removeIndentation)
27+import qualified DynFlags as GHC
36−import qualified Panic as GHC
28+import qualified FastString as GHC
29+import qualified HeaderInfo as GHC
30+import qualified Lexer as GHC
31+import qualified Outputable as GHC
37import qualified Parser as GHC
32import qualified Parser as GHC
33+import qualified SrcLoc as GHC
38import qualified StringBuffer as GHC
34import qualified StringBuffer as GHC
39
35
40-- | Parse a complete module from string.
36-- | Parse a complete module from string.
41−parseModule ::
42− MonadIO m =>
43− -- | Ormolu configuration
44− Config RegionDeltas ->
45− -- | File name (only for source location annotations)
46− FilePath ->
47− -- | Input for parser
48− String ->
49− m
50− ( [GHC.Warn],
51− Either (SrcSpan, String) ParseResult
52− )
53−parseModule Config {..} path rawInput = liftIO $ do
54− let (literalPrefix, indentedInput, literalSuffix, extraComments) =
55− preprocess path rawInput cfgRegion
56− (input, indent) = removeIndentation indentedInput
57− -- It's important that 'setDefaultExts' is done before
58− -- 'parsePragmasIntoDynFlags', because otherwise we might enable an
59− -- extension that was explicitly disabled in the file.
60− let baseFlags =
61− GHC.setGeneralFlag'
62− GHC.Opt_Haddock
63− (setDefaultExts baseDynFlags)
64− extraOpts = dynOptionToLocatedStr <$> cfgDynOptions
65− (warnings, dynFlags) <-
66− parsePragmasIntoDynFlags baseFlags extraOpts path rawInput >>= \case
67− Right res -> pure res
68− Left err ->
69− let loc =
70− mkSrcSpan
71− (mkSrcLoc (GHC.mkFastString path) 1 1)
72− (mkSrcLoc (GHC.mkFastString path) 1 1)
73− in throwIO (OrmoluParsingFailed loc err)
74− let useRecordDot =
75− "record-dot-preprocessor" == pgm_F dynFlags
76− || any
77− (("RecordDotPreprocessor" ==) . moduleNameString)
78− (pluginModNames dynFlags)
79− pStateErrors = \pstate ->
80− let errs = bagToList $ GHC.getErrorMessages pstate dynFlags
81− fixupErrSpan = incSpanLine (regionPrefixLength cfgRegion)
82− in case L.sortOn (Down . SeverityOrd . errMsgSeverity) errs of
83− [] -> Nothing
84− err : _ ->
85− -- Show instance returns a short error message
86− Just (fixupErrSpan (errMsgSpan err), show err)
87− r = case runParser GHC.parseModule dynFlags path input of
88− GHC.PFailed pstate ->
89− case pStateErrors pstate of
90− Just err -> Left err
91− Nothing -> error "PFailed does not have an error"
92− GHC.POk pstate (L _ hsModule) ->
93− case pStateErrors pstate of
94− -- Some parse errors (pattern/arrow syntax in expr context)
95− -- do not cause a parse error, but they are replaced with "_"
96− -- by the parser and the modified AST is propagated to the
97− -- later stages; but we fail in those cases.
98− Just err -> Left err
99− Nothing ->
100− let (stackHeader, shebangs, pragmas, comments) =
101− mkCommentStream input extraComments pstate
102− in Right
103− ParseResult
104− { prParsedSource = hsModule,
105− prAnns = mkAnns pstate,
106− prStackHeader = stackHeader,
107− prShebangs = shebangs,
108− prPragmas = pragmas,
109− prCommentStream = comments,
110− prUseRecordDot = useRecordDot,
111− prImportQualifiedPost =
112− GHC.xopt ImportQualifiedPost dynFlags,
113− prLiteralPrefix = T.pack literalPrefix,
114− prLiteralSuffix = T.pack literalSuffix,
115− prIndent = indent
116− }
117− return (warnings, r)
118
37
119−-- | Enable all language extensions that we think should be enabled by
38+parseModule
120−-- default for ease of use.
39+ :: MonadIO m
121−setDefaultExts :: DynFlags -> DynFlags
40+ => Config -- ^ Ormolu configuration
122−setDefaultExts flags = L.foldl' xopt_set flags autoExts
41+ -> FilePath -- ^ File name (only for source location annotations)
123− where
42+ -> String -- ^ Input for parser
124− autoExts = allExts L.\\ manualExts
43+ -> m ( [GHC.Warn]
125− allExts = [minBound .. maxBound]
44+ , Either (SrcSpan, String) ParseResult
45+ )
46+parseModule Config {..} path input' = liftIO $ do
47+ let (input, extraComments) = stripLinePragmas path input'
48+ (ws, dynFlags) <- ghcWrapper $ do
49+ dynFlags0 <- initDynFlagsPure path input
50+ (dynFlags1, _, ws) <- GHC.parseDynamicFilePragma
51+ dynFlags0
52+ (dynOptionToLocatedStr <$> cfgDynOptions)
53+ return (ws, GHC.setGeneralFlag' GHC.Opt_Haddock dynFlags1)
54+ -- NOTE It's better to throw this outside of 'ghcWrapper' because
55+ -- otherwise the exception will be wrapped as a GHC panic, which we don't
56+ -- want.
57+ when (GHC.xopt Cpp dynFlags && not cfgTolerateCpp) $
58+ throwIO (OrmoluCppEnabled path)
59+ let r = case runParser GHC.parseModule dynFlags path input of
60+ GHC.PFailed _ ss m ->
61+ Left (ss, GHC.showSDoc dynFlags m)
62+ GHC.POk pstate pmod ->
63+ let (comments, exts) = mkCommentStream extraComments pstate
64+ in Right ParseResult
65+ { prParsedSource = pmod
66+ , prAnns = mkAnns pstate
67+ , prCommentStream = comments
68+ , prExtensions = exts
69+ }
70+ return (ws, r)
126
71
127-- | Extensions that are not enabled automatically and should be activated
72-- | Extensions that are not enabled automatically and should be activated
128-- by user.
73-- by user.
74+
129manualExts :: [Extension]
75manualExts :: [Extension]
130manualExts =
76manualExts =
131− [ Arrows, -- steals proc
77+ [ Arrows -- steals proc
132− Cpp, -- forbidden
78+ , Cpp -- forbidden
133− BangPatterns, -- makes certain patterns with ! fail
79+ , BangPatterns -- makes certain patterns with ! fail
134− PatternSynonyms, -- steals the pattern keyword
80+ , PatternSynonyms -- steals the pattern keyword
135− RecursiveDo, -- steals the rec keyword
81+ , RecursiveDo -- steals the rec keyword
136− StaticPointers, -- steals static keyword
82+ , StaticPointers -- steals static keyword
137− TransformListComp, -- steals the group keyword
83+ , TransformListComp -- steals the group keyword
138− UnboxedTuples, -- breaks (#) lens operator
84+ , UnboxedTuples -- breaks (#) lens operator
139− MagicHash, -- screws {-# these things #-}
85+ , MagicHash -- screws {-# these things #-}
140− TypeApplications, -- steals (@) operator on some cases
86+ , TypeApplications -- steals (@) operator on some cases
141− AlternativeLayoutRule,
87+ , AlternativeLayoutRule
142− AlternativeLayoutRuleTransitional,
88+ , AlternativeLayoutRuleTransitional
143− MonadComprehensions,
89+ , MonadComprehensions
144− UnboxedSums,
90+ , UnboxedSums
145− UnicodeSyntax, -- gives special meanings to operators like (→)
91+ , UnicodeSyntax -- gives special meanings to operators like (→)
146− TemplateHaskellQuotes, -- enables TH subset of quasi-quotes, this
92+ , TemplateHaskellQuotes -- enables TH subset of quasi-quotes, this
147− -- apparently interferes with QuasiQuotes in
93+ -- apparently interferes with QuasiQuotes in
148− -- weird ways
94+ -- weird ways
149− ImportQualifiedPost -- affects how Ormolu renders imports, so the
150− -- decision of enabling this style is left to the user
151 ]
95 ]
152
96
97+----------------------------------------------------------------------------
98+-- Helpers (taken from ghc-exactprint)
99+
100+-- | Requires GhcMonad constraint because there is no pure variant of
101+-- 'parseDynamicFilePragma'. Yet, in constrast to 'initDynFlags', it does
102+-- not (try to) read the file at filepath, but solely depends on the module
103+-- source in the input string.
104+--
105+-- Passes "-hide-all-packages" to the GHC API to prevent parsing of package
106+-- environment files. However this only works if there is no invocation of
107+-- 'setSessionDynFlags' before calling 'initDynFlagsPure'. See GHC tickets
108+-- #15513, #15541.
109+
110+initDynFlagsPure
111+ :: GHC.GhcMonad m
112+ => FilePath -- ^ Module path
113+ -> String -- ^ Module contents
114+ -> m GHC.DynFlags -- ^ Dynamic flags for that module
115+initDynFlagsPure fp input = do
116+ -- I was told we could get away with using the 'unsafeGlobalDynFlags'. as
117+ -- long as 'parseDynamicFilePragma' is impure there seems to be no reason
118+ -- to use it.
119+ dflags0 <- setDefaultExts <$> GHC.getSessionDynFlags
120+ let tokens = GHC.getOptions dflags0 (GHC.stringToStringBuffer input) fp
121+ (dflags1, _, _) <- GHC.parseDynamicFilePragma dflags0 tokens
122+ -- Turn this on last to avoid T10942
123+ let dflags2 = dflags1 `GHC.gopt_set` GHC.Opt_KeepRawTokenStream
124+ -- Prevent parsing of .ghc.environment.* "package environment files"
125+ (dflags3, _, _) <- GHC.parseDynamicFlagsCmdLine
126+ dflags2
127+ [GHC.noLoc "-hide-all-packages"]
128+ _ <- GHC.setSessionDynFlags dflags3
129+ return dflags3
130+
131+-- | Default runner of 'GHC.Ghc' action in 'IO'.
132+
133+ghcWrapper :: GHC.Ghc a -> IO a
134+ghcWrapper act =
135+ let GHC.FlushOut flushOut = GHC.defaultFlushOut
136+ in GHC.runGhc (Just libdir) act
137+ `finally` flushOut
138+
153-- | Run a 'GHC.P' computation.
139-- | Run a 'GHC.P' computation.
140+
154−runParser ::
141+runParser
155− -- | Computation to run
142+ :: GHC.P a -- ^ Computation to run
156− GHC.P a ->
157− -- | Dynamic flags
143+ -> GHC.DynFlags -- ^ Dynamic flags
158− GHC.DynFlags ->
159− -- | Module path
160− FilePath ->
144+ -> FilePath -- ^ Module path
161− -- | Module contents
162− String ->
145+ -> String -- ^ Module contents
163− -- | Parse result
146+ -> GHC.ParseResult a -- ^ Parse result
164− GHC.ParseResult a
165runParser parser flags filename input = GHC.unP parser parseState
147runParser parser flags filename input = GHC.unP parser parseState
166 where
148 where
167 location = GHC.mkRealSrcLoc (GHC.mkFastString filename) 1 1
149 location = GHC.mkRealSrcLoc (GHC.mkFastString filename) 1 1
168 buffer = GHC.stringToStringBuffer input
150 buffer = GHC.stringToStringBuffer input
169 parseState = GHC.mkPState flags buffer location
151 parseState = GHC.mkPState flags buffer location
170
152
171−-- | Wrap GHC's 'Severity' to add 'Ord' instance.
153+-- | Remove GHC style line pragams (@{-# LINE .. #-}@) and convert them into
172−newtype SeverityOrd = SeverityOrd Severity
154+-- comments.
173−
174−instance Eq SeverityOrd where
175− s1 == s2 = compare s1 s2 == EQ
176−
177−instance Ord SeverityOrd where
178− compare (SeverityOrd s1) (SeverityOrd s2) =
179− compare (f s1) (f s2)
180− where
181− f :: Severity -> Int
182− f SevOutput = 1
183− f SevFatal = 2
184− f SevInteractive = 3
185− f SevDump = 4
186− f SevInfo = 5
187− f SevWarning = 6
188− f SevError = 7
189
155
190−----------------------------------------------------------------------------
156+stripLinePragmas :: FilePath -> String -> (String, [Located String])
191−-- Helpers taken from HLint
157+stripLinePragmas path = unlines' . unzip . findLines path . lines
192−
158+ where
193−parsePragmasIntoDynFlags ::
159+ unlines' (a, b) = (unlines a, catMaybes b)
194− -- | Pre-set 'DynFlags'
160+
195− DynFlags ->
161+findLines :: FilePath -> [String] -> [(String, Maybe (Located String))]
196− -- | Extra options (provided by user)
162+findLines path = zipWith (checkLine path) [1..]
197− [Located String] ->
163+
198− -- | File name (only for source location annotations)
164+checkLine :: FilePath -> Int -> String -> (String, Maybe (Located String))
199− FilePath ->
165+checkLine path line s
200− -- | Input for parser
166+ | "{-# LINE" `isPrefixOf` s =
201− String ->
167+ let (pragma, res) = getPragma s
202− IO (Either String ([GHC.Warn], DynFlags))
168+ size = length pragma
203−parsePragmasIntoDynFlags flags extraOpts filepath str =
169+ ss = mkSrcSpan (mkSrcLoc' 1) (mkSrcLoc' (size + 1))
204− catchErrors $ do
170+ in (res, Just $ L ss pragma)
205− let opts = GHC.getOptions flags (GHC.stringToStringBuffer str) filepath
171+ | "#!" `isPrefixOf` s =
206− (flags', leftovers, warnings) <-
172+ let ss = mkSrcSpan (mkSrcLoc' 1) (mkSrcLoc' (length s))
207− parseDynamicFilePragma flags (opts <> extraOpts)
173+ in ("",Just $ L ss s)
208− case NE.nonEmpty leftovers of
209− Nothing -> return ()
174+ | otherwise = (s, Nothing)
210− Just unrecognizedOpts ->
211− throwIO (OrmoluUnrecognizedOpts (unLoc <$> unrecognizedOpts))
212− let flags'' = flags' `gopt_set` Opt_KeepRawTokenStream
213− return $ Right (warnings, flags'')
214 where
175 where
215− catchErrors act =
176+ mkSrcLoc' = mkSrcLoc (GHC.mkFastString path) line
216− GHC.handleGhcException
177+
217− reportErr
178+getPragma :: String -> (String, String)
218− (GHC.handleSourceError reportErr act)
179+getPragma [] = error "Ormolu.Parser.getPragma: input must not be empty"
219− reportErr e = return $ Left (show e)
180+getPragma s@(x:xs)
181+ | "#-}" `isPrefixOf` s = ("#-}", " " ++ drop 3 s)
182+ | otherwise =
183+ let (prag, remline) = getPragma xs
184+ in (x:prag, ' ':remline)
185+
186+-- | Enable all language extensions that we think should be enabled by
187+-- default for ease of use.
188+
189+setDefaultExts :: DynFlags -> DynFlags
190+setDefaultExts flags = foldl' GHC.xopt_set flags autoExts
191+ where
192+ autoExts = allExts \\ manualExts
193+ allExts = [minBound..maxBound]
194+
195+deriving instance Bounded Extension
src/Ormolu/Parser/Anns.hs+20−18
@@ -1,34 +1,37 @@
1-- | Ormolu-specific representation of GHC annotations.
1-- | Ormolu-specific representation of GHC annotations.
2+
2module Ormolu.Parser.Anns
3module Ormolu.Parser.Anns
3− ( Anns (..),
4+ ( Anns (..)
4− emptyAnns,
5+ , emptyAnns
5− mkAnns,
6+ , mkAnns
6− lookupAnns,
7+ , lookupAnns
7 )
8 )
8where
9where
9
10
10import Data.Map.Strict (Map)
11import Data.Map.Strict (Map)
11−import qualified Data.Map.Strict as M
12import Data.Maybe (mapMaybe)
12import Data.Maybe (mapMaybe)
13+import SrcLoc
14+import qualified Data.Map.Strict as M
13import qualified GHC
15import qualified GHC
14import qualified Lexer as GHC
16import qualified Lexer as GHC
15−import SrcLoc
16
17
17-- | Ormolu-specific representation of GHC annotations.
18-- | Ormolu-specific representation of GHC annotations.
19+
18newtype Anns = Anns (Map RealSrcSpan [GHC.AnnKeywordId])
20newtype Anns = Anns (Map RealSrcSpan [GHC.AnnKeywordId])
19 deriving (Eq)
21 deriving (Eq)
20
22
21-- | Empty 'Anns'.
23-- | Empty 'Anns'.
24+
22emptyAnns :: Anns
25emptyAnns :: Anns
23emptyAnns = Anns M.empty
26emptyAnns = Anns M.empty
24
27
25-- | Create 'Anns' from 'GHC.PState'.
28-- | Create 'Anns' from 'GHC.PState'.
29+
26−mkAnns ::
30+mkAnns
27− GHC.PState ->
31+ :: GHC.PState
28− Anns
32+ -> Anns
29−mkAnns pstate =
33+mkAnns pstate = Anns $
30− Anns $
31− M.fromListWith (++) (mapMaybe f (GHC.annotations pstate))
34+ M.fromListWith (++) (mapMaybe f (GHC.annotations pstate))
32 where
35 where
33 f ((spn, kid), _) =
36 f ((spn, kid), _) =
34 case spn of
37 case spn of
@@ -36,11 +39,10 @@ mkAnns pstate =
36 UnhelpfulSpan _ -> Nothing
39 UnhelpfulSpan _ -> Nothing
37
40
38-- | Lookup 'GHC.AnnKeywordId's corresponding to a given 'SrcSpan'.
41-- | Lookup 'GHC.AnnKeywordId's corresponding to a given 'SrcSpan'.
42+
39−lookupAnns ::
43+lookupAnns
40− -- | Span to lookup with
44+ :: SrcSpan -- ^ Span to lookup with
41− SrcSpan ->
42− -- | Collection of annotations
45+ -> Anns -- ^ Collection of annotations
43− Anns ->
44− [GHC.AnnKeywordId]
46+ -> [GHC.AnnKeywordId]
45lookupAnns (RealSrcSpan rspn) (Anns m) = M.findWithDefault [] rspn m
47lookupAnns (RealSrcSpan rspn) (Anns m) = M.findWithDefault [] rspn m
46lookupAnns (UnhelpfulSpan _) _ = []
48lookupAnns (UnhelpfulSpan _) _ = []
src/Ormolu/Parser/CommentStream.hs+87−171
@@ -1,200 +1,116 @@
1+{-# LANGUAGE BangPatterns #-}
1−{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE DeriveDataTypeable #-}
2{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3−{-# LANGUAGE LambdaCase #-}
4+{-# LANGUAGE LambdaCase #-}
5+{-# LANGUAGE TupleSections #-}
4
6
5-- | Functions for working with comment stream.
7-- | Functions for working with comment stream.
8+
6module Ormolu.Parser.CommentStream
9module Ormolu.Parser.CommentStream
7− ( -- * Comment stream
8− CommentStream (..),
10+ ( CommentStream (..)
11+ , Comment (..)
9− mkCommentStream,
12+ , mkCommentStream
13+ , isPrevHaddock
14+ , isMultilineComment
10− showCommentStream,
15+ , showCommentStream
11−
12− -- * Comment
13− Comment (..),
14− unComment,
15− hasAtomsBefore,
16− isMultilineComment,
17 )
16 )
18where
17where
19
18
20import Data.Char (isSpace)
19import Data.Char (isSpace)
21import Data.Data (Data)
20import Data.Data (Data)
22−import qualified Data.List as L
21+import Data.Either (partitionEithers)
22+import Data.List (isPrefixOf, sortOn, dropWhileEnd)
23import Data.List.NonEmpty (NonEmpty (..))
23import Data.List.NonEmpty (NonEmpty (..))
24−import qualified Data.List.NonEmpty as NE
25import Data.Maybe (mapMaybe)
24import Data.Maybe (mapMaybe)
26−import qualified GHC
27−import qualified Lexer as GHC
28import Ormolu.Parser.Pragma
25import Ormolu.Parser.Pragma
29−import Ormolu.Parser.Shebang
30−import Ormolu.Processing.Common
31−import Ormolu.Utils (onTheSameLine, showOutputable)
26+import Ormolu.Utils (showOutputable)
32import SrcLoc
27import SrcLoc
33−
28+import qualified Data.List.NonEmpty as NE
34−----------------------------------------------------------------------------
29+import qualified GHC
35−-- Comment stream
30+import qualified Lexer as GHC
36
31
37-- | A stream of 'RealLocated' 'Comment's in ascending order with respect to
32-- | A stream of 'RealLocated' 'Comment's in ascending order with respect to
38-- beginning of corresponding spans.
33-- beginning of corresponding spans.
34+
39newtype CommentStream = CommentStream [RealLocated Comment]
35newtype CommentStream = CommentStream [RealLocated Comment]
40 deriving (Eq, Data, Semigroup, Monoid)
36 deriving (Eq, Data, Semigroup, Monoid)
41
37
38+-- | A wrapper for a single comment. The 'NonEmpty' list inside contains
39+-- lines of multiline comment @{- … -}@ or just single item\/line otherwise.
40+
41+newtype Comment = Comment (NonEmpty String)
42+ deriving (Eq, Show, Data)
43+
42−-- | Create 'CommentStream' from 'GHC.PState'. The pragmas and shebangs are
44+-- | Create 'CommentStream' from 'GHC.PState'. We also create a 'Set' of
45+-- extensions here, which is not sorted in any way. The pragma comment are
43−-- removed from the 'CommentStream'. Shebangs are only extracted from the
46+-- removed from the 'CommentStream'.
44−-- comments that come from the first argument.
47+
45−mkCommentStream ::
48+mkCommentStream
46− -- | Original input
47− String ->
48− -- | Extra comments to include
49+ :: [Located String] -- ^ Extra comments to include
49− [Located String] ->
50− -- | Parser state to use for comment extraction
50+ -> GHC.PState -- ^ Parser state to use for comment extraction
51− GHC.PState ->
51+ -> (CommentStream, [Pragma])
52− -- | Stack header, shebangs, pragmas, and comment stream
52+ -- ^ Comment stream and a set of extracted pragmas
53− ( Maybe (RealLocated Comment),
54− [Shebang],
55− [([RealLocated Comment], Pragma)],
56− CommentStream
57− )
58−mkCommentStream input extraComments pstate =
53+mkCommentStream extraComments pstate =
59− ( mstackHeader,
54+ ( CommentStream $
60− shebangs,
55+ -- NOTE It's easier to normalize pragmas right when we construct comment
61− pragmas,
56+ -- streams. Because this way we need to do it only once and when we
62− CommentStream comments
57+ -- perform checking later they'll automatically match.
58+ mkComment <$> sortOn (realSrcSpanStart . getLoc) comments
59+ , pragmas
63 )
60 )
64 where
61 where
65− (comments, pragmas) = extractPragmas input rawComments1
62+ (comments, pragmas) = partitionEithers (partitionComments <$> rawComments)
66− (rawComments1, mstackHeader) = extractStackHeader rawComments0
67− rawComments0 =
68− L.sortOn (realSrcSpanStart . getRealSrcSpan) . mapMaybe toRealSpan $
63+ rawComments = mapMaybe toRealSpan $
69− otherExtraComments
64+ extraComments ++
70− ++ mapMaybe (liftMaybe . fmap unAnnotationComment) (GHC.comment_q pstate)
65+ mapMaybe (liftMaybe . fmap unAnnotationComment) (GHC.comment_q pstate) ++
71− ++ concatMap
72− (mapMaybe (liftMaybe . fmap unAnnotationComment) . snd)
66+ concatMap (mapMaybe (liftMaybe . fmap unAnnotationComment) . snd)
73− (GHC.annotations_comments pstate)
67+ (GHC.annotations_comments pstate)
74− (shebangs, otherExtraComments) = extractShebangs extraComments
68+
69+-- | Test whether a 'Comment' looks like a Haddock following a definition,
70+-- i.e. something starting with @-- ^@.
71+
72+isPrevHaddock :: Comment -> Bool
73+isPrevHaddock (Comment (x :| _)) = "-- ^" `isPrefixOf` x
74+
75+-- | Is this comment multiline-style?
76+
77+isMultilineComment :: Comment -> Bool
78+isMultilineComment (Comment (x :| _)) = "{-" `isPrefixOf` x
75
79
76-- | Pretty-print a 'CommentStream'.
80-- | Pretty-print a 'CommentStream'.
81+
77showCommentStream :: CommentStream -> String
82showCommentStream :: CommentStream -> String
78−showCommentStream (CommentStream xs) =
83+showCommentStream (CommentStream xs) = unlines $
79− unlines $
80− showComment <$> xs
84+ showComment <$> xs
81 where
85 where
82 showComment (GHC.L l str) = showOutputable l ++ " " ++ show str
86 showComment (GHC.L l str) = showOutputable l ++ " " ++ show str
83
87
84----------------------------------------------------------------------------
88----------------------------------------------------------------------------
85−-- Comment
89+-- Helpers
86−
87−-- | A wrapper for a single comment. The 'Bool' indicates whether there were
88−-- atoms before beginning of the comment in the original input. The
89−-- 'NonEmpty' list inside contains lines of multiline comment @{- … -}@ or
90−-- just single item\/line otherwise.
91−data Comment = Comment Bool (NonEmpty String)
92− deriving (Eq, Show, Data)
93
90
94-- | Normalize comment string. Sometimes one multi-line comment is turned
91-- | Normalize comment string. Sometimes one multi-line comment is turned
95-- into several lines for subsequent outputting with correct indentation for
92-- into several lines for subsequent outputting with correct indentation for
96-- each line.
93-- each line.
97−mkComment ::
98− -- | Lines of original input with their indices
99− [(Int, String)] ->
100− -- | Raw comment string
101− RealLocated String ->
102− -- | Remaining lines of original input and the constructed 'Comment'
103− ([(Int, String)], RealLocated Comment)
104−mkComment ls (L l s) = (ls', comment)
105− where
106− comment =
107− L l . Comment atomsBefore . removeConseqBlanks . fmap dropTrailing $
108− if "{-" `L.isPrefixOf` s
109− then case NE.nonEmpty (lines s) of
110− Nothing -> s :| []
111− Just (x :| xs) ->
112− let getIndent y =
113− if all isSpace y || y == endDisabling
114− then startIndent
115− else length (takeWhile isSpace y)
116− n = minimum (startIndent : fmap getIndent xs)
117− removeIndent y =
118− if y == endDisabling
119− then y
120− else drop n y
121− in x :| (removeIndent <$> xs)
122− else s :| []
123− (atomsBefore, ls') =
124− case dropWhile ((< commentLine) . fst) ls of
125− [] -> (False, [])
126− ((_, i) : ls'') ->
127− case take 2 (dropWhile isSpace i) of
128− "--" -> (False, ls'')
129− "{-" -> (False, ls'')
130− _ -> (True, ls'')
131− dropTrailing = L.dropWhileEnd isSpace
132− startIndent = srcSpanStartCol l - 1
133− commentLine = srcSpanStartLine l
134−
135−-- | Get a collection of lines from a 'Comment'.
136−unComment :: Comment -> NonEmpty String
137−unComment (Comment _ xs) = xs
138−
139−-- | Check whether the 'Comment' had some non-whitespace atoms in front of
140−-- it in the original input.
141−hasAtomsBefore :: Comment -> Bool
142−hasAtomsBefore (Comment atomsBefore _) = atomsBefore
143
94
144−-- | Is this comment multiline-style?
95+mkComment :: RealLocated String -> RealLocated Comment
145−isMultilineComment :: Comment -> Bool
96+mkComment (L l s) = L l . Comment . fmap dropTrailing $
146−isMultilineComment (Comment _ (x :| _)) = "{-" `L.isPrefixOf` x
97+ if "{-" `isPrefixOf` s
147−
98+ then case NE.nonEmpty (lines s) of
148−----------------------------------------------------------------------------
99+ Nothing -> s :| []
149−-- Helpers
150−
151−-- | Detect and extract stack header if it is present.
152−extractStackHeader ::
153− -- | Comment stream to analyze
154− [RealLocated String] ->
155− ([RealLocated String], Maybe (RealLocated Comment))
156−extractStackHeader = \case
157− [] -> ([], Nothing)
158− (x : xs) ->
100+ Just (x:|xs) ->
159− let comment = snd (mkComment [] x)
101+ let getIndent y =
160− in if isStackHeader (unRealSrcSpan comment)
102+ if all isSpace y
161− then (xs, Just comment)
103+ then startIndent
162− else (x : xs, Nothing)
104+ else length (takeWhile isSpace y)
163− where
105+ n = minimum (startIndent : fmap getIndent xs)
164− isStackHeader (Comment _ (x :| _)) =
106+ in x :| (drop n <$> xs)
165− "stack" `L.isPrefixOf` dropWhile isSpace (drop 2 x)
107+ else s :| []
166−
167−-- | Extract pragmas and their associated comments.
168−extractPragmas ::
169− -- | Input
170− String ->
171− -- | Comment stream to analyze
172− [RealLocated String] ->
173− ([RealLocated Comment], [([RealLocated Comment], Pragma)])
174−extractPragmas input = go initialLs id id
175 where
108 where
176− initialLs = zip [1 ..] (lines input)
109+ dropTrailing = dropWhileEnd isSpace
177− go ls csSoFar pragmasSoFar = \case
110+ startIndent = srcSpanStartCol l - 1
178− [] -> (csSoFar [], pragmasSoFar [])
179− (x : xs) ->
180− case parsePragma (unRealSrcSpan x) of
181− Nothing ->
182− let (ls', x') = mkComment ls x
183− in go ls' (csSoFar . (x' :)) pragmasSoFar xs
184− Just pragma ->
185− let combined ys = (csSoFar ys, pragma)
186− go' ls' ys rest = go ls' id (pragmasSoFar . (combined ys :)) rest
187− in case xs of
188− [] -> go' ls [] xs
189− (y : ys) ->
190− let (ls', y') = mkComment ls y
191− in if onTheSameLine
192− (RealSrcSpan (getRealSrcSpan x))
193− (RealSrcSpan (getRealSrcSpan y))
194− then go' ls' [y'] ys
195− else go' ls [] xs
196
111
197-- | Get a 'String' from 'GHC.AnnotationComment'.
112-- | Get a 'String' from 'GHC.AnnotationComment'.
113+
198unAnnotationComment :: GHC.AnnotationComment -> Maybe String
114unAnnotationComment :: GHC.AnnotationComment -> Maybe String
199unAnnotationComment = \case
115unAnnotationComment = \case
200 GHC.AnnDocCommentNext _ -> Nothing -- @-- |@
116 GHC.AnnDocCommentNext _ -> Nothing -- @-- |@
@@ -214,13 +130,13 @@ toRealSpan :: Located a -> Maybe (RealLocated a)
214toRealSpan (L (RealSrcSpan l) a) = Just (L l a)
130toRealSpan (L (RealSrcSpan l) a) = Just (L l a)
215toRealSpan _ = Nothing
131toRealSpan _ = Nothing
216
132
217−-- | Remove consecutive blank lines.
133+-- | If a given comment is a pragma, return it in parsed form in 'Right'.
218−removeConseqBlanks :: NonEmpty String -> NonEmpty String
134+-- Otherwise return the original comment unchanged.
219−removeConseqBlanks (x :| xs) = x :| go (null x) id xs
135+
220− where
136+partitionComments
221− go seenBlank acc = \case
137+ :: RealLocated String
222− [] -> acc []
138+ -> Either (RealLocated String) Pragma
223− (y : ys) ->
139+partitionComments input =
224− if seenBlank && null y
140+ case parsePragma (unLoc input) of
225− then go True acc ys
141+ Nothing -> Left input
226− else go (null y) (acc . (y :)) ys
142+ Just pragma -> Right pragma
src/Ormolu/Parser/Pragma.hs+33−34
@@ -1,42 +1,41 @@
1+-- | A module for parsing of pragmas from comments.
2+
1−{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
4{-# LANGUAGE OverloadedStrings #-}
3
5
4−-- | A module for parsing of pragmas from comments.
5module Ormolu.Parser.Pragma
6module Ormolu.Parser.Pragma
6− ( Pragma (..),
7+ ( Pragma (..)
7− parsePragma,
8+ , parsePragma
8 )
9 )
9where
10where
10
11
11import Control.Monad
12import Control.Monad
12−import Data.Char (isSpace, toLower)
13+import Data.Char (toLower, isSpace)
13−import qualified Data.List as L
14+import Data.List
14−import qualified EnumSet as ES
15import FastString (mkFastString, unpackFS)
15import FastString (mkFastString, unpackFS)
16−import qualified Lexer as L
17−import Module (ComponentId (..), newSimpleUnitId)
16+import Module (newSimpleUnitId, ComponentId (..))
18import SrcLoc
17import SrcLoc
19import StringBuffer
18import StringBuffer
19+import qualified EnumSet as ES
20+import qualified Lexer as L
20
21
21-- | Ormolu's representation of pragmas.
22-- | Ormolu's representation of pragmas.
23+
22data Pragma
24data Pragma
23− = -- | Language pragma
24− PragmaLanguage [String]
25+ = PragmaLanguage [String] -- ^ Language pragma
25− | -- | GHC options pragma
26+ | PragmaOptionsGHC String -- ^ GHC options pragma
26− PragmaOptionsGHC String
27− | -- | Haddock options pragma
28− PragmaOptionsHaddock String
27+ | PragmaOptionsHaddock String -- ^ Haddock options pragma
29 deriving (Show, Eq)
28 deriving (Show, Eq)
30
29
31-- | Extract a pragma from a comment if possible, or return 'Nothing'
30-- | Extract a pragma from a comment if possible, or return 'Nothing'
32-- otherwise.
31-- otherwise.
32+
33−parsePragma ::
33+parsePragma
34− -- | Comment to try to parse
34+ :: String -- ^ Comment to try to parse
35− String ->
36− Maybe Pragma
35+ -> Maybe Pragma
37parsePragma input = do
36parsePragma input = do
38− inputNoPrefix <- L.stripPrefix "{-#" input
37+ inputNoPrefix <- stripPrefix "{-#" input
39− guard ("#-}" `L.isSuffixOf` input)
38+ guard ("#-}" `isSuffixOf` input)
40 let contents = take (length inputNoPrefix - 3) inputNoPrefix
39 let contents = take (length inputNoPrefix - 3) inputNoPrefix
41 (pragmaName, cs) = (break isSpace . dropWhile isSpace) contents
40 (pragmaName, cs) = (break isSpace . dropWhile isSpace) contents
42 case toLower <$> pragmaName of
41 case toLower <$> pragmaName of
@@ -46,19 +45,21 @@ parsePragma input = do
46 _ -> Nothing
45 _ -> Nothing
47 where
46 where
48 trimSpaces :: String -> String
47 trimSpaces :: String -> String
49− trimSpaces = L.dropWhileEnd isSpace . dropWhile isSpace
48+ trimSpaces = dropWhileEnd isSpace . dropWhile isSpace
50
49
51-- | Assuming the input consists of a series of tokens from a language
50-- | Assuming the input consists of a series of tokens from a language
52-- pragma, return the set of enabled extensions.
51-- pragma, return the set of enabled extensions.
52+
53−parseExtensions :: String -> Maybe [String]
53+parseExtensions :: String -> Maybe [String]
54parseExtensions str = tokenize str >>= go
54parseExtensions str = tokenize str >>= go
55 where
55 where
56 go = \case
56 go = \case
57− [L.ITconid ext] -> return [unpackFS ext]
57+ (L.ITconid ext : []) -> return [unpackFS ext]
58 (L.ITconid ext : L.ITcomma : xs) -> (unpackFS ext :) <$> go xs
58 (L.ITconid ext : L.ITcomma : xs) -> (unpackFS ext :) <$> go xs
59 _ -> Nothing
59 _ -> Nothing
60
60
61-- | Tokenize a given input using GHC's lexer.
61-- | Tokenize a given input using GHC's lexer.
62+
62tokenize :: String -> Maybe [L.Token]
63tokenize :: String -> Maybe [L.Token]
63tokenize input =
64tokenize input =
64 case L.unP pLexer parseState of
65 case L.unP pLexer parseState of
@@ -68,17 +69,15 @@ tokenize input =
68 location = mkRealSrcLoc (mkFastString "") 1 1
69 location = mkRealSrcLoc (mkFastString "") 1 1
69 buffer = stringToStringBuffer input
70 buffer = stringToStringBuffer input
70 parseState = L.mkPStatePure parserFlags buffer location
71 parseState = L.mkPStatePure parserFlags buffer location
71− parserFlags =
72+ parserFlags = L.ParserFlags
72− L.mkParserFlags'
73− ES.empty
73+ { L.pWarningFlags = ES.empty
74− ES.empty
74+ , L.pExtensionFlags = ES.empty
75− (newSimpleUnitId (ComponentId (mkFastString "")))
75+ , L.pThisPackage = newSimpleUnitId (ComponentId (mkFastString ""))
76− True
76+ , L.pExtsBitmap = 0xffffffffffffffff
77− True
77+ }
78− True
79− True
80
78
81-- | Haskell lexer.
79-- | Haskell lexer.
80+
82pLexer :: L.P [L.Token]
81pLexer :: L.P [L.Token]
83pLexer = go
82pLexer = go
84 where
83 where
@@ -86,4 +85,4 @@ pLexer = go
86 r <- L.lexer False return
85 r <- L.lexer False return
87 case unLoc r of
86 case unLoc r of
88 L.ITeof -> return []
87 L.ITeof -> return []
89− x -> (x :) <$> go
88+ x -> (x:) <$> go
src/Ormolu/Parser/Result.hs+20−34
@@ -1,51 +1,37 @@
1+-- | A type for result of parsing.
2+
1{-# LANGUAGE RecordWildCards #-}
3{-# LANGUAGE RecordWildCards #-}
2
4
3−-- | A type for result of parsing.
4module Ormolu.Parser.Result
5module Ormolu.Parser.Result
5− ( ParseResult (..),
6+ ( ParseResult (..)
6− prettyPrintParseResult,
7+ , prettyPrintParseResult
7 )
8 )
8where
9where
9
10
10−import Data.Text (Text)
11import GHC
11import GHC
12import Ormolu.Parser.Anns
12import Ormolu.Parser.Anns
13import Ormolu.Parser.CommentStream
13import Ormolu.Parser.CommentStream
14import Ormolu.Parser.Pragma (Pragma)
14import Ormolu.Parser.Pragma (Pragma)
15−import Ormolu.Parser.Shebang (Shebang)
16
15
17-- | A collection of data that represents a parsed module in Ormolu.
16-- | A collection of data that represents a parsed module in Ormolu.
17+
18data ParseResult = ParseResult
18data ParseResult = ParseResult
19+ { prParsedSource :: ParsedSource
19− { -- | 'ParsedSource' from GHC
20+ -- ^ 'ParsedSource' from GHC
20− prParsedSource :: HsModule GhcPs,
21+ , prAnns :: Anns
21− -- | Ormolu-specfic representation of annotations
22+ -- ^ Ormolu-specfic representation of annotations
22− prAnns :: Anns,
23− -- | Stack header
24− prStackHeader :: Maybe (RealLocated Comment),
25− -- | Shebangs found in the input
26− prShebangs :: [Shebang],
27− -- | Pragmas and the associated comments
28− prPragmas :: [([RealLocated Comment], Pragma)],
29− -- | Comment stream
30− prCommentStream :: CommentStream,
23+ , prCommentStream :: CommentStream
31− -- | Whether or not record dot syntax is enabled
24+ -- ^ Comment stream
32− prUseRecordDot :: Bool,
25+ , prExtensions :: [Pragma]
33− -- | Whether or not ImportQualifiedPost is enabled
26+ -- ^ Extensions enabled in that module
34− prImportQualifiedPost :: Bool,
35− -- | Literal prefix
36− prLiteralPrefix :: Text,
37− -- | Literal suffix
38− prLiteralSuffix :: Text,
39− -- | Indentation level, can be non-zero in case of region formatting
40− prIndent :: Int
41 }
27 }
42
28
43-- | Pretty-print a 'ParseResult'.
29-- | Pretty-print a 'ParseResult'.
30+
44prettyPrintParseResult :: ParseResult -> String
31prettyPrintParseResult :: ParseResult -> String
45−prettyPrintParseResult ParseResult {..} =
32+prettyPrintParseResult ParseResult {..} = unlines
46− unlines
47− [ "parse result:",
33+ [ "parse result:"
48− " comment stream:",
34+ , " comment stream:"
49− showCommentStream prCommentStream
35+ , showCommentStream prCommentStream
50− -- XXX extend as needed
36+ -- XXX extend as needed
51− ]
37+ ]
src/Ormolu/Parser/Shebang.hsdeleted−27
@@ -1,27 +0,0 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−
3−-- | A module for dealing with shebangs.
4−module Ormolu.Parser.Shebang
5− ( Shebang (..),
6− extractShebangs,
7− isShebang,
8− )
9−where
10−
11−import Data.Data (Data)
12−import qualified Data.List as L
13−import SrcLoc
14−
15−-- | A wrapper for a shebang.
16−newtype Shebang = Shebang (Located String)
17− deriving (Eq, Data)
18−
19−-- | Extract shebangs from the beginning of a comment stream.
20−extractShebangs :: [Located String] -> ([Shebang], [Located String])
21−extractShebangs comments = (Shebang <$> shebangs, rest)
22− where
23− (shebangs, rest) = span (isShebang . unLoc) comments
24−
25−-- | Return 'True' if given 'String' is a shebang.
26−isShebang :: String -> Bool
27−isShebang str = "#!" `L.isPrefixOf` str
src/Ormolu/Printer.hs+13−24
@@ -1,8 +1,11 @@
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE OverloadedStrings #-}
1−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
2
4
3-- | Pretty-printer for Haskell AST.
5-- | Pretty-printer for Haskell AST.
6+
4module Ormolu.Printer
7module Ormolu.Printer
5− ( printModule,
8+ ( printModule
6 )
9 )
7where
10where
8
11
@@ -11,28 +14,14 @@ import Ormolu.Parser.Result
11import Ormolu.Printer.Combinators
14import Ormolu.Printer.Combinators
12import Ormolu.Printer.Meat.Module
15import Ormolu.Printer.Meat.Module
13import Ormolu.Printer.SpanStream
16import Ormolu.Printer.SpanStream
14−import Ormolu.Processing.Postprocess (postprocess)
15
17
16-- | Render a module.
18-- | Render a module.
19+
17−printModule ::
20+printModule
18− -- | Result of parsing
21+ :: ParseResult -- ^ Result of parsing
19− ParseResult ->
20− -- | Resulting rendition
22+ -> Text -- ^ Resulting rendition
21− Text
22printModule ParseResult {..} =
23printModule ParseResult {..} =
23− prLiteralPrefix <> region <> prLiteralSuffix
24− where
25− region =
26− postprocess prIndent $
27− runR
28− ( p_hsModule
29− prStackHeader
30− prShebangs
31− prPragmas
32− prImportQualifiedPost
33− prParsedSource
24+ runR (p_hsModule prExtensions prParsedSource)
34− )
35− (mkSpanStream prParsedSource)
25+ (mkSpanStream prParsedSource)
36− prCommentStream
26+ prCommentStream
37− prAnns
27+ prAnns
38− prUseRecordDot
src/Ormolu/Printer/Combinators.hs+122−138
@@ -1,113 +1,104 @@
1−{-# LANGUAGE FlexibleContexts #-}
2−{-# LANGUAGE GADTs #-}
3−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
4{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
5
4
6-- | Printing combinators. The definitions here are presented in such an
5-- | Printing combinators. The definitions here are presented in such an
7-- order so you can just go through the Haddocks and by the end of the file
6-- order so you can just go through the Haddocks and by the end of the file
8-- you should have a pretty good idea how to program rendering logic.
7-- you should have a pretty good idea how to program rendering logic.
8+
9module Ormolu.Printer.Combinators
9module Ormolu.Printer.Combinators
10 ( -- * The 'R' monad
10 ( -- * The 'R' monad
11− R,
11+ R
12− runR,
12+ , runR
13− getAnns,
13+ , getAnns
14− getEnclosingSpan,
14+ , getEnclosingSpan
15−
16 -- * Combinators
15 -- * Combinators
17−
18 -- ** Basic
16 -- ** Basic
19− txt,
17+ , txt
20− atom,
18+ , atom
21− space,
19+ , space
22− newline,
20+ , newline
23− inci,
21+ , inci
24− inciIf,
25− located,
22+ , located
26− located',
23+ , located'
27− switchLayout,
24+ , switchLayout
28− Layout (..),
25+ , Layout (..)
29− vlayout,
26+ , vlayout
30− getLayout,
27+ , getLayout
31− breakpoint,
28+ , breakpoint
32− breakpoint',
29+ , breakpoint'
33−
34 -- ** Formatting lists
30 -- ** Formatting lists
35− sep,
31+ , sep
36− sepSemi,
32+ , sepSemi
37− canUseBraces,
33+ , canUseBraces
38− useBraces,
34+ , useBraces
39− dontUseBraces,
35+ , dontUseBraces
40−
41 -- ** Wrapping
36 -- ** Wrapping
42− BracketStyle (..),
37+ , BracketStyle (..)
43− sitcc,
38+ , sitcc
44− backticks,
39+ , backticks
45− banana,
40+ , banana
46− braces,
41+ , braces
47− brackets,
42+ , brackets
48− parens,
43+ , parens
49− parensHash,
44+ , parensHash
50− pragmaBraces,
45+ , pragmaBraces
51− pragma,
46+ , pragma
52−
53 -- ** Literals
47 -- ** Literals
54− comma,
48+ , comma
55− commaDel,
49+ -- ** Comments
56− equals,
57−
58− -- ** Stateful markers
59− SpanMark (..),
60− spanMarkSpan,
61− HaddockStyle (..),
50+ , HaddockStyle (..)
62− setSpanMark,
51+ , setLastCommentSpan
63− getSpanMark,
52+ , getLastCommentSpan
64 )
53 )
65where
54where
66
55
67import Control.Monad
56import Control.Monad
57+import Data.Data (Data)
68import Data.List (intersperse)
58import Data.List (intersperse)
69import Data.Text (Text)
59import Data.Text (Text)
70import Ormolu.Printer.Comments
60import Ormolu.Printer.Comments
71import Ormolu.Printer.Internal
61import Ormolu.Printer.Internal
62+import Ormolu.Utils (isModule)
72import SrcLoc
63import SrcLoc
73
64
74----------------------------------------------------------------------------
65----------------------------------------------------------------------------
75-- Basic
66-- Basic
76
67
77−-- | Indent the inner expression if the first argument is 'True'.
78−inciIf ::
79− -- | Whether to indent
80− Bool ->
81− -- | The expression to indent
82− R () ->
83− R ()
84−inciIf b m = if b then inci m else m
85−
86-- | Enter a 'Located' entity. This combinator handles outputting comments
68-- | Enter a 'Located' entity. This combinator handles outputting comments
87-- and sets layout (single-line vs multi-line) for the inner computation.
69-- and sets layout (single-line vs multi-line) for the inner computation.
88-- Roughly, the rule for using 'located' is that every time there is a
70-- Roughly, the rule for using 'located' is that every time there is a
89-- 'Located' wrapper, it should be “discharged” with a corresponding
71-- 'Located' wrapper, it should be “discharged” with a corresponding
90-- 'located' invocation.
72-- 'located' invocation.
73+
91−located ::
74+located
75+ :: Data a
92− -- | Thing to enter
76+ => Located a -- ^ Thing to enter
93− Located a ->
94− -- | How to render inner value
77+ -> (a -> R ()) -- ^ How to render inner value
95− (a -> R ()) ->
96− R ()
78+ -> R ()
97−located (L (UnhelpfulSpan _) a) f = f a
79+located loc f = do
98−located (L (RealSrcSpan l) a) f = do
80+ let withRealLocated (L l a) g =
81+ case l of
82+ UnhelpfulSpan _ -> return ()
83+ RealSrcSpan l' -> g (L l' a)
99− spitPrecedingComments l
84+ withRealLocated loc spitPrecedingComments
85+ let setEnclosingSpan =
86+ case getLoc loc of
87+ UnhelpfulSpan _ -> id
88+ RealSrcSpan orf ->
89+ if isModule (unLoc loc)
90+ then id
100− withEnclosingSpan l $
91+ else withEnclosingSpan orf
101− switchLayout [RealSrcSpan l] (f a)
92+ setEnclosingSpan $ switchLayout [getLoc loc] (f (unLoc loc))
102− spitFollowingComments l
93+ withRealLocated loc spitFollowingComments
103
94
104-- | A version of 'located' with arguments flipped.
95-- | A version of 'located' with arguments flipped.
96+
105−located' ::
97+located'
98+ :: Data a
106− -- | How to render inner value
99+ => (a -> R ()) -- ^ How to render inner value
107− (a -> R ()) ->
108− -- | Thing to enter
100+ -> Located a -- ^ Thing to enter
109− Located a ->
110− R ()
101+ -> R ()
111located' = flip located
102located' = flip located
112
103
113-- | Set layout according to combination of given 'SrcSpan's for a given.
104-- | Set layout according to combination of given 'SrcSpan's for a given.
@@ -116,19 +107,19 @@ located' = flip located
116-- provided by GHC AST. It is relatively rare that this one is needed.
107-- provided by GHC AST. It is relatively rare that this one is needed.
117--
108--
118-- Given empty list this function will set layout to single line.
109-- Given empty list this function will set layout to single line.
110+
119−switchLayout ::
111+switchLayout
120− -- | Span that controls layout
112+ :: [SrcSpan] -- ^ Span that controls layout
121− [SrcSpan] ->
122− -- | Computation to run with changed layout
113+ -> R () -- ^ Computation to run with changed layout
123− R () ->
124− R ()
114+ -> R ()
125switchLayout spans' = enterLayout (spansLayout spans')
115switchLayout spans' = enterLayout (spansLayout spans')
126
116
127-- | Which layout combined spans result in?
117-- | Which layout combined spans result in?
118+
128spansLayout :: [SrcSpan] -> Layout
119spansLayout :: [SrcSpan] -> Layout
129spansLayout = \case
120spansLayout = \case
130 [] -> SingleLine
121 [] -> SingleLine
131− (x : xs) ->
122+ (x:xs) ->
132 if isOneLineSpan (foldr combineSrcSpans x xs)
123 if isOneLineSpan (foldr combineSrcSpans x xs)
133 then SingleLine
124 then SingleLine
134 else MultiLine
125 else MultiLine
@@ -137,6 +128,7 @@ spansLayout = \case
137-- multiline.
128-- multiline.
138--
129--
139-- > breakpoint = vlayout space newline
130-- > breakpoint = vlayout space newline
131+
140breakpoint :: R ()
132breakpoint :: R ()
141breakpoint = vlayout space newline
133breakpoint = vlayout space newline
142
134
@@ -144,6 +136,7 @@ breakpoint = vlayout space newline
144-- layout.
136-- layout.
145--
137--
146-- > breakpoint' = vlayout (return ()) newline
138-- > breakpoint' = vlayout (return ()) newline
139+
147breakpoint' :: R ()
140breakpoint' :: R ()
148breakpoint' = vlayout (return ()) newline
141breakpoint' = vlayout (return ()) newline
149
142
@@ -151,14 +144,12 @@ breakpoint' = vlayout (return ()) newline
151-- Formatting lists
144-- Formatting lists
152
145
153-- | Render a collection of elements inserting a separator between them.
146-- | Render a collection of elements inserting a separator between them.
147+
154−sep ::
148+sep
155− -- | Separator
149+ :: R () -- ^ Separator
156− R () ->
157− -- | How to render an element
150+ -> (a -> R ()) -- ^ How to render an element
158− (a -> R ()) ->
151+ -> [a] -- ^ Elements to render
159− -- | Elements to render
160− [a] ->
161− R ()
152+ -> R ()
162sep s f xs = sequence_ (intersperse s (f <$> xs))
153sep s f xs = sequence_ (intersperse s (f <$> xs))
163
154
164-- | Render a collection of elements layout-sensitively using given printer,
155-- | Render a collection of elements layout-sensitively using given printer,
@@ -170,12 +161,11 @@ sep s f xs = sequence_ (intersperse s (f <$> xs))
170--
161--
171-- > dontUseBraces $ sepSemi txt ["foo", "bar"]
162-- > dontUseBraces $ sepSemi txt ["foo", "bar"]
172-- > == vlayout (txt "foo; bar") (txt "foo\nbar")
163-- > == vlayout (txt "foo; bar") (txt "foo\nbar")
164+
173−sepSemi ::
165+sepSemi
174− -- | How to render an element
166+ :: (a -> R ()) -- ^ How to render an element
175− (a -> R ()) ->
167+ -> [a] -- ^ Elements to render
176− -- | Elements to render
177− [a] ->
178− R ()
168+ -> R ()
179sepSemi f xs = vlayout singleLine multiLine
169sepSemi f xs = vlayout singleLine multiLine
180 where
170 where
181 singleLine = do
171 singleLine = do
@@ -184,13 +174,12 @@ sepSemi f xs = vlayout singleLine multiLine
184 [] -> when ub $ txt "{}"
174 [] -> when ub $ txt "{}"
185 xs' ->
175 xs' ->
186 if ub
176 if ub
187− then do
177+ then do
188− txt "{"
178+ txt "{ "
189− space
190− sep (txt ";" >> space) (dontUseBraces . f) xs'
179+ sep (txt "; ") (dontUseBraces . f) xs'
191− space
192− txt "}"
180+ txt " }"
181+ else
193− else sep (txt ";" >> space) f xs'
182+ sep (txt "; ") f xs'
194 multiLine =
183 multiLine =
195 sep newline (dontUseBraces . f) xs
184 sep newline (dontUseBraces . f) xs
196
185
@@ -198,14 +187,13 @@ sepSemi f xs = vlayout singleLine multiLine
198-- Wrapping
187-- Wrapping
199
188
200-- | 'BracketStyle' controlling how closing bracket is rendered.
189-- | 'BracketStyle' controlling how closing bracket is rendered.
190+
201data BracketStyle
191data BracketStyle
202− = -- | Normal
192+ = N -- ^ Normal
203− N
204− | -- | Shifted one level
193+ | S -- ^ Shifted one level
205− S
206− deriving (Eq, Show)
207
194
208-- | Surround given entity by backticks.
195-- | Surround given entity by backticks.
196+
209backticks :: R () -> R ()
197backticks :: R () -> R ()
210backticks m = do
198backticks m = do
211 txt "`"
199 txt "`"
@@ -213,26 +201,32 @@ backticks m = do
213 txt "`"
201 txt "`"
214
202
215-- | Surround given entity by banana brackets (i.e., from arrow notation.)
203-- | Surround given entity by banana brackets (i.e., from arrow notation.)
204+
216banana :: R () -> R ()
205banana :: R () -> R ()
217banana = brackets_ True "(|" "|)" N
206banana = brackets_ True "(|" "|)" N
218
207
219-- | Surround given entity by curly braces @{@ and @}@.
208-- | Surround given entity by curly braces @{@ and @}@.
209+
220braces :: BracketStyle -> R () -> R ()
210braces :: BracketStyle -> R () -> R ()
221braces = brackets_ False "{" "}"
211braces = brackets_ False "{" "}"
222
212
223-- | Surround given entity by square brackets @[@ and @]@.
213-- | Surround given entity by square brackets @[@ and @]@.
214+
224brackets :: BracketStyle -> R () -> R ()
215brackets :: BracketStyle -> R () -> R ()
225brackets = brackets_ False "[" "]"
216brackets = brackets_ False "[" "]"
226
217
227-- | Surround given entity by parentheses @(@ and @)@.
218-- | Surround given entity by parentheses @(@ and @)@.
219+
228parens :: BracketStyle -> R () -> R ()
220parens :: BracketStyle -> R () -> R ()
229parens = brackets_ False "(" ")"
221parens = brackets_ False "(" ")"
230
222
231-- | Surround given entity by @(# @ and @ #)@.
223-- | Surround given entity by @(# @ and @ #)@.
224+
232parensHash :: BracketStyle -> R () -> R ()
225parensHash :: BracketStyle -> R () -> R ()
233parensHash = brackets_ True "(#" "#)"
226parensHash = brackets_ True "(#" "#)"
234
227
235-- | Braces as used for pragmas: @{-#@ and @#-}@.
228-- | Braces as used for pragmas: @{-#@ and @#-}@.
229+
236pragmaBraces :: R () -> R ()
230pragmaBraces :: R () -> R ()
237pragmaBraces m = sitcc $ do
231pragmaBraces m = sitcc $ do
238 txt "{-#"
232 txt "{-#"
@@ -242,30 +236,25 @@ pragmaBraces m = sitcc $ do
242 inci (txt "#-}")
236 inci (txt "#-}")
243
237
244-- | Surround the body with a pragma name and 'pragmaBraces'.
238-- | Surround the body with a pragma name and 'pragmaBraces'.
239+
245−pragma ::
240+pragma
246− -- | Pragma text
241+ :: Text -- ^ Pragma text
247− Text ->
248− -- | Pragma body
242+ -> R () -- ^ Pragma body
249− R () ->
250− R ()
243+ -> R ()
251pragma pragmaText body = pragmaBraces $ do
244pragma pragmaText body = pragmaBraces $ do
252 txt pragmaText
245 txt pragmaText
253 breakpoint
246 breakpoint
254 body
247 body
255
248
256-- | A helper for defining wrappers like 'parens' and 'braces'.
249-- | A helper for defining wrappers like 'parens' and 'braces'.
250+
257−brackets_ ::
251+brackets_
258− -- | Insert breakpoints around brackets
252+ :: Bool -- ^ Insert breakpoints around brackets
259− Bool ->
260− -- | Opening bracket
253+ -> Text -- ^ Opening bracket
261− Text ->
262− -- | Closing bracket
254+ -> Text -- ^ Closing bracket
263− Text ->
264− -- | Bracket style
255+ -> BracketStyle -- ^ Bracket style
265− BracketStyle ->
266− -- | Inner expression
256+ -> R () -- ^ Inner expression
267− R () ->
268− R ()
257+ -> R ()
269brackets_ needBreaks open close style m = sitcc (vlayout singleLine multiLine)
258brackets_ needBreaks open close style m = sitcc (vlayout singleLine multiLine)
270 where
259 where
271 singleLine = do
260 singleLine = do
@@ -280,19 +269,14 @@ brackets_ needBreaks open close style m = sitcc (vlayout singleLine multiLine)
280 then newline >> inci m
269 then newline >> inci m
281 else space >> sitcc m
270 else space >> sitcc m
282 newline
271 newline
272+ case style of
273+ N -> txt close
283− inciIf (style == S) (txt close)
274+ S -> inci (txt close)
284
275
285----------------------------------------------------------------------------
276----------------------------------------------------------------------------
286-- Literals
277-- Literals
287
278
288-- | Print @,@.
279-- | Print @,@.
280+
289comma :: R ()
281comma :: R ()
290comma = txt ","
282comma = txt ","
291−
292−-- | Delimiting combination with 'comma'. To be used with 'sep'.
293−commaDel :: R ()
294−commaDel = comma >> breakpoint
295−
296−-- | Print @=@. Do not use @'txt' "="@.
297−equals :: R ()
298−equals = interferingTxt "="
src/Ormolu/Printer/Comments.hs+133−135
@@ -1,115 +1,125 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3
3
4-- | Helpers for formatting of comments. This is low-level code, use
4-- | Helpers for formatting of comments. This is low-level code, use
5-- "Ormolu.Printer.Combinators" unless you know what you are doing.
5-- "Ormolu.Printer.Combinators" unless you know what you are doing.
6+
6module Ormolu.Printer.Comments
7module Ormolu.Printer.Comments
7− ( spitPrecedingComments,
8+ ( spitPrecedingComments
8− spitFollowingComments,
9+ , spitFollowingComments
9− spitRemainingComments,
10+ , spitRemainingComments
10− spitCommentNow,
11− spitCommentPending,
12 )
11 )
13where
12where
14
13
15import Control.Monad
14import Control.Monad
16−import qualified Data.List.NonEmpty as NE
15+import Data.Coerce (coerce)
17−import Data.Maybe (listToMaybe)
16+import Data.Data (Data)
18−import qualified Data.Text as T
19import Ormolu.Parser.CommentStream
17import Ormolu.Parser.CommentStream
20import Ormolu.Printer.Internal
18import Ormolu.Printer.Internal
19+import Ormolu.Utils (isModule)
21import SrcLoc
20import SrcLoc
21+import qualified Data.List.NonEmpty as NE
22+import qualified Data.Text as T
22
23
23----------------------------------------------------------------------------
24----------------------------------------------------------------------------
24-- Top-level
25-- Top-level
25
26
26-- | Output all preceding comments for an element at given location.
27-- | Output all preceding comments for an element at given location.
28+
27−spitPrecedingComments ::
29+spitPrecedingComments
30+ :: Data a
28− -- | Span of the element to attach comments to
31+ => RealLocated a -- ^ AST element to attach comments to
29− RealSrcSpan ->
30− R ()
32+ -> R ()
31spitPrecedingComments ref = do
33spitPrecedingComments ref = do
34+ r <- getLastCommentSpan
35+ case r of
36+ Just (Just Pipe, _) ->
37+ -- We should not insert comments between pipe Haddock and the thing
38+ -- it's attached to.
39+ return ()
40+ _ -> do
32− gotSome <- handleCommentSeries (spitPrecedingComment ref)
41+ gotSome <- handleCommentSeries (spitPrecedingComment ref)
33− when gotSome $ do
42+ when gotSome $ do
34− lastMark <- getSpanMark
35− -- Insert a blank line between the preceding comments and the thing
43+ -- Insert a blank line between the preceding comments and the thing
36− -- after them if there was a blank line in the input.
44+ -- after them if there was a blank line in the input.
45+ lastSpn <- fmap snd <$> getLastCommentSpan
37− when (needsNewlineBefore ref lastMark) newline
46+ when (needsNewlineBefore (getLoc ref) lastSpn) newline
38
47
39-- | Output all comments following an element at given location.
48-- | Output all comments following an element at given location.
49+
40−spitFollowingComments ::
50+spitFollowingComments
51+ :: Data a
41− -- | Span of the element to attach comments to
52+ => RealLocated a -- ^ AST element of attach comments to
42− RealSrcSpan ->
43− R ()
53+ -> R ()
44spitFollowingComments ref = do
54spitFollowingComments ref = do
45− trimSpanStream ref
55+ trimSpanStream (getLoc ref)
46 void $ handleCommentSeries (spitFollowingComment ref)
56 void $ handleCommentSeries (spitFollowingComment ref)
47
57
48-- | Output all remaining comments in the comment stream.
58-- | Output all remaining comments in the comment stream.
59+
49spitRemainingComments :: R ()
60spitRemainingComments :: R ()
50−spitRemainingComments = do
51− -- Make sure we have a blank a line between the last definition and the
52− -- trailing comments.
53− newline
54− void $ handleCommentSeries spitRemainingComment
61+spitRemainingComments = void $ handleCommentSeries spitRemainingComment
55
62
56----------------------------------------------------------------------------
63----------------------------------------------------------------------------
57-- Single-comment functions
64-- Single-comment functions
58
65
59-- | Output a single preceding comment for an element at given location.
66-- | Output a single preceding comment for an element at given location.
67+
60−spitPrecedingComment ::
68+spitPrecedingComment
69+ :: Data a
61− -- | Span of the element to attach comments to
70+ => RealLocated a -- ^ AST element to attach comments to
62− RealSrcSpan ->
71+ -> Maybe RealSrcSpan -- ^ Location of last comment in the series
63− -- | Are we done?
72+ -> R Bool -- ^ Are we done?
64− R Bool
73+spitPrecedingComment (L ref a) mlastSpn = do
65−spitPrecedingComment ref = do
66− mlastMark <- getSpanMark
67 let p (L l _) = realSrcSpanEnd l <= realSrcSpanStart ref
74 let p (L l _) = realSrcSpanEnd l <= realSrcSpanStart ref
68 withPoppedComment p $ \l comment -> do
75 withPoppedComment p $ \l comment -> do
69− lineSpans <- thisLineSpans
76+ dirtyLine <-
70− let thisCommentLine = srcLocLine (realSrcSpanStart l)
77+ case mlastSpn of
71− needsNewline =
78+ -- NOTE When the current line is dirty it means that something that
72− case listToMaybe lineSpans of
79+ -- can have comments attached to it is already on the line. To avoid
73− Nothing -> False
80+ -- problems with idempotence we cannot output the first comment
74− Just spn -> srcLocLine (realSrcSpanEnd spn) /= thisCommentLine
81+ -- immediately because it'll be attached to the previous element (on
82+ -- the same line) on the next run, so we play safe here and output
83+ -- an extra 'newline' in this case.
84+ Nothing -> isLineDirty -- only for very first preceding comment
85+ Just _ -> return False
75− when (needsNewline || needsNewlineBefore l mlastMark) newline
86+ when (dirtyLine || needsNewlineBefore l mlastSpn) newline
76 spitCommentNow l comment
87 spitCommentNow l comment
77− if theSameLinePre l ref
88+ if theSameLinePre l ref && not (isModule a)
78 then space
89 then space
79 else newline
90 else newline
80
91
81-- | Output a comment that follows element at given location immediately on
92-- | Output a comment that follows element at given location immediately on
82-- the same line, if there is any.
93-- the same line, if there is any.
94+
83−spitFollowingComment ::
95+spitFollowingComment
96+ :: Data a
84− -- | AST element to attach comments to
97+ => RealLocated a -- ^ AST element to attach comments to
85− RealSrcSpan ->
98+ -> Maybe RealSrcSpan -- ^ Location of last comment in the series
86− -- | Are we done?
99+ -> R Bool -- ^ Are we done?
87− R Bool
100+spitFollowingComment (L ref a) mlastSpn = do
88−spitFollowingComment ref = do
89− mlastMark <- getSpanMark
90 mnSpn <- nextEltSpan
101 mnSpn <- nextEltSpan
91 -- Get first enclosing span that is not equal to reference span, i.e. it's
102 -- Get first enclosing span that is not equal to reference span, i.e. it's
92 -- truly something enclosing the AST element.
103 -- truly something enclosing the AST element.
93 meSpn <- getEnclosingSpan (/= ref)
104 meSpn <- getEnclosingSpan (/= ref)
94− withPoppedComment (commentFollowsElt ref mnSpn meSpn mlastMark) $ \l comment ->
105+ withPoppedComment (commentFollowsElt ref mnSpn meSpn mlastSpn) $ \l comment ->
95− if theSameLinePost l ref
106+ if theSameLinePost l ref && not (isModule a)
96− then
97− if isMultilineComment comment
107+ then if isMultilineComment comment
98− then space >> spitCommentNow l comment
108+ then space >> spitCommentNow l comment
99− else spitCommentPending OnTheSameLine l comment
109+ else spitCommentPending OnTheSameLine l comment
100 else do
110 else do
101− when (needsNewlineBefore l mlastMark) $
111+ when (needsNewlineBefore l mlastSpn) $
102 registerPendingCommentLine OnNextLine ""
112 registerPendingCommentLine OnNextLine ""
103 spitCommentPending OnNextLine l comment
113 spitCommentPending OnNextLine l comment
104
114
105-- | Output a single remaining comment from the comment stream.
115-- | Output a single remaining comment from the comment stream.
116+
106−spitRemainingComment ::
117+spitRemainingComment
118+ :: Maybe RealSrcSpan -- ^ Location of last comment in the series
107− -- | Are we done?
119+ -> R Bool -- ^ Are we done?
108− R Bool
109−spitRemainingComment = do
120+spitRemainingComment mlastSpn =
110− mlastMark <- getSpanMark
111 withPoppedComment (const True) $ \l comment -> do
121 withPoppedComment (const True) $ \l comment -> do
112− when (needsNewlineBefore l mlastMark) newline
122+ when (needsNewlineBefore l mlastSpn) newline
113 spitCommentNow l comment
123 spitCommentNow l comment
114 newline
124 newline
115
125
@@ -117,29 +127,27 @@ spitRemainingComment = do
117-- Helpers
127-- Helpers
118
128
119-- | Output series of comments.
129-- | Output series of comments.
130+
120−handleCommentSeries ::
131+handleCommentSeries
132+ :: (Maybe RealSrcSpan -> R Bool)
121− -- | Given location of previous comment, output the next comment
133+ -- ^ Given location of previous comment, output the next comment
122− -- returning 'True' if we're done
134+ -- returning 'True' if we're done
123− R Bool ->
124− -- | Whether we printed any comments
135+ -> R Bool -- ^ Whether we printed any comments
125− R Bool
126handleCommentSeries f = go False
136handleCommentSeries f = go False
127 where
137 where
128 go gotSome = do
138 go gotSome = do
129− done <- f
139+ done <- getLastCommentSpan >>= f . fmap snd
130 if done
140 if done
131 then return gotSome
141 then return gotSome
132 else go True
142 else go True
133
143
134-- | Try to pop a comment using given predicate and if there is a comment
144-- | Try to pop a comment using given predicate and if there is a comment
135-- matching the predicate, print it out.
145-- matching the predicate, print it out.
146+
136−withPoppedComment ::
147+withPoppedComment
137− -- | Comment predicate
148+ :: (RealLocated Comment -> Bool) -- ^ Comment predicate
138− (RealLocated Comment -> Bool) ->
139− -- | Printing function
149+ -> (RealSrcSpan -> Comment -> R ()) -- ^ Printing function
140− (RealSrcSpan -> Comment -> R ()) ->
141− -- | Are we done?
150+ -> R Bool -- ^ Are we done?
142− R Bool
143withPoppedComment p f = do
151withPoppedComment p f = do
144 r <- popComment p
152 r <- popComment p
145 case r of
153 case r of
@@ -148,53 +156,45 @@ withPoppedComment p f = do
148
156
149-- | Determine if we need to insert a newline between current comment and
157-- | Determine if we need to insert a newline between current comment and
150-- last printed comment.
158-- last printed comment.
159+
151−needsNewlineBefore ::
160+needsNewlineBefore
152− -- | Current comment span
161+ :: RealSrcSpan -- ^ Current comment span
153− RealSrcSpan ->
154− -- | Last printed comment span
162+ -> Maybe RealSrcSpan -- ^ Last printed comment span
155− Maybe SpanMark ->
156− Bool
163+ -> Bool
157−needsNewlineBefore _ (Just (HaddockSpan _ _)) = True
158−needsNewlineBefore l mlastMark =
164+needsNewlineBefore l mlastSpn =
159− case spanMarkSpan <$> mlastMark of
165+ case mlastSpn of
160 Nothing -> False
166 Nothing -> False
161− Just lastMark ->
167+ Just lastSpn ->
162− srcSpanStartLine l > srcSpanEndLine lastMark + 1
168+ srcSpanStartLine l > srcSpanEndLine lastSpn + 1
163
169
164-- | Is the preceding comment and AST element are on the same line?
170-- | Is the preceding comment and AST element are on the same line?
171+
165−theSameLinePre ::
172+theSameLinePre
166− -- | Current comment span
173+ :: RealSrcSpan -- ^ Current comment span
167− RealSrcSpan ->
168− -- | AST element location
174+ -> RealSrcSpan -- ^ AST element location
169− RealSrcSpan ->
170− Bool
175+ -> Bool
171theSameLinePre l ref =
176theSameLinePre l ref =
172 srcSpanEndLine l == srcSpanStartLine ref
177 srcSpanEndLine l == srcSpanStartLine ref
173
178
174-- | Is the following comment and AST element are on the same line?
179-- | Is the following comment and AST element are on the same line?
180+
175−theSameLinePost ::
181+theSameLinePost
176− -- | Current comment span
182+ :: RealSrcSpan -- ^ Current comment span
177− RealSrcSpan ->
178− -- | AST element location
183+ -> RealSrcSpan -- ^ AST element location
179− RealSrcSpan ->
180− Bool
184+ -> Bool
181theSameLinePost l ref =
185theSameLinePost l ref =
182 srcSpanStartLine l == srcSpanEndLine ref
186 srcSpanStartLine l == srcSpanEndLine ref
183
187
184-- | Determine if given comment follows AST element.
188-- | Determine if given comment follows AST element.
189+
185−commentFollowsElt ::
190+commentFollowsElt
186− -- | Location of AST element
191+ :: RealSrcSpan -- ^ Location of AST element
187− RealSrcSpan ->
188− -- | Location of next AST element
192+ -> Maybe RealSrcSpan -- ^ Location of next AST element
189− Maybe RealSrcSpan ->
190− -- | Location of enclosing AST element
193+ -> Maybe RealSrcSpan -- ^ Location of enclosing AST element
191− Maybe RealSrcSpan ->
192− -- | Location of last comment in the series
194+ -> Maybe RealSrcSpan -- ^ Location of last comment in the series
193− Maybe SpanMark ->
194− -- | Comment to test
195+ -> RealLocated Comment -- ^ Comment to test
195− RealLocated Comment ->
196− Bool
196+ -> Bool
197−commentFollowsElt ref mnSpn meSpn mlastMark (L l comment) =
197+commentFollowsElt ref mnSpn meSpn mlastSpn (L l comment) =
198 -- A comment follows a AST element if all 4 conditions are satisfied:
198 -- A comment follows a AST element if all 4 conditions are satisfied:
199 goesAfter
199 goesAfter
200 && logicallyFollows
200 && logicallyFollows
@@ -205,10 +205,11 @@ commentFollowsElt ref mnSpn meSpn mlastMark (L l comment) =
205 goesAfter =
205 goesAfter =
206 realSrcSpanStart l >= realSrcSpanEnd ref
206 realSrcSpanStart l >= realSrcSpanEnd ref
207 -- 2) The comment logically belongs to the element, four cases:
207 -- 2) The comment logically belongs to the element, four cases:
208− logicallyFollows =
208+ logicallyFollows
209− theSameLinePost l ref -- a) it's on the same line
209+ = theSameLinePost l ref -- a) it's on the same line
210+ || isPrevHaddock comment -- b) it's a Haddock string starting with -- ^
210− || continuation -- b) it's a continuation of a comment block
211+ || continuation -- c) it's a continuation of a comment block
211− || lastInEnclosing -- c) it's the last element in the enclosing construct
212+ || lastInEnclosing -- d) it's the last element in the enclosing construct
212
213
213 -- 3) There is no other AST element between this element and the comment:
214 -- 3) There is no other AST element between this element and the comment:
214 noEltBetween =
215 noEltBetween =
@@ -230,20 +231,15 @@ commentFollowsElt ref mnSpn meSpn mlastMark (L l comment) =
230 Nothing -> True
231 Nothing -> True
231 Just espn ->
232 Just espn ->
232 let startColumn = srcLocCol . realSrcSpanStart
233 let startColumn = srcLocCol . realSrcSpanStart
233− in startColumn espn > startColumn ref
234+ in if startColumn espn > startColumn ref
235+ then True
234− || ( abs (startColumn espn - startColumn l)
236+ else abs (startColumn espn - startColumn l)
235− >= abs (startColumn ref - startColumn l)
237+ >= abs (startColumn ref - startColumn l)
236− )
237 continuation =
238 continuation =
238− -- A comment is a continuation when it doesn't have non-whitespace
239− -- lexemes in front of it and goes right after the previous comment.
240− not (hasAtomsBefore comment)
241− && ( case mlastMark of
239+ case mlastSpn of
242− Just (HaddockSpan _ _) -> False
240+ Nothing -> False
243− Just (CommentSpan spn) ->
244− srcSpanEndLine spn + 1 == srcSpanStartLine l
241+ Just spn -> srcSpanEndLine spn + 1 == srcSpanStartLine l
245− _ -> False
242+
246− )
247 lastInEnclosing =
243 lastInEnclosing =
248 case meSpn of
244 case meSpn of
249 -- When there is no enclosing element, return false
245 -- When there is no enclosing element, return false
@@ -259,19 +255,21 @@ commentFollowsElt ref mnSpn meSpn mlastMark (L l comment) =
259 in insideParent && nextOutsideParent
255 in insideParent && nextOutsideParent
260
256
261-- | Output a 'Comment' immediately. This is a low-level printing function.
257-- | Output a 'Comment' immediately. This is a low-level printing function.
258+
262spitCommentNow :: RealSrcSpan -> Comment -> R ()
259spitCommentNow :: RealSrcSpan -> Comment -> R ()
263spitCommentNow spn comment = do
260spitCommentNow spn comment = do
264 sitcc
261 sitcc
265 . sequence_
262 . sequence_
266 . NE.intersperse newline
263 . NE.intersperse newline
267 . fmap (txt . T.pack)
264 . fmap (txt . T.pack)
268− . unComment
265+ . coerce
269 $ comment
266 $ comment
270− setSpanMark (CommentSpan spn)
267+ setLastCommentSpan Nothing spn
271
268
272-- | Output a 'Comment' at the end of correct line or after it depending on
269-- | Output a 'Comment' at the end of correct line or after it depending on
273-- 'CommentPosition'. Used for comments that may potentially follow on the
270-- 'CommentPosition'. Used for comments that may potentially follow on the
274-- same line as something we just rendered, but not immediately after it.
271-- same line as something we just rendered, but not immediately after it.
272+
275spitCommentPending :: CommentPosition -> RealSrcSpan -> Comment -> R ()
273spitCommentPending :: CommentPosition -> RealSrcSpan -> Comment -> R ()
276spitCommentPending position spn comment = do
274spitCommentPending position spn comment = do
277 let wrapper = case position of
275 let wrapper = case position of
@@ -281,6 +279,6 @@ spitCommentPending position spn comment = do
281 . sequence_
279 . sequence_
282 . NE.toList
280 . NE.toList
283 . fmap (registerPendingCommentLine position . T.pack)
281 . fmap (registerPendingCommentLine position . T.pack)
284− . unComment
282+ . coerce
285 $ comment
283 $ comment
286− setSpanMark (CommentSpan spn)
284+ setLastCommentSpan Nothing spn
src/Ormolu/Printer/Internal.hs+271−349
@@ -1,55 +1,46 @@
1{-# LANGUAGE GeneralizedNewtypeDeriving #-}
1{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE RankNTypes #-}
4+{-# LANGUAGE RankNTypes #-}
5
5
6-- | In most cases import "Ormolu.Printer.Combinators" instead, these
6-- | In most cases import "Ormolu.Printer.Combinators" instead, these
7-- functions are the low-level building blocks and should not be used on
7-- functions are the low-level building blocks and should not be used on
8-- their own. The 'R' monad is re-exported from "Ormolu.Printer.Combinators"
8-- their own. The 'R' monad is re-exported from "Ormolu.Printer.Combinators"
9-- as well.
9-- as well.
10+
10module Ormolu.Printer.Internal
11module Ormolu.Printer.Internal
11 ( -- * The 'R' monad
12 ( -- * The 'R' monad
12− R,
13+ R
13− runR,
14+ , runR
14−
15 -- * Internal functions
15 -- * Internal functions
16− txt,
16+ , txt
17− interferingTxt,
18− atom,
17+ , atom
19− space,
18+ , space
20− newline,
19+ , newline
21− useRecordDot,
20+ , isLineDirty
22− inci,
21+ , inci
23− sitcc,
22+ , sitcc
24− Layout (..),
23+ , Layout (..)
25− enterLayout,
24+ , enterLayout
26− vlayout,
25+ , vlayout
27− getLayout,
26+ , getLayout
28−
29 -- * Helpers for braces
27 -- * Helpers for braces
30− useBraces,
28+ , useBraces
31− dontUseBraces,
29+ , dontUseBraces
32− canUseBraces,
30+ , canUseBraces
33−
34 -- * Special helpers for comment placement
31 -- * Special helpers for comment placement
35− CommentPosition (..),
32+ , CommentPosition (..)
36− registerPendingCommentLine,
33+ , registerPendingCommentLine
37− trimSpanStream,
34+ , trimSpanStream
38− nextEltSpan,
35+ , nextEltSpan
39− popComment,
36+ , popComment
40− getEnclosingSpan,
37+ , getEnclosingSpan
41− withEnclosingSpan,
38+ , withEnclosingSpan
42− thisLineSpans,
43−
44− -- * Stateful markers
45− SpanMark (..),
46− spanMarkSpan,
47− HaddockStyle (..),
39+ , HaddockStyle (..)
48− setSpanMark,
40+ , setLastCommentSpan
49− getSpanMark,
41+ , getLastCommentSpan
50−
51 -- * Annotations
42 -- * Annotations
52− getAnns,
43+ , getAnns
53 )
44 )
54where
45where
55
46
@@ -59,8 +50,6 @@ import Data.Bool (bool)
59import Data.Coerce
50import Data.Coerce
60import Data.Maybe (listToMaybe)
51import Data.Maybe (listToMaybe)
61import Data.Text (Text)
52import Data.Text (Text)
62−import qualified Data.Text as T
63−import qualified Data.Text.Lazy as TL
64import Data.Text.Lazy.Builder
53import Data.Text.Lazy.Builder
65import GHC
54import GHC
66import Ormolu.Parser.Anns
55import Ormolu.Parser.Anns
@@ -68,145 +57,115 @@ import Ormolu.Parser.CommentStream
68import Ormolu.Printer.SpanStream
57import Ormolu.Printer.SpanStream
69import Ormolu.Utils (showOutputable)
58import Ormolu.Utils (showOutputable)
70import Outputable (Outputable)
59import Outputable (Outputable)
60+import SrcLoc
61+import qualified Data.Text as T
62+import qualified Data.Text.Lazy as TL
71
63
72----------------------------------------------------------------------------
64----------------------------------------------------------------------------
73-- The 'R' monad
65-- The 'R' monad
74
66
75-- | The 'R' monad hosts combinators that allow us to describe how to render
67-- | The 'R' monad hosts combinators that allow us to describe how to render
76-- AST.
68-- AST.
69+
77newtype R a = R (ReaderT RC (State SC) a)
70newtype R a = R (ReaderT RC (State SC) a)
78 deriving (Functor, Applicative, Monad)
71 deriving (Functor, Applicative, Monad)
79
72
80-- | Reader context of 'R'. This should be used when we control rendering by
73-- | Reader context of 'R'. This should be used when we control rendering by
81-- enclosing certain expressions with wrappers.
74-- enclosing certain expressions with wrappers.
75+
82data RC = RC
76data RC = RC
77+ { rcIndent :: !Int
83− { -- | Indentation level, as the column index we need to start from after
78+ -- ^ Indentation level, as the column index we need to start from after
84 -- a newline if we break lines
79 -- a newline if we break lines
85− rcIndent :: !Int,
86− -- | Current layout
87− rcLayout :: Layout,
80+ , rcLayout :: Layout
88− -- | Spans of enclosing elements of AST
81+ -- ^ Current layout
89− rcEnclosingSpans :: [RealSrcSpan],
82+ , rcEnclosingSpans :: [RealSrcSpan]
90− -- | Collection of annotations
83+ -- ^ Spans of enclosing elements of AST
91− rcAnns :: Anns,
84+ , rcAnns :: Anns
85+ -- ^ Collection of annotations
86+ , rcCanUseBraces :: Bool
92− -- | Whether the last expression in the layout can use braces
87+ -- ^ If the last expression in the layout can use braces
93− rcCanUseBraces :: Bool,
94− -- | Whether the source could have used the record dot preprocessor
95− rcUseRecDot :: Bool
96 }
88 }
97
89
98-- | State context of 'R'.
90-- | State context of 'R'.
91+
99data SC = SC
92data SC = SC
93+ { scColumn :: !Int
100− { -- | Index of the next column to render
94+ -- ^ Index of the next column to render
101− scColumn :: !Int,
95+ , scBuilder :: Builder
102− -- | Indentation level that was used for the current line
103− scIndent :: !Int,
104− -- | Rendered source code so far
96+ -- ^ Rendered source code so far
105− scBuilder :: Builder,
106− -- | Span stream
107− scSpanStream :: SpanStream,
97+ , scSpanStream :: SpanStream
108− -- | Spans of atoms that have been printed on the current line so far
98+ -- ^ Span stream
109− scThisLineSpans :: [RealSrcSpan],
110− -- | Comment stream
111− scCommentStream :: CommentStream,
99+ , scCommentStream :: CommentStream
100+ -- ^ Comment stream
101+ , scPendingComments :: ![(CommentPosition, Int, Text)]
112− -- | Pending comment lines (in reverse order) to be inserted before next
102+ -- ^ Pending comment lines (in reverse order) to be inserted before next
113 -- newline, 'Int' is the indentation level
103 -- newline, 'Int' is the indentation level
114− scPendingComments :: ![(CommentPosition, Text)],
104+ , scDirtyLine :: !Bool
105+ -- ^ Whether the current line is “dirty”, that is, already contains
106+ -- atoms that can have comments attached to them
107+ , scRequestedDelimiter :: !RequestedDelimiter
115− -- | Whether to output a space before the next output
108+ -- ^ Whether to output a space before the next output
116− scRequestedDelimiter :: !RequestedDelimiter,
109+ , scLastCommentSpan :: !(Maybe (Maybe HaddockStyle, RealSrcSpan))
117− -- | An auxiliary marker for keeping track of last output element
110+ -- ^ Span of last output comment
118− scSpanMark :: !(Maybe SpanMark)
119 }
111 }
120
112
121-- | Make sure next output is delimited by one of the following.
113-- | Make sure next output is delimited by one of the following.
114+
122data RequestedDelimiter
115data RequestedDelimiter
123− = -- | A space
124− RequestedSpace
116+ = RequestedSpace -- ^ A space
125− | -- | A newline
126− RequestedNewline
117+ | RequestedNewline -- ^ A newline
127− | -- | Nothing
118+ | RequestedNothing -- ^ Nothing
128− RequestedNothing
129− | -- | We just output a newline
119+ | AfterNewline -- ^ We just output a newline
130− AfterNewline
131− | -- | We haven't printed anything yet
120+ | VeryBeginning -- ^ We haven't printed anything yet
132− VeryBeginning
133 deriving (Eq, Show)
121 deriving (Eq, Show)
134
122
135-- | 'Layout' options.
123-- | 'Layout' options.
124+
136data Layout
125data Layout
137− = -- | Put everything on single line
126+ = SingleLine -- ^ Put everything on single line
138− SingleLine
139− | -- | Use multiple lines
127+ | MultiLine -- ^ Use multiple lines
140− MultiLine
141 deriving (Eq, Show)
128 deriving (Eq, Show)
142
129
143-- | Modes for rendering of pending comments.
130-- | Modes for rendering of pending comments.
131+
144data CommentPosition
132data CommentPosition
145− = -- | Put the comment on the same line
133+ = OnTheSameLine -- ^ Put the comment on the same line
146− OnTheSameLine
147− | -- | Put the comment on next line
134+ | OnNextLine -- ^ Put the comment on next line
148− OnNextLine
149 deriving (Eq, Show)
135 deriving (Eq, Show)
150
136
151-- | Run an 'R' monad.
137-- | Run an 'R' monad.
138+
152−runR ::
139+runR
153− -- | Monad to run
140+ :: R () -- ^ Monad to run
154− R () ->
155− -- | Span stream
141+ -> SpanStream -- ^ Span stream
156− SpanStream ->
157− -- | Comment stream
142+ -> CommentStream -- ^ Comment stream
158− CommentStream ->
159− -- | Annotations
143+ -> Anns -- ^ Annotations
160− Anns ->
161− -- | Use Record Dot Syntax
162− Bool ->
163− -- | Resulting rendition
144+ -> Text -- ^ Resulting rendition
164− Text
165−runR (R m) sstream cstream anns recDot =
145+runR (R m) sstream cstream anns =
166 TL.toStrict . toLazyText . scBuilder $ execState (runReaderT m rc) sc
146 TL.toStrict . toLazyText . scBuilder $ execState (runReaderT m rc) sc
167 where
147 where
168− rc =
148+ rc = RC
169− RC
170− { rcIndent = 0,
149+ { rcIndent = 0
171− rcLayout = MultiLine,
150+ , rcLayout = MultiLine
172− rcEnclosingSpans = [],
151+ , rcEnclosingSpans = []
173− rcAnns = anns,
152+ , rcAnns = anns
174− rcCanUseBraces = False,
153+ , rcCanUseBraces = False
175− rcUseRecDot = recDot
176− }
154+ }
177− sc =
155+ sc = SC
178− SC
179− { scColumn = 0,
156+ { scColumn = 0
180− scIndent = 0,
181− scBuilder = mempty,
157+ , scBuilder = mempty
182− scSpanStream = sstream,
158+ , scSpanStream = sstream
183− scThisLineSpans = [],
184− scCommentStream = cstream,
159+ , scCommentStream = cstream
185− scPendingComments = [],
160+ , scPendingComments = []
161+ , scDirtyLine = False
186− scRequestedDelimiter = VeryBeginning,
162+ , scRequestedDelimiter = VeryBeginning
187− scSpanMark = Nothing
163+ , scLastCommentSpan = Nothing
188− }
164+ }
189
165
190----------------------------------------------------------------------------
166----------------------------------------------------------------------------
191-- Internal functions
167-- Internal functions
192
168
193−-- | Type of the thing to output. Influences the primary low-level rendering
194−-- function 'spit'.
195−data SpitType
196− = -- | Simple opaque text that breaks comment series.
197− SimpleText
198− | -- | Like 'SimpleText', but assume that when this text is inserted it
199− -- will separate an 'Atom' and its pending comments, so insert an extra
200− -- 'newline' in that case to force the pending comments and continue on
201− -- a fresh line.
202− InterferingText
203− | -- | An atom that typically have span information in the AST and can
204− -- have comments attached to it.
205− Atom
206− | -- | Used for rendering comment lines.
207− CommentPart
208− deriving (Show, Eq)
209−
210-- | Output a fixed 'Text' fragment. The argument may not contain any line
169-- | Output a fixed 'Text' fragment. The argument may not contain any line
211-- breaks. 'txt' is used to output all sorts of “fixed” bits of syntax like
170-- breaks. 'txt' is used to output all sorts of “fixed” bits of syntax like
212-- keywords and pipes @|@ in functional dependencies.
171-- keywords and pipes @|@ in functional dependencies.
@@ -214,84 +173,59 @@ data SpitType
214-- To separate various bits of syntax with white space use 'space' instead
173-- To separate various bits of syntax with white space use 'space' instead
215-- of @'txt' " "@. To output 'Outputable' Haskell entities like numbers use
174-- of @'txt' " "@. To output 'Outputable' Haskell entities like numbers use
216-- 'atom'.
175-- 'atom'.
176+
217−txt ::
177+txt
218− -- | 'Text' to output
178+ :: Text -- ^ 'Text' to output
219− Text ->
220− R ()
179+ -> R ()
221−txt = spit SimpleText
180+txt = spit False False
222−
223−-- | Similar to 'txt' but the text inserted this way is assumed to break the
224−-- “link” between the preceding atom and its pending comments.
225−interferingTxt ::
226− -- | 'Text' to output
227− Text ->
228− R ()
229−interferingTxt = spit InterferingText
230
181
231-- | Output 'Outputable' fragment of AST. This can be used to output numeric
182-- | Output 'Outputable' fragment of AST. This can be used to output numeric
232-- literals and similar. Everything that doesn't have inner structure but
183-- literals and similar. Everything that doesn't have inner structure but
233-- does have an 'Outputable' instance.
184-- does have an 'Outputable' instance.
185+
234−atom ::
186+atom
235− Outputable a =>
187+ :: Outputable a
236− a ->
188+ => a
237− R ()
189+ -> R ()
238−atom = spit Atom . T.pack . showOutputable
190+atom = spit True False . T.pack . showOutputable
239
191
240-- | Low-level non-public helper to define 'txt' and 'atom'.
192-- | Low-level non-public helper to define 'txt' and 'atom'.
193+
241−spit ::
194+spit
242− -- | Type of the thing to spit
195+ :: Bool -- ^ Should we mark the line as dirty?
243− SpitType ->
196+ -> Bool -- ^ Used during outputting of pending comments?
244− -- | 'Text' to output
197+ -> Text -- ^ 'Text' to output
245− Text ->
246− R ()
198+ -> R ()
247−spit _ "" = return ()
199+spit dirty printingComments txt' = do
248−spit stype text = do
249 requestedDel <- R (gets scRequestedDelimiter)
200 requestedDel <- R (gets scRequestedDelimiter)
250− pendingComments <- R (gets scPendingComments)
251− when (stype == InterferingText && not (null pendingComments)) newline
252 case requestedDel of
201 case requestedDel of
253 RequestedNewline -> do
202 RequestedNewline -> do
254− R . modify $ \sc ->
203+ R . modify $ \sc -> sc
255− sc
256− { scRequestedDelimiter = RequestedNothing
204+ { scRequestedDelimiter = RequestedNothing }
257− }
205+ if printingComments
258− case stype of
259− CommentPart -> newlineRaw
206+ then newlineRaw
260− _ -> newline
207+ else newline
261 _ -> return ()
208 _ -> return ()
262 R $ do
209 R $ do
263 i <- asks rcIndent
210 i <- asks rcIndent
264 c <- gets scColumn
211 c <- gets scColumn
265− closestEnclosing <- listToMaybe <$> asks rcEnclosingSpans
212+ let spaces =
266− let indentedTxt = spaces <> text
213+ if c < i
267− spaces = T.replicate spacesN " "
214+ then T.replicate (i - c) " "
268− spacesN =
269− if c == 0
270− then i
271− else bool 0 1 (requestedDel == RequestedSpace)
215+ else bool mempty " " (requestedDel == RequestedSpace)
216+ indentedTxt = spaces <> txt'
272− modify $ \sc ->
217+ modify $ \sc -> sc
273− sc
274− { scBuilder = scBuilder sc <> fromText indentedTxt,
218+ { scBuilder = scBuilder sc <> fromText indentedTxt
275− scColumn = scColumn sc + T.length indentedTxt,
219+ , scColumn = scColumn sc + T.length indentedTxt
276− scIndent =
220+ , scDirtyLine = scDirtyLine sc || dirty
277− if c == 0
278− then i
279− else scIndent sc,
280− scThisLineSpans =
281− let xs = scThisLineSpans sc
282− in case stype of
283− Atom -> case closestEnclosing of
284− Nothing -> xs
285− Just x -> x : xs
286− _ -> xs,
287− scRequestedDelimiter = RequestedNothing,
221+ , scRequestedDelimiter = RequestedNothing
288− scSpanMark =
222+ , scLastCommentSpan =
289− -- If there are pending comments, do not reset last comment
223+ -- NOTE If there are pending comments, do not reset last comment
290− -- location.
224+ -- location.
291− if (stype == CommentPart) || (not . null . scPendingComments) sc
225+ if printingComments || (not . null . scPendingComments) sc
292− then scSpanMark sc
226+ then scLastCommentSpan sc
293− else Nothing
227+ else Nothing
294− }
228+ }
295
229
296-- | This primitive /does not/ necessarily output a space. It just ensures
230-- | This primitive /does not/ necessarily output a space. It just ensures
297-- that the next thing that will be printed on the same line will be
231-- that the next thing that will be printed on the same line will be
@@ -301,13 +235,14 @@ spit stype text = do
301-- In practice this design prevents trailing white space and makes it hard
235-- In practice this design prevents trailing white space and makes it hard
302-- to output more than one delimiting space in a row, which is what we
236-- to output more than one delimiting space in a row, which is what we
303-- usually want.
237-- usually want.
238+
304space :: R ()
239space :: R ()
305−space = R . modify $ \sc ->
240+space = R . modify $ \sc -> sc
306− sc
241+ { scRequestedDelimiter =
307− { scRequestedDelimiter = case scRequestedDelimiter sc of
242+ case scRequestedDelimiter sc of
308 RequestedNothing -> RequestedSpace
243 RequestedNothing -> RequestedSpace
309 other -> other
244 other -> other
310− }
245+ }
311
246
312-- | Output a newline. First time 'newline' is used after some non-'newline'
247-- | Output a newline. First time 'newline' is used after some non-'newline'
313-- output it gets inserted immediately. Second use of 'newline' does not
248-- output it gets inserted immediately. Second use of 'newline' does not
@@ -318,100 +253,109 @@ space = R . modify $ \sc ->
318--
253--
319-- Similarly to 'space', this design prevents trailing newlines and makes it
254-- Similarly to 'space', this design prevents trailing newlines and makes it
320-- hard to output more than one blank newline in a row.
255-- hard to output more than one blank newline in a row.
256+
321newline :: R ()
257newline :: R ()
322newline = do
258newline = do
323− indent <- R (gets scIndent)
324 cs <- reverse <$> R (gets scPendingComments)
259 cs <- reverse <$> R (gets scPendingComments)
325 case cs of
260 case cs of
326 [] -> newlineRaw
261 [] -> newlineRaw
327− ((position, _) : _) -> do
262+ ((position, _, _):_) -> do
328 case position of
263 case position of
329 OnTheSameLine -> space
264 OnTheSameLine -> space
330 OnNextLine -> newlineRaw
265 OnNextLine -> newlineRaw
331− R . forM_ cs $ \(_, text) ->
266+ R . forM_ cs $ \(_, indent, txt') ->
332− let modRC rc =
267+ let modRC rc = rc
333− rc
334− { rcIndent = indent
268+ { rcIndent = indent
335− }
269+ }
336 R m = do
270 R m = do
337− unless (T.null text) $
271+ unless (T.null txt') $
338− spit CommentPart text
272+ spit False True txt'
339 newlineRaw
273 newlineRaw
340− in local modRC m
274+ in local modRC m
341− R . modify $ \sc ->
275+ R . modify $ \sc -> sc
342− sc
343− { scPendingComments = []
276+ { scPendingComments = []
344− }
277+ }
345
278
346-- | Low-level newline primitive. This one always just inserts a newline, no
279-- | Low-level newline primitive. This one always just inserts a newline, no
347-- hooks can be attached.
280-- hooks can be attached.
281+
348newlineRaw :: R ()
282newlineRaw :: R ()
349newlineRaw = R . modify $ \sc ->
283newlineRaw = R . modify $ \sc ->
350 let requestedDel = scRequestedDelimiter sc
284 let requestedDel = scRequestedDelimiter sc
351 builderSoFar = scBuilder sc
285 builderSoFar = scBuilder sc
352− in sc
286+ in sc
287+ { scBuilder =
353− { scBuilder = case requestedDel of
288+ case requestedDel of
354− AfterNewline -> builderSoFar
289+ AfterNewline -> builderSoFar
355− RequestedNewline -> builderSoFar
290+ RequestedNewline -> builderSoFar
356− VeryBeginning -> builderSoFar
291+ VeryBeginning -> builderSoFar
357− _ -> builderSoFar <> "\n",
292+ _ -> builderSoFar <> "\n"
358− scColumn = 0,
293+ , scColumn = 0
359− scIndent = 0,
294+ , scDirtyLine = False
360− scThisLineSpans = [],
295+ , scRequestedDelimiter =
361− scRequestedDelimiter = case scRequestedDelimiter sc of
296+ case scRequestedDelimiter sc of
362− AfterNewline -> RequestedNewline
297+ AfterNewline -> RequestedNewline
363− RequestedNewline -> RequestedNewline
298+ RequestedNewline -> RequestedNewline
364− VeryBeginning -> VeryBeginning
299+ VeryBeginning -> VeryBeginning
365− _ -> AfterNewline
300+ _ -> AfterNewline
366− }
301+ }
367
302
368−-- | Return 'True' if we should print record dot syntax.
303+-- | Check if the current line is “dirty”, that is, there is something on it
369−useRecordDot :: R Bool
304+-- that can have comments attached to it.
370−useRecordDot = R (asks rcUseRecDot)
305+
306+isLineDirty :: R Bool
307+isLineDirty = R (gets scDirtyLine)
371
308
372-- | Increase indentation level by one indentation step for the inner
309-- | Increase indentation level by one indentation step for the inner
373-- computation. 'inci' should be used when a part of code must be more
310-- computation. 'inci' should be used when a part of code must be more
374-- indented relative to the parts outside of 'inci' in order for the output
311-- indented relative to the parts outside of 'inci' in order for the output
375-- to be valid Haskell. When layout is single-line there is no obvious
312-- to be valid Haskell. When layout is single-line there is no obvious
376-- effect, but with multi-line layout correct indentation levels matter.
313-- effect, but with multi-line layout correct indentation levels matter.
314+
377inci :: R () -> R ()
315inci :: R () -> R ()
378inci (R m) = R (local modRC m)
316inci (R m) = R (local modRC m)
379 where
317 where
380− modRC rc =
318+ modRC rc = rc
381− rc
382− { rcIndent = rcIndent rc + indentStep
319+ { rcIndent = rcIndent rc + indentStep
383− }
320+ }
384
321
385-- | Set indentation level for the inner computation equal to current
322-- | Set indentation level for the inner computation equal to current
386-- column. This makes sure that the entire inner block is uniformly
323-- column. This makes sure that the entire inner block is uniformly
387−-- \"shifted\" to the right.
324+-- \"shifted\" to the right. Only works (and makes sense) when enclosing
325+-- layout is multi-line.
326+
388sitcc :: R () -> R ()
327sitcc :: R () -> R ()
389sitcc (R m) = do
328sitcc (R m) = do
390 requestedDel <- R (gets scRequestedDelimiter)
329 requestedDel <- R (gets scRequestedDelimiter)
391 i <- R (asks rcIndent)
330 i <- R (asks rcIndent)
392 c <- R (gets scColumn)
331 c <- R (gets scColumn)
393− let modRC rc =
332+ let modRC rc = rc
394− rc
395− { rcIndent = max i (c + bool 0 1 (requestedDel == RequestedSpace))
333+ { rcIndent = max i c + bool 0 1 (requestedDel == RequestedSpace)
396− }
334+ }
335+ vlayout (R m) . R $ do
336+ modify $ \sc -> sc
337+ { scRequestedDelimiter =
338+ case requestedDel of
339+ RequestedSpace -> RequestedNothing
340+ other -> other
341+ }
397− R (local modRC m)
342+ local modRC m
398
343
399-- | Set 'Layout' for internal computation.
344-- | Set 'Layout' for internal computation.
345+
400enterLayout :: Layout -> R () -> R ()
346enterLayout :: Layout -> R () -> R ()
401enterLayout l (R m) = R (local modRC m)
347enterLayout l (R m) = R (local modRC m)
402 where
348 where
403− modRC rc =
349+ modRC rc = rc
404− rc
405− { rcLayout = l
350+ { rcLayout = l
406− }
351+ }
407
352
408-- | Do one or another thing depending on current 'Layout'.
353-- | Do one or another thing depending on current 'Layout'.
354+
409−vlayout ::
355+vlayout
410− -- | Single line
356+ :: R a -- ^ Single line
411− R a ->
412− -- | Multi line
357+ -> R a -- ^ Multi line
413− R a ->
414− R a
358+ -> R a
415vlayout sline mline = do
359vlayout sline mline = do
416 l <- getLayout
360 l <- getLayout
417 case l of
361 case l of
@@ -419,6 +363,7 @@ vlayout sline mline = do
419 MultiLine -> mline
363 MultiLine -> mline
420
364
421-- | Get current 'Layout'.
365-- | Get current 'Layout'.
366+
422getLayout :: R Layout
367getLayout :: R Layout
423getLayout = R (asks rcLayout)
368getLayout = R (asks rcLayout)
424
369
@@ -429,149 +374,126 @@ getLayout = R (asks rcLayout)
429-- before next newline. When the comment goes after something else on the
374-- before next newline. When the comment goes after something else on the
430-- same line, a space will be inserted between preceding text and the
375-- same line, a space will be inserted between preceding text and the
431-- comment when necessary.
376-- comment when necessary.
377+
432−registerPendingCommentLine ::
378+registerPendingCommentLine
433− -- | Comment position
434− CommentPosition ->
379+ :: CommentPosition -- ^ Comment position
435− -- | 'Text' to output
380+ -> Text -- ^ 'Text' to output
436− Text ->
437− R ()
381+ -> R ()
438−registerPendingCommentLine position text = R $ do
382+registerPendingCommentLine position txt' = R $ do
383+ i <- asks rcIndent
439− modify $ \sc ->
384+ modify $ \sc -> sc
440− sc
441− { scPendingComments = (position, text) : scPendingComments sc
385+ { scPendingComments = (position, i, txt') : scPendingComments sc
442− }
386+ }
443
387
444-- | Drop elements that begin before or at the same place as given
388-- | Drop elements that begin before or at the same place as given
445-- 'SrcSpan'.
389-- 'SrcSpan'.
390+
446−trimSpanStream ::
391+trimSpanStream
447− -- | Reference span
392+ :: RealSrcSpan -- ^ Reference span
448− RealSrcSpan ->
449− R ()
393+ -> R ()
450trimSpanStream ref = do
394trimSpanStream ref = do
451 let leRef :: RealSrcSpan -> Bool
395 let leRef :: RealSrcSpan -> Bool
452 leRef x = realSrcSpanStart x <= realSrcSpanStart ref
396 leRef x = realSrcSpanStart x <= realSrcSpanStart ref
453− R . modify $ \sc ->
397+ R . modify $ \sc -> sc
454− sc
455− { scSpanStream = coerce (dropWhile leRef) (scSpanStream sc)
398+ { scSpanStream = coerce (dropWhile leRef) (scSpanStream sc)
456− }
399+ }
457
400
458-- | Get location of next element in AST.
401-- | Get location of next element in AST.
402+
459nextEltSpan :: R (Maybe RealSrcSpan)
403nextEltSpan :: R (Maybe RealSrcSpan)
460nextEltSpan = listToMaybe . coerce <$> R (gets scSpanStream)
404nextEltSpan = listToMaybe . coerce <$> R (gets scSpanStream)
461
405
462-- | Pop a 'Comment' from the 'CommentStream' if given predicate is
406-- | Pop a 'Comment' from the 'CommentStream' if given predicate is
463-- satisfied and there are comments in the stream.
407-- satisfied and there are comments in the stream.
408+
464−popComment ::
409+popComment
465− (RealLocated Comment -> Bool) ->
410+ :: (RealLocated Comment -> Bool)
466− R (Maybe (RealLocated Comment))
411+ -> R (Maybe (RealLocated Comment))
467popComment f = R $ do
412popComment f = R $ do
468 CommentStream cstream <- gets scCommentStream
413 CommentStream cstream <- gets scCommentStream
469 case cstream of
414 case cstream of
470 [] -> return Nothing
415 [] -> return Nothing
471− (x : xs) ->
416+ (x:xs) ->
472 if f x
417 if f x
473− then
474− Just x
475− <$ modify
418+ then Just x <$ modify (\sc -> sc
476− ( \sc ->
477− sc
478− { scCommentStream = CommentStream xs
419+ { scCommentStream = CommentStream xs
479− }
420+ })
480− )
481 else return Nothing
421 else return Nothing
482
422
483-- | Get the first enclosing 'RealSrcSpan' that satisfies given predicate.
423-- | Get the first enclosing 'RealSrcSpan' that satisfies given predicate.
424+
484−getEnclosingSpan ::
425+getEnclosingSpan
485− -- | Predicate to use
426+ :: (RealSrcSpan -> Bool) -- ^ Predicate to use
486− (RealSrcSpan -> Bool) ->
487− R (Maybe RealSrcSpan)
427+ -> R (Maybe RealSrcSpan)
488getEnclosingSpan f =
428getEnclosingSpan f =
489 listToMaybe . filter f <$> R (asks rcEnclosingSpans)
429 listToMaybe . filter f <$> R (asks rcEnclosingSpans)
490
430
491-- | Set 'RealSrcSpan' of enclosing span for the given computation.
431-- | Set 'RealSrcSpan' of enclosing span for the given computation.
432+
492withEnclosingSpan :: RealSrcSpan -> R () -> R ()
433withEnclosingSpan :: RealSrcSpan -> R () -> R ()
493withEnclosingSpan spn (R m) = R (local modRC m)
434withEnclosingSpan spn (R m) = R (local modRC m)
494 where
435 where
495− modRC rc =
436+ modRC rc = rc
496− rc
497− { rcEnclosingSpans = spn : rcEnclosingSpans rc
437+ { rcEnclosingSpans = spn : rcEnclosingSpans rc
498− }
438+ }
499−
500−-- | Get spans on this line so far.
501−thisLineSpans :: R [RealSrcSpan]
502−thisLineSpans = R (gets scThisLineSpans)
503−
504−----------------------------------------------------------------------------
505−-- Stateful markers
506−
507−-- | An auxiliary marker for keeping track of last output element.
508−data SpanMark
509− = -- | Haddock comment
510− HaddockSpan HaddockStyle RealSrcSpan
511− | -- | Non-haddock comment
512− CommentSpan RealSrcSpan
513− | -- | A statement in a do-block and such span
514− StatementSpan RealSrcSpan
515−
516−-- | Project 'RealSrcSpan' from 'SpanMark'.
517−spanMarkSpan :: SpanMark -> RealSrcSpan
518−spanMarkSpan = \case
519− HaddockSpan _ s -> s
520− CommentSpan s -> s
521− StatementSpan s -> s
522
439
523-- | Haddock string style.
440-- | Haddock string style.
441+
524data HaddockStyle
442data HaddockStyle
525− = -- | @-- |@
526− Pipe
443+ = Pipe -- ^ @-- |@
527− | -- | @-- ^@
528− Caret
444+ | Caret -- ^ @-- ^@
529− | -- | @-- *@
530− Asterisk Int
445+ | Asterisk Int -- ^ @-- *@
531− | -- | @-- $@
532− Named String
446+ | Named String -- ^ @-- $@
533
447
534-- | Set span of last output comment.
448-- | Set span of last output comment.
535−setSpanMark ::
449+
536− -- | Span mark to set
450+setLastCommentSpan
537− SpanMark ->
451+ :: Maybe HaddockStyle
452+ -- ^ 'HaddockStyle' or 'Nothing' if it's a non-Haddock comment
453+ -> RealSrcSpan
454+ -- ^ Location of last printed comment
538− R ()
455+ -> R ()
539−setSpanMark spnMark = R . modify $ \sc ->
456+setLastCommentSpan mhStyle spn = R . modify $ \sc -> sc
540− sc
457+ { scLastCommentSpan = Just (mhStyle, spn)
541− { scSpanMark = Just spnMark
542− }
458+ }
543
459
544-- | Get span of last output comment.
460-- | Get span of last output comment.
545−getSpanMark :: R (Maybe SpanMark)
461+
546−getSpanMark = R (gets scSpanMark)
462+getLastCommentSpan :: R (Maybe (Maybe HaddockStyle, RealSrcSpan))
463+getLastCommentSpan = R (gets scLastCommentSpan)
547
464
548----------------------------------------------------------------------------
465----------------------------------------------------------------------------
549-- Annotations
466-- Annotations
550
467
551-- | For a given span return 'AnnKeywordId's associated with it.
468-- | For a given span return 'AnnKeywordId's associated with it.
469+
552−getAnns ::
470+getAnns
553− SrcSpan ->
471+ :: SrcSpan
554− R [AnnKeywordId]
472+ -> R [AnnKeywordId]
555getAnns spn = lookupAnns spn <$> R (asks rcAnns)
473getAnns spn = lookupAnns spn <$> R (asks rcAnns)
556
474
557----------------------------------------------------------------------------
475----------------------------------------------------------------------------
558-- Helpers for braces
476-- Helpers for braces
559
477
560-- | Make the inner computation use braces around single-line layouts.
478-- | Make the inner computation use braces around single-line layouts.
479+
561useBraces :: R () -> R ()
480useBraces :: R () -> R ()
562−useBraces (R r) = R (local (\i -> i {rcCanUseBraces = True}) r)
481+useBraces (R r) = R (local (\i -> i {rcCanUseBraces = True}) r)
563
482
564-- | Make the inner computation omit braces around single-line layouts.
483-- | Make the inner computation omit braces around single-line layouts.
484+
565dontUseBraces :: R () -> R ()
485dontUseBraces :: R () -> R ()
566−dontUseBraces (R r) = R (local (\i -> i {rcCanUseBraces = False}) r)
486+dontUseBraces (R r) = R (local (\i -> i {rcCanUseBraces = False}) r)
567
487
568-- | Return 'True' if we can use braces in this context.
488-- | Return 'True' if we can use braces in this context.
489+
569canUseBraces :: R Bool
490canUseBraces :: R Bool
570−canUseBraces = R (asks rcCanUseBraces)
491+canUseBraces = R $ asks rcCanUseBraces
571
492
572----------------------------------------------------------------------------
493----------------------------------------------------------------------------
573-- Constants
494-- Constants
574
495
575-- | Indentation step.
496-- | Indentation step.
497+
576indentStep :: Int
498indentStep :: Int
577indentStep = 2
499indentStep = 2
src/Ormolu/Printer/Meat/Common.hs+57−62
@@ -1,35 +1,37 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3
3
4-- | Rendering of commonly useful bits.
4-- | Rendering of commonly useful bits.
5+
5module Ormolu.Printer.Meat.Common
6module Ormolu.Printer.Meat.Common
6− ( FamilyStyle (..),
7+ ( FamilyStyle (..)
7− p_hsmodName,
8+ , p_hsmodName
8− p_ieWrappedName,
9+ , p_ieWrappedName
9− p_rdrName,
10+ , p_rdrName
10− doesNotNeedExtraParens,
11+ , doesNotNeedExtraParens
11− p_qualName,
12+ , p_qualName
12− p_infixDefHelper,
13+ , p_infixDefHelper
13− p_hsDocString,
14+ , p_hsDocString
14− p_hsDocName,
15+ , p_hsDocName
15 )
16 )
16where
17where
17
18
18import Control.Monad
19import Control.Monad
19import Data.List (isPrefixOf)
20import Data.List (isPrefixOf)
20−import qualified Data.Text as T
21+import Data.Maybe (isJust)
21import GHC hiding (GhcPs, IE)
22import GHC hiding (GhcPs, IE)
22import Name (nameStableString)
23import Name (nameStableString)
23import OccName (OccName (..))
24import OccName (OccName (..))
24import Ormolu.Printer.Combinators
25import Ormolu.Printer.Combinators
25import Ormolu.Utils
26import Ormolu.Utils
27+import RdrName (RdrName (..))
28+import qualified Data.Text as T
26
29
27-- | Data and type family style.
30-- | Data and type family style.
31+
28data FamilyStyle
32data FamilyStyle
29− = -- | Declarations in type classes
33+ = Associated -- ^ Declarations in type classes
30− Associated
31− | -- | Top-level declarations
34+ | Free -- ^ Top-level declarations
32− Free
33
35
34p_hsmodName :: ModuleName -> R ()
36p_hsmodName :: ModuleName -> R ()
35p_hsmodName mname = do
37p_hsmodName mname = do
@@ -50,6 +52,7 @@ p_ieWrappedName = \case
50 p_rdrName x
52 p_rdrName x
51
53
52-- | Render a @'Located' 'RdrName'@.
54-- | Render a @'Located' 'RdrName'@.
55+
53p_rdrName :: Located RdrName -> R ()
56p_rdrName :: Located RdrName -> R ()
54p_rdrName l@(L spn _) = located l $ \x -> do
57p_rdrName l@(L spn _) = located l $ \x -> do
55 ids <- getAnns spn
58 ids <- getAnns spn
@@ -64,9 +67,9 @@ p_rdrName l@(L spn _) = located l $ \x -> do
64 singleQuoteWrapper =
67 singleQuoteWrapper =
65 if AnnSimpleQuote `elem` ids
68 if AnnSimpleQuote `elem` ids
66 then \y -> do
69 then \y -> do
67− txt "'"
70+ txt "'"
68− y
71+ y
69− else id
72+ else id
70 m =
73 m =
71 case x of
74 case x of
72 Unqual occName ->
75 Unqual occName ->
@@ -74,10 +77,10 @@ p_rdrName l@(L spn _) = located l $ \x -> do
74 Qual mname occName ->
77 Qual mname occName ->
75 p_qualName mname occName
78 p_qualName mname occName
76 Orig _ occName ->
79 Orig _ occName ->
77− -- This is used when GHC generates code that will be fed into
80+ -- NOTE This is used when GHC generates code that will be fed
78− -- the renamer (e.g. from deriving clauses), but where we want
81+ -- into the renamer (e.g. from deriving clauses), but where we
79− -- to say that something comes from given module which is not
82+ -- want to say that something comes from given module which is
80− -- specified in the source code, e.g. @Prelude.map@.
83+ -- not specified in the source code, e.g. @Prelude.map@.
81 --
84 --
82 -- My current understanding is that the provided module name
85 -- My current understanding is that the provided module name
83 -- serves no purpose for us and can be safely ignored.
86 -- serves no purpose for us and can be safely ignored.
@@ -93,15 +96,16 @@ p_rdrName l@(L spn _) = located l $ \x -> do
93-- to detect e.g. tuples for which annotations will indicate parentheses,
96-- to detect e.g. tuples for which annotations will indicate parentheses,
94-- but the parentheses are already part of the symbol, so no extra layer of
97-- but the parentheses are already part of the symbol, so no extra layer of
95-- parentheses should be added. It also detects the [] literal.
98-- parentheses should be added. It also detects the [] literal.
99+
96doesNotNeedExtraParens :: RdrName -> Bool
100doesNotNeedExtraParens :: RdrName -> Bool
97doesNotNeedExtraParens = \case
101doesNotNeedExtraParens = \case
98 Exact name ->
102 Exact name ->
99 let s = nameStableString name
103 let s = nameStableString name
100− in -- I'm not sure this "stable string" is stable enough, but it looks
104+ -- NOTE I'm not sure this "stable string" is stable enough, but it looks
101− -- like this is the most robust way to tell if we're looking at
105+ -- like this is the most robust way to tell if we're looking at exactly
102− -- exactly this piece of built-in syntax.
106+ -- this piece of built-in syntax.
103− ("$ghc-prim$GHC.Tuple$" `isPrefixOf` s)
107+ in ("$ghc-prim$GHC.Tuple$" `isPrefixOf` s) ||
104− || ("$ghc-prim$GHC.Types$[]" `isPrefixOf` s)
108+ ("$ghc-prim$GHC.Types$[]" `isPrefixOf` s)
105 _ -> False
109 _ -> False
106
110
107p_qualName :: ModuleName -> OccName -> R ()
111p_qualName :: ModuleName -> OccName -> R ()
@@ -111,19 +115,16 @@ p_qualName mname occName = do
111 atom occName
115 atom occName
112
116
113-- | A helper for formatting infix constructions in lhs of definitions.
117-- | A helper for formatting infix constructions in lhs of definitions.
118+
114−p_infixDefHelper ::
119+p_infixDefHelper
115− -- | Whether to format in infix style
120+ :: Bool -- ^ Whether to format in infix style
116− Bool ->
121+ -> (R () -> R ()) -- ^ Indentation-bumping wrapper
117− -- | Whether to bump indentation for arguments
118− Bool ->
119− -- | How to print the operator\/name
122+ -> R () -- ^ How to print the operator\/name
120− R () ->
123+ -> [R ()] -- ^ How to print the arguments
121− -- | How to print the arguments
122− [R ()] ->
123− R ()
124+ -> R ()
124−p_infixDefHelper isInfix indentArgs name args =
125+p_infixDefHelper isInfix inci' name args =
125 case (isInfix, args) of
126 case (isInfix, args) of
126− (True, p0 : p1 : ps) -> do
127+ (True, p0:p1:ps) -> do
127 let parens' =
128 let parens' =
128 if null ps
129 if null ps
129 then id
130 then id
@@ -131,45 +132,38 @@ p_infixDefHelper isInfix indentArgs name args =
131 parens' $ do
132 parens' $ do
132 p0
133 p0
133 breakpoint
134 breakpoint
134− inci . sitcc $ do
135+ inci $ sitcc $ do
135 name
136 name
136 space
137 space
137 p1
138 p1
138− unless (null ps) . inciIf indentArgs $ do
139+ unless (null ps) . inci' $ do
139 breakpoint
140 breakpoint
140 sitcc (sep breakpoint sitcc ps)
141 sitcc (sep breakpoint sitcc ps)
141 (_, ps) -> do
142 (_, ps) -> do
142 name
143 name
143 unless (null ps) $ do
144 unless (null ps) $ do
144 breakpoint
145 breakpoint
145− inciIf indentArgs $ sitcc (sep breakpoint sitcc args)
146+ inci' $ sitcc (sep breakpoint sitcc args)
146
147
147-- | Print a Haddock.
148-- | Print a Haddock.
149+
148−p_hsDocString ::
150+p_hsDocString
149− -- | Haddock style
151+ :: HaddockStyle -- ^ Haddock style
150− HaddockStyle ->
151− -- | Finish the doc string with a newline
152+ -> Bool -- ^ Finish the doc string with a newline
152− Bool ->
153− -- | The doc string to render
153+ -> LHsDocString -- ^ The doc string to render
154− LHsDocString ->
155− R ()
154+ -> R ()
156p_hsDocString hstyle needsNewline (L l str) = do
155p_hsDocString hstyle needsNewline (L l str) = do
157− let isCommentSpan = \case
156+ goesAfterComment <- isJust <$> getLastCommentSpan
158− HaddockSpan _ _ -> True
159− CommentSpan _ -> True
160− _ -> False
161− goesAfterComment <- maybe False isCommentSpan <$> getSpanMark
162 -- Make sure the Haddock is separated by a newline from other comments.
157 -- Make sure the Haddock is separated by a newline from other comments.
163 when goesAfterComment newline
158 when goesAfterComment newline
164 forM_ (zip (splitDocString str) (True : repeat False)) $ \(x, isFirst) -> do
159 forM_ (zip (splitDocString str) (True : repeat False)) $ \(x, isFirst) -> do
165 if isFirst
160 if isFirst
166 then case hstyle of
161 then case hstyle of
167− Pipe -> txt "-- |"
162+ Pipe -> txt "-- |" >> space
168− Caret -> txt "-- ^"
163+ Caret -> txt "-- ^" >> space
169− Asterisk n -> txt ("-- " <> T.replicate n "*")
164+ Asterisk n -> txt ("-- " <> T.replicate n "*") >> space
170 Named name -> p_hsDocName name
165 Named name -> p_hsDocName name
171− else newline >> txt "--"
166+ else newline >> txt "--" >> space
172− space
173 unless (T.null x) (txt x)
167 unless (T.null x) (txt x)
174 when needsNewline newline
168 when needsNewline newline
175 case l of
169 case l of
@@ -177,9 +171,10 @@ p_hsDocString hstyle needsNewline (L l str) = do
177 -- It's often the case that the comment itself doesn't have a span
171 -- It's often the case that the comment itself doesn't have a span
178 -- attached to it and instead its location can be obtained from
172 -- attached to it and instead its location can be obtained from
179 -- nearest enclosing span.
173 -- nearest enclosing span.
180− getEnclosingSpan (const True) >>= mapM_ (setSpanMark . HaddockSpan hstyle)
174+ getEnclosingSpan (const True) >>= mapM_ (setLastCommentSpan (Just hstyle))
181− RealSrcSpan spn -> setSpanMark (HaddockSpan hstyle spn)
175+ RealSrcSpan spn -> setLastCommentSpan (Just hstyle) spn
182
176
183-- | Print anchor of named doc section.
177-- | Print anchor of named doc section.
178+
184p_hsDocName :: String -> R ()
179p_hsDocName :: String -> R ()
185p_hsDocName name = txt ("-- $" <> T.pack name)
180p_hsDocName name = txt ("-- $" <> T.pack name)
src/Ormolu/Printer/Meat/Declaration.hs+136−202
@@ -1,20 +1,20 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE PatternSynonyms #-}
3{-# LANGUAGE PatternSynonyms #-}
4{-# LANGUAGE RecordWildCards #-}
4{-# LANGUAGE RecordWildCards #-}
5−{-# LANGUAGE ViewPatterns #-}
5+{-# LANGUAGE ViewPatterns #-}
6
6
7-- | Rendering of declarations.
7-- | Rendering of declarations.
8+
8module Ormolu.Printer.Meat.Declaration
9module Ormolu.Printer.Meat.Declaration
9− ( p_hsDecls,
10+ ( p_hsDecls
10− p_hsDeclsRespectGrouping,
11+ , hasSeparatedDecls
11 )
12 )
12where
13where
13
14
14import Data.List (sort)
15import Data.List (sort)
15import Data.List.NonEmpty (NonEmpty (..), (<|))
16import Data.List.NonEmpty (NonEmpty (..), (<|))
16−import qualified Data.List.NonEmpty as NE
17+import GHC
17−import GHC hiding (InlinePragma)
18import OccName (occNameFS)
18import OccName (occNameFS)
19import Ormolu.Printer.Combinators
19import Ormolu.Printer.Combinators
20import Ormolu.Printer.Meat.Common
20import Ormolu.Printer.Meat.Common
@@ -34,57 +34,27 @@ import Ormolu.Printer.Meat.Declaration.Value
34import Ormolu.Printer.Meat.Declaration.Warning
34import Ormolu.Printer.Meat.Declaration.Warning
35import Ormolu.Printer.Meat.Type
35import Ormolu.Printer.Meat.Type
36import Ormolu.Utils
36import Ormolu.Utils
37−
37+import RdrName (rdrNameOcc)
38−data UserGrouping
38+import qualified Data.List.NonEmpty as NE
39− = -- | Always put newlines where we think they should be
40− Disregard
41− | -- | Respect user preferences regarding grouping
42− Respect
43− deriving (Eq, Show)
44
39
45p_hsDecls :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
40p_hsDecls :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
46−p_hsDecls = p_hsDecls' Disregard
47−
48−-- | Like 'p_hsDecls' but respects user choices regarding grouping. If the
49−-- user omits newlines between declarations, we also omit them in most
50−-- cases, except when said declarations have associated Haddocks.
51−--
52−-- Does some normalization (compress subsequent newlines into a single one)
53−p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
54−p_hsDeclsRespectGrouping = p_hsDecls' Respect
55−
56−p_hsDecls' :: UserGrouping -> FamilyStyle -> [LHsDecl GhcPs] -> R ()
57−p_hsDecls' grouping style decls =
58− sepSemi id $
41+p_hsDecls style decls = sepSemi id $
59− -- Return a list of rendered declarations, adding a newline to separate
42+ -- Return a list of rendered declarations, adding a newline to separate
60− -- groups.
43+ -- groups.
61− case groupDecls decls of
44+ case groupDecls decls of
62− [] -> []
45+ [] -> []
63− (x : xs) -> renderGroup x ++ concat (zipWith renderGroupWithPrev (x : xs) xs)
46+ (x:xs) ->
64− where
47+ NE.toList (renderGroup x)
65− renderGroup = NE.toList . fmap (located' $ dontUseBraces . p_hsDecl style)
48+ ++ concatMap (NE.toList . separateGroup . renderGroup) xs
66− renderGroupWithPrev prev curr =
67− -- We can omit a blank line when the user didn't add one, but we must
68− -- ensure we always add blank lines around documented declarations
69− case grouping of
70− Disregard ->
71− breakpoint : renderGroup curr
72− Respect ->
73− if separatedByBlankNE getLoc prev curr
74− || isDocumented prev
75− || isDocumented curr
76− then breakpoint : renderGroup curr
77− else renderGroup curr
78−
79−-- | Is a declaration group documented?
80−isDocumented :: NonEmpty (LHsDecl GhcPs) -> Bool
81−isDocumented = any (isHaddock . unLoc)
82 where
49 where
83− isHaddock DocNext = True
50+ renderGroup = fmap (located' $ dontUseBraces . p_hsDecl style)
84− isHaddock DocPrev = True
51+ separateGroup (x :| xs) = (breakpoint' >> x) :| xs
85− isHaddock _ = False
86
52
87-- | Group relevant declarations together.
53-- | Group relevant declarations together.
54+--
55+-- Add a declaration to a group iff it is relevant to either the first or
56+-- the last declaration of the group.
57+
88groupDecls :: [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]
58groupDecls :: [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]
89groupDecls [] = []
59groupDecls [] = []
90groupDecls (l@(L _ DocNext) : xs) =
60groupDecls (l@(L _ DocNext) : xs) =
@@ -92,41 +62,45 @@ groupDecls (l@(L _ DocNext) : xs) =
92 -- in the next block:
62 -- in the next block:
93 case groupDecls xs of
63 case groupDecls xs of
94 [] -> [l :| []]
64 [] -> [l :| []]
95− (x : xs') -> (l <| x) : xs'
65+ (x:xs') -> (l <| x) : xs'
96−groupDecls (header : xs) =
66+groupDecls (lhdr:xs) =
97− let (grp, rest) = flip span (zip (header : xs) xs) $ \(previous, current) ->
67+ let -- Pick the first decl as the group header
98− let relevantToHdr = groupedDecls header current
68+ hdr = unLoc lhdr
99− relevantToPrev = groupedDecls previous current
69+ -- Zip rest of the decls with their previous decl
100− isDeclSeries = declSeries previous current
70+ zipped = zip (lhdr:xs) xs
71+ -- Pick decls from the tail if they are relevant to the group header
72+ -- or the previous decl.
73+ (grp, rest) = flip span zipped $ \(L _ prev, L _ cur) ->
74+ let relevantToHdr = groupedDecls hdr cur
75+ relevantToPrev = groupedDecls prev cur
101− in isDeclSeries || relevantToHdr || relevantToPrev
76+ in relevantToHdr || relevantToPrev
102− in (header :| map snd grp) : groupDecls (map snd rest)
77+ in (lhdr :| map snd grp) : groupDecls (map snd rest)
103
78
104p_hsDecl :: FamilyStyle -> HsDecl GhcPs -> R ()
79p_hsDecl :: FamilyStyle -> HsDecl GhcPs -> R ()
105p_hsDecl style = \case
80p_hsDecl style = \case
106− TyClD NoExtField x -> p_tyClDecl style x
81+ TyClD NoExt x -> p_tyClDecl style x
107− ValD NoExtField x -> p_valDecl x
82+ ValD NoExt x -> p_valDecl x
108− SigD NoExtField x -> p_sigDecl x
83+ SigD NoExt x -> p_sigDecl x
109− InstD NoExtField x -> p_instDecl style x
84+ InstD NoExt x -> p_instDecl style x
110− DerivD NoExtField x -> p_derivDecl x
85+ DerivD NoExt x -> p_derivDecl x
111− DefD NoExtField x -> p_defaultDecl x
86+ DefD NoExt x -> p_defaultDecl x
112− ForD NoExtField x -> p_foreignDecl x
87+ ForD NoExt x -> p_foreignDecl x
113− WarningD NoExtField x -> p_warnDecls x
88+ WarningD NoExt x -> p_warnDecls x
114− AnnD NoExtField x -> p_annDecl x
89+ AnnD NoExt x -> p_annDecl x
115− RuleD NoExtField x -> p_ruleDecls x
90+ RuleD NoExt x -> p_ruleDecls x
116− SpliceD NoExtField x -> p_spliceDecl x
91+ SpliceD NoExt x -> p_spliceDecl x
117− DocD NoExtField docDecl ->
92+ DocD NoExt docDecl ->
118 case docDecl of
93 case docDecl of
119 DocCommentNext str -> p_hsDocString Pipe False (noLoc str)
94 DocCommentNext str -> p_hsDocString Pipe False (noLoc str)
120 DocCommentPrev str -> p_hsDocString Caret False (noLoc str)
95 DocCommentPrev str -> p_hsDocString Caret False (noLoc str)
121 DocCommentNamed name str -> p_hsDocString (Named name) False (noLoc str)
96 DocCommentNamed name str -> p_hsDocString (Named name) False (noLoc str)
122− DocGroup n str -> p_hsDocString (Asterisk n) False (noLoc str)
97+ DocGroup n str -> p_hsDocString (Asterisk n) False (noLoc str)
123− RoleAnnotD NoExtField x -> p_roleAnnot x
98+ RoleAnnotD NoExt x -> p_roleAnnot x
124− KindSigD NoExtField s -> p_standaloneKindSig s
99+ XHsDecl _ -> notImplemented "XHsDecl"
125− XHsDecl x -> noExtCon x
126
100
127p_tyClDecl :: FamilyStyle -> TyClDecl GhcPs -> R ()
101p_tyClDecl :: FamilyStyle -> TyClDecl GhcPs -> R ()
128p_tyClDecl style = \case
102p_tyClDecl style = \case
129− FamDecl NoExtField x -> p_famDecl style x
103+ FamDecl NoExt x -> p_famDecl style x
130 SynDecl {..} -> p_synDecl tcdLName tcdFixity tcdTyVars tcdRhs
104 SynDecl {..} -> p_synDecl tcdLName tcdFixity tcdTyVars tcdRhs
131 DataDecl {..} ->
105 DataDecl {..} ->
132 p_dataDecl
106 p_dataDecl
@@ -147,65 +121,39 @@ p_tyClDecl style = \case
147 tcdATs
121 tcdATs
148 tcdATDefs
122 tcdATDefs
149 tcdDocs
123 tcdDocs
150− XTyClDecl x -> noExtCon x
124+ XTyClDecl {} -> notImplemented "XTyClDecl"
151
125
152p_instDecl :: FamilyStyle -> InstDecl GhcPs -> R ()
126p_instDecl :: FamilyStyle -> InstDecl GhcPs -> R ()
153p_instDecl style = \case
127p_instDecl style = \case
154− ClsInstD NoExtField x -> p_clsInstDecl x
128+ ClsInstD NoExt x -> p_clsInstDecl x
155− TyFamInstD NoExtField x -> p_tyFamInstDecl style x
129+ TyFamInstD NoExt x -> p_tyFamInstDecl style x
156− DataFamInstD NoExtField x -> p_dataFamInstDecl style x
130+ DataFamInstD NoExt x -> p_dataFamInstDecl style x
157− XInstDecl x -> noExtCon x
131+ XInstDecl _ -> notImplemented "XInstDecl"
158
132
159p_derivDecl :: DerivDecl GhcPs -> R ()
133p_derivDecl :: DerivDecl GhcPs -> R ()
160p_derivDecl = \case
134p_derivDecl = \case
161− d@DerivDecl {} -> p_standaloneDerivDecl d
135+ d@DerivDecl {..} -> p_standaloneDerivDecl d
162− XDerivDecl x -> noExtCon x
136+ XDerivDecl _ -> notImplemented "XDerivDecl standalone deriving"
163
137
164-- | Determine if these declarations should be grouped together.
138-- | Determine if these declarations should be grouped together.
165−groupedDecls ::
166− LHsDecl GhcPs ->
167− LHsDecl GhcPs ->
168− Bool
169−groupedDecls (L l_x x') (L l_y y') =
170− case (x', y') of
171− (TypeSignature ns, FunctionBody ns') -> ns `intersects` ns'
172− (TypeSignature ns, DefaultSignature ns') -> ns `intersects` ns'
173− (DefaultSignature ns, TypeSignature ns') -> ns `intersects` ns'
174− (DefaultSignature ns, FunctionBody ns') -> ns `intersects` ns'
175− (x, FunctionBody ns) | Just ns' <- isPragma x -> ns `intersects` ns'
176− (FunctionBody ns, x) | Just ns' <- isPragma x -> ns `intersects` ns'
177− (x, DataDeclaration n) | Just ns <- isPragma x -> n `elem` ns
178− (DataDeclaration n, x)
179− | Just ns <- isPragma x ->
180− let f = occNameFS . rdrNameOcc in f n `elem` map f ns
181− (x, y)
182− | Just ns <- isPragma x,
183− Just ns' <- isPragma y ->
184− ns `intersects` ns'
185− (x, TypeSignature ns) | Just ns' <- isPragma x -> ns `intersects` ns'
186− (TypeSignature ns, x) | Just ns' <- isPragma x -> ns `intersects` ns'
187− (PatternSignature ns, Pattern n) -> n `elem` ns
188− (KindSignature n, DataDeclaration n') -> n == n'
189− (KindSignature n, ClassDeclaration n') -> n == n'
190− (KindSignature n, FamilyDeclaration n') -> n == n'
191− -- Special case for TH splices, we look at locations
192− (Splice, Splice) -> not (separatedByBlank id l_x l_y)
193− -- This looks only at Haddocks, normal comments are handled elsewhere
194− (DocNext, _) -> True
195− (_, DocPrev) -> True
196− _ -> False
197
139
198−-- | Detect declaration series that should not have blanks between them.
140+groupedDecls
199−declSeries ::
200− LHsDecl GhcPs ->
141+ :: HsDecl GhcPs
201− LHsDecl GhcPs ->
142+ -> HsDecl GhcPs
202− Bool
143+ -> Bool
203−declSeries (L _ x) (L _ y) =
144+groupedDecls (TypeSignature ns) (FunctionBody ns') = ns `intersects` ns'
204− case (x, y) of
145+groupedDecls x (FunctionBody ns) | Just ns' <- isPragma x = ns `intersects` ns'
205− ( SigD NoExtField (TypeSig NoExtField _ _),
146+groupedDecls (FunctionBody ns) x | Just ns' <- isPragma x = ns `intersects` ns'
206− SigD NoExtField (TypeSig NoExtField _ _)
147+groupedDecls x (DataDeclaration n) | Just ns <- isPragma x = n `elem` ns
207− ) -> True
148+groupedDecls (DataDeclaration n) x | Just ns <- isPragma x =
149+ let f = occNameFS . rdrNameOcc in f n `elem` map f ns
150+groupedDecls x y | Just ns <- isPragma x, Just ns' <- isPragma y = ns `intersects` ns'
151+groupedDecls x (TypeSignature ns) | Just ns' <- isPragma x = ns `intersects` ns'
152+groupedDecls (TypeSignature ns) x | Just ns' <- isPragma x = ns `intersects` ns'
153+groupedDecls (PatternSignature ns) (Pattern n) = n `elem` ns
154+groupedDecls DocNext _ = True
155+groupedDecls _ DocPrev = True
208− _ -> False
156+groupedDecls _ _ = False
209
157
210intersects :: Ord a => [a] -> [a] -> Bool
158intersects :: Ord a => [a] -> [a] -> Bool
211intersects a b = go (sort a) (sort b)
159intersects a b = go (sort a) (sort b)
@@ -213,14 +161,22 @@ intersects a b = go (sort a) (sort b)
213 go :: Ord a => [a] -> [a] -> Bool
161 go :: Ord a => [a] -> [a] -> Bool
214 go _ [] = False
162 go _ [] = False
215 go [] _ = False
163 go [] _ = False
216− go (x : xs) (y : ys)
164+ go (x:xs) (y:ys)
217− | x < y = go xs (y : ys)
165+ | x < y = go xs (y:ys)
218− | x > y = go (x : xs) ys
166+ | x > y = go (x:xs) ys
219 | otherwise = True
167 | otherwise = True
220
168
169+-- | Checks if given list of declarations contain a pair which should
170+-- be separated by a blank line.
171+
172+hasSeparatedDecls :: [LHsDecl GhcPs] -> Bool
173+hasSeparatedDecls xs = case groupDecls xs of
174+ _:_:_ -> True
175+ _ -> False
176+
221−isPragma ::
177+isPragma
222− HsDecl GhcPs ->
178+ :: HsDecl GhcPs
223− Maybe [RdrName]
179+ -> Maybe [RdrName]
224isPragma = \case
180isPragma = \case
225 InlinePragma n -> Just [n]
181 InlinePragma n -> Just [n]
226 SpecializePragma n -> Just [n]
182 SpecializePragma n -> Just [n]
@@ -230,98 +186,76 @@ isPragma = \case
230 WarningPragma n -> Just n
186 WarningPragma n -> Just n
231 _ -> Nothing
187 _ -> Nothing
232
188
233−-- Declarations that do not refer to names
234−
235−pattern Splice :: HsDecl GhcPs
236−pattern Splice <- SpliceD NoExtField (SpliceDecl NoExtField _ _)
237−
238-- Declarations referring to a single name
189-- Declarations referring to a single name
239
190
240−pattern
241− InlinePragma,
191+pattern InlinePragma
242− SpecializePragma,
192+ , SpecializePragma
243− SCCPragma,
193+ , SCCPragma
244− AnnTypePragma,
194+ , AnnTypePragma
245− AnnValuePragma,
195+ , AnnValuePragma
246− Pattern,
196+ , Pattern
247− DataDeclaration,
248− ClassDeclaration,
249− KindSignature,
250− FamilyDeclaration ::
251− RdrName -> HsDecl GhcPs
197+ , DataDeclaration :: RdrName -> HsDecl GhcPs
252−pattern InlinePragma n <- SigD NoExtField (InlineSig NoExtField (L _ n) _)
198+pattern InlinePragma n <- SigD NoExt (InlineSig NoExt (L _ n) _)
253−pattern SpecializePragma n <- SigD NoExtField (SpecSig NoExtField (L _ n) _ _)
199+pattern SpecializePragma n <- SigD NoExt (SpecSig NoExt (L _ n) _ _)
254−pattern SCCPragma n <- SigD NoExtField (SCCFunSig NoExtField _ (L _ n) _)
200+pattern SCCPragma n <- SigD NoExt (SCCFunSig NoExt _ (L _ n) _)
255−pattern AnnTypePragma n <- AnnD NoExtField (HsAnnotation NoExtField _ (TypeAnnProvenance (L _ n)) _)
201+pattern AnnTypePragma n <- AnnD NoExt (HsAnnotation NoExt _ (TypeAnnProvenance (L _ n)) _)
256−pattern AnnValuePragma n <- AnnD NoExtField (HsAnnotation NoExtField _ (ValueAnnProvenance (L _ n)) _)
202+pattern AnnValuePragma n <- AnnD NoExt (HsAnnotation NoExt _ (ValueAnnProvenance (L _ n)) _)
257−pattern Pattern n <- ValD NoExtField (PatSynBind NoExtField (PSB _ (L _ n) _ _ _))
203+pattern Pattern n <- ValD NoExt (PatSynBind NoExt (PSB _ (L _ n) _ _ _))
258−pattern DataDeclaration n <- TyClD NoExtField (DataDecl NoExtField (L _ n) _ _ _)
204+pattern DataDeclaration n <- TyClD NoExt (DataDecl NoExt (L _ n) _ _ _)
259−pattern ClassDeclaration n <- TyClD NoExtField (ClassDecl NoExtField _ (L _ n) _ _ _ _ _ _ _ _)
260−pattern KindSignature n <- KindSigD NoExtField (StandaloneKindSig NoExtField (L _ n) _)
261−pattern FamilyDeclaration n <- TyClD NoExtField (FamDecl NoExtField (FamilyDecl NoExtField _ (L _ n) _ _ _ _))
262
205
263-- Declarations which can refer to multiple names
206-- Declarations which can refer to multiple names
264
207
265−pattern
266− TypeSignature,
208+pattern TypeSignature
267− DefaultSignature,
268− FunctionBody,
209+ , FunctionBody
269− PatternSignature,
210+ , PatternSignature
270− WarningPragma ::
271− [RdrName] -> HsDecl GhcPs
211+ , WarningPragma :: [RdrName] -> HsDecl GhcPs
272pattern TypeSignature n <- (sigRdrNames -> Just n)
212pattern TypeSignature n <- (sigRdrNames -> Just n)
273−pattern DefaultSignature n <- (defSigRdrNames -> Just n)
274pattern FunctionBody n <- (funRdrNames -> Just n)
213pattern FunctionBody n <- (funRdrNames -> Just n)
275pattern PatternSignature n <- (patSigRdrNames -> Just n)
214pattern PatternSignature n <- (patSigRdrNames -> Just n)
276pattern WarningPragma n <- (warnSigRdrNames -> Just n)
215pattern WarningPragma n <- (warnSigRdrNames -> Just n)
277
216
278pattern DocNext, DocPrev :: HsDecl GhcPs
217pattern DocNext, DocPrev :: HsDecl GhcPs
279−pattern DocNext <- (DocD NoExtField (DocCommentNext _))
218+pattern DocNext <- (DocD NoExt (DocCommentNext _))
280−pattern DocPrev <- (DocD NoExtField (DocCommentPrev _))
219+pattern DocPrev <- (DocD NoExt (DocCommentPrev _))
281
220
282sigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
221sigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
283−sigRdrNames (SigD NoExtField (TypeSig NoExtField ns _)) = Just $ map unLoc ns
222+sigRdrNames (SigD NoExt (TypeSig NoExt ns _)) = Just $ map unLoc ns
284−sigRdrNames (SigD NoExtField (ClassOpSig NoExtField _ ns _)) = Just $ map unLoc ns
223+sigRdrNames (SigD NoExt (ClassOpSig NoExt _ ns _)) = Just $ map unLoc ns
285−sigRdrNames (SigD NoExtField (PatSynSig NoExtField ns _)) = Just $ map unLoc ns
224+sigRdrNames (SigD NoExt (PatSynSig NoExt ns _)) = Just $ map unLoc ns
286sigRdrNames _ = Nothing
225sigRdrNames _ = Nothing
287
226
288−defSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
289−defSigRdrNames (SigD NoExtField (ClassOpSig NoExtField True ns _)) = Just $ map unLoc ns
290−defSigRdrNames _ = Nothing
291−
292funRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
227funRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
293−funRdrNames (ValD NoExtField (FunBind NoExtField (L _ n) _ _ _)) = Just [n]
228+funRdrNames (ValD NoExt (FunBind NoExt (L _ n) _ _ _)) = Just [n]
294−funRdrNames (ValD NoExtField (PatBind NoExtField (L _ n) _ _)) = Just $ patBindNames n
229+funRdrNames (ValD NoExt (PatBind NoExt (L _ n) _ _)) = Just $ patBindNames n
295funRdrNames _ = Nothing
230funRdrNames _ = Nothing
296
231
297patSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
232patSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
298−patSigRdrNames (SigD NoExtField (PatSynSig NoExtField ns _)) = Just $ map unLoc ns
233+patSigRdrNames (SigD NoExt (PatSynSig NoExt ns _)) = Just $ map unLoc ns
299patSigRdrNames _ = Nothing
234patSigRdrNames _ = Nothing
300
235
301warnSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
236warnSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
302−warnSigRdrNames (WarningD NoExtField (Warnings NoExtField _ ws)) = Just $
237+warnSigRdrNames (WarningD NoExt (Warnings NoExt _ ws)) = Just $ flip concatMap ws $ \case
303− flip concatMap ws $ \case
304− L _ (Warning NoExtField ns _) -> map unLoc ns
238+ L _ (Warning NoExt ns _) -> map unLoc ns
305− L _ (XWarnDecl x) -> noExtCon x
239+ L _ (XWarnDecl NoExt) -> []
306warnSigRdrNames _ = Nothing
240warnSigRdrNames _ = Nothing
307
241
308patBindNames :: Pat GhcPs -> [RdrName]
242patBindNames :: Pat GhcPs -> [RdrName]
309−patBindNames (TuplePat NoExtField ps _) = concatMap (patBindNames . unLoc) ps
243+patBindNames (TuplePat NoExt ps _) = concatMap (patBindNames . unLoc) ps
310−patBindNames (VarPat NoExtField (L _ n)) = [n]
244+patBindNames (VarPat NoExt (L _ n)) = [n]
311−patBindNames (WildPat NoExtField) = []
245+patBindNames (WildPat NoExt) = []
312−patBindNames (LazyPat NoExtField (L _ p)) = patBindNames p
246+patBindNames (LazyPat NoExt (L _ p)) = patBindNames p
313−patBindNames (BangPat NoExtField (L _ p)) = patBindNames p
247+patBindNames (BangPat NoExt (L _ p)) = patBindNames p
314−patBindNames (ParPat NoExtField (L _ p)) = patBindNames p
248+patBindNames (ParPat NoExt (L _ p)) = patBindNames p
315−patBindNames (ListPat NoExtField ps) = concatMap (patBindNames . unLoc) ps
249+patBindNames (ListPat NoExt ps) = concatMap (patBindNames . unLoc) ps
316−patBindNames (AsPat NoExtField (L _ n) (L _ p)) = n : patBindNames p
250+patBindNames (AsPat NoExt (L _ n) (L _ p)) = n : patBindNames p
317−patBindNames (SumPat NoExtField (L _ p) _ _) = patBindNames p
251+patBindNames (SumPat NoExt (L _ p) _ _) = patBindNames p
318−patBindNames (ViewPat NoExtField _ (L _ p)) = patBindNames p
252+patBindNames (ViewPat NoExt _ (L _ p)) = patBindNames p
319−patBindNames (SplicePat NoExtField _) = []
253+patBindNames (SplicePat NoExt _) = []
320−patBindNames (LitPat NoExtField _) = []
254+patBindNames (LitPat NoExt _) = []
321−patBindNames (SigPat _ (L _ p) _) = patBindNames p
255+patBindNames (SigPat _ (L _ p)) = patBindNames p
322−patBindNames (NPat NoExtField _ _ _) = []
256+patBindNames (NPat NoExt _ _ _) = []
323−patBindNames (NPlusKPat NoExtField (L _ n) _ _ _ _) = [n]
257+patBindNames (NPlusKPat NoExt (L _ n) _ _ _ _) = [n]
324patBindNames (ConPatIn _ d) = concatMap (patBindNames . unLoc) (hsConPatArgs d)
258patBindNames (ConPatIn _ d) = concatMap (patBindNames . unLoc) (hsConPatArgs d)
325−patBindNames ConPatOut {} = notImplemented "ConPatOut" -- created by renamer
259+patBindNames (ConPatOut _ _ _ _ _ _ _) = notImplemented "ConPatOut" -- created by renamer
326−patBindNames (CoPat NoExtField _ p _) = patBindNames p
260+patBindNames (CoPat NoExt _ p _) = patBindNames p
327−patBindNames (XPat x) = noExtCon x
261+patBindNames (XPat NoExt) = notImplemented "XPat"
src/Ormolu/Printer/Meat/Declaration.hs-boot+3−3
@@ -1,6 +1,6 @@
1module Ormolu.Printer.Meat.Declaration
1module Ormolu.Printer.Meat.Declaration
2− ( p_hsDecls,
2+ ( p_hsDecls
3− p_hsDeclsRespectGrouping,
3+ , hasSeparatedDecls
4 )
4 )
5where
5where
6
6
@@ -9,4 +9,4 @@ import Ormolu.Printer.Combinators
9import Ormolu.Printer.Meat.Common
9import Ormolu.Printer.Meat.Common
10
10
11p_hsDecls :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
11p_hsDecls :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
12−p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
12+hasSeparatedDecls :: [LHsDecl GhcPs] -> Bool
src/Ormolu/Printer/Meat/Declaration/Annotation.hs+5−4
@@ -1,8 +1,8 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3
3
4module Ormolu.Printer.Meat.Declaration.Annotation
4module Ormolu.Printer.Meat.Declaration.Annotation
5− ( p_annDecl,
5+ ( p_annDecl
6 )
6 )
7where
7where
8
8
@@ -10,14 +10,15 @@ import GHC
10import Ormolu.Printer.Combinators
10import Ormolu.Printer.Combinators
11import Ormolu.Printer.Meat.Common
11import Ormolu.Printer.Meat.Common
12import Ormolu.Printer.Meat.Declaration.Value
12import Ormolu.Printer.Meat.Declaration.Value
13+import Ormolu.Utils
13
14
14p_annDecl :: AnnDecl GhcPs -> R ()
15p_annDecl :: AnnDecl GhcPs -> R ()
15p_annDecl = \case
16p_annDecl = \case
16− HsAnnotation NoExtField _ annProv expr -> pragma "ANN" . inci $ do
17+ HsAnnotation NoExt _ annProv expr -> pragma "ANN" . inci $ do
17 p_annProv annProv
18 p_annProv annProv
18 breakpoint
19 breakpoint
19 located expr p_hsExpr
20 located expr p_hsExpr
20− XAnnDecl x -> noExtCon x
21+ XAnnDecl {} -> notImplemented "XAnnDecl"
21
22
22p_annProv :: AnnProvenance (IdP GhcPs) -> R ()
23p_annProv :: AnnProvenance (IdP GhcPs) -> R ()
23p_annProv = \case
24p_annProv = \case
src/Ormolu/Printer/Meat/Declaration/Class.hs+53−41
@@ -1,10 +1,11 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
4
4
5-- | Rendering of type class declarations.
5-- | Rendering of type class declarations.
6+
6module Ormolu.Printer.Meat.Declaration.Class
7module Ormolu.Printer.Meat.Declaration.Class
7− ( p_classDecl,
8+ ( p_classDecl
8 )
9 )
9where
10where
10
11
@@ -12,63 +13,67 @@ import Class
12import Control.Arrow
13import Control.Arrow
13import Control.Monad
14import Control.Monad
14import Data.Foldable
15import Data.Foldable
15−import Data.List (sortOn)
16+import Data.List (sortBy)
17+import Data.Ord (comparing)
16import GHC
18import GHC
17import Ormolu.Printer.Combinators
19import Ormolu.Printer.Combinators
18import Ormolu.Printer.Meat.Common
20import Ormolu.Printer.Meat.Common
19−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
20import Ormolu.Printer.Meat.Type
21import Ormolu.Printer.Meat.Type
22+import Ormolu.Utils
23+import RdrName (RdrName (..))
24+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
21
25
22−p_classDecl ::
26+p_classDecl
23− LHsContext GhcPs ->
27+ :: LHsContext GhcPs
24− Located RdrName ->
28+ -> Located RdrName
25− LHsQTyVars GhcPs ->
29+ -> LHsQTyVars GhcPs
26− LexicalFixity ->
30+ -> LexicalFixity
27− [Located (FunDep (Located RdrName))] ->
31+ -> [Located (FunDep (Located RdrName))]
28− [LSig GhcPs] ->
32+ -> [LSig GhcPs]
29− LHsBinds GhcPs ->
33+ -> LHsBinds GhcPs
30− [LFamilyDecl GhcPs] ->
34+ -> [LFamilyDecl GhcPs]
31− [LTyFamDefltDecl GhcPs] ->
35+ -> [LTyFamDefltEqn GhcPs]
32− [LDocDecl] ->
36+ -> [LDocDecl]
33− R ()
37+ -> R ()
34−p_classDecl ctx name HsQTvs {..} fixity fdeps csigs cdefs cats catdefs cdocs = do
38+p_classDecl ctx name tvars fixity fdeps csigs cdefs cats catdefs cdocs = do
39+ let HsQTvs {..} = tvars
35− let variableSpans = getLoc <$> hsq_explicit
40+ variableSpans = getLoc <$> hsq_explicit
36 signatureSpans = getLoc name : variableSpans
41 signatureSpans = getLoc name : variableSpans
37 dependencySpans = getLoc <$> fdeps
42 dependencySpans = getLoc <$> fdeps
38 combinedSpans = getLoc ctx : (signatureSpans ++ dependencySpans)
43 combinedSpans = getLoc ctx : (signatureSpans ++ dependencySpans)
39− -- GHC's AST does not necessarily store each kind of element in source
40− -- location order. This happens because different declarations are stored
41− -- in different lists. Consequently, to get all the declarations in proper
42− -- order, they need to be manually sorted.
43− sigs = (getLoc &&& fmap (SigD NoExtField)) <$> csigs
44− vals = (getLoc &&& fmap (ValD NoExtField)) <$> toList cdefs
45− tyFams = (getLoc &&& fmap (TyClD NoExtField . FamDecl NoExtField)) <$> cats
46− docs = (getLoc &&& fmap (DocD NoExtField)) <$> cdocs
47− tyFamDefs =
48− ( getLoc &&& fmap (InstD NoExtField . TyFamInstD NoExtField)
49− )
50− <$> catdefs
51− allDecls =
52− snd <$> sortOn fst (sigs <> vals <> tyFams <> tyFamDefs <> docs)
53 txt "class"
44 txt "class"
54 switchLayout combinedSpans $ do
45 switchLayout combinedSpans $ do
55 breakpoint
46 breakpoint
56 inci $ do
47 inci $ do
57 p_classContext ctx
48 p_classContext ctx
58− switchLayout signatureSpans $
49+ switchLayout signatureSpans $ do
59 p_infixDefHelper
50 p_infixDefHelper
60 (isInfix fixity)
51 (isInfix fixity)
61− True
52+ inci
62 (p_rdrName name)
53 (p_rdrName name)
63 (located' p_hsTyVarBndr <$> hsq_explicit)
54 (located' p_hsTyVarBndr <$> hsq_explicit)
64 inci (p_classFundeps fdeps)
55 inci (p_classFundeps fdeps)
56+ -- NOTE GHC's AST does not necessarily store each kind of element in
57+ -- source location order. This happens because different declarations are
58+ -- stored in different lists. Consequently, to get all the declarations in
59+ -- proper order, they need to be manually sorted.
60+ let sigs = (getLoc &&& fmap (SigD NoExt)) <$> csigs
61+ vals = (getLoc &&& fmap (ValD NoExt)) <$> toList cdefs
62+ tyFams = (getLoc &&& fmap (TyClD NoExt . FamDecl NoExt)) <$> cats
63+ docs = (getLoc &&& fmap (DocD NoExt)) <$> cdocs
64+ tyFamDefs =
65+ ( getLoc &&& fmap (InstD NoExt . TyFamInstD NoExt . defltEqnToInstDecl)
66+ ) <$> catdefs
65− unless (null allDecls) $ do
67+ allDecls =
66− breakpoint
68+ snd <$> sortBy (comparing fst) (sigs <> vals <> tyFams <> tyFamDefs <> docs)
67− txt "where"
68 unless (null allDecls) $ do
69 unless (null allDecls) $ do
70+ space
71+ txt "where"
69 breakpoint -- Ensure whitespace is added after where clause.
72 breakpoint -- Ensure whitespace is added after where clause.
73+ -- Add newline before first declaration if the body contains separate
74+ -- declarations.
75+ when (hasSeparatedDecls allDecls) breakpoint'
70− inci (p_hsDeclsRespectGrouping Associated allDecls)
76+ inci (p_hsDecls Associated allDecls)
71−p_classDecl _ _ (XLHsQTyVars c) _ _ _ _ _ _ _ = noExtCon c
72
77
73p_classContext :: LHsContext GhcPs -> R ()
78p_classContext :: LHsContext GhcPs -> R ()
74p_classContext ctx = unless (null (unLoc ctx)) $ do
79p_classContext ctx = unless (null (unLoc ctx)) $ do
@@ -82,7 +87,7 @@ p_classFundeps fdeps = unless (null fdeps) $ do
82 breakpoint
87 breakpoint
83 txt "|"
88 txt "|"
84 space
89 space
85− inci $ sep commaDel (sitcc . located' p_funDep) fdeps
90+ sitcc $ sep (comma >> breakpoint) (sitcc . located' p_funDep) fdeps
86
91
87p_funDep :: FunDep (Located RdrName) -> R ()
92p_funDep :: FunDep (Located RdrName) -> R ()
88p_funDep (before, after) = do
93p_funDep (before, after) = do
@@ -95,6 +100,13 @@ p_funDep (before, after) = do
95----------------------------------------------------------------------------
100----------------------------------------------------------------------------
96-- Helpers
101-- Helpers
97
102
103+defltEqnToInstDecl :: TyFamDefltEqn GhcPs -> TyFamInstDecl GhcPs
104+defltEqnToInstDecl FamEqn {..} = TyFamInstDecl {..}
105+ where
106+ eqn = FamEqn {feqn_pats = tyVarsToTypes feqn_pats, ..}
107+ tfid_eqn = HsIB {hsib_ext = NoExt, hsib_body = eqn}
108+defltEqnToInstDecl XFamEqn {} = notImplemented "XFamEqn"
109+
98isInfix :: LexicalFixity -> Bool
110isInfix :: LexicalFixity -> Bool
99isInfix = \case
111isInfix = \case
100 Infix -> True
112 Infix -> True
src/Ormolu/Printer/Meat/Declaration/Data.hs+112−165
@@ -1,33 +1,31 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
4
4
5-- | Renedring of data type declarations.
5-- | Renedring of data type declarations.
6+
6module Ormolu.Printer.Meat.Declaration.Data
7module Ormolu.Printer.Meat.Declaration.Data
7− ( p_dataDecl,
8+ ( p_dataDecl
8 )
9 )
9where
10where
10
11
11import Control.Monad
12import Control.Monad
12−import Data.Maybe (isJust, maybeToList)
13+import Data.Maybe (isJust)
13import GHC
14import GHC
14import Ormolu.Printer.Combinators
15import Ormolu.Printer.Combinators
15import Ormolu.Printer.Meat.Common
16import Ormolu.Printer.Meat.Common
16import Ormolu.Printer.Meat.Type
17import Ormolu.Printer.Meat.Type
17import Ormolu.Utils
18import Ormolu.Utils
19+import RdrName (RdrName (..))
20+import SrcLoc (Located)
18
21
19−p_dataDecl ::
22+p_dataDecl
20− -- | Whether to format as data family
23+ :: FamilyStyle -- ^ Whether to format as data family
21− FamilyStyle ->
22− -- | Type constructor
23− Located RdrName ->
24+ -> Located RdrName -- ^ Type constructor
24− -- | Type patterns
25− [LHsType GhcPs] ->
25+ -> [LHsType GhcPs] -- ^ Type patterns
26− -- | Lexical fixity
26+ -> LexicalFixity -- ^ Lexical fixity
27− LexicalFixity ->
28− -- | Data definition
27+ -> HsDataDefn GhcPs -- ^ Data definition
29− HsDataDefn GhcPs ->
30− R ()
28+ -> R ()
31p_dataDecl style name tpats fixity HsDataDefn {..} = do
29p_dataDecl style name tpats fixity HsDataDefn {..} = do
32 txt $ case dd_ND of
30 txt $ case dd_ND of
33 NewType -> "newtype"
31 NewType -> "newtype"
@@ -35,15 +33,13 @@ p_dataDecl style name tpats fixity HsDataDefn {..} = do
35 txt $ case style of
33 txt $ case style of
36 Associated -> mempty
34 Associated -> mempty
37 Free -> " instance"
35 Free -> " instance"
38− let constructorSpans = getLoc name : fmap getLoc tpats
36+ switchLayout (getLoc name : fmap getLoc tpats) $ do
39− switchLayout constructorSpans $ do
40 breakpoint
37 breakpoint
41− inci $
42− p_infixDefHelper
38+ inci $ p_infixDefHelper
43− (isInfix fixity)
39+ (isInfix fixity)
44− True
40+ inci
45− (p_rdrName name)
41+ (p_rdrName name)
46− (located' p_hsType <$> tpats)
42+ (located' p_hsType <$> tpats)
47 case dd_kindSig of
43 case dd_kindSig of
48 Nothing -> return ()
44 Nothing -> return ()
49 Just k -> do
45 Just k -> do
@@ -54,134 +50,100 @@ p_dataDecl style name tpats fixity HsDataDefn {..} = do
54 let gadt = isJust dd_kindSig || any (isGadt . unLoc) dd_cons
50 let gadt = isJust dd_kindSig || any (isGadt . unLoc) dd_cons
55 unless (null dd_cons) $
51 unless (null dd_cons) $
56 if gadt
52 if gadt
57− then inci $ do
53+ then do
58− switchLayout constructorSpans $ do
59− breakpoint
60− txt "where"
61− breakpoint
62− sepSemi (located' (p_conDecl False)) dd_cons
63− else switchLayout (getLoc name : (getLoc <$> dd_cons)) . inci $ do
64− let singleConstRec = isSingleConstRec dd_cons
65− if singleConstRec
66− then space
67− else
68− if hasHaddocks dd_cons
69− then newline
70− else breakpoint
71− equals
72 space
54 space
73− layout <- getLayout
55+ txt "where"
56+ breakpoint
57+ inci $ sepSemi (located' p_conDecl) dd_cons
58+ else switchLayout (getLoc name : (getLoc <$> dd_cons)) $
59+ inci $ do
60+ breakpoint
61+ txt "="
62+ space
74− let s =
63+ let s = vlayout
75− if layout == MultiLine || hasHaddocks dd_cons
64+ (space >> txt "|" >> space)
76− then newline >> txt "|" >> space
65+ (newline >> txt "|" >> space)
77− else space >> txt "|" >> space
78− sitcc' =
79− if singleConstRec
80− then id
81− else sitcc
82− sep s (sitcc' . located' (p_conDecl singleConstRec)) dd_cons
66+ sep s (sitcc . located' p_conDecl) dd_cons
83 unless (null $ unLoc dd_derivs) breakpoint
67 unless (null $ unLoc dd_derivs) breakpoint
84− inci . located dd_derivs $ \xs ->
68+ inci . located dd_derivs $ \xs -> do
85 sep newline (located' p_hsDerivingClause) xs
69 sep newline (located' p_hsDerivingClause) xs
86−p_dataDecl _ _ _ _ (XHsDataDefn x) = noExtCon x
70+p_dataDecl _ _ _ _ (XHsDataDefn NoExt) = notImplemented "XHsDataDefn"
87
71
88−p_conDecl ::
89− Bool ->
90− ConDecl GhcPs ->
72+p_conDecl :: ConDecl GhcPs -> R ()
91− R ()
92−p_conDecl singleConstRec = \case
73+p_conDecl = \case
93 ConDeclGADT {..} -> do
74 ConDeclGADT {..} -> do
94 mapM_ (p_hsDocString Pipe True) con_doc
75 mapM_ (p_hsDocString Pipe True) con_doc
95− let conDeclSpn =
96− fmap getLoc con_names
97− <> [getLoc con_forall]
98− <> conTyVarsSpans con_qvars
99− <> maybeToList (fmap getLoc con_mb_cxt)
100− <> conArgsSpans con_args
101− switchLayout conDeclSpn $ do
102− case con_names of
76+ case con_names of
103− [] -> return ()
77+ [] -> return ()
104− (c : cs) -> do
78+ (c:cs) -> do
105− p_rdrName c
79+ p_rdrName c
106− unless (null cs) . inci $ do
80+ unless (null cs) . inci $ do
107− commaDel
81+ comma
82+ breakpoint
108− sep commaDel p_rdrName cs
83+ sitcc $ sep (comma >> breakpoint) p_rdrName cs
84+ space
109− inci $ do
85+ inci $ do
110− space
111− txt "::"
86+ txt "::"
112− let interArgBreak =
87+ let interArgBreak =
113− if hasDocStrings (unLoc con_res_ty)
88+ if hasDocStrings (unLoc con_res_ty)
114− then newline
89+ then newline
115− else breakpoint
90+ else breakpoint
116− interArgBreak
91+ interArgBreak
117− when (unLoc con_forall) $ do
118− p_forallBndrs ForallInvis p_hsTyVarBndr (hsq_explicit con_qvars)
92+ p_forallBndrs (hsq_explicit con_qvars)
119− interArgBreak
93+ unless (null $ hsq_explicit con_qvars) interArgBreak
120− forM_ con_mb_cxt p_lhsContext
121− case con_args of
122− PrefixCon xs -> do
123− sep breakpoint (located' p_hsType) xs
124− unless (null xs) $ do
125− space
126− txt "->"
127− breakpoint
128− RecCon l -> do
129− located l p_conDeclFields
130− unless (null $ unLoc l) $ do
131− space
132− txt "->"
133− breakpoint
134− InfixCon _ _ -> notImplemented "InfixCon"
135− p_hsType (unLoc con_res_ty)
136− ConDeclH98 {..} -> do
137− mapM_ (p_hsDocString Pipe True) con_doc
138− let conDeclWithContextSpn =
139− [getLoc con_forall]
140− <> fmap getLoc con_ex_tvs
141− <> maybeToList (fmap getLoc con_mb_cxt)
142− <> conDeclSpn
143− conDeclSpn =
144− getLoc con_name : conArgsSpans con_args
145− switchLayout conDeclWithContextSpn $ do
146− when (unLoc con_forall) $ do
147− p_forallBndrs ForallInvis p_hsTyVarBndr con_ex_tvs
148− breakpoint
149 forM_ con_mb_cxt p_lhsContext
94 forM_ con_mb_cxt p_lhsContext
150− switchLayout conDeclSpn $ case con_args of
95+ case con_args of
151 PrefixCon xs -> do
96 PrefixCon xs -> do
152− p_rdrName con_name
153− unless (null xs) breakpoint
154− inci . sitcc $ sep breakpoint (sitcc . located' p_hsTypePostDoc) xs
97+ sep breakpoint (located' p_hsType) xs
98+ unless (null xs) $ do
99+ space
100+ txt "->"
101+ breakpoint
155 RecCon l -> do
102 RecCon l -> do
156− p_rdrName con_name
157− breakpoint
158− inciIf (not singleConstRec) (located l p_conDeclFields)
103+ located l p_conDeclFields
159− InfixCon x y -> do
104+ unless (null $ unLoc l) $ do
160− located x p_hsType
161− breakpoint
162− inci $ do
163− p_rdrName con_name
164 space
105 space
106+ txt "->"
107+ breakpoint
108+ InfixCon _ _ -> notImplemented "InfixCon"
165− located y p_hsType
109+ p_hsType (unLoc con_res_ty)
166− XConDecl x -> noExtCon x
110+ ConDeclH98 {..} -> do
167−
111+ mapM_ (p_hsDocString Pipe True) con_doc
168−conArgsSpans :: HsConDeclDetails GhcPs -> [SrcSpan]
112+ p_forallBndrs con_ex_tvs
169−conArgsSpans = \case
113+ unless (null con_ex_tvs) breakpoint
114+ forM_ con_mb_cxt p_lhsContext
115+ case con_args of
170− PrefixCon xs ->
116+ PrefixCon xs -> do
171− getLoc <$> xs
117+ p_rdrName con_name
118+ unless (null xs) breakpoint
119+ inci . sitcc $ sep breakpoint (sitcc . located' p_hsType) xs
172− RecCon l ->
120+ RecCon l -> do
173− [getLoc l]
121+ p_rdrName con_name
122+ breakpoint
123+ inci $ located l p_conDeclFields
174− InfixCon x y ->
124+ InfixCon x y -> do
175− [getLoc x, getLoc y]
125+ located x p_hsType
126+ breakpoint
127+ inci $ do
128+ p_rdrName con_name
129+ space
130+ located y p_hsType
131+ XConDecl NoExt -> notImplemented "XConDecl"
176
132
177−conTyVarsSpans :: LHsQTyVars GhcPs -> [SrcSpan]
133+p_forallBndrs
178−conTyVarsSpans = \case
134+ :: [LHsTyVarBndr GhcPs]
179− HsQTvs {..} -> getLoc <$> hsq_explicit
135+ -> R ()
180− XLHsQTyVars x -> noExtCon x
136+p_forallBndrs = \case
137+ [] -> return ()
138+ bndrs -> do
139+ txt "forall"
140+ space
141+ sep space (located' p_hsTyVarBndr) bndrs
142+ txt "."
181
143
182−p_lhsContext ::
144+p_lhsContext
183− LHsContext GhcPs ->
145+ :: LHsContext GhcPs
184− R ()
146+ -> R ()
185p_lhsContext = \case
147p_lhsContext = \case
186 L _ [] -> pure ()
148 L _ [] -> pure ()
187 ctx -> do
149 ctx -> do
@@ -196,19 +158,17 @@ isGadt = \case
196 ConDeclH98 {} -> False
158 ConDeclH98 {} -> False
197 XConDecl {} -> False
159 XConDecl {} -> False
198
160
199−p_hsDerivingClause ::
161+p_hsDerivingClause
200− HsDerivingClause GhcPs ->
162+ :: HsDerivingClause GhcPs
201− R ()
163+ -> R ()
202p_hsDerivingClause HsDerivingClause {..} = do
164p_hsDerivingClause HsDerivingClause {..} = do
203 txt "deriving"
165 txt "deriving"
204 let derivingWhat = located deriv_clause_tys $ \case
166 let derivingWhat = located deriv_clause_tys $ \case
205 [] -> txt "()"
167 [] -> txt "()"
206− xs ->
207− parens N $
168+ xs -> parens N . sitcc $ sep
208− sep
169+ (comma >> breakpoint)
209− commaDel
210− (sitcc . located' p_hsType . hsib_body)
170+ (sitcc . located' p_hsType . hsib_body)
211− xs
171+ xs
212 space
172 space
213 case deriv_clause_strategy of
173 case deriv_clause_strategy of
214 Nothing -> do
174 Nothing -> do
@@ -235,9 +195,9 @@ p_hsDerivingClause HsDerivingClause {..} = do
235 txt "via"
195 txt "via"
236 space
196 space
237 located hsib_body p_hsType
197 located hsib_body p_hsType
238− ViaStrategy (XHsImplicitBndrs x) ->
198+ ViaStrategy (XHsImplicitBndrs NoExt) ->
239− noExtCon x
199+ notImplemented "XHsImplicitBndrs"
240−p_hsDerivingClause (XHsDerivingClause x) = noExtCon x
200+p_hsDerivingClause (XHsDerivingClause NoExt) = notImplemented "XHsDerivingClause"
241
201
242----------------------------------------------------------------------------
202----------------------------------------------------------------------------
243-- Helpers
203-- Helpers
@@ -246,16 +206,3 @@ isInfix :: LexicalFixity -> Bool
246isInfix = \case
206isInfix = \case
247 Infix -> True
207 Infix -> True
248 Prefix -> False
208 Prefix -> False
249−
250−isSingleConstRec :: [LConDecl GhcPs] -> Bool
251−isSingleConstRec [(L _ ConDeclH98 {..})] =
252− case con_args of
253− RecCon _ -> True
254− _ -> False
255−isSingleConstRec _ = False
256−
257−hasHaddocks :: [LConDecl GhcPs] -> Bool
258−hasHaddocks = any (f . unLoc)
259− where
260− f ConDeclH98 {..} = isJust con_doc
261− f _ = False
src/Ormolu/Printer/Meat/Declaration/Default.hs+7−6
@@ -1,20 +1,21 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3
3
4module Ormolu.Printer.Meat.Declaration.Default
4module Ormolu.Printer.Meat.Declaration.Default
5− ( p_defaultDecl,
5+ ( p_defaultDecl
6 )
6 )
7where
7where
8
8
9import GHC
9import GHC
10import Ormolu.Printer.Combinators
10import Ormolu.Printer.Combinators
11import Ormolu.Printer.Meat.Type
11import Ormolu.Printer.Meat.Type
12+import Ormolu.Utils
12
13
13p_defaultDecl :: DefaultDecl GhcPs -> R ()
14p_defaultDecl :: DefaultDecl GhcPs -> R ()
14p_defaultDecl = \case
15p_defaultDecl = \case
15− DefaultDecl NoExtField ts -> do
16+ DefaultDecl NoExt ts -> do
16 txt "default"
17 txt "default"
17 breakpoint
18 breakpoint
18− inci . parens N $
19+ inci . parens N . sitcc $
19− sep commaDel (sitcc . located' p_hsType) ts
20+ sep (comma >> breakpoint) (sitcc . located' p_hsType) ts
20− XDefaultDecl x -> noExtCon x
21+ XDefaultDecl {} -> notImplemented "XDefaultDecl"
src/Ormolu/Printer/Meat/Declaration/Foreign.hs+12−12
@@ -1,9 +1,9 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2−{-# LANGUAGE NamedFieldPuns #-}
2+{-# LANGUAGE NamedFieldPuns #-}
3{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
4
4
5module Ormolu.Printer.Meat.Declaration.Foreign
5module Ormolu.Printer.Meat.Declaration.Foreign
6− ( p_foreignDecl,
6+ ( p_foreignDecl
7 )
7 )
8where
8where
9
9
@@ -15,6 +15,7 @@ import GHC
15import Ormolu.Printer.Combinators
15import Ormolu.Printer.Combinators
16import Ormolu.Printer.Meat.Common
16import Ormolu.Printer.Meat.Common
17import Ormolu.Printer.Meat.Declaration.Signature
17import Ormolu.Printer.Meat.Declaration.Signature
18+import Ormolu.Utils
18
19
19p_foreignDecl :: ForeignDecl GhcPs -> R ()
20p_foreignDecl :: ForeignDecl GhcPs -> R ()
20p_foreignDecl = \case
21p_foreignDecl = \case
@@ -24,21 +25,19 @@ p_foreignDecl = \case
24 fd@ForeignExport {fd_fe} -> do
25 fd@ForeignExport {fd_fe} -> do
25 p_foreignExport fd_fe
26 p_foreignExport fd_fe
26 p_foreignTypeSig fd
27 p_foreignTypeSig fd
27− XForeignDecl x -> noExtCon x
28+ XForeignDecl {} -> notImplemented "XForeignDecl"
28
29
29-- | Printer for the last part of an import\/export, which is function name
30-- | Printer for the last part of an import\/export, which is function name
30-- and type signature.
31-- and type signature.
32+
31p_foreignTypeSig :: ForeignDecl GhcPs -> R ()
33p_foreignTypeSig :: ForeignDecl GhcPs -> R ()
32p_foreignTypeSig fd = do
34p_foreignTypeSig fd = do
33 breakpoint
35 breakpoint
34− inci
36+ -- Switch into the layout of the signature, to allow us to pull name and
35− . switchLayout
37+ -- signature onto a single line.
36− [ getLoc (fd_name fd),
37− (getLoc . hsib_body . fd_sig_ty) fd
38+ inci . switchLayout [getLoc . hsib_body $ fd_sig_ty fd] $ do
38− ]
39− $ do
40− p_rdrName (fd_name fd)
39+ p_rdrName (fd_name fd)
41− p_typeAscription (HsWC NoExtField (fd_sig_ty fd))
40+ p_typeAscription (HsWC NoExt (fd_sig_ty fd))
42
41
43-- | Printer for 'ForeignImport'.
42-- | Printer for 'ForeignImport'.
44--
43--
@@ -52,6 +51,7 @@ p_foreignTypeSig fd = do
52-- We also layout the identifier using the 'SourceText', because printing
51-- We also layout the identifier using the 'SourceText', because printing
53-- with the other two fields of 'CImport' is very complicated. See the
52-- with the other two fields of 'CImport' is very complicated. See the
54-- 'Outputable' instance of 'ForeignImport' for details.
53-- 'Outputable' instance of 'ForeignImport' for details.
54+
55p_foreignImport :: ForeignImport -> R ()
55p_foreignImport :: ForeignImport -> R ()
56p_foreignImport (CImport cCallConv safety _ _ sourceText) = do
56p_foreignImport (CImport cCallConv safety _ _ sourceText) = do
57 txt "foreign import"
57 txt "foreign import"
src/Ormolu/Printer/Meat/Declaration/Instance.hs+38−33
@@ -1,13 +1,14 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
4
4
5-- | Type class, type family, and data family instance declarations.
5-- | Type class, type family, and data family instance declarations.
6+
6module Ormolu.Printer.Meat.Declaration.Instance
7module Ormolu.Printer.Meat.Declaration.Instance
7− ( p_clsInstDecl,
8+ ( p_clsInstDecl
8− p_tyFamInstDecl,
9+ , p_tyFamInstDecl
9− p_dataFamInstDecl,
10+ , p_dataFamInstDecl
10− p_standaloneDerivDecl,
11+ , p_standaloneDerivDecl
11 )
12 )
12where
13where
13
14
@@ -15,15 +16,16 @@ import BasicTypes
15import Control.Arrow
16import Control.Arrow
16import Control.Monad
17import Control.Monad
17import Data.Foldable
18import Data.Foldable
18−import Data.List (sortOn)
19+import Data.List (sortBy)
20+import Data.Ord (comparing)
19import GHC
21import GHC
20import Ormolu.Printer.Combinators
22import Ormolu.Printer.Combinators
21import Ormolu.Printer.Meat.Common
23import Ormolu.Printer.Meat.Common
22−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
23import Ormolu.Printer.Meat.Declaration.Data
24import Ormolu.Printer.Meat.Declaration.Data
24import Ormolu.Printer.Meat.Declaration.TypeFamily
25import Ormolu.Printer.Meat.Declaration.TypeFamily
25import Ormolu.Printer.Meat.Type
26import Ormolu.Printer.Meat.Type
26import Ormolu.Utils
27import Ormolu.Utils
28+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
27
29
28p_standaloneDerivDecl :: DerivDecl GhcPs -> R ()
30p_standaloneDerivDecl :: DerivDecl GhcPs -> R ()
29p_standaloneDerivDecl DerivDecl {..} = do
31p_standaloneDerivDecl DerivDecl {..} = do
@@ -32,11 +34,13 @@ p_standaloneDerivDecl DerivDecl {..} = do
32 txt "instance"
34 txt "instance"
33 breakpoint
35 breakpoint
34 match_overlap_mode deriv_overlap_mode breakpoint
36 match_overlap_mode deriv_overlap_mode breakpoint
37+ if toIndent
38+ then inci typesAfterInstance
35− inciIf toIndent typesAfterInstance
39+ else typesAfterInstance
36 txt "deriving"
40 txt "deriving"
37 space
41 space
38 case deriv_strategy of
42 case deriv_strategy of
39− Nothing ->
43+ Nothing -> do
40 instTypes False
44 instTypes False
41 Just (L _ a) -> case a of
45 Just (L _ a) -> case a of
42 StockStrategy -> do
46 StockStrategy -> do
@@ -54,8 +58,8 @@ p_standaloneDerivDecl DerivDecl {..} = do
54 inci (located hsib_body p_hsType)
58 inci (located hsib_body p_hsType)
55 breakpoint
59 breakpoint
56 instTypes True
60 instTypes True
57− ViaStrategy (XHsImplicitBndrs x) ->
61+ ViaStrategy (XHsImplicitBndrs NoExt) ->
58− noExtCon x
62+ notImplemented "XHsImplicitBndrs"
59p_standaloneDerivDecl (XDerivDecl _) = notImplemented "XDerivDecl"
63p_standaloneDerivDecl (XDerivDecl _) = notImplemented "XDerivDecl"
60
64
61p_clsInstDecl :: ClsInstDecl GhcPs -> R ()
65p_clsInstDecl :: ClsInstDecl GhcPs -> R ()
@@ -68,18 +72,17 @@ p_clsInstDecl = \case
68 -- location order. This happens because different declarations are stored in
72 -- location order. This happens because different declarations are stored in
69 -- different lists. Consequently, to get all the declarations in proper
73 -- different lists. Consequently, to get all the declarations in proper
70 -- order, they need to be manually sorted.
74 -- order, they need to be manually sorted.
71− let sigs = (getLoc &&& fmap (SigD NoExtField)) <$> cid_sigs
75+ let sigs = (getLoc &&& fmap (SigD NoExt)) <$> cid_sigs
72− vals = (getLoc &&& fmap (ValD NoExtField)) <$> toList cid_binds
76+ vals = (getLoc &&& fmap (ValD NoExt)) <$> toList cid_binds
73 tyFamInsts =
77 tyFamInsts =
74− ( getLoc &&& fmap (InstD NoExtField . TyFamInstD NoExtField)
78+ ( getLoc &&& fmap (InstD NoExt . TyFamInstD NoExt)
75− )
76− <$> cid_tyfam_insts
79+ ) <$> cid_tyfam_insts
77 dataFamInsts =
80 dataFamInsts =
78− ( getLoc &&& fmap (InstD NoExtField . DataFamInstD NoExtField)
81+ ( getLoc &&& fmap (InstD NoExt . DataFamInstD NoExt)
79− )
80− <$> cid_datafam_insts
82+ ) <$> cid_datafam_insts
81 allDecls =
83 allDecls =
84+ snd <$>
82− snd <$> sortOn fst (sigs <> vals <> tyFamInsts <> dataFamInsts)
85+ sortBy (comparing fst) (sigs <> vals <> tyFamInsts <> dataFamInsts)
83 located hsib_body $ \x -> do
86 located hsib_body $ \x -> do
84 breakpoint
87 breakpoint
85 inci $ do
88 inci $ do
@@ -88,12 +91,16 @@ p_clsInstDecl = \case
88 unless (null allDecls) $ do
91 unless (null allDecls) $ do
89 breakpoint
92 breakpoint
90 txt "where"
93 txt "where"
91− unless (null allDecls) . inci $ do
94+ unless (null allDecls) $ do
95+ inci $ do
92− -- Ensure whitespace is added after where clause.
96+ -- Ensure whitespace is added after where clause.
97+ breakpoint
98+ -- Add newline before first declaration if the body contains separate
99+ -- declarations
93− breakpoint
100+ when (hasSeparatedDecls allDecls) breakpoint'
94− dontUseBraces $ p_hsDeclsRespectGrouping Associated allDecls
101+ dontUseBraces $ p_hsDecls Associated allDecls
95− XHsImplicitBndrs x -> noExtCon x
102+ XHsImplicitBndrs NoExt -> notImplemented "XHsImplicitBndrs"
96− XClsInstDecl x -> noExtCon x
103+ XClsInstDecl NoExt -> notImplemented "XClsInstDecl"
97
104
98p_tyFamInstDecl :: FamilyStyle -> TyFamInstDecl GhcPs -> R ()
105p_tyFamInstDecl :: FamilyStyle -> TyFamInstDecl GhcPs -> R ()
99p_tyFamInstDecl style = \case
106p_tyFamInstDecl style = \case
@@ -106,12 +113,10 @@ p_tyFamInstDecl style = \case
106
113
107p_dataFamInstDecl :: FamilyStyle -> DataFamInstDecl GhcPs -> R ()
114p_dataFamInstDecl :: FamilyStyle -> DataFamInstDecl GhcPs -> R ()
108p_dataFamInstDecl style = \case
115p_dataFamInstDecl style = \case
109− DataFamInstDecl {dfid_eqn = HsIB {hsib_body = FamEqn {..}}} ->
116+ DataFamInstDecl {..} -> do
117+ let HsIB {..} = dfid_eqn
118+ FamEqn {..} = hsib_body
110− p_dataDecl style feqn_tycon (map typeArgToType feqn_pats) feqn_fixity feqn_rhs
119+ p_dataDecl style feqn_tycon feqn_pats feqn_fixity feqn_rhs
111− DataFamInstDecl {dfid_eqn = HsIB {hsib_body = XFamEqn {}}} ->
112− notImplemented "XFamEqn"
113− DataFamInstDecl {dfid_eqn = XHsImplicitBndrs {}} ->
114− notImplemented "XHsImplicitBndrs"
115
120
116match_overlap_mode :: Maybe (Located OverlapMode) -> R () -> R ()
121match_overlap_mode :: Maybe (Located OverlapMode) -> R () -> R ()
117match_overlap_mode overlap_mode layoutStrategy =
122match_overlap_mode overlap_mode layoutStrategy =
src/Ormolu/Printer/Meat/Declaration/RoleAnnotation.hs+11−5
@@ -1,10 +1,12 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
3{-# LANGUAGE TypeFamilies #-}
4{-# LANGUAGE TypeFamilies #-}
4
5
5-- | Rendering of Role annotation declarations.
6-- | Rendering of Role annotation declarations.
7+
6module Ormolu.Printer.Meat.Declaration.RoleAnnotation
8module Ormolu.Printer.Meat.Declaration.RoleAnnotation
7− ( p_roleAnnot,
9+ ( p_roleAnnot
8 )
10 )
9where
11where
10
12
@@ -12,11 +14,14 @@ import CoAxiom
12import GHC
14import GHC
13import Ormolu.Printer.Combinators
15import Ormolu.Printer.Combinators
14import Ormolu.Printer.Meat.Common
16import Ormolu.Printer.Meat.Common
17+import Ormolu.Utils
18+import RdrName (RdrName (..))
19+import SrcLoc (Located)
15
20
16p_roleAnnot :: RoleAnnotDecl GhcPs -> R ()
21p_roleAnnot :: RoleAnnotDecl GhcPs -> R ()
17p_roleAnnot = \case
22p_roleAnnot = \case
18− RoleAnnotDecl NoExtField l_name anns -> p_roleAnnot' l_name anns
23+ RoleAnnotDecl NoExt l_name anns -> p_roleAnnot' l_name anns
19− XRoleAnnotDecl x -> noExtCon x
24+ XRoleAnnotDecl _ -> notImplemented "XRoleAnnotDecl"
20
25
21p_roleAnnot' :: Located RdrName -> [Located (Maybe Role)] -> R ()
26p_roleAnnot' :: Located RdrName -> [Located (Maybe Role)] -> R ()
22p_roleAnnot' l_name anns = do
27p_roleAnnot' l_name anns = do
@@ -25,7 +30,8 @@ p_roleAnnot' l_name anns = do
25 inci $ do
30 inci $ do
26 p_rdrName l_name
31 p_rdrName l_name
27 breakpoint
32 breakpoint
33+ let
28− let p_role' = maybe (txt "_") p_role
34+ p_role' = maybe (txt "_") p_role
29 inci . sitcc $ sep breakpoint (sitcc . located' p_role') anns
35 inci . sitcc $ sep breakpoint (sitcc . located' p_role') anns
30
36
31p_role :: Role -> R ()
37p_role :: Role -> R ()
src/Ormolu/Printer/Meat/Declaration/Rule.hs+25−25
@@ -1,61 +1,61 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
3
4
4module Ormolu.Printer.Meat.Declaration.Rule
5module Ormolu.Printer.Meat.Declaration.Rule
5− ( p_ruleDecls,
6+ ( p_ruleDecls
6 )
7 )
7where
8where
8
9
9import BasicTypes
10import BasicTypes
10−import Control.Monad (unless)
11import GHC
11import GHC
12import Ormolu.Printer.Combinators
12import Ormolu.Printer.Combinators
13import Ormolu.Printer.Meat.Common
13import Ormolu.Printer.Meat.Common
14import Ormolu.Printer.Meat.Declaration.Signature
14import Ormolu.Printer.Meat.Declaration.Signature
15import Ormolu.Printer.Meat.Declaration.Value
15import Ormolu.Printer.Meat.Declaration.Value
16−import Ormolu.Printer.Meat.Type
16+import Ormolu.Utils
17
17
18p_ruleDecls :: RuleDecls GhcPs -> R ()
18p_ruleDecls :: RuleDecls GhcPs -> R ()
19p_ruleDecls = \case
19p_ruleDecls = \case
20− HsRules NoExtField _ xs ->
21− pragma "RULES" $
20+ HsRules NoExt _ xs -> pragma "RULES" . sitcc $
22− sep breakpoint (sitcc . located' p_ruleDecl) xs
21+ sep breakpoint (sitcc . located' p_ruleDecl) xs
23− XRuleDecls x -> noExtCon x
22+ XRuleDecls NoExt -> notImplemented "XRuleDecls"
24
23
25p_ruleDecl :: RuleDecl GhcPs -> R ()
24p_ruleDecl :: RuleDecl GhcPs -> R ()
26p_ruleDecl = \case
25p_ruleDecl = \case
27− HsRule NoExtField ruleName activation tyvars ruleBndrs lhs rhs -> do
26+ HsRule NoExt ruleName activation ruleBndrs lhs rhs -> do
28 located ruleName p_ruleName
27 located ruleName p_ruleName
29 space
28 space
30 p_activation activation
29 p_activation activation
31 space
30 space
32− case tyvars of
31+ p_ruleBndrs ruleBndrs
33− Nothing -> return ()
34− Just xs -> do
35− p_forallBndrs ForallInvis p_hsTyVarBndr xs
36− space
37− -- It appears that there is no way to tell if there was an empty forall
38− -- in the input or no forall at all. We do not want to add redundant
39− -- foralls, so let's just skip the empty ones.
40− unless (null ruleBndrs) $
41− p_forallBndrs ForallInvis p_ruleBndr ruleBndrs
42 breakpoint
32 breakpoint
43 inci $ do
33 inci $ do
44 located lhs p_hsExpr
34 located lhs p_hsExpr
45 space
35 space
46− equals
36+ txt "="
47 inci $ do
37 inci $ do
48 breakpoint
38 breakpoint
49 located rhs p_hsExpr
39 located rhs p_hsExpr
50− XRuleDecl x -> noExtCon x
40+ XRuleDecl NoExt -> notImplemented "XRuleDecl"
51
41
52p_ruleName :: (SourceText, RuleName) -> R ()
42p_ruleName :: (SourceText, RuleName) -> R ()
53−p_ruleName (_, name) = atom $ (HsString NoSourceText name :: HsLit GhcPs)
43+p_ruleName (_, name) = atom $ HsString NoSourceText name
44+
45+p_ruleBndrs :: [LRuleBndr GhcPs] -> R ()
46+p_ruleBndrs [] = return ()
47+p_ruleBndrs bndrs =
48+ switchLayout (getLoc <$> bndrs) $ do
49+ txt "forall"
50+ breakpoint
51+ inci $ do
52+ sitcc $ sep breakpoint (sitcc . located' p_ruleBndr) bndrs
53+ txt "."
54
54
55p_ruleBndr :: RuleBndr GhcPs -> R ()
55p_ruleBndr :: RuleBndr GhcPs -> R ()
56p_ruleBndr = \case
56p_ruleBndr = \case
57− RuleBndr NoExtField x -> p_rdrName x
57+ RuleBndr NoExt x -> p_rdrName x
58− RuleBndrSig NoExtField x hswc -> parens N $ do
58+ RuleBndrSig NoExt x hswc -> parens N $ do
59 p_rdrName x
59 p_rdrName x
60 p_typeAscription hswc
60 p_typeAscription hswc
61− XRuleBndr x -> noExtCon x
61+ XRuleBndr NoExt -> notImplemented "XRuleBndr"
src/Ormolu/Printer/Meat/Declaration/Signature.hs+91−126
@@ -1,19 +1,20 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
4
4
5-- | Type signature declarations.
5-- | Type signature declarations.
6+
6module Ormolu.Printer.Meat.Declaration.Signature
7module Ormolu.Printer.Meat.Declaration.Signature
7− ( p_sigDecl,
8+ ( p_sigDecl
8− p_typeAscription,
9+ , p_typeAscription
9− p_activation,
10+ , p_activation
10− p_standaloneKindSig,
11 )
11 )
12where
12where
13
13
14import BasicTypes
14import BasicTypes
15import BooleanFormula
15import BooleanFormula
16import Control.Monad
16import Control.Monad
17+import Data.Bool (bool)
17import GHC
18import GHC
18import Ormolu.Printer.Combinators
19import Ormolu.Printer.Combinators
19import Ormolu.Printer.Meat.Common
20import Ormolu.Printer.Meat.Common
@@ -22,81 +23,73 @@ import Ormolu.Utils
22
23
23p_sigDecl :: Sig GhcPs -> R ()
24p_sigDecl :: Sig GhcPs -> R ()
24p_sigDecl = \case
25p_sigDecl = \case
25− TypeSig NoExtField names hswc -> p_typeSig True names hswc
26+ TypeSig NoExt names hswc -> p_typeSig True names hswc
26− PatSynSig NoExtField names hsib -> p_patSynSig names hsib
27+ PatSynSig NoExt names hsib -> p_patSynSig names hsib
27− ClassOpSig NoExtField def names hsib -> p_classOpSig def names hsib
28+ ClassOpSig NoExt def names hsib -> p_classOpSig def names hsib
28− FixSig NoExtField sig -> p_fixSig sig
29+ FixSig NoExt sig -> p_fixSig sig
29− InlineSig NoExtField name inlinePragma -> p_inlineSig name inlinePragma
30+ InlineSig NoExt name inlinePragma -> p_inlineSig name inlinePragma
30− SpecSig NoExtField name ts inlinePragma -> p_specSig name ts inlinePragma
31+ SpecSig NoExt name ts inlinePragma -> p_specSig name ts inlinePragma
31− SpecInstSig NoExtField _ hsib -> p_specInstSig hsib
32+ SpecInstSig NoExt _ hsib -> p_specInstSig hsib
32− MinimalSig NoExtField _ booleanFormula -> p_minimalSig booleanFormula
33+ MinimalSig NoExt _ booleanFormula -> p_minimalSig booleanFormula
33− CompleteMatchSig NoExtField _sourceText cs ty -> p_completeSig cs ty
34+ CompleteMatchSig NoExt _sourceText cs ty -> p_completeSig cs ty
34− SCCFunSig NoExtField _ name literal -> p_sccSig name literal
35+ SCCFunSig NoExt _ name literal -> p_sccSig name literal
35 _ -> notImplemented "certain types of signature declarations"
36 _ -> notImplemented "certain types of signature declarations"
36
37
37−p_typeSig ::
38+p_typeSig
38− -- | Should the tail of the names be indented
39+ :: Bool -- ^ Should the tail of the names be indented
39− Bool ->
40− -- | Names (before @::@)
41− [Located RdrName] ->
40+ -> [Located RdrName] -- ^ Names (before @::@)
42− -- | Type
43− LHsSigWcType GhcPs ->
41+ -> LHsSigWcType GhcPs -- ^ Type
44− R ()
42+ -> R ()
45p_typeSig _ [] _ = return () -- should not happen though
43p_typeSig _ [] _ = return () -- should not happen though
46−p_typeSig indentTail (n : ns) hswc = do
44+p_typeSig indentTail (n:ns) hswc = do
47 p_rdrName n
45 p_rdrName n
48 if null ns
46 if null ns
49 then p_typeAscription hswc
47 then p_typeAscription hswc
50− else inciIf indentTail $ do
48+ else bool id inci indentTail $ do
51− commaDel
49+ comma
50+ breakpoint
52− sep commaDel p_rdrName ns
51+ sep (comma >> breakpoint) p_rdrName ns
53 p_typeAscription hswc
52 p_typeAscription hswc
54
53
55−p_typeAscription ::
54+p_typeAscription
56− LHsSigWcType GhcPs ->
55+ :: LHsSigWcType GhcPs
57− R ()
56+ -> R ()
58−p_typeAscription HsWC {..} = inci $ do
57+p_typeAscription HsWC {..} = do
59 space
58 space
59+ inci $ do
60− txt "::"
60+ txt "::"
61− let t = hsib_body hswc_body
61+ let t = hsib_body hswc_body
62− if hasDocStrings (unLoc t)
62+ if hasDocStrings (unLoc t)
63− then newline
63+ then newline
64− else breakpoint
64+ else breakpoint
65− located t p_hsType
65+ located t p_hsType
66−p_typeAscription (XHsWildCardBndrs x) = noExtCon x
66+p_typeAscription (XHsWildCardBndrs NoExt) = notImplemented "XHsWildCardBndrs"
67−
67+
68−p_patSynSig ::
68+p_patSynSig
69− [Located RdrName] ->
69+ :: [Located RdrName]
70− HsImplicitBndrs GhcPs (LHsType GhcPs) ->
70+ -> HsImplicitBndrs GhcPs (LHsType GhcPs)
71− R ()
71+ -> R ()
72p_patSynSig names hsib = do
72p_patSynSig names hsib = do
73 txt "pattern"
73 txt "pattern"
74− let body =
75− p_typeSig
76− False
77− names
78− HsWC {hswc_ext = NoExtField, hswc_body = hsib}
74+ let body = p_typeSig False names HsWC {hswc_ext = NoExt, hswc_body = hsib}
79 if length names > 1
75 if length names > 1
80 then breakpoint >> inci body
76 then breakpoint >> inci body
81 else space >> body
77 else space >> body
82
78
83−p_classOpSig ::
79+p_classOpSig
84− -- | Whether this is a \"default\" signature
80+ :: Bool -- ^ Whether this is a \"default\" signature
85− Bool ->
86− -- | Names (before @::@)
87− [Located RdrName] ->
81+ -> [Located RdrName] -- ^ Names (before @::@)
88− -- | Type
89− HsImplicitBndrs GhcPs (LHsType GhcPs) ->
82+ -> HsImplicitBndrs GhcPs (LHsType GhcPs) -- ^ Type
90− R ()
83+ -> R ()
91−p_classOpSig def names hsib = do
84+p_classOpSig def names hsib = do
92 when def (txt "default" >> space)
85 when def (txt "default" >> space)
93− p_typeSig True names HsWC {hswc_ext = NoExtField, hswc_body = hsib}
86+ p_typeSig True names HsWC {hswc_ext = NoExt, hswc_body = hsib}
94
87
95−p_fixSig ::
88+p_fixSig
96− FixitySig GhcPs ->
89+ :: FixitySig GhcPs
97− R ()
90+ -> R ()
98p_fixSig = \case
91p_fixSig = \case
99− FixitySig NoExtField names (Fixity _ n dir) -> do
92+ FixitySig NoExt names (Fixity _ n dir) -> do
100 txt $ case dir of
93 txt $ case dir of
101 InfixL -> "infixl"
94 InfixL -> "infixl"
102 InfixR -> "infixr"
95 InfixR -> "infixr"
@@ -104,15 +97,13 @@ p_fixSig = \case
104 space
97 space
105 atom n
98 atom n
106 space
99 space
107− sitcc $ sep commaDel p_rdrName names
100+ sitcc $ sep (comma >> breakpoint) p_rdrName names
108− XFixitySig x -> noExtCon x
101+ XFixitySig NoExt -> notImplemented "XFixitySig"
109−
102+
110−p_inlineSig ::
103+p_inlineSig
111− -- | Name
112− Located RdrName ->
104+ :: Located RdrName -- ^ Name
113− -- | Inline pragma specification
105+ -> InlinePragma -- ^ Inline pragma specification
114− InlinePragma ->
115− R ()
106+ -> R ()
116p_inlineSig name InlinePragma {..} = pragmaBraces $ do
107p_inlineSig name InlinePragma {..} = pragmaBraces $ do
117 p_inlineSpec inl_inline
108 p_inlineSpec inl_inline
118 space
109 space
@@ -124,14 +115,11 @@ p_inlineSig name InlinePragma {..} = pragmaBraces $ do
124 space
115 space
125 p_rdrName name
116 p_rdrName name
126
117
127−p_specSig ::
118+p_specSig
128− -- | Name
129− Located RdrName ->
119+ :: Located RdrName -- ^ Name
130− -- | The types to specialize to
131− [LHsSigType GhcPs] ->
120+ -> [LHsSigType GhcPs] -- ^ The types to specialize to
132− -- | For specialize inline
121+ -> InlinePragma -- ^ For specialize inline
133− InlinePragma ->
134− R ()
122+ -> R ()
135p_specSig name ts InlinePragma {..} = pragmaBraces $ do
123p_specSig name ts InlinePragma {..} = pragmaBraces $ do
136 txt "SPECIALIZE"
124 txt "SPECIALIZE"
137 space
125 space
@@ -143,7 +131,7 @@ p_specSig name ts InlinePragma {..} = pragmaBraces $ do
143 space
131 space
144 txt "::"
132 txt "::"
145 breakpoint
133 breakpoint
146− inci $ sep commaDel (located' p_hsType . hsib_body) ts
134+ inci $ sep (comma >> breakpoint) (located' p_hsType . hsib_body) ts
147
135
148p_inlineSpec :: InlineSpec -> R ()
136p_inlineSpec :: InlineSpec -> R ()
149p_inlineSpec = \case
137p_inlineSpec = \case
@@ -166,48 +154,39 @@ p_activation = \case
166 txt "]"
154 txt "]"
167
155
168p_specInstSig :: LHsSigType GhcPs -> R ()
156p_specInstSig :: LHsSigType GhcPs -> R ()
169−p_specInstSig hsib =
170− pragma "SPECIALIZE instance" . inci $
157+p_specInstSig hsib = pragma "SPECIALIZE instance" . inci $
171− located (hsib_body hsib) p_hsType
158+ located (hsib_body hsib) p_hsType
172−
159+
173−p_minimalSig ::
160+p_minimalSig
174− -- | Boolean formula
175− LBooleanFormula (Located RdrName) ->
161+ :: LBooleanFormula (Located RdrName) -- ^ Boolean formula
176− R ()
162+ -> R ()
177p_minimalSig =
163p_minimalSig =
178 located' $ \booleanFormula ->
164 located' $ \booleanFormula ->
179 pragma "MINIMAL" (inci $ p_booleanFormula booleanFormula)
165 pragma "MINIMAL" (inci $ p_booleanFormula booleanFormula)
180
166
181−p_booleanFormula ::
167+p_booleanFormula
182− -- | Boolean formula
168+ :: BooleanFormula (Located RdrName) -- ^ Boolean formula
183− BooleanFormula (Located RdrName) ->
184− R ()
169+ -> R ()
185p_booleanFormula = \case
170p_booleanFormula = \case
186 Var name -> p_rdrName name
171 Var name -> p_rdrName name
187− And xs ->
172+ And xs -> sitcc $ sep
188− sitcc $
173+ (comma >> breakpoint)
189− sep
190− commaDel
191− (located' p_booleanFormula)
174+ (located' p_booleanFormula)
192− xs
175+ xs
193− Or xs ->
194− sitcc $
176+ Or xs -> sitcc $ sep
195− sep
196− (breakpoint >> txt "|" >> space)
177+ (breakpoint >> txt "| ")
197− (located' p_booleanFormula)
178+ (located' p_booleanFormula)
198− xs
179+ xs
199 Parens l -> located l (parens N . p_booleanFormula)
180 Parens l -> located l (parens N . p_booleanFormula)
200
181
201−p_completeSig ::
182+p_completeSig
202− -- | Constructors\/patterns
183+ :: Located [Located RdrName] -- ^ Constructors\/patterns
203− Located [Located RdrName] ->
204− -- | Type
205− Maybe (Located RdrName) ->
184+ -> Maybe (Located RdrName) -- ^ Type
206− R ()
185+ -> R ()
207p_completeSig cs' mty =
186p_completeSig cs' mty =
208 located cs' $ \cs ->
187 located cs' $ \cs ->
209 pragma "COMPLETE" . inci $ do
188 pragma "COMPLETE" . inci $ do
210− sep commaDel p_rdrName cs
189+ sitcc $ sep (comma >> breakpoint) p_rdrName cs
211 forM_ mty $ \ty -> do
190 forM_ mty $ \ty -> do
212 space
191 space
213 txt "::"
192 txt "::"
@@ -220,17 +199,3 @@ p_sccSig loc literal = pragma "SCC" . inci $ do
220 forM_ literal $ \x -> do
199 forM_ literal $ \x -> do
221 breakpoint
200 breakpoint
222 atom x
201 atom x
223−
224−p_standaloneKindSig :: StandaloneKindSig GhcPs -> R ()
225−p_standaloneKindSig (StandaloneKindSig NoExtField name bndrs) = do
226− txt "type"
227− inci $ do
228− space
229− p_rdrName name
230− space
231− txt "::"
232− breakpoint
233− case bndrs of
234− HsIB NoExtField sig -> located sig p_hsType
235− XHsImplicitBndrs x -> noExtCon x
236−p_standaloneKindSig (XStandaloneKindSig c) = noExtCon c
src/Ormolu/Printer/Meat/Declaration/Splice.hs+4−3
@@ -1,15 +1,16 @@
1{-# LANGUAGE LambdaCase #-}
1{-# LANGUAGE LambdaCase #-}
2
2
3module Ormolu.Printer.Meat.Declaration.Splice
3module Ormolu.Printer.Meat.Declaration.Splice
4− ( p_spliceDecl,
4+ ( p_spliceDecl
5 )
5 )
6where
6where
7
7
8import GHC
8import GHC
9import Ormolu.Printer.Combinators
9import Ormolu.Printer.Combinators
10import Ormolu.Printer.Meat.Declaration.Value (p_hsSplice)
10import Ormolu.Printer.Meat.Declaration.Value (p_hsSplice)
11+import Ormolu.Utils
11
12
12p_spliceDecl :: SpliceDecl GhcPs -> R ()
13p_spliceDecl :: SpliceDecl GhcPs -> R ()
13p_spliceDecl = \case
14p_spliceDecl = \case
14− SpliceDecl NoExtField splice _explicit -> located splice p_hsSplice
15+ SpliceDecl NoExt splice _explicit -> located splice p_hsSplice
15− XSpliceDecl x -> noExtCon x
16+ XSpliceDecl {} -> notImplemented "XSpliceDecl"
src/Ormolu/Printer/Meat/Declaration/Type.hs+17−20
@@ -1,9 +1,10 @@
1{-# LANGUAGE OverloadedStrings #-}
1{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE RecordWildCards #-}
3
3
4-- | Rendering of type synonym declarations.
4-- | Rendering of type synonym declarations.
5+
5module Ormolu.Printer.Meat.Declaration.Type
6module Ormolu.Printer.Meat.Declaration.Type
6− ( p_synDecl,
7+ ( p_synDecl
7 )
8 )
8where
9where
9
10
@@ -11,30 +12,26 @@ import GHC
11import Ormolu.Printer.Combinators
12import Ormolu.Printer.Combinators
12import Ormolu.Printer.Meat.Common
13import Ormolu.Printer.Meat.Common
13import Ormolu.Printer.Meat.Type
14import Ormolu.Printer.Meat.Type
15+import RdrName (RdrName (..))
16+import SrcLoc (Located)
14
17
15−p_synDecl ::
18+p_synDecl
16− -- | Type constructor
17− Located RdrName ->
19+ :: Located RdrName -- ^ Type constructor
18− -- | Fixity
19− LexicalFixity ->
20+ -> LexicalFixity -- ^ Fixity
20− -- | Type variables
21+ -> LHsQTyVars GhcPs -- ^ Type variables
21− LHsQTyVars GhcPs ->
22− -- | RHS of type declaration
22+ -> LHsType GhcPs -- ^ RHS of type declaration
23− LHsType GhcPs ->
24− R ()
23+ -> R ()
25−p_synDecl name fixity HsQTvs {..} t = do
24+p_synDecl name fixity tvars t = do
26 txt "type"
25 txt "type"
27 space
26 space
27+ let HsQTvs {..} = tvars
28− switchLayout (getLoc name : map getLoc hsq_explicit) $
28+ switchLayout (getLoc name : map getLoc hsq_explicit) $ do
29 p_infixDefHelper
29 p_infixDefHelper
30 (case fixity of Infix -> True; _ -> False)
30 (case fixity of Infix -> True; _ -> False)
31− True
31+ inci
32 (p_rdrName name)
32 (p_rdrName name)
33 (map (located' p_hsTyVarBndr) hsq_explicit)
33 (map (located' p_hsTyVarBndr) hsq_explicit)
34 space
34 space
35− equals
35+ txt "="
36− if hasDocStrings (unLoc t)
37− then newline
38− else breakpoint
36+ breakpoint
39 inci (located t p_hsType)
37 inci (located t p_hsType)
40−p_synDecl _ _ (XLHsQTyVars x) _ = noExtCon x
src/Ormolu/Printer/Meat/Declaration/TypeFamily.hs+44−49
@@ -1,24 +1,27 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
4
4
5-- | Rendering of data\/type families.
5-- | Rendering of data\/type families.
6+
6module Ormolu.Printer.Meat.Declaration.TypeFamily
7module Ormolu.Printer.Meat.Declaration.TypeFamily
7− ( p_famDecl,
8+ ( p_famDecl
8− p_tyFamInstEqn,
9+ , p_tyFamInstEqn
9 )
10 )
10where
11where
11
12
13+import BasicTypes (LexicalFixity (..))
12import Control.Monad
14import Control.Monad
13−import Data.Maybe (isNothing)
15+import Data.Maybe (isNothing, isJust)
14import GHC
16import GHC
15import Ormolu.Printer.Combinators
17import Ormolu.Printer.Combinators
16import Ormolu.Printer.Meat.Common
18import Ormolu.Printer.Meat.Common
17import Ormolu.Printer.Meat.Type
19import Ormolu.Printer.Meat.Type
18import Ormolu.Utils
20import Ormolu.Utils
21+import SrcLoc (Located, GenLocated (..))
19
22
20p_famDecl :: FamilyStyle -> FamilyDecl GhcPs -> R ()
23p_famDecl :: FamilyStyle -> FamilyDecl GhcPs -> R ()
21−p_famDecl style FamilyDecl {fdTyVars = HsQTvs {..}, ..} = do
24+p_famDecl style FamilyDecl {..} = do
22 mmeqs <- case fdInfo of
25 mmeqs <- case fdInfo of
23 DataFamily -> Nothing <$ txt "data"
26 DataFamily -> Nothing <$ txt "data"
24 OpenTypeFamily -> Nothing <$ txt "type"
27 OpenTypeFamily -> Nothing <$ txt "type"
@@ -26,26 +29,27 @@ p_famDecl style FamilyDecl {fdTyVars = HsQTvs {..}, ..} = do
26 txt $ case style of
29 txt $ case style of
27 Associated -> mempty
30 Associated -> mempty
28 Free -> " family"
31 Free -> " family"
32+ let HsQTvs {..} = fdTyVars
29 breakpoint
33 breakpoint
30 inci $ do
34 inci $ do
31− switchLayout (getLoc fdLName : (getLoc <$> hsq_explicit)) $
35+ switchLayout (getLoc fdLName : (getLoc <$> hsq_explicit)) $ do
32 p_infixDefHelper
36 p_infixDefHelper
33 (isInfix fdFixity)
37 (isInfix fdFixity)
34− True
38+ inci
35 (p_rdrName fdLName)
39 (p_rdrName fdLName)
36 (located' p_hsTyVarBndr <$> hsq_explicit)
40 (located' p_hsTyVarBndr <$> hsq_explicit)
37− let resultSig = p_familyResultSigL fdResultSig
41+ let rsig = p_familyResultSigL (isJust fdInjectivityAnn) fdResultSig
38− unless (isNothing resultSig && isNothing fdInjectivityAnn) space
42+ unless (isNothing rsig && isNothing fdInjectivityAnn) $
39− inci $ do
40− sequence_ resultSig
41 space
43 space
44+ inci $ do
45+ sequence_ rsig
46+ when (isJust rsig && isJust fdInjectivityAnn) breakpoint
42 forM_ fdInjectivityAnn (located' p_injectivityAnn)
47 forM_ fdInjectivityAnn (located' p_injectivityAnn)
43 case mmeqs of
48 case mmeqs of
44 Nothing -> return ()
49 Nothing -> return ()
45 Just meqs -> do
50 Just meqs -> do
46− inci $ do
51+ space
47− breakpoint
48− txt "where"
52+ txt "where"
49 case meqs of
53 case meqs of
50 Nothing -> do
54 Nothing -> do
51 space
55 space
@@ -53,27 +57,26 @@ p_famDecl style FamilyDecl {fdTyVars = HsQTvs {..}, ..} = do
53 Just eqs -> do
57 Just eqs -> do
54 newline
58 newline
55 sep newline (located' (inci . p_tyFamInstEqn)) eqs
59 sep newline (located' (inci . p_tyFamInstEqn)) eqs
56−p_famDecl _ FamilyDecl {fdTyVars = XLHsQTyVars {}} =
60+p_famDecl _ (XFamilyDecl NoExt) = notImplemented "XFamilyDecl"
57− notImplemented "XLHsQTyVars"
58−p_famDecl _ (XFamilyDecl x) = noExtCon x
59
61
60−p_familyResultSigL ::
62+p_familyResultSigL
63+ :: Bool
61− Located (FamilyResultSig GhcPs) ->
64+ -> Located (FamilyResultSig GhcPs)
62− Maybe (R ())
65+ -> Maybe (R ())
63−p_familyResultSigL l =
66+p_familyResultSigL injAnn l =
64 case l of
67 case l of
65 L _ a -> case a of
68 L _ a -> case a of
66− NoSig NoExtField -> Nothing
69+ NoSig NoExt -> Nothing
67− KindSig NoExtField k -> Just $ do
70+ KindSig NoExt k -> Just $ do
68− txt "::"
71+ if injAnn then txt "=" else txt "::"
69 breakpoint
72 breakpoint
70 located k p_hsType
73 located k p_hsType
71− TyVarSig NoExtField bndr -> Just $ do
74+ TyVarSig NoExt bndr -> Just $ do
72− equals
75+ if injAnn then txt "=" else txt "::"
73 breakpoint
76 breakpoint
74 located bndr p_hsTyVarBndr
77 located bndr p_hsTyVarBndr
75− XFamilyResultSig x ->
78+ XFamilyResultSig NoExt ->
76− noExtCon x
79+ notImplemented "XFamilyResultSig"
77
80
78p_injectivityAnn :: InjectivityAnn GhcPs -> R ()
81p_injectivityAnn :: InjectivityAnn GhcPs -> R ()
79p_injectivityAnn (InjectivityAnn a bs) = do
82p_injectivityAnn (InjectivityAnn a bs) = do
@@ -86,26 +89,18 @@ p_injectivityAnn (InjectivityAnn a bs) = do
86 sep space p_rdrName bs
89 sep space p_rdrName bs
87
90
88p_tyFamInstEqn :: TyFamInstEqn GhcPs -> R ()
91p_tyFamInstEqn :: TyFamInstEqn GhcPs -> R ()
89−p_tyFamInstEqn HsIB {hsib_body = FamEqn {..}} = do
92+p_tyFamInstEqn HsIB {..} = do
90− case feqn_bndrs of
93+ let FamEqn {..} = hsib_body
91− Nothing -> return ()
92− Just bndrs -> do
93− p_forallBndrs ForallInvis p_hsTyVarBndr bndrs
94− breakpoint
95− inciIf (not $ null feqn_bndrs) $ do
96− let famLhsSpn = getLoc feqn_tycon : fmap (getLoc . typeArgToType) feqn_pats
94+ switchLayout (getLoc feqn_tycon : (getLoc <$> feqn_pats)) $ p_infixDefHelper
97− switchLayout famLhsSpn $
98− p_infixDefHelper
99− (isInfix feqn_fixity)
95+ (isInfix feqn_fixity)
100− True
96+ inci
101− (p_rdrName feqn_tycon)
97+ (p_rdrName feqn_tycon)
102− (located' p_hsType . typeArgToType <$> feqn_pats)
98+ (located' p_hsType <$> feqn_pats)
103− space
99+ space
104− equals
100+ txt "="
105− breakpoint
101+ breakpoint
106− inci (located feqn_rhs p_hsType)
102+ inci (located feqn_rhs p_hsType)
107−p_tyFamInstEqn HsIB {hsib_body = XFamEqn x} = noExtCon x
103+p_tyFamInstEqn (XHsImplicitBndrs NoExt) = notImplemented "XHsImplicitBndrs"
108−p_tyFamInstEqn (XHsImplicitBndrs x) = noExtCon x
109
104
110----------------------------------------------------------------------------
105----------------------------------------------------------------------------
111-- Helpers
106-- Helpers
src/Ormolu/Printer/Meat/Declaration/Value.hs+573−731
@@ -1,15 +1,13 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2−{-# LANGUAGE MultiWayIf #-}
3{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
5−{-# LANGUAGE TypeApplications #-}
6
4
7module Ormolu.Printer.Meat.Declaration.Value
5module Ormolu.Printer.Meat.Declaration.Value
8− ( p_valDecl,
6+ ( p_valDecl
9− p_pat,
7+ , p_pat
10− p_hsExpr,
8+ , p_hsExpr
11− p_hsSplice,
9+ , p_hsSplice
12− p_stringLit,
10+ , p_stringLit
13 )
11 )
14where
12where
15
13
@@ -20,24 +18,26 @@ import Ctype (is_space)
20import Data.Bool (bool)
18import Data.Bool (bool)
21import Data.Char (isPunctuation, isSymbol)
19import Data.Char (isPunctuation, isSymbol)
22import Data.Data hiding (Infix, Prefix)
20import Data.Data hiding (Infix, Prefix)
23−import Data.Functor ((<&>))
24import Data.List (intersperse, sortOn)
21import Data.List (intersperse, sortOn)
25−import Data.List.NonEmpty (NonEmpty (..), (<|))
22+import Data.List.NonEmpty (NonEmpty ((:|)))
26−import qualified Data.List.NonEmpty as NE
27import Data.Text (Text)
23import Data.Text (Text)
28−import qualified Data.Text as Text
29import GHC
24import GHC
30−import OccName (occNameString)
25+import OccName (mkVarOcc)
31import Ormolu.Printer.Combinators
26import Ormolu.Printer.Combinators
32−import Ormolu.Printer.Internal
33import Ormolu.Printer.Meat.Common
27import Ormolu.Printer.Meat.Common
34−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
35import Ormolu.Printer.Meat.Declaration.Signature
28import Ormolu.Printer.Meat.Declaration.Signature
36import Ormolu.Printer.Meat.Type
29import Ormolu.Printer.Meat.Type
37import Ormolu.Printer.Operators
30import Ormolu.Printer.Operators
38import Ormolu.Utils
31import Ormolu.Utils
32+import RdrName (RdrName (..))
33+import RdrName (rdrNameOcc)
34+import SrcLoc (combineSrcSpans, isOneLineSpan)
35+import qualified Data.List.NonEmpty as NE
36+import qualified Data.Text as Text
37+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
39
38
40-- | Style of a group of equations.
39-- | Style of a group of equations.
40+
41data MatchGroupStyle
41data MatchGroupStyle
42 = Function (Located RdrName)
42 = Function (Located RdrName)
43 | PatternBind
43 | PatternBind
@@ -46,61 +46,57 @@ data MatchGroupStyle
46 | LambdaCase
46 | LambdaCase
47
47
48-- | Style of equations in a group.
48-- | Style of equations in a group.
49+
49data GroupStyle
50data GroupStyle
50 = EqualSign
51 = EqualSign
51 | RightArrow
52 | RightArrow
52
53
53-- | Expression placement. This marks the places where expressions that
54-- | Expression placement. This marks the places where expressions that
54-- implement handing forms may use them.
55-- implement handing forms may use them.
56+
55data Placement
57data Placement
56− = -- | Multi-line layout should cause
58+ = Normal -- ^ Multi-line layout should cause
57− -- insertion of a newline and indentation
59+ -- insertion of a newline and indentation
58− -- bump
60+ -- bump
59− Normal
60− | -- | Expressions that have hanging form
61+ | Hanging -- ^ Expressions that have hanging form
61− -- should use it and avoid bumping one level
62+ -- should use it and avoid bumping one level
62− -- of indentation
63+ -- of indentation
63− Hanging
64− deriving (Eq, Show)
64+ deriving (Eq)
65
65
66p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
66p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
67p_valDecl = \case
67p_valDecl = \case
68− FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
68+ FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
69− PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
69+ PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
70 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
70 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
71 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
71 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
72− PatSynBind NoExtField psb -> p_patSynBind psb
72+ PatSynBind NoExt psb -> p_patSynBind psb
73− XHsBindsLR x -> noExtCon x
73+ XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
74
74
75−p_funBind ::
75+p_funBind
76− Located RdrName ->
76+ :: Located RdrName
77− MatchGroup GhcPs (LHsExpr GhcPs) ->
77+ -> MatchGroup GhcPs (LHsExpr GhcPs)
78− R ()
78+ -> R ()
79p_funBind name = p_matchGroup (Function name)
79p_funBind name = p_matchGroup (Function name)
80
80
81−p_matchGroup ::
81+p_matchGroup
82− MatchGroupStyle ->
82+ :: MatchGroupStyle
83− MatchGroup GhcPs (LHsExpr GhcPs) ->
83+ -> MatchGroup GhcPs (LHsExpr GhcPs)
84− R ()
84+ -> R ()
85p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
85p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
86
86
87−p_matchGroup' ::
87+p_matchGroup'
88− Data body =>
88+ :: Data body
89− -- | How to get body placement
89+ => (body -> Placement) -- ^ How to get body placement
90− (body -> Placement) ->
91− -- | How to print body
90+ -> (body -> R ()) -- ^ How to print body
92− (body -> R ()) ->
93− -- | Style of this group of equations
91+ -> MatchGroupStyle -- ^ Style of this group of equations
94− MatchGroupStyle ->
95− -- | Match group
96− MatchGroup GhcPs (Located body) ->
92+ -> MatchGroup GhcPs (Located body) -- ^ Match group
97− R ()
93+ -> R ()
98−p_matchGroup' placer render style MG {..} = do
94+p_matchGroup' placer pretty style MG {..} = do
99 let ob = case style of
95 let ob = case style of
100 Case -> id
96 Case -> id
101 LambdaCase -> id
97 LambdaCase -> id
102 _ -> dontUseBraces
98 _ -> dontUseBraces
103− -- Since we are forcing braces on 'sepSemi' based on 'ob', we have to
99+ -- NOTE since we are forcing braces on 'sepSemi' based on 'ob', we have to
104 -- restore the brace state inside the sepsemi.
100 -- restore the brace state inside the sepsemi.
105 ub <- bool dontUseBraces useBraces <$> canUseBraces
101 ub <- bool dontUseBraces useBraces <$> canUseBraces
106 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
102 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -108,14 +104,14 @@ p_matchGroup' placer render style MG {..} = do
108 p_Match m@Match {..} =
104 p_Match m@Match {..} =
109 p_match'
105 p_match'
110 placer
106 placer
111− render
107+ pretty
112 (adjustMatchGroupStyle m style)
108 (adjustMatchGroupStyle m style)
113 (isInfixMatch m)
109 (isInfixMatch m)
114 (matchStrictness m)
110 (matchStrictness m)
115 m_pats
111 m_pats
116 m_grhss
112 m_grhss
117− p_Match (XMatch x) = noExtCon x
113+ p_Match _ = notImplemented "XMatch"
118−p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
114+p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
119
115
120-- | Function id obtained through pattern matching on 'FunBind' should not
116-- | Function id obtained through pattern matching on 'FunBind' should not
121-- be used to print the actual equations because the different ‘RdrNames’
117-- be used to print the actual equations because the different ‘RdrNames’
@@ -123,10 +119,11 @@ p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
123-- and paretheses) associated with them. It is necessary to use per-equation
119-- and paretheses) associated with them. It is necessary to use per-equation
124-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
120-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
125-- name inside of 'Function' accordingly.
121-- name inside of 'Function' accordingly.
122+
126−adjustMatchGroupStyle ::
123+adjustMatchGroupStyle
127− Match GhcPs body ->
124+ :: Match GhcPs body
128− MatchGroupStyle ->
125+ -> MatchGroupStyle
129− MatchGroupStyle
126+ -> MatchGroupStyle
130adjustMatchGroupStyle m = \case
127adjustMatchGroupStyle m = \case
131 Function _ -> (Function . mc_fun . m_ctxt) m
128 Function _ -> (Function . mc_fun . m_ctxt) m
132 style -> style
129 style -> style
@@ -134,43 +131,31 @@ adjustMatchGroupStyle m = \case
134matchStrictness :: Match id body -> SrcStrictness
131matchStrictness :: Match id body -> SrcStrictness
135matchStrictness match =
132matchStrictness match =
136 case m_ctxt match of
133 case m_ctxt match of
137− FunRhs {mc_strictness = s} -> s
134+ FunRhs{mc_strictness=s} -> s
138 _ -> NoSrcStrict
135 _ -> NoSrcStrict
139
136
140−p_match ::
137+p_match
141− -- | Style of the group
138+ :: MatchGroupStyle -- ^ Style of the group
142− MatchGroupStyle ->
143− -- | Is this an infix match?
139+ -> Bool -- ^ Is this an infix match?
144− Bool ->
145− -- | Strictness prefix (FunBind)
140+ -> SrcStrictness -- ^ Strictness prefix (FunBind)
146− SrcStrictness ->
147− -- | Argument patterns
148− [LPat GhcPs] ->
141+ -> [LPat GhcPs] -- ^ Argument patterns
149− -- | Equations
150− GRHSs GhcPs (LHsExpr GhcPs) ->
142+ -> GRHSs GhcPs (LHsExpr GhcPs) -- ^ Equations
151− R ()
143+ -> R ()
152p_match = p_match' exprPlacement p_hsExpr
144p_match = p_match' exprPlacement p_hsExpr
153
145
154−p_match' ::
146+p_match'
155− Data body =>
147+ :: Data body
156− -- | How to get body placement
148+ => (body -> Placement) -- ^ How to get body placement
157− (body -> Placement) ->
158− -- | How to print body
149+ -> (body -> R ()) -- ^ How to print body
159− (body -> R ()) ->
160− -- | Style of this group of equations
150+ -> MatchGroupStyle -- ^ Style of this group of equations
161− MatchGroupStyle ->
162− -- | Is this an infix match?
151+ -> Bool -- ^ Is this an infix match?
163− Bool ->
164− -- | Strictness prefix (FunBind)
152+ -> SrcStrictness -- ^ Strictness prefix (FunBind)
165− SrcStrictness ->
166− -- | Argument patterns
167− [LPat GhcPs] ->
153+ -> [LPat GhcPs] -- ^ Argument patterns
168− -- | Equations
169− GRHSs GhcPs (Located body) ->
154+ -> GRHSs GhcPs (Located body) -- ^ Equations
170− R ()
155+ -> R ()
171−p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
156+p_match' placer pretty style isInfix strictness m_pats m_grhss = do
172− -- Normally, since patterns may be placed in a multi-line layout, it is
157+ -- NOTE Normally, since patterns may be placed in a multi-line layout, it
173− -- necessary to bump indentation for the pattern group so it's more
158+ -- is necessary to bump indentation for the pattern group so it's more
174 -- indented than function name. This in turn means that indentation for
159 -- indented than function name. This in turn means that indentation for
175 -- the body should also be bumped. Normally this would mean that bodies
160 -- the body should also be bumped. Normally this would mean that bodies
176 -- would start with two indentation steps applied, which is ugly, so we
161 -- would start with two indentation steps applied, which is ugly, so we
@@ -180,24 +165,23 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
180 NoSrcStrict -> return ()
165 NoSrcStrict -> return ()
181 SrcStrict -> txt "!"
166 SrcStrict -> txt "!"
182 SrcLazy -> txt "~"
167 SrcLazy -> txt "~"
183− indentBody <- case NE.nonEmpty m_pats of
168+ inci' <- case NE.nonEmpty m_pats of
184− Nothing ->
185− False <$ case style of
169+ Nothing -> id <$ case style of
186− Function name -> p_rdrName name
170+ Function name -> p_rdrName name
187− _ -> return ()
171+ _ -> return ()
188 Just ne_pats -> do
172 Just ne_pats -> do
189− let combinedSpans = case style of
173+ let combinedSpans = combineSrcSpans' $
190− Function name -> combineSrcSpans (getLoc name) patSpans
191− _ -> patSpans
192− patSpans = combineSrcSpans' (getLoc <$> ne_pats)
174+ getLoc <$> ne_pats
193− indentBody = not (isOneLineSpan combinedSpans)
175+ inci' = if isOneLineSpan combinedSpans
176+ then id
177+ else inci
194 switchLayout [combinedSpans] $ do
178 switchLayout [combinedSpans] $ do
195 let stdCase = sep breakpoint (located' p_pat) m_pats
179 let stdCase = sep breakpoint (located' p_pat) m_pats
196 case style of
180 case style of
197 Function name ->
181 Function name ->
198 p_infixDefHelper
182 p_infixDefHelper
199 isInfix
183 isInfix
200− indentBody
184+ inci'
201 (p_rdrName name)
185 (p_rdrName name)
202 (located' p_pat <$> m_pats)
186 (located' p_pat <$> m_pats)
203 PatternBind -> stdCase
187 PatternBind -> stdCase
@@ -212,40 +196,46 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
212 when needsSpace space
196 when needsSpace space
213 sitcc stdCase
197 sitcc stdCase
214 LambdaCase -> stdCase
198 LambdaCase -> stdCase
215− return indentBody
199+ return inci'
200+ let
216− let -- Calculate position of end of patterns. This is useful when we decide
201+ -- Calculate position of end of patterns. This is useful when we decide
217− -- about putting certain constructions in hanging positions.
202+ -- about putting certain constructions in hanging positions.
218− endOfPats = case NE.nonEmpty m_pats of
203+ endOfPats = case NE.nonEmpty m_pats of
219− Nothing -> case style of
204+ Nothing -> case style of
220− Function name -> Just (getLoc name)
205+ Function name -> (Just . srcSpanEnd . getLoc) name
221− _ -> Nothing
206+ _ -> Nothing
222− Just pats -> (Just . getLoc . NE.last) pats
207+ Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
223− isCase = \case
208+ isCase = \case
224− Case -> True
209+ Case -> True
225− LambdaCase -> True
210+ LambdaCase -> True
226− _ -> False
211+ _ -> False
212+ let GRHSs {..} = m_grhss
227 hasGuards = withGuards grhssGRHSs
213 hasGuards = withGuards grhssGRHSs
228− grhssSpan =
214+ unless (length grhssGRHSs > 1) $ do
215+ case style of
216+ Function _ | hasGuards -> return ()
217+ Function _ -> space >> txt "="
218+ PatternBind -> space >> txt "="
219+ s | isCase s && hasGuards -> return ()
220+ _ -> space >> txt "->"
229− combineSrcSpans' $
221+ let grhssSpan = combineSrcSpans' $
230− getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
222+ getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
231− patGrhssSpan =
223+ patGrhssSpan = maybe grhssSpan
232− maybe
233− grhssSpan
234− (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
224+ (combineSrcSpans grhssSpan . srcLocSpan) endOfPats
235− endOfPats
236 placement =
225 placement =
237 case endOfPats of
226 case endOfPats of
238 Nothing -> blockPlacement placer grhssGRHSs
227 Nothing -> blockPlacement placer grhssGRHSs
239 Just spn ->
228 Just spn ->
229+ if isOneLineSpan
240− if onTheSameLine spn grhssSpan
230+ (mkSrcSpan spn (srcSpanStart grhssSpan))
241 then blockPlacement placer grhssGRHSs
231 then blockPlacement placer grhssGRHSs
242 else Normal
232 else Normal
243 p_body = do
233 p_body = do
244 let groupStyle =
234 let groupStyle =
245 if isCase style && hasGuards
235 if isCase style && hasGuards
246− then RightArrow
236+ then RightArrow
247− else EqualSign
237+ else EqualSign
248− sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
238+ sep newline (located' (p_grhs' placer pretty groupStyle)) grhssGRHSs
249 p_where = do
239 p_where = do
250 let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
240 let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
251 unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
241 unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
@@ -253,178 +243,150 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
253 txt "where"
243 txt "where"
254 unless whereIsEmpty breakpoint
244 unless whereIsEmpty breakpoint
255 inci $ located grhssLocalBinds p_hsLocalBinds
245 inci $ located grhssLocalBinds p_hsLocalBinds
256− inciIf indentBody $ do
246+ inci' $ do
257− unless (length grhssGRHSs > 1) $
258− case style of
259− Function _ | hasGuards -> return ()
260− Function _ -> space >> inci equals
261− PatternBind -> space >> inci equals
262− s | isCase s && hasGuards -> return ()
263− _ -> space >> txt "->"
264 switchLayout [patGrhssSpan] $
247 switchLayout [patGrhssSpan] $
265 placeHanging placement p_body
248 placeHanging placement p_body
266 inci p_where
249 inci p_where
267−p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
268
250
269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
251p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
270p_grhs = p_grhs' exprPlacement p_hsExpr
252p_grhs = p_grhs' exprPlacement p_hsExpr
271
253
272−p_grhs' ::
254+p_grhs'
273− Data body =>
255+ :: Data body
274− -- | How to get body placement
256+ => (body -> Placement) -- ^ How to get body placement
275− (body -> Placement) ->
276− -- | How to print body
257+ -> (body -> R ()) -- ^ How to print body
277− (body -> R ()) ->
278− GroupStyle ->
258+ -> GroupStyle
279− GRHS GhcPs (Located body) ->
259+ -> GRHS GhcPs (Located body)
280− R ()
260+ -> R ()
281−p_grhs' placer render style (GRHS NoExtField guards body) =
261+p_grhs' placer pretty style (GRHS NoExt guards body) =
282 case guards of
262 case guards of
283 [] -> p_body
263 [] -> p_body
284 xs -> do
264 xs -> do
285 txt "|"
265 txt "|"
286 space
266 space
287− sitcc (sep commaDel (sitcc . located' p_stmt) xs)
267+ sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
288 space
268 space
289− inci $ case style of
269+ txt $ case style of
290− EqualSign -> equals
270+ EqualSign -> "="
291− RightArrow -> txt "->"
271+ RightArrow -> "->"
292 placeHanging placement p_body
272 placeHanging placement p_body
293 where
273 where
294 placement =
274 placement =
295 case endOfGuards of
275 case endOfGuards of
296 Nothing -> placer (unLoc body)
276 Nothing -> placer (unLoc body)
297 Just spn ->
277 Just spn ->
298− if onTheSameLine spn (getLoc body)
278+ if isOneLineSpan (mkSrcSpan spn (srcSpanStart (getLoc body)))
299− then placer (unLoc body)
279+ then placer (unLoc body)
300− else Normal
280+ else Normal
301 endOfGuards =
281 endOfGuards =
302 case NE.nonEmpty guards of
282 case NE.nonEmpty guards of
303 Nothing -> Nothing
283 Nothing -> Nothing
304− Just gs -> (Just . getLoc . NE.last) gs
284+ Just gs -> (Just . srcSpanEnd . getLoc . NE.last) gs
305− p_body = located body render
285+ p_body = located body pretty
306−p_grhs' _ _ _ (XGRHS x) = noExtCon x
286+p_grhs' _ _ _ (XGRHS NoExt) = notImplemented "XGRHS"
307
287
308p_hsCmd :: HsCmd GhcPs -> R ()
288p_hsCmd :: HsCmd GhcPs -> R ()
309p_hsCmd = \case
289p_hsCmd = \case
310− HsCmdArrApp NoExtField body input arrType _ -> do
290+ HsCmdArrApp NoExt body input arrType _ -> do
311 located body p_hsExpr
291 located body p_hsExpr
312− breakpoint
292+ space
313− inci $ do
314− case arrType of
293+ case arrType of
315− HsFirstOrderApp -> txt "-<"
294+ HsFirstOrderApp -> txt "-<"
316− HsHigherOrderApp -> txt "-<<"
295+ HsHigherOrderApp -> txt "-<<"
317− placeHanging (exprPlacement (unLoc input)) $
296+ placeHanging (exprPlacement (unLoc input)) $
318− located input p_hsExpr
297+ located input p_hsExpr
319− HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ do
298+ HsCmdArrForm NoExt form Prefix _ cmds -> banana $ sitcc $ do
320 located form p_hsExpr
299 located form p_hsExpr
321 unless (null cmds) $ do
300 unless (null cmds) $ do
322 breakpoint
301 breakpoint
323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
302 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
324− HsCmdArrForm NoExtField form Infix _ [left, right] -> do
303+ HsCmdArrForm NoExt form Infix _ [left, right] -> do
325 located left p_hsCmdTop
304 located left p_hsCmdTop
326 space
305 space
327 located form p_hsExpr
306 located form p_hsExpr
328 placeHanging (cmdTopPlacement (unLoc right)) $
307 placeHanging (cmdTopPlacement (unLoc right)) $
329 located right p_hsCmdTop
308 located right p_hsCmdTop
330− HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
309+ HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
331 HsCmdApp {} ->
310 HsCmdApp {} ->
332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
311 -- XXX Does this ever occur in the syntax tree? It does not seem like it
333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
312 -- does. Open an issue and ping @yumiova if this ever occurs in output.
334 notImplemented "HsCmdApp"
313 notImplemented "HsCmdApp"
335− HsCmdLam NoExtField mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
314+ HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
336− HsCmdPar NoExtField c -> parens N (located c p_hsCmd)
315+ HsCmdPar NoExt c -> parens N (located c p_hsCmd)
337− HsCmdCase NoExtField e mgroup ->
316+ HsCmdCase NoExt e mgroup -> do
317+ txt "case"
318+ space
319+ located e p_hsExpr
320+ space
321+ txt "of"
322+ breakpoint
338− p_case cmdPlacement p_hsCmd e mgroup
323+ inci (p_matchGroup' cmdPlacement p_hsCmd Case mgroup)
339− HsCmdIf NoExtField _ if' then' else' ->
324+ HsCmdIf NoExt _ if' then' else' -> do
340− p_if cmdPlacement p_hsCmd if' then' else'
325+ txt "if"
326+ space
327+ located if' p_hsExpr
328+ breakpoint
329+ txt "then"
330+ located then' $ \x -> do
331+ breakpoint
332+ inci (p_hsCmd x)
333+ breakpoint
334+ txt "else"
335+ located else' $ \x -> do
336+ breakpoint
337+ inci (p_hsCmd x)
341− HsCmdLet NoExtField localBinds c ->
338+ HsCmdLet NoExt localBinds c -> do
342− p_let p_hsCmd localBinds c
339+ txt "let"
340+ space
341+ sitcc (located localBinds p_hsLocalBinds)
342+ breakpoint
343+ vlayout space (newline >> txt " ")
344+ txt "in"
345+ space
346+ sitcc (located c p_hsCmd)
343− HsCmdDo NoExtField es -> do
347+ HsCmdDo NoExt es -> do
344 txt "do"
348 txt "do"
345 newline
349 newline
346− inci . located es $
347− sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
350+ inci (located es (sitcc . sep newline (located' (sitcc . p_stmt' p_hsCmd))))
348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
351 HsCmdWrap {} -> notImplemented "HsCmdWrap"
349− XCmd x -> noExtCon x
352+ XCmd {} -> notImplemented "XCmd"
350
353
351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
354p_hsCmdTop :: HsCmdTop GhcPs -> R ()
352p_hsCmdTop = \case
355p_hsCmdTop = \case
353− HsCmdTop NoExtField cmd -> located cmd p_hsCmd
356+ HsCmdTop NoExt cmd -> located cmd p_hsCmd
354− XCmdTop x -> noExtCon x
357+ XCmdTop {} -> notImplemented "XHsCmdTop"
355−
356−-- | Render an expression preserving blank lines between such consecutive
357−-- expressions found in the original source code.
358−withSpacing ::
359− -- | Rendering function
360− (a -> R ()) ->
361− -- | Entity to render
362− Located a ->
363− R ()
364−withSpacing f l = located l $ \x -> do
365− case getLoc l of
366− UnhelpfulSpan _ -> f x
367− RealSrcSpan currentSpn -> do
368− getSpanMark >>= \case
369− -- Spacing before comments will be handled by the code
370− -- that prints comments, so we just have to deal with
371− -- blank lines between statements here.
372− Just (StatementSpan lastSpn) ->
373− if srcSpanStartLine currentSpn > srcSpanEndLine lastSpn + 1
374− then newline
375− else return ()
376− _ -> return ()
377− f x
378− -- In some cases the (f x) expression may insert a new mark. We want
379− -- to be careful not to override comment marks.
380− getSpanMark >>= \case
381− Just (HaddockSpan _ _) -> return ()
382− Just (CommentSpan _) -> return ()
383− _ -> setSpanMark (StatementSpan currentSpn)
384
358
385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
359p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
386−p_stmt = p_stmt' exprPlacement p_hsExpr
360+p_stmt = p_stmt' p_hsExpr
387−
361+
388−p_stmt' ::
362+p_stmt'
389− Data body =>
363+ :: Data body
390− -- | Placer
391− (body -> Placement) ->
364+ => (body -> R ())
392− -- | Render
393− (body -> R ()) ->
394− -- | Statement to render
395− Stmt GhcPs (Located body) ->
365+ -> Stmt GhcPs (Located body)
396− R ()
366+ -> R ()
397−p_stmt' placer render = \case
367+p_stmt' pretty = \case
398− LastStmt NoExtField body _ _ -> located body render
368+ LastStmt NoExt body _ _ -> located body pretty
399− BindStmt NoExtField p f _ _ -> do
369+ BindStmt NoExt l f _ _ -> do
400− located p p_pat
370+ located l p_pat
401 space
371 space
402 txt "<-"
372 txt "<-"
403− let loc = getLoc p
373+ breakpoint
404− placement =
374+ inci (located f pretty)
405− case f of
406− L l' x ->
407− if isOneLineSpan
408− (mkSrcSpan (srcSpanEnd loc) (srcSpanStart l'))
409− then placer x
410− else Normal
411− switchLayout [loc, getLoc f] $
412− placeHanging placement (located f render)
413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
375 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
414− BodyStmt NoExtField body _ _ -> located body render
376+ BodyStmt NoExt body _ _ -> located body pretty
415− LetStmt NoExtField binds -> do
377+ LetStmt NoExt binds -> do
416 txt "let"
378 txt "let"
417 space
379 space
418 sitcc $ located binds p_hsLocalBinds
380 sitcc $ located binds p_hsLocalBinds
419 ParStmt {} ->
381 ParStmt {} ->
420− -- 'ParStmt' should always be eliminated in 'gatherStmt' already, such
382+ -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
421− -- that it never occurs in 'p_stmt''. Consequently, handling it here
383+ -- such that it never occurs in 'p_stmt''. Consequently, handling it
422− -- would be redundant.
384+ -- here would be redundant.
423 notImplemented "ParStmt"
385 notImplemented "ParStmt"
424− TransStmt {..} ->
386+ TransStmt {..} -> do
425− -- 'TransStmt' only needs to account for render printing itself, since
387+ -- NOTE 'TransStmt' only needs to account for pretty printing itself,
426− -- pretty printing of relevant statements (e.g., in 'trS_stmts') is
388+ -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
427− -- handled through 'gatherStmt'.
389+ -- is handled through 'gatherStmt'.
428 case (trS_form, trS_by) of
390 case (trS_form, trS_by) of
429 (ThenForm, Nothing) -> do
391 (ThenForm, Nothing) -> do
430 txt "then"
392 txt "then"
@@ -453,11 +415,11 @@ p_stmt' placer render = \case
453 RecStmt {..} -> do
415 RecStmt {..} -> do
454 txt "rec"
416 txt "rec"
455 space
417 space
456− sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
418+ sitcc $ sepSemi (located' (p_stmt' pretty)) recS_stmts
457− XStmtLR c -> noExtCon c
419+ XStmtLR {} -> notImplemented "XStmtLR"
458
420
459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
421gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
460−gatherStmt (L _ (ParStmt NoExtField block _ _)) =
422+gatherStmt (L _ (ParStmt NoExt block _ _)) =
461 foldr ((<>) . gatherStmtBlock) [] block
423 foldr ((<>) . gatherStmtBlock) [] block
462gatherStmt (L s stmt@TransStmt {..}) =
424gatherStmt (L s stmt@TransStmt {..}) =
463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
425 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -466,230 +428,205 @@ gatherStmt stmt = [[stmt]]
466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
428gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
429gatherStmtBlock (ParStmtBlock _ stmts _ _) =
468 foldr (liftAppend . gatherStmt) [] stmts
430 foldr (liftAppend . gatherStmt) [] stmts
469−gatherStmtBlock (XParStmtBlock x) = noExtCon x
431+gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
470
432
471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
433p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
472p_hsLocalBinds = \case
434p_hsLocalBinds = \case
473− HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
435+ HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
436+ let ssStart = either
437+ (srcSpanStart . getLoc)
438+ (srcSpanStart . getLoc)
439+ items =
440+ (Left <$> bagToList bag) ++ (Right <$> lsigs)
441+ p_item (Left x) = located x p_valDecl
442+ p_item (Right x) = located x p_sigDecl
443+ -- Assigns 'False' to the last element, 'True' to the rest.
444+ markInit :: [a] -> [(Bool, a)]
445+ markInit [] = []
446+ markInit (x:[]) = [(False, x)]
447+ markInit (x:xs) = (True, x) : markInit xs
474− -- When in a single-line layout, there is a chance that the inner
448+ -- NOTE When in a single-line layout, there is a chance that the inner
475 -- elements will also contain semicolons and they will confuse the
449 -- elements will also contain semicolons and they will confuse the
476 -- parser. so we request braces around every element except the last.
450 -- parser. so we request braces around every element except the last.
477 br <- layoutToBraces <$> getLayout
451 br <- layoutToBraces <$> getLayout
478− let items =
452+ sitcc $ sepSemi
479− let injectLeft (L l x) = L l (Left x)
453+ (\(m, i) -> (if m then br else id) $ p_item i)
480− injectRight (L l x) = L l (Right x)
454+ (markInit $ sortOn ssStart items)
481− in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
482− positionToBracing = \case
483− SinglePos -> id
484− FirstPos -> br
485− MiddlePos -> br
486− LastPos -> id
487− p_item' (p, item) =
488− positionToBracing p $
489− withSpacing (either p_valDecl p_sigDecl) item
490− binds = sortOn (srcSpanStart . getLoc) items
491− sitcc $ sepSemi p_item' (attachRelativePos binds)
492− HsValBinds NoExtField _ -> notImplemented "HsValBinds"
455+ HsValBinds NoExt _ -> notImplemented "HsValBinds"
493− HsIPBinds NoExtField (IPBinds NoExtField xs) ->
456+ HsIPBinds NoExt (IPBinds NoExt xs) ->
494 -- Second argument of IPBind is always Left before type-checking.
457 -- Second argument of IPBind is always Left before type-checking.
495− let p_ipBind (IPBind NoExtField (Left name) expr) = do
458+ let p_ipBind (IPBind NoExt (Left name) expr) = do
496 atom name
459 atom name
497 space
460 space
498− equals
461+ txt "="
499 breakpoint
462 breakpoint
500 useBraces $ inci $ located expr p_hsExpr
463 useBraces $ inci $ located expr p_hsExpr
501− p_ipBind (IPBind NoExtField (Right _) _) =
502− -- Should only occur after the type checker
503− notImplemented "IPBind _ (Right _) _"
464+ p_ipBind _ = notImplemented "XHsIPBinds"
504− p_ipBind (XIPBind x) = noExtCon x
505 in sepSemi (located' p_ipBind) xs
465 in sepSemi (located' p_ipBind) xs
506− HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
466+ HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
507− EmptyLocalBinds NoExtField -> return ()
467+ EmptyLocalBinds NoExt -> return ()
508− XHsLocalBindsLR x -> noExtCon x
468+ XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
509−
469+
510−p_hsRecField ::
470+p_hsRecField
511− HsRecField' RdrName (LHsExpr GhcPs) ->
471+ :: HsRecField' RdrName (LHsExpr GhcPs)
512− R ()
472+ -> R ()
513−p_hsRecField HsRecField {..} = do
473+p_hsRecField = \HsRecField {..} -> do
514 p_rdrName hsRecFieldLbl
474 p_rdrName hsRecFieldLbl
515 unless hsRecPun $ do
475 unless hsRecPun $ do
516 space
476 space
517− equals
477+ txt "="
518− let placement =
519− if onTheSameLine (getLoc hsRecFieldLbl) (getLoc hsRecFieldArg)
520− then exprPlacement (unLoc hsRecFieldArg)
478+ let placement = exprPlacement (unLoc hsRecFieldArg)
521− else Normal
522− placeHanging placement (located hsRecFieldArg p_hsExpr)
479+ placeHanging placement $ located hsRecFieldArg p_hsExpr
480+
481+p_hsTupArg :: HsTupArg GhcPs -> R ()
482+p_hsTupArg = \case
483+ Present NoExt x -> located x p_hsExpr
484+ Missing NoExt -> pure ()
485+ XTupArg {} -> notImplemented "XTupArg"
523
486
524p_hsExpr :: HsExpr GhcPs -> R ()
487p_hsExpr :: HsExpr GhcPs -> R ()
525p_hsExpr = p_hsExpr' N
488p_hsExpr = p_hsExpr' N
526
489
527p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
490p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
528p_hsExpr' s = \case
491p_hsExpr' s = \case
529− HsVar NoExtField name -> p_rdrName name
492+ HsVar NoExt name -> p_rdrName name
530− HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
493+ HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
531− HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
494+ HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
532− HsRecFld NoExtField x ->
495+ HsRecFld NoExt x ->
533 case x of
496 case x of
534− Unambiguous NoExtField name -> p_rdrName name
497+ Unambiguous NoExt name -> p_rdrName name
535− Ambiguous NoExtField name -> p_rdrName name
498+ Ambiguous NoExt name -> p_rdrName name
536− XAmbiguousFieldOcc xx -> noExtCon xx
499+ XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
537− HsOverLabel NoExtField _ v -> do
500+ HsOverLabel NoExt _ v -> do
538 txt "#"
501 txt "#"
539 atom v
502 atom v
540− HsIPVar NoExtField (HsIPName name) -> do
503+ HsIPVar NoExt (HsIPName name) -> do
541 txt "?"
504 txt "?"
542 atom name
505 atom name
543− HsOverLit NoExtField v -> atom (ol_val v)
506+ HsOverLit NoExt v -> atom (ol_val v)
544− HsLit NoExtField lit ->
507+ HsLit NoExt lit ->
545 case lit of
508 case lit of
546 HsString (SourceText stxt) _ -> p_stringLit stxt
509 HsString (SourceText stxt) _ -> p_stringLit stxt
547 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
510 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
548 r -> atom r
511 r -> atom r
549− HsLam NoExtField mgroup ->
512+ HsLam NoExt mgroup ->
550 p_matchGroup Lambda mgroup
513 p_matchGroup Lambda mgroup
551− HsLamCase NoExtField mgroup -> do
514+ HsLamCase NoExt mgroup -> do
552 txt "\\case"
515 txt "\\case"
553 breakpoint
516 breakpoint
554 inci (p_matchGroup LambdaCase mgroup)
517 inci (p_matchGroup LambdaCase mgroup)
555− HsApp NoExtField f x -> do
518+ HsApp NoExt f x -> do
556− let -- In order to format function applications with multiple parameters
519+ -- We hang only the last function argument. In order to do
557− -- nicer, traverse the AST to gather the function and all the
520+ -- this, we only call 'placeHanging' on the topmost 'HsApp',
558− -- parameters together.
521+ -- and then use 'p_withoutHanging' for the descendants.
559− gatherArgs f' knownArgs =
522+ let p_withoutHanging (HsApp NoExt f' x') = do
560 case f' of
523 case f' of
561− L _ (HsApp _ l r) -> gatherArgs l (r <| knownArgs)
524+ L _ (HsApp _ _ _) -> located f' p_withoutHanging
562− _ -> (f', knownArgs)
563− (func, args) = gatherArgs f (x :| [])
564− -- We need to handle the last argument specially if it is a
565− -- hanging construct, so separate it from the rest.
566− (initp, lastp) = (NE.init args, NE.last args)
567− initSpan =
568− combineSrcSpans' $
569− getLoc f :| [(srcLocSpan . srcSpanStart . getLoc) lastp]
570− -- Hang the last argument only if the initial arguments span one
571− -- line.
572− placement =
573− if isOneLineSpan initSpan
574− then exprPlacement (unLoc lastp)
575− else Normal
576− -- If the last argument is not hanging, just separate every argument as
577− -- usual. If it is hanging, print the initial arguments and hang the
578− -- last one. Also, use braces around the every argument except the last
579− -- one.
580− case placement of
581− Normal -> do
582− let -- Usually we want to bump indentation for arguments for the
583− -- sake of readability. However, when the function itself is a
584− -- do-block or case expression it is not a good idea. It seems
585− -- to be safe to always bump indentation when the function
586− -- expression is parenthesised.
587− doIndent =
588− case func of
589− L _ (HsPar NoExtField _) -> True
590− L _ (HsAppType NoExtField _ _) -> True
591− L _ (HsMultiIf NoExtField _) -> True
592− L spn _ -> isOneLineSpan spn
593− ub <-
594− getLayout <&> \case
595− SingleLine -> useBraces
596− MultiLine -> id
597− ub $ do
598− located func (p_hsExpr' s)
525+ _ -> located f' (p_hsExpr' s)
599 breakpoint
526 breakpoint
600− inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
527+ inci $ located x' p_hsExpr
601− inciIf doIndent $ do
528+ p_withoutHanging e = p_hsExpr e
602− unless (null initp) breakpoint
529+ -- Only use the hanging placement if the function spans
603− located lastp p_hsExpr
530+ -- a single line.
604− Hanging -> do
531+ placement =
605− useBraces . switchLayout [initSpan] $ do
532+ if isOneLineSpan (getLoc f)
606− located func (p_hsExpr' s)
533+ then exprPlacement (unLoc x)
607− breakpoint
534+ else Normal
608− sep breakpoint (located' p_hsExpr) initp
535+ -- We only sit when the last expression is not hanging.
536+ -- This is to allow:
537+ -- f = foo bar do
538+ -- baz
539+ sit' = if placement == Normal
540+ then sitcc
541+ else id
542+ sit' $ do
543+ useBraces $ located f p_withoutHanging
609− placeHanging placement $
544+ placeHanging placement $
610− located lastp p_hsExpr
545+ located x p_hsExpr
611− HsAppType NoExtField e a -> do
546+ HsAppType a e -> do
612 located e p_hsExpr
547 located e p_hsExpr
613 breakpoint
548 breakpoint
614 inci $ do
549 inci $ do
615 txt "@"
550 txt "@"
616− -- Insert a space when the type is represented as a TH splice to avoid
617− -- gluing @ and $ together.
618− case unLoc (hswc_body a) of
619− HsSpliceTy {} -> space
620− _ -> return ()
621 located (hswc_body a) p_hsType
551 located (hswc_body a) p_hsType
622− OpApp NoExtField x op y -> do
552+ OpApp NoExt x op y -> do
623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
553 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
624− p_exprOpTree s (reassociateOpTree getOpName opTree)
554+ p_exprOpTree True s (reassociateOpTree getOpName opTree)
625− NegApp NoExtField e _ -> do
555+ NegApp NoExt e _ -> do
626 txt "-"
556 txt "-"
627 space
557 space
628 located e p_hsExpr
558 located e p_hsExpr
629− HsPar NoExtField e ->
630− parens s (located e (dontUseBraces . p_hsExpr))
559+ HsPar NoExt e -> parens s (located e p_hsExpr)
631− SectionL NoExtField x op -> do
560+ SectionL NoExt x op -> do
632 located x p_hsExpr
561 located x p_hsExpr
633 breakpoint
562 breakpoint
634 inci (located op p_hsExpr)
563 inci (located op p_hsExpr)
635− SectionR NoExtField op x -> do
564+ SectionR NoExt op x -> do
636 located op p_hsExpr
565 located op p_hsExpr
637− useRecordDot' <- useRecordDot
638− let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639− unless (useRecordDot' && isRecordDot') breakpoint
566+ breakpoint
640 inci (located x p_hsExpr)
567 inci (located x p_hsExpr)
641− ExplicitTuple NoExtField args boxity ->
568+ ExplicitTuple NoExt args boxity -> do
642 let isSection = any (isMissing . unLoc) args
569 let isSection = any (isMissing . unLoc) args
643 isMissing = \case
570 isMissing = \case
644− Missing NoExtField -> True
571+ Missing NoExt -> True
645 _ -> False
572 _ -> False
646− p_arg = \case
647− Present NoExtField x -> located x p_hsExpr
648− Missing NoExtField -> pure ()
649− XTupArg x -> noExtCon x
650− p_larg = sitcc . located' p_arg
651− parens' =
573+ let parens' =
652 case boxity of
574 case boxity of
653 Boxed -> parens
575 Boxed -> parens
654 Unboxed -> parensHash
576 Unboxed -> parensHash
655− in if isSection
577+ if isSection
656− then
657− switchLayout [] . parens' s $
578+ then switchLayout [] . parens' s $
658− sep comma p_larg args
579+ sep comma (located' p_hsTupArg) args
659− else
660− switchLayout (getLoc <$> args) . parens' s $
580+ else switchLayout (getLoc <$> args) . parens' s . sitcc $
661− sep commaDel p_larg args
581+ sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
662− ExplicitSum NoExtField tag arity e ->
582+ ExplicitSum NoExt tag arity e ->
663 p_unboxedSum N tag arity (located e p_hsExpr)
583 p_unboxedSum N tag arity (located e p_hsExpr)
664− HsCase NoExtField e mgroup ->
584+ HsCase NoExt e mgroup -> do
665− p_case exprPlacement p_hsExpr e mgroup
585+ txt "case"
586+ space
587+ located e p_hsExpr
588+ space
589+ txt "of"
590+ breakpoint
591+ inci (p_matchGroup Case mgroup)
666− HsIf NoExtField _ if' then' else' ->
592+ HsIf NoExt _ if' then' else' -> do
667− p_if exprPlacement p_hsExpr if' then' else'
668− HsMultiIf NoExtField guards -> do
669 txt "if"
593 txt "if"
594+ space
595+ located if' p_hsExpr
670 breakpoint
596 breakpoint
597+ inci $ do
598+ txt "then"
599+ located then' $ \x ->
600+ placeHanging (exprPlacement x) (p_hsExpr x)
601+ breakpoint
602+ txt "else"
603+ located else' $ \x ->
604+ placeHanging (exprPlacement x) (p_hsExpr x)
605+ HsMultiIf NoExt guards -> do
606+ txt "if"
607+ breakpoint
671− inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
608+ inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
672− HsLet NoExtField localBinds e ->
609+ HsLet NoExt localBinds e -> sitcc $ do
673− p_let p_hsExpr localBinds e
610+ txt "let"
611+ space
612+ dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
613+ vlayout space (newline >> txt " ")
614+ txt "in"
615+ space
616+ sitcc (located e p_hsExpr)
674− HsDo NoExtField ctx es -> do
617+ HsDo NoExt ctx es -> do
675 let doBody header = do
618 let doBody header = do
676 txt header
619 txt header
677 breakpoint
620 breakpoint
678 ub <- layoutToBraces <$> getLayout
621 ub <- layoutToBraces <$> getLayout
679− inci $
680− sepSemi
681− (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
622+ inci $ sepSemi (located' (ub . p_stmt' (p_hsExpr' S))) (unLoc es)
682− (unLoc es)
683− compBody = brackets N . located es $ \xs -> do
623+ compBody = brackets N $ located es $ \xs -> do
684− let p_parBody =
624+ let p_parBody = sep
685− sep
686− (breakpoint >> txt "|" >> space)
625+ (breakpoint >> txt "| ")
687− p_seqBody
626+ p_seqBody
688− p_seqBody =
627+ p_seqBody = sitcc . sep
689− sitcc
628+ (comma >> breakpoint)
690− . sep
691− commaDel
692− (located' (sitcc . p_stmt))
629+ (located' (sitcc . p_stmt))
693 stmts = init xs
630 stmts = init xs
694 yield = last xs
631 yield = last xs
695 lists = foldr (liftAppend . gatherStmt) [] stmts
632 lists = foldr (liftAppend . gatherStmt) [] stmts
@@ -703,100 +640,92 @@ p_hsExpr' s = \case
703 MDoExpr -> doBody "mdo"
640 MDoExpr -> doBody "mdo"
704 ListComp -> compBody
641 ListComp -> compBody
705 MonadComp -> notImplemented "MonadComp"
642 MonadComp -> notImplemented "MonadComp"
706− ArrowExpr -> notImplemented "ArrowExpr"
643+ ArrowExpr -> notImplemented "ArrowExpr"
707 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
644 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
708 PatGuard _ -> notImplemented "PatGuard"
645 PatGuard _ -> notImplemented "PatGuard"
709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
646 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
647 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
711 ExplicitList _ _ xs ->
648 ExplicitList _ _ xs ->
712− brackets s $
649+ brackets s . sitcc $
713− sep commaDel (sitcc . located' p_hsExpr) xs
650+ sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
714 RecordCon {..} -> do
651 RecordCon {..} -> do
715 located rcon_con_name atom
652 located rcon_con_name atom
716 breakpoint
653 breakpoint
717 let HsRecFields {..} = rcon_flds
654 let HsRecFields {..} = rcon_flds
718− updName f =
655+ updName f = f {
719− (f :: HsRecField GhcPs (LHsExpr GhcPs))
720− { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
656+ hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
721− FieldOcc _ n -> n
657+ FieldOcc _ n -> n
722− XFieldOcc x -> noExtCon x
658+ XFieldOcc _ -> notImplemented "XFieldOcc"
723− }
659+ }
724 fields = located' (p_hsRecField . updName) <$> rec_flds
660 fields = located' (p_hsRecField . updName) <$> rec_flds
725 dotdot =
661 dotdot =
726 case rec_dotdot of
662 case rec_dotdot of
727 Just {} -> [txt ".."]
663 Just {} -> [txt ".."]
728 Nothing -> []
664 Nothing -> []
729− inci . braces N $
665+ inci . braces N . sitcc $
730− sep commaDel sitcc (fields <> dotdot)
666+ sep (comma >> breakpoint) sitcc (fields <> dotdot)
731 RecordUpd {..} -> do
667 RecordUpd {..} -> do
732 located rupd_expr p_hsExpr
668 located rupd_expr p_hsExpr
733− useRecordDot' <- useRecordDot
734− let mrs sp = case getLoc sp of
735− RealSrcSpan r -> Just r
736− _ -> Nothing
737− let isPluginForm =
738− ((1 +) . srcSpanEndCol <$> mrs rupd_expr)
739− == (srcSpanStartCol <$> mrs (head rupd_flds))
740− unless (useRecordDot' && isPluginForm) breakpoint
669+ breakpoint
741− let updName f =
670+ let updName f = f {
742− (f :: HsRecUpdField GhcPs)
743− { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
671+ hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
744− Ambiguous _ n -> n
672+ Ambiguous _ n -> n
745− Unambiguous _ n -> n
673+ Unambiguous _ n -> n
746− XAmbiguousFieldOcc x -> noExtCon x
674+ XAmbiguousFieldOcc _ -> notImplemented "XAmbiguousFieldOcc"
747− }
675+ }
748− inci . braces N $
676+ inci . braces N . sitcc $
749 sep
677 sep
750− commaDel
678+ (comma >> breakpoint)
751 (sitcc . located' (p_hsRecField . updName))
679 (sitcc . located' (p_hsRecField . updName))
752 rupd_flds
680 rupd_flds
753− ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
681+ ExprWithTySig affix x -> sitcc $ do
754 located x p_hsExpr
682 located x p_hsExpr
755 space
683 space
756 txt "::"
684 txt "::"
757 breakpoint
685 breakpoint
686+ inci $ do
687+ let HsWC {..} = affix
688+ HsIB {..} = hswc_body
758− inci $ located hsib_body p_hsType
689+ located hsib_body p_hsType
759− ExprWithTySig NoExtField _ HsWC {hswc_body = XHsImplicitBndrs x} -> noExtCon x
760− ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
761− ArithSeq NoExtField _ x ->
690+ ArithSeq NoExt _ x -> do
762 case x of
691 case x of
763− From from -> brackets s $ do
692+ From from -> brackets s . sitcc $ do
764 located from p_hsExpr
693 located from p_hsExpr
765 breakpoint
694 breakpoint
766 txt ".."
695 txt ".."
767− FromThen from next -> brackets s $ do
696+ FromThen from next -> brackets s . sitcc $ do
768− sep commaDel (located' p_hsExpr) [from, next]
697+ sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
769 breakpoint
698 breakpoint
770 txt ".."
699 txt ".."
771− FromTo from to -> brackets s $ do
700+ FromTo from to -> brackets s . sitcc $ do
772 located from p_hsExpr
701 located from p_hsExpr
773 breakpoint
702 breakpoint
774 txt ".."
703 txt ".."
775 space
704 space
776 located to p_hsExpr
705 located to p_hsExpr
777− FromThenTo from next to -> brackets s $ do
706+ FromThenTo from next to -> brackets s . sitcc $ do
778− sep commaDel (located' p_hsExpr) [from, next]
707+ sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
779 breakpoint
708 breakpoint
780 txt ".."
709 txt ".."
781 space
710 space
782 located to p_hsExpr
711 located to p_hsExpr
783− HsSCC NoExtField _ name x -> do
712+ HsSCC NoExt _ name x -> do
784 txt "{-# SCC "
713 txt "{-# SCC "
785 atom name
714 atom name
786 txt " #-}"
715 txt " #-}"
787 breakpoint
716 breakpoint
788 located x p_hsExpr
717 located x p_hsExpr
789− HsCoreAnn NoExtField _ value x -> do
718+ HsCoreAnn NoExt _ value x -> do
790 txt "{-# CORE "
719 txt "{-# CORE "
791 atom value
720 atom value
792 txt " #-}"
721 txt " #-}"
793 breakpoint
722 breakpoint
794 located x p_hsExpr
723 located x p_hsExpr
795− HsBracket NoExtField x -> p_hsBracket x
724+ HsBracket NoExt x -> p_hsBracket x
796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
725 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
726 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
798− HsSpliceE NoExtField splice -> p_hsSplice splice
727+ HsSpliceE NoExt splice -> p_hsSplice splice
799− HsProc NoExtField p e -> do
728+ HsProc NoExt p e -> do
800 txt "proc"
729 txt "proc"
801 located p $ \x -> do
730 located p $ \x -> do
802 breakpoint
731 breakpoint
@@ -805,15 +734,35 @@ p_hsExpr' s = \case
805 txt "->"
734 txt "->"
806 placeHanging (cmdTopPlacement (unLoc e)) $
735 placeHanging (cmdTopPlacement (unLoc e)) $
807 located e p_hsCmdTop
736 located e p_hsCmdTop
808− HsStatic _ e -> do
737+ HsStatic _ e -> do
809 txt "static"
738 txt "static"
810 breakpoint
739 breakpoint
811 inci (located e p_hsExpr)
740 inci (located e p_hsExpr)
741+ HsArrApp NoExt body input arrType cond ->
742+ p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
743+ HsArrForm NoExt form mfixity cmds ->
744+ p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
812 HsTick {} -> notImplemented "HsTick"
745 HsTick {} -> notImplemented "HsTick"
813 HsBinTick {} -> notImplemented "HsBinTick"
746 HsBinTick {} -> notImplemented "HsBinTick"
814 HsTickPragma {} -> notImplemented "HsTickPragma"
747 HsTickPragma {} -> notImplemented "HsTickPragma"
748+ -- These four constructs should never appear in correct programs.
749+ -- See: https://github.com/tweag/ormolu/issues/343
750+ EWildPat NoExt -> txt "_"
751+ EAsPat NoExt n p -> do
752+ p_rdrName n
753+ txt "@"
754+ located p p_hsExpr
755+ EViewPat NoExt p e -> do
756+ located p p_hsExpr
757+ space
758+ txt "->"
759+ breakpoint
760+ inci (located e p_hsExpr)
761+ ELazyPat NoExt p -> do
762+ txt "~"
763+ located p p_hsExpr
815 HsWrap {} -> notImplemented "HsWrap"
764 HsWrap {} -> notImplemented "HsWrap"
816− XExpr x -> noExtCon x
765+ XExpr {} -> notImplemented "XExpr"
817
766
818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
767p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
819p_patSynBind PSB {..} = do
768p_patSynBind PSB {..} = do
@@ -824,8 +773,8 @@ p_patSynBind PSB {..} = do
824 txt "<-"
773 txt "<-"
825 breakpoint
774 breakpoint
826 located psb_def p_pat
775 located psb_def p_pat
827− ImplicitBidirectional -> do
776+ ImplicitBidirectional -> do
828− equals
777+ txt "="
829 breakpoint
778 breakpoint
830 located psb_def p_pat
779 located psb_def p_pat
831 ExplicitBidirectional mgroup -> do
780 ExplicitBidirectional mgroup -> do
@@ -841,7 +790,7 @@ p_patSynBind PSB {..} = do
841 PrefixCon xs -> do
790 PrefixCon xs -> do
842 space
791 space
843 p_rdrName psb_id
792 p_rdrName psb_id
844− inci $ do
793+ inci $ do
845 switchLayout (getLoc <$> xs) $ do
794 switchLayout (getLoc <$> xs) $ do
846 unless (null xs) breakpoint
795 unless (null xs) breakpoint
847 sitcc (sep breakpoint p_rdrName xs)
796 sitcc (sep breakpoint p_rdrName xs)
@@ -852,8 +801,8 @@ p_patSynBind PSB {..} = do
852 inci $ do
801 inci $ do
853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
802 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
854 unless (null xs) breakpoint
803 unless (null xs) breakpoint
855− braces N $
804+ braces N . sitcc $
856− sep commaDel (p_rdrName . recordPatSynPatVar) xs
805+ sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
857 rhs
806 rhs
858 InfixCon l r -> do
807 InfixCon l r -> do
859 switchLayout [getLoc l, getLoc r] $ do
808 switchLayout [getLoc l, getLoc r] $ do
@@ -865,98 +814,33 @@ p_patSynBind PSB {..} = do
865 space
814 space
866 p_rdrName r
815 p_rdrName r
867 inci rhs
816 inci rhs
868−p_patSynBind (XPatSynBind x) = noExtCon x
817+p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
869−
870−p_case ::
871− Data body =>
872− -- | Placer
873− (body -> Placement) ->
874− -- | Render
875− (body -> R ()) ->
876− -- | Expression
877− LHsExpr GhcPs ->
878− -- | Match group
879− MatchGroup GhcPs (Located body) ->
880− R ()
881−p_case placer render e mgroup = do
882− txt "case"
883− space
884− located e p_hsExpr
885− space
886− txt "of"
887− breakpoint
888− inci (p_matchGroup' placer render Case mgroup)
889−
890−p_if ::
891− Data body =>
892− -- | Placer
893− (body -> Placement) ->
894− -- | Render
895− (body -> R ()) ->
896− -- | If
897− LHsExpr GhcPs ->
898− -- | Then
899− Located body ->
900− -- | Else
901− Located body ->
902− R ()
903−p_if placer render if' then' else' = do
904− txt "if"
905− space
906− located if' p_hsExpr
907− breakpoint
908− inci $ do
909− txt "then"
910− space
911− located then' $ \x ->
912− placeHanging (placer x) (render x)
913− breakpoint
914− txt "else"
915− space
916− located else' $ \x ->
917− placeHanging (placer x) (render x)
918−
919−p_let ::
920− Data body =>
921− -- | Render
922− (body -> R ()) ->
923− Located (HsLocalBindsLR GhcPs GhcPs) ->
924− Located body ->
925− R ()
926−p_let render localBinds e = sitcc $ do
927− txt "let"
928− space
929− dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
930− vlayout space (newline >> txt " ")
931− txt "in"
932− space
933− sitcc (located e render)
934
818
935p_pat :: Pat GhcPs -> R ()
819p_pat :: Pat GhcPs -> R ()
936p_pat = \case
820p_pat = \case
937− WildPat NoExtField -> txt "_"
821+ WildPat NoExt -> txt "_"
938− VarPat NoExtField name -> p_rdrName name
822+ VarPat NoExt name -> p_rdrName name
939− LazyPat NoExtField pat -> do
823+ LazyPat NoExt pat -> do
940 txt "~"
824 txt "~"
941 located pat p_pat
825 located pat p_pat
942− AsPat NoExtField name pat -> do
826+ AsPat NoExt name pat -> do
943 p_rdrName name
827 p_rdrName name
944 txt "@"
828 txt "@"
945 located pat p_pat
829 located pat p_pat
946− ParPat NoExtField pat ->
830+ ParPat NoExt pat ->
947 located pat (parens S . p_pat)
831 located pat (parens S . p_pat)
948− BangPat NoExtField pat -> do
832+ BangPat NoExt pat -> do
949 txt "!"
833 txt "!"
950 located pat p_pat
834 located pat p_pat
951− ListPat NoExtField pats ->
835+ ListPat NoExt pats -> do
952− brackets S $ sep commaDel (located' p_pat) pats
836+ brackets S . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
953− TuplePat NoExtField pats boxing -> do
837+ TuplePat NoExt pats boxing -> do
954− let parens' =
838+ let f =
955 case boxing of
839 case boxing of
956 Boxed -> parens S
840 Boxed -> parens S
957 Unboxed -> parensHash S
841 Unboxed -> parensHash S
958− parens' $ sep commaDel (sitcc . located' p_pat) pats
842+ f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
959− SumPat NoExtField pat tag arity ->
843+ SumPat NoExt pat tag arity ->
960 p_unboxedSum S tag arity (located pat p_pat)
844 p_unboxedSum S tag arity (located pat p_pat)
961 ConPatIn pat details ->
845 ConPatIn pat details ->
962 case details of
846 case details of
@@ -971,40 +855,38 @@ p_pat = \case
971 let f = \case
855 let f = \case
972 Nothing -> txt ".."
856 Nothing -> txt ".."
973 Just x -> located x p_pat_hsRecField
857 Just x -> located x p_pat_hsRecField
974− inci . braces N . sep commaDel f $
858+ inci . braces N . sitcc . sep (comma >> breakpoint) f $
975 case dotdot of
859 case dotdot of
976 Nothing -> Just <$> fields
860 Nothing -> Just <$> fields
977− Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
861+ Just n -> (Just <$> take n fields) ++ [Nothing]
978− InfixCon l r -> do
862+ InfixCon x y -> do
979− switchLayout [getLoc l, getLoc r] $ do
863+ located x p_pat
980− located l p_pat
864+ space
865+ p_rdrName pat
981− breakpoint
866+ breakpoint
982− inci $ do
983− p_rdrName pat
984− space
985− located r p_pat
867+ inci (located y p_pat)
986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
868 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
987− ViewPat NoExtField expr pat -> sitcc $ do
869+ ViewPat NoExt expr pat -> sitcc $ do
988 located expr p_hsExpr
870 located expr p_hsExpr
989 space
871 space
990 txt "->"
872 txt "->"
991 breakpoint
873 breakpoint
992 inci (located pat p_pat)
874 inci (located pat p_pat)
993− SplicePat NoExtField splice -> p_hsSplice splice
875+ SplicePat NoExt splice -> p_hsSplice splice
994− LitPat NoExtField p -> atom p
876+ LitPat NoExt p -> atom p
995− NPat NoExtField v _ _ -> located v (atom . ol_val)
877+ NPat NoExt v _ _ -> located v (atom . ol_val)
996− NPlusKPat NoExtField n k _ _ _ -> sitcc $ do
878+ NPlusKPat NoExt n k _ _ _ -> sitcc $ do
997 p_rdrName n
879 p_rdrName n
998 breakpoint
880 breakpoint
999 inci $ do
881 inci $ do
1000 txt "+"
882 txt "+"
1001 space
883 space
1002 located k (atom . ol_val)
884 located k (atom . ol_val)
1003− SigPat NoExtField pat hswc -> do
885+ SigPat hswc pat -> do
1004 located pat p_pat
886 located pat p_pat
1005 p_typeAscription hswc
887 p_typeAscription hswc
1006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
888 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1007− XPat x -> noExtCon x
889+ XPat NoExt -> notImplemented "XPat"
1008
890
1009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
891p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
1010p_pat_hsRecField HsRecField {..} = do
892p_pat_hsRecField HsRecField {..} = do
@@ -1012,7 +894,7 @@ p_pat_hsRecField HsRecField {..} = do
1012 p_rdrName (rdrNameFieldOcc x)
894 p_rdrName (rdrNameFieldOcc x)
1013 unless hsRecPun $ do
895 unless hsRecPun $ do
1014 space
896 space
1015− equals
897+ txt "="
1016 breakpoint
898 breakpoint
1017 inci (located hsRecFieldArg p_pat)
899 inci (located hsRecFieldArg p_pat)
1018
900
@@ -1021,40 +903,38 @@ p_unboxedSum s tag arity m = do
1021 let before = tag - 1
903 let before = tag - 1
1022 after = arity - before - 1
904 after = arity - before - 1
1023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
905 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1024− f x =
906+ f (x,i) = do
907+ let isFirst = i == 0
908+ isLast = i == arity - 1
1025 case x :: Maybe (R ()) of
909 case x :: Maybe (R ()) of
1026 Nothing ->
910 Nothing ->
1027− space
911+ unless (isFirst || isLast) space
1028 Just m' -> do
912 Just m' -> do
1029− space
913+ unless isFirst space
1030 m'
914 m'
1031− space
915+ unless isLast space
1032− parensHash s $ sep (txt "|") f args
916+ parensHash s $ sep (txt "|") f (zip args [0..])
1033
917
1034p_hsSplice :: HsSplice GhcPs -> R ()
918p_hsSplice :: HsSplice GhcPs -> R ()
1035p_hsSplice = \case
919p_hsSplice = \case
1036− HsTypedSplice NoExtField deco _ expr -> p_hsSpliceTH True expr deco
920+ HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
1037− HsUntypedSplice NoExtField deco _ expr -> p_hsSpliceTH False expr deco
921+ HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
1038− HsQuasiQuote NoExtField _ quoterName srcSpan str -> do
922+ HsQuasiQuote NoExt _ quoterName srcSpan str -> do
1039 txt "["
923 txt "["
1040 p_rdrName (L srcSpan quoterName)
924 p_rdrName (L srcSpan quoterName)
1041 txt "|"
925 txt "|"
1042− -- QuasiQuoters often rely on precise custom strings. We cannot do any
926+ -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
1043− -- formatting here without potentially breaking someone's code.
927+ -- any formatting here without potentially breaking someone's code.
1044 atom str
928 atom str
1045 txt "|]"
929 txt "|]"
1046 HsSpliced {} -> notImplemented "HsSpliced"
930 HsSpliced {} -> notImplemented "HsSpliced"
1047− HsSplicedT {} -> notImplemented "HsSplicedT"
931+ XSplice {} -> notImplemented "XSplice"
1048− XSplice x -> noExtCon x
932+
1049−
1050−p_hsSpliceTH ::
933+p_hsSpliceTH
1051− -- | Typed splice?
934+ :: Bool -- ^ Typed splice?
1052− Bool ->
1053− -- | Splice expression
1054− LHsExpr GhcPs ->
935+ -> LHsExpr GhcPs -- ^ Splice expression
1055− -- | Splice decoration
1056− SpliceDecoration ->
936+ -> SpliceDecoration -- ^ Splice decoration
1057− R ()
937+ -> R ()
1058p_hsSpliceTH isTyped expr = \case
938p_hsSpliceTH isTyped expr = \case
1059 HasParens -> do
939 HasParens -> do
1060 txt decoSymbol
940 txt decoSymbol
@@ -1069,17 +949,17 @@ p_hsSpliceTH isTyped expr = \case
1069
949
1070p_hsBracket :: HsBracket GhcPs -> R ()
950p_hsBracket :: HsBracket GhcPs -> R ()
1071p_hsBracket = \case
951p_hsBracket = \case
1072− ExpBr NoExtField expr -> do
952+ ExpBr NoExt expr -> do
1073 anns <- getEnclosingAnns
953 anns <- getEnclosingAnns
1074 let name = case anns of
954 let name = case anns of
1075− AnnOpenEQ : _ -> ""
955+ AnnOpenEQ:_ -> ""
1076 _ -> "e"
956 _ -> "e"
1077 quote name (located expr p_hsExpr)
957 quote name (located expr p_hsExpr)
1078− PatBr NoExtField pat -> located pat (quote "p" . p_pat)
958+ PatBr NoExt pat -> quote "p" (located pat p_pat)
1079− DecBrL NoExtField decls -> quote "d" (p_hsDecls Free decls)
959+ DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
1080− DecBrG NoExtField _ -> notImplemented "DecBrG" -- result of renamer
960+ DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
1081− TypBr NoExtField ty -> quote "t" (located ty p_hsType)
961+ TypBr NoExt ty -> quote "t" (located ty p_hsType)
1082− VarBr NoExtField isSingleQuote name -> do
962+ VarBr NoExt isSingleQuote name -> do
1083 txt (bool "''" "'" isSingleQuote)
963 txt (bool "''" "'" isSingleQuote)
1084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
964 -- HACK As you can see we use 'noLoc' here to be able to pass name into
1085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
965 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -1087,20 +967,19 @@ p_hsBracket = \case
1087 -- turn makes it impossible to detect if there are parentheses around
967 -- turn makes it impossible to detect if there are parentheses around
1088 -- it, etc. So we have to add parentheses manually assuming they are
968 -- it, etc. So we have to add parentheses manually assuming they are
1089 -- necessary for all operators.
969 -- necessary for all operators.
1090− let isOperator =
970+ let isOperator = all
1091− all
1092− (\i -> isPunctuation i || isSymbol i)
971+ (\i -> isPunctuation i || isSymbol i)
1093− (showOutputable (rdrNameOcc name))
972+ (showOutputable (rdrNameOcc name))
1094− && not (doesNotNeedExtraParens name)
973+ && not (doesNotNeedExtraParens name)
1095 wrapper = if isOperator then parens N else id
974 wrapper = if isOperator then parens N else id
1096 wrapper $ p_rdrName (noLoc name)
975 wrapper $ p_rdrName (noLoc name)
1097− TExpBr NoExtField expr -> do
976+ TExpBr NoExt expr -> do
1098 txt "[||"
977 txt "[||"
1099 breakpoint'
978 breakpoint'
1100 located expr p_hsExpr
979 located expr p_hsExpr
1101 breakpoint'
980 breakpoint'
1102 txt "||]"
981 txt "||]"
1103− XBracket x -> noExtCon x
982+ XBracket {} -> notImplemented "XBracket"
1104 where
983 where
1105 quote :: Text -> R () -> R ()
984 quote :: Text -> R () -> R ()
1106 quote name body = do
985 quote name body = do
@@ -1124,47 +1003,50 @@ p_stringLit src =
1124 multiLine =
1003 multiLine =
1125 sitcc $ sep breakpoint (txt . Text.pack) (backslashes s)
1004 sitcc $ sep breakpoint (txt . Text.pack) (backslashes s)
1126 in vlayout singleLine multiLine
1005 in vlayout singleLine multiLine
1127− where
1006+ where
1128− -- Split a string on gaps (backslash delimited whitespaces)
1007+ -- Split a string on gaps (backslash delimited whitespaces)
1129− --
1008+ --
1130− -- > splitGaps "bar\\ \\fo\\&o" == ["bar", "fo\\&o"]
1009+ -- > splitGaps "bar\\ \\fo\\&o" == ["bar", "fo\\&o"]
1131− splitGaps :: String -> [String]
1010+ splitGaps :: String -> [String]
1132− splitGaps "" = []
1011+ splitGaps "" = []
1133− splitGaps s =
1012+ splitGaps s =
1134− let -- A backslash and a whitespace starts a "gap"
1013+ let -- A backslash and a whitespace starts a "gap"
1135− p (Just '\\', _, _) = True
1014+ p (Just '\\', _, _) = True
1136− p (_, '\\', Just c) | ghcSpace c = False
1015+ p (_, '\\', Just c) | ghcSpace c = False
1137− p _ = True
1016+ p _ = True
1138− in case span p (zipPrevNext s) of
1017+ in case span p (zipPrevNext s) of
1139− (l, r) ->
1018+ (l, r) ->
1140− let -- drop the initial '\', any amount of 'ghcSpace', and another '\'
1019+ let -- drop the initial '\', any amount of 'ghcSpace', and another '\'
1141 r' = drop 1 . dropWhile ghcSpace . drop 1 $ map orig r
1020 r' = drop 1 . dropWhile ghcSpace . drop 1 $ map orig r
1142− in map orig l : splitGaps r'
1021+ in map orig l : splitGaps r'
1022+
1143− -- GHC's definition of whitespaces in strings
1023+ -- GHC's definition of whitespaces in strings
1144− -- See: https://gitlab.haskell.org/ghc/ghc/blob/86753475/compiler/parser/Lexer.x#L1653
1024+ -- See: https://gitlab.haskell.org/ghc/ghc/blob/86753475/compiler/parser/Lexer.x#L1653
1145− ghcSpace :: Char -> Bool
1025+ ghcSpace :: Char -> Bool
1146− ghcSpace c = c <= '\x7f' && is_space c
1026+ ghcSpace c = c <= '\x7f' && is_space c
1027+
1147− -- Add backslashes to the inner side of the strings
1028+ -- Add backslashes to the inner side of the strings
1148− --
1029+ --
1149− -- > backslashes ["a", "b", "c"] == ["a\\", "\\b\\", "\\c"]
1030+ -- > backslashes ["a", "b", "c"] == ["a\\", "\\b\\", "\\c"]
1150− backslashes :: [String] -> [String]
1031+ backslashes :: [String] -> [String]
1151− backslashes (x : y : xs) = (x ++ "\\") : backslashes (('\\' : y) : xs)
1032+ backslashes (x:y:xs) = (x ++ "\\") : backslashes (('\\' : y) : xs)
1152− backslashes xs = xs
1033+ backslashes xs = xs
1034+
1153− -- Attaches previous and next items to each list element
1035+ -- Attaches previous and next items to each list element
1154− zipPrevNext :: [a] -> [(Maybe a, a, Maybe a)]
1036+ zipPrevNext :: [a] -> [(Maybe a, a, Maybe a)]
1155− zipPrevNext xs =
1037+ zipPrevNext xs =
1156− let z =
1157− zip
1158− (zip (Nothing : map Just xs) xs)
1038+ let z = zip (zip (Nothing : map Just xs) xs)
1159− (map Just (tail xs) ++ repeat Nothing)
1039+ (map Just (tail xs) ++ repeat Nothing)
1160− in map (\((p, x), n) -> (p, x, n)) z
1040+ in map (\((p, x), n) -> (p, x, n)) z
1041+
1161− orig (_, x, _) = x
1042+ orig (_, x, _) = x
1162
1043
1163----------------------------------------------------------------------------
1044----------------------------------------------------------------------------
1164-- Helpers
1045-- Helpers
1165
1046
1166-- | Return the wrapping function controlling the use of braces according to
1047-- | Return the wrapping function controlling the use of braces according to
1167-- the current layout.
1048-- the current layout.
1049+
1168layoutToBraces :: Layout -> R () -> R ()
1050layoutToBraces :: Layout -> R () -> R ()
1169layoutToBraces = \case
1051layoutToBraces = \case
1170 SingleLine -> useBraces
1052 SingleLine -> useBraces
@@ -1172,6 +1054,7 @@ layoutToBraces = \case
1172
1054
1173-- | Append each element in both lists with semigroups. If one list is shorter
1055-- | Append each element in both lists with semigroups. If one list is shorter
1174-- than the other, return the rest of the longer list unchanged.
1056-- than the other, return the rest of the longer list unchanged.
1057+
1175liftAppend :: Semigroup a => [a] -> [a] -> [a]
1058liftAppend :: Semigroup a => [a] -> [a] -> [a]
1176liftAppend [] [] = []
1059liftAppend [] [] = []
1177liftAppend [] (y : ys) = y : ys
1060liftAppend [] (y : ys) = y : ys
@@ -1179,13 +1062,14 @@ liftAppend (x : xs) [] = x : xs
1179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
1062liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
1180
1063
1181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1064getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1182−getGRHSSpan (GRHS NoExtField guards body) =
1065+getGRHSSpan (GRHS NoExt guards body) =
1183 combineSrcSpans' $ getLoc body :| map getLoc guards
1066 combineSrcSpans' $ getLoc body :| map getLoc guards
1184−getGRHSSpan (XGRHS x) = noExtCon x
1067+getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1185
1068
1186-- | Place a thing that may have a hanging form. This function handles how
1069-- | Place a thing that may have a hanging form. This function handles how
1187-- to separate it from preceding expressions and whether to bump indentation
1070-- to separate it from preceding expressions and whether to bump indentation
1188-- depending on what sort of expression we have.
1071-- depending on what sort of expression we have.
1072+
1189placeHanging :: Placement -> R () -> R ()
1073placeHanging :: Placement -> R () -> R ()
1190placeHanging placement m =
1074placeHanging placement m =
1191 case placement of
1075 case placement of
@@ -1198,92 +1082,92 @@ placeHanging placement m =
1198
1082
1199-- | Check if given block contains single expression which has a hanging
1083-- | Check if given block contains single expression which has a hanging
1200-- form.
1084-- form.
1085+
1201−blockPlacement ::
1086+blockPlacement
1202− (body -> Placement) ->
1087+ :: (body -> Placement)
1203− [LGRHS GhcPs (Located body)] ->
1088+ -> [LGRHS GhcPs (Located body)]
1204− Placement
1089+ -> Placement
1205−blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
1090+blockPlacement placer [(L _ (GRHS NoExt _ (L _ x)))] = placer x
1206blockPlacement _ _ = Normal
1091blockPlacement _ _ = Normal
1207
1092
1208-- | Check if given command has a hanging form.
1093-- | Check if given command has a hanging form.
1094+
1209cmdPlacement :: HsCmd GhcPs -> Placement
1095cmdPlacement :: HsCmd GhcPs -> Placement
1210cmdPlacement = \case
1096cmdPlacement = \case
1211− HsCmdLam NoExtField _ -> Hanging
1097+ HsCmdLam NoExt _ -> Hanging
1212− HsCmdCase NoExtField _ _ -> Hanging
1098+ HsCmdCase NoExt _ _ -> Hanging
1213− HsCmdDo NoExtField _ -> Hanging
1099+ HsCmdDo NoExt _ -> Hanging
1214 _ -> Normal
1100 _ -> Normal
1215
1101
1216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
1102cmdTopPlacement :: HsCmdTop GhcPs -> Placement
1217cmdTopPlacement = \case
1103cmdTopPlacement = \case
1218− HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1104+ HsCmdTop NoExt (L _ x) -> cmdPlacement x
1219− XCmdTop x -> noExtCon x
1105+ XCmdTop {} -> notImplemented "XCmdTop"
1220
1106
1221-- | Check if given expression has a hanging form.
1107-- | Check if given expression has a hanging form.
1108+
1222exprPlacement :: HsExpr GhcPs -> Placement
1109exprPlacement :: HsExpr GhcPs -> Placement
1223exprPlacement = \case
1110exprPlacement = \case
1224 -- Only hang lambdas with single line parameter lists
1111 -- Only hang lambdas with single line parameter lists
1225− HsLam NoExtField mg -> case mg of
1112+ HsLam NoExt mg -> case mg of
1226− MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
1113+ MG _ (L _ [L _ (Match NoExt _ (x:xs) _)]) _
1227− | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
1114+ | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs))
1228− Hanging
1115+ -> Hanging
1229 _ -> Normal
1116 _ -> Normal
1230− HsLamCase NoExtField _ -> Hanging
1117+ HsLamCase NoExt _ -> Hanging
1231− HsCase NoExtField _ _ -> Hanging
1118+ HsCase NoExt _ _ -> Hanging
1232− HsDo NoExtField DoExpr _ -> Hanging
1119+ HsDo NoExt DoExpr _ -> Hanging
1233− HsDo NoExtField MDoExpr _ -> Hanging
1120+ HsDo NoExt MDoExpr _ -> Hanging
1234− OpApp NoExtField _ op y ->
1121+ RecordCon NoExt _ _ -> Hanging
1235− case (fmap getOpNameStr . getOpName . unLoc) op of
1122+ -- If the rightmost expression in an operator chain is hanging, make the
1236− Just "$" -> exprPlacement (unLoc y)
1123+ -- whole block hanging; so that we can use the common @f = foo $ do@
1237− _ -> Normal
1124+ -- style.
1125+ OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1126+ -- Same thing for function applications (usually with -XBlockArguments)
1238− HsApp NoExtField _ y -> exprPlacement (unLoc y)
1127+ HsApp NoExt _ y -> exprPlacement (unLoc y)
1239− HsProc NoExtField p _ ->
1128+ HsProc NoExt (L s _) _ ->
1240 -- Indentation breaks if pattern is longer than one line and left
1129 -- Indentation breaks if pattern is longer than one line and left
1241 -- hanging. Consequently, only apply hanging when it is safe.
1130 -- hanging. Consequently, only apply hanging when it is safe.
1242− if isOneLineSpan (getLoc p)
1131+ if isOneLineSpan s
1243− then Hanging
1132+ then Hanging
1244− else Normal
1133+ else Normal
1245 _ -> Normal
1134 _ -> Normal
1246
1135
1247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
1136withGuards :: [LGRHS GhcPs (Located body)] -> Bool
1248withGuards = any (checkOne . unLoc)
1137withGuards = any (checkOne . unLoc)
1249 where
1138 where
1250 checkOne :: GRHS GhcPs (Located body) -> Bool
1139 checkOne :: GRHS GhcPs (Located body) -> Bool
1251− checkOne (GRHS NoExtField [] _) = False
1140+ checkOne (GRHS NoExt [] _) = False
1252 checkOne _ = True
1141 checkOne _ = True
1253
1142
1254exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1143exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1255−exprOpTree (L _ (OpApp NoExtField x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
1144+exprOpTree (L _ (OpApp NoExt x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
1256exprOpTree n = OpNode n
1145exprOpTree n = OpNode n
1257
1146
1258getOpName :: HsExpr GhcPs -> Maybe RdrName
1147getOpName :: HsExpr GhcPs -> Maybe RdrName
1259getOpName = \case
1148getOpName = \case
1260− HsVar NoExtField (L _ a) -> Just a
1149+ HsVar NoExt (L _ a) -> Just a
1261 _ -> Nothing
1150 _ -> Nothing
1262
1151
1263−getOpNameStr :: RdrName -> String
1152+p_exprOpTree
1264−getOpNameStr = occNameString . rdrNameOcc
1153+ :: Bool -- ^ Can use special handling of dollar?
1265−
1266−p_exprOpTree ::
1267− -- | Bracket style to use
1154+ -> BracketStyle -- ^ Bracket style to use
1268− BracketStyle ->
1269− OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
1155+ -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1270− R ()
1156+ -> R ()
1271−p_exprOpTree s (OpNode x) = located x (p_hsExpr' s)
1157+p_exprOpTree _ s (OpNode x) = located x (p_hsExpr' s)
1272−p_exprOpTree s (OpBranch x op y) = do
1158+p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1273− -- If the beginning of the first argument and the second argument are on
1159+ -- NOTE If the beginning of the first argument and the second argument
1274− -- the same line, and the second argument has a hanging form, use hanging
1160+ -- are on the same line, and the second argument has a hanging form, use
1275− -- placement.
1161+ -- hanging placement.
1276 let placement =
1162 let placement =
1277 if isOneLineSpan
1163 if isOneLineSpan
1278− (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1164+ (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1279 then case y of
1165 then case y of
1280− OpNode (L _ n) -> exprPlacement n
1166+ OpNode (L _ n) -> exprPlacement n
1281− _ -> Normal
1167+ _ -> Normal
1282 else Normal
1168 else Normal
1283− -- Distinguish holes used in infix notation.
1284− -- eg. '1 _foo 2' and '1 `_foo` 2'
1285 opWrapper = case unLoc op of
1169 opWrapper = case unLoc op of
1286− HsUnboundVar NoExtField _ -> backticks
1170+ EWildPat NoExt -> backticks
1287 _ -> id
1171 _ -> id
1288 layout <- getLayout
1172 layout <- getLayout
1289 let ub = case layout of
1173 let ub = case layout of
@@ -1291,72 +1175,30 @@ p_exprOpTree s (OpBranch x op y) = do
1291 MultiLine -> case placement of
1175 MultiLine -> case placement of
1292 Hanging -> useBraces
1176 Hanging -> useBraces
1293 Normal -> dontUseBraces
1177 Normal -> dontUseBraces
1294− opNameStr = (fmap getOpNameStr . getOpName . unLoc) op
1178+ gotDollar = case getOpName (unLoc op) of
1295− gotDollar = opNameStr == Just "$"
1179+ Just rname -> mkVarOcc "$" == (rdrNameOcc rname)
1296− gotColon = opNameStr == Just ":"
1297− gotRecordDot = isRecordDot (unLoc op) (opTreeLoc y)
1298− lhs =
1299− switchLayout [opTreeLoc x] $
1300− p_exprOpTree s x
1301− p_op = located op (opWrapper . p_hsExpr)
1302− p_y = switchLayout [opTreeLoc y] (p_exprOpTree N y)
1303− isSection = case (opTreeLoc x, getLoc op) of
1304− (RealSrcSpan treeSpan, RealSrcSpan opSpan) ->
1305− srcSpanEndCol treeSpan /= srcSpanStartCol opSpan
1306− _ -> False
1307− isDoBlock = \case
1308− OpNode (L _ HsDo {}) -> True
1309 _ -> False
1180 _ -> False
1310− useRecordDot' <- useRecordDot
1181+ switchLayout [opTreeLoc x] $
1311− if
1182+ ub $ p_exprOpTree (not gotDollar) s x
1312− | gotColon -> do
1183+ let p_op = located op (opWrapper . p_hsExpr)
1313− lhs
1184+ p_y = switchLayout [opTreeLoc y] (p_exprOpTree True N y)
1185+ if isDollarSpecial && gotDollar && placement == Normal && isOneLineSpan (opTreeLoc x)
1186+ then do
1314− space
1187+ space
1188+ p_op
1189+ breakpoint
1190+ inci p_y
1191+ else
1192+ placeHanging placement $ do
1315 p_op
1193 p_op
1316− case placement of
1317− Hanging -> do
1318− space
1319− p_y
1320− Normal -> do
1321− breakpoint
1322− inciIf (isDoBlock y) p_y
1323− | gotDollar
1324− && isOneLineSpan (opTreeLoc x)
1325− && placement == Normal -> do
1326− useBraces lhs
1327 space
1194 space
1328− p_op
1329− breakpoint
1330− inci p_y
1331− | useRecordDot' && gotRecordDot -> do
1332− lhs
1333− when isSection space
1334− p_op
1335 p_y
1195 p_y
1336− | otherwise -> do
1337− ub lhs
1338− placeHanging placement $ do
1339− p_op
1340− space
1341− p_y
1342−
1343−-- | Return 'True' if given expression is a record-dot operator expression.
1344−isRecordDot ::
1345− -- | Operator expression
1346− HsExpr GhcPs ->
1347− -- | Span of the expression on the right-hand side of the operator
1348− SrcSpan ->
1349− Bool
1350−isRecordDot op (RealSrcSpan ySpan) = case op of
1351− HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1352− (getOpNameStr opName == ".") && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1353− _ -> False
1354−isRecordDot _ _ = False
1355
1196
1356-- | Get annotations for the enclosing element.
1197-- | Get annotations for the enclosing element.
1198+
1357getEnclosingAnns :: R [AnnKeywordId]
1199getEnclosingAnns :: R [AnnKeywordId]
1358getEnclosingAnns = do
1200getEnclosingAnns = do
1359 e <- getEnclosingSpan (const True)
1201 e <- getEnclosingSpan (const True)
1360 case e of
1202 case e of
1361 Nothing -> return []
1203 Nothing -> return []
1362− Just e' -> getAnns (RealSrcSpan e')
1204+ Just e' -> getAnns (RealSrcSpan e')
src/Ormolu/Printer/Meat/Declaration/Value.hs-boot+9−5
@@ -1,9 +1,9 @@
1module Ormolu.Printer.Meat.Declaration.Value
1module Ormolu.Printer.Meat.Declaration.Value
2− ( p_valDecl,
2+ ( p_valDecl
3− p_pat,
3+ , p_pat
4− p_hsExpr,
4+ , p_hsExpr
5− p_hsSplice,
5+ , p_hsSplice
6− p_stringLit,
6+ , p_stringLit
7 )
7 )
8where
8where
9
9
@@ -11,7 +11,11 @@ import GHC
11import Ormolu.Printer.Combinators
11import Ormolu.Printer.Combinators
12
12
13p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
13p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
14+
14p_pat :: Pat GhcPs -> R ()
15p_pat :: Pat GhcPs -> R ()
16+
15p_hsExpr :: HsExpr GhcPs -> R ()
17p_hsExpr :: HsExpr GhcPs -> R ()
18+
16p_hsSplice :: HsSplice GhcPs -> R ()
19p_hsSplice :: HsSplice GhcPs -> R ()
20+
17p_stringLit :: String -> R ()
21p_stringLit :: String -> R ()
src/Ormolu/Printer/Meat/Declaration/Warning.hs+13−11
@@ -1,9 +1,9 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3
3
4module Ormolu.Printer.Meat.Declaration.Warning
4module Ormolu.Printer.Meat.Declaration.Warning
5− ( p_warnDecls,
5+ ( p_warnDecls
6− p_moduleWarning,
6+ , p_moduleWarning
7 )
7 )
8where
8where
9
9
@@ -13,28 +13,30 @@ import Data.Text (Text)
13import GHC
13import GHC
14import Ormolu.Printer.Combinators
14import Ormolu.Printer.Combinators
15import Ormolu.Printer.Meat.Common
15import Ormolu.Printer.Meat.Common
16+import Ormolu.Utils
16
17
17p_warnDecls :: WarnDecls GhcPs -> R ()
18p_warnDecls :: WarnDecls GhcPs -> R ()
18−p_warnDecls (Warnings NoExtField _ warnings) =
19+p_warnDecls (Warnings NoExt _ warnings) =
19 traverse_ (located' p_warnDecl) warnings
20 traverse_ (located' p_warnDecl) warnings
20−p_warnDecls (XWarnDecls x) = noExtCon x
21+p_warnDecls XWarnDecls {} = notImplemented "XWarnDecls"
21
22
22p_warnDecl :: WarnDecl GhcPs -> R ()
23p_warnDecl :: WarnDecl GhcPs -> R ()
23−p_warnDecl (Warning NoExtField functions warningTxt) =
24+p_warnDecl (Warning NoExt functions warningTxt) =
24 p_topLevelWarning functions warningTxt
25 p_topLevelWarning functions warningTxt
25−p_warnDecl (XWarnDecl x) = noExtCon x
26+p_warnDecl XWarnDecl {} = notImplemented "XWarnDecl"
26
27
27p_moduleWarning :: WarningTxt -> R ()
28p_moduleWarning :: WarningTxt -> R ()
28p_moduleWarning wtxt = do
29p_moduleWarning wtxt = do
29 let (pragmaText, lits) = warningText wtxt
30 let (pragmaText, lits) = warningText wtxt
31+ switchLayout (getLoc <$> lits) $ do
30− inci $ pragma pragmaText $ inci $ p_lits lits
32+ inci $ pragma pragmaText (inci $ p_lits lits)
31
33
32p_topLevelWarning :: [Located RdrName] -> WarningTxt -> R ()
34p_topLevelWarning :: [Located RdrName] -> WarningTxt -> R ()
33p_topLevelWarning fnames wtxt = do
35p_topLevelWarning fnames wtxt = do
34 let (pragmaText, lits) = warningText wtxt
36 let (pragmaText, lits) = warningText wtxt
35− switchLayout (fmap getLoc fnames ++ fmap getLoc lits) $
37+ switchLayout (fmap getLoc fnames ++ fmap getLoc lits) $ do
36 pragma pragmaText . inci $ do
38 pragma pragmaText . inci $ do
37− sep commaDel p_rdrName fnames
39+ sitcc $ sep (comma >> breakpoint) p_rdrName fnames
38 breakpoint
40 breakpoint
39 p_lits lits
41 p_lits lits
40
42
@@ -46,4 +48,4 @@ warningText = \case
46p_lits :: [Located StringLiteral] -> R ()
48p_lits :: [Located StringLiteral] -> R ()
47p_lits = \case
49p_lits = \case
48 [l] -> atom l
50 [l] -> atom l
49− ls -> brackets N $ sep commaDel atom ls
51+ ls -> brackets N . sitcc $ sep (comma >> breakpoint) atom ls
src/Ormolu/Printer/Meat/ImportExport.hs+46−53
@@ -1,19 +1,21 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
4
4
5-- | Rendering of import and export lists.
5-- | Rendering of import and export lists.
6+
6module Ormolu.Printer.Meat.ImportExport
7module Ormolu.Printer.Meat.ImportExport
7− ( p_hsmodExports,
8+ ( p_hsmodExports
8− p_hsmodImport,
9+ , p_hsmodImport
9 )
10 )
10where
11where
11
12
12import Control.Monad
13import Control.Monad
13import GHC
14import GHC
15+import HsImpExp (IE (..))
14import Ormolu.Printer.Combinators
16import Ormolu.Printer.Combinators
15import Ormolu.Printer.Meat.Common
17import Ormolu.Printer.Meat.Common
16−import Ormolu.Utils (RelativePos (..), attachRelativePos)
18+import Ormolu.Utils
17
19
18p_hsmodExports :: [LIE GhcPs] -> R ()
20p_hsmodExports :: [LIE GhcPs] -> R ()
19p_hsmodExports [] = do
21p_hsmodExports [] = do
@@ -21,24 +23,19 @@ p_hsmodExports [] = do
21 breakpoint'
23 breakpoint'
22 txt ")"
24 txt ")"
23p_hsmodExports xs =
25p_hsmodExports xs =
24− parens N $ do
26+ parens N . sitcc $ do
25 layout <- getLayout
27 layout <- getLayout
26− sep
27− breakpoint
28− (\(p, l) -> sitcc (located l (p_lie layout p)))
28+ sep breakpoint (sitcc . located' (uncurry (p_lie layout))) (attachPositions xs)
29− (attachRelativePos xs)
30
29
31−p_hsmodImport :: Bool -> ImportDecl GhcPs -> R ()
30+p_hsmodImport :: ImportDecl GhcPs -> R ()
32−p_hsmodImport useQualifiedPost ImportDecl {..} = do
31+p_hsmodImport ImportDecl {..} = do
33 txt "import"
32 txt "import"
34 space
33 space
35 when ideclSource (txt "{-# SOURCE #-}")
34 when ideclSource (txt "{-# SOURCE #-}")
36 space
35 space
37 when ideclSafe (txt "safe")
36 when ideclSafe (txt "safe")
38 space
37 space
39− when
40− (isImportDeclQualified ideclQualified && not useQualifiedPost)
41− (txt "qualified")
38+ when ideclQualified (txt "qualified")
42 space
39 space
43 case ideclPkgQual of
40 case ideclPkgQual of
44 Nothing -> return ()
41 Nothing -> return ()
@@ -46,9 +43,6 @@ p_hsmodImport useQualifiedPost ImportDecl {..} = do
46 space
43 space
47 inci $ do
44 inci $ do
48 located ideclName atom
45 located ideclName atom
49− when
50− (isImportDeclQualified ideclQualified && useQualifiedPost)
51− (space >> txt "qualified")
52 case ideclAs of
46 case ideclAs of
53 Nothing -> return ()
47 Nothing -> return ()
54 Just l -> do
48 Just l -> do
@@ -63,64 +57,63 @@ p_hsmodImport useQualifiedPost ImportDecl {..} = do
63 when hiding (txt "hiding")
57 when hiding (txt "hiding")
64 case ideclHiding of
58 case ideclHiding of
65 Nothing -> return ()
59 Nothing -> return ()
66− Just (_, L _ xs) -> do
60+ Just (_, (L _ xs)) -> do
67 breakpoint
61 breakpoint
68− parens N $ do
62+ parens N . sitcc $ do
69 layout <- getLayout
63 layout <- getLayout
70− sep
71− breakpoint
72− (\(p, l) -> sitcc (located l (p_lie layout p)))
64+ sep breakpoint (sitcc . located' (uncurry (p_lie layout))) (attachPositions xs)
73− (attachRelativePos xs)
74 newline
65 newline
75−p_hsmodImport _ (XImportDecl x) = noExtCon x
66+p_hsmodImport (XImportDecl NoExt) = notImplemented "XImportDecl"
76
67
77−p_lie :: Layout -> RelativePos -> IE GhcPs -> R ()
68+p_lie :: Layout -> (Int, Int) -> IE GhcPs -> R ()
78−p_lie encLayout relativePos = \case
69+p_lie encLayout (i, totalItems) = \case
79− IEVar NoExtField l1 -> do
70+ IEVar NoExt l1 -> do
80 located l1 p_ieWrappedName
71 located l1 p_ieWrappedName
81 p_comma
72 p_comma
82− IEThingAbs NoExtField l1 -> do
73+ IEThingAbs NoExt l1 -> do
83 located l1 p_ieWrappedName
74 located l1 p_ieWrappedName
84 p_comma
75 p_comma
85− IEThingAll NoExtField l1 -> do
76+ IEThingAll NoExt l1 -> do
86 located l1 p_ieWrappedName
77 located l1 p_ieWrappedName
87 space
78 space
88 txt "(..)"
79 txt "(..)"
89 p_comma
80 p_comma
90− IEThingWith NoExtField l1 w xs _ -> sitcc $ do
81+ IEThingWith NoExt l1 w xs _ -> sitcc $ do
91 located l1 p_ieWrappedName
82 located l1 p_ieWrappedName
92 breakpoint
83 breakpoint
93 inci $ do
84 inci $ do
94 let names :: [R ()]
85 let names :: [R ()]
95 names = located' p_ieWrappedName <$> xs
86 names = located' p_ieWrappedName <$> xs
96− parens N . sep commaDel sitcc $
87+ parens N . sitcc $
88+ sep (comma >> breakpoint) sitcc $
97− case w of
89+ case w of
98− NoIEWildcard -> names
90+ NoIEWildcard -> names
99− IEWildcard n ->
91+ IEWildcard n ->
100− let (before, after) = splitAt n names
92+ let (before, after) = splitAt n names
101− in before ++ [txt ".."] ++ after
93+ in before ++ [txt ".."] ++ after
102 p_comma
94 p_comma
103− IEModuleContents NoExtField l1 -> do
95+ IEModuleContents NoExt l1 -> do
104 located l1 p_hsmodName
96 located l1 p_hsmodName
105 p_comma
97 p_comma
106− IEGroup NoExtField n str -> do
98+ IEGroup NoExt n str -> do
107− case relativePos of
108− SinglePos -> return ()
109− FirstPos -> return ()
110− MiddlePos -> newline
111− LastPos -> newline
99+ unless (i == 0) newline
112 p_hsDocString (Asterisk n) False (noLoc str)
100 p_hsDocString (Asterisk n) False (noLoc str)
113− IEDoc NoExtField str ->
101+ IEDoc NoExt str ->
114 p_hsDocString Pipe False (noLoc str)
102 p_hsDocString Pipe False (noLoc str)
115− IEDocNamed NoExtField str -> p_hsDocName str
103+ IEDocNamed NoExt str -> p_hsDocName str
116− XIE x -> noExtCon x
104+ XIE NoExt -> notImplemented "XIE"
117 where
105 where
118 p_comma =
106 p_comma =
119 case encLayout of
107 case encLayout of
120− SingleLine ->
108+ SingleLine -> unless (i + 1 == totalItems) comma
121− case relativePos of
122− SinglePos -> return ()
123− FirstPos -> comma
124− MiddlePos -> comma
125− LastPos -> return ()
126 MultiLine -> comma
109 MultiLine -> comma
110+
111+-- | Attach positions to 'Located' things in a list.
112+
113+attachPositions
114+ :: [Located a]
115+ -> [Located ((Int, Int), a)]
116+attachPositions xs =
117+ let f i (L l x) = L l ((i, n), x)
118+ n = length xs
119+ in zipWith f [0..] xs
src/Ormolu/Printer/Meat/Module.hs+21−41
@@ -1,20 +1,18 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
4
4
5-- | Rendering of modules.
5-- | Rendering of modules.
6+
6module Ormolu.Printer.Meat.Module
7module Ormolu.Printer.Meat.Module
7− ( p_hsModule,
8+ ( p_hsModule
8 )
9 )
9where
10where
10
11
11import Control.Monad
12import Control.Monad
12−import qualified Data.Text as T
13import GHC
13import GHC
14−import Ormolu.Imports (normalizeImports)
14+import Ormolu.Imports
15−import Ormolu.Parser.CommentStream
16import Ormolu.Parser.Pragma
15import Ormolu.Parser.Pragma
17−import Ormolu.Parser.Shebang
18import Ormolu.Printer.Combinators
16import Ormolu.Printer.Combinators
19import Ormolu.Printer.Comments
17import Ormolu.Printer.Comments
20import Ormolu.Printer.Meat.Common
18import Ormolu.Printer.Meat.Common
@@ -23,53 +21,35 @@ import Ormolu.Printer.Meat.Declaration.Warning
23import Ormolu.Printer.Meat.ImportExport
21import Ormolu.Printer.Meat.ImportExport
24import Ormolu.Printer.Meat.Pragma
22import Ormolu.Printer.Meat.Pragma
25
23
26−-- | Render a module.
27−p_hsModule ::
24+p_hsModule :: [Pragma] -> ParsedSource -> R ()
28− -- | Stack header
29− Maybe (RealLocated Comment) ->
30− -- | Shebangs
31− [Shebang] ->
32− -- | Pragmas and the associated comments
33− [([RealLocated Comment], Pragma)] ->
34− -- | Whether to use postfix qualified imports
35− Bool ->
36− -- | AST to print
37− HsModule GhcPs ->
38− R ()
39−p_hsModule mstackHeader shebangs pragmas qualifiedPost HsModule {..} = do
25+p_hsModule pragmas (L moduleSpan HsModule {..}) = do
26+ -- NOTE If span of exports in multiline, the whole thing is multiline.
27+ -- This is especially important because span of module itself always seems
28+ -- to have length zero, so it's not reliable for layout selection.
29+ let exportSpans = maybe [] (\(L s _) -> [s]) hsmodExports
40− let deprecSpan = maybe [] (\(L s _) -> [s]) hsmodDeprecMessage
30+ deprecSpan = maybe [] (\(L s _) -> [s]) hsmodDeprecMessage
41− exportSpans = maybe [] (\(L s _) -> [s]) hsmodExports
31+ spans' = exportSpans ++ deprecSpan ++ [moduleSpan]
42− switchLayout (deprecSpan <> exportSpans) $ do
32+ switchLayout spans' $ do
43− forM_ shebangs $ \(Shebang x) ->
44− located x $ \shebang -> do
45− txt (T.pack shebang)
46− newline
47− forM_ mstackHeader $ \(L spn comment) -> do
48− spitCommentNow spn comment
49− newline
50− newline
51 p_pragmas pragmas
33 p_pragmas pragmas
52 newline
34 newline
35+ forM_ hsmodHaddockModHeader (p_hsDocString Pipe True)
53 case hsmodName of
36 case hsmodName of
54 Nothing -> return ()
37 Nothing -> return ()
55 Just hsmodName' -> do
38 Just hsmodName' -> do
56− located hsmodName' $ \name -> do
39+ located hsmodName' p_hsmodName
57− forM_ hsmodHaddockModHeader (p_hsDocString Pipe True)
58− p_hsmodName name
59− breakpoint
60 forM_ hsmodDeprecMessage $ \w -> do
40 forM_ hsmodDeprecMessage $ \w -> do
61− located' p_moduleWarning w
62 breakpoint
41 breakpoint
42+ located' p_moduleWarning w
63 case hsmodExports of
43 case hsmodExports of
64 Nothing -> return ()
44 Nothing -> return ()
65− Just l -> do
45+ Just hsmodExports' -> do
66− located l $ \exports -> do
67− inci (p_hsmodExports exports)
68 breakpoint
46 breakpoint
47+ inci (p_hsmodExports (unLoc hsmodExports'))
48+ breakpoint
69 txt "where"
49 txt "where"
70 newline
50 newline
71 newline
51 newline
72− forM_ (normalizeImports hsmodImports) (located' (p_hsmodImport qualifiedPost))
52+ forM_ (sortImports hsmodImports) (located' p_hsmodImport)
73 newline
53 newline
74 switchLayout (getLoc <$> hsmodDecls) $ do
54 switchLayout (getLoc <$> hsmodDecls) $ do
75 p_hsDecls Free hsmodDecls
55 p_hsDecls Free hsmodDecls
src/Ormolu/Printer/Meat/Pragma.hs+20−73
@@ -1,91 +1,38 @@
1+-- | Pretty-printing of language pragmas.
2+
1−{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
4{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE TupleSections #-}
5+{-# LANGUAGE TupleSections #-}
4
6
5−-- | Pretty-printing of language pragmas.
6module Ormolu.Printer.Meat.Pragma
7module Ormolu.Printer.Meat.Pragma
7− ( p_pragmas,
8+ ( p_pragmas
8 )
9 )
9where
10where
10
11
11−import Control.Monad
12−import Data.Char (isUpper)
13−import qualified Data.List as L
14−import Data.Maybe (listToMaybe)
15−import qualified Data.Text as T
16−import Ormolu.Parser.CommentStream
17−import Ormolu.Parser.Pragma (Pragma (..))
18import Ormolu.Printer.Combinators
12import Ormolu.Printer.Combinators
19−import Ormolu.Printer.Comments
13+import Ormolu.Parser.Pragma (Pragma (..))
20−import SrcLoc
14+import qualified Data.Set as S
21−
15+import qualified Data.Text as T
22−-- | Pragma classification.
23−data PragmaTy
24− = Language LanguagePragmaClass
25− | OptionsGHC
26− | OptionsHaddock
27− deriving (Eq, Ord)
28
16
29−-- | Language pragma classification.
17+data PragmaTy = Language | OptionsGHC | OptionsHaddock
30−--
31−-- The order in which language pragmas are put in the input sometimes
32−-- matters. This is because some language extensions can enable other
33−-- extensions, yet the extensions coming later in the list have the ability
34−-- to change it. So here we classify all extensions by assigning one of the
35−-- four groups to them. Then we only sort inside of the groups.
36−--
37−-- 'Ord' instance of this data type is what affects the sorting.
38−--
39−-- See also: <https://github.com/tweag/ormolu/issues/404>
40−data LanguagePragmaClass
41− = -- | All other extensions
42− Normal
43− | -- | Extensions starting with "No"
44− Disabling
45− | -- | Extensions that should go after everything else
46− Final
47 deriving (Eq, Ord)
18 deriving (Eq, Ord)
48
19
49−-- | Print a collection of 'Pragma's with their associated comments.
50−p_pragmas :: [([RealLocated Comment], Pragma)] -> R ()
20+p_pragmas :: [Pragma] -> R ()
51−p_pragmas ps = do
21+p_pragmas ps =
52− let prepare = L.sortOn snd . L.nub . concatMap analyze
22+ let prepare = concatMap $ \case
53− analyze = \case
54− (cs, PragmaLanguage xs) ->
23+ PragmaLanguage xs -> (Language,) <$> xs
55− let f x = (cs, (Language (classifyLanguagePragma x), x))
56− in f <$> xs
57− (cs, PragmaOptionsGHC x) -> [(cs, (OptionsGHC, x))]
24+ PragmaOptionsGHC x -> [(OptionsGHC, x)]
58− (cs, PragmaOptionsHaddock x) -> [(cs, (OptionsHaddock, x))]
25+ PragmaOptionsHaddock x -> [(OptionsHaddock, x)]
59− forM_ (prepare ps) $ \(cs, (pragmaTy, x)) ->
26+ in mapM_ (uncurry p_pragma) (S.toAscList . S.fromList . prepare $ ps)
60− p_pragma cs pragmaTy x
61
27
62−p_pragma :: [RealLocated Comment] -> PragmaTy -> String -> R ()
28+p_pragma :: PragmaTy -> String -> R ()
63−p_pragma comments ty x = do
29+p_pragma ty c = do
64− forM_ comments $ \(L l comment) -> do
65− spitCommentNow l comment
66− newline
67 txt "{-# "
30 txt "{-# "
68 txt $ case ty of
31 txt $ case ty of
69− Language _ -> "LANGUAGE"
32+ Language -> "LANGUAGE"
70 OptionsGHC -> "OPTIONS_GHC"
33 OptionsGHC -> "OPTIONS_GHC"
71 OptionsHaddock -> "OPTIONS_HADDOCK"
34 OptionsHaddock -> "OPTIONS_HADDOCK"
72 space
35 space
73− txt (T.pack x)
36+ txt (T.pack c)
74 txt " #-}"
37 txt " #-}"
75 newline
38 newline
76−
77−-- | Classify a 'LanguagePragma'.
78−classifyLanguagePragma :: String -> LanguagePragmaClass
79−classifyLanguagePragma = \case
80− "ImplicitPrelude" -> Final
81− "CUSKs" -> Final
82− str ->
83− case splitAt 2 str of
84− ("No", rest) ->
85− case listToMaybe rest of
86− Nothing -> Normal
87− Just x ->
88− if isUpper x
89− then Disabling
90− else Normal
91− _ -> Normal
src/Ormolu/Printer/Meat/Type.hs+94−137
@@ -1,46 +1,39 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
4
4
5-- | Rendering of types.
5-- | Rendering of types.
6+
6module Ormolu.Printer.Meat.Type
7module Ormolu.Printer.Meat.Type
7− ( p_hsType,
8+ ( p_hsType
8− p_hsTypePostDoc,
9− hasDocStrings,
9+ , hasDocStrings
10− p_hsContext,
10+ , p_hsContext
11− p_hsTyVarBndr,
11+ , p_hsTyVarBndr
12− p_forallBndrs,
13− p_conDeclFields,
12+ , p_conDeclFields
14− tyVarsToTypes,
13+ , tyVarsToTypes
15 )
14 )
16where
15where
17
16
18−import Data.Data (Data)
17+import BasicTypes
19−import GHC hiding (isPromoted)
18+import GHC
20import Ormolu.Printer.Combinators
19import Ormolu.Printer.Combinators
21import Ormolu.Printer.Meat.Common
20import Ormolu.Printer.Meat.Common
22−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration.Value (p_hsSplice, p_stringLit)
23import Ormolu.Printer.Operators
21import Ormolu.Printer.Operators
24import Ormolu.Utils
22import Ormolu.Utils
23+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration.Value (p_hsSplice, p_stringLit)
25
24
26p_hsType :: HsType GhcPs -> R ()
25p_hsType :: HsType GhcPs -> R ()
27−p_hsType t = p_hsType' (hasDocStrings t) PipeStyle t
26+p_hsType t = p_hsType' (hasDocStrings t) t
28−
27+
29−p_hsTypePostDoc :: HsType GhcPs -> R ()
30−p_hsTypePostDoc t = p_hsType' (hasDocStrings t) CaretStyle t
31−
32−-- | How to render Haddocks associated with a type.
33−data TypeDocStyle
34− = PipeStyle
35− | CaretStyle
36−
37−p_hsType' :: Bool -> TypeDocStyle -> HsType GhcPs -> R ()
28+p_hsType' :: Bool -> HsType GhcPs -> R ()
38−p_hsType' multilineArgs docStyle = \case
29+p_hsType' multilineArgs = \case
39− HsForAllTy NoExtField visibility bndrs t -> do
30+ HsForAllTy NoExt bndrs t -> do
31+ txt "forall "
40− p_forallBndrs visibility p_hsTyVarBndr bndrs
32+ sep space (located' p_hsTyVarBndr) bndrs
33+ txt "."
41 interArgBreak
34 interArgBreak
42− p_hsTypeR (unLoc t)
35+ p_hsType' multilineArgs (unLoc t)
43− HsQualTy NoExtField qs t -> do
36+ HsQualTy NoExt qs t -> do
44 located qs p_hsContext
37 located qs p_hsContext
45 space
38 space
46 txt "=>"
39 txt "=>"
@@ -49,89 +42,72 @@ p_hsType' multilineArgs docStyle = \case
49 HsQualTy {} -> p_hsTypeR (unLoc t)
42 HsQualTy {} -> p_hsTypeR (unLoc t)
50 HsFunTy {} -> p_hsTypeR (unLoc t)
43 HsFunTy {} -> p_hsTypeR (unLoc t)
51 _ -> located t p_hsTypeR
44 _ -> located t p_hsTypeR
52− HsTyVar NoExtField p n -> do
45+ HsTyVar NoExt p n -> do
53 case p of
46 case p of
54− IsPromoted -> do
47+ Promoted -> do
55 txt "'"
48 txt "'"
56 case showOutputable (unLoc n) of
49 case showOutputable (unLoc n) of
57 _ : '\'' : _ -> space
50 _ : '\'' : _ -> space
58 _ -> return ()
51 _ -> return ()
59 NotPromoted -> return ()
52 NotPromoted -> return ()
60 p_rdrName n
53 p_rdrName n
61− HsAppTy NoExtField f x -> do
54+ HsAppTy NoExt f x -> sitcc $ do
62− let -- In order to format type applications with multiple parameters
63− -- nicer, traverse the AST to gather the function and all the
64− -- parameters together.
65− gatherArgs f' knownArgs =
66− case f' of
67− L _ (HsAppTy _ l r) -> gatherArgs l (r : knownArgs)
68− _ -> (f', knownArgs)
69− (func, args) = gatherArgs f [x]
70− switchLayout (getLoc f : fmap getLoc args) . sitcc $ do
71− located func p_hsType
72− breakpoint
73− inci $
74− sep breakpoint (located' p_hsType) args
75− HsAppKindTy _ ty kd -> sitcc $ do
76− -- The first argument is the location of the "@..." part. Not 100% sure,
77− -- but I think we can ignore it as long as we use 'located' on both the
78− -- type and the kind.
79− located ty p_hsType
55+ located f p_hsType
80 breakpoint
56 breakpoint
81− inci $ do
82− txt "@"
83− located kd p_hsType
57+ inci (located x p_hsType)
84− HsFunTy NoExtField x y@(L _ y') -> do
58+ HsFunTy NoExt x y@(L _ y') -> do
85 located x p_hsType
59 located x p_hsType
86 space
60 space
87 txt "->"
61 txt "->"
88 interArgBreak
62 interArgBreak
89 case y' of
63 case y' of
90− HsFunTy {} -> p_hsTypeR y'
64+ HsFunTy{} -> p_hsTypeR y'
91 _ -> located y p_hsTypeR
65 _ -> located y p_hsTypeR
92− HsListTy NoExtField t ->
66+ HsListTy NoExt t ->
93 located t (brackets N . p_hsType)
67 located t (brackets N . p_hsType)
94− HsTupleTy NoExtField tsort xs ->
68+ HsTupleTy NoExt tsort xs ->
95 let parens' =
69 let parens' =
96 case tsort of
70 case tsort of
97 HsUnboxedTuple -> parensHash N
71 HsUnboxedTuple -> parensHash N
98 HsBoxedTuple -> parens N
72 HsBoxedTuple -> parens N
99 HsConstraintTuple -> parens N
73 HsConstraintTuple -> parens N
100 HsBoxedOrConstraintTuple -> parens N
74 HsBoxedOrConstraintTuple -> parens N
75+ in parens' . sitcc $
101− in parens' $ sep commaDel (sitcc . located' p_hsType) xs
76+ sep (comma >> breakpoint) (sitcc . located' p_hsType) xs
102− HsSumTy NoExtField xs ->
77+ HsSumTy NoExt xs ->
103− parensHash N $
78+ parensHash N . sitcc $
104 sep (txt "|" >> breakpoint) (sitcc . located' p_hsType) xs
79 sep (txt "|" >> breakpoint) (sitcc . located' p_hsType) xs
105− HsOpTy NoExtField x op y ->
80+ HsOpTy NoExt x op y -> sitcc $ do
106− sitcc $
107− let opTree = OpBranch (tyOpTree x) op (tyOpTree y)
81+ let opTree = OpBranch (tyOpTree x) op (tyOpTree y)
108− in p_tyOpTree (reassociateOpTree Just opTree)
82+ in p_tyOpTree (reassociateOpTree Just opTree)
109− HsParTy NoExtField t ->
83+ HsParTy NoExt (L _ t@HsKindSig {}) ->
84+ -- NOTE Kind signatures already put parentheses around in all cases, so
85+ -- skip this layer of parentheses. The reason for this behavior is that
86+ -- parentheses are not always encoded with 'HsParTy', but seem to be
87+ -- always necessary when we have kind signatures in place.
88+ p_hsType t
89+ HsParTy NoExt t ->
110 parens N (located t p_hsType)
90 parens N (located t p_hsType)
111− HsIParamTy NoExtField n t -> sitcc $ do
91+ HsIParamTy NoExt n t -> sitcc $ do
112 located n atom
92 located n atom
113 space
93 space
114 txt "::"
94 txt "::"
115 breakpoint
95 breakpoint
116 inci (located t p_hsType)
96 inci (located t p_hsType)
117− HsStarTy NoExtField _ -> txt "*"
97+ HsStarTy NoExt _ -> txt "*"
118− HsKindSig NoExtField t k -> sitcc $ do
98+ HsKindSig NoExt t k ->
99+ -- NOTE Also see the comment for 'HsParTy'.
100+ parens N . sitcc $ do
101+ located t p_hsType
102+ space -- FIXME
103+ txt "::"
104+ space
105+ inci (located k p_hsType)
106+ HsSpliceTy NoExt splice -> p_hsSplice splice
107+ HsDocTy NoExt t str -> do
108+ p_hsDocString Pipe True str
119 located t p_hsType
109 located t p_hsType
120− space
121− txt "::"
122− breakpoint
123− inci (located k p_hsType)
124− HsSpliceTy NoExtField splice -> p_hsSplice splice
125− HsDocTy NoExtField t str ->
126− case docStyle of
127− PipeStyle -> do
128− p_hsDocString Pipe True str
129− located t p_hsType
130− CaretStyle -> do
131− located t p_hsType
132− newline
133− p_hsDocString Caret False str
134− HsBangTy NoExtField (HsSrcBang _ u s) t -> do
110+ HsBangTy NoExt (HsSrcBang _ u s) t -> do
135 case u of
111 case u of
136 SrcUnpack -> txt "{-# UNPACK #-}" >> space
112 SrcUnpack -> txt "{-# UNPACK #-}" >> space
137 SrcNoUnpack -> txt "{-# NOUNPACK #-}" >> space
113 SrcNoUnpack -> txt "{-# NOUNPACK #-}" >> space
@@ -141,49 +117,50 @@ p_hsType' multilineArgs docStyle = \case
141 SrcStrict -> txt "!"
117 SrcStrict -> txt "!"
142 NoSrcStrict -> return ()
118 NoSrcStrict -> return ()
143 located t p_hsType
119 located t p_hsType
144− HsRecTy NoExtField fields ->
120+ HsRecTy NoExt fields ->
145 p_conDeclFields fields
121 p_conDeclFields fields
146− HsExplicitListTy NoExtField p xs -> do
122+ HsExplicitListTy NoExt p xs -> do
147 case p of
123 case p of
148− IsPromoted -> txt "'"
124+ Promoted -> txt "'"
149 NotPromoted -> return ()
125 NotPromoted -> return ()
150 brackets N $ do
126 brackets N $ do
151 -- If both this list itself and the first element is promoted,
127 -- If both this list itself and the first element is promoted,
152 -- we need to put a space in between or it fails to parse.
128 -- we need to put a space in between or it fails to parse.
153 case (p, xs) of
129 case (p, xs) of
154− (IsPromoted, L _ t : _) | isPromoted t -> space
130+ (Promoted, ((L _ t):_)) | isPromoted t -> space
155 _ -> return ()
131 _ -> return ()
156− sep commaDel (sitcc . located' p_hsType) xs
132+ sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsType) xs
157− HsExplicitTupleTy NoExtField xs -> do
133+ HsExplicitTupleTy NoExt xs -> do
158 txt "'"
134 txt "'"
159 parens N $ do
135 parens N $ do
160 case xs of
136 case xs of
161− L _ t : _ | isPromoted t -> space
137+ ((L _ t):_) | isPromoted t -> space
162 _ -> return ()
138 _ -> return ()
163− sep commaDel (located' p_hsType) xs
139+ sep (comma >> breakpoint) (located' p_hsType) xs
164− HsTyLit NoExtField t ->
140+ HsTyLit NoExt t ->
165 case t of
141 case t of
166 HsStrTy (SourceText s) _ -> p_stringLit s
142 HsStrTy (SourceText s) _ -> p_stringLit s
167 a -> atom a
143 a -> atom a
168− HsWildCardTy NoExtField -> txt "_"
144+ HsWildCardTy NoExt -> txt "_"
169 XHsType (NHsCoreTy t) -> atom t
145 XHsType (NHsCoreTy t) -> atom t
170 where
146 where
171 isPromoted = \case
147 isPromoted = \case
172− HsTyVar _ IsPromoted _ -> True
148+ HsTyVar _ Promoted _ -> True
149+ HsExplicitListTy _ _ _ -> True
173− HsExplicitTupleTy {} -> True
150+ HsExplicitTupleTy _ _ -> True
174− HsExplicitListTy {} -> True
175 _ -> False
151 _ -> False
176 interArgBreak =
152 interArgBreak =
177 if multilineArgs
153 if multilineArgs
178 then newline
154 then newline
179 else breakpoint
155 else breakpoint
180− p_hsTypeR = p_hsType' multilineArgs docStyle
156+ p_hsTypeR = p_hsType' multilineArgs
181
157
182-- | Return 'True' if at least one argument in 'HsType' has a doc string
158-- | Return 'True' if at least one argument in 'HsType' has a doc string
183-- attached to it.
159-- attached to it.
160+
184hasDocStrings :: HsType GhcPs -> Bool
161hasDocStrings :: HsType GhcPs -> Bool
185hasDocStrings = \case
162hasDocStrings = \case
186− HsDocTy {} -> True
163+ HsDocTy _ _ _ -> True
187 HsFunTy _ (L _ x) (L _ y) -> hasDocStrings x || hasDocStrings y
164 HsFunTy _ (L _ x) (L _ y) -> hasDocStrings x || hasDocStrings y
188 _ -> False
165 _ -> False
189
166
@@ -191,61 +168,46 @@ p_hsContext :: HsContext GhcPs -> R ()
191p_hsContext = \case
168p_hsContext = \case
192 [] -> txt "()"
169 [] -> txt "()"
193 [x] -> located x p_hsType
170 [x] -> located x p_hsType
171+ xs -> parens N . sitcc $
194− xs -> parens N $ sep commaDel (sitcc . located' p_hsType) xs
172+ sep (comma >> breakpoint) (sitcc . located' p_hsType) xs
195
173
196p_hsTyVarBndr :: HsTyVarBndr GhcPs -> R ()
174p_hsTyVarBndr :: HsTyVarBndr GhcPs -> R ()
197p_hsTyVarBndr = \case
175p_hsTyVarBndr = \case
198− UserTyVar NoExtField x ->
176+ UserTyVar NoExt x ->
199 p_rdrName x
177 p_rdrName x
200− KindedTyVar NoExtField l k -> parens N $ do
178+ KindedTyVar NoExt l k -> parens N $ do
201 located l atom
179 located l atom
202 space
180 space
203 txt "::"
181 txt "::"
204 breakpoint
182 breakpoint
205 inci (located k p_hsType)
183 inci (located k p_hsType)
206− XTyVarBndr x -> noExtCon x
184+ XTyVarBndr NoExt -> notImplemented "XTyVarBndr"
207−
208−-- | Render several @forall@-ed variables.
209−p_forallBndrs :: Data a => ForallVisFlag -> (a -> R ()) -> [Located a] -> R ()
210−p_forallBndrs ForallInvis _ [] = txt "forall."
211−p_forallBndrs ForallVis _ [] = txt "forall ->"
212−p_forallBndrs vis p tyvars =
213− switchLayout (getLoc <$> tyvars) $ do
214− txt "forall"
215− breakpoint
216− inci $ do
217− sitcc $ sep breakpoint (sitcc . located' p) tyvars
218− case vis of
219− ForallInvis -> txt "."
220− ForallVis -> space >> txt "->"
221
185
222p_conDeclFields :: [LConDeclField GhcPs] -> R ()
186p_conDeclFields :: [LConDeclField GhcPs] -> R ()
223−p_conDeclFields xs =
187+p_conDeclFields xs = braces N . sitcc $
224− braces N $ sep commaDel (sitcc . located' p_conDeclField) xs
188+ sep (comma >> breakpoint) (sitcc . located' p_conDeclField) xs
225
189
226p_conDeclField :: ConDeclField GhcPs -> R ()
190p_conDeclField :: ConDeclField GhcPs -> R ()
227p_conDeclField ConDeclField {..} = do
191p_conDeclField ConDeclField {..} = do
228 mapM_ (p_hsDocString Pipe True) cd_fld_doc
192 mapM_ (p_hsDocString Pipe True) cd_fld_doc
229− sitcc $
193+ sitcc $ sep (comma >> breakpoint)
230− sep
231− commaDel
232− (located' (p_rdrName . rdrNameFieldOcc))
194+ (located' (p_rdrName . rdrNameFieldOcc))
233− cd_fld_names
195+ cd_fld_names
234 space
196 space
235 txt "::"
197 txt "::"
236 breakpoint
198 breakpoint
237 sitcc . inci $ p_hsType (unLoc cd_fld_type)
199 sitcc . inci $ p_hsType (unLoc cd_fld_type)
238−p_conDeclField (XConDeclField x) = noExtCon x
200+p_conDeclField (XConDeclField NoExt) = notImplemented "XConDeclField"
239
201
240tyOpTree :: LHsType GhcPs -> OpTree (LHsType GhcPs) (Located RdrName)
202tyOpTree :: LHsType GhcPs -> OpTree (LHsType GhcPs) (Located RdrName)
241−tyOpTree (L _ (HsOpTy NoExtField l op r)) =
203+tyOpTree (L _ (HsOpTy NoExt l op r)) =
242 OpBranch (tyOpTree l) op (tyOpTree r)
204 OpBranch (tyOpTree l) op (tyOpTree r)
243tyOpTree n = OpNode n
205tyOpTree n = OpNode n
244
206
245p_tyOpTree :: OpTree (LHsType GhcPs) (Located RdrName) -> R ()
207p_tyOpTree :: OpTree (LHsType GhcPs) (Located RdrName) -> R ()
246p_tyOpTree (OpNode n) = located n p_hsType
208p_tyOpTree (OpNode n) = located n p_hsType
247p_tyOpTree (OpBranch l op r) = do
209p_tyOpTree (OpBranch l op r) = do
248− switchLayout [opTreeLoc l] $
210+ switchLayout [opTreeLoc l] $ do
249 p_tyOpTree l
211 p_tyOpTree l
250 breakpoint
212 breakpoint
251 inci . switchLayout [opTreeLoc r] $ do
213 inci . switchLayout [opTreeLoc r] $ do
@@ -259,17 +221,12 @@ p_tyOpTree (OpBranch l op r) = do
259tyVarsToTypes :: LHsQTyVars GhcPs -> [LHsType GhcPs]
221tyVarsToTypes :: LHsQTyVars GhcPs -> [LHsType GhcPs]
260tyVarsToTypes = \case
222tyVarsToTypes = \case
261 HsQTvs {..} -> fmap tyVarToType <$> hsq_explicit
223 HsQTvs {..} -> fmap tyVarToType <$> hsq_explicit
262− XLHsQTyVars x -> noExtCon x
224+ XLHsQTyVars {} -> notImplemented "XLHsQTyVars"
263
225
264tyVarToType :: HsTyVarBndr GhcPs -> HsType GhcPs
226tyVarToType :: HsTyVarBndr GhcPs -> HsType GhcPs
265tyVarToType = \case
227tyVarToType = \case
266− UserTyVar NoExtField tvar -> HsTyVar NoExtField NotPromoted tvar
228+ UserTyVar NoExt tvar -> HsTyVar NoExt NotPromoted tvar
267− KindedTyVar NoExtField tvar kind ->
229+ KindedTyVar NoExt tvar kind ->
268− -- Note: we always add parentheses because for whatever reason GHC does
230+ HsParTy NoExt $ noLoc $
269− -- not use HsParTy for left-hand sides of declarations. Please see
270− -- <https://gitlab.haskell.org/ghc/ghc/issues/17404>. This is fine as
271− -- long as 'tyVarToType' does not get applied to right-hand sides of
272− -- declarations.
273− HsParTy NoExtField . noLoc $
274− HsKindSig NoExtField (noLoc (HsTyVar NoExtField NotPromoted tvar)) kind
231+ HsKindSig NoExt (noLoc (HsTyVar NoExt NotPromoted tvar)) kind
275− XTyVarBndr x -> noExtCon x
232+ XTyVarBndr {} -> notImplemented "XTyVarBndr"
src/Ormolu/Printer/Operators.hs+103−96
@@ -1,27 +1,28 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE ScopedTypeVariables #-}
2{-# LANGUAGE ScopedTypeVariables #-}
3
3
4-- | This module helps handle operator chains composed of different
4-- | This module helps handle operator chains composed of different
5-- operators that may have different precedence and fixities.
5-- operators that may have different precedence and fixities.
6+
6module Ormolu.Printer.Operators
7module Ormolu.Printer.Operators
7− ( OpTree (..),
8+ ( OpTree (..)
8− opTreeLoc,
9+ , opTreeLoc
9− reassociateOpTree,
10+ , reassociateOpTree
10− )
11−where
11+ ) where
12
12
13+import BasicTypes (Fixity (..), SourceText (NoSourceText), defaultFixity, compareFixity)
13import Data.Function (on)
14import Data.Function (on)
14−import qualified Data.List as L
15+import Data.List
15−import Data.Map.Strict (Map)
16−import qualified Data.Map.Strict as M
17−import Data.Maybe (fromMaybe, mapMaybe)
16+import Data.Maybe (fromMaybe)
18import GHC
17import GHC
19−import OccName (occNameString)
18+import OccName (mkVarOcc)
20−import Ormolu.Utils (unSrcSpan)
19+import RdrName (mkRdrUnqual)
20+import SrcLoc (combineSrcSpans)
21
21
22-- | Intermediate representation of operator trees. It has two type
22-- | Intermediate representation of operator trees. It has two type
23-- parameters: @ty@ is the type of sub-expressions, while @op@ is the type
23-- parameters: @ty@ is the type of sub-expressions, while @op@ is the type
24-- of operators.
24-- of operators.
25+
25data OpTree ty op
26data OpTree ty op
26 = OpNode ty
27 = OpNode ty
27 | OpBranch
28 | OpBranch
@@ -30,6 +31,7 @@ data OpTree ty op
30 (OpTree ty op)
31 (OpTree ty op)
31
32
32-- | Return combined 'SrcSpan's of all elements in this 'OpTree'.
33-- | Return combined 'SrcSpan's of all elements in this 'OpTree'.
34+
33opTreeLoc :: OpTree (Located a) b -> SrcSpan
35opTreeLoc :: OpTree (Located a) b -> SrcSpan
34opTreeLoc (OpNode (L l _)) = l
36opTreeLoc (OpNode (L l _)) = l
35opTreeLoc (OpBranch l _ r) = combineSrcSpans (opTreeLoc l) (opTreeLoc r)
37opTreeLoc (OpBranch l _ r) = combineSrcSpans (opTreeLoc l) (opTreeLoc r)
@@ -38,13 +40,11 @@ opTreeLoc (OpBranch l _ r) = combineSrcSpans (opTreeLoc l) (opTreeLoc r)
38-- relative precedence of operators. Users are expected to first construct
40-- relative precedence of operators. Users are expected to first construct
39-- an initial 'OpTree', then re-associate it using this function before
41-- an initial 'OpTree', then re-associate it using this function before
40-- printing.
42-- printing.
43+
41−reassociateOpTree ::
44+reassociateOpTree
42− -- | How to get name of an operator
45+ :: (op -> Maybe RdrName) -- ^ How to get name of an operator
43− (op -> Maybe RdrName) ->
44− -- | Original 'OpTree'
46+ -> OpTree (Located ty) (Located op) -- ^ Original 'OpTree'
45− OpTree (Located ty) (Located op) ->
47+ -> OpTree (Located ty) (Located op) -- ^ Re-associated 'OpTree'
46− -- | Re-associated 'OpTree'
47− OpTree (Located ty) (Located op)
48reassociateOpTree getOpName opTree =
48reassociateOpTree getOpName opTree =
49 reassociateOpTreeWith
49 reassociateOpTreeWith
50 (buildFixityMap getOpName normOpTree)
50 (buildFixityMap getOpName normOpTree)
@@ -54,27 +54,25 @@ reassociateOpTree getOpName opTree =
54 normOpTree = normalizeOpTree opTree
54 normOpTree = normalizeOpTree opTree
55
55
56-- | Re-associate an 'OpTree' given the map with operator fixities.
56-- | Re-associate an 'OpTree' given the map with operator fixities.
57+
57−reassociateOpTreeWith ::
58+reassociateOpTreeWith
58− forall ty op.
59+ :: forall ty op.
59− -- | Fixity map for operators
60+ [(RdrName, Fixity)] -- ^ Fixity map for operators
60− Map String Fixity ->
61− -- | How to get the name of an operator
61+ -> (op -> Maybe RdrName) -- ^ How to get the name of an operator
62− (op -> Maybe RdrName) ->
63− -- | Original 'OpTree'
62+ -> OpTree ty op -- ^ Original 'OpTree'
64− OpTree ty op ->
65− -- | Re-associated 'OpTree'
63+ -> OpTree ty op -- ^ Re-associated 'OpTree'
66− OpTree ty op
67reassociateOpTreeWith fixityMap getOpName = go
64reassociateOpTreeWith fixityMap getOpName = go
68 where
65 where
69 fixityOf :: op -> Fixity
66 fixityOf :: op -> Fixity
70 fixityOf op = fromMaybe defaultFixity $ do
67 fixityOf op = fromMaybe defaultFixity $ do
71− s <- occNameString . rdrNameOcc <$> getOpName op
68+ opName <- getOpName op
72− M.lookup s fixityMap
69+ lookup opName fixityMap
70+
73 -- Here, left branch is already associated and the root alongside with
71 -- Here, left branch is already associated and the root alongside with
74 -- the right branch is right-associated. This function picks up one item
72 -- the right branch is right-associated. This function picks up one item
75 -- from the right and inserts it correctly to the left.
73 -- from the right and inserts it correctly to the left.
76 --
74 --
77− -- Also, we are using the 'compareFixity' function which tells if the
75+ -- Also, we are using the 'compareFixity' function which returns if the
78 -- expression should associate to right.
76 -- expression should associate to right.
79 go :: OpTree ty op -> OpTree ty op
77 go :: OpTree ty op -> OpTree ty op
80 -- base cases
78 -- base cases
@@ -86,52 +84,38 @@ reassociateOpTreeWith fixityMap getOpName = go
86 -- at the last operator, place the operator and don't recurse
84 -- at the last operator, place the operator and don't recurse
87 go (OpBranch (OpBranch l op r) op' r'@(OpNode _)) =
85 go (OpBranch (OpBranch l op r) op' r'@(OpNode _)) =
88 if snd $ compareFixity (fixityOf op) (fixityOf op')
86 if snd $ compareFixity (fixityOf op) (fixityOf op')
89− then OpBranch l op (go $ OpBranch r op' r')
87+ then OpBranch l op (go $ OpBranch r op' r')
90− else OpBranch (OpBranch l op r) op' r'
88+ else OpBranch (OpBranch l op r) op' r'
91 -- else, shift one operator to left and recurse.
89 -- else, shift one operator to left and recurse.
92 go (OpBranch (OpBranch l op r) op' (OpBranch l' op'' r')) =
90 go (OpBranch (OpBranch l op r) op' (OpBranch l' op'' r')) =
93 if snd $ compareFixity (fixityOf op) (fixityOf op')
91 if snd $ compareFixity (fixityOf op) (fixityOf op')
94− then go $ OpBranch (OpBranch l op (go $ OpBranch r op' l')) op'' r'
92+ then go $ OpBranch (OpBranch l op (go $ OpBranch r op' l')) op'' r'
95− else go $ OpBranch (OpBranch (OpBranch l op r) op' l') op'' r'
93+ else go $ OpBranch (OpBranch (OpBranch l op r) op' l') op'' r'
96−
97−-- | A score assigned to an operator.
98−data Score
99− = -- | The operator was placed at the beginning of a line
100− AtBeginning Int
101− | -- | The operator was placed at the end of a line
102− AtEnd
103− | -- | The operator was placed in between arguments on a single line
104− InBetween
105− deriving (Eq, Ord)
106
94
107-- | Build a map of inferred 'Fixity's from an 'OpTree'.
95-- | Build a map of inferred 'Fixity's from an 'OpTree'.
96+
108−buildFixityMap ::
97+buildFixityMap
109− forall ty op.
98+ :: forall ty op.
110− -- | How to get the name of an operator
99+ (op -> Maybe RdrName) -- ^ How to get the name of an operator
111− (op -> Maybe RdrName) ->
112− -- | Operator tree
100+ -> OpTree (Located ty) (Located op) -- ^ Operator tree
113− OpTree (Located ty) (Located op) ->
114− -- | Fixity map
101+ -> [(RdrName, Fixity)] -- ^ Fixity map
115− Map String Fixity
116buildFixityMap getOpName opTree =
102buildFixityMap getOpName opTree =
117− addOverrides
118− . M.fromList
119− . concatMap (\(i, ns) -> map (\(n, _) -> (n, fixity i InfixL)) ns)
103+ concatMap (\(i, ns) -> map (\(n, _) -> (n, fixity i InfixL)) ns)
120− . zip [2 ..]
104+ . zip [0..]
121− . L.groupBy ((==) `on` snd)
105+ . groupBy (doubleWithinEps 0.00001 `on` snd)
122− . selectScores
106+ . (overrides ++)
107+ . avgScores
123 $ score opTree
108 $ score opTree
124 where
109 where
125− addOverrides :: Map String Fixity -> Map String Fixity
110+ -- Add a special case for ($), since it is pretty unlikely for someone
126− addOverrides m =
111+ -- to override it.
127− M.fromList
112+ overrides :: [(RdrName, Double)]
128− [ ("$", fixity 0 InfixR),
113+ overrides =
129− (":", fixity 1 InfixR),
114+ [ (mkRdrUnqual $ mkVarOcc "$", -1)
130− (".", fixity 100 InfixL)
115+ ]
131− ]
116+
132− `M.union` m
117+ -- Assign scores to operators based on their location in the source.
133− fixity = Fixity NoSourceText
134− score :: OpTree (Located ty) (Located op) -> [(String, Score)]
118+ score :: OpTree (Located ty) (Located op) -> [(RdrName, Double)]
135 score (OpNode _) = []
119 score (OpNode _) = []
136 score (OpBranch l o r) = fromMaybe (score r) $ do
120 score (OpBranch l o r) = fromMaybe (score r) $ do
137 -- If we fail to get any of these, 'defaultFixity' will be used by
121 -- If we fail to get any of these, 'defaultFixity' will be used by
@@ -141,37 +125,60 @@ buildFixityMap getOpName opTree =
141 oe <- srcSpanEndLine <$> unSrcSpan (getLoc o) -- operator end
125 oe <- srcSpanEndLine <$> unSrcSpan (getLoc o) -- operator end
142 rb <- srcSpanStartLine <$> unSrcSpan (opTreeLoc r) -- right begin
126 rb <- srcSpanStartLine <$> unSrcSpan (opTreeLoc r) -- right begin
143 oc <- srcSpanStartCol <$> unSrcSpan (getLoc o) -- operator column
127 oc <- srcSpanStartCol <$> unSrcSpan (getLoc o) -- operator column
144− opName <- occNameString . rdrNameOcc <$> getOpName (unLoc o)
128+ opName <- getOpName (unLoc o)
129+
145− let s
130+ let s =
146− | le < ob = AtBeginning oc
131+ if le < ob
132+ -- if the operator is in the beginning of a line, assign
133+ -- a score relative to its column within range [0, 1).
134+ then fromIntegral oc / fromIntegral (maxCol + 1)
135+ -- if the operator is in the end of the line, assign the
136+ -- score 1.
137+ else
147− | oe < rb = AtEnd
138+ if oe < rb
148− | otherwise = InBetween
139+ then 1
140+ else 2 -- otherwise, assign a high score.
149 return $ (opName, s) : score r
141 return $ (opName, s) : score r
150− selectScores :: [(String, Score)] -> [(String, Score)]
142+
151− selectScores =
143+ avgScores :: [(RdrName, Double)] -> [(RdrName, Double)]
144+ avgScores
152− L.sortOn snd
145+ = sortOn snd
153− . mapMaybe
154− ( \case
155− [] -> Nothing
156− xs@((n, _) : _) -> Just (n, selectScore $ map snd xs)
146+ . map (\xs@((n, _):_) -> (n, avg $ map snd xs))
157− )
158− . L.groupBy ((==) `on` fst)
147+ . groupBy ((==) `on` fst)
159− . L.sort
148+ . sort
160− selectScore :: [Score] -> Score
149+
161− selectScore xs =
150+ avg :: [Double] -> Double
162− case filter (/= InBetween) xs of
151+ avg i = sum i / fromIntegral (length i)
163− [] -> InBetween
152+
153+ -- The start column of the rightmost operator.
154+ maxCol = go opTree
155+ where
156+ go (OpNode (L _ _)) = 0
164− xs' -> maximum xs'
157+ go (OpBranch l (L o _) r) = maximum
158+ [ go l
159+ , maybe 0 srcSpanStartCol (unSrcSpan o)
160+ , go r
161+ ]
162+
163+ unSrcSpan (RealSrcSpan r) = Just r
164+ unSrcSpan (UnhelpfulSpan _) = Nothing
165
165
166----------------------------------------------------------------------------
166----------------------------------------------------------------------------
167-- Helpers
167-- Helpers
168
168
169-- | Convert an 'OpTree' to with all operators having the same fixity and
169-- | Convert an 'OpTree' to with all operators having the same fixity and
170-- associativity (left infix).
170-- associativity (left infix).
171+
171normalizeOpTree :: OpTree ty op -> OpTree ty op
172normalizeOpTree :: OpTree ty op -> OpTree ty op
172−normalizeOpTree (OpNode n) =
173+normalizeOpTree (OpNode n)
173− OpNode n
174+ = OpNode n
174−normalizeOpTree (OpBranch (OpNode l) lop r) =
175+normalizeOpTree (OpBranch (OpNode l) lop r)
175− OpBranch (OpNode l) lop (normalizeOpTree r)
176+ = OpBranch (OpNode l) lop (normalizeOpTree r)
176−normalizeOpTree (OpBranch (OpBranch l' lop' r') lop r) =
177+normalizeOpTree (OpBranch (OpBranch l' lop' r') lop r)
177− normalizeOpTree (OpBranch l' lop' (OpBranch r' lop r))
178+ = normalizeOpTree (OpBranch l' lop' (OpBranch r' lop r))
179+
180+fixity :: Int -> FixityDirection -> Fixity
181+fixity = Fixity NoSourceText
182+
183+doubleWithinEps :: Double -> Double -> Double -> Bool
184+doubleWithinEps eps a b = abs (a - b) < eps
src/Ormolu/Printer/SpanStream.hs+20−18
@@ -1,44 +1,46 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
1+{-# LANGUAGE DeriveDataTypeable #-}
2{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3
3
4-- | Build span stream from AST.
4-- | Build span stream from AST.
5+
5module Ormolu.Printer.SpanStream
6module Ormolu.Printer.SpanStream
6− ( SpanStream (..),
7+ ( SpanStream (..)
7− mkSpanStream,
8+ , mkSpanStream
8 )
9 )
9where
10where
10
11
11import Data.DList (DList)
12import Data.DList (DList)
12−import qualified Data.DList as D
13import Data.Data (Data)
13import Data.Data (Data)
14import Data.Generics (everything, ext2Q)
14import Data.Generics (everything, ext2Q)
15import Data.List (sortOn)
15import Data.List (sortOn)
16import Data.Typeable (cast)
16import Data.Typeable (cast)
17import SrcLoc
17import SrcLoc
18+import qualified Data.DList as D
18
19
19-- | A stream of 'RealSrcSpan's in ascending order. This allows us to tell
20-- | A stream of 'RealSrcSpan's in ascending order. This allows us to tell
20-- e.g. whether there is another \"located\" element of AST between current
21-- e.g. whether there is another \"located\" element of AST between current
21-- element and comment we're considering for printing.
22-- element and comment we're considering for printing.
23+
22newtype SpanStream = SpanStream [RealSrcSpan]
24newtype SpanStream = SpanStream [RealSrcSpan]
23 deriving (Eq, Show, Data, Semigroup, Monoid)
25 deriving (Eq, Show, Data, Semigroup, Monoid)
24
26
25-- | Create 'SpanStream' from a data structure containing \"located\"
27-- | Create 'SpanStream' from a data structure containing \"located\"
26-- elements.
28-- elements.
29+
27−mkSpanStream ::
30+mkSpanStream
28− Data a =>
31+ :: Data a
29− -- | Data structure to inspect (AST)
32+ => a -- ^ Data structure to inspect (AST)
30− a ->
31− SpanStream
33+ -> SpanStream
32−mkSpanStream a =
34+mkSpanStream a
33− SpanStream
35+ = SpanStream
34− . sortOn realSrcSpanStart
36+ . sortOn realSrcSpanStart
35− . D.toList
37+ . D.toList
36− $ everything mappend (const mempty `ext2Q` queryLocated) a
38+ $ everything mappend (const mempty `ext2Q` queryLocated) a
37 where
39 where
38− queryLocated ::
40+ queryLocated
39− (Data e0) =>
41+ :: (Data e0, Data e1)
40− GenLocated e0 e1 ->
42+ => GenLocated e0 e1
41− DList RealSrcSpan
43+ -> DList RealSrcSpan
42 queryLocated (L mspn _) =
44 queryLocated (L mspn _) =
43 case cast mspn :: Maybe SrcSpan of
45 case cast mspn :: Maybe SrcSpan of
44 Nothing -> mempty
46 Nothing -> mempty
src/Ormolu/Processing/Common.hsdeleted−27
@@ -1,27 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−-- | Common definitions for pre- and post- processing.
4−module Ormolu.Processing.Common
5− ( OrmoluState (..),
6− startDisabling,
7− endDisabling,
8− )
9−where
10−
11−import Data.String (IsString (..))
12−
13−-- | Ormolu state.
14−data OrmoluState
15− = -- | Enabled
16− OrmoluEnabled
17− | -- | Disabled
18− OrmoluDisabled
19− deriving (Eq, Show)
20−
21−-- | Marker for the beginning of the region where Ormolu should be disabled.
22−startDisabling :: IsString s => s
23−startDisabling = "{- ORMOLU_DISABLE_START"
24−
25−-- | Marker for the end of the region where Ormolu should be disabled.
26−endDisabling :: IsString s => s
27−endDisabling = "ORMOLU_DISABLE_END -}"
src/Ormolu/Processing/Cpp.hsdeleted−70
@@ -1,70 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−-- | Support for CPP.
4−module Ormolu.Processing.Cpp
5− ( State (..),
6− processLine,
7− unmaskLine,
8− )
9−where
10−
11−import Control.Monad
12−import Data.Char (isSpace)
13−import qualified Data.List as L
14−import Data.Maybe (isJust)
15−import Data.String
16−import Data.Text (Text)
17−import qualified Data.Text as T
18−
19−-- | State of the CPP processor.
20−data State
21− = -- | Outside of CPP directives
22− Outside
23− | -- | In a conditional expression
24− InConditional
25− | -- | In a continuation (after @\\@)
26− InContinuation
27− deriving (Eq, Show)
28−
29−-- | Automatically mask the line when needed and update the 'State'.
30−processLine :: String -> State -> (String, State)
31−processLine line state
32− | for "define " = (masked, state')
33− | for "include " = (masked, state')
34− | for "undef " = (masked, state')
35− | for "ifdef " = (masked, InConditional)
36− | for "ifndef " = (masked, InConditional)
37− | for "if " = (masked, InConditional)
38− | for "else" = (masked, InConditional)
39− | for "elif" = (masked, InConditional)
40− | for "endif" = (masked, state')
41− | otherwise =
42− case state of
43− Outside -> (line, Outside)
44− InConditional -> (masked, InConditional)
45− InContinuation -> (masked, state')
46− where
47− for directive = isJust $ do
48− s <- dropWhile isSpace <$> L.stripPrefix "#" line
49− void (L.stripPrefix directive s)
50− masked = maskLine line
51− state' =
52− if "\\" `L.isSuffixOf` line
53− then InContinuation
54− else Outside
55−
56−-- | Mask the given line.
57−maskLine :: String -> String
58−maskLine x = maskPrefix ++ x
59−
60−-- | If the given line is masked, unmask it. Otherwise return the line
61−-- unchanged.
62−unmaskLine :: Text -> Text
63−unmaskLine x =
64− case T.stripPrefix maskPrefix (T.stripStart x) of
65− Nothing -> x
66− Just x' -> x'
67−
68−-- | Mask prefix for CPP.
69−maskPrefix :: IsString s => s
70−maskPrefix = "-- ORMOLU_CPP_MASK"
src/Ormolu/Processing/Postprocess.hsdeleted−31
@@ -1,31 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE ViewPatterns #-}
3−
4−-- | Postprocessing for the results of printing.
5−module Ormolu.Processing.Postprocess
6− ( postprocess,
7− )
8−where
9−
10−import Data.Text (Text)
11−import qualified Data.Text as T
12−import Ormolu.Processing.Common
13−import qualified Ormolu.Processing.Cpp as Cpp
14−
15−-- | Postprocess output of the formatter.
16−postprocess ::
17− -- | Desired indentation level
18− Int ->
19− -- | Input to process
20− Text ->
21− Text
22−postprocess indent =
23− T.unlines
24− . fmap indentLine
25− . fmap Cpp.unmaskLine
26− . filter (not . magicComment)
27− . T.lines
28− where
29− magicComment (T.stripStart -> x) =
30− x == startDisabling || x == endDisabling
31− indentLine x = T.replicate indent " " <> x
src/Ormolu/Processing/Preprocess.hsdeleted−149
@@ -1,149 +0,0 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE RecordWildCards #-}
4−
5−-- | Preprocessing for input source code.
6−module Ormolu.Processing.Preprocess
7− ( preprocess,
8− )
9−where
10−
11−import Control.Monad
12−import Data.Char (isSpace)
13−import qualified Data.List as L
14−import Data.Maybe (isJust, maybeToList)
15−import FastString
16−import Ormolu.Config (RegionDeltas (..))
17−import Ormolu.Parser.Shebang (isShebang)
18−import Ormolu.Processing.Common
19−import qualified Ormolu.Processing.Cpp as Cpp
20−import SrcLoc
21−
22−-- | Transform given input possibly returning comments extracted from it.
23−-- This handles LINE pragmas, CPP, shebangs, and the magic comments for
24−-- enabling\/disabling of Ormolu.
25−preprocess ::
26− -- | File name, just to use in the spans
27− FilePath ->
28− -- | Input to process
29− String ->
30− -- | Region deltas
31− RegionDeltas ->
32− -- | Literal prefix, pre-processed input, literal suffix, extra comments
33− (String, String, String, [Located String])
34−preprocess path input RegionDeltas {..} =
35− go 1 OrmoluEnabled Cpp.Outside id id regionLines
36− where
37− (prefixLines, otherLines) = splitAt regionPrefixLength (lines input)
38− (regionLines, suffixLines) =
39− let regionLength = length otherLines - regionSuffixLength
40− in splitAt regionLength otherLines
41− go !n ormoluState cppState inputSoFar csSoFar = \case
42− [] ->
43− let input' = unlines (inputSoFar [])
44− in ( unlines prefixLines,
45− case ormoluState of
46− OrmoluEnabled -> input'
47− OrmoluDisabled -> input' ++ endDisabling,
48− unlines suffixLines,
49− csSoFar []
50− )
51− (x : xs) ->
52− let (x', ormoluState', cppState', cs) =
53− processLine path n ormoluState cppState x
54− in go
55− (n + 1)
56− ormoluState'
57− cppState'
58− (inputSoFar . (x' :))
59− (csSoFar . (maybeToList cs ++))
60− xs
61−
62−-- | Transform a given line possibly returning a comment extracted from it.
63−processLine ::
64− -- | File name, just to use in the spans
65− FilePath ->
66− -- | Line number of this line
67− Int ->
68− -- | Whether Ormolu is currently enabled
69− OrmoluState ->
70− -- | CPP state
71− Cpp.State ->
72− -- | The actual line
73− String ->
74− -- | Adjusted line and possibly a comment extracted from it
75− (String, OrmoluState, Cpp.State, Maybe (Located String))
76−processLine path n ormoluState Cpp.Outside line
77− | "{-# LINE" `L.isPrefixOf` line =
78− let (pragma, res) = getPragma line
79− size = length pragma
80− ss = mkSrcSpan (mkSrcLoc' 1) (mkSrcLoc' (size + 1))
81− in (res, ormoluState, Cpp.Outside, Just (L ss pragma))
82− | isOrmoluEnable line =
83− case ormoluState of
84− OrmoluEnabled ->
85− (enableMarker, OrmoluEnabled, Cpp.Outside, Nothing)
86− OrmoluDisabled ->
87− (endDisabling ++ enableMarker, OrmoluEnabled, Cpp.Outside, Nothing)
88− | isOrmoluDisable line =
89− case ormoluState of
90− OrmoluEnabled ->
91− (disableMarker ++ startDisabling, OrmoluDisabled, Cpp.Outside, Nothing)
92− OrmoluDisabled ->
93− (disableMarker, OrmoluDisabled, Cpp.Outside, Nothing)
94− | isShebang line =
95− let ss = mkSrcSpan (mkSrcLoc' 1) (mkSrcLoc' (length line))
96− in ("", ormoluState, Cpp.Outside, Just (L ss line))
97− | otherwise =
98− let (line', cppState') = Cpp.processLine line Cpp.Outside
99− in (line', ormoluState, cppState', Nothing)
100− where
101− mkSrcLoc' = mkSrcLoc (mkFastString path) n
102−processLine _ _ ormoluState cppState line =
103− let (line', cppState') = Cpp.processLine line cppState
104− in (line', ormoluState, cppState', Nothing)
105−
106−-- | Take a line pragma and output its replacement (where line pragma is
107−-- replaced with spaces) and the contents of the pragma itself.
108−getPragma ::
109− -- | Pragma line to analyze
110− String ->
111− -- | Contents of the pragma and its replacement line
112− (String, String)
113−getPragma [] = error "Ormolu.Preprocess.getPragma: input must not be empty"
114−getPragma s@(x : xs)
115− | "#-}" `L.isPrefixOf` s = ("#-}", " " ++ drop 3 s)
116− | otherwise =
117− let (prag, remline) = getPragma xs
118− in (x : prag, ' ' : remline)
119−
120−-- | Canonical enable marker.
121−enableMarker :: String
122−enableMarker = "{- ORMOLU_ENABLE -}"
123−
124−-- | Canonical disable marker.
125−disableMarker :: String
126−disableMarker = "{- ORMOLU_DISABLE -}"
127−
128−-- | Return 'True' if the given string is an enabling marker.
129−isOrmoluEnable :: String -> Bool
130−isOrmoluEnable = magicComment "ORMOLU_ENABLE"
131−
132−-- | Return 'True' if the given string is a disabling marker.
133−isOrmoluDisable :: String -> Bool
134−isOrmoluDisable = magicComment "ORMOLU_DISABLE"
135−
136−-- | Construct a function for whitespace-insensitive matching of string.
137−magicComment ::
138− -- | What to expect
139− String ->
140− -- | String to test
141− String ->
142− -- | Whether or not the two strings watch
143− Bool
144−magicComment expected s0 = isJust $ do
145− let trim = dropWhile isSpace
146− s1 <- trim <$> L.stripPrefix "{-" (trim s0)
147− s2 <- trim <$> L.stripPrefix expected s1
148− s3 <- L.stripPrefix "-}" s2
149− guard (all isSpace s3)
src/Ormolu/Utils.hs+33−109
@@ -1,82 +1,61 @@
1+-- | Random utilities used by the code.
2+
1−{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
4{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE ViewPatterns #-}
4
5
5−-- | Random utilities used by the code.
6module Ormolu.Utils
6module Ormolu.Utils
7− ( RelativePos (..),
8− attachRelativePos,
9− combineSrcSpans',
7+ ( combineSrcSpans'
8+ , isModule
10− notImplemented,
9+ , notImplemented
11− showOutputable,
10+ , showOutputable
12− splitDocString,
11+ , splitDocString
13− typeArgToType,
14− unSrcSpan,
15− incSpanLine,
16− separatedByBlank,
17− separatedByBlankNE,
18− onTheSameLine,
19− removeIndentation,
20 )
12 )
21where
13where
22
14
23−import Data.Char (isSpace)
15+import Data.Data (Data, showConstr, toConstr)
24import Data.List (dropWhileEnd)
16import Data.List (dropWhileEnd)
25import Data.List.NonEmpty (NonEmpty (..))
17import Data.List.NonEmpty (NonEmpty (..))
26−import qualified Data.List.NonEmpty as NE
27−import Data.Maybe (fromMaybe)
28import Data.Text (Text)
18import Data.Text (Text)
19+import HsDoc (HsDocString, unpackHDS)
20+import SrcLoc
29import qualified Data.Text as T
21import qualified Data.Text as T
30−import GHC
31−import GHC.DynFlags (baseDynFlags)
32import qualified Outputable as GHC
22import qualified Outputable as GHC
33
23
34−-- | Relative positions in a list.
35−data RelativePos
36− = SinglePos
37− | FirstPos
38− | MiddlePos
39− | LastPos
40− deriving (Eq, Show)
41−
42−-- | Attach 'RelativePos'es to elements of a given list.
43−attachRelativePos :: [a] -> [(RelativePos, a)]
44−attachRelativePos = \case
45− [] -> []
46− [x] -> [(SinglePos, x)]
47− (x : xs) -> (FirstPos, x) : markLast xs
48− where
49− markLast [] = []
50− markLast [x] = [(LastPos, x)]
51− markLast (x : xs) = (MiddlePos, x) : markLast xs
52−
53-- | Combine all source spans from the given list.
24-- | Combine all source spans from the given list.
25+
54combineSrcSpans' :: NonEmpty SrcSpan -> SrcSpan
26combineSrcSpans' :: NonEmpty SrcSpan -> SrcSpan
55−combineSrcSpans' (x :| xs) = foldr combineSrcSpans x xs
27+combineSrcSpans' (x:|xs) = foldr combineSrcSpans x xs
28+
29+-- | Return 'True' if given element of AST is module.
30+
31+isModule :: Data a => a -> Bool
32+isModule x = showConstr (toConstr x) == "HsModule"
56
33
57-- | Placeholder for things that are not yet implemented.
34-- | Placeholder for things that are not yet implemented.
35+
58notImplemented :: String -> a
36notImplemented :: String -> a
59notImplemented msg = error $ "not implemented yet: " ++ msg
37notImplemented msg = error $ "not implemented yet: " ++ msg
60
38
61-- | Pretty-print an 'GHC.Outputable' thing.
39-- | Pretty-print an 'GHC.Outputable' thing.
40+
62showOutputable :: GHC.Outputable o => o -> String
41showOutputable :: GHC.Outputable o => o -> String
63−showOutputable = GHC.showSDoc baseDynFlags . GHC.ppr
42+showOutputable = GHC.showSDocUnsafe . GHC.ppr
64
43
65-- | Split and normalize a doc string. The result is a list of lines that
44-- | Split and normalize a doc string. The result is a list of lines that
66-- make up the comment.
45-- make up the comment.
46+
67splitDocString :: HsDocString -> [Text]
47splitDocString :: HsDocString -> [Text]
68splitDocString docStr =
48splitDocString docStr =
69 case r of
49 case r of
70 [] -> [""]
50 [] -> [""]
71− _ -> r
51+ _ -> r
72 where
52 where
73− r =
74− fmap escapeLeadingDollar
53+ r = fmap escapeLeadingDollar
75− . dropPaddingSpace
54+ . dropPaddingSpace
76− . dropWhileEnd T.null
55+ . dropWhileEnd T.null
77− . fmap (T.stripEnd . T.pack)
56+ . fmap (T.stripEnd . T.pack)
78− . lines
57+ . lines
79− $ unpackHDS docStr
58+ $ unpackHDS docStr
80 -- We cannot have the first character to be a dollar because in that
59 -- We cannot have the first character to be a dollar because in that
81 -- case it'll be a parse error (apparently collides with named docs
60 -- case it'll be a parse error (apparently collides with named docs
82 -- syntax @-- $name@ somehow).
61 -- syntax @-- $name@ somehow).
@@ -87,7 +66,7 @@ splitDocString docStr =
87 dropPaddingSpace xs =
66 dropPaddingSpace xs =
88 case dropWhile T.null xs of
67 case dropWhile T.null xs of
89 [] -> []
68 [] -> []
90− (x : _) ->
69+ (x:_) ->
91 let leadingSpace txt = case T.uncons txt of
70 let leadingSpace txt = case T.uncons txt of
92 Just (' ', _) -> True
71 Just (' ', _) -> True
93 _ -> False
72 _ -> False
@@ -95,61 +74,6 @@ splitDocString docStr =
95 if leadingSpace txt
74 if leadingSpace txt
96 then T.drop 1 txt
75 then T.drop 1 txt
97 else txt
76 else txt
98− in if leadingSpace x
77+ in if leadingSpace x
99− then dropSpace <$> xs
78+ then dropSpace <$> xs
100− else xs
79+ else xs
101−
102−-- | Get 'LHsType' out of 'LHsTypeArg'.
103−typeArgToType :: LHsTypeArg p -> LHsType p
104−typeArgToType = \case
105− HsValArg tm -> tm
106− HsTypeArg _ ty -> ty
107− HsArgPar _ -> notImplemented "HsArgPar"
108−
109−-- | Get 'RealSrcSpan' out of 'SrcSpan' if the span is “helpful”.
110−unSrcSpan :: SrcSpan -> Maybe RealSrcSpan
111−unSrcSpan = \case
112− RealSrcSpan r -> Just r
113− UnhelpfulSpan _ -> Nothing
114−
115−-- | Increment line number in a 'SrcSpan'.
116−incSpanLine :: Int -> SrcSpan -> SrcSpan
117−incSpanLine i = \case
118− RealSrcSpan s ->
119− let start = realSrcSpanStart s
120− end = realSrcSpanEnd s
121− incLine x =
122− let file = srcLocFile x
123− line = srcLocLine x
124− col = srcLocCol x
125− in mkRealSrcLoc file (line + i) col
126− in RealSrcSpan (mkRealSrcSpan (incLine start) (incLine end))
127− UnhelpfulSpan x -> UnhelpfulSpan x
128−
129−-- | Do two declarations have a blank between them?
130−separatedByBlank :: (a -> SrcSpan) -> a -> a -> Bool
131−separatedByBlank loc a b =
132− fromMaybe False $ do
133− endA <- srcSpanEndLine <$> unSrcSpan (loc a)
134− startB <- srcSpanStartLine <$> unSrcSpan (loc b)
135− pure (startB - endA >= 2)
136−
137−-- | Do two declaration groups have a blank between them?
138−separatedByBlankNE :: (a -> SrcSpan) -> NonEmpty a -> NonEmpty a -> Bool
139−separatedByBlankNE loc a b = separatedByBlank loc (NE.last a) (NE.head b)
140−
141−-- | Return 'True' if one span ends on the same line the second one starts.
142−onTheSameLine :: SrcSpan -> SrcSpan -> Bool
143−onTheSameLine a b =
144− isOneLineSpan (mkSrcSpan (srcSpanEnd a) (srcSpanStart b))
145−
146−-- | Remove indentation from a given 'String'. Return the input with
147−-- indentation removed and the detected indentation level.
148−removeIndentation :: String -> (String, Int)
149−removeIndentation (lines -> xs) = (unlines (drop n <$> xs), n)
150− where
151− n = minimum (getIndent <$> xs)
152− getIndent y =
153− if all isSpace y
154− then 0
155− else length (takeWhile isSpace y)
tests/Ormolu/Parser/PragmaSpec.hs+3−4
@@ -4,7 +4,7 @@ import Ormolu.Parser.Pragma
4import Test.Hspec
4import Test.Hspec
5
5
6spec :: Spec
6spec :: Spec
7−spec =
7+spec = do
8 describe "parsePragma" $ do
8 describe "parsePragma" $ do
9 stdTest "{-# LANGUAGE Foo #-}" (Just (PragmaLanguage ["Foo"]))
9 stdTest "{-# LANGUAGE Foo #-}" (Just (PragmaLanguage ["Foo"]))
10 stdTest "{-# language Foo #-}" (Just (PragmaLanguage ["Foo"]))
10 stdTest "{-# language Foo #-}" (Just (PragmaLanguage ["Foo"]))
@@ -21,6 +21,5 @@ spec =
21 stdTest "{-#OPTIONS_HADDOCK foo, bar, baz #-}" (Just $ PragmaOptionsHaddock "foo, bar, baz")
21 stdTest "{-#OPTIONS_HADDOCK foo, bar, baz #-}" (Just $ PragmaOptionsHaddock "foo, bar, baz")
22
22
23stdTest :: String -> Maybe Pragma -> Spec
23stdTest :: String -> Maybe Pragma -> Spec
24−stdTest input result =
24+stdTest input result = it input $
25− it input $
26− parsePragma input `shouldBe` result
25+ parsePragma input `shouldBe` result
tests/Ormolu/PrinterSpec.hs+25−22
@@ -7,13 +7,13 @@ import Control.Monad
7import Control.Monad.IO.Class
7import Control.Monad.IO.Class
8import Data.List (isSuffixOf)
8import Data.List (isSuffixOf)
9import Data.Text (Text)
9import Data.Text (Text)
10−import qualified Data.Text as T
11−import qualified Data.Text.IO as T
12import Ormolu
10import Ormolu
13import Path
11import Path
14import Path.IO
12import Path.IO
15−import qualified System.FilePath as F
13+import System.FilePath (addExtension, dropExtensions, splitExtensions)
16import Test.Hspec
14import Test.Hspec
15+import qualified Data.Text as T
16+import qualified Data.Text.IO as T
17
17
18spec :: Spec
18spec :: Spec
19spec = do
19spec = do
@@ -21,6 +21,7 @@ spec = do
21 forM_ es checkExample
21 forM_ es checkExample
22
22
23-- | Check a single given example.
23-- | Check a single given example.
24+
24checkExample :: Path Rel File -> Spec
25checkExample :: Path Rel File -> Spec
25checkExample srcPath' = it (fromRelFile srcPath' ++ " works") . withNiceExceptions $ do
26checkExample srcPath' = it (fromRelFile srcPath' ++ " works") . withNiceExceptions $ do
26 let srcPath = examplesDir </> srcPath'
27 let srcPath = examplesDir </> srcPath'
@@ -41,39 +42,41 @@ checkExample srcPath' = it (fromRelFile srcPath' ++ " works") . withNiceExceptio
41 shouldMatch True formatted1 formatted0
42 shouldMatch True formatted1 formatted0
42
43
43-- | Build list of examples for testing.
44-- | Build list of examples for testing.
45+
44locateExamples :: IO [Path Rel File]
46locateExamples :: IO [Path Rel File]
45locateExamples =
47locateExamples =
46 filter isInput . snd <$> listDirRecurRel examplesDir
48 filter isInput . snd <$> listDirRecurRel examplesDir
47
49
48-- | Does given path look like input path (as opposed to expected output
50-- | Does given path look like input path (as opposed to expected output
49-- path)?
51-- path)?
52+
50isInput :: Path Rel File -> Bool
53isInput :: Path Rel File -> Bool
51isInput path =
54isInput path =
52 let s = fromRelFile path
55 let s = fromRelFile path
53− (s', exts) = F.splitExtensions s
56+ (s', exts) = splitExtensions s
54− in exts == ".hs" && not ("-out" `isSuffixOf` s')
57+ in exts == ".hs" && not ("-out" `isSuffixOf` s')
55
58
56-- | For given path of input file return expected name of output.
59-- | For given path of input file return expected name of output.
60+
57deriveOutput :: Path Rel File -> IO (Path Rel File)
61deriveOutput :: Path Rel File -> IO (Path Rel File)
58−deriveOutput path =
62+deriveOutput path = parseRelFile $
59− parseRelFile $
60− F.addExtension (F.dropExtensions (fromRelFile path) ++ "-out") "hs"
63+ addExtension (dropExtensions (fromRelFile path) ++ "-out") "hs"
61
64
62-- | A version of 'shouldBe' that is specialized to comparing 'Text' values.
65-- | A version of 'shouldBe' that is specialized to comparing 'Text' values.
63-- It also prints multi-line snippets in a more readable form.
66-- It also prints multi-line snippets in a more readable form.
67+
64shouldMatch :: Bool -> Text -> Text -> Expectation
68shouldMatch :: Bool -> Text -> Text -> Expectation
65−shouldMatch idempotenceTest actual expected =
69+shouldMatch idempotencyTest actual expected =
66− when (actual /= expected) . expectationFailure $
70+ when (actual /= expected) . expectationFailure $ unlines
67− unlines
68− [ ">>>>>>>>>>>>>>>>>>>>>> expected (" ++ pass ++ "):",
71+ [ ">>>>>>>>>>>>>>>>>>>>>> expected (" ++ pass ++ "):"
69− T.unpack expected,
72+ , T.unpack expected
70− ">>>>>>>>>>>>>>>>>>>>>> but got:",
73+ , ">>>>>>>>>>>>>>>>>>>>>> but got:"
71− T.unpack actual
74+ , T.unpack actual
72− ]
75+ ]
73 where
76 where
74 pass =
77 pass =
75− if idempotenceTest
78+ if idempotencyTest
76− then "idempotence pass"
79+ then "idempotency pass"
77 else "first pass"
80 else "first pass"
78
81
79examplesDir :: Path Rel Dir
82examplesDir :: Path Rel Dir
@@ -81,10 +84,10 @@ examplesDir = $(mkRelDir "data/examples")
81
84
82-- | Inside this wrapper 'OrmoluException' will be caught and displayed
85-- | Inside this wrapper 'OrmoluException' will be caught and displayed
83-- nicely using 'displayException'.
86-- nicely using 'displayException'.
87+
84−withNiceExceptions ::
88+withNiceExceptions
85− -- | Action that may throw the exception
89+ :: Expectation -- ^ Action that may throw the exception
86− Expectation ->
87− Expectation
90+ -> Expectation
88withNiceExceptions m = m `catch` h
91withNiceExceptions m = m `catch` h
89 where
92 where
90 h :: OrmoluException -> IO ()
93 h :: OrmoluException -> IO ()