on master help sign in
.buildkite/pipeline.yml+2−2
since splitsnapshots
unifiedsplit
@@ -3,9 +3,9 @@ steps:
3 command: |
3 command: |
4 nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc865
4 nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc865
5 timeout: 100
5 timeout: 100
6− - label: Build and test with GHC 8.8.3
6+ - label: Build and test with GHC 8.8.4
7 command: |
7 command: |
8− nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc883
8+ nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc884
9 timeout: 100
9 timeout: 100
10 - label: Build and test with GHC 8.10.1
10 - label: Build and test with GHC 8.10.1
11 command: |
11 command: |
.github/workflows/binaries.ymlnew file+39
@@ -0,0 +1,39 @@
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.shnew file+7
@@ -0,0 +1,7 @@
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
CHANGELOG.md+104
@@ -1,5 +1,102 @@
1## Unreleased
1## Unreleased
2
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+
3* Grouping of statements in `do`-blocks is now preserved. [Issue
100* Grouping of statements in `do`-blocks is now preserved. [Issue
4 74](https://github.com/tweag/ormolu/issues/74).
101 74](https://github.com/tweag/ormolu/issues/74).
5
102
@@ -15,6 +112,13 @@
15* Added experimental support for simple CPP. [Issue
112* Added experimental support for simple CPP. [Issue
16 415](https://github.com/tweag/ormolu/issues/415).
113 415](https://github.com/tweag/ormolu/issues/415).
17
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+
18## Ormolu 0.0.4.0
122## Ormolu 0.0.4.0
19
123
20* When given several files to format, Ormolu does not stop on the first
124* When given several files to format, Ormolu does not stop on the first
CONTRIBUTING.md+1−1
@@ -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−* Idempotency property is verified: formatting already formatted code
33+* Idempotence 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
DESIGN.md+11−11
@@ -24,7 +24,7 @@ It also includes recommendations for future implementers.
24
24
25We set for the following goals (mostly taken from
25We set for the following goals (mostly taken from
26[brittany](https://github.com/lspitzner/brittany)):
26[brittany](https://github.com/lspitzner/brittany)):
27−* Preserve the meaning of the formatted functions;
27+* Preserve the meaning of the formatted functions when no CPP is used;
28* Make reasonable use of screen space;
28* Make reasonable use of screen space;
29* Use linear space and computation time on the size of the input;
29* Use linear space and computation time on the size of the input;
30* Preserve comments;
30* Preserve comments;
@@ -140,8 +140,10 @@ impossible to guess what they'll be called on.
140
140
141### CPP
141### CPP
142
142
143−Formatting a module which uses CPP directives won't be supported. Instead,
143+We allow CPP directives in the input, but we forgo the goal to preserve the
144+meaning of the formatted functions in that case.
145+Instead of supporting CPP better, we hope for a solution to replace CPP to
144−we hope for a solution to replace CPP to do conditional compilation.
146+do conditional compilation.
145
147
146There are the following challenges when formatting a module with CPP:
148There are the following challenges when formatting a module with CPP:
147
149
@@ -180,14 +182,15 @@ True
180```
182```
181
183
182At the time of this writing, formatting this program with Hindent
184At the time of this writing, formatting this program with Hindent
183−produces the same output we would get if the CPP directives were
185+or Ormolu produces the same output we would get if the CPP directives
184−considered comments:
186+were considered comments:
185
187
186```
188```
187−$ hindent --version
189+$ ormolu --version
188−hindent 5.2.7
190+ormolu 0.0.5.0 HEAD fc64eada5c4da7a5b07d2872e253671b48aec115
191+using ghc-lib-parser 8.10.1.20200412
189
192
190−$ hindent test.hs
193+$ ormolu --mode inplace test.hs
191
194
192$ cat test.hs
195$ cat test.hs
193{-# LANGUAGE CPP #-}
196{-# LANGUAGE CPP #-}
@@ -227,9 +230,6 @@ to parse Haskell modules. If CPP is replaced with some language
227extension or mechanism to do conditional compilation, all tools
230extension or mechanism to do conditional compilation, all tools
228will benefit from it.
231will benefit from it.
229
232
230−Therefore, CPP won't be supported. If the CPP extension
231−is enabled, we should signal an error right away.
232−
233### Printing
233### Printing
234
234
235Just pretty-printing code (following the approach of Hindent) seems sane. It
235Just pretty-printing code (following the approach of Hindent) seems sane. It
README.md+31−14
@@ -22,7 +22,7 @@ the following goals in mind:
22* That formatting style aims to result in minimal diffs while still
22* That formatting style aims to result in minimal diffs while still
23 remaining very close to “conventional” Haskell formatting people use.
23 remaining very close to “conventional” Haskell formatting people use.
24* Choose a style compatible with modern dialects of Haskell. As new Haskell
24* Choose a style compatible with modern dialects of Haskell. As new Haskell
25− extensions enter broad use, we may change the style to accomodate them.
25+ extensions enter broad use, we may change the style to accommodate them.
26* Idempotence: formatting already formatted code doesn't change it.
26* Idempotence: formatting already formatted code doesn't change it.
27* Be well-tested and robust to the point that it can be used in large
27* 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.
28 projects without exposing unfortunate, disappointing bugs here and there.
@@ -45,11 +45,12 @@ Alternatively, `stack` could be used with a `stack.yaml` file as follows.
45
45
46```console
46```console
47$ cat stack.yaml
47$ cat stack.yaml
48−resolver: lts-14.3
48+resolver: lts-16.0
49packages:
49packages:
50- '.'
50- '.'
51
51
52−$ stack build
52+$ stack build # to build
53+$ stack install # to install
53```
54```
54
55
55To use Ormolu directly from GitHub with Nix, this snippet may come in handy:
56To use Ormolu directly from GitHub with Nix, this snippet may come in handy:
@@ -91,6 +92,12 @@ formatted output.
91$ ormolu --mode inplace Module.hs
92$ ormolu --mode inplace Module.hs
92```
93```
93
94
95+Use `find` to format a tree recursively:
96+
97+```console
98+$ ormolu --mode inplace $(find . -name '*.hs')
99+```
100+
94## Magic comments
101## Magic comments
95
102
96Ormolu understands two magic comments:
103Ormolu understands two magic comments:
@@ -116,20 +123,13 @@ independent top-level definitions.
116
123
117* CPP support is experimental. CPP is virtually impossible to handle
124* CPP support is experimental. CPP is virtually impossible to handle
118 correctly, so we process them as a sort of unchangeable snippets. This
125 correctly, so we process them as a sort of unchangeable snippets. This
119− works only in simple cases when CPP conditionals are self-contained. Use
126+ works only in simple cases when CPP conditionals surround top-level
120− Ormolu with CPP at your own risk.
127+ declarations. See the [CPP][design-cpp] section in the design notes for
128+ a discussion of the dangers.
121* Input modules should be parsable by Haddock, which is a bit stricter
129* Input modules should be parsable by Haddock, which is a bit stricter
122 criterion than just being valid Haskell modules.
130 criterion than just being valid Haskell modules.
123* Various minor idempotence issues, most of them are related to comments.
131* Various minor idempotence issues, most of them are related to comments.
124
132
125−## Editor integration
126−
127−We know of the following editor integrations:
128−
129−* [Emacs][emacs-package]
130−* [VS Code][vs-code-plugin]
131−* vim: [neoformat][neoformat], [vim-ormolu][vim-ormolu]
132−
133## Running on Hackage
133## Running on Hackage
134
134
135It's possible to try Ormolu on arbitrary packages from Hackage. For that
135It's possible to try Ormolu on arbitrary packages from Hackage. For that
@@ -144,6 +144,22 @@ also contain formatted `.hs` files for inspection and original inputs with
144`.hs-original` extension (those are with CPP dropped, exactly what is fed
144`.hs-original` extension (those are with CPP dropped, exactly what is fed
145into Ormolu).
145into Ormolu).
146
146
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+
147## Contributing
163## Contributing
148
164
149See [CONTRIBUTING.md][contributing].
165See [CONTRIBUTING.md][contributing].
@@ -154,7 +170,7 @@ See [LICENSE.md][license].
154
170
155Copyright © 2018–present Tweag I/O
171Copyright © 2018–present Tweag I/O
156
172
157−[design]: https://github.com/tweag/ormolu/blob/master/DESIGN.md#cpp
173+[design-cpp]: https://github.com/tweag/ormolu/blob/master/DESIGN.md#cpp
158[contributing]: https://github.com/tweag/ormolu/blob/master/CONTRIBUTING.md
174[contributing]: https://github.com/tweag/ormolu/blob/master/CONTRIBUTING.md
159[license]: https://github.com/tweag/ormolu/blob/master/LICENSE.md
175[license]: https://github.com/tweag/ormolu/blob/master/LICENSE.md
160[haskell-src-exts]: https://hackage.haskell.org/package/haskell-src-exts
176[haskell-src-exts]: https://hackage.haskell.org/package/haskell-src-exts
@@ -162,3 +178,4 @@ Copyright © 2018–present Tweag I/O
162[vs-code-plugin]: https://marketplace.visualstudio.com/items?itemName=sjurmillidahl.ormolu-vscode
178[vs-code-plugin]: https://marketplace.visualstudio.com/items?itemName=sjurmillidahl.ormolu-vscode
163[vim-ormolu]: https://github.com/sdiehl/vim-ormolu
179[vim-ormolu]: https://github.com/sdiehl/vim-ormolu
164[neoformat]: https://github.com/sbdchd/neoformat
180[neoformat]: https://github.com/sbdchd/neoformat
181+[aur]: https://aur.archlinux.org/packages/ormolu
app/Main.hs+40−21
@@ -4,13 +4,11 @@
4{-# LANGUAGE TemplateHaskell #-}
4{-# LANGUAGE TemplateHaskell #-}
5{-# LANGUAGE TypeApplications #-}
5{-# LANGUAGE TypeApplications #-}
6
6
7−module Main
7+module Main (main) where
8− ( main,
9− )
10−where
11
8
12import Control.Exception (SomeException, displayException, try)
9import Control.Exception (SomeException, displayException, try)
13import Control.Monad
10import Control.Monad
11+import Data.Bool (bool)
14import Data.Either (lefts)
12import Data.Either (lefts)
15import Data.List (intercalate, sort)
13import Data.List (intercalate, sort)
16import qualified Data.Text.IO as TIO
14import qualified Data.Text.IO as TIO
@@ -47,7 +45,7 @@ formatOne ::
47 -- | Mode of operation
45 -- | Mode of operation
48 Mode ->
46 Mode ->
49 -- | Configuration
47 -- | Configuration
50− Config ->
48+ Config RegionIndices ->
51 -- | File to format or stdin as 'Nothing'
49 -- | File to format or stdin as 'Nothing'
52 Maybe FilePath ->
50 Maybe FilePath ->
53 IO ()
51 IO ()
@@ -63,15 +61,19 @@ formatOne mode config = \case
63 -- 101 is different from all the other exit codes we already use.
61 -- 101 is different from all the other exit codes we already use.
64 exitWith (ExitFailure 101)
62 exitWith (ExitFailure 101)
65 Just inputFile -> do
63 Just inputFile -> do
64+ originalInput <- TIO.readFile inputFile
66− r <- ormoluFile config inputFile
65+ formattedInput <- ormoluFile config inputFile
67 case mode of
66 case mode of
68 Stdout ->
67 Stdout ->
69− TIO.putStr r
68+ TIO.putStr formattedInput
70− InPlace ->
69+ InPlace -> do
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) $
71− TIO.writeFile inputFile r
74+ TIO.writeFile inputFile formattedInput
72 Check -> do
75 Check -> do
73− r' <- TIO.readFile inputFile
76+ when (formattedInput /= originalInput) $
74− when (r /= r') $
75 -- 100 is different to all the other exit code that are emitted
77 -- 100 is different to all the other exit code that are emitted
76 -- either from an 'OrmoluException' or from 'error' and
78 -- either from an 'OrmoluException' or from 'error' and
77 -- 'notImplemented'.
79 -- 'notImplemented'.
@@ -84,7 +86,7 @@ data Opts = Opts
84 { -- | Mode of operation
86 { -- | Mode of operation
85 optMode :: !Mode,
87 optMode :: !Mode,
86 -- | Ormolu 'Config'
88 -- | Ormolu 'Config'
87− optConfig :: !Config,
89+ optConfig :: !(Config RegionIndices),
88 -- | Haskell source files to format or stdin (when the list is empty)
90 -- | Haskell source files to format or stdin (when the list is empty)
89 optInputFiles :: ![FilePath]
91 optInputFiles :: ![FilePath]
90 }
92 }
@@ -137,20 +139,25 @@ optsParserInfo =
137optsParser :: Parser Opts
139optsParser :: Parser Opts
138optsParser =
140optsParser =
139 Opts
141 Opts
142+ <$> ( (fmap (bool Stdout InPlace) . switch . mconcat)
143+ [ short 'i',
144+ help "A shortcut for --mode inplace"
145+ ]
140− <$> (option parseMode . mconcat)
146+ <|> (option parseMode . mconcat)
141− [ long "mode",
147+ [ long "mode",
142− short 'm',
148+ short 'm',
143− metavar "MODE",
149+ metavar "MODE",
144− value Stdout,
150+ value Stdout,
145− help "Mode of operation: 'stdout' (default), 'inplace', or 'check'"
151+ help "Mode of operation: 'stdout' (default), 'inplace', or 'check'"
146− ]
152+ ]
153+ )
147 <*> configParser
154 <*> configParser
148 <*> (many . strArgument . mconcat)
155 <*> (many . strArgument . mconcat)
149 [ metavar "FILE",
156 [ metavar "FILE",
150 help "Haskell source files to format or stdin (default)"
157 help "Haskell source files to format or stdin (default)"
151 ]
158 ]
152
159
153−configParser :: Parser Config
160+configParser :: Parser (Config RegionIndices)
154configParser =
161configParser =
155 Config
162 Config
156 <$> (fmap (fmap DynOption) . many . strOption . mconcat)
163 <$> (fmap (fmap DynOption) . many . strOption . mconcat)
@@ -170,10 +177,22 @@ configParser =
170 help "Output information useful for debugging"
177 help "Output information useful for debugging"
171 ]
178 ]
172 <*> (switch . mconcat)
179 <*> (switch . mconcat)
173− [ long "check-idempotency",
180+ [ long "check-idempotence",
174 short 'c',
181 short 'c',
175 help "Fail if formatting is not idempotent"
182 help "Fail if formatting is not idempotent"
176 ]
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+ ]
190+ <*> (optional . option auto . mconcat)
191+ [ long "end-line",
192+ metavar "END",
193+ help "End line of the region to format (inclusive)"
194+ ]
195+ )
177
196
178----------------------------------------------------------------------------
197----------------------------------------------------------------------------
179-- Helpers
198-- Helpers
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/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/partly-documented-out.hsnew file+5
@@ -0,0 +1,5 @@
1+data Optimisation
2+ = PETransform
3+ | -- | partial eval and associated transforms
4+ GeneralisedNatHack
5+ deriving (Show, Eq, Generic)
data/examples/declaration/data/partly-documented.hsnew file+2
@@ -0,0 +1,2 @@
1+data Optimisation = PETransform | GeneralisedNatHack -- ^ partial eval and associated transforms
2+ deriving (Show, Eq, Generic)
data/examples/declaration/data/unnamed-field-comment-0-out.hsnew file+7
@@ -0,0 +1,7 @@
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.hsnew file+5
@@ -0,0 +1,5 @@
1+data Foo
2+ = -- | Bar
3+ Bar
4+ Field1 -- ^ Field 1
5+ Field2 -- ^ Field 2
data/examples/declaration/data/unnamed-field-comment-1-out.hsnew file+5
@@ -0,0 +1,5 @@
1+data X
2+ = B
3+ !Int
4+ -- ^ y
5+ C
data/examples/declaration/data/unnamed-field-comment-1.hsnew file+4
@@ -0,0 +1,4 @@
1+data X
2+ = B
3+ !Int -- ^ y
4+ C
data/examples/declaration/data/with-comment-out.hsnew file+4
@@ -0,0 +1,4 @@
1+data A
2+ = B -- C
3+ | -- D
4+ E
data/examples/declaration/data/with-comment.hsnew file+5
@@ -0,0 +1,5 @@
1+data A =
2+ B -- C
3+
4+ -- D
5+ | E
data/examples/declaration/data/with-weird-haddock-out.hsnew file+4
@@ -0,0 +1,4 @@
1+data PlusLevel' t
2+ = -- | @n + ℓ@.
3+ Plus Integer (LevelAtom' t)
4+ deriving (Show, Data)
data/examples/declaration/data/with-weird-haddock.hsnew file+2
@@ -0,0 +1,2 @@
1+data PlusLevel' t = Plus Integer (LevelAtom' t) -- ^ @n + ℓ@.
2+ deriving (Show, Data)
data/examples/declaration/signature/type/infix-promoted-type-constructor-out.hs−1
@@ -1,3 +1,2 @@
1fun1 :: Def ('[Ref s (Stored Uint32), IBool] 'T.:-> IBool)
1fun1 :: Def ('[Ref s (Stored Uint32), IBool] 'T.:-> IBool)
2−
3fun2 :: Def ('[Ref s (Stored Uint32), IBool] ':-> IBool)
2fun2 :: Def ('[Ref s (Stored Uint32), IBool] ':-> IBool)
data/examples/declaration/signature/type/multi-value-out.hs+5
@@ -2,6 +2,11 @@ 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+
5foo,
10foo,
6 bar,
11 bar,
7 baz ::
12 baz ::
data/examples/declaration/signature/type/multi-value.hs+5
@@ -2,6 +2,11 @@ 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+
5foo,
10foo,
6 bar,
11 bar,
7 baz :: Int
12 baz :: Int
data/examples/declaration/signature/type/unrelated-out.hsnew file+4
@@ -0,0 +1,4 @@
1+clientFunc1 :: SomeType1
2+clientFunc2 :: SomeType2
3+clientFunc3 :: SomeType3
4+clientFunc1 :<|> clientFunc2 :<|> clientFunc3 = hoistClient foo bar baz
data/examples/declaration/signature/type/unrelated.hsnew file+4
@@ -0,0 +1,4 @@
1+clientFunc1 :: SomeType1
2+clientFunc2 :: SomeType2
3+clientFunc3 :: SomeType3
4+clientFunc1 :<|> clientFunc2 :<|> clientFunc3 = hoistClient foo bar baz
data/examples/declaration/type-synonyms/with-weird-haddock-out.hsnew file+3
@@ -0,0 +1,3 @@
1+type Elims =
2+ -- | eliminations ordered left-to-right.
3+ [Elim]
data/examples/declaration/type-synonyms/with-weird-haddock.hsnew file+1
@@ -0,0 +1 @@
1+type Elims = [Elim] -- ^ eliminations ordered left-to-right.
data/examples/declaration/value/function/arg-breakpoints-out.hsnew file+3
@@ -0,0 +1,3 @@
1+foo
2+ bar =
3+ body
data/examples/declaration/value/function/arg-breakpoints.hsnew file+3
@@ -0,0 +1,3 @@
1+foo
2+ bar =
3+ body
data/examples/declaration/value/function/arrow/proc-do-complex-out.hs+1−1
@@ -40,7 +40,7 @@ foo
40 )
40 )
41 else do
41 else do
42 let u = x -- Let bindings bind expressions, not commands
42 let u = x -- Let bindings bind expressions, not commands
43− -- Could pattern match directly on x
43+ -- Could pattern match directly on x
44 i <- case u of
44 i <- case u of
45 0 -> (g . h -< u)
45 0 -> (g . h -< u)
46 n ->
46 n ->
data/examples/declaration/value/function/awkward-comment-0-out.hsnew file+6
@@ -0,0 +1,6 @@
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.hsnew file+5
@@ -0,0 +1,5 @@
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.hsnew file+9
@@ -0,0 +1,9 @@
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.hsnew file+7
@@ -0,0 +1,7 @@
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.hsnew file+6
@@ -0,0 +1,6 @@
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.hsnew file+9
@@ -0,0 +1,9 @@
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.hsnew file+6
@@ -0,0 +1,6 @@
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.hsnew file+7
@@ -0,0 +1,7 @@
1+foo = x + y + z
2+ where
3+
4+ x = 10
5+
6+ y = 11
7+ z = 12
data/examples/declaration/value/function/if-with-comment-out.hsnew file+8
@@ -0,0 +1,8 @@
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.hsnew file+8
@@ -0,0 +1,8 @@
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,6 +1,7 @@
1{-# LANGUAGE ImplicitParams #-}
1{-# LANGUAGE ImplicitParams #-}
2
2
3sortBy :: (a -> a -> Bool) -> [a] -> [a]
3sortBy :: (a -> a -> Bool) -> [a] -> [a]
4+sortBy = undefined
4
5
5sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
6sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
6sort = sortBy ?cmp
7sort = sortBy ?cmp
data/examples/declaration/value/function/implicit-params.hs+2
@@ -1,6 +1,8 @@
1{-# LANGUAGE ImplicitParams #-}
1{-# LANGUAGE ImplicitParams #-}
2sortBy :: (a -> a -> Bool) -> [a] -> [a]
2sortBy :: (a -> a -> Bool) -> [a] -> [a]
3
3
4+sortBy = undefined
5+
4sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
6sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
5sort = sortBy ?cmp
7sort = sortBy ?cmp
6
8
data/examples/declaration/value/function/infix/dollar-chains-out.hs+3−3
@@ -13,9 +13,9 @@ 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
19
20x =
20x =
21 case l of { A -> B } $
21 case l of { A -> B } $
data/examples/declaration/value/function/infix/hanging-out.hs+4−3
@@ -17,6 +17,7 @@ update =
17 `catch` \case
17 `catch` \case
18 a -> a
18 a -> a
19
19
20−foo = bar
20+foo =
21+ bar
21− ++ case foo of
22+ ++ case foo of
22− a -> a
23+ a -> a
data/examples/declaration/value/function/infix/lenses-out.hs+8−7
@@ -1,11 +1,12 @@
1lenses =
1lenses =
2+ Just $
2− Just $ M.fromList $
3+ M.fromList $
3− "type" .= ("user.connection" :: Text)
4+ "type" .= ("user.connection" :: Text)
4− # "connection" .= uc
5+ # "connection" .= uc
5− # "user" .= case name of
6+ # "user" .= case name of
6− Just n -> Just $ object ["name" .= n]
7+ Just n -> Just $ object ["name" .= n]
7− Nothing -> Nothing
8+ Nothing -> Nothing
8− # []
9+ # []
9
10
10foo =
11foo =
11 a
12 a
data/examples/declaration/value/function/list-notation-0-out.hsnew file+5
@@ -0,0 +1,5 @@
1+foo =
2+ testCase "Foo" testFoo :
3+ testCase "Bar" testBar :
4+ testCase "Baz" testBaz :
5+ []
data/examples/declaration/value/function/list-notation-0.hsnew file+5
@@ -0,0 +1,5 @@
1+foo =
2+ testCase "Foo" testFoo :
3+ testCase "Bar" testBar :
4+ testCase "Baz" testBaz :
5+ []
data/examples/declaration/value/function/list-notation-1-out.hsnew file+8
@@ -0,0 +1,8 @@
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.hsnew file+7
@@ -0,0 +1,7 @@
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.hsnew file+6
@@ -0,0 +1,6 @@
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.hsnew file+5
@@ -0,0 +1,5 @@
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.hsnew file+12
@@ -0,0 +1,12 @@
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.hsnew file+10
@@ -0,0 +1,10 @@
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−2
@@ -3,12 +3,14 @@
3foo x = if | x == 5 -> 5
3foo x = if | x == 5 -> 5
4
4
5bar x y =
5bar x y =
6+ if
6− if | x > y -> x
7+ | x > y -> x
7 | x < y ->
8 | x < y ->
8 y
9 y
9 | otherwise -> x
10 | otherwise -> x
10
11
11baz =
12baz =
12− if | p -> f
13+ if
14+ | p -> f
13 | otherwise -> g
15 | otherwise -> g
14 x
16 x
data/examples/declaration/value/function/operator-comments-2-out.hsnew file+5
@@ -0,0 +1,5 @@
1+x =
2+ y
3+ ++ f g -- commentA
4+ -- commentB
5+ -- commentC
data/examples/declaration/value/function/operator-comments-2.hsnew file+4
@@ -0,0 +1,4 @@
1+x =
2+ y ++ -- commentA
3+-- commentB
4+ f g -- commentC
data/examples/declaration/value/function/operators-out.hs → data/examples/declaration/value/function/operators-0-out.hsrenamed

The content is the same.

data/examples/declaration/value/function/operators.hs → data/examples/declaration/value/function/operators-0.hsrenamed

The content is the same.

data/examples/declaration/value/function/operators-1-out.hsnew file+4
@@ -0,0 +1,4 @@
1+foo =
2+ f
3+ . g
4+ =<< h . i
data/examples/declaration/value/function/operators-1.hsnew file+3
@@ -0,0 +1,3 @@
1+foo = f
2+ . g
3+ =<< h . i
data/examples/declaration/value/function/operators-2-out.hsnew file+4
@@ -0,0 +1,4 @@
1+foo n
2+ | x || y && z || n ** x
3+ || x && n =
4+ 42
data/examples/declaration/value/function/operators-2.hsnew file+4
@@ -0,0 +1,4 @@
1+foo n
2+ | x || y && z || n ** x
3+ || x && n =
4+ 42
data/examples/declaration/value/function/operators-3-out.hsnew file+3
@@ -0,0 +1,3 @@
1+foo =
2+ op <> n <+> colon <+> prettySe <+> text "="
3+ <+> prettySe <> text sc
data/examples/declaration/value/function/operators-3.hsnew file+3
@@ -0,0 +1,3 @@
1+foo =
2+ op <> n <+> colon <+> prettySe <+> text "=" <+>
3+ prettySe <> text sc
data/examples/declaration/value/function/operators-4-out.hsnew file+3
@@ -0,0 +1,3 @@
1+foo =
2+ line <> bindingOf <+> text "=" <+> tPretty <+> colon
3+ <+> align <> prettyPs
data/examples/declaration/value/function/operators-4.hsnew file+3
@@ -0,0 +1,3 @@
1+foo =
2+ line <> bindingOf <+> text "=" <+> tPretty <+> colon <+>
3+ align <> prettyPs
data/examples/declaration/value/function/operators-5-out.hsnew file+5
@@ -0,0 +1,5 @@
1+foo =
2+ map bar $
3+ [ baz
4+ ]
5+ ++ quux
data/examples/declaration/value/function/operators-5.hsnew file+4
@@ -0,0 +1,4 @@
1+foo =
2+ map bar $
3+ [ baz
4+ ] ++ quux
data/examples/declaration/value/function/operators-6-out.hsnew file+9
@@ -0,0 +1,9 @@
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.hsnew file+7
@@ -0,0 +1,7 @@
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/record-constructors-out.hs → data/examples/declaration/value/function/record/constructors-out.hsrenamed

The content is the same.

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-dot-out.hs → data/examples/declaration/value/function/record/dot-out.hsrenamed

The content is the same.

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

The content is the same.

data/examples/declaration/value/function/record/hanging-after-equal-con-out.hsnew file+8
@@ -0,0 +1,8 @@
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.hsnew file+7
@@ -0,0 +1,7 @@
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.hsnew file+8
@@ -0,0 +1,8 @@
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.hsnew file+7
@@ -0,0 +1,7 @@
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.hs → data/examples/declaration/value/function/record/inter-comments-out.hsrenamed

The content is the same.

data/examples/declaration/value/function/record-inter-comments.hs → data/examples/declaration/value/function/record/inter-comments.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

The content is the same.

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/type-applications-and-splice-out.hsnew file+4
@@ -0,0 +1,4 @@
1+{-# LANGUAGE TemplateHaskell #-}
2+{-# LANGUAGE TypeApplications #-}
3+
4+staticKey name = [|sing @ $(symFQN name)|]
data/examples/declaration/value/function/type-applications-and-splice.hsnew file+4
@@ -0,0 +1,4 @@
1+{-# LANGUAGE TemplateHaskell #-}
2+{-# LANGUAGE TypeApplications #-}
3+
4+staticKey name = [| sing @ $(symFQN name) |]
data/examples/import/deduplication-bug-out.hsnew file+6
@@ -0,0 +1,6 @@
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.hsnew file+6
@@ -0,0 +1,6 @@
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− (>>>),
4− Either,
2+ ( Either,
5 Maybe (Just, Nothing),
3 Maybe (Just, Nothing),
6 MaybeT (..),
4 MaybeT (..),
7− Monad ((>>), (>>=), return),
5+ Monad (return, (>>), (>>=)),
8 MonadBaseControl,
6 MonadBaseControl,
9 join,
7 join,
10 liftIO,
8 liftIO,
11 void,
9 void,
10+ (<<<),
11+ (>>>),
12 )
12 )
data/examples/import/explicit-imports-with-comments-out.hs+3−2
@@ -1,6 +1,7 @@
1import qualified MegaModule as M
1import qualified MegaModule as M
2 ( -- (1)
2 ( -- (1)
3− (<<<), -- (2)
3+ -- (2)
4− (>>>),
5 Either, -- (3)
4 Either, -- (3)
5+ (<<<),
6+ (>>>),
6 )
7 )
data/examples/import/merging-0-out.hsnew file+3
@@ -0,0 +1,3 @@
1+import Foo
2+import Foo (bar, foo)
3+import Foo as F
data/examples/import/merging-0.hsnew file+4
@@ -0,0 +1,4 @@
1+import Foo
2+import Foo (foo)
3+import Foo (bar)
4+import Foo as F
data/examples/import/merging-1-out.hsnew file+2
@@ -0,0 +1,2 @@
1+import "bar" Foo (bar)
2+import "foo" Foo (baz, foo)
data/examples/import/merging-1.hsnew file+3
@@ -0,0 +1,3 @@
1+import "foo" Foo (foo)
2+import "bar" Foo (bar)
3+import "foo" Foo (baz)
data/examples/import/merging-2-out.hsnew file+2
@@ -0,0 +1,2 @@
1+import Foo hiding (bar4, foo2)
2+import qualified Foo (bar3, foo1)
data/examples/import/merging-2.hsnew file+4
@@ -0,0 +1,4 @@
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,11 +1,5 @@
1import A hiding
1import A hiding
2 ( foobarbazqux,
2 ( foobarbazqux,
3− foobarbazqux,
4− foobarbazqux,
5− foobarbazqux,
6− foobarbazqux,
7− foobarbazqux,
8− foobarbazqux,
9 )
3 )
10import {-# SOURCE #-} safe qualified Module as M hiding (a, b, c, d, e, f)
4import {-# SOURCE #-} safe qualified Module as M hiding (a, b, c, d, e, f)
11import Name hiding ()
5import 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− (>>>),
4− Either,
2+ ( Either,
5 Monad
3 Monad
4+ ( return,
6− ( (>>),
5+ (>>),
7− (>>=),
6+ (>>=)
8− return
9 ),
7 ),
8+ (<<<),
9+ (>>>),
10 )
10 )
data/examples/import/qualified-post-out.hs+1−1
@@ -1,5 +1,5 @@
1{-# LANGUAGE ImportQualifiedPost #-}
1{-# LANGUAGE ImportQualifiedPost #-}
2
2
3−import Data.Text qualified as T
4import Data.Text qualified (a, b, c)
3import Data.Text qualified (a, b, c)
5import Data.Text qualified hiding (a, b, c)
4import Data.Text qualified hiding (a, b, c)
5+import Data.Text qualified as T
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, (.))
3import qualified Prelude
4import qualified Prelude
4−import Prelude hiding ((.), id)
data/examples/import/simple-out.hs+2−3
@@ -1,6 +1,5 @@
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)
5import Data.Text (a, b, c)
2import Data.Text (a, b, c)
6import Data.Text hiding (a, b, c)
3import 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,3 +4,5 @@ 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.hsnew file+1
@@ -0,0 +1 @@
1+import Linear.Vector (Additive (..), (*^), (^*))
data/examples/import/sorted-export-list.hsnew file+1
@@ -0,0 +1 @@
1+import Linear.Vector (Additive (..), (*^), (^*))
data/examples/module-header/double-dot-with-names-out.hs+1−6
@@ -1,11 +1,6 @@
1{-# LANGUAGE PatternSynonyms #-}
1{-# LANGUAGE PatternSynonyms #-}
2
2
3−module ExportSyntax
3+module ExportSyntax (A (.., NoA), Q (F, ..), G (T, .., U)) where
4− ( A (.., NoA),
5− Q (F, ..),
6− G (T, .., U),
7− )
8−where
9
4
10data A = A | B
5data A = A | B
11
6
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.hs+1−4
@@ -3,9 +3,6 @@
3-}
3-}
4
4
5-- | This is the module's Haddock.
5-- | This is the module's Haddock.
6−module Main
6+module Main (main) where
7− ( main,
8− )
9−where
10
7
11main = return ()
8main = return ()
data/examples/module-header/singleline-empty-out.hs+1−4
@@ -1,5 +1,2 @@
1-- | This demonstrates a BUG.
1-- | This demonstrates a BUG.
2−module Foo
2+module Foo () where
3− (
4− )
5−where
data/examples/module-header/warning-pragma-multiline-out.hs+1−4
@@ -1,9 +1,6 @@
1module Test
1module Test
2 {-# DEPRECATED "This module is unstable" #-}
2 {-# DEPRECATED "This module is unstable" #-}
3− ( foo,
3+ (foo, bar, baz)
4− bar,
5− baz,
6− )
7where
4where
8
5
9import Blah
6import Blah
data/examples/module-header/warning-pragma-out.hs+3−1
@@ -1,3 +1,5 @@
1module Test
1module Test
2+ {-# WARNING
2− {-# WARNING "This module is very internal" #-}
3+ "This module is very internal"
4+ #-}
3where
5where
data/examples/other/argument-comment-out.hs−1
@@ -9,7 +9,6 @@ foo ::
9 -- | Foo
9 -- | Foo
10 Int ->
10 Int ->
11 Int
11 Int
12−
13foo ::
12foo ::
14 Foo a =>
13 Foo a =>
15 -- | Foo
14 -- | Foo
data/examples/other/comment-glued-together-out.hsnew file+7
@@ -0,0 +1,7 @@
1+module Main (main) where
2+
3+-- | Foo.
4+
5+-- Bar
6+main :: IO ()
7+main = return ()
data/examples/other/comment-glued-together.hsnew file+6
@@ -0,0 +1,6 @@
1+module Main (main) where
2+
3+{- | Foo. -}
4+-- Bar
5+main :: IO ()
6+main = return ()
data/examples/other/comment-trailing-space-out.hsnew file+9
@@ -0,0 +1,9 @@
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.hsnew file+9
@@ -0,0 +1,9 @@
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/separation-2b-out.hs−1
@@ -1,5 +1,4 @@
1ffff, ffffffff :: Natural
1ffff, ffffffff :: Natural
2−
3#ifdef HASKELL_ZIP_DEV_MODE
2#ifdef HASKELL_ZIP_DEV_MODE
4ffff = 200
3ffff = 200
5ffffffff = 5000
4ffffffff = 5000
data/examples/other/disabling/indented-fragment-out.hsnew file+7
@@ -0,0 +1,7 @@
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.hsnew file+7
@@ -0,0 +1,7 @@
1+foo =
2+ {- ORMOLU_DISABLE -}
3+ testCase "Foo" testFoo :
4+ testCase "Bar" testBar :
5+ testCase "Baz" testBaz :
6+ {- ORMOLU_ENABLE -}
7+ []
data/examples/other/inline-comment-0-out.hsnew file+3
@@ -0,0 +1,3 @@
1+x = ({-a-} b, c)
2+
3+y = ({-a-} b)
data/examples/other/inline-comment-0.hsnew file+3
@@ -0,0 +1,3 @@
1+x = ({-a-}b, c)
2+
3+y = ({-a-}b)
data/examples/other/inline-comment-1-out.hsnew file+12
@@ -0,0 +1,12 @@
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.hsnew file+9
@@ -0,0 +1,9 @@
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/multiple-blank-line-comment-out.hsnew file+9
@@ -0,0 +1,9 @@
1+module A where
2+
3+a =
4+ b
5+ [ f
6+ {-,
7+
8+ -}
9+ ]
data/examples/other/multiple-blank-line-comment.hsnew file+10
@@ -0,0 +1,10 @@
1+module A where
2+
3+a =
4+ b
5+ [ f
6+ {-,
7+
8+
9+ -}
10+ ]
data/examples/other/pragma-comments-after-out.hsnew file+4
@@ -0,0 +1,4 @@
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.hsnew file+3
@@ -0,0 +1,3 @@
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.hs+1−4
@@ -5,7 +5,4 @@
5{-# OPTIONS_GHC -fno-warn-overlapping-patterns #-}
5{-# OPTIONS_GHC -fno-warn-overlapping-patterns #-}
6
6
7-- | Header comment.
7-- | Header comment.
8−module Foo
8+module Foo () where
9− (
10− )
11−where
data/examples/other/pragma-out.hs+1−4
@@ -9,7 +9,4 @@
9{-# OPTIONS_HADDOCK prune, show-extensions #-}
9{-# OPTIONS_HADDOCK prune, show-extensions #-}
10
10
11-- | Header comment.
11-- | Header comment.
12−module Foo
12+module Foo () where
13− (
14− )
15−where
default.nix+69−25
@@ -1,5 +1,6 @@
1−{ pkgs ? (import ./nix/nixpkgs)
1+{ pkgs ? (import ./nix/nixpkgs { inherit system; })
2+, system ? builtins.currentSystem
2−, ormoluCompiler ? "ghc883" # the shell doesn't work with ghc8101 yet
3+, ormoluCompiler ? "ghc884" # the shell doesn't work with ghc8101 yet
3}:
4}:
4
5
5let
6let
@@ -16,12 +17,6 @@ let
16 };
17 };
17 ormoluOverlay = self: super: {
18 ormoluOverlay = self: super: {
18 "ormolu" = super.callCabal2nixWithOptions "ormolu" source "-fdev" { };
19 "ormolu" = super.callCabal2nixWithOptions "ormolu" source "-fdev" { };
19− "ghc-lib-parser" = pkgs.haskell.lib.dontHaddock
20− (super.callHackageDirect {
21− pkg = "ghc-lib-parser";
22− ver = "8.10.1.20200412";
23− sha256 = "sha256-EjMzp8xRT3xVFKDI1fAfopkylGB0hv35Av2+uZeETRU=";
24− } {});
25 };
20 };
26 ormolize = import ./nix/ormolize {
21 ormolize = import ./nix/ormolize {
27 inherit pkgs;
22 inherit pkgs;
@@ -30,19 +25,19 @@ let
30 expectedFailures = [
25 expectedFailures = [
31 "Agda"
26 "Agda"
32 "aws"
27 "aws"
33− "brick"
34 "distributed-process"
28 "distributed-process"
35 "esqueleto"
29 "esqueleto"
36 "fay"
30 "fay"
31+ "hlint"
37 "idris"
32 "idris"
38 "intero"
33 "intero"
39 "leksah"
34 "leksah"
40− "lens"
41 "pandoc"
35 "pandoc"
42 "pipes"
36 "pipes"
37+ "postgrest"
43 "purescript"
38 "purescript"
44− "stack"
39+ "tensorflow"
45− ];
40+ ] ++ (if ormoluCompiler == "ghc8101" then [] else ["lens"]);
46 ormolizedPackages = doCheck:
41 ormolizedPackages = doCheck:
47 pkgs.lib.mapAttrs (name: p: ormolize {
42 pkgs.lib.mapAttrs (name: p: ormolize {
48 package = p;
43 package = p;
@@ -54,14 +49,11 @@ let
54 }) haskellPackages;
49 }) haskellPackages;
55in {
50in {
56 ormolu = haskellPackages.ormolu;
51 ormolu = haskellPackages.ormolu;
57− ormoluShell =
52+ # We put the derivations in another attribute set to avoid building them
58− if ormoluCompiler == "ghc8101"
53+ # when nix-build is run.
59− # HACK The shell doesn't compile with GHC 8.10.1
54+ dev = {
60− then haskellPackages.shellFor {
55+ ormoluShell =
61− packages = ps: [];
62− buildInputs = [];
63− }
64− else haskellPackages.shellFor {
56+ haskellPackages.shellFor {
65 packages = ps: [
57 packages = ps: [
66 ps.ormolu
58 ps.ormolu
67 ];
59 ];
@@ -70,11 +62,13 @@ in {
70 haskellPackages.ghcid
62 haskellPackages.ghcid
71 ];
63 ];
72 };
64 };
73− withOrmolu = haskellPackages.shellFor {
65+ withOrmolu = haskellPackages.shellFor {
74− packages = ps: [];
66+ packages = ps: [];
75− buildInputs = [
67+ buildInputs = [
68+ haskellPackages.cabal-install
76− haskellPackages.ormolu
69+ haskellPackages.ormolu
70+ ];
77− ];
71+ };
78 };
72 };
79 inherit ormoluOverlay ormoluCompiler;
73 inherit ormoluOverlay ormoluCompiler;
80 hackage = ormolizedPackages false;
74 hackage = ormolizedPackages false;
@@ -109,6 +103,7 @@ in {
109 "optics"
103 "optics"
110 "ormolu"
104 "ormolu"
111 "pandoc"
105 "pandoc"
106+ "parsec3"
112 "pipes"
107 "pipes"
113 "postgrest"
108 "postgrest"
114 "purescript"
109 "purescript"
@@ -122,4 +117,53 @@ in {
122 ];
117 ];
123 in listToAttrs (map (p: nameValuePair p (ormolizedPackages true).${p}) ps)
118 in listToAttrs (map (p: nameValuePair p (ormolizedPackages true).${p}) ps)
124 );
119 );
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+ };
125}
169}
expected-failures/Agda.txt+6−29
@@ -1,34 +1,11 @@
1Formatting is not idempotent:
1Formatting is not idempotent:
2− src/full/Agda/Auto/CaseSplit.hs<rendered>:176:54
2+ dist/build/Agda/Syntax/Parser/Lexer.hs<rendered>:1602:17
3− before: ", pats') = applyperm"
3+ before: " = (check_ac"
4− after: ", pats') =\n "
4+ after: " =\n "
5Please, consider reporting the bug.
5Please, consider reporting the bug.
6
6
7Formatting is not idempotent:
7Formatting is not idempotent:
8− src/full/Agda/Syntax/Internal.hs<rendered>:236:12
8+ src/full/Agda/Syntax/Translation/InternalToAbstract.hs<rendered>:769:4
9− before: "pe Elims = -- | elim"
10− after: "pe Elims =\n -- | el"
11−Please, consider reporting the bug.
12−
13−Parsing of formatted code failed:
14− src/full/Agda/Syntax/Translation/ConcreteToAbstract.hs<rendered>:524:7-13
15− parse error on input `C.QName'
16−Please, consider reporting the bug.
17−
18−Formatting is not idempotent:
19− src/full/Agda/Termination/CallGraph.hs<rendered>:152:38
20− before: "2, old2) = -- TODO: "
9+ before: " nes\n\n "
21− after: "2, old2) =\n -"
10+ after: " nes\n\n -- Andreas"
22−Please, consider reporting the bug.
23−
24−Formatting is not idempotent:
25− src/full/Agda/TypeChecking/MetaVars.hs<rendered>:1448:16
26− before: "ubstCand = -- | a po"
27− after: "ubstCand =\n -- | a "
28−Please, consider reporting the bug.
29−
30−Formatting is not idempotent:
31− src/full/Agda/Utils/List.hs<rendered>:186:15
32− before: "Prefix a = -- | The "
33− after: "Prefix a =\n -- | Th"
34Please, consider reporting the bug.
11Please, consider reporting the bug.
expected-failures/brick.txtdeleted−5
@@ -1,5 +0,0 @@
1−Formatting is not idempotent:
2− src/Brick/Widgets/List.hs<rendered>:573:3
3− before: "t at i\n in -- If t"
4− after: "t at i\n -"
5−Please, consider reporting the bug.
expected-failures/esqueleto.txt+1−1
@@ -3,5 +3,5 @@ The GHC parser (in Haddock mode) failed:
3 lexical error in string/character literal at character 's'
3 lexical error in string/character literal at character 's'
4
4
5The GHC parser (in Haddock mode) failed:
5The GHC parser (in Haddock mode) failed:
6− test/PostgreSQL/Test.hs:510:9-41
6+ test/PostgreSQL/Test.hs:562:9-41
7 parse error on input `-- | Check the result is not null'
7 parse error on input `-- | Check the result is not null'
expected-failures/hlint.txtnew file+11
@@ -0,0 +1,11 @@
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.txt−94
@@ -1,101 +1,7 @@
1−Formatting is not idempotent:
2− src/Idris/AbsSyntaxTree.hs<rendered>:2105:48
3− before: "t_impl ppo && uname "
4− after: "t_impl ppo\n "
5−Please, consider reporting the bug.
6−
7−Formatting is not idempotent:
8− src/Idris/Core/ProofState.hs<rendered>:163:20
9− before: "++ showEnv env (\n "
10− after: "++ showEnv\n "
11−Please, consider reporting the bug.
12−
13−Formatting is not idempotent:
14− src/Idris/Core/ProofTerm.hs<rendered>:351:19
15− before: "f c e pt = -- @(PT p"
16− after: "f c e pt =\n -- @(PT"
17−Please, consider reporting the bug.
18−
19−Formatting is not idempotent:
20− src/Idris/Core/TT.hs<rendered>:1963:13
21− before: " text op <> pretty"
22− after: " text op\n <"
23−Please, consider reporting the bug.
24−
25−Formatting is not idempotent:
26− src/Idris/Core/WHNF.hs<rendered>:110:46
27− before: " n b sc) = -- stk mu"
28− after: " n b sc) =\n -- "
29−Please, consider reporting the bug.
30−
31−Formatting is not idempotent:
32− src/Idris/Delaborate.hs<rendered>:627:6
33− before: "ity\n -- Issue #"
34− after: "ity\n -- Issue"
35−Please, consider reporting the bug.
36−
37−Formatting is not idempotent:
38− src/Idris/Elab/Term.hs<rendered>:432:47
39− before: "K\" _ _)) = -- for ch"
40− after: "K\" _ _)) =\n -- "
41−Please, consider reporting the bug.
42−
43−Formatting is not idempotent:
44− src/Idris/ModeCommon.hs<rendered>:40:26
45− before: "s toline = -- furthe"
46− after: "s toline =\n -- furt"
47−Please, consider reporting the bug.
48−
49−Formatting is not idempotent:
50− src/Idris/Options.hs<rendered>:177:17
51− before: "timisation = PETrans"
52− after: "timisation\n = PETra"
53−Please, consider reporting the bug.
54−
55The GHC parser (in Haddock mode) failed:
1The GHC parser (in Haddock mode) failed:
56 src/Idris/Parser.hs:1052:1
2 src/Idris/Parser.hs:1052:1
57 parse error on input `@'
3 parse error on input `@'
58
4
59−AST of input and AST of formatted code differ.
60− at src/Idris/Parser/Data.hs:281:1-29
61−Please, consider reporting the bug.
62−
63The GHC parser (in Haddock mode) failed:
5The GHC parser (in Haddock mode) failed:
64 src/Idris/Parser/Expr.hs:75:1
6 src/Idris/Parser/Expr.hs:75:1
65 parse error on input `@'
7 parse error on input `@'
66−
67−Formatting is not idempotent:
68− src/Idris/PartialEval.hs<rendered>:281:42
69− before: ": ns) as = -- Droppe"
70− after: ": ns) as =\n -- "
71−Please, consider reporting the bug.
72−
73−Formatting is not idempotent:
74− src/Idris/ProofSearch.hs<rendered>:487:20
75− before: "OK ty hs = -- if any"
76− after: "OK ty hs =\n -- "
77−Please, consider reporting the bug.
78−
79−Formatting is not idempotent:
80− src/Idris/Prover.hs<rendered>:244:10
81− before: " line <> bindin"
82− after: " line\n <"
83−Please, consider reporting the bug.
84−
85−Formatting is not idempotent:
86− src/Idris/REPL.hs<rendered>:1270:33
87− before: "ht c) _) = -- consta"
88− after: "ht c) _) =\n -- cons"
89−Please, consider reporting the bug.
90−
91−Formatting is not idempotent:
92− src/Idris/Reflection.hs<rendered>:934:27
93− before: "attern _ = -- for al"
94− after: "attern _ =\n -- for "
95−Please, consider reporting the bug.
96−
97−Formatting is not idempotent:
98− src/Idris/Transforms.hs<rendered>:26:32
99− before: "s, rhs)) = -- apply "
100− after: "s, rhs)) =\n -- "
101−Please, consider reporting the bug.
expected-failures/intero.txt+3−3
@@ -1,5 +1,5 @@
1Formatting is not idempotent:
1Formatting is not idempotent:
2− src/InteractiveUI.hs<rendered>:2635:36
2+ src/InteractiveUI.hs<rendered>:3748:33
3− before: "Decl d2) = -- A bit "
3+ before: "text \"Try\" <+> doWha"
4− after: "Decl d2) =\n -- A bi"
4+ after: "text \"Try\"\n "
5Please, consider reporting the bug.
5Please, consider reporting the bug.
expected-failures/leksah.txt+1−7
@@ -1,11 +1,5 @@
1Formatting is not idempotent:
1Formatting is not idempotent:
2− src/IDE/Pane/Modules.hs<rendered>:1188:7
2+ src/IDE/Pane/Modules.hs<rendered>:1184:7
3 before: "cr\n -- show"
3 before: "cr\n -- show"
4 after: "cr\n in -- show"
4 after: "cr\n in -- show"
5Please, consider reporting the bug.
5Please, consider reporting the bug.
6−
7−Formatting is not idempotent:
8− src/IDE/SymbolNavigation.hs<rendered>:233:8
9− before: "\n\n return [\n {-i"
10− after: "\n\n return\n [ {-i"
11−Please, consider reporting the bug.
expected-failures/pandoc.txt+1−7
@@ -3,13 +3,7 @@ The GHC parser (in Haddock mode) failed:
3 parse error on input `import'
3 parse error on input `import'
4
4
5Formatting is not idempotent:
5Formatting is not idempotent:
6− src/Text/Pandoc/Readers/Vimwiki.hs<rendered>:615:19
6+ src/Text/Pandoc/Readers/Vimwiki.hs<rendered>:613:19
7 before: ".softbreak <$ endlin"
7 before: ".softbreak <$ endlin"
8 after: ".softbreak\n <$ en"
8 after: ".softbreak\n <$ en"
9Please, consider reporting the bug.
9Please, consider reporting the bug.
10−
11−Formatting is not idempotent:
12− src/Text/Pandoc/Writers/Docx.hs<rendered>:997:25
13− before: " -- w:p\n "
14− after: " -- w:p\n "
15−Please, consider reporting the bug.
expected-failures/postgrest.txtnew file+5
@@ -0,0 +1,5 @@
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.txt+2−2
@@ -1,10 +1,10 @@
1The GHC parser (in Haddock mode) failed:
1The GHC parser (in Haddock mode) failed:
2− src/Language/PureScript/AST/Declarations.hs:478:1-17
2+ src/Language/PureScript/AST/Declarations.hs:479:1-17
3 Invalid type signature: pattern ValueDecl :: ...
3 Invalid type signature: pattern ValueDecl :: ...
4Perhaps you meant to use PatternSynonyms?
4Perhaps you meant to use PatternSynonyms?
5
5
6The GHC parser (in Haddock mode) failed:
6The GHC parser (in Haddock mode) failed:
7− src/Language/PureScript/AST/SourcePos.hs:101:1-22
7+ src/Language/PureScript/AST/SourcePos.hs:99:1-22
8 Invalid type signature: pattern NullSourceSpan :: ...
8 Invalid type signature: pattern NullSourceSpan :: ...
9Perhaps you meant to use PatternSynonyms?
9Perhaps you meant to use PatternSynonyms?
10
10
expected-failures/stack.txtdeleted−5
@@ -1,5 +0,0 @@
1−Formatting is not idempotent:
2− src/Stack/Options/DockerParser.hs<rendered>:36:10
3− before: " <$> opti"
4− after: " <$> option"
5−Please, consider reporting the bug.
expected-failures/tensorflow.txtnew file+7
@@ -0,0 +1,7 @@
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.sh+3−1
@@ -1,5 +1,5 @@
1#!/usr/bin/env nix-shell
1#!/usr/bin/env nix-shell
2−#!nix-shell default.nix -A withOrmolu -i bash --pure
2+#!nix-shell default.nix -A dev.withOrmolu -i bash --pure
3#
3#
4# Format Ormolu using current version of Ormolu.
4# Format Ormolu using current version of Ormolu.
5
5
@@ -7,6 +7,8 @@ set -e
7
7
8export LANG="C.UTF-8"
8export LANG="C.UTF-8"
9
9
10+cabal format
11+
10ormolu -m inplace $(find app -type f -name "*.hs")
12ormolu -m inplace $(find app -type f -name "*.hs")
11ormolu -m inplace $(find src -type f \( -name "*.hs" -o -name "*.hs-boot" \))
13ormolu -m inplace $(find src -type f \( -name "*.hs" -o -name "*.hs-boot" \))
12ormolu -m inplace $(find tests -type f -name "*.hs")
14ormolu -m inplace $(find tests -type f -name "*.hs")
nix/nixpkgs/default.nix+7−3
@@ -1,9 +1,13 @@
1+{ system ? builtins.currentSystem }:
1let
2let
2− rev = "807ca93fadd5197c2260490de0c76e500562dc05";
3+ rev = "32b46dd897ab2143a609988a04d87452f0bbef59";
3− sha256 = "10yq8bnls77fh3pk5chkkb1sv5lbdgyk1rr2v9xn71rr1k2x563p";
4+ sha256 = "1gzfrpjnr1bz9zljsyg3a4zrhk8r927sz761mrgcg56dwinkhpjk";
4 nixpkgs = builtins.fetchTarball {
5 nixpkgs = builtins.fetchTarball {
5 url = "https://github.com/NixOS/nixpkgs/archive/${rev}.tar.gz";
6 url = "https://github.com/NixOS/nixpkgs/archive/${rev}.tar.gz";
6 inherit sha256;
7 inherit sha256;
7 };
8 };
9+ pkgs = import nixpkgs {
10+ inherit system;
8− pkgs = import nixpkgs { config.allowUnfree = true; };
11+ config.allowUnfree = true;
12+ };
9in pkgs
13in pkgs
nix/ormolize/default.nix+1−1
@@ -32,7 +32,7 @@
32 cp "$hs_file" "''${hs_file}-original"
32 cp "$hs_file" "''${hs_file}-original"
33 done
33 done
34
34
35− (ormolu --check-idempotency --mode inplace $hs_files || true) 2> log.txt
35+ (ormolu --check-idempotence --mode inplace $hs_files || true) 2> log.txt
36 '';
36 '';
37 inherit doCheck;
37 inherit doCheck;
38 checkPhase =
38 checkPhase =
ormolu.cabal+174−160
@@ -1,170 +1,184 @@
1−name: ormolu
2−version: 0.0.4.0
3−cabal-version: 1.18
1+cabal-version: 1.18
4−tested-with: GHC==8.6.5, GHC==8.8.3, GHC==8.10.1
2+name: ormolu
3+version: 0.1.2.0
5−license: BSD3
4+license: BSD3
6−license-file: LICENSE.md
5+license-file: LICENSE.md
7−maintainer: Mark Karpov <mark.karpov@tweag.io>
6+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.
10−category: Development, Formatting
12+category: Development, Formatting
11−synopsis: A formatter for Haskell source code
12−build-type: Simple
13+build-type: Simple
13−description: A formatter for Haskell source code.
14+data-files:
14−extra-doc-files: CONTRIBUTING.md
15− , CHANGELOG.md
16− , DESIGN.md
17− , README.md
18−data-files: data/examples/declaration/annotation/*.hs
15+ data/examples/declaration/annotation/*.hs
19− , data/examples/declaration/class/*.hs
16+ data/examples/declaration/class/*.hs
20− , data/examples/declaration/data/*.hs
17+ data/examples/declaration/data/*.hs
21− , data/examples/declaration/data/gadt/*.hs
18+ data/examples/declaration/data/gadt/*.hs
22− , data/examples/declaration/default/*.hs
19+ data/examples/declaration/default/*.hs
23− , data/examples/declaration/deriving/*.hs
20+ data/examples/declaration/deriving/*.hs
24− , data/examples/declaration/foreign/*.hs
21+ data/examples/declaration/foreign/*.hs
25− , data/examples/declaration/instance/*.hs
22+ data/examples/declaration/instance/*.hs
26− , data/examples/declaration/rewrite-rule/*.hs
23+ data/examples/declaration/rewrite-rule/*.hs
27− , data/examples/declaration/role-annotation/*.hs
24+ data/examples/declaration/role-annotation/*.hs
28− , data/examples/declaration/signature/complete/*.hs
25+ data/examples/declaration/signature/complete/*.hs
29− , data/examples/declaration/signature/fixity/*.hs
26+ data/examples/declaration/signature/fixity/*.hs
30− , data/examples/declaration/signature/inline/*.hs
27+ data/examples/declaration/signature/inline/*.hs
31− , data/examples/declaration/signature/minimal/*.hs
28+ data/examples/declaration/signature/minimal/*.hs
32− , data/examples/declaration/signature/pattern/*.hs
29+ data/examples/declaration/signature/pattern/*.hs
33− , data/examples/declaration/signature/set-cost-centre/*.hs
30+ data/examples/declaration/signature/set-cost-centre/*.hs
34− , data/examples/declaration/signature/specialize/*.hs
31+ data/examples/declaration/signature/specialize/*.hs
35− , data/examples/declaration/signature/type/*.hs
32+ data/examples/declaration/signature/type/*.hs
36− , data/examples/declaration/splice/*.hs
33+ data/examples/declaration/splice/*.hs
37− , data/examples/declaration/type-families/closed-type-family/*.hs
34+ data/examples/declaration/type-families/closed-type-family/*.hs
38− , data/examples/declaration/type-families/data-family/*.hs
35+ data/examples/declaration/type-families/data-family/*.hs
39− , data/examples/declaration/type-families/type-family/*.hs
36+ data/examples/declaration/type-families/type-family/*.hs
40− , data/examples/declaration/type-synonyms/*.hs
37+ data/examples/declaration/type-synonyms/*.hs
41− , data/examples/declaration/type/*.hs
38+ data/examples/declaration/type/*.hs
42− , data/examples/declaration/value/function/*.hs
39+ data/examples/declaration/value/function/*.hs
43− , data/examples/declaration/value/function/arrow/*.hs
40+ data/examples/declaration/value/function/arrow/*.hs
44− , data/examples/declaration/value/function/comprehension/*.hs
41+ data/examples/declaration/value/function/comprehension/*.hs
45− , data/examples/declaration/value/function/do/*.hs
42+ data/examples/declaration/value/function/do/*.hs
46− , data/examples/declaration/value/function/infix/*.hs
43+ data/examples/declaration/value/function/infix/*.hs
47− , data/examples/declaration/value/function/pattern/*.hs
44+ data/examples/declaration/value/function/pattern/*.hs
48− , data/examples/declaration/value/other/*.hs
45+ data/examples/declaration/value/other/*.hs
49− , data/examples/declaration/value/pattern-synonyms/*.hs
46+ data/examples/declaration/value/pattern-synonyms/*.hs
50− , data/examples/declaration/warning/*.hs
47+ data/examples/declaration/warning/*.hs
51− , data/examples/import/*.hs
48+ data/examples/import/*.hs
52− , data/examples/module-header/*.hs
49+ data/examples/module-header/*.hs
53− , data/examples/other/*.hs
50+ data/examples/other/*.hs
51+
52+extra-doc-files:
53+ CONTRIBUTING.md
54+ CHANGELOG.md
55+ DESIGN.md
56+ README.md
54
57
55source-repository head
58source-repository head
56− type: git
59+ type: git
57− location: https://github.com/tweag/ormolu.git
60+ location: https://github.com/tweag/ormolu.git
58
61
59flag dev
62flag dev
60− description: Turn on development settings.
63+ description: Turn on development settings.
61− manual: True
62− default: False
64+ default: False
65+ manual: True
63
66
64library
67library
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-lib-parser >= 8.10 && < 8.11
72− , mtl >= 2.0 && < 3.0
73− , syb >= 0.7 && < 0.8
74− , text >= 0.2 && < 1.3
75− exposed-modules: Ormolu
68+ exposed-modules:
69+ Ormolu
76− , Ormolu.Config
70+ Ormolu.Config
77− , Ormolu.Diff
71+ Ormolu.Diff
78− , Ormolu.Exception
72+ Ormolu.Exception
79− , Ormolu.Imports
73+ Ormolu.Imports
80− , Ormolu.Parser
74+ Ormolu.Parser
81− , Ormolu.Parser.Anns
75+ Ormolu.Parser.Anns
82− , Ormolu.Parser.CommentStream
76+ Ormolu.Parser.CommentStream
83− , Ormolu.Parser.Pragma
77+ Ormolu.Parser.Pragma
84− , Ormolu.Parser.Result
78+ Ormolu.Parser.Result
85− , Ormolu.Parser.Shebang
79+ Ormolu.Parser.Shebang
86− , Ormolu.Printer
80+ Ormolu.Printer
87− , Ormolu.Printer.Combinators
81+ Ormolu.Printer.Combinators
88− , Ormolu.Printer.Comments
82+ Ormolu.Printer.Comments
89− , Ormolu.Printer.Internal
83+ Ormolu.Printer.Internal
90− , Ormolu.Printer.Meat.Common
84+ Ormolu.Printer.Meat.Common
91− , Ormolu.Printer.Meat.Declaration
85+ Ormolu.Printer.Meat.Declaration
92− , Ormolu.Printer.Meat.Declaration.Annotation
86+ Ormolu.Printer.Meat.Declaration.Annotation
93− , Ormolu.Printer.Meat.Declaration.Class
87+ Ormolu.Printer.Meat.Declaration.Class
94− , Ormolu.Printer.Meat.Declaration.Data
88+ Ormolu.Printer.Meat.Declaration.Data
95− , Ormolu.Printer.Meat.Declaration.Default
89+ Ormolu.Printer.Meat.Declaration.Default
96− , Ormolu.Printer.Meat.Declaration.Foreign
90+ Ormolu.Printer.Meat.Declaration.Foreign
97− , Ormolu.Printer.Meat.Declaration.Instance
91+ Ormolu.Printer.Meat.Declaration.Instance
98− , Ormolu.Printer.Meat.Declaration.RoleAnnotation
92+ Ormolu.Printer.Meat.Declaration.RoleAnnotation
99− , Ormolu.Printer.Meat.Declaration.Rule
93+ Ormolu.Printer.Meat.Declaration.Rule
100− , Ormolu.Printer.Meat.Declaration.Signature
94+ Ormolu.Printer.Meat.Declaration.Signature
101− , Ormolu.Printer.Meat.Declaration.Splice
95+ Ormolu.Printer.Meat.Declaration.Splice
102− , Ormolu.Printer.Meat.Declaration.Type
96+ Ormolu.Printer.Meat.Declaration.Type
103− , Ormolu.Printer.Meat.Declaration.TypeFamily
97+ Ormolu.Printer.Meat.Declaration.TypeFamily
104− , Ormolu.Printer.Meat.Declaration.Value
98+ Ormolu.Printer.Meat.Declaration.Value
105− , Ormolu.Printer.Meat.Declaration.Warning
99+ Ormolu.Printer.Meat.Declaration.Warning
106− , Ormolu.Printer.Meat.ImportExport
100+ Ormolu.Printer.Meat.ImportExport
107− , Ormolu.Printer.Meat.Module
101+ Ormolu.Printer.Meat.Module
108− , Ormolu.Printer.Meat.Pragma
102+ Ormolu.Printer.Meat.Pragma
109− , Ormolu.Printer.Meat.Type
103+ Ormolu.Printer.Meat.Type
110− , Ormolu.Printer.Operators
104+ Ormolu.Printer.Operators
111− , Ormolu.Printer.SpanStream
105+ Ormolu.Printer.SpanStream
112− , Ormolu.Processing.Common
106+ Ormolu.Processing.Common
113− , Ormolu.Processing.Cpp
107+ Ormolu.Processing.Cpp
114− , Ormolu.Processing.Postprocess
108+ Ormolu.Processing.Postprocess
115− , Ormolu.Processing.Preprocess
109+ Ormolu.Processing.Preprocess
116− , Ormolu.Utils
110+ Ormolu.Utils
117− other-modules: GHC
118− , GHC.DynFlags
119− if flag(dev)
120− ghc-options: -Wall -Werror -Wcompat
121− -Wincomplete-record-updates
122− -Wincomplete-uni-patterns
123− -Wnoncanonical-monad-instances
124− -- https://github.com/haskell/haddock/issues/1116
125− -Wno-missing-home-modules
126− else
127− ghc-options: -O2 -Wall
128− default-language: Haskell2010
129
111
130−test-suite tests
131− main-is: Spec.hs
132− hs-source-dirs: tests
112+ hs-source-dirs: src
133− type: exitcode-stdio-1.0
113+ other-modules:
114+ GHC
115+ GHC.DynFlags
116+
117+ default-language: Haskell2010
134− build-depends: base >= 4.12 && < 5.0
118+ build-depends:
119+ base >=4.12 && <5.0,
120+ bytestring >=0.2 && <0.11,
135− , containers >= 0.5 && < 0.7
121+ containers >=0.5 && <0.7,
136− , filepath >= 1.2 && < 1.5
122+ dlist >=0.8 && <2.0,
137− , hspec >= 2.0 && < 3.0
123+ exceptions >=0.6 && <0.11,
138− , ormolu
124+ ghc-lib-parser >=8.10 && <8.11,
139− , path >= 0.6 && < 0.8
125+ mtl >=2.0 && <3.0,
140− , path-io >= 1.4.2 && < 2.0
126+ syb >=0.7 && <0.8,
141− , text >= 0.2 && < 1.3
127+ text >=0.2 && <1.3
142− build-tools: hspec-discover >= 2.0 && < 3.0
143− other-modules:
144− Ormolu.Parser.PragmaSpec
145− , Ormolu.PrinterSpec
146
128
147− if flag(dev)
129+ if flag(dev)
148− ghc-options: -Wall -Werror
130+ ghc-options:
131+ -Wall -Werror -Wcompat -Wincomplete-record-updates
132+ -Wincomplete-uni-patterns -Wnoncanonical-monad-instances
133+ -Wno-missing-home-modules
134+
149− else
135+ else
150− ghc-options: -O2 -Wall
136+ ghc-options: -O2 -Wall
151− default-language: Haskell2010
152
137
153executable ormolu
138executable ormolu
154− main-is: Main.hs
139+ main-is: Main.hs
155− hs-source-dirs: app
140+ hs-source-dirs: app
141+ other-modules: Paths_ormolu
142+ default-language: Haskell2010
156− build-depends: base >= 4.12 && < 5.0
143+ build-depends:
144+ base >=4.12 && <5.0,
157− , ghc-lib-parser >= 8.10 && < 8.11
145+ ghc-lib-parser >=8.10 && <8.11,
158− , gitrev >= 1.3 && < 1.4
146+ gitrev >=1.3 && <1.4,
159− , optparse-applicative >= 0.14 && < 0.16
147+ optparse-applicative >=0.14 && <0.17,
160− , ormolu
148+ ormolu -any,
161− , text >= 0.2 && < 1.3
149+ text >=0.2 && <1.3
162− other-modules: Paths_ormolu
150+
163− if flag(dev)
151+ if flag(dev)
164− ghc-options: -Wall -Werror -Wcompat
152+ ghc-options:
165− -Wincomplete-record-updates
153+ -Wall -Werror -Wcompat -Wincomplete-record-updates
166− -Wincomplete-uni-patterns
167− -Wnoncanonical-monad-instances
154+ -Wincomplete-uni-patterns -Wnoncanonical-monad-instances
168− else
155+ -optP-Wno-nonportable-include-path
156+
157+ else
169− ghc-options: -O2 -Wall -rtsopts
158+ ghc-options: -O2 -Wall -rtsopts
159+
160+test-suite tests
161+ type: exitcode-stdio-1.0
162+ main-is: Spec.hs
163+ build-tools: hspec-discover >=2.0 && <3.0
164+ hs-source-dirs: tests
165+ other-modules:
166+ Ormolu.Parser.PragmaSpec
167+ Ormolu.PrinterSpec
168+
170− default-language: Haskell2010
169+ 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+
180+ if flag(dev)
181+ ghc-options: -Wall -Werror
182+
183+ else
184+ ghc-options: -O2 -Wall
region-tests/expected-result-17-18.hsnew file+17
@@ -0,0 +1,17 @@
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.hsnew file+17
@@ -0,0 +1,17 @@
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.hsnew file+16
@@ -0,0 +1,16 @@
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.hsnew file+17
@@ -0,0 +1,17 @@
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.hsnew file+21
@@ -0,0 +1,21 @@
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.hsnew file+17
@@ -0,0 +1,17 @@
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+4−2
@@ -1,3 +1,5 @@
1−{ pkgs ? (import ./nix/nixpkgs) }:
1+{ pkgs ? (import ./nix/nixpkgs { inherit system; })
2+, system ? builtins.currentSystem
3+}:
2
4
3−(import ./default.nix { inherit pkgs; }).ormoluShell
5+(import ./default.nix { inherit pkgs; }).dev.ormoluShell
src/GHC.hs−3
@@ -1,6 +1,5 @@
1module GHC
1module GHC
2 ( module X,
2 ( module X,
3− ParsedSource,
4 )
3 )
5where
4where
6
5
@@ -11,5 +10,3 @@ import GHC.Hs.Instances as X ()
11import Module as X
10import Module as X
12import RdrName as X
11import RdrName as X
13import SrcLoc as X
12import SrcLoc as X
14−
15−type ParsedSource = Located (HsModule GhcPs)
src/Ormolu.hs+10−7
@@ -6,6 +6,7 @@ module Ormolu
6 ormoluFile,
6 ormoluFile,
7 ormoluStdin,
7 ormoluStdin,
8 Config (..),
8 Config (..),
9+ RegionIndices (..),
9 defaultConfig,
10 defaultConfig,
10 DynOption (..),
11 DynOption (..),
11 OrmoluException (..),
12 OrmoluException (..),
@@ -42,13 +43,15 @@ import qualified SrcLoc as GHC
42ormolu ::
43ormolu ::
43 MonadIO m =>
44 MonadIO m =>
44 -- | Ormolu configuration
45 -- | Ormolu configuration
45− Config ->
46+ Config RegionIndices ->
46 -- | Location of source file
47 -- | Location of source file
47 FilePath ->
48 FilePath ->
48 -- | Input to format
49 -- | Input to format
49 String ->
50 String ->
50 m Text
51 m Text
51−ormolu cfg path str = do
52+ormolu cfgWithIndices path str = do
53+ let totalLines = length (lines str)
54+ cfg = regionIndicesToDeltas totalLines <$> cfgWithIndices
52 (warnings, result0) <-
55 (warnings, result0) <-
53 parseModule' cfg OrmoluParsingFailed path str
56 parseModule' cfg OrmoluParsingFailed path str
54 when (cfgDebug cfg) $ do
57 when (cfgDebug cfg) $ do
@@ -60,7 +63,7 @@ ormolu cfg path str = do
60 -- to parse the rendered code back, inside of GHC monad wrapper which will
63 -- to parse the rendered code back, inside of GHC monad wrapper which will
61 -- lead to error messages presenting the exceptions as GHC bugs.
64 -- lead to error messages presenting the exceptions as GHC bugs.
62 let !txt = printModule result0
65 let !txt = printModule result0
63− when (not (cfgUnsafe cfg) || cfgCheckIdempotency cfg) $ do
66+ when (not (cfgUnsafe cfg) || cfgCheckIdempotence cfg) $ do
64 let pathRendered = path ++ "<rendered>"
67 let pathRendered = path ++ "<rendered>"
65 -- Parse the result of pretty-printing again and make sure that AST
68 -- Parse the result of pretty-printing again and make sure that AST
66 -- is the same as AST of original snippet module span positions.
69 -- is the same as AST of original snippet module span positions.
@@ -76,7 +79,7 @@ ormolu cfg path str = do
76 Different ss -> liftIO $ throwIO (OrmoluASTDiffers path ss)
79 Different ss -> liftIO $ throwIO (OrmoluASTDiffers path ss)
77 -- Try re-formatting the formatted result to check if we get exactly
80 -- Try re-formatting the formatted result to check if we get exactly
78 -- the same output.
81 -- the same output.
79− when (cfgCheckIdempotency cfg) $
82+ when (cfgCheckIdempotence cfg) $
80 let txt2 = printModule result1
83 let txt2 = printModule result1
81 in case diffText txt txt2 pathRendered of
84 in case diffText txt txt2 pathRendered of
82 Nothing -> return ()
85 Nothing -> return ()
@@ -93,7 +96,7 @@ ormolu cfg path str = do
93ormoluFile ::
96ormoluFile ::
94 MonadIO m =>
97 MonadIO m =>
95 -- | Ormolu configuration
98 -- | Ormolu configuration
96− Config ->
99+ Config RegionIndices ->
97 -- | Location of source file
100 -- | Location of source file
98 FilePath ->
101 FilePath ->
99 -- | Resulting rendition
102 -- | Resulting rendition
@@ -108,7 +111,7 @@ ormoluFile cfg path =
108ormoluStdin ::
111ormoluStdin ::
109 MonadIO m =>
112 MonadIO m =>
110 -- | Ormolu configuration
113 -- | Ormolu configuration
111− Config ->
114+ Config RegionIndices ->
112 -- | Resulting rendition
115 -- | Resulting rendition
113 m Text
116 m Text
114ormoluStdin cfg =
117ormoluStdin cfg =
@@ -121,7 +124,7 @@ ormoluStdin cfg =
121parseModule' ::
124parseModule' ::
122 MonadIO m =>
125 MonadIO m =>
123 -- | Ormolu configuration
126 -- | Ormolu configuration
124− Config ->
127+ Config RegionDeltas ->
125 -- | How to obtain 'OrmoluException' to throw when parsing fails
128 -- | How to obtain 'OrmoluException' to throw when parsing fails
126 (GHC.SrcSpan -> String -> OrmoluException) ->
129 (GHC.SrcSpan -> String -> OrmoluException) ->
127 -- | File name to use in errors
130 -- | File name to use in errors
src/Ormolu/Config.hs+52−6
@@ -1,7 +1,13 @@
1+{-# LANGUAGE DeriveFunctor #-}
2+{-# LANGUAGE RecordWildCards #-}
3+
1-- | Configuration options used by the tool.
4-- | Configuration options used by the tool.
2module Ormolu.Config
5module Ormolu.Config
3 ( Config (..),
6 ( Config (..),
7+ RegionIndices (..),
8+ RegionDeltas (..),
4 defaultConfig,
9 defaultConfig,
10+ regionIndicesToDeltas,
5 DynOption (..),
11 DynOption (..),
6 dynOptionToLocatedStr,
12 dynOptionToLocatedStr,
7 )
13 )
@@ -10,26 +16,66 @@ where
10import qualified SrcLoc as GHC
16import qualified SrcLoc as GHC
11
17
12-- | Ormolu configuration.
18-- | Ormolu configuration.
13−data Config = Config
19+data Config region = Config
14 { -- | Dynamic options to pass to GHC parser
20 { -- | Dynamic options to pass to GHC parser
15 cfgDynOptions :: ![DynOption],
21 cfgDynOptions :: ![DynOption],
16 -- | Do formatting faster but without automatic detection of defects
22 -- | Do formatting faster but without automatic detection of defects
17 cfgUnsafe :: !Bool,
23 cfgUnsafe :: !Bool,
18 -- | Output information useful for debugging
24 -- | Output information useful for debugging
19 cfgDebug :: !Bool,
25 cfgDebug :: !Bool,
20− -- | Checks if re-formatting the result is idempotent.
26+ -- | Checks if re-formatting the result is idempotent
21− cfgCheckIdempotency :: !Bool
27+ cfgCheckIdempotence :: !Bool,
28+ -- | Region selection
29+ cfgRegion :: !region
30+ }
31+ deriving (Eq, Show, Functor)
32+
33+-- | Region selection as the combination of start and end line numbers.
34+data RegionIndices = RegionIndices
35+ { -- | Start line of the region to format
36+ regionStartLine :: !(Maybe Int),
37+ -- | End line of the region to format
38+ regionEndLine :: !(Maybe Int)
39+ }
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
22 }
49 }
23 deriving (Eq, Show)
50 deriving (Eq, Show)
24
51
25−-- | Default 'Config'.
52+-- | Default @'Config' 'RegionIndices'@.
26−defaultConfig :: Config
53+defaultConfig :: Config RegionIndices
27defaultConfig =
54defaultConfig =
28 Config
55 Config
29 { cfgDynOptions = [],
56 { cfgDynOptions = [],
30 cfgUnsafe = False,
57 cfgUnsafe = False,
31 cfgDebug = False,
58 cfgDebug = False,
32− cfgCheckIdempotency = 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
33 }
79 }
34
80
35-- | A wrapper for dynamic options.
81-- | A wrapper for dynamic options.
src/Ormolu/Diff.hs+15−12
@@ -14,7 +14,8 @@ import Data.Text (Text)
14import qualified Data.Text as T
14import qualified Data.Text as T
15import qualified FastString as GHC
15import qualified FastString as GHC
16import GHC
16import GHC
17−import Ormolu.Imports (sortImports)
17+import Ormolu.Imports (normalizeImports)
18+import Ormolu.Parser.CommentStream
18import Ormolu.Parser.Result
19import Ormolu.Parser.Result
19import Ormolu.Utils
20import Ormolu.Utils
20
21
@@ -38,14 +39,16 @@ diffParseResult :: ParseResult -> ParseResult -> Diff
38diffParseResult
39diffParseResult
39 ParseResult
40 ParseResult
40 { prCommentStream = cstream0,
41 { prCommentStream = cstream0,
41− prParsedSource = ps0
42+ prParsedSource = hs0
42 }
43 }
43 ParseResult
44 ParseResult
44 { prCommentStream = cstream1,
45 { prCommentStream = cstream1,
45− prParsedSource = ps1
46+ prParsedSource = hs1
46 } =
47 } =
47 matchIgnoringSrcSpans cstream0 cstream1
48 matchIgnoringSrcSpans cstream0 cstream1
48− <> matchIgnoringSrcSpans ps0 ps1
49+ <> matchIgnoringSrcSpans
50+ hs0 {hsmodImports = normalizeImports (hsmodImports hs0)}
51+ hs1 {hsmodImports = normalizeImports (hsmodImports hs1)}
49
52
50-- | Compare two values for equality disregarding differences in 'SrcSpan's
53-- | Compare two values for equality disregarding differences in 'SrcSpan's
51-- and the ordering of import lists.
54-- and the ordering of import lists.
@@ -67,7 +70,7 @@ matchIgnoringSrcSpans = genericQuery
67 gzipWithQ
70 gzipWithQ
68 ( genericQuery
71 ( genericQuery
69 `extQ` srcSpanEq
72 `extQ` srcSpanEq
70− `extQ` hsModuleEq
73+ `extQ` commentEq
71 `extQ` sourceTextEq
74 `extQ` sourceTextEq
72 `extQ` hsDocStringEq
75 `extQ` hsDocStringEq
73 `extQ` importDeclQualifiedStyleEq
76 `extQ` importDeclQualifiedStyleEq
@@ -78,14 +81,14 @@ matchIgnoringSrcSpans = genericQuery
78 | otherwise = Different []
81 | otherwise = Different []
79 srcSpanEq :: SrcSpan -> GenericQ Diff
82 srcSpanEq :: SrcSpan -> GenericQ Diff
80 srcSpanEq _ _ = Same
83 srcSpanEq _ _ = Same
81− hsModuleEq :: HsModule GhcPs -> GenericQ Diff
84+ commentEq :: Comment -> GenericQ Diff
82− hsModuleEq hs0 hs1' =
85+ commentEq (Comment _ x) d =
83− case cast hs1' :: Maybe (HsModule GhcPs) of
86+ case cast d :: Maybe Comment of
84 Nothing -> Different []
87 Nothing -> Different []
85− Just hs1 ->
88+ Just (Comment _ y) ->
86− matchIgnoringSrcSpans
89+ if x == y
87− hs0 {hsmodImports = sortImports (hsmodImports hs0)}
90+ then Same
88− hs1 {hsmodImports = sortImports (hsmodImports hs1)}
91+ else Different []
89 sourceTextEq :: SourceText -> GenericQ Diff
92 sourceTextEq :: SourceText -> GenericQ Diff
90 sourceTextEq _ _ = Same
93 sourceTextEq _ _ = Same
91 importDeclQualifiedStyleEq :: ImportDeclQualifiedStyle -> GenericQ Diff
94 importDeclQualifiedStyleEq :: ImportDeclQualifiedStyle -> GenericQ Diff
src/Ormolu/Imports.hs+161−44
@@ -4,82 +4,199 @@
4
4
5-- | Manipulations on import lists.
5-- | Manipulations on import lists.
6module Ormolu.Imports
6module Ormolu.Imports
7− ( sortImports,
7+ ( normalizeImports,
8 )
8 )
9where
9where
10
10
11import Data.Bifunctor
11import Data.Bifunctor
12+import Data.Char (isAlphaNum)
12import Data.Function (on)
13import Data.Function (on)
13−import Data.Generics (gcompare)
14+import Data.List (foldl', nubBy, sortBy, sortOn)
14−import Data.List (sortBy)
15+import Data.Map.Strict (Map)
16+import qualified Data.Map.Strict as M
17+import FastString (FastString)
15import GHC hiding (GhcPs, IE)
18import GHC hiding (GhcPs, IE)
16import GHC.Hs.Extension
19import GHC.Hs.Extension
17import GHC.Hs.ImpExp (IE (..))
20import GHC.Hs.ImpExp (IE (..))
18−import Ormolu.Utils (notImplemented)
21+import Ormolu.Utils (notImplemented, showOutputable)
19
22
20−-- | Sort imports by module name. This also sorts explicit import lists for
23+-- | Sort and normalize imports.
21−-- each declaration.
22−sortImports :: [LImportDecl GhcPs] -> [LImportDecl GhcPs]
24+normalizeImports :: [LImportDecl GhcPs] -> [LImportDecl GhcPs]
23−sortImports = sortBy compareIdecl . fmap (fmap sortImportLists)
25+normalizeImports =
26+ fmap snd
27+ . M.toAscList
28+ . M.fromListWith combineImports
29+ . fmap (\x -> (importId x, g x))
24 where
30 where
25− sortImportLists :: ImportDecl GhcPs -> ImportDecl GhcPs
26− sortImportLists = \case
27− ImportDecl {..} ->
31+ g (L l ImportDecl {..}) =
32+ L
33+ l
28 ImportDecl
34 ImportDecl
29− { ideclHiding = second (fmap sortLies) <$> ideclHiding,
35+ { ideclHiding = second (fmap normalizeLies) <$> ideclHiding,
30 ..
36 ..
31 }
37 }
32− XImportDecl x -> noExtCon x
38+ g _ = notImplemented "XImportDecl"
33
39
40+-- | Combine two import declarations. It should be assumed that 'ImportId's
41+-- are equal.
42+combineImports ::
34−-- | Compare two @'LImportDecl' 'GhcPs'@ things.
43+ LImportDecl GhcPs ->
35−compareIdecl :: LImportDecl GhcPs -> LImportDecl GhcPs -> Ordering
44+ LImportDecl GhcPs ->
36−compareIdecl (L _ m0) (L _ m1) =
45+ LImportDecl GhcPs
37− case (isPrelude n0, isPrelude n1) of
46+combineImports (L lx ImportDecl {..}) (L _ y) =
38− (False, False) -> n0 `compare` n1
47+ L
39− (True, False) -> GT
48+ lx
40− (False, True) -> LT
49+ ImportDecl
41− (True, True) -> m0 `gcompare` m1
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
76+importId (L _ ImportDecl {..}) =
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+ }
42 where
91 where
43− n0 = unLoc (ideclName m0)
44− n1 = unLoc (ideclName m1)
45− isPrelude = (== "Prelude") . moduleNameString
92+ isPrelude = moduleNameString moduleName == "Prelude"
93+ moduleName = unLoc ideclName
94+importId _ = notImplemented "XImportDecl"
46
95
47−-- | Sort located import or export.
96+-- | Normalize a collection of import\/export items.
48−sortLies :: [LIE GhcPs] -> [LIE GhcPs]
97+normalizeLies :: [LIE GhcPs] -> [LIE GhcPs]
49−sortLies = sortBy (compareIE `on` unLoc) . fmap (fmap sortThings)
98+normalizeLies = sortOn (getIewn . unLoc) . M.elems . foldl' combine M.empty
99+ where
100+ combine ::
101+ Map IEWrappedNameOrd (LIE GhcPs) ->
102+ LIE GhcPs ->
103+ Map IEWrappedNameOrd (LIE GhcPs)
104+ combine m (L new_l new) =
105+ let wname = getIewn new
106+ normalizeWNames =
107+ nubBy (\x y -> compareLIewn x y == EQ) . sortBy compareLIewn
108+ alter = \case
109+ Nothing -> Just . L new_l $
110+ case new of
111+ IEThingWith NoExtField n wildcard g flbl ->
112+ IEThingWith NoExtField n wildcard (normalizeWNames g) flbl
113+ other -> other
114+ Just old ->
115+ let f = \case
116+ IEVar NoExtField n -> IEVar NoExtField n
117+ IEThingAbs NoExtField _ -> new
118+ IEThingAll NoExtField n -> IEThingAll NoExtField n
119+ IEThingWith NoExtField n wildcard g flbl ->
120+ case new of
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
50
151
51−-- | Sort imports\/exports inside of 'IEThingWith'.
152+-- | A wrapper for @'IEWrappedName' 'RdrName'@ that allows us to define an
52−sortThings :: IE GhcPs -> IE GhcPs
153+-- 'Ord' instance for it.
53−sortThings = \case
154+newtype IEWrappedNameOrd = IEWrappedNameOrd (IEWrappedName RdrName)
54− IEThingWith NoExtField x w xs fl ->
155+ deriving (Eq)
55− IEThingWith NoExtField x w (sortBy (compareIewn `on` unLoc) xs) fl
56− other -> other
57
156
58−-- | Compare two located imports or exports.
157+instance Ord IEWrappedNameOrd where
59−compareIE :: IE GhcPs -> IE GhcPs -> Ordering
158+ compare (IEWrappedNameOrd x) (IEWrappedNameOrd y) = compareIewn x y
60−compareIE = compareIewn `on` getIewn
61
159
62-- | Project @'IEWrappedName' 'RdrName'@ from @'IE' 'GhcPs'@.
160-- | Project @'IEWrappedName' 'RdrName'@ from @'IE' 'GhcPs'@.
63−getIewn :: IE GhcPs -> IEWrappedName RdrName
161+getIewn :: IE GhcPs -> IEWrappedNameOrd
64getIewn = \case
162getIewn = \case
65− IEVar NoExtField x -> unLoc x
163+ IEVar NoExtField x -> IEWrappedNameOrd (unLoc x)
66− IEThingAbs NoExtField x -> unLoc x
164+ IEThingAbs NoExtField x -> IEWrappedNameOrd (unLoc x)
67− IEThingAll NoExtField x -> unLoc x
165+ IEThingAll NoExtField x -> IEWrappedNameOrd (unLoc x)
68− IEThingWith NoExtField x _ _ _ -> unLoc x
166+ IEThingWith NoExtField x _ _ _ -> IEWrappedNameOrd (unLoc x)
69 IEModuleContents NoExtField _ -> notImplemented "IEModuleContents"
167 IEModuleContents NoExtField _ -> notImplemented "IEModuleContents"
70 IEGroup NoExtField _ _ -> notImplemented "IEGroup"
168 IEGroup NoExtField _ _ -> notImplemented "IEGroup"
71 IEDoc NoExtField _ -> notImplemented "IEDoc"
169 IEDoc NoExtField _ -> notImplemented "IEDoc"
72 IEDocNamed NoExtField _ -> notImplemented "IEDocNamed"
170 IEDocNamed NoExtField _ -> notImplemented "IEDocNamed"
73 XIE x -> noExtCon x
171 XIE x -> noExtCon x
74
172
173+-- | Like 'compareIewn' for located wrapped names.
174+compareLIewn :: LIEWrappedName RdrName -> LIEWrappedName RdrName -> Ordering
175+compareLIewn = compareIewn `on` unLoc
176+
75-- | Compare two @'IEWrapppedName' 'RdrName'@ things.
177-- | Compare two @'IEWrapppedName' 'RdrName'@ things.
76compareIewn :: IEWrappedName RdrName -> IEWrappedName RdrName -> Ordering
178compareIewn :: IEWrappedName RdrName -> IEWrappedName RdrName -> Ordering
77−compareIewn (IEName x) (IEName y) = unLoc x `compare` unLoc y
179+compareIewn (IEName x) (IEName y) = unLoc x `compareRdrName` unLoc y
78compareIewn (IEName _) (IEPattern _) = LT
180compareIewn (IEName _) (IEPattern _) = LT
79compareIewn (IEName _) (IEType _) = LT
181compareIewn (IEName _) (IEType _) = LT
80compareIewn (IEPattern _) (IEName _) = GT
182compareIewn (IEPattern _) (IEName _) = GT
81−compareIewn (IEPattern x) (IEPattern y) = unLoc x `compare` unLoc y
183+compareIewn (IEPattern x) (IEPattern y) = unLoc x `compareRdrName` unLoc y
82compareIewn (IEPattern _) (IEType _) = LT
184compareIewn (IEPattern _) (IEType _) = LT
83compareIewn (IEType _) (IEName _) = GT
185compareIewn (IEType _) (IEName _) = GT
84compareIewn (IEType _) (IEPattern _) = GT
186compareIewn (IEType _) (IEPattern _) = GT
85−compareIewn (IEType x) (IEType y) = unLoc x `compare` unLoc y
187+compareIewn (IEType x) (IEType y) = unLoc x `compareRdrName` 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+20−10
@@ -16,6 +16,7 @@ import Control.Monad.IO.Class
16import qualified Data.List as L
16import qualified Data.List as L
17import qualified Data.List.NonEmpty as NE
17import qualified Data.List.NonEmpty as NE
18import Data.Ord (Down (Down))
18import Data.Ord (Down (Down))
19+import qualified Data.Text as T
19import DynFlags as GHC
20import DynFlags as GHC
20import ErrUtils (Severity (..), errMsgSeverity, errMsgSpan)
21import ErrUtils (Severity (..), errMsgSeverity, errMsgSpan)
21import qualified FastString as GHC
22import qualified FastString as GHC
@@ -31,6 +32,7 @@ import Ormolu.Parser.Anns
31import Ormolu.Parser.CommentStream
32import Ormolu.Parser.CommentStream
32import Ormolu.Parser.Result
33import Ormolu.Parser.Result
33import Ormolu.Processing.Preprocess (preprocess)
34import Ormolu.Processing.Preprocess (preprocess)
35+import Ormolu.Utils (incSpanLine, removeIndentation)
34import qualified Panic as GHC
36import qualified Panic as GHC
35import qualified Parser as GHC
37import qualified Parser as GHC
36import qualified StringBuffer as GHC
38import qualified StringBuffer as GHC
@@ -39,7 +41,7 @@ import qualified StringBuffer as GHC
39parseModule ::
41parseModule ::
40 MonadIO m =>
42 MonadIO m =>
41 -- | Ormolu configuration
43 -- | Ormolu configuration
42− Config ->
44+ Config RegionDeltas ->
43 -- | File name (only for source location annotations)
45 -- | File name (only for source location annotations)
44 FilePath ->
46 FilePath ->
45 -- | Input for parser
47 -- | Input for parser
@@ -48,8 +50,10 @@ parseModule ::
48 ( [GHC.Warn],
50 ( [GHC.Warn],
49 Either (SrcSpan, String) ParseResult
51 Either (SrcSpan, String) ParseResult
50 )
52 )
51−parseModule Config {..} path input' = liftIO $ do
53+parseModule Config {..} path rawInput = liftIO $ do
52− let (input, extraComments) = preprocess path input'
54+ let (literalPrefix, indentedInput, literalSuffix, extraComments) =
55+ preprocess path rawInput cfgRegion
56+ (input, indent) = removeIndentation indentedInput
53 -- It's important that 'setDefaultExts' is done before
57 -- It's important that 'setDefaultExts' is done before
54 -- 'parsePragmasIntoDynFlags', because otherwise we might enable an
58 -- 'parsePragmasIntoDynFlags', because otherwise we might enable an
55 -- extension that was explicitly disabled in the file.
59 -- extension that was explicitly disabled in the file.
@@ -59,7 +63,7 @@ parseModule Config {..} path input' = liftIO $ do
59 (setDefaultExts baseDynFlags)
63 (setDefaultExts baseDynFlags)
60 extraOpts = dynOptionToLocatedStr <$> cfgDynOptions
64 extraOpts = dynOptionToLocatedStr <$> cfgDynOptions
61 (warnings, dynFlags) <-
65 (warnings, dynFlags) <-
62− parsePragmasIntoDynFlags baseFlags extraOpts path input' >>= \case
66+ parsePragmasIntoDynFlags baseFlags extraOpts path rawInput >>= \case
63 Right res -> pure res
67 Right res -> pure res
64 Left err ->
68 Left err ->
65 let loc =
69 let loc =
@@ -74,15 +78,18 @@ parseModule Config {..} path input' = liftIO $ do
74 (pluginModNames dynFlags)
78 (pluginModNames dynFlags)
75 pStateErrors = \pstate ->
79 pStateErrors = \pstate ->
76 let errs = bagToList $ GHC.getErrorMessages pstate dynFlags
80 let errs = bagToList $ GHC.getErrorMessages pstate dynFlags
81+ fixupErrSpan = incSpanLine (regionPrefixLength cfgRegion)
77 in case L.sortOn (Down . SeverityOrd . errMsgSeverity) errs of
82 in case L.sortOn (Down . SeverityOrd . errMsgSeverity) errs of
78 [] -> Nothing
83 [] -> Nothing
84+ err : _ ->
79− err : _ -> Just (errMsgSpan err, show err) -- Show instance returns a short error message
85+ -- Show instance returns a short error message
86+ Just (fixupErrSpan (errMsgSpan err), show err)
80 r = case runParser GHC.parseModule dynFlags path input of
87 r = case runParser GHC.parseModule dynFlags path input of
81 GHC.PFailed pstate ->
88 GHC.PFailed pstate ->
82 case pStateErrors pstate of
89 case pStateErrors pstate of
83 Just err -> Left err
90 Just err -> Left err
84− Nothing -> error "invariant violation: PFailed does not have an error"
91+ Nothing -> error "PFailed does not have an error"
85− GHC.POk pstate pmod ->
92+ GHC.POk pstate (L _ hsModule) ->
86 case pStateErrors pstate of
93 case pStateErrors pstate of
87 -- Some parse errors (pattern/arrow syntax in expr context)
94 -- Some parse errors (pattern/arrow syntax in expr context)
88 -- do not cause a parse error, but they are replaced with "_"
95 -- do not cause a parse error, but they are replaced with "_"
@@ -91,10 +98,10 @@ parseModule Config {..} path input' = liftIO $ do
91 Just err -> Left err
98 Just err -> Left err
92 Nothing ->
99 Nothing ->
93 let (stackHeader, shebangs, pragmas, comments) =
100 let (stackHeader, shebangs, pragmas, comments) =
94− mkCommentStream extraComments pstate
101+ mkCommentStream input extraComments pstate
95 in Right
102 in Right
96 ParseResult
103 ParseResult
97− { prParsedSource = pmod,
104+ { prParsedSource = hsModule,
98 prAnns = mkAnns pstate,
105 prAnns = mkAnns pstate,
99 prStackHeader = stackHeader,
106 prStackHeader = stackHeader,
100 prShebangs = shebangs,
107 prShebangs = shebangs,
@@ -102,7 +109,10 @@ parseModule Config {..} path input' = liftIO $ do
102 prCommentStream = comments,
109 prCommentStream = comments,
103 prUseRecordDot = useRecordDot,
110 prUseRecordDot = useRecordDot,
104 prImportQualifiedPost =
111 prImportQualifiedPost =
105− GHC.xopt ImportQualifiedPost dynFlags
112+ GHC.xopt ImportQualifiedPost dynFlags,
113+ prLiteralPrefix = T.pack literalPrefix,
114+ prLiteralSuffix = T.pack literalSuffix,
115+ prIndent = indent
106 }
116 }
107 return (warnings, r)
117 return (warnings, r)
108
118
src/Ormolu/Parser/CommentStream.hs+126−60
@@ -4,12 +4,16 @@
4
4
5-- | Functions for working with comment stream.
5-- | Functions for working with comment stream.
6module Ormolu.Parser.CommentStream
6module Ormolu.Parser.CommentStream
7− ( CommentStream (..),
7+ ( -- * Comment stream
8− Comment (..),
8+ CommentStream (..),
9 mkCommentStream,
9 mkCommentStream,
10− isPrevHaddock,
11− isMultilineComment,
12 showCommentStream,
10 showCommentStream,
11+
12+ -- * Comment
13+ Comment (..),
14+ unComment,
15+ hasAtomsBefore,
16+ isMultilineComment,
13 )
17 )
14where
18where
15
19
@@ -23,23 +27,24 @@ import qualified GHC
23import qualified Lexer as GHC
27import qualified Lexer as GHC
24import Ormolu.Parser.Pragma
28import Ormolu.Parser.Pragma
25import Ormolu.Parser.Shebang
29import Ormolu.Parser.Shebang
30+import Ormolu.Processing.Common
26−import Ormolu.Utils (showOutputable)
31+import Ormolu.Utils (onTheSameLine, showOutputable)
27import SrcLoc
32import SrcLoc
28
33
34+----------------------------------------------------------------------------
35+-- Comment stream
36+
29-- | A stream of 'RealLocated' 'Comment's in ascending order with respect to
37-- | A stream of 'RealLocated' 'Comment's in ascending order with respect to
30-- beginning of corresponding spans.
38-- beginning of corresponding spans.
31newtype CommentStream = CommentStream [RealLocated Comment]
39newtype CommentStream = CommentStream [RealLocated Comment]
32 deriving (Eq, Data, Semigroup, Monoid)
40 deriving (Eq, Data, Semigroup, Monoid)
33
41
34−-- | A wrapper for a single comment. The 'NonEmpty' list inside contains
35−-- lines of multiline comment @{- … -}@ or just single item\/line otherwise.
36−newtype Comment = Comment (NonEmpty String)
37− deriving (Eq, Show, Data)
38−
39-- | Create 'CommentStream' from 'GHC.PState'. The pragmas and shebangs are
42-- | Create 'CommentStream' from 'GHC.PState'. The pragmas and shebangs are
40-- removed from the 'CommentStream'. Shebangs are only extracted from the
43-- removed from the 'CommentStream'. Shebangs are only extracted from the
41-- comments that come from the first argument.
44-- comments that come from the first argument.
42mkCommentStream ::
45mkCommentStream ::
46+ -- | Original input
47+ String ->
43 -- | Extra comments to include
48 -- | Extra comments to include
44 [Located String] ->
49 [Located String] ->
45 -- | Parser state to use for comment extraction
50 -- | Parser state to use for comment extraction
@@ -50,14 +55,14 @@ mkCommentStream ::
50 [([RealLocated Comment], Pragma)],
55 [([RealLocated Comment], Pragma)],
51 CommentStream
56 CommentStream
52 )
57 )
53−mkCommentStream extraComments pstate =
58+mkCommentStream input extraComments pstate =
54 ( mstackHeader,
59 ( mstackHeader,
55 shebangs,
60 shebangs,
56 pragmas,
61 pragmas,
57 CommentStream comments
62 CommentStream comments
58 )
63 )
59 where
64 where
60− (comments, pragmas) = extractPragmas rawComments1
65+ (comments, pragmas) = extractPragmas input rawComments1
61 (rawComments1, mstackHeader) = extractStackHeader rawComments0
66 (rawComments1, mstackHeader) = extractStackHeader rawComments0
62 rawComments0 =
67 rawComments0 =
63 L.sortOn (realSrcSpanStart . getRealSrcSpan) . mapMaybe toRealSpan $
68 L.sortOn (realSrcSpanStart . getRealSrcSpan) . mapMaybe toRealSpan $
@@ -68,15 +73,6 @@ mkCommentStream extraComments pstate =
68 (GHC.annotations_comments pstate)
73 (GHC.annotations_comments pstate)
69 (shebangs, otherExtraComments) = extractShebangs extraComments
74 (shebangs, otherExtraComments) = extractShebangs extraComments
70
75
71−-- | Test whether a 'Comment' looks like a Haddock following a definition,
72−-- i.e. something starting with @-- ^@.
73−isPrevHaddock :: Comment -> Bool
74−isPrevHaddock (Comment (x :| _)) = "-- ^" `L.isPrefixOf` x
75−
76−-- | Is this comment multiline-style?
77−isMultilineComment :: Comment -> Bool
78−isMultilineComment (Comment (x :| _)) = "{-" `L.isPrefixOf` x
79−
80-- | Pretty-print a 'CommentStream'.
76-- | Pretty-print a 'CommentStream'.
81showCommentStream :: CommentStream -> String
77showCommentStream :: CommentStream -> String
82showCommentStream (CommentStream xs) =
78showCommentStream (CommentStream xs) =
@@ -86,75 +82,145 @@ showCommentStream (CommentStream xs) =
86 showComment (GHC.L l str) = showOutputable l ++ " " ++ show str
82 showComment (GHC.L l str) = showOutputable l ++ " " ++ show str
87
83
88----------------------------------------------------------------------------
84----------------------------------------------------------------------------
89−-- Helpers
85+-- Comment
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)
90
93
91-- | Normalize comment string. Sometimes one multi-line comment is turned
94-- | Normalize comment string. Sometimes one multi-line comment is turned
92-- into several lines for subsequent outputting with correct indentation for
95-- into several lines for subsequent outputting with correct indentation for
93-- each line.
96-- each line.
94−mkComment :: RealLocated String -> RealLocated Comment
97+mkComment ::
95−mkComment (L l s) =
98+ -- | Lines of original input with their indices
96− L l . Comment . fmap dropTrailing $
99+ [(Int, String)] ->
97− if "{-" `L.isPrefixOf` s
100+ -- | Raw comment string
98− then case NE.nonEmpty (lines s) of
101+ RealLocated String ->
99− Nothing -> s :| []
102+ -- | Remaining lines of original input and the constructed 'Comment'
100− Just (x :| xs) ->
103+ ([(Int, String)], RealLocated Comment)
101− let getIndent y =
104+mkComment ls (L l s) = (ls', comment)
102− if all isSpace y
103− then startIndent
104− else length (takeWhile isSpace y)
105− n = minimum (startIndent : fmap getIndent xs)
106− in x :| (drop n <$> xs)
107− else s :| []
108 where
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'')
109 dropTrailing = L.dropWhileEnd isSpace
131 dropTrailing = L.dropWhileEnd isSpace
110 startIndent = srcSpanStartCol l - 1
132 startIndent = srcSpanStartCol l - 1
133+ commentLine = srcSpanStartLine l
111
134
112−-- | Get a 'String' from 'GHC.AnnotationComment'.
135+-- | Get a collection of lines from a 'Comment'.
113−unAnnotationComment :: GHC.AnnotationComment -> Maybe String
136+unComment :: Comment -> NonEmpty String
114−unAnnotationComment = \case
137+unComment (Comment _ xs) = xs
115− GHC.AnnDocCommentNext _ -> Nothing -- @-- |@
116− GHC.AnnDocCommentPrev _ -> Nothing -- @-- ^@
117− GHC.AnnDocCommentNamed _ -> Nothing -- @-- $@
118− GHC.AnnDocSection _ _ -> Nothing -- @-- *@
119− GHC.AnnDocOptions s -> Just s
120− GHC.AnnLineComment s -> Just s
121− GHC.AnnBlockComment s -> Just s
122
138
123−liftMaybe :: Located (Maybe a) -> Maybe (Located a)
139+-- | Check whether the 'Comment' had some non-whitespace atoms in front of
124−liftMaybe = \case
140+-- it in the original input.
125− L _ Nothing -> Nothing
141+hasAtomsBefore :: Comment -> Bool
126− L l (Just a) -> Just (L l a)
142+hasAtomsBefore (Comment atomsBefore _) = atomsBefore
127
143
128−toRealSpan :: Located a -> Maybe (RealLocated a)
144+-- | Is this comment multiline-style?
129−toRealSpan (L (RealSrcSpan l) a) = Just (L l a)
145+isMultilineComment :: Comment -> Bool
130−toRealSpan _ = Nothing
146+isMultilineComment (Comment _ (x :| _)) = "{-" `L.isPrefixOf` x
147+
148+----------------------------------------------------------------------------
149+-- Helpers
131
150
132-- | Detect and extract stack header if it is present.
151-- | Detect and extract stack header if it is present.
133extractStackHeader ::
152extractStackHeader ::
153+ -- | Comment stream to analyze
134 [RealLocated String] ->
154 [RealLocated String] ->
135 ([RealLocated String], Maybe (RealLocated Comment))
155 ([RealLocated String], Maybe (RealLocated Comment))
136extractStackHeader = \case
156extractStackHeader = \case
137 [] -> ([], Nothing)
157 [] -> ([], Nothing)
138 (x : xs) ->
158 (x : xs) ->
139− let comment = mkComment x
159+ let comment = snd (mkComment [] x)
140 in if isStackHeader (unRealSrcSpan comment)
160 in if isStackHeader (unRealSrcSpan comment)
141 then (xs, Just comment)
161 then (xs, Just comment)
142 else (x : xs, Nothing)
162 else (x : xs, Nothing)
143 where
163 where
144− isStackHeader (Comment (x :| _)) =
164+ isStackHeader (Comment _ (x :| _)) =
145 "stack" `L.isPrefixOf` dropWhile isSpace (drop 2 x)
165 "stack" `L.isPrefixOf` dropWhile isSpace (drop 2 x)
146
166
147-- | Extract pragmas and their associated comments.
167-- | Extract pragmas and their associated comments.
148extractPragmas ::
168extractPragmas ::
169+ -- | Input
170+ String ->
171+ -- | Comment stream to analyze
149 [RealLocated String] ->
172 [RealLocated String] ->
150 ([RealLocated Comment], [([RealLocated Comment], Pragma)])
173 ([RealLocated Comment], [([RealLocated Comment], Pragma)])
151−extractPragmas = go id id
174+extractPragmas input = go initialLs id id
152 where
175 where
176+ initialLs = zip [1 ..] (lines input)
153− go csSoFar pragmasSoFar = \case
177+ go ls csSoFar pragmasSoFar = \case
154 [] -> (csSoFar [], pragmasSoFar [])
178 [] -> (csSoFar [], pragmasSoFar [])
155 (x : xs) ->
179 (x : xs) ->
156 case parsePragma (unRealSrcSpan x) of
180 case parsePragma (unRealSrcSpan x) of
181+ Nothing ->
182+ let (ls', x') = mkComment ls x
157− Nothing -> go (csSoFar . (mkComment x :)) pragmasSoFar xs
183+ in go ls' (csSoFar . (x' :)) pragmasSoFar xs
158 Just pragma ->
184 Just pragma ->
159− let combined = (csSoFar [], pragma)
185+ let combined ys = (csSoFar ys, pragma)
160− in go id (pragmasSoFar . (combined :)) xs
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+
197+-- | Get a 'String' from 'GHC.AnnotationComment'.
198+unAnnotationComment :: GHC.AnnotationComment -> Maybe String
199+unAnnotationComment = \case
200+ GHC.AnnDocCommentNext _ -> Nothing -- @-- |@
201+ GHC.AnnDocCommentPrev _ -> Nothing -- @-- ^@
202+ GHC.AnnDocCommentNamed _ -> Nothing -- @-- $@
203+ GHC.AnnDocSection _ _ -> Nothing -- @-- *@
204+ GHC.AnnDocOptions s -> Just s
205+ GHC.AnnLineComment s -> Just s
206+ GHC.AnnBlockComment s -> Just s
207+
208+liftMaybe :: Located (Maybe a) -> Maybe (Located a)
209+liftMaybe = \case
210+ L _ Nothing -> Nothing
211+ L l (Just a) -> Just (L l a)
212+
213+toRealSpan :: Located a -> Maybe (RealLocated a)
214+toRealSpan (L (RealSrcSpan l) a) = Just (L l a)
215+toRealSpan _ = Nothing
216+
217+-- | Remove consecutive blank lines.
218+removeConseqBlanks :: NonEmpty String -> NonEmpty String
219+removeConseqBlanks (x :| xs) = x :| go (null x) id xs
220+ where
221+ go seenBlank acc = \case
222+ [] -> acc []
223+ (y : ys) ->
224+ if seenBlank && null y
225+ then go True acc ys
226+ else go (null y) (acc . (y :)) ys
src/Ormolu/Parser/Result.hs+9−2
@@ -7,6 +7,7 @@ module Ormolu.Parser.Result
7 )
7 )
8where
8where
9
9
10+import Data.Text (Text)
10import GHC
11import GHC
11import Ormolu.Parser.Anns
12import Ormolu.Parser.Anns
12import Ormolu.Parser.CommentStream
13import Ormolu.Parser.CommentStream
@@ -16,7 +17,7 @@ import Ormolu.Parser.Shebang (Shebang)
16-- | A collection of data that represents a parsed module in Ormolu.
17-- | A collection of data that represents a parsed module in Ormolu.
17data ParseResult = ParseResult
18data ParseResult = ParseResult
18 { -- | 'ParsedSource' from GHC
19 { -- | 'ParsedSource' from GHC
19− prParsedSource :: ParsedSource,
20+ prParsedSource :: HsModule GhcPs,
20 -- | Ormolu-specfic representation of annotations
21 -- | Ormolu-specfic representation of annotations
21 prAnns :: Anns,
22 prAnns :: Anns,
22 -- | Stack header
23 -- | Stack header
@@ -30,7 +31,13 @@ data ParseResult = ParseResult
30 -- | Whether or not record dot syntax is enabled
31 -- | Whether or not record dot syntax is enabled
31 prUseRecordDot :: Bool,
32 prUseRecordDot :: Bool,
32 -- | Whether or not ImportQualifiedPost is enabled
33 -- | Whether or not ImportQualifiedPost is enabled
33− prImportQualifiedPost :: Bool
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
34 }
41 }
35
42
36-- | Pretty-print a 'ParseResult'.
43-- | Pretty-print a 'ParseResult'.
src/Ormolu/Printer.hs+16−13
@@ -20,16 +20,19 @@ printModule ::
20 -- | Resulting rendition
20 -- | Resulting rendition
21 Text
21 Text
22printModule ParseResult {..} =
22printModule ParseResult {..} =
23+ prLiteralPrefix <> region <> prLiteralSuffix
24+ where
25+ region =
23− postprocess $
26+ postprocess prIndent $
24− runR
27+ runR
25− ( p_hsModule
28+ ( p_hsModule
26− prStackHeader
29+ prStackHeader
27− prShebangs
30+ prShebangs
28− prPragmas
31+ prPragmas
29− prImportQualifiedPost
32+ prImportQualifiedPost
30− prParsedSource
33+ prParsedSource
31− )
34+ )
32− (mkSpanStream prParsedSource)
35+ (mkSpanStream prParsedSource)
33− prCommentStream
36+ prCommentStream
34− prAnns
37+ prAnns
35− prUseRecordDot
38+ prUseRecordDot
src/Ormolu/Printer/Combinators.hs+34−26
@@ -21,6 +21,7 @@ module Ormolu.Printer.Combinators
21 space,
21 space,
22 newline,
22 newline,
23 inci,
23 inci,
24+ inciIf,
24 located,
25 located,
25 located',
26 located',
26 switchLayout,
27 switchLayout,
@@ -51,6 +52,8 @@ module Ormolu.Printer.Combinators
51
52
52 -- ** Literals
53 -- ** Literals
53 comma,
54 comma,
55+ commaDel,
56+ equals,
54
57
55 -- ** Stateful markers
58 -- ** Stateful markers
56 SpanMark (..),
59 SpanMark (..),
@@ -62,48 +65,44 @@ module Ormolu.Printer.Combinators
62where
65where
63
66
64import Control.Monad
67import Control.Monad
65−import Data.Data (Data)
66import Data.List (intersperse)
68import Data.List (intersperse)
67import Data.Text (Text)
69import Data.Text (Text)
68import Ormolu.Printer.Comments
70import Ormolu.Printer.Comments
69import Ormolu.Printer.Internal
71import Ormolu.Printer.Internal
70−import Ormolu.Utils (isModule)
71import SrcLoc
72import SrcLoc
72
73
73----------------------------------------------------------------------------
74----------------------------------------------------------------------------
74-- Basic
75-- Basic
75
76
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+
76-- | Enter a 'Located' entity. This combinator handles outputting comments
86-- | Enter a 'Located' entity. This combinator handles outputting comments
77-- and sets layout (single-line vs multi-line) for the inner computation.
87-- and sets layout (single-line vs multi-line) for the inner computation.
78-- Roughly, the rule for using 'located' is that every time there is a
88-- Roughly, the rule for using 'located' is that every time there is a
79-- 'Located' wrapper, it should be “discharged” with a corresponding
89-- 'Located' wrapper, it should be “discharged” with a corresponding
80-- 'located' invocation.
90-- 'located' invocation.
81located ::
91located ::
82− Data a =>
83 -- | Thing to enter
92 -- | Thing to enter
84 Located a ->
93 Located a ->
85 -- | How to render inner value
94 -- | How to render inner value
86 (a -> R ()) ->
95 (a -> R ()) ->
87 R ()
96 R ()
88−located loc f = do
97+located (L (UnhelpfulSpan _) a) f = f a
89− let withRealLocated (L l a) g =
98+located (L (RealSrcSpan l) a) f = do
90− case l of
91− UnhelpfulSpan _ -> return ()
92− RealSrcSpan l' -> g (L l' a)
93− withRealLocated loc spitPrecedingComments
99+ spitPrecedingComments l
94− let setEnclosingSpan =
95− case getLoc loc of
96− UnhelpfulSpan _ -> id
97− RealSrcSpan orf ->
98− if isModule (unLoc loc)
99− then id
100− else withEnclosingSpan orf
100+ withEnclosingSpan l $
101− setEnclosingSpan $ switchLayout [getLoc loc] (f (unLoc loc))
101+ switchLayout [RealSrcSpan l] (f a)
102− withRealLocated loc spitFollowingComments
102+ spitFollowingComments l
103
103
104-- | A version of 'located' with arguments flipped.
104-- | A version of 'located' with arguments flipped.
105located' ::
105located' ::
106− Data a =>
107 -- | How to render inner value
106 -- | How to render inner value
108 (a -> R ()) ->
107 (a -> R ()) ->
109 -- | Thing to enter
108 -- | Thing to enter
@@ -186,10 +185,12 @@ sepSemi f xs = vlayout singleLine multiLine
186 xs' ->
185 xs' ->
187 if ub
186 if ub
188 then do
187 then do
189− txt "{ "
188+ txt "{"
189+ space
190− sep (txt "; ") (dontUseBraces . f) xs'
190+ sep (txt ";" >> space) (dontUseBraces . f) xs'
191+ space
191− txt " }"
192+ txt "}"
192− else sep (txt "; ") f xs'
193+ else sep (txt ";" >> space) f xs'
193 multiLine =
194 multiLine =
194 sep newline (dontUseBraces . f) xs
195 sep newline (dontUseBraces . f) xs
195
196
@@ -202,6 +203,7 @@ data BracketStyle
202 N
203 N
203 | -- | Shifted one level
204 | -- | Shifted one level
204 S
205 S
206+ deriving (Eq, Show)
205
207
206-- | Surround given entity by backticks.
208-- | Surround given entity by backticks.
207backticks :: R () -> R ()
209backticks :: R () -> R ()
@@ -278,9 +280,7 @@ brackets_ needBreaks open close style m = sitcc (vlayout singleLine multiLine)
278 then newline >> inci m
280 then newline >> inci m
279 else space >> sitcc m
281 else space >> sitcc m
280 newline
282 newline
281− case style of
282− N -> txt close
283− S -> inci (txt close)
283+ inciIf (style == S) (txt close)
284
284
285----------------------------------------------------------------------------
285----------------------------------------------------------------------------
286-- Literals
286-- Literals
@@ -288,3 +288,11 @@ brackets_ needBreaks open close style m = sitcc (vlayout singleLine multiLine)
288-- | Print @,@.
288-- | Print @,@.
289comma :: R ()
289comma :: R ()
290comma = txt ","
290comma = 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+41−51
@@ -13,13 +13,11 @@ module Ormolu.Printer.Comments
13where
13where
14
14
15import Control.Monad
15import Control.Monad
16−import Data.Coerce (coerce)
17−import Data.Data (Data)
18import qualified Data.List.NonEmpty as NE
16import qualified Data.List.NonEmpty as NE
17+import Data.Maybe (listToMaybe)
19import qualified Data.Text as T
18import qualified Data.Text as T
20import Ormolu.Parser.CommentStream
19import Ormolu.Parser.CommentStream
21import Ormolu.Printer.Internal
20import Ormolu.Printer.Internal
22−import Ormolu.Utils (isModule)
23import SrcLoc
21import SrcLoc
24
22
25----------------------------------------------------------------------------
23----------------------------------------------------------------------------
@@ -27,9 +25,8 @@ import SrcLoc
27
25
28-- | Output all preceding comments for an element at given location.
26-- | Output all preceding comments for an element at given location.
29spitPrecedingComments ::
27spitPrecedingComments ::
30− Data a =>
31− -- | AST element to attach comments to
28+ -- | Span of the element to attach comments to
32− RealLocated a ->
29+ RealSrcSpan ->
33 R ()
30 R ()
34spitPrecedingComments ref = do
31spitPrecedingComments ref = do
35 gotSome <- handleCommentSeries (spitPrecedingComment ref)
32 gotSome <- handleCommentSeries (spitPrecedingComment ref)
@@ -37,16 +34,15 @@ spitPrecedingComments ref = do
37 lastMark <- getSpanMark
34 lastMark <- getSpanMark
38 -- Insert a blank line between the preceding comments and the thing
35 -- Insert a blank line between the preceding comments and the thing
39 -- after them if there was a blank line in the input.
36 -- after them if there was a blank line in the input.
40− when (needsNewlineBefore (getRealSrcSpan ref) lastMark) newline
37+ when (needsNewlineBefore ref lastMark) newline
41
38
42-- | Output all comments following an element at given location.
39-- | Output all comments following an element at given location.
43spitFollowingComments ::
40spitFollowingComments ::
44− Data a =>
45− -- | AST element of attach comments to
41+ -- | Span of the element to attach comments to
46− RealLocated a ->
42+ RealSrcSpan ->
47 R ()
43 R ()
48spitFollowingComments ref = do
44spitFollowingComments ref = do
49− trimSpanStream (getRealSrcSpan ref)
45+ trimSpanStream ref
50 void $ handleCommentSeries (spitFollowingComment ref)
46 void $ handleCommentSeries (spitFollowingComment ref)
51
47
52-- | Output all remaining comments in the comment stream.
48-- | Output all remaining comments in the comment stream.
@@ -62,49 +58,41 @@ spitRemainingComments = do
62
58
63-- | Output a single preceding comment for an element at given location.
59-- | Output a single preceding comment for an element at given location.
64spitPrecedingComment ::
60spitPrecedingComment ::
65− Data a =>
66− -- | AST element to attach comments to
61+ -- | Span of the element to attach comments to
67− RealLocated a ->
62+ RealSrcSpan ->
68− -- | Location of last comment in the series
69− Maybe SpanMark ->
70 -- | Are we done?
63 -- | Are we done?
71 R Bool
64 R Bool
72−spitPrecedingComment (L ref a) mlastMark = do
65+spitPrecedingComment ref = do
66+ mlastMark <- getSpanMark
73 let p (L l _) = realSrcSpanEnd l <= realSrcSpanStart ref
67 let p (L l _) = realSrcSpanEnd l <= realSrcSpanStart ref
74 withPoppedComment p $ \l comment -> do
68 withPoppedComment p $ \l comment -> do
75− dirtyLine <-
69+ lineSpans <- thisLineSpans
76− case mlastMark of
70+ let thisCommentLine = srcLocLine (realSrcSpanStart l)
77− -- When the current line is dirty it means that something that can
71+ needsNewline =
78− -- have comments attached to it is already on the line. To avoid
72+ case listToMaybe lineSpans of
79− -- problems with idempotence we cannot output the first comment
73+ Nothing -> False
80− -- immediately because it'll be attached to the previous element (on
74+ Just spn -> srcLocLine (realSrcSpanEnd spn) /= thisCommentLine
81− -- the same line) on the next run, so we play safe here and output
82− -- an extra 'newline' in this case.
83− Nothing -> isLineDirty -- only for very first preceding comment
84− Just _ -> return False
85− when (dirtyLine || needsNewlineBefore l mlastMark) newline
75+ when (needsNewline || needsNewlineBefore l mlastMark) newline
86 spitCommentNow l comment
76 spitCommentNow l comment
87− if theSameLinePre l ref && not (isModule a)
77+ if theSameLinePre l ref
88 then space
78 then space
89 else newline
79 else newline
90
80
91-- | Output a comment that follows element at given location immediately on
81-- | Output a comment that follows element at given location immediately on
92-- the same line, if there is any.
82-- the same line, if there is any.
93spitFollowingComment ::
83spitFollowingComment ::
94− Data a =>
95 -- | AST element to attach comments to
84 -- | AST element to attach comments to
96− RealLocated a ->
85+ RealSrcSpan ->
97− -- | Location of last comment in the series
98− Maybe SpanMark ->
99 -- | Are we done?
86 -- | Are we done?
100 R Bool
87 R Bool
101−spitFollowingComment (L ref a) mlastMark = do
88+spitFollowingComment ref = do
89+ mlastMark <- getSpanMark
102 mnSpn <- nextEltSpan
90 mnSpn <- nextEltSpan
103 -- Get first enclosing span that is not equal to reference span, i.e. it's
91 -- Get first enclosing span that is not equal to reference span, i.e. it's
104 -- truly something enclosing the AST element.
92 -- truly something enclosing the AST element.
105 meSpn <- getEnclosingSpan (/= ref)
93 meSpn <- getEnclosingSpan (/= ref)
106 withPoppedComment (commentFollowsElt ref mnSpn meSpn mlastMark) $ \l comment ->
94 withPoppedComment (commentFollowsElt ref mnSpn meSpn mlastMark) $ \l comment ->
107− if theSameLinePost l ref && not (isModule a)
95+ if theSameLinePost l ref
108 then
96 then
109 if isMultilineComment comment
97 if isMultilineComment comment
110 then space >> spitCommentNow l comment
98 then space >> spitCommentNow l comment
@@ -116,11 +104,10 @@ spitFollowingComment (L ref a) mlastMark = do
116
104
117-- | Output a single remaining comment from the comment stream.
105-- | Output a single remaining comment from the comment stream.
118spitRemainingComment ::
106spitRemainingComment ::
119− -- | Location of last comment in the series
120− Maybe SpanMark ->
121 -- | Are we done?
107 -- | Are we done?
122 R Bool
108 R Bool
123−spitRemainingComment mlastMark =
109+spitRemainingComment = do
110+ mlastMark <- getSpanMark
124 withPoppedComment (const True) $ \l comment -> do
111 withPoppedComment (const True) $ \l comment -> do
125 when (needsNewlineBefore l mlastMark) newline
112 when (needsNewlineBefore l mlastMark) newline
126 spitCommentNow l comment
113 spitCommentNow l comment
@@ -133,13 +120,13 @@ spitRemainingComment mlastMark =
133handleCommentSeries ::
120handleCommentSeries ::
134 -- | Given location of previous comment, output the next comment
121 -- | Given location of previous comment, output the next comment
135 -- returning 'True' if we're done
122 -- returning 'True' if we're done
136− (Maybe SpanMark -> R Bool) ->
123+ R Bool ->
137 -- | Whether we printed any comments
124 -- | Whether we printed any comments
138 R Bool
125 R Bool
139handleCommentSeries f = go False
126handleCommentSeries f = go False
140 where
127 where
141 go gotSome = do
128 go gotSome = do
142− done <- getSpanMark >>= f
129+ done <- f
143 if done
130 if done
144 then return gotSome
131 then return gotSome
145 else go True
132 else go True
@@ -167,6 +154,7 @@ needsNewlineBefore ::
167 -- | Last printed comment span
154 -- | Last printed comment span
168 Maybe SpanMark ->
155 Maybe SpanMark ->
169 Bool
156 Bool
157+needsNewlineBefore _ (Just (HaddockSpan _ _)) = True
170needsNewlineBefore l mlastMark =
158needsNewlineBefore l mlastMark =
171 case spanMarkSpan <$> mlastMark of
159 case spanMarkSpan <$> mlastMark of
172 Nothing -> False
160 Nothing -> False
@@ -219,9 +207,8 @@ commentFollowsElt ref mnSpn meSpn mlastMark (L l comment) =
219 -- 2) The comment logically belongs to the element, four cases:
207 -- 2) The comment logically belongs to the element, four cases:
220 logicallyFollows =
208 logicallyFollows =
221 theSameLinePost l ref -- a) it's on the same line
209 theSameLinePost l ref -- a) it's on the same line
222− || isPrevHaddock comment -- b) it's a Haddock string starting with -- ^
223− || continuation -- c) it's a continuation of a comment block
210+ || continuation -- b) it's a continuation of a comment block
224− || lastInEnclosing -- d) it's the last element in the enclosing construct
211+ || lastInEnclosing -- c) it's the last element in the enclosing construct
225
212
226 -- 3) There is no other AST element between this element and the comment:
213 -- 3) There is no other AST element between this element and the comment:
227 noEltBetween =
214 noEltBetween =
@@ -248,12 +235,15 @@ commentFollowsElt ref mnSpn meSpn mlastMark (L l comment) =
248 >= abs (startColumn ref - startColumn l)
235 >= abs (startColumn ref - startColumn l)
249 )
236 )
250 continuation =
237 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)
251− case mlastMark of
241+ && ( case mlastMark of
252− Just (HaddockSpan _ spn) ->
242+ Just (HaddockSpan _ _) -> False
253− srcSpanEndLine spn + 1 == srcSpanStartLine l
254− Just (CommentSpan spn) ->
243+ Just (CommentSpan spn) ->
255− srcSpanEndLine spn + 1 == srcSpanStartLine l
244+ srcSpanEndLine spn + 1 == srcSpanStartLine l
256− _ -> False
245+ _ -> False
246+ )
257 lastInEnclosing =
247 lastInEnclosing =
258 case meSpn of
248 case meSpn of
259 -- When there is no enclosing element, return false
249 -- When there is no enclosing element, return false
@@ -275,7 +265,7 @@ spitCommentNow spn comment = do
275 . sequence_
265 . sequence_
276 . NE.intersperse newline
266 . NE.intersperse newline
277 . fmap (txt . T.pack)
267 . fmap (txt . T.pack)
278− . coerce
268+ . unComment
279 $ comment
269 $ comment
280 setSpanMark (CommentSpan spn)
270 setSpanMark (CommentSpan spn)
281
271
@@ -291,6 +281,6 @@ spitCommentPending position spn comment = do
291 . sequence_
281 . sequence_
292 . NE.toList
282 . NE.toList
293 . fmap (registerPendingCommentLine position . T.pack)
283 . fmap (registerPendingCommentLine position . T.pack)
294− . coerce
284+ . unComment
295 $ comment
285 $ comment
296 setSpanMark (CommentSpan spn)
286 setSpanMark (CommentSpan spn)
src/Ormolu/Printer/Internal.hs+85−52
@@ -14,10 +14,10 @@ module Ormolu.Printer.Internal
14
14
15 -- * Internal functions
15 -- * Internal functions
16 txt,
16 txt,
17+ interferingTxt,
17 atom,
18 atom,
18 space,
19 space,
19 newline,
20 newline,
20− isLineDirty,
21 useRecordDot,
21 useRecordDot,
22 inci,
22 inci,
23 sitcc,
23 sitcc,
@@ -39,6 +39,7 @@ module Ormolu.Printer.Internal
39 popComment,
39 popComment,
40 getEnclosingSpan,
40 getEnclosingSpan,
41 withEnclosingSpan,
41 withEnclosingSpan,
42+ thisLineSpans,
42
43
43 -- * Stateful markers
44 -- * Stateful markers
44 SpanMark (..),
45 SpanMark (..),
@@ -98,18 +99,19 @@ data RC = RC
98data SC = SC
99data SC = SC
99 { -- | Index of the next column to render
100 { -- | Index of the next column to render
100 scColumn :: !Int,
101 scColumn :: !Int,
102+ -- | Indentation level that was used for the current line
103+ scIndent :: !Int,
101 -- | Rendered source code so far
104 -- | Rendered source code so far
102 scBuilder :: Builder,
105 scBuilder :: Builder,
103 -- | Span stream
106 -- | Span stream
104 scSpanStream :: SpanStream,
107 scSpanStream :: SpanStream,
108+ -- | Spans of atoms that have been printed on the current line so far
109+ scThisLineSpans :: [RealSrcSpan],
105 -- | Comment stream
110 -- | Comment stream
106 scCommentStream :: CommentStream,
111 scCommentStream :: CommentStream,
107 -- | Pending comment lines (in reverse order) to be inserted before next
112 -- | Pending comment lines (in reverse order) to be inserted before next
108 -- newline, 'Int' is the indentation level
113 -- newline, 'Int' is the indentation level
109− scPendingComments :: ![(CommentPosition, Int, Text)],
114+ scPendingComments :: ![(CommentPosition, Text)],
110− -- | Whether the current line is “dirty”, that is, already contains
111− -- atoms that can have comments attached to them
112− scDirtyLine :: !Bool,
113 -- | Whether to output a space before the next output
115 -- | Whether to output a space before the next output
114 scRequestedDelimiter :: !RequestedDelimiter,
116 scRequestedDelimiter :: !RequestedDelimiter,
115 -- | An auxiliary marker for keeping track of last output element
117 -- | An auxiliary marker for keeping track of last output element
@@ -175,11 +177,12 @@ runR (R m) sstream cstream anns recDot =
175 sc =
177 sc =
176 SC
178 SC
177 { scColumn = 0,
179 { scColumn = 0,
180+ scIndent = 0,
178 scBuilder = mempty,
181 scBuilder = mempty,
179 scSpanStream = sstream,
182 scSpanStream = sstream,
183+ scThisLineSpans = [],
180 scCommentStream = cstream,
184 scCommentStream = cstream,
181 scPendingComments = [],
185 scPendingComments = [],
182− scDirtyLine = False,
183 scRequestedDelimiter = VeryBeginning,
186 scRequestedDelimiter = VeryBeginning,
184 scSpanMark = Nothing
187 scSpanMark = Nothing
185 }
188 }
@@ -187,6 +190,23 @@ runR (R m) sstream cstream anns recDot =
187----------------------------------------------------------------------------
190----------------------------------------------------------------------------
188-- Internal functions
191-- Internal functions
189
192
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+
190-- | Output a fixed 'Text' fragment. The argument may not contain any line
210-- | Output a fixed 'Text' fragment. The argument may not contain any line
191-- breaks. 'txt' is used to output all sorts of “fixed” bits of syntax like
211-- breaks. 'txt' is used to output all sorts of “fixed” bits of syntax like
192-- keywords and pipes @|@ in functional dependencies.
212-- keywords and pipes @|@ in functional dependencies.
@@ -198,7 +218,15 @@ txt ::
198 -- | 'Text' to output
218 -- | 'Text' to output
199 Text ->
219 Text ->
200 R ()
220 R ()
201−txt = spit False False
221+txt = spit SimpleText
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
202
230
203-- | Output 'Outputable' fragment of AST. This can be used to output numeric
231-- | Output 'Outputable' fragment of AST. This can be used to output numeric
204-- literals and similar. Everything that doesn't have inner structure but
232-- literals and similar. Everything that doesn't have inner structure but
@@ -207,47 +235,60 @@ atom ::
207 Outputable a =>
235 Outputable a =>
208 a ->
236 a ->
209 R ()
237 R ()
210−atom = spit True False . T.pack . showOutputable
238+atom = spit Atom . T.pack . showOutputable
211
239
212-- | Low-level non-public helper to define 'txt' and 'atom'.
240-- | Low-level non-public helper to define 'txt' and 'atom'.
213spit ::
241spit ::
214− -- | Should we mark the line as dirty?
242+ -- | Type of the thing to spit
215− Bool ->
243+ SpitType ->
216− -- | Used during outputting of pending comments?
217− Bool ->
218 -- | 'Text' to output
244 -- | 'Text' to output
219 Text ->
245 Text ->
220 R ()
246 R ()
221−spit dirty printingComments txt' = do
247+spit _ "" = return ()
248+spit stype text = do
222 requestedDel <- R (gets scRequestedDelimiter)
249 requestedDel <- R (gets scRequestedDelimiter)
250+ pendingComments <- R (gets scPendingComments)
251+ when (stype == InterferingText && not (null pendingComments)) newline
223 case requestedDel of
252 case requestedDel of
224 RequestedNewline -> do
253 RequestedNewline -> do
225 R . modify $ \sc ->
254 R . modify $ \sc ->
226 sc
255 sc
227 { scRequestedDelimiter = RequestedNothing
256 { scRequestedDelimiter = RequestedNothing
228 }
257 }
229− if printingComments
258+ case stype of
230− then newlineRaw
259+ CommentPart -> newlineRaw
231− else newline
260+ _ -> newline
232 _ -> return ()
261 _ -> return ()
233 R $ do
262 R $ do
234 i <- asks rcIndent
263 i <- asks rcIndent
235 c <- gets scColumn
264 c <- gets scColumn
265+ closestEnclosing <- listToMaybe <$> asks rcEnclosingSpans
236− let spaces =
266+ let indentedTxt = spaces <> text
267+ spaces = T.replicate spacesN " "
268+ spacesN =
237− if c < i
269+ if c == 0
238− then T.replicate (i - c) " "
270+ then i
239− else bool mempty " " (requestedDel == RequestedSpace)
271+ else bool 0 1 (requestedDel == RequestedSpace)
240− indentedTxt = spaces <> txt'
241 modify $ \sc ->
272 modify $ \sc ->
242 sc
273 sc
243 { scBuilder = scBuilder sc <> fromText indentedTxt,
274 { scBuilder = scBuilder sc <> fromText indentedTxt,
244 scColumn = scColumn sc + T.length indentedTxt,
275 scColumn = scColumn sc + T.length indentedTxt,
245− scDirtyLine = scDirtyLine sc || dirty,
276+ scIndent =
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,
246 scRequestedDelimiter = RequestedNothing,
287 scRequestedDelimiter = RequestedNothing,
247 scSpanMark =
288 scSpanMark =
248 -- If there are pending comments, do not reset last comment
289 -- If there are pending comments, do not reset last comment
249 -- location.
290 -- location.
250− if printingComments || (not . null . scPendingComments) sc
291+ if (stype == CommentPart) || (not . null . scPendingComments) sc
251 then scSpanMark sc
292 then scSpanMark sc
252 else Nothing
293 else Nothing
253 }
294 }
@@ -279,21 +320,22 @@ space = R . modify $ \sc ->
279-- hard to output more than one blank newline in a row.
320-- hard to output more than one blank newline in a row.
280newline :: R ()
321newline :: R ()
281newline = do
322newline = do
323+ indent <- R (gets scIndent)
282 cs <- reverse <$> R (gets scPendingComments)
324 cs <- reverse <$> R (gets scPendingComments)
283 case cs of
325 case cs of
284 [] -> newlineRaw
326 [] -> newlineRaw
285− ((position, _, _) : _) -> do
327+ ((position, _) : _) -> do
286 case position of
328 case position of
287 OnTheSameLine -> space
329 OnTheSameLine -> space
288 OnNextLine -> newlineRaw
330 OnNextLine -> newlineRaw
289− R . forM_ cs $ \(_, indent, txt') ->
331+ R . forM_ cs $ \(_, text) ->
290 let modRC rc =
332 let modRC rc =
291 rc
333 rc
292 { rcIndent = indent
334 { rcIndent = indent
293 }
335 }
294 R m = do
336 R m = do
295− unless (T.null txt') $
337+ unless (T.null text) $
296− spit False True txt'
338+ spit CommentPart text
297 newlineRaw
339 newlineRaw
298 in local modRC m
340 in local modRC m
299 R . modify $ \sc ->
341 R . modify $ \sc ->
@@ -314,7 +356,8 @@ newlineRaw = R . modify $ \sc ->
314 VeryBeginning -> builderSoFar
356 VeryBeginning -> builderSoFar
315 _ -> builderSoFar <> "\n",
357 _ -> builderSoFar <> "\n",
316 scColumn = 0,
358 scColumn = 0,
317− scDirtyLine = False,
359+ scIndent = 0,
360+ scThisLineSpans = [],
318 scRequestedDelimiter = case scRequestedDelimiter sc of
361 scRequestedDelimiter = case scRequestedDelimiter sc of
319 AfterNewline -> RequestedNewline
362 AfterNewline -> RequestedNewline
320 RequestedNewline -> RequestedNewline
363 RequestedNewline -> RequestedNewline
@@ -322,14 +365,9 @@ newlineRaw = R . modify $ \sc ->
322 _ -> AfterNewline
365 _ -> AfterNewline
323 }
366 }
324
367
325−-- | Check if the current line is “dirty”, that is, there is something on it
326−-- that can have comments attached to it.
327−isLineDirty :: R Bool
328−isLineDirty = R (gets scDirtyLine)
329−
330-- | Return 'True' if we should print record dot syntax.
368-- | Return 'True' if we should print record dot syntax.
331useRecordDot :: R Bool
369useRecordDot :: R Bool
332−useRecordDot = R $ asks rcUseRecDot
370+useRecordDot = R (asks rcUseRecDot)
333
371
334-- | Increase indentation level by one indentation step for the inner
372-- | Increase indentation level by one indentation step for the inner
335-- computation. 'inci' should be used when a part of code must be more
373-- computation. 'inci' should be used when a part of code must be more
@@ -346,8 +384,7 @@ inci (R m) = R (local modRC m)
346
384
347-- | Set indentation level for the inner computation equal to current
385-- | Set indentation level for the inner computation equal to current
348-- column. This makes sure that the entire inner block is uniformly
386-- column. This makes sure that the entire inner block is uniformly
349−-- \"shifted\" to the right. Only works (and makes sense) when enclosing
387+-- \"shifted\" to the right.
350−-- layout is multi-line.
351sitcc :: R () -> R ()
388sitcc :: R () -> R ()
352sitcc (R m) = do
389sitcc (R m) = do
353 requestedDel <- R (gets scRequestedDelimiter)
390 requestedDel <- R (gets scRequestedDelimiter)
@@ -355,16 +392,9 @@ sitcc (R m) = do
355 c <- R (gets scColumn)
392 c <- R (gets scColumn)
356 let modRC rc =
393 let modRC rc =
357 rc
394 rc
358− { rcIndent = max i c + bool 0 1 (requestedDel == RequestedSpace)
395+ { rcIndent = max i (c + bool 0 1 (requestedDel == RequestedSpace))
359 }
396 }
360− vlayout (R m) . R $ do
361− modify $ \sc ->
362− sc
363− { scRequestedDelimiter = case requestedDel of
364− RequestedSpace -> RequestedNothing
365− other -> other
366− }
367− local modRC m
397+ R (local modRC m)
368
398
369-- | Set 'Layout' for internal computation.
399-- | Set 'Layout' for internal computation.
370enterLayout :: Layout -> R () -> R ()
400enterLayout :: Layout -> R () -> R ()
@@ -405,11 +435,10 @@ registerPendingCommentLine ::
405 -- | 'Text' to output
435 -- | 'Text' to output
406 Text ->
436 Text ->
407 R ()
437 R ()
408−registerPendingCommentLine position txt' = R $ do
438+registerPendingCommentLine position text = R $ do
409− i <- asks rcIndent
410 modify $ \sc ->
439 modify $ \sc ->
411 sc
440 sc
412− { scPendingComments = (position, i, txt') : scPendingComments sc
441+ { scPendingComments = (position, text) : scPendingComments sc
413 }
442 }
414
443
415-- | Drop elements that begin before or at the same place as given
444-- | Drop elements that begin before or at the same place as given
@@ -468,6 +497,10 @@ withEnclosingSpan spn (R m) = R (local modRC m)
468 { rcEnclosingSpans = spn : rcEnclosingSpans rc
497 { rcEnclosingSpans = spn : rcEnclosingSpans rc
469 }
498 }
470
499
500+-- | Get spans on this line so far.
501+thisLineSpans :: R [RealSrcSpan]
502+thisLineSpans = R (gets scThisLineSpans)
503+
471----------------------------------------------------------------------------
504----------------------------------------------------------------------------
472-- Stateful markers
505-- Stateful markers
473
506
@@ -477,15 +510,15 @@ data SpanMark
477 HaddockSpan HaddockStyle RealSrcSpan
510 HaddockSpan HaddockStyle RealSrcSpan
478 | -- | Non-haddock comment
511 | -- | Non-haddock comment
479 CommentSpan RealSrcSpan
512 CommentSpan RealSrcSpan
480− | -- | Non-comment span
513+ | -- | A statement in a do-block and such span
481− OtherSpan RealSrcSpan
514+ StatementSpan RealSrcSpan
482
515
483-- | Project 'RealSrcSpan' from 'SpanMark'.
516-- | Project 'RealSrcSpan' from 'SpanMark'.
484spanMarkSpan :: SpanMark -> RealSrcSpan
517spanMarkSpan :: SpanMark -> RealSrcSpan
485spanMarkSpan = \case
518spanMarkSpan = \case
486 HaddockSpan _ s -> s
519 HaddockSpan _ s -> s
487 CommentSpan s -> s
520 CommentSpan s -> s
488− OtherSpan s -> s
521+ StatementSpan s -> s
489
522
490-- | Haddock string style.
523-- | Haddock string style.
491data HaddockStyle
524data HaddockStyle
@@ -534,7 +567,7 @@ dontUseBraces (R r) = R (local (\i -> i {rcCanUseBraces = False}) r)
534
567
535-- | Return 'True' if we can use braces in this context.
568-- | Return 'True' if we can use braces in this context.
536canUseBraces :: R Bool
569canUseBraces :: R Bool
537−canUseBraces = R $ asks rcCanUseBraces
570+canUseBraces = R (asks rcCanUseBraces)
538
571
539----------------------------------------------------------------------------
572----------------------------------------------------------------------------
540-- Constants
573-- Constants
src/Ormolu/Printer/Meat/Common.hs+11−10
@@ -114,14 +114,14 @@ p_qualName mname occName = do
114p_infixDefHelper ::
114p_infixDefHelper ::
115 -- | Whether to format in infix style
115 -- | Whether to format in infix style
116 Bool ->
116 Bool ->
117− -- | Indentation-bumping wrapper
117+ -- | Whether to bump indentation for arguments
118− (R () -> R ()) ->
118+ Bool ->
119 -- | How to print the operator\/name
119 -- | How to print the operator\/name
120 R () ->
120 R () ->
121 -- | How to print the arguments
121 -- | How to print the arguments
122 [R ()] ->
122 [R ()] ->
123 R ()
123 R ()
124−p_infixDefHelper isInfix inci' name args =
124+p_infixDefHelper isInfix indentArgs name args =
125 case (isInfix, args) of
125 case (isInfix, args) of
126 (True, p0 : p1 : ps) -> do
126 (True, p0 : p1 : ps) -> do
127 let parens' =
127 let parens' =
@@ -131,18 +131,18 @@ p_infixDefHelper isInfix inci' name args =
131 parens' $ do
131 parens' $ do
132 p0
132 p0
133 breakpoint
133 breakpoint
134− inci $ sitcc $ do
134+ inci . sitcc $ do
135 name
135 name
136 space
136 space
137 p1
137 p1
138− unless (null ps) . inci' $ do
138+ unless (null ps) . inciIf indentArgs $ do
139 breakpoint
139 breakpoint
140 sitcc (sep breakpoint sitcc ps)
140 sitcc (sep breakpoint sitcc ps)
141 (_, ps) -> do
141 (_, ps) -> do
142 name
142 name
143 unless (null ps) $ do
143 unless (null ps) $ do
144 breakpoint
144 breakpoint
145− inci' $ sitcc (sep breakpoint sitcc args)
145+ inciIf indentArgs $ sitcc (sep breakpoint sitcc args)
146
146
147-- | Print a Haddock.
147-- | Print a Haddock.
148p_hsDocString ::
148p_hsDocString ::
@@ -154,10 +154,11 @@ p_hsDocString ::
154 LHsDocString ->
154 LHsDocString ->
155 R ()
155 R ()
156p_hsDocString hstyle needsNewline (L l str) = do
156p_hsDocString hstyle needsNewline (L l str) = do
157− goesAfterComment <- getSpanMark >>= \case
157+ let isCommentSpan = \case
158− Just (HaddockSpan _ _) -> return True
158+ HaddockSpan _ _ -> True
159− Just (CommentSpan _) -> return True
159+ CommentSpan _ -> True
160− _ -> return False
160+ _ -> False
161+ goesAfterComment <- maybe False isCommentSpan <$> getSpanMark
161 -- Make sure the Haddock is separated by a newline from other comments.
162 -- Make sure the Haddock is separated by a newline from other comments.
162 when goesAfterComment newline
163 when goesAfterComment newline
163 forM_ (zip (splitDocString str) (True : repeat False)) $ \(x, isFirst) -> do
164 forM_ (zip (splitDocString str) (True : repeat False)) $ \(x, isFirst) -> do
src/Ormolu/Printer/Meat/Declaration.hs+26−14
@@ -12,7 +12,7 @@ module Ormolu.Printer.Meat.Declaration
12where
12where
13
13
14import Data.List (sort)
14import Data.List (sort)
15−import Data.List.NonEmpty ((<|), NonEmpty (..))
15+import Data.List.NonEmpty (NonEmpty (..), (<|))
16import qualified Data.List.NonEmpty as NE
16import qualified Data.List.NonEmpty as NE
17import GHC hiding (InlinePragma)
17import GHC hiding (InlinePragma)
18import OccName (occNameFS)
18import OccName (occNameFS)
@@ -54,12 +54,13 @@ p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
54p_hsDeclsRespectGrouping = p_hsDecls' Respect
54p_hsDeclsRespectGrouping = p_hsDecls' Respect
55
55
56p_hsDecls' :: UserGrouping -> FamilyStyle -> [LHsDecl GhcPs] -> R ()
56p_hsDecls' :: UserGrouping -> FamilyStyle -> [LHsDecl GhcPs] -> R ()
57−p_hsDecls' grouping style decls = sepSemi id $
57+p_hsDecls' grouping style decls =
58+ sepSemi id $
58− -- Return a list of rendered declarations, adding a newline to separate
59+ -- Return a list of rendered declarations, adding a newline to separate
59− -- groups.
60+ -- groups.
60− case groupDecls decls of
61+ case groupDecls decls of
61− [] -> []
62+ [] -> []
62− (x : xs) -> renderGroup x ++ concat (zipWith renderGroupWithPrev (x : xs) xs)
63+ (x : xs) -> renderGroup x ++ concat (zipWith renderGroupWithPrev (x : xs) xs)
63 where
64 where
64 renderGroup = NE.toList . fmap (located' $ dontUseBraces . p_hsDecl style)
65 renderGroup = NE.toList . fmap (located' $ dontUseBraces . p_hsDecl style)
65 renderGroupWithPrev prev curr =
66 renderGroupWithPrev prev curr =
@@ -84,9 +85,6 @@ isDocumented = any (isHaddock . unLoc)
84 isHaddock _ = False
85 isHaddock _ = False
85
86
86-- | Group relevant declarations together.
87-- | Group relevant declarations together.
87−--
88−-- Add a declaration to a group iff it is relevant to either the first or
89−-- the preceding declaration in the group.
90groupDecls :: [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]
88groupDecls :: [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]
91groupDecls [] = []
89groupDecls [] = []
92groupDecls (l@(L _ DocNext) : xs) =
90groupDecls (l@(L _ DocNext) : xs) =
@@ -99,7 +97,8 @@ groupDecls (header : xs) =
99 let (grp, rest) = flip span (zip (header : xs) xs) $ \(previous, current) ->
97 let (grp, rest) = flip span (zip (header : xs) xs) $ \(previous, current) ->
100 let relevantToHdr = groupedDecls header current
98 let relevantToHdr = groupedDecls header current
101 relevantToPrev = groupedDecls previous current
99 relevantToPrev = groupedDecls previous current
100+ isDeclSeries = declSeries previous current
102− in relevantToHdr || relevantToPrev
101+ in isDeclSeries || relevantToHdr || relevantToPrev
103 in (header :| map snd grp) : groupDecls (map snd rest)
102 in (header :| map snd grp) : groupDecls (map snd rest)
104
103
105p_hsDecl :: FamilyStyle -> HsDecl GhcPs -> R ()
104p_hsDecl :: FamilyStyle -> HsDecl GhcPs -> R ()
@@ -196,6 +195,18 @@ groupedDecls (L l_x x') (L l_y y') =
196 (_, DocPrev) -> True
195 (_, DocPrev) -> True
197 _ -> False
196 _ -> False
198
197
198+-- | Detect declaration series that should not have blanks between them.
199+declSeries ::
200+ LHsDecl GhcPs ->
201+ LHsDecl GhcPs ->
202+ Bool
203+declSeries (L _ x) (L _ y) =
204+ case (x, y) of
205+ ( SigD NoExtField (TypeSig NoExtField _ _),
206+ SigD NoExtField (TypeSig NoExtField _ _)
207+ ) -> True
208+ _ -> False
209+
199intersects :: Ord a => [a] -> [a] -> Bool
210intersects :: Ord a => [a] -> [a] -> Bool
200intersects a b = go (sort a) (sort b)
211intersects a b = go (sort a) (sort b)
201 where
212 where
@@ -288,9 +299,10 @@ patSigRdrNames (SigD NoExtField (PatSynSig NoExtField ns _)) = Just $ map unLoc
288patSigRdrNames _ = Nothing
299patSigRdrNames _ = Nothing
289
300
290warnSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
301warnSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
291−warnSigRdrNames (WarningD NoExtField (Warnings NoExtField _ ws)) = Just $ flip concatMap ws $ \case
302+warnSigRdrNames (WarningD NoExtField (Warnings NoExtField _ ws)) = Just $
303+ flip concatMap ws $ \case
292− L _ (Warning NoExtField ns _) -> map unLoc ns
304+ L _ (Warning NoExtField ns _) -> map unLoc ns
293− L _ (XWarnDecl x) -> noExtCon x
305+ L _ (XWarnDecl x) -> noExtCon x
294warnSigRdrNames _ = Nothing
306warnSigRdrNames _ = Nothing
295
307
296patBindNames :: Pat GhcPs -> [RdrName]
308patBindNames :: Pat GhcPs -> [RdrName]
src/Ormolu/Printer/Meat/Declaration.hs-boot−1
@@ -9,5 +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−
13p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
12p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
src/Ormolu/Printer/Meat/Declaration/Class.hs+2−2
@@ -58,7 +58,7 @@ p_classDecl ctx name HsQTvs {..} fixity fdeps csigs cdefs cats catdefs cdocs = d
58 switchLayout signatureSpans $
58 switchLayout signatureSpans $
59 p_infixDefHelper
59 p_infixDefHelper
60 (isInfix fixity)
60 (isInfix fixity)
61− inci
61+ True
62 (p_rdrName name)
62 (p_rdrName name)
63 (located' p_hsTyVarBndr <$> hsq_explicit)
63 (located' p_hsTyVarBndr <$> hsq_explicit)
64 inci (p_classFundeps fdeps)
64 inci (p_classFundeps fdeps)
@@ -82,7 +82,7 @@ p_classFundeps fdeps = unless (null fdeps) $ do
82 breakpoint
82 breakpoint
83 txt "|"
83 txt "|"
84 space
84 space
85− sitcc $ sep (comma >> breakpoint) (sitcc . located' p_funDep) fdeps
85+ inci $ sep commaDel (sitcc . located' p_funDep) fdeps
86
86
87p_funDep :: FunDep (Located RdrName) -> R ()
87p_funDep :: FunDep (Located RdrName) -> R ()
88p_funDep (before, after) = do
88p_funDep (before, after) = do
src/Ormolu/Printer/Meat/Declaration/Data.hs+34−31
@@ -41,7 +41,7 @@ p_dataDecl style name tpats fixity HsDataDefn {..} = do
41 inci $
41 inci $
42 p_infixDefHelper
42 p_infixDefHelper
43 (isInfix fixity)
43 (isInfix fixity)
44− inci
44+ True
45 (p_rdrName name)
45 (p_rdrName name)
46 (located' p_hsType <$> tpats)
46 (located' p_hsType <$> tpats)
47 case dd_kindSig of
47 case dd_kindSig of
@@ -60,24 +60,26 @@ p_dataDecl style name tpats fixity HsDataDefn {..} = do
60 txt "where"
60 txt "where"
61 breakpoint
61 breakpoint
62 sepSemi (located' (p_conDecl False)) dd_cons
62 sepSemi (located' (p_conDecl False)) dd_cons
63− else switchLayout (getLoc name : (getLoc <$> dd_cons))
63+ else switchLayout (getLoc name : (getLoc <$> dd_cons)) . inci $ do
64− $ inci
65− $ do
66− let singleConstRec = isSingleConstRec dd_cons
64+ let singleConstRec = isSingleConstRec dd_cons
67− if singleConstRec
65+ if singleConstRec
68− then space
66+ then space
67+ else
68+ if hasHaddocks dd_cons
69+ then newline
69− else breakpoint
70+ else breakpoint
70− txt "="
71+ equals
71− space
72+ space
73+ layout <- getLayout
72− let s =
74+ let s =
73− vlayout
75+ if layout == MultiLine || hasHaddocks dd_cons
74− (space >> txt "|" >> space)
76+ then newline >> txt "|" >> space
75− (newline >> txt "|" >> space)
77+ else space >> txt "|" >> space
76− sitcc' =
78+ sitcc' =
77− if singleConstRec
79+ if singleConstRec
78− then id
80+ then id
79− else sitcc
81+ else sitcc
80− sep s (sitcc' . located' (p_conDecl singleConstRec)) dd_cons
82+ sep s (sitcc' . located' (p_conDecl singleConstRec)) dd_cons
81 unless (null $ unLoc dd_derivs) breakpoint
83 unless (null $ unLoc dd_derivs) breakpoint
82 inci . located dd_derivs $ \xs ->
84 inci . located dd_derivs $ \xs ->
83 sep newline (located' p_hsDerivingClause) xs
85 sep newline (located' p_hsDerivingClause) xs
@@ -102,11 +104,10 @@ p_conDecl singleConstRec = \case
102 (c : cs) -> do
104 (c : cs) -> do
103 p_rdrName c
105 p_rdrName c
104 unless (null cs) . inci $ do
106 unless (null cs) . inci $ do
105− comma
107+ commaDel
106− breakpoint
107− sitcc $ sep (comma >> breakpoint) p_rdrName cs
108+ sep commaDel p_rdrName cs
108− space
109 inci $ do
109 inci $ do
110+ space
110 txt "::"
111 txt "::"
111 let interArgBreak =
112 let interArgBreak =
112 if hasDocStrings (unLoc con_res_ty)
113 if hasDocStrings (unLoc con_res_ty)
@@ -150,15 +151,11 @@ p_conDecl singleConstRec = \case
150 PrefixCon xs -> do
151 PrefixCon xs -> do
151 p_rdrName con_name
152 p_rdrName con_name
152 unless (null xs) breakpoint
153 unless (null xs) breakpoint
153− inci . sitcc $ sep breakpoint (sitcc . located' p_hsType) xs
154+ inci . sitcc $ sep breakpoint (sitcc . located' p_hsTypePostDoc) xs
154 RecCon l -> do
155 RecCon l -> do
155 p_rdrName con_name
156 p_rdrName con_name
156 breakpoint
157 breakpoint
157− let inci' =
158− if singleConstRec
159− then id
160− else inci
161− inci' (located l p_conDeclFields)
158+ inciIf (not singleConstRec) (located l p_conDeclFields)
162 InfixCon x y -> do
159 InfixCon x y -> do
163 located x p_hsType
160 located x p_hsType
164 breakpoint
161 breakpoint
@@ -207,9 +204,9 @@ p_hsDerivingClause HsDerivingClause {..} = do
207 let derivingWhat = located deriv_clause_tys $ \case
204 let derivingWhat = located deriv_clause_tys $ \case
208 [] -> txt "()"
205 [] -> txt "()"
209 xs ->
206 xs ->
210− parens N . sitcc $
207+ parens N $
211 sep
208 sep
212− (comma >> breakpoint)
209+ commaDel
213 (sitcc . located' p_hsType . hsib_body)
210 (sitcc . located' p_hsType . hsib_body)
214 xs
211 xs
215 space
212 space
@@ -256,3 +253,9 @@ isSingleConstRec [(L _ ConDeclH98 {..})] =
256 RecCon _ -> True
253 RecCon _ -> True
257 _ -> False
254 _ -> False
258isSingleConstRec _ = False
255isSingleConstRec _ = 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+2−2
@@ -15,6 +15,6 @@ p_defaultDecl = \case
15 DefaultDecl NoExtField ts -> do
15 DefaultDecl NoExtField ts -> do
16 txt "default"
16 txt "default"
17 breakpoint
17 breakpoint
18− inci . parens N . sitcc $
18+ inci . parens N $
19− sep (comma >> breakpoint) (sitcc . located' p_hsType) ts
19+ sep commaDel (sitcc . located' p_hsType) ts
20 XDefaultDecl x -> noExtCon x
20 XDefaultDecl x -> noExtCon x
src/Ormolu/Printer/Meat/Declaration/Instance.hs+5−9
@@ -32,9 +32,7 @@ p_standaloneDerivDecl DerivDecl {..} = do
32 txt "instance"
32 txt "instance"
33 breakpoint
33 breakpoint
34 match_overlap_mode deriv_overlap_mode breakpoint
34 match_overlap_mode deriv_overlap_mode breakpoint
35− if toIndent
36− then inci typesAfterInstance
37− else typesAfterInstance
35+ inciIf toIndent typesAfterInstance
38 txt "deriving"
36 txt "deriving"
39 space
37 space
40 case deriv_strategy of
38 case deriv_strategy of
@@ -90,12 +88,10 @@ p_clsInstDecl = \case
90 unless (null allDecls) $ do
88 unless (null allDecls) $ do
91 breakpoint
89 breakpoint
92 txt "where"
90 txt "where"
93− unless (null allDecls)
91+ unless (null allDecls) . inci $ do
94− $ inci
95− $ do
96− -- Ensure whitespace is added after where clause.
92+ -- Ensure whitespace is added after where clause.
97− breakpoint
93+ breakpoint
98− dontUseBraces $ p_hsDeclsRespectGrouping Associated allDecls
94+ dontUseBraces $ p_hsDeclsRespectGrouping Associated allDecls
99 XHsImplicitBndrs x -> noExtCon x
95 XHsImplicitBndrs x -> noExtCon x
100 XClsInstDecl x -> noExtCon x
96 XClsInstDecl x -> noExtCon x
101
97
src/Ormolu/Printer/Meat/Declaration/Rule.hs+2−2
@@ -18,7 +18,7 @@ import Ormolu.Printer.Meat.Type
18p_ruleDecls :: RuleDecls GhcPs -> R ()
18p_ruleDecls :: RuleDecls GhcPs -> R ()
19p_ruleDecls = \case
19p_ruleDecls = \case
20 HsRules NoExtField _ xs ->
20 HsRules NoExtField _ xs ->
21− pragma "RULES" . sitcc $
21+ pragma "RULES" $
22 sep breakpoint (sitcc . located' p_ruleDecl) xs
22 sep breakpoint (sitcc . located' p_ruleDecl) xs
23 XRuleDecls x -> noExtCon x
23 XRuleDecls x -> noExtCon x
24
24
@@ -43,7 +43,7 @@ p_ruleDecl = \case
43 inci $ do
43 inci $ do
44 located lhs p_hsExpr
44 located lhs p_hsExpr
45 space
45 space
46− txt "="
46+ equals
47 inci $ do
47 inci $ do
48 breakpoint
48 breakpoint
49 located rhs p_hsExpr
49 located rhs p_hsExpr
src/Ormolu/Printer/Meat/Declaration/Signature.hs+29−27
@@ -14,7 +14,6 @@ where
14import BasicTypes
14import BasicTypes
15import BooleanFormula
15import BooleanFormula
16import Control.Monad
16import Control.Monad
17−import Data.Bool (bool)
18import GHC
17import GHC
19import Ormolu.Printer.Combinators
18import Ormolu.Printer.Combinators
20import Ormolu.Printer.Meat.Common
19import Ormolu.Printer.Meat.Common
@@ -48,24 +47,22 @@ p_typeSig indentTail (n : ns) hswc = do
48 p_rdrName n
47 p_rdrName n
49 if null ns
48 if null ns
50 then p_typeAscription hswc
49 then p_typeAscription hswc
51− else bool id inci indentTail $ do
50+ else inciIf indentTail $ do
52− comma
51+ commaDel
53− breakpoint
54− sep (comma >> breakpoint) p_rdrName ns
52+ sep commaDel p_rdrName ns
55 p_typeAscription hswc
53 p_typeAscription hswc
56
54
57p_typeAscription ::
55p_typeAscription ::
58 LHsSigWcType GhcPs ->
56 LHsSigWcType GhcPs ->
59 R ()
57 R ()
60−p_typeAscription HsWC {..} = do
58+p_typeAscription HsWC {..} = inci $ do
61 space
59 space
62− inci $ do
63− txt "::"
60+ txt "::"
64− let t = hsib_body hswc_body
61+ let t = hsib_body hswc_body
65− if hasDocStrings (unLoc t)
62+ if hasDocStrings (unLoc t)
66− then newline
63+ then newline
67− else breakpoint
64+ else breakpoint
68− located t p_hsType
65+ located t p_hsType
69p_typeAscription (XHsWildCardBndrs x) = noExtCon x
66p_typeAscription (XHsWildCardBndrs x) = noExtCon x
70
67
71p_patSynSig ::
68p_patSynSig ::
@@ -74,7 +71,11 @@ p_patSynSig ::
74 R ()
71 R ()
75p_patSynSig names hsib = do
72p_patSynSig names hsib = do
76 txt "pattern"
73 txt "pattern"
74+ let body =
75+ p_typeSig
76+ False
77+ names
77− let body = p_typeSig False names HsWC {hswc_ext = NoExtField, hswc_body = hsib}
78+ HsWC {hswc_ext = NoExtField, hswc_body = hsib}
78 if length names > 1
79 if length names > 1
79 then breakpoint >> inci body
80 then breakpoint >> inci body
80 else space >> body
81 else space >> body
@@ -103,7 +104,7 @@ p_fixSig = \case
103 space
104 space
104 atom n
105 atom n
105 space
106 space
106− sitcc $ sep (comma >> breakpoint) p_rdrName names
107+ sitcc $ sep commaDel p_rdrName names
107 XFixitySig x -> noExtCon x
108 XFixitySig x -> noExtCon x
108
109
109p_inlineSig ::
110p_inlineSig ::
@@ -142,7 +143,7 @@ p_specSig name ts InlinePragma {..} = pragmaBraces $ do
142 space
143 space
143 txt "::"
144 txt "::"
144 breakpoint
145 breakpoint
145− inci $ sep (comma >> breakpoint) (located' p_hsType . hsib_body) ts
146+ inci $ sep commaDel (located' p_hsType . hsib_body) ts
146
147
147p_inlineSpec :: InlineSpec -> R ()
148p_inlineSpec :: InlineSpec -> R ()
148p_inlineSpec = \case
149p_inlineSpec = \case
@@ -186,13 +187,13 @@ p_booleanFormula = \case
186 And xs ->
187 And xs ->
187 sitcc $
188 sitcc $
188 sep
189 sep
189− (comma >> breakpoint)
190+ commaDel
190 (located' p_booleanFormula)
191 (located' p_booleanFormula)
191 xs
192 xs
192 Or xs ->
193 Or xs ->
193 sitcc $
194 sitcc $
194 sep
195 sep
195− (breakpoint >> txt "| ")
196+ (breakpoint >> txt "|" >> space)
196 (located' p_booleanFormula)
197 (located' p_booleanFormula)
197 xs
198 xs
198 Parens l -> located l (parens N . p_booleanFormula)
199 Parens l -> located l (parens N . p_booleanFormula)
@@ -206,7 +207,7 @@ p_completeSig ::
206p_completeSig cs' mty =
207p_completeSig cs' mty =
207 located cs' $ \cs ->
208 located cs' $ \cs ->
208 pragma "COMPLETE" . inci $ do
209 pragma "COMPLETE" . inci $ do
209− sitcc $ sep (comma >> breakpoint) p_rdrName cs
210+ sep commaDel p_rdrName cs
210 forM_ mty $ \ty -> do
211 forM_ mty $ \ty -> do
211 space
212 space
212 txt "::"
213 txt "::"
@@ -223,12 +224,13 @@ p_sccSig loc literal = pragma "SCC" . inci $ do
223p_standaloneKindSig :: StandaloneKindSig GhcPs -> R ()
224p_standaloneKindSig :: StandaloneKindSig GhcPs -> R ()
224p_standaloneKindSig (StandaloneKindSig NoExtField name bndrs) = do
225p_standaloneKindSig (StandaloneKindSig NoExtField name bndrs) = do
225 txt "type"
226 txt "type"
227+ inci $ do
226− space
228+ space
227− p_rdrName name
229+ p_rdrName name
228− space
230+ space
229− txt "::"
231+ txt "::"
230− breakpoint
232+ breakpoint
231− inci $ case bndrs of
233+ case bndrs of
232− HsIB NoExtField sig -> located sig p_hsType
234+ HsIB NoExtField sig -> located sig p_hsType
233− XHsImplicitBndrs x -> noExtCon x
235+ XHsImplicitBndrs x -> noExtCon x
234p_standaloneKindSig (XStandaloneKindSig c) = noExtCon c
236p_standaloneKindSig (XStandaloneKindSig c) = noExtCon c
src/Ormolu/Printer/Meat/Declaration/Type.hs+5−3
@@ -28,11 +28,13 @@ p_synDecl name fixity HsQTvs {..} t = do
28 switchLayout (getLoc name : map getLoc hsq_explicit) $
28 switchLayout (getLoc name : map getLoc hsq_explicit) $
29 p_infixDefHelper
29 p_infixDefHelper
30 (case fixity of Infix -> True; _ -> False)
30 (case fixity of Infix -> True; _ -> False)
31− inci
31+ True
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− txt "="
35+ equals
36+ if hasDocStrings (unLoc t)
37+ then newline
36− breakpoint
38+ else breakpoint
37 inci (located t p_hsType)
39 inci (located t p_hsType)
38p_synDecl _ _ (XLHsQTyVars x) _ = noExtCon x
40p_synDecl _ _ (XLHsQTyVars x) _ = noExtCon x
src/Ormolu/Printer/Meat/Declaration/TypeFamily.hs+5−5
@@ -31,7 +31,7 @@ p_famDecl style FamilyDecl {fdTyVars = HsQTvs {..}, ..} = do
31 switchLayout (getLoc fdLName : (getLoc <$> hsq_explicit)) $
31 switchLayout (getLoc fdLName : (getLoc <$> hsq_explicit)) $
32 p_infixDefHelper
32 p_infixDefHelper
33 (isInfix fdFixity)
33 (isInfix fdFixity)
34− inci
34+ True
35 (p_rdrName fdLName)
35 (p_rdrName fdLName)
36 (located' p_hsTyVarBndr <$> hsq_explicit)
36 (located' p_hsTyVarBndr <$> hsq_explicit)
37 let resultSig = p_familyResultSigL fdResultSig
37 let resultSig = p_familyResultSigL fdResultSig
@@ -69,7 +69,7 @@ p_familyResultSigL l =
69 breakpoint
69 breakpoint
70 located k p_hsType
70 located k p_hsType
71 TyVarSig NoExtField bndr -> Just $ do
71 TyVarSig NoExtField bndr -> Just $ do
72− txt "="
72+ equals
73 breakpoint
73 breakpoint
74 located bndr p_hsTyVarBndr
74 located bndr p_hsTyVarBndr
75 XFamilyResultSig x ->
75 XFamilyResultSig x ->
@@ -92,16 +92,16 @@ p_tyFamInstEqn HsIB {hsib_body = FamEqn {..}} = do
92 Just bndrs -> do
92 Just bndrs -> do
93 p_forallBndrs ForallInvis p_hsTyVarBndr bndrs
93 p_forallBndrs ForallInvis p_hsTyVarBndr bndrs
94 breakpoint
94 breakpoint
95− (if null feqn_bndrs then id else inci) $ do
95+ inciIf (not $ null feqn_bndrs) $ do
96 let famLhsSpn = getLoc feqn_tycon : fmap (getLoc . typeArgToType) feqn_pats
96 let famLhsSpn = getLoc feqn_tycon : fmap (getLoc . typeArgToType) feqn_pats
97 switchLayout famLhsSpn $
97 switchLayout famLhsSpn $
98 p_infixDefHelper
98 p_infixDefHelper
99 (isInfix feqn_fixity)
99 (isInfix feqn_fixity)
100− inci
100+ True
101 (p_rdrName feqn_tycon)
101 (p_rdrName feqn_tycon)
102 (located' p_hsType . typeArgToType <$> feqn_pats)
102 (located' p_hsType . typeArgToType <$> feqn_pats)
103 space
103 space
104− txt "="
104+ equals
105 breakpoint
105 breakpoint
106 inci (located feqn_rhs p_hsType)
106 inci (located feqn_rhs p_hsType)
107p_tyFamInstEqn HsIB {hsib_body = XFamEqn x} = noExtCon x
107p_tyFamInstEqn HsIB {hsib_body = XFamEqn x} = noExtCon x
src/Ormolu/Printer/Meat/Declaration/Value.hs+181−169
@@ -1,4 +1,5 @@
1{-# LANGUAGE LambdaCase #-}
1{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE MultiWayIf #-}
2{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE RecordWildCards #-}
4{-# LANGUAGE RecordWildCards #-}
4{-# LANGUAGE TypeApplications #-}
5{-# LANGUAGE TypeApplications #-}
@@ -21,12 +22,12 @@ import Data.Char (isPunctuation, isSymbol)
21import Data.Data hiding (Infix, Prefix)
22import Data.Data hiding (Infix, Prefix)
22import Data.Functor ((<&>))
23import Data.Functor ((<&>))
23import Data.List (intersperse, sortOn)
24import Data.List (intersperse, sortOn)
24−import Data.List.NonEmpty ((<|), NonEmpty (..))
25+import Data.List.NonEmpty (NonEmpty (..), (<|))
25import qualified Data.List.NonEmpty as NE
26import qualified Data.List.NonEmpty as NE
26import Data.Text (Text)
27import Data.Text (Text)
27import qualified Data.Text as Text
28import qualified Data.Text as Text
28import GHC
29import GHC
29−import OccName (mkVarOcc)
30+import OccName (occNameString)
30import Ormolu.Printer.Combinators
31import Ormolu.Printer.Combinators
31import Ormolu.Printer.Internal
32import Ormolu.Printer.Internal
32import Ormolu.Printer.Meat.Common
33import Ormolu.Printer.Meat.Common
@@ -60,7 +61,7 @@ data Placement
60 -- should use it and avoid bumping one level
61 -- should use it and avoid bumping one level
61 -- of indentation
62 -- of indentation
62 Hanging
63 Hanging
63− deriving (Eq)
64+ deriving (Eq, Show)
64
65
65p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
66p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
66p_valDecl = \case
67p_valDecl = \case
@@ -179,25 +180,24 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
179 NoSrcStrict -> return ()
180 NoSrcStrict -> return ()
180 SrcStrict -> txt "!"
181 SrcStrict -> txt "!"
181 SrcLazy -> txt "~"
182 SrcLazy -> txt "~"
182− inci' <- case NE.nonEmpty m_pats of
183+ indentBody <- case NE.nonEmpty m_pats of
184+ Nothing ->
183− Nothing -> id <$ case style of
185+ False <$ case style of
184− Function name -> p_rdrName name
186+ Function name -> p_rdrName name
185− _ -> return ()
187+ _ -> return ()
186 Just ne_pats -> do
188 Just ne_pats -> do
187− let combinedSpans =
189+ let combinedSpans = case style of
190+ Function name -> combineSrcSpans (getLoc name) patSpans
191+ _ -> patSpans
188− combineSrcSpans' $
192+ patSpans = combineSrcSpans' (getLoc <$> ne_pats)
189− getLoc <$> ne_pats
190− inci' =
191− if isOneLineSpan combinedSpans
193+ indentBody = not (isOneLineSpan combinedSpans)
192− then id
193− else inci
194 switchLayout [combinedSpans] $ do
194 switchLayout [combinedSpans] $ do
195 let stdCase = sep breakpoint (located' p_pat) m_pats
195 let stdCase = sep breakpoint (located' p_pat) m_pats
196 case style of
196 case style of
197 Function name ->
197 Function name ->
198 p_infixDefHelper
198 p_infixDefHelper
199 isInfix
199 isInfix
200− inci'
200+ indentBody
201 (p_rdrName name)
201 (p_rdrName name)
202 (located' p_pat <$> m_pats)
202 (located' p_pat <$> m_pats)
203 PatternBind -> stdCase
203 PatternBind -> stdCase
@@ -212,40 +212,32 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
212 when needsSpace space
212 when needsSpace space
213 sitcc stdCase
213 sitcc stdCase
214 LambdaCase -> stdCase
214 LambdaCase -> stdCase
215− return inci'
215+ return indentBody
216 let -- Calculate position of end of patterns. This is useful when we decide
216 let -- Calculate position of end of patterns. This is useful when we decide
217 -- about putting certain constructions in hanging positions.
217 -- about putting certain constructions in hanging positions.
218 endOfPats = case NE.nonEmpty m_pats of
218 endOfPats = case NE.nonEmpty m_pats of
219 Nothing -> case style of
219 Nothing -> case style of
220− Function name -> (Just . srcSpanEnd . getLoc) name
220+ Function name -> Just (getLoc name)
221 _ -> Nothing
221 _ -> Nothing
222− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
222+ Just pats -> (Just . getLoc . NE.last) pats
223 isCase = \case
223 isCase = \case
224 Case -> True
224 Case -> True
225 LambdaCase -> True
225 LambdaCase -> True
226 _ -> False
226 _ -> False
227− let hasGuards = withGuards grhssGRHSs
227+ hasGuards = withGuards grhssGRHSs
228− unless (length grhssGRHSs > 1) $
229− case style of
230− Function _ | hasGuards -> return ()
231− Function _ -> space >> txt "="
232− PatternBind -> space >> txt "="
233− s | isCase s && hasGuards -> return ()
234− _ -> space >> txt "->"
235− let grhssSpan =
228+ grhssSpan =
236 combineSrcSpans' $
229 combineSrcSpans' $
237 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
230 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
238 patGrhssSpan =
231 patGrhssSpan =
239 maybe
232 maybe
240 grhssSpan
233 grhssSpan
241− (combineSrcSpans grhssSpan . srcLocSpan)
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
242 endOfPats
235 endOfPats
243 placement =
236 placement =
244 case endOfPats of
237 case endOfPats of
245 Nothing -> blockPlacement placer grhssGRHSs
238 Nothing -> blockPlacement placer grhssGRHSs
246 Just spn ->
239 Just spn ->
247− if isOneLineSpan
248− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn grhssSpan
249 then blockPlacement placer grhssGRHSs
241 then blockPlacement placer grhssGRHSs
250 else Normal
242 else Normal
251 p_body = do
243 p_body = do
@@ -261,7 +253,14 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
261 txt "where"
253 txt "where"
262 unless whereIsEmpty breakpoint
254 unless whereIsEmpty breakpoint
263 inci $ located grhssLocalBinds p_hsLocalBinds
255 inci $ located grhssLocalBinds p_hsLocalBinds
264− inci' $ do
256+ inciIf indentBody $ 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 "->"
265 switchLayout [patGrhssSpan] $
264 switchLayout [patGrhssSpan] $
266 placeHanging placement p_body
265 placeHanging placement p_body
267 inci p_where
266 inci p_where
@@ -285,24 +284,24 @@ p_grhs' placer render style (GRHS NoExtField guards body) =
285 xs -> do
284 xs -> do
286 txt "|"
285 txt "|"
287 space
286 space
288− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
289 space
288 space
290− txt $ case style of
289+ inci $ case style of
291− EqualSign -> "="
290+ EqualSign -> equals
292− RightArrow -> "->"
291+ RightArrow -> txt "->"
293 placeHanging placement p_body
292 placeHanging placement p_body
294 where
293 where
295 placement =
294 placement =
296 case endOfGuards of
295 case endOfGuards of
297 Nothing -> placer (unLoc body)
296 Nothing -> placer (unLoc body)
298 Just spn ->
297 Just spn ->
299− if isOneLineSpan (mkSrcSpan spn (srcSpanStart (getLoc body)))
298+ if onTheSameLine spn (getLoc body)
300 then placer (unLoc body)
299 then placer (unLoc body)
301 else Normal
300 else Normal
302 endOfGuards =
301 endOfGuards =
303 case NE.nonEmpty guards of
302 case NE.nonEmpty guards of
304 Nothing -> Nothing
303 Nothing -> Nothing
305− Just gs -> (Just . srcSpanEnd . getLoc . NE.last) gs
304+ Just gs -> (Just . getLoc . NE.last) gs
306 p_body = located body render
305 p_body = located body render
307p_grhs' _ _ _ (XGRHS x) = noExtCon x
306p_grhs' _ _ _ (XGRHS x) = noExtCon x
308
307
@@ -317,7 +316,7 @@ p_hsCmd = \case
317 HsHigherOrderApp -> txt "-<<"
316 HsHigherOrderApp -> txt "-<<"
318 placeHanging (exprPlacement (unLoc input)) $
317 placeHanging (exprPlacement (unLoc input)) $
319 located input p_hsExpr
318 located input p_hsExpr
320− HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ sitcc $ do
319+ HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ do
321 located form p_hsExpr
320 located form p_hsExpr
322 unless (null cmds) $ do
321 unless (null cmds) $ do
323 breakpoint
322 breakpoint
@@ -354,7 +353,14 @@ p_hsCmdTop = \case
354 HsCmdTop NoExtField cmd -> located cmd p_hsCmd
353 HsCmdTop NoExtField cmd -> located cmd p_hsCmd
355 XCmdTop x -> noExtCon x
354 XCmdTop x -> noExtCon x
356
355
356+-- | Render an expression preserving blank lines between such consecutive
357+-- expressions found in the original source code.
357−withSpacing :: Data a => (a -> R ()) -> Located a -> R ()
358+withSpacing ::
359+ -- | Rendering function
360+ (a -> R ()) ->
361+ -- | Entity to render
362+ Located a ->
363+ R ()
358withSpacing f l = located l $ \x -> do
364withSpacing f l = located l $ \x -> do
359 case getLoc l of
365 case getLoc l of
360 UnhelpfulSpan _ -> f x
366 UnhelpfulSpan _ -> f x
@@ -363,7 +369,7 @@ withSpacing f l = located l $ \x -> do
363 -- Spacing before comments will be handled by the code
369 -- Spacing before comments will be handled by the code
364 -- that prints comments, so we just have to deal with
370 -- that prints comments, so we just have to deal with
365 -- blank lines between statements here.
371 -- blank lines between statements here.
366− Just (OtherSpan lastSpn) ->
372+ Just (StatementSpan lastSpn) ->
367 if srcSpanStartLine currentSpn > srcSpanEndLine lastSpn + 1
373 if srcSpanStartLine currentSpn > srcSpanEndLine lastSpn + 1
368 then newline
374 then newline
369 else return ()
375 else return ()
@@ -374,7 +380,7 @@ withSpacing f l = located l $ \x -> do
374 getSpanMark >>= \case
380 getSpanMark >>= \case
375 Just (HaddockSpan _ _) -> return ()
381 Just (HaddockSpan _ _) -> return ()
376 Just (CommentSpan _) -> return ()
382 Just (CommentSpan _) -> return ()
377− _ -> setSpanMark (OtherSpan currentSpn)
383+ _ -> setSpanMark (StatementSpan currentSpn)
378
384
379p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
380p_stmt = p_stmt' exprPlacement p_hsExpr
386p_stmt = p_stmt' exprPlacement p_hsExpr
@@ -465,37 +471,31 @@ gatherStmtBlock (XParStmtBlock x) = noExtCon x
465p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
466p_hsLocalBinds = \case
472p_hsLocalBinds = \case
467 HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
473 HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
468− let ssStart =
469− either
470− (srcSpanStart . getLoc)
471− (srcSpanStart . getLoc)
472− items =
473− (Left <$> bagToList bag) ++ (Right <$> lsigs)
474− p_item (Left x) = located x p_valDecl
475− p_item (Right x) = located x p_sigDecl
476 -- When in a single-line layout, there is a chance that the inner
474 -- When in a single-line layout, there is a chance that the inner
477 -- elements will also contain semicolons and they will confuse the
475 -- elements will also contain semicolons and they will confuse the
478 -- parser. so we request braces around every element except the last.
476 -- parser. so we request braces around every element except the last.
479 br <- layoutToBraces <$> getLayout
477 br <- layoutToBraces <$> getLayout
480− sitcc $
478+ let items =
481− sepSemi
479+ let injectLeft (L l x) = L l (Left x)
482− ( \(p, i) ->
480+ injectRight (L l x) = L l (Right x)
483− ( case p of
481+ in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
482+ positionToBracing = \case
484− SinglePos -> id
483+ SinglePos -> id
485− FirstPos -> br
484+ FirstPos -> br
486− MiddlePos -> br
485+ MiddlePos -> br
487− LastPos -> id
486+ LastPos -> id
488− )
487+ p_item' (p, item) =
489− (p_item i)
488+ positionToBracing p $
490− )
489+ withSpacing (either p_valDecl p_sigDecl) item
490+ binds = sortOn (srcSpanStart . getLoc) items
491− (attachRelativePos $ sortOn ssStart items)
491+ sitcc $ sepSemi p_item' (attachRelativePos binds)
492 HsValBinds NoExtField _ -> notImplemented "HsValBinds"
492 HsValBinds NoExtField _ -> notImplemented "HsValBinds"
493 HsIPBinds NoExtField (IPBinds NoExtField xs) ->
493 HsIPBinds NoExtField (IPBinds NoExtField xs) ->
494 -- Second argument of IPBind is always Left before type-checking.
494 -- Second argument of IPBind is always Left before type-checking.
495 let p_ipBind (IPBind NoExtField (Left name) expr) = do
495 let p_ipBind (IPBind NoExtField (Left name) expr) = do
496 atom name
496 atom name
497 space
497 space
498− txt "="
498+ equals
499 breakpoint
499 breakpoint
500 useBraces $ inci $ located expr p_hsExpr
500 useBraces $ inci $ located expr p_hsExpr
501 p_ipBind (IPBind NoExtField (Right _) _) =
501 p_ipBind (IPBind NoExtField (Right _) _) =
@@ -514,15 +514,12 @@ p_hsRecField HsRecField {..} = do
514 p_rdrName hsRecFieldLbl
514 p_rdrName hsRecFieldLbl
515 unless hsRecPun $ do
515 unless hsRecPun $ do
516 space
516 space
517− txt "="
517+ equals
518+ let placement =
519+ if onTheSameLine (getLoc hsRecFieldLbl) (getLoc hsRecFieldArg)
518− let placement = exprPlacement (unLoc hsRecFieldArg)
520+ then exprPlacement (unLoc hsRecFieldArg)
521+ else Normal
519− placeHanging placement $ located hsRecFieldArg p_hsExpr
522+ placeHanging placement (located hsRecFieldArg p_hsExpr)
520−
521−p_hsTupArg :: HsTupArg GhcPs -> R ()
522−p_hsTupArg = \case
523− Present NoExtField x -> located x p_hsExpr
524− Missing NoExtField -> pure ()
525− XTupArg x -> noExtCon x
526
523
527p_hsExpr :: HsExpr GhcPs -> R ()
524p_hsExpr :: HsExpr GhcPs -> R ()
528p_hsExpr = p_hsExpr' N
525p_hsExpr = p_hsExpr' N
@@ -587,23 +584,21 @@ p_hsExpr' s = \case
587 -- do-block or case expression it is not a good idea. It seems
584 -- do-block or case expression it is not a good idea. It seems
588 -- to be safe to always bump indentation when the function
585 -- to be safe to always bump indentation when the function
589 -- expression is parenthesised.
586 -- expression is parenthesised.
590− indent =
587+ doIndent =
591 case func of
588 case func of
592− L _ (HsPar NoExtField _) -> inci
589+ L _ (HsPar NoExtField _) -> True
593− L _ (HsAppType NoExtField _ _) -> inci
590+ L _ (HsAppType NoExtField _ _) -> True
594− L _ (HsMultiIf NoExtField _) -> inci
591+ L _ (HsMultiIf NoExtField _) -> True
595− L spn _ ->
596− if isOneLineSpan spn
592+ L spn _ -> isOneLineSpan spn
597− then inci
593+ ub <-
598− else id
599− ub <- getLayout <&> \case
594+ getLayout <&> \case
600− SingleLine -> useBraces
595+ SingleLine -> useBraces
601− MultiLine -> id
596+ MultiLine -> id
602 ub $ do
597 ub $ do
603 located func (p_hsExpr' s)
598 located func (p_hsExpr' s)
604 breakpoint
599 breakpoint
605− indent $ sep breakpoint (located' p_hsExpr) initp
600+ inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
606− indent $ do
601+ inciIf doIndent $ do
607 unless (null initp) breakpoint
602 unless (null initp) breakpoint
608 located lastp p_hsExpr
603 located lastp p_hsExpr
609 Hanging -> do
604 Hanging -> do
@@ -618,10 +613,15 @@ p_hsExpr' s = \case
618 breakpoint
613 breakpoint
619 inci $ do
614 inci $ do
620 txt "@"
615 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
621 located (hswc_body a) p_hsType
622 OpApp NoExtField x op y -> do
622 OpApp NoExtField x op y -> do
623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
624− p_exprOpTree True s (reassociateOpTree getOpName opTree)
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
625 NegApp NoExtField e _ -> do
625 NegApp NoExtField e _ -> do
626 txt "-"
626 txt "-"
627 space
627 space
@@ -638,22 +638,27 @@ p_hsExpr' s = \case
638 let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
638 let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639 unless (useRecordDot' && isRecordDot') breakpoint
639 unless (useRecordDot' && isRecordDot') breakpoint
640 inci (located x p_hsExpr)
640 inci (located x p_hsExpr)
641− ExplicitTuple NoExtField args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
642 let isSection = any (isMissing . unLoc) args
642 let isSection = any (isMissing . unLoc) args
643 isMissing = \case
643 isMissing = \case
644 Missing NoExtField -> True
644 Missing NoExtField -> True
645 _ -> False
645 _ -> 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
646− let parens' =
651+ parens' =
647 case boxity of
652 case boxity of
648 Boxed -> parens
653 Boxed -> parens
649 Unboxed -> parensHash
654 Unboxed -> parensHash
650− if isSection
655+ in if isSection
651− then
656+ then
652− switchLayout [] . parens' s $
657+ switchLayout [] . parens' s $
653− sep comma (located' p_hsTupArg) args
658+ sep comma p_larg args
654− else
659+ else
655− switchLayout (getLoc <$> args) . parens' s . sitcc $
660+ switchLayout (getLoc <$> args) . parens' s $
656− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
661+ sep commaDel p_larg args
657 ExplicitSum NoExtField tag arity e ->
662 ExplicitSum NoExtField tag arity e ->
658 p_unboxedSum N tag arity (located e p_hsExpr)
663 p_unboxedSum N tag arity (located e p_hsExpr)
659 HsCase NoExtField e mgroup ->
664 HsCase NoExtField e mgroup ->
@@ -661,8 +666,9 @@ p_hsExpr' s = \case
661 HsIf NoExtField _ if' then' else' ->
666 HsIf NoExtField _ if' then' else' ->
662 p_if exprPlacement p_hsExpr if' then' else'
667 p_if exprPlacement p_hsExpr if' then' else'
663 HsMultiIf NoExtField guards -> do
668 HsMultiIf NoExtField guards -> do
664− txt "if "
669+ txt "if"
670+ breakpoint
665− inci . inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
666 HsLet NoExtField localBinds e ->
672 HsLet NoExtField localBinds e ->
667 p_let p_hsExpr localBinds e
673 p_let p_hsExpr localBinds e
668 HsDo NoExtField ctx es -> do
674 HsDo NoExtField ctx es -> do
@@ -674,15 +680,15 @@ p_hsExpr' s = \case
674 sepSemi
680 sepSemi
675 (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
681 (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
676 (unLoc es)
682 (unLoc es)
677− compBody = brackets N $ located es $ \xs -> do
683+ compBody = brackets N . located es $ \xs -> do
678 let p_parBody =
684 let p_parBody =
679 sep
685 sep
680− (breakpoint >> txt "| ")
686+ (breakpoint >> txt "|" >> space)
681 p_seqBody
687 p_seqBody
682 p_seqBody =
688 p_seqBody =
683 sitcc
689 sitcc
684 . sep
690 . sep
685− (comma >> breakpoint)
691+ commaDel
686 (located' (sitcc . p_stmt))
692 (located' (sitcc . p_stmt))
687 stmts = init xs
693 stmts = init xs
688 yield = last xs
694 yield = last xs
@@ -703,8 +709,8 @@ p_hsExpr' s = \case
703 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
704 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
705 ExplicitList _ _ xs ->
711 ExplicitList _ _ xs ->
706− brackets s . sitcc $
712+ brackets s $
707− sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
713+ sep commaDel (sitcc . located' p_hsExpr) xs
708 RecordCon {..} -> do
714 RecordCon {..} -> do
709 located rcon_con_name atom
715 located rcon_con_name atom
710 breakpoint
716 breakpoint
@@ -720,8 +726,8 @@ p_hsExpr' s = \case
720 case rec_dotdot of
726 case rec_dotdot of
721 Just {} -> [txt ".."]
727 Just {} -> [txt ".."]
722 Nothing -> []
728 Nothing -> []
723− inci . braces N . sitcc $
729+ inci . braces N $
724− sep (comma >> breakpoint) sitcc (fields <> dotdot)
730+ sep commaDel sitcc (fields <> dotdot)
725 RecordUpd {..} -> do
731 RecordUpd {..} -> do
726 located rupd_expr p_hsExpr
732 located rupd_expr p_hsExpr
727 useRecordDot' <- useRecordDot
733 useRecordDot' <- useRecordDot
@@ -739,9 +745,9 @@ p_hsExpr' s = \case
739 Unambiguous _ n -> n
745 Unambiguous _ n -> n
740 XAmbiguousFieldOcc x -> noExtCon x
746 XAmbiguousFieldOcc x -> noExtCon x
741 }
747 }
742− inci . braces N . sitcc $
748+ inci . braces N $
743 sep
749 sep
744− (comma >> breakpoint)
750+ commaDel
745 (sitcc . located' (p_hsRecField . updName))
751 (sitcc . located' (p_hsRecField . updName))
746 rupd_flds
752 rupd_flds
747 ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
753 ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
@@ -754,22 +760,22 @@ p_hsExpr' s = \case
754 ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
760 ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
755 ArithSeq NoExtField _ x ->
761 ArithSeq NoExtField _ x ->
756 case x of
762 case x of
757− From from -> brackets s . sitcc $ do
763+ From from -> brackets s $ do
758 located from p_hsExpr
764 located from p_hsExpr
759 breakpoint
765 breakpoint
760 txt ".."
766 txt ".."
761− FromThen from next -> brackets s . sitcc $ do
767+ FromThen from next -> brackets s $ do
762− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
768+ sep commaDel (located' p_hsExpr) [from, next]
763 breakpoint
769 breakpoint
764 txt ".."
770 txt ".."
765− FromTo from to -> brackets s . sitcc $ do
771+ FromTo from to -> brackets s $ do
766 located from p_hsExpr
772 located from p_hsExpr
767 breakpoint
773 breakpoint
768 txt ".."
774 txt ".."
769 space
775 space
770 located to p_hsExpr
776 located to p_hsExpr
771− FromThenTo from next to -> brackets s . sitcc $ do
777+ FromThenTo from next to -> brackets s $ do
772− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
778+ sep commaDel (located' p_hsExpr) [from, next]
773 breakpoint
779 breakpoint
774 txt ".."
780 txt ".."
775 space
781 space
@@ -819,7 +825,7 @@ p_patSynBind PSB {..} = do
819 breakpoint
825 breakpoint
820 located psb_def p_pat
826 located psb_def p_pat
821 ImplicitBidirectional -> do
827 ImplicitBidirectional -> do
822− txt "="
828+ equals
823 breakpoint
829 breakpoint
824 located psb_def p_pat
830 located psb_def p_pat
825 ExplicitBidirectional mgroup -> do
831 ExplicitBidirectional mgroup -> do
@@ -846,8 +852,8 @@ p_patSynBind PSB {..} = do
846 inci $ do
852 inci $ do
847 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
848 unless (null xs) breakpoint
854 unless (null xs) breakpoint
849− braces N . sitcc $
855+ braces N $
850− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
851 rhs
857 rhs
852 InfixCon l r -> do
858 InfixCon l r -> do
853 switchLayout [getLoc l, getLoc r] $ do
859 switchLayout [getLoc l, getLoc r] $ do
@@ -901,10 +907,12 @@ p_if placer render if' then' else' = do
901 breakpoint
907 breakpoint
902 inci $ do
908 inci $ do
903 txt "then"
909 txt "then"
910+ space
904 located then' $ \x ->
911 located then' $ \x ->
905 placeHanging (placer x) (render x)
912 placeHanging (placer x) (render x)
906 breakpoint
913 breakpoint
907 txt "else"
914 txt "else"
915+ space
908 located else' $ \x ->
916 located else' $ \x ->
909 placeHanging (placer x) (render x)
917 placeHanging (placer x) (render x)
910
918
@@ -941,13 +949,13 @@ p_pat = \case
941 txt "!"
949 txt "!"
942 located pat p_pat
950 located pat p_pat
943 ListPat NoExtField pats ->
951 ListPat NoExtField pats ->
944− brackets S . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
952+ brackets S $ sep commaDel (located' p_pat) pats
945 TuplePat NoExtField pats boxing -> do
953 TuplePat NoExtField pats boxing -> do
946− let f =
954+ let parens' =
947 case boxing of
955 case boxing of
948 Boxed -> parens S
956 Boxed -> parens S
949 Unboxed -> parensHash S
957 Unboxed -> parensHash S
950− f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
958+ parens' $ sep commaDel (sitcc . located' p_pat) pats
951 SumPat NoExtField pat tag arity ->
959 SumPat NoExtField pat tag arity ->
952 p_unboxedSum S tag arity (located pat p_pat)
960 p_unboxedSum S tag arity (located pat p_pat)
953 ConPatIn pat details ->
961 ConPatIn pat details ->
@@ -963,7 +971,7 @@ p_pat = \case
963 let f = \case
971 let f = \case
964 Nothing -> txt ".."
972 Nothing -> txt ".."
965 Just x -> located x p_pat_hsRecField
973 Just x -> located x p_pat_hsRecField
966− inci . braces N . sitcc . sep (comma >> breakpoint) f $
974+ inci . braces N . sep commaDel f $
967 case dotdot of
975 case dotdot of
968 Nothing -> Just <$> fields
976 Nothing -> Just <$> fields
969 Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
977 Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
@@ -1004,7 +1012,7 @@ p_pat_hsRecField HsRecField {..} = do
1004 p_rdrName (rdrNameFieldOcc x)
1012 p_rdrName (rdrNameFieldOcc x)
1005 unless hsRecPun $ do
1013 unless hsRecPun $ do
1006 space
1014 space
1007− txt "="
1015+ equals
1008 breakpoint
1016 breakpoint
1009 inci (located hsRecFieldArg p_pat)
1017 inci (located hsRecFieldArg p_pat)
1010
1018
@@ -1013,17 +1021,15 @@ p_unboxedSum s tag arity m = do
1013 let before = tag - 1
1021 let before = tag - 1
1014 after = arity - before - 1
1022 after = arity - before - 1
1015 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1016− f (x, i) = do
1024+ f x =
1017− let isFirst = i == 0
1018− isLast = i == arity - 1
1019 case x :: Maybe (R ()) of
1025 case x :: Maybe (R ()) of
1020 Nothing ->
1026 Nothing ->
1021− unless (isFirst || isLast) space
1027+ space
1022 Just m' -> do
1028 Just m' -> do
1023− unless isFirst space
1029+ space
1024 m'
1030 m'
1025− unless isLast space
1031+ space
1026− parensHash s $ sep (txt "|") f (zip args [0 ..])
1032+ parensHash s $ sep (txt "|") f args
1027
1033
1028p_hsSplice :: HsSplice GhcPs -> R ()
1034p_hsSplice :: HsSplice GhcPs -> R ()
1029p_hsSplice = \case
1035p_hsSplice = \case
@@ -1225,11 +1231,10 @@ exprPlacement = \case
1225 HsCase NoExtField _ _ -> Hanging
1231 HsCase NoExtField _ _ -> Hanging
1226 HsDo NoExtField DoExpr _ -> Hanging
1232 HsDo NoExtField DoExpr _ -> Hanging
1227 HsDo NoExtField MDoExpr _ -> Hanging
1233 HsDo NoExtField MDoExpr _ -> Hanging
1228− -- If the rightmost expression in an operator chain is hanging, make the
1234+ OpApp NoExtField _ op y ->
1229− -- whole block hanging; so that we can use the common @f = foo $ do@
1235+ case (fmap getOpNameStr . getOpName . unLoc) op of
1230− -- style.
1231− OpApp NoExtField _ _ y -> exprPlacement (unLoc y)
1236+ Just "$" -> exprPlacement (unLoc y)
1232− -- Same thing for function applications (usually with -XBlockArguments)
1237+ _ -> Normal
1233 HsApp NoExtField _ y -> exprPlacement (unLoc y)
1238 HsApp NoExtField _ y -> exprPlacement (unLoc y)
1234 HsProc NoExtField p _ ->
1239 HsProc NoExtField p _ ->
1235 -- Indentation breaks if pattern is longer than one line and left
1240 -- Indentation breaks if pattern is longer than one line and left
@@ -1255,15 +1260,16 @@ getOpName = \case
1255 HsVar NoExtField (L _ a) -> Just a
1260 HsVar NoExtField (L _ a) -> Just a
1256 _ -> Nothing
1261 _ -> Nothing
1257
1262
1263+getOpNameStr :: RdrName -> String
1264+getOpNameStr = occNameString . rdrNameOcc
1265+
1258p_exprOpTree ::
1266p_exprOpTree ::
1259− -- | Can use special handling of dollar?
1260− Bool ->
1261 -- | Bracket style to use
1267 -- | Bracket style to use
1262 BracketStyle ->
1268 BracketStyle ->
1263 OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
1269 OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
1264 R ()
1270 R ()
1265−p_exprOpTree _ s (OpNode x) = located x (p_hsExpr' s)
1271+p_exprOpTree s (OpNode x) = located x (p_hsExpr' s)
1266−p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1272+p_exprOpTree s (OpBranch x op y) = do
1267 -- If the beginning of the first argument and the second argument are on
1273 -- If the beginning of the first argument and the second argument are on
1268 -- the same line, and the second argument has a hanging form, use hanging
1274 -- the same line, and the second argument has a hanging form, use hanging
1269 -- placement.
1275 -- placement.
@@ -1285,44 +1291,54 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1285 MultiLine -> case placement of
1291 MultiLine -> case placement of
1286 Hanging -> useBraces
1292 Hanging -> useBraces
1287 Normal -> dontUseBraces
1293 Normal -> dontUseBraces
1288− gotDollar = case getOpName (unLoc op) of
1294+ opNameStr = (fmap getOpNameStr . getOpName . unLoc) op
1289− Just rname -> mkVarOcc "$" == rdrNameOcc rname
1295+ gotDollar = opNameStr == Just "$"
1290− _ -> False
1296+ gotColon = opNameStr == Just ":"
1297+ gotRecordDot = isRecordDot (unLoc op) (opTreeLoc y)
1291 lhs =
1298 lhs =
1292 switchLayout [opTreeLoc x] $
1299 switchLayout [opTreeLoc x] $
1293− p_exprOpTree (not gotDollar) s x
1300+ p_exprOpTree s x
1294− let p_op = located op (opWrapper . p_hsExpr)
1301+ p_op = located op (opWrapper . p_hsExpr)
1295− p_y = switchLayout [opTreeLoc y] (p_exprOpTree True N y)
1302+ p_y = switchLayout [opTreeLoc y] (p_exprOpTree N y)
1296 isSection = case (opTreeLoc x, getLoc op) of
1303 isSection = case (opTreeLoc x, getLoc op) of
1297 (RealSrcSpan treeSpan, RealSrcSpan opSpan) ->
1304 (RealSrcSpan treeSpan, RealSrcSpan opSpan) ->
1298 srcSpanEndCol treeSpan /= srcSpanStartCol opSpan
1305 srcSpanEndCol treeSpan /= srcSpanStartCol opSpan
1299 _ -> False
1306 _ -> False
1307+ isDoBlock = \case
1308+ OpNode (L _ HsDo {}) -> True
1309+ _ -> False
1300 useRecordDot' <- useRecordDot
1310 useRecordDot' <- useRecordDot
1301− let isRecordDot' = isRecordDot (unLoc op) (opTreeLoc y)
1311+ if
1302− if useRecordDot' && isRecordDot'
1312+ | gotColon -> do
1303− then do
1304− lhs
1305− when isSection space
1306− p_op
1307− p_y
1308− else
1309− if isDollarSpecial
1310− && gotDollar
1311− && placement
1312− == Normal
1313− && isOneLineSpan (opTreeLoc x)
1314− then do
1315− useBraces lhs
1313+ lhs
1316− space
1314+ space
1317− p_op
1315+ p_op
1318− breakpoint
1316+ case placement of
1319− inci p_y
1317+ Hanging -> do
1320− else do
1321− ub lhs
1322− placeHanging placement $ do
1323− p_op
1324 space
1318 space
1325 p_y
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
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
1336+ | otherwise -> do
1337+ ub lhs
1338+ placeHanging placement $ do
1339+ p_op
1340+ space
1341+ p_y
1326
1342
1327-- | Return 'True' if given expression is a record-dot operator expression.
1343-- | Return 'True' if given expression is a record-dot operator expression.
1328isRecordDot ::
1344isRecordDot ::
@@ -1333,14 +1349,10 @@ isRecordDot ::
1333 Bool
1349 Bool
1334isRecordDot op (RealSrcSpan ySpan) = case op of
1350isRecordDot op (RealSrcSpan ySpan) = case op of
1335 HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1351 HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1336− isDot opName && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1352+ (getOpNameStr opName == ".") && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1337 _ -> False
1353 _ -> False
1338isRecordDot _ _ = False
1354isRecordDot _ _ = False
1339
1355
1340−-- | Check whether a given 'RdrName' is the dot operator.
1341−isDot :: RdrName -> Bool
1342−isDot name = rdrNameOcc name == mkVarOcc "."
1343−
1344-- | Get annotations for the enclosing element.
1356-- | Get annotations for the enclosing element.
1345getEnclosingAnns :: R [AnnKeywordId]
1357getEnclosingAnns :: R [AnnKeywordId]
1346getEnclosingAnns = do
1358getEnclosingAnns = do
src/Ormolu/Printer/Meat/Declaration/Value.hs-boot−4
@@ -11,11 +11,7 @@ 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−
15p_pat :: Pat GhcPs -> R ()
14p_pat :: Pat GhcPs -> R ()
16−
17p_hsExpr :: HsExpr GhcPs -> R ()
15p_hsExpr :: HsExpr GhcPs -> R ()
18−
19p_hsSplice :: HsSplice GhcPs -> R ()
16p_hsSplice :: HsSplice GhcPs -> R ()
20−
21p_stringLit :: String -> R ()
17p_stringLit :: String -> R ()
src/Ormolu/Printer/Meat/Declaration/Warning.hs+5−8
@@ -27,17 +27,14 @@ p_warnDecl (XWarnDecl x) = noExtCon x
27p_moduleWarning :: WarningTxt -> R ()
27p_moduleWarning :: WarningTxt -> R ()
28p_moduleWarning wtxt = do
28p_moduleWarning wtxt = do
29 let (pragmaText, lits) = warningText wtxt
29 let (pragmaText, lits) = warningText wtxt
30− switchLayout (getLoc <$> lits)
31− $ inci
32− $ pragma pragmaText (inci $ p_lits lits)
30+ inci $ pragma pragmaText $ inci $ p_lits lits
33
31
34p_topLevelWarning :: [Located RdrName] -> WarningTxt -> R ()
32p_topLevelWarning :: [Located RdrName] -> WarningTxt -> R ()
35p_topLevelWarning fnames wtxt = do
33p_topLevelWarning fnames wtxt = do
36 let (pragmaText, lits) = warningText wtxt
34 let (pragmaText, lits) = warningText wtxt
37− switchLayout (fmap getLoc fnames ++ fmap getLoc lits)
35+ switchLayout (fmap getLoc fnames ++ fmap getLoc lits) $
38− $ pragma pragmaText . inci
36+ pragma pragmaText . inci $ do
39− $ do
40− sitcc $ sep (comma >> breakpoint) p_rdrName fnames
37+ sep commaDel p_rdrName fnames
41 breakpoint
38 breakpoint
42 p_lits lits
39 p_lits lits
43
40
@@ -49,4 +46,4 @@ warningText = \case
49p_lits :: [Located StringLiteral] -> R ()
46p_lits :: [Located StringLiteral] -> R ()
50p_lits = \case
47p_lits = \case
51 [l] -> atom l
48 [l] -> atom l
52− ls -> brackets N . sitcc $ sep (comma >> breakpoint) atom ls
49+ ls -> brackets N $ sep commaDel atom ls
src/Ormolu/Printer/Meat/ImportExport.hs+4−5
@@ -21,7 +21,7 @@ p_hsmodExports [] = do
21 breakpoint'
21 breakpoint'
22 txt ")"
22 txt ")"
23p_hsmodExports xs =
23p_hsmodExports xs =
24− parens N . sitcc $ do
24+ parens N $ do
25 layout <- getLayout
25 layout <- getLayout
26 sep
26 sep
27 breakpoint
27 breakpoint
@@ -65,7 +65,7 @@ p_hsmodImport useQualifiedPost ImportDecl {..} = do
65 Nothing -> return ()
65 Nothing -> return ()
66 Just (_, L _ xs) -> do
66 Just (_, L _ xs) -> do
67 breakpoint
67 breakpoint
68− parens N . sitcc $ do
68+ parens N $ do
69 layout <- getLayout
69 layout <- getLayout
70 sep
70 sep
71 breakpoint
71 breakpoint
@@ -93,9 +93,8 @@ p_lie encLayout relativePos = \case
93 inci $ do
93 inci $ do
94 let names :: [R ()]
94 let names :: [R ()]
95 names = located' p_ieWrappedName <$> xs
95 names = located' p_ieWrappedName <$> xs
96− parens N . sitcc
96+ parens N . sep commaDel sitcc $
97− $ sep (comma >> breakpoint) sitcc
98− $ case w of
97+ case w of
99 NoIEWildcard -> names
98 NoIEWildcard -> names
100 IEWildcard n ->
99 IEWildcard n ->
101 let (before, after) = splitAt n names
100 let (before, after) = splitAt n names
src/Ormolu/Printer/Meat/Module.hs+12−15
@@ -11,7 +11,7 @@ where
11import Control.Monad
11import Control.Monad
12import qualified Data.Text as T
12import qualified Data.Text as T
13import GHC
13import GHC
14−import Ormolu.Imports
14+import Ormolu.Imports (normalizeImports)
15import Ormolu.Parser.CommentStream
15import Ormolu.Parser.CommentStream
16import Ormolu.Parser.Pragma
16import Ormolu.Parser.Pragma
17import Ormolu.Parser.Shebang
17import Ormolu.Parser.Shebang
@@ -34,16 +34,12 @@ p_hsModule ::
34 -- | Whether to use postfix qualified imports
34 -- | Whether to use postfix qualified imports
35 Bool ->
35 Bool ->
36 -- | AST to print
36 -- | AST to print
37− ParsedSource ->
37+ HsModule GhcPs ->
38 R ()
38 R ()
39−p_hsModule mstackHeader shebangs pragmas qualifiedPost (L moduleSpan HsModule {..}) = do
39+p_hsModule mstackHeader shebangs pragmas qualifiedPost HsModule {..} = do
40− -- If span of exports in multiline, the whole thing is multiline. This is
41− -- especially important because span of module itself always seems to have
42− -- length zero, so it's not reliable for layout selection.
43− let exportSpans = maybe [] (\(L s _) -> [s]) hsmodExports
44− deprecSpan = maybe [] (\(L s _) -> [s]) hsmodDeprecMessage
40+ let deprecSpan = maybe [] (\(L s _) -> [s]) hsmodDeprecMessage
45− spans' = exportSpans ++ deprecSpan ++ [moduleSpan]
41+ exportSpans = maybe [] (\(L s _) -> [s]) hsmodExports
46− switchLayout spans' $ do
42+ switchLayout (deprecSpan <> exportSpans) $ do
47 forM_ shebangs $ \(Shebang x) ->
43 forM_ shebangs $ \(Shebang x) ->
48 located x $ \shebang -> do
44 located x $ \shebang -> do
49 txt (T.pack shebang)
45 txt (T.pack shebang)
@@ -60,19 +56,20 @@ p_hsModule mstackHeader shebangs pragmas qualifiedPost (L moduleSpan HsModule {.
60 located hsmodName' $ \name -> do
56 located hsmodName' $ \name -> do
61 forM_ hsmodHaddockModHeader (p_hsDocString Pipe True)
57 forM_ hsmodHaddockModHeader (p_hsDocString Pipe True)
62 p_hsmodName name
58 p_hsmodName name
59+ breakpoint
63 forM_ hsmodDeprecMessage $ \w -> do
60 forM_ hsmodDeprecMessage $ \w -> do
64− breakpoint
65 located' p_moduleWarning w
61 located' p_moduleWarning w
62+ breakpoint
66 case hsmodExports of
63 case hsmodExports of
67 Nothing -> return ()
64 Nothing -> return ()
68− Just hsmodExports' -> do
65+ Just l -> do
66+ located l $ \exports -> do
67+ inci (p_hsmodExports exports)
69 breakpoint
68 breakpoint
70− inci (p_hsmodExports (unLoc hsmodExports'))
71− breakpoint
72 txt "where"
69 txt "where"
73 newline
70 newline
74 newline
71 newline
75− forM_ (sortImports hsmodImports) (located' (p_hsmodImport qualifiedPost))
72+ forM_ (normalizeImports hsmodImports) (located' (p_hsmodImport qualifiedPost))
76 newline
73 newline
77 switchLayout (getLoc <$> hsmodDecls) $ do
74 switchLayout (getLoc <$> hsmodDecls) $ do
78 p_hsDecls Free hsmodDecls
75 p_hsDecls Free hsmodDecls
src/Ormolu/Printer/Meat/Type.hs+35−24
@@ -5,6 +5,7 @@
5-- | Rendering of types.
5-- | Rendering of types.
6module Ormolu.Printer.Meat.Type
6module Ormolu.Printer.Meat.Type
7 ( p_hsType,
7 ( p_hsType,
8+ p_hsTypePostDoc,
8 hasDocStrings,
9 hasDocStrings,
9 p_hsContext,
10 p_hsContext,
10 p_hsTyVarBndr,
11 p_hsTyVarBndr,
@@ -23,14 +24,22 @@ import Ormolu.Printer.Operators
23import Ormolu.Utils
24import Ormolu.Utils
24
25
25p_hsType :: HsType GhcPs -> R ()
26p_hsType :: HsType GhcPs -> R ()
26−p_hsType t = p_hsType' (hasDocStrings t) t
27+p_hsType t = p_hsType' (hasDocStrings t) PipeStyle t
27
28
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+
28−p_hsType' :: Bool -> HsType GhcPs -> R ()
37+p_hsType' :: Bool -> TypeDocStyle -> HsType GhcPs -> R ()
29−p_hsType' multilineArgs = \case
38+p_hsType' multilineArgs docStyle = \case
30 HsForAllTy NoExtField visibility bndrs t -> do
39 HsForAllTy NoExtField visibility bndrs t -> do
31 p_forallBndrs visibility p_hsTyVarBndr bndrs
40 p_forallBndrs visibility p_hsTyVarBndr bndrs
32 interArgBreak
41 interArgBreak
33− p_hsType' multilineArgs (unLoc t)
42+ p_hsTypeR (unLoc t)
34 HsQualTy NoExtField qs t -> do
43 HsQualTy NoExtField qs t -> do
35 located qs p_hsContext
44 located qs p_hsContext
36 space
45 space
@@ -58,7 +67,7 @@ p_hsType' multilineArgs = \case
58 L _ (HsAppTy _ l r) -> gatherArgs l (r : knownArgs)
67 L _ (HsAppTy _ l r) -> gatherArgs l (r : knownArgs)
59 _ -> (f', knownArgs)
68 _ -> (f', knownArgs)
60 (func, args) = gatherArgs f [x]
69 (func, args) = gatherArgs f [x]
61− switchLayout (getLoc f : fmap getLoc args) $ sitcc $ do
70+ switchLayout (getLoc f : fmap getLoc args) . sitcc $ do
62 located func p_hsType
71 located func p_hsType
63 breakpoint
72 breakpoint
64 inci $
73 inci $
@@ -89,10 +98,9 @@ p_hsType' multilineArgs = \case
89 HsBoxedTuple -> parens N
98 HsBoxedTuple -> parens N
90 HsConstraintTuple -> parens N
99 HsConstraintTuple -> parens N
91 HsBoxedOrConstraintTuple -> parens N
100 HsBoxedOrConstraintTuple -> parens N
92− in parens' . sitcc $
93− sep (comma >> breakpoint) (sitcc . located' p_hsType) xs
101+ in parens' $ sep commaDel (sitcc . located' p_hsType) xs
94 HsSumTy NoExtField xs ->
102 HsSumTy NoExtField xs ->
95− parensHash N . sitcc $
103+ parensHash N $
96 sep (txt "|" >> breakpoint) (sitcc . located' p_hsType) xs
104 sep (txt "|" >> breakpoint) (sitcc . located' p_hsType) xs
97 HsOpTy NoExtField x op y ->
105 HsOpTy NoExtField x op y ->
98 sitcc $
106 sitcc $
@@ -109,14 +117,20 @@ p_hsType' multilineArgs = \case
109 HsStarTy NoExtField _ -> txt "*"
117 HsStarTy NoExtField _ -> txt "*"
110 HsKindSig NoExtField t k -> sitcc $ do
118 HsKindSig NoExtField t k -> sitcc $ do
111 located t p_hsType
119 located t p_hsType
112− space -- FIXME
113− txt "::"
114 space
120 space
121+ txt "::"
122+ breakpoint
115 inci (located k p_hsType)
123 inci (located k p_hsType)
116 HsSpliceTy NoExtField splice -> p_hsSplice splice
124 HsSpliceTy NoExtField splice -> p_hsSplice splice
117− HsDocTy NoExtField t str -> do
125+ HsDocTy NoExtField t str ->
126+ case docStyle of
127+ PipeStyle -> do
118− p_hsDocString Pipe True str
128+ p_hsDocString Pipe True str
129+ located t p_hsType
130+ CaretStyle -> do
119− located t p_hsType
131+ located t p_hsType
132+ newline
133+ p_hsDocString Caret False str
120 HsBangTy NoExtField (HsSrcBang _ u s) t -> do
134 HsBangTy NoExtField (HsSrcBang _ u s) t -> do
121 case u of
135 case u of
122 SrcUnpack -> txt "{-# UNPACK #-}" >> space
136 SrcUnpack -> txt "{-# UNPACK #-}" >> space
@@ -139,14 +153,14 @@ p_hsType' multilineArgs = \case
139 case (p, xs) of
153 case (p, xs) of
140 (IsPromoted, L _ t : _) | isPromoted t -> space
154 (IsPromoted, L _ t : _) | isPromoted t -> space
141 _ -> return ()
155 _ -> return ()
142− sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsType) xs
156+ sep commaDel (sitcc . located' p_hsType) xs
143 HsExplicitTupleTy NoExtField xs -> do
157 HsExplicitTupleTy NoExtField xs -> do
144 txt "'"
158 txt "'"
145 parens N $ do
159 parens N $ do
146 case xs of
160 case xs of
147 L _ t : _ | isPromoted t -> space
161 L _ t : _ | isPromoted t -> space
148 _ -> return ()
162 _ -> return ()
149− sep (comma >> breakpoint) (located' p_hsType) xs
163+ sep commaDel (located' p_hsType) xs
150 HsTyLit NoExtField t ->
164 HsTyLit NoExtField t ->
151 case t of
165 case t of
152 HsStrTy (SourceText s) _ -> p_stringLit s
166 HsStrTy (SourceText s) _ -> p_stringLit s
@@ -156,14 +170,14 @@ p_hsType' multilineArgs = \case
156 where
170 where
157 isPromoted = \case
171 isPromoted = \case
158 HsTyVar _ IsPromoted _ -> True
172 HsTyVar _ IsPromoted _ -> True
159− HsExplicitListTy {} -> True
160 HsExplicitTupleTy {} -> True
173 HsExplicitTupleTy {} -> True
174+ HsExplicitListTy {} -> True
161 _ -> False
175 _ -> False
162 interArgBreak =
176 interArgBreak =
163 if multilineArgs
177 if multilineArgs
164 then newline
178 then newline
165 else breakpoint
179 else breakpoint
166− p_hsTypeR = p_hsType' multilineArgs
180+ p_hsTypeR = p_hsType' multilineArgs docStyle
167
181
168-- | Return 'True' if at least one argument in 'HsType' has a doc string
182-- | Return 'True' if at least one argument in 'HsType' has a doc string
169-- attached to it.
183-- attached to it.
@@ -177,9 +191,7 @@ p_hsContext :: HsContext GhcPs -> R ()
177p_hsContext = \case
191p_hsContext = \case
178 [] -> txt "()"
192 [] -> txt "()"
179 [x] -> located x p_hsType
193 [x] -> located x p_hsType
180− xs ->
181− parens N . sitcc $
182− sep (comma >> breakpoint) (sitcc . located' p_hsType) xs
194+ xs -> parens N $ sep commaDel (sitcc . located' p_hsType) xs
183
195
184p_hsTyVarBndr :: HsTyVarBndr GhcPs -> R ()
196p_hsTyVarBndr :: HsTyVarBndr GhcPs -> R ()
185p_hsTyVarBndr = \case
197p_hsTyVarBndr = \case
@@ -209,15 +221,14 @@ p_forallBndrs vis p tyvars =
209
221
210p_conDeclFields :: [LConDeclField GhcPs] -> R ()
222p_conDeclFields :: [LConDeclField GhcPs] -> R ()
211p_conDeclFields xs =
223p_conDeclFields xs =
212− braces N . sitcc $
213− sep (comma >> breakpoint) (sitcc . located' p_conDeclField) xs
224+ braces N $ sep commaDel (sitcc . located' p_conDeclField) xs
214
225
215p_conDeclField :: ConDeclField GhcPs -> R ()
226p_conDeclField :: ConDeclField GhcPs -> R ()
216p_conDeclField ConDeclField {..} = do
227p_conDeclField ConDeclField {..} = do
217 mapM_ (p_hsDocString Pipe True) cd_fld_doc
228 mapM_ (p_hsDocString Pipe True) cd_fld_doc
218 sitcc $
229 sitcc $
219 sep
230 sep
220− (comma >> breakpoint)
231+ commaDel
221 (located' (p_rdrName . rdrNameFieldOcc))
232 (located' (p_rdrName . rdrNameFieldOcc))
222 cd_fld_names
233 cd_fld_names
223 space
234 space
@@ -259,6 +270,6 @@ tyVarToType = \case
259 -- <https://gitlab.haskell.org/ghc/ghc/issues/17404>. This is fine as
270 -- <https://gitlab.haskell.org/ghc/ghc/issues/17404>. This is fine as
260 -- long as 'tyVarToType' does not get applied to right-hand sides of
271 -- long as 'tyVarToType' does not get applied to right-hand sides of
261 -- declarations.
272 -- declarations.
262− HsParTy NoExtField $ noLoc $
273+ HsParTy NoExtField . noLoc $
263 HsKindSig NoExtField (noLoc (HsTyVar NoExtField NotPromoted tvar)) kind
274 HsKindSig NoExtField (noLoc (HsTyVar NoExtField NotPromoted tvar)) kind
264 XTyVarBndr x -> noExtCon x
275 XTyVarBndr x -> noExtCon x
src/Ormolu/Printer/Operators.hs+46−59
@@ -12,10 +12,11 @@ where
12
12
13import Data.Function (on)
13import Data.Function (on)
14import qualified Data.List as L
14import qualified Data.List as L
15+import Data.Map.Strict (Map)
16+import qualified Data.Map.Strict as M
15import Data.Maybe (fromMaybe, mapMaybe)
17import Data.Maybe (fromMaybe, mapMaybe)
16−import Data.Ord (Down (Down), comparing)
17import GHC
18import GHC
18−import OccName (mkVarOcc)
19+import OccName (occNameString)
19import Ormolu.Utils (unSrcSpan)
20import Ormolu.Utils (unSrcSpan)
20
21
21-- | Intermediate representation of operator trees. It has two type
22-- | Intermediate representation of operator trees. It has two type
@@ -56,7 +57,7 @@ reassociateOpTree getOpName opTree =
56reassociateOpTreeWith ::
57reassociateOpTreeWith ::
57 forall ty op.
58 forall ty op.
58 -- | Fixity map for operators
59 -- | Fixity map for operators
59− [(RdrName, Fixity)] ->
60+ Map String Fixity ->
60 -- | How to get the name of an operator
61 -- | How to get the name of an operator
61 (op -> Maybe RdrName) ->
62 (op -> Maybe RdrName) ->
62 -- | Original 'OpTree'
63 -- | Original 'OpTree'
@@ -67,13 +68,13 @@ reassociateOpTreeWith fixityMap getOpName = go
67 where
68 where
68 fixityOf :: op -> Fixity
69 fixityOf :: op -> Fixity
69 fixityOf op = fromMaybe defaultFixity $ do
70 fixityOf op = fromMaybe defaultFixity $ do
70− opName <- getOpName op
71+ s <- occNameString . rdrNameOcc <$> getOpName op
71− lookup opName fixityMap
72+ M.lookup s fixityMap
72 -- Here, left branch is already associated and the root alongside with
73 -- Here, left branch is already associated and the root alongside with
73 -- the right branch is right-associated. This function picks up one item
74 -- the right branch is right-associated. This function picks up one item
74 -- from the right and inserts it correctly to the left.
75 -- from the right and inserts it correctly to the left.
75 --
76 --
76− -- Also, we are using the 'compareFixity' function which returns if the
77+ -- Also, we are using the 'compareFixity' function which tells if the
77 -- expression should associate to right.
78 -- expression should associate to right.
78 go :: OpTree ty op -> OpTree ty op
79 go :: OpTree ty op -> OpTree ty op
79 -- base cases
80 -- base cases
@@ -93,6 +94,16 @@ reassociateOpTreeWith fixityMap getOpName = go
93 then go $ OpBranch (OpBranch l op (go $ OpBranch r op' l')) op'' r'
94 then go $ OpBranch (OpBranch l op (go $ OpBranch r op' l')) op'' r'
94 else go $ OpBranch (OpBranch (OpBranch l op r) op' l') op'' r'
95 else go $ OpBranch (OpBranch (OpBranch l op r) op' l') op'' r'
95
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+
96-- | Build a map of inferred 'Fixity's from an 'OpTree'.
107-- | Build a map of inferred 'Fixity's from an 'OpTree'.
97buildFixityMap ::
108buildFixityMap ::
98 forall ty op.
109 forall ty op.
@@ -101,23 +112,26 @@ buildFixityMap ::
101 -- | Operator tree
112 -- | Operator tree
102 OpTree (Located ty) (Located op) ->
113 OpTree (Located ty) (Located op) ->
103 -- | Fixity map
114 -- | Fixity map
104− [(RdrName, Fixity)]
115+ Map String Fixity
105buildFixityMap getOpName opTree =
116buildFixityMap getOpName opTree =
117+ addOverrides
118+ . M.fromList
106− concatMap (\(i, ns) -> map (\(n, _) -> (n, fixity i InfixL)) ns)
119+ . concatMap (\(i, ns) -> map (\(n, _) -> (n, fixity i InfixL)) ns)
107− . zip [0 ..]
120+ . zip [2 ..]
108− . L.groupBy (doubleWithinEps 0.00001 `on` snd)
121+ . L.groupBy ((==) `on` snd)
109− . (overrides ++)
122+ . selectScores
110− . modeScores
111 $ score opTree
123 $ score opTree
112 where
124 where
113− -- Add a special case for ($), since it is pretty unlikely for someone
125+ addOverrides :: Map String Fixity -> Map String Fixity
114− -- to override it.
126+ addOverrides m =
115− overrides :: [(RdrName, Double)]
127+ M.fromList
116− overrides =
128+ [ ("$", fixity 0 InfixR),
117− [ (mkRdrUnqual $ mkVarOcc "$", -1)
129+ (":", fixity 1 InfixR),
118− ]
130+ (".", fixity 100 InfixL)
119− -- Assign scores to operators based on their location in the source.
131+ ]
132+ `M.union` m
133+ fixity = Fixity NoSourceText
120− score :: OpTree (Located ty) (Located op) -> [(RdrName, Double)]
134+ score :: OpTree (Located ty) (Located op) -> [(String, Score)]
121 score (OpNode _) = []
135 score (OpNode _) = []
122 score (OpBranch l o r) = fromMaybe (score r) $ do
136 score (OpBranch l o r) = fromMaybe (score r) $ do
123 -- If we fail to get any of these, 'defaultFixity' will be used by
137 -- If we fail to get any of these, 'defaultFixity' will be used by
@@ -127,48 +141,27 @@ buildFixityMap getOpName opTree =
127 oe <- srcSpanEndLine <$> unSrcSpan (getLoc o) -- operator end
141 oe <- srcSpanEndLine <$> unSrcSpan (getLoc o) -- operator end
128 rb <- srcSpanStartLine <$> unSrcSpan (opTreeLoc r) -- right begin
142 rb <- srcSpanStartLine <$> unSrcSpan (opTreeLoc r) -- right begin
129 oc <- srcSpanStartCol <$> unSrcSpan (getLoc o) -- operator column
143 oc <- srcSpanStartCol <$> unSrcSpan (getLoc o) -- operator column
130− opName <- getOpName (unLoc o)
144+ opName <- occNameString . rdrNameOcc <$> getOpName (unLoc o)
131 let s
145 let s
132− | le < ob =
146+ | le < ob = AtBeginning oc
133− -- if the operator is in the beginning of a line, assign
134− -- a score relative to its column within range [0, 1).
135− fromIntegral oc / fromIntegral (maxCol + 1)
136− | oe < rb =
147+ | oe < rb = AtEnd
137− -- if the operator is in the end of the line, assign the
138− -- score 1.
139− 1
140− | otherwise =
148+ | otherwise = InBetween
141− 2 -- otherwise, assign a high score.
142 return $ (opName, s) : score r
149 return $ (opName, s) : score r
143− -- Pick the most common score per 'RdrName'.
150+ selectScores :: [(String, Score)] -> [(String, Score)]
144− modeScores :: [(RdrName, Double)] -> [(RdrName, Double)]
151+ selectScores =
145− modeScores =
146 L.sortOn snd
152 L.sortOn snd
147 . mapMaybe
153 . mapMaybe
148 ( \case
154 ( \case
149 [] -> Nothing
155 [] -> Nothing
150− xs@((n, _) : _) -> Just (n, mode $ map snd xs)
156+ xs@((n, _) : _) -> Just (n, selectScore $ map snd xs)
151 )
157 )
152 . L.groupBy ((==) `on` fst)
158 . L.groupBy ((==) `on` fst)
153 . L.sort
159 . L.sort
154− -- Return the most common number, leaning to the smaller
160+ selectScore :: [Score] -> Score
155− -- one in case of a tie.
161+ selectScore xs =
156− mode :: [Double] -> Double
162+ case filter (/= InBetween) xs of
157− mode =
163+ [] -> InBetween
158− head
159− . L.minimumBy (comparing (Down . length))
160− . L.groupBy (doubleWithinEps 0.0001)
161− . L.sort
162− -- The start column of the rightmost operator.
163− maxCol = go opTree
164− where
165− go (OpNode (L _ _)) = 0
166− go (OpBranch l (L o _) r) =
167− maximum
164+ xs' -> maximum xs'
168− [ go l,
169− maybe 0 srcSpanStartCol (unSrcSpan o),
170− go r
171− ]
172
165
173----------------------------------------------------------------------------
166----------------------------------------------------------------------------
174-- Helpers
167-- Helpers
@@ -182,9 +175,3 @@ normalizeOpTree (OpBranch (OpNode l) lop r) =
182 OpBranch (OpNode l) lop (normalizeOpTree r)
175 OpBranch (OpNode l) lop (normalizeOpTree r)
183normalizeOpTree (OpBranch (OpBranch l' lop' r') lop r) =
176normalizeOpTree (OpBranch (OpBranch l' lop' r') lop r) =
184 normalizeOpTree (OpBranch l' lop' (OpBranch r' lop r))
177 normalizeOpTree (OpBranch l' lop' (OpBranch r' lop r))
185−
186−fixity :: Int -> FixityDirection -> Fixity
187−fixity = Fixity NoSourceText
188−
189−doubleWithinEps :: Double -> Double -> Double -> Bool
190−doubleWithinEps eps a b = abs (a - b) < eps
src/Ormolu/Processing/Common.hs+1−1
@@ -20,7 +20,7 @@ data OrmoluState
20
20
21-- | Marker for the beginning of the region where Ormolu should be disabled.
21-- | Marker for the beginning of the region where Ormolu should be disabled.
22startDisabling :: IsString s => s
22startDisabling :: IsString s => s
23−startDisabling = "{- ORMOLU_DISABLING_START"
23+startDisabling = "{- ORMOLU_DISABLE_START"
24
24
25-- | Marker for the end of the region where Ormolu should be disabled.
25-- | Marker for the end of the region where Ormolu should be disabled.
26endDisabling :: IsString s => s
26endDisabling :: IsString s => s
src/Ormolu/Processing/Postprocess.hs+13−3
@@ -1,3 +1,6 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE ViewPatterns #-}
3+
1-- | Postprocessing for the results of printing.
4-- | Postprocessing for the results of printing.
2module Ormolu.Processing.Postprocess
5module Ormolu.Processing.Postprocess
3 ( postprocess,
6 ( postprocess,
@@ -10,12 +13,19 @@ import Ormolu.Processing.Common
10import qualified Ormolu.Processing.Cpp as Cpp
13import qualified Ormolu.Processing.Cpp as Cpp
11
14
12-- | Postprocess output of the formatter.
15-- | Postprocess output of the formatter.
13−postprocess :: Text -> Text
16+postprocess ::
17+ -- | Desired indentation level
18+ Int ->
19+ -- | Input to process
20+ Text ->
21+ Text
14−postprocess =
22+postprocess indent =
15 T.unlines
23 T.unlines
24+ . fmap indentLine
16 . fmap Cpp.unmaskLine
25 . fmap Cpp.unmaskLine
17 . filter (not . magicComment)
26 . filter (not . magicComment)
18 . T.lines
27 . T.lines
19 where
28 where
20− magicComment x =
29+ magicComment (T.stripStart -> x) =
21 x == startDisabling || x == endDisabling
30 x == startDisabling || x == endDisabling
31+ indentLine x = T.replicate indent " " <> x
src/Ormolu/Processing/Preprocess.hs+19−8
@@ -1,5 +1,6 @@
1{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE BangPatterns #-}
2{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE RecordWildCards #-}
3
4
4-- | Preprocessing for input source code.
5-- | Preprocessing for input source code.
5module Ormolu.Processing.Preprocess
6module Ormolu.Processing.Preprocess
@@ -10,9 +11,9 @@ where
10import Control.Monad
11import Control.Monad
11import Data.Char (isSpace)
12import Data.Char (isSpace)
12import qualified Data.List as L
13import qualified Data.List as L
13−import Data.Maybe (isJust)
14+import Data.Maybe (isJust, maybeToList)
14−import Data.Maybe (maybeToList)
15import FastString
15import FastString
16+import Ormolu.Config (RegionDeltas (..))
16import Ormolu.Parser.Shebang (isShebang)
17import Ormolu.Parser.Shebang (isShebang)
17import Ormolu.Processing.Common
18import Ormolu.Processing.Common
18import qualified Ormolu.Processing.Cpp as Cpp
19import qualified Ormolu.Processing.Cpp as Cpp
@@ -26,16 +27,25 @@ preprocess ::
26 FilePath ->
27 FilePath ->
27 -- | Input to process
28 -- | Input to process
28 String ->
29 String ->
29− -- | Adjusted input with comments extracted from it
30+ -- | Region deltas
31+ RegionDeltas ->
32+ -- | Literal prefix, pre-processed input, literal suffix, extra comments
30− (String, [Located String])
33+ (String, String, String, [Located String])
34+preprocess path input RegionDeltas {..} =
31−preprocess path input = go 1 OrmoluEnabled Cpp.Outside id id (lines input)
35+ go 1 OrmoluEnabled Cpp.Outside id id regionLines
32 where
36 where
37+ (prefixLines, otherLines) = splitAt regionPrefixLength (lines input)
38+ (regionLines, suffixLines) =
39+ let regionLength = length otherLines - regionSuffixLength
40+ in splitAt regionLength otherLines
33 go !n ormoluState cppState inputSoFar csSoFar = \case
41 go !n ormoluState cppState inputSoFar csSoFar = \case
34 [] ->
42 [] ->
35 let input' = unlines (inputSoFar [])
43 let input' = unlines (inputSoFar [])
44+ in ( unlines prefixLines,
36− in ( case ormoluState of
45+ case ormoluState of
37 OrmoluEnabled -> input'
46 OrmoluEnabled -> input'
38 OrmoluDisabled -> input' ++ endDisabling,
47 OrmoluDisabled -> input' ++ endDisabling,
48+ unlines suffixLines,
39 csSoFar []
49 csSoFar []
40 )
50 )
41 (x : xs) ->
51 (x : xs) ->
@@ -132,7 +142,8 @@ magicComment ::
132 -- | Whether or not the two strings watch
142 -- | Whether or not the two strings watch
133 Bool
143 Bool
134magicComment expected s0 = isJust $ do
144magicComment expected s0 = isJust $ do
135− s1 <- dropWhile isSpace <$> L.stripPrefix "{-" s0
145+ let trim = dropWhile isSpace
146+ s1 <- trim <$> L.stripPrefix "{-" (trim s0)
136− s2 <- dropWhile isSpace <$> L.stripPrefix expected s1
147+ s2 <- trim <$> L.stripPrefix expected s1
137 s3 <- L.stripPrefix "-}" s2
148 s3 <- L.stripPrefix "-}" s2
138 guard (all isSpace s3)
149 guard (all isSpace s3)
src/Ormolu/Utils.hs+41−9
@@ -1,26 +1,29 @@
1{-# LANGUAGE LambdaCase #-}
1{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE ViewPatterns #-}
3
4
4-- | Random utilities used by the code.
5-- | Random utilities used by the code.
5module Ormolu.Utils
6module Ormolu.Utils
6 ( RelativePos (..),
7 ( RelativePos (..),
7 attachRelativePos,
8 attachRelativePos,
8 combineSrcSpans',
9 combineSrcSpans',
9− isModule,
10 notImplemented,
10 notImplemented,
11 showOutputable,
11 showOutputable,
12 splitDocString,
12 splitDocString,
13 typeArgToType,
13 typeArgToType,
14 unSrcSpan,
14 unSrcSpan,
15+ incSpanLine,
15 separatedByBlank,
16 separatedByBlank,
16 separatedByBlankNE,
17 separatedByBlankNE,
18+ onTheSameLine,
19+ removeIndentation,
17 )
20 )
18where
21where
19
22
20−import Data.Data (Data, showConstr, toConstr)
23+import Data.Char (isSpace)
21import Data.List (dropWhileEnd)
24import Data.List (dropWhileEnd)
22−import qualified Data.List.NonEmpty as NE
23import Data.List.NonEmpty (NonEmpty (..))
25import Data.List.NonEmpty (NonEmpty (..))
26+import qualified Data.List.NonEmpty as NE
24import Data.Maybe (fromMaybe)
27import Data.Maybe (fromMaybe)
25import Data.Text (Text)
28import Data.Text (Text)
26import qualified Data.Text as T
29import qualified Data.Text as T
@@ -51,10 +54,6 @@ attachRelativePos = \case
51combineSrcSpans' :: NonEmpty SrcSpan -> SrcSpan
54combineSrcSpans' :: NonEmpty SrcSpan -> SrcSpan
52combineSrcSpans' (x :| xs) = foldr combineSrcSpans x xs
55combineSrcSpans' (x :| xs) = foldr combineSrcSpans x xs
53
56
54−-- | Return 'True' if given element of AST is module.
55−isModule :: Data a => a -> Bool
56−isModule x = showConstr (toConstr x) == "HsModule"
57−
58-- | Placeholder for things that are not yet implemented.
57-- | Placeholder for things that are not yet implemented.
59notImplemented :: String -> a
58notImplemented :: String -> a
60notImplemented msg = error $ "not implemented yet: " ++ msg
59notImplemented msg = error $ "not implemented yet: " ++ msg
@@ -100,15 +99,32 @@ splitDocString docStr =
100 then dropSpace <$> xs
99 then dropSpace <$> xs
101 else xs
100 else xs
102
101
102+-- | Get 'LHsType' out of 'LHsTypeArg'.
103typeArgToType :: LHsTypeArg p -> LHsType p
103typeArgToType :: LHsTypeArg p -> LHsType p
104typeArgToType = \case
104typeArgToType = \case
105 HsValArg tm -> tm
105 HsValArg tm -> tm
106 HsTypeArg _ ty -> ty
106 HsTypeArg _ ty -> ty
107 HsArgPar _ -> notImplemented "HsArgPar"
107 HsArgPar _ -> notImplemented "HsArgPar"
108
108
109+-- | Get 'RealSrcSpan' out of 'SrcSpan' if the span is “helpful”.
109unSrcSpan :: SrcSpan -> Maybe RealSrcSpan
110unSrcSpan :: SrcSpan -> Maybe RealSrcSpan
111+unSrcSpan = \case
110−unSrcSpan (RealSrcSpan r) = Just r
112+ RealSrcSpan r -> Just r
111−unSrcSpan (UnhelpfulSpan _) = Nothing
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
112
128
113-- | Do two declarations have a blank between them?
129-- | Do two declarations have a blank between them?
114separatedByBlank :: (a -> SrcSpan) -> a -> a -> Bool
130separatedByBlank :: (a -> SrcSpan) -> a -> a -> Bool
@@ -121,3 +137,19 @@ separatedByBlank loc a b =
121-- | Do two declaration groups have a blank between them?
137-- | Do two declaration groups have a blank between them?
122separatedByBlankNE :: (a -> SrcSpan) -> NonEmpty a -> NonEmpty a -> Bool
138separatedByBlankNE :: (a -> SrcSpan) -> NonEmpty a -> NonEmpty a -> Bool
123separatedByBlankNE loc a b = separatedByBlank loc (NE.last a) (NE.head b)
139separatedByBlankNE 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/PrinterSpec.hs+4−7
@@ -1,9 +1,6 @@
1{-# LANGUAGE TemplateHaskell #-}
1{-# LANGUAGE TemplateHaskell #-}
2
2
3−module Ormolu.PrinterSpec
3+module Ormolu.PrinterSpec (spec) where
4− ( spec,
5− )
6−where
7
4
8import Control.Exception
5import Control.Exception
9import Control.Monad
6import Control.Monad
@@ -65,7 +62,7 @@ deriveOutput path =
65-- | A version of 'shouldBe' that is specialized to comparing 'Text' values.
62-- | A version of 'shouldBe' that is specialized to comparing 'Text' values.
66-- It also prints multi-line snippets in a more readable form.
63-- It also prints multi-line snippets in a more readable form.
67shouldMatch :: Bool -> Text -> Text -> Expectation
64shouldMatch :: Bool -> Text -> Text -> Expectation
68−shouldMatch idempotencyTest actual expected =
65+shouldMatch idempotenceTest actual expected =
69 when (actual /= expected) . expectationFailure $
66 when (actual /= expected) . expectationFailure $
70 unlines
67 unlines
71 [ ">>>>>>>>>>>>>>>>>>>>>> expected (" ++ pass ++ "):",
68 [ ">>>>>>>>>>>>>>>>>>>>>> expected (" ++ pass ++ "):",
@@ -75,8 +72,8 @@ shouldMatch idempotencyTest actual expected =
75 ]
72 ]
76 where
73 where
77 pass =
74 pass =
78− if idempotencyTest
75+ if idempotenceTest
79− then "idempotency pass"
76+ then "idempotence pass"
80 else "first pass"
77 else "first pass"
81
78
82examplesDir :: Path Rel Dir
79examplesDir :: Path Rel Dir