on a3559a2 help sign in
671 files changed+4995−10190
since splitsnapshots
unifiedsplit
.buildkite/pipeline.yml−18 .circleci/config.yml+44 .github/workflows/binaries.yml−39 .github/workflows/build.sh−7 .gitignore−1 CHANGELOG.md−231 CONTRIBUTING.md+25−11 DESIGN.md+50−26 README.md+19−108 app/Main.hs+101−156 data/examples/declaration/annotation/annotation-out.hs+3−4 data/examples/declaration/class/associated-data2-out.hs → data/examples/declaration/class/associated-data-out.hs+13−1 data/examples/declaration/class/associated-data2.hs → data/examples/declaration/class/associated-data.hs+11−2 data/examples/declaration/class/associated-data1-out.hs−13 data/examples/declaration/class/associated-data1.hs−12 data/examples/declaration/class/associated-type-defaults-out.hs+2 data/examples/declaration/class/associated-types2-out.hs → data/examples/declaration/class/associated-types-out.hs+13−1 data/examples/declaration/class/associated-types2.hs → data/examples/declaration/class/associated-types.hs+11−2 data/examples/declaration/class/associated-types1-out.hs−13 data/examples/declaration/class/associated-types1.hs−12 data/examples/declaration/class/default-implementations-comments-out.hs−26 data/examples/declaration/class/default-implementations-comments.hs−22 data/examples/declaration/class/default-implementations-out.hs+31−5 data/examples/declaration/class/default-implementations.hs+21−2 data/examples/declaration/class/default-signatures-out.hs+21−12 data/examples/declaration/class/default-signatures-simple-out.hs−8 data/examples/declaration/class/default-signatures-simple.hs−8 data/examples/declaration/class/default-signatures.hs+7−2 data/examples/declaration/class/dependency-super-classes-out.hs+11−11 data/examples/declaration/class/dependency-super-classes.hs−2 data/examples/declaration/class/empty-classes-out.hs−2 data/examples/declaration/class/empty-classes.hs−2 data/examples/declaration/class/functional-dependencies-out.hs+2−4 data/examples/declaration/class/functional-dependencies.hs−2 data/examples/declaration/class/multi-parameters-out.hs+34 data/examples/declaration/class/multi-parameters2.hs → data/examples/declaration/class/multi-parameters.hs+16−2 data/examples/declaration/class/multi-parameters1-out.hs−15 data/examples/declaration/class/multi-parameters1.hs−18 data/examples/declaration/class/multi-parameters2-out.hs−19 data/examples/declaration/class/newlines-after-where-out.hs−5 data/examples/declaration/class/newlines-after-where.hs−7 data/examples/declaration/class/newlines-and-default-decls-out.hs−11 data/examples/declaration/class/newlines-and-default-decls.hs−13 data/examples/declaration/class/newlines-and-haddocks-out.hs−23 data/examples/declaration/class/newlines-and-haddocks.hs−19 data/examples/declaration/class/newlines-between-methods-out.hs−17 data/examples/declaration/class/newlines-between-methods.hs−15 data/examples/declaration/class/poly-kinded-classes-out.hs+3−3 data/examples/declaration/class/single-parameters-out.hs+12−13 data/examples/declaration/class/single-parameters.hs−2 data/examples/declaration/class/super-classes-out.hs+4−4 data/examples/declaration/class/type-operators-out.hs+43 data/examples/declaration/class/type-operators.hs+39 data/examples/declaration/class/type-operators1-out.hs−21 data/examples/declaration/class/type-operators1.hs−19 data/examples/declaration/class/type-operators2-out.hs−16 data/examples/declaration/class/type-operators2.hs−16 data/examples/declaration/class/type-operators3-out.hs−10 data/examples/declaration/class/type-operators3.hs−7 data/examples/declaration/data/deriving-strategies-out.hs+1−3 data/examples/declaration/data/deriving-strategies.hs−2 data/examples/declaration/data/existential-multiline-out.hs−12 data/examples/declaration/data/existential-multiline.hs−7 data/examples/declaration/data/existential-out.hs−2 data/examples/declaration/data/existential.hs−2 data/examples/declaration/data/fat-multiline-out.hs+4−6 data/examples/declaration/data/fat-multiline.hs−2 data/examples/declaration/data/field-layout/gadt-out.hs−11 data/examples/declaration/data/field-layout/gadt.hs−10 data/examples/declaration/data/field-layout/record-out.hs−12 data/examples/declaration/data/field-layout/record.hs−11 data/examples/declaration/data/field-layout/variants-out.hs−10 data/examples/declaration/data/field-layout/variants.hs−10 data/examples/declaration/data/gadt-syntax-out.hs+1−2 data/examples/declaration/data/gadt-syntax.hs+1−1 data/examples/declaration/data/gadt/multiline-out.hs+13−17 data/examples/declaration/data/gadt/multiline-where-out.hs−7 data/examples/declaration/data/gadt/multiline-where.hs−6 data/examples/declaration/data/gadt/multiline.hs−2 data/examples/declaration/data/gadt/multiple-declaration-out.hs+6−6 data/examples/declaration/data/gadt/record-out.hs+9−11 data/examples/declaration/data/gadt/record.hs−2 data/examples/declaration/data/gadt/simple-out.hs+2−12 data/examples/declaration/data/gadt/simple.hs−2 data/examples/declaration/data/gadt/strictness-out.hs+1−2 data/examples/declaration/data/gadt/strictness.hs+1−2 data/examples/declaration/data/kind-annotations-out.hs−10 data/examples/declaration/data/kind-annotations.hs−9 data/examples/declaration/data/multiline-arg-parens-out.hs+1−3 data/examples/declaration/data/multiline-arg-parens.hs−2 data/examples/declaration/data/multiline-names-out.hs+2−2 data/examples/declaration/data/multiline-out.hs+3−8 data/examples/declaration/data/multiline.hs−2 data/examples/declaration/data/newtype-out.hs−2 data/examples/declaration/data/newtype.hs−2 data/examples/declaration/data/operators-out.hs−12 data/examples/declaration/data/operators.hs−12 data/examples/declaration/data/partly-documented-out.hs−5 data/examples/declaration/data/partly-documented.hs−2 data/examples/declaration/data/record-multi-const-out.hs−17 data/examples/declaration/data/record-multi-const.hs−13 data/examples/declaration/data/record-out.hs+16−21 data/examples/declaration/data/record-singleline-out.hs−2 data/examples/declaration/data/record-singleline.hs−2 data/examples/declaration/data/record.hs−2 data/examples/declaration/data/simple-broken-out.hs+2−3 data/examples/declaration/data/simple-broken.hs−2 data/examples/declaration/data/simple-out.hs−2 data/examples/declaration/data/simple.hs−2 data/examples/declaration/data/strictness-out.hs+1−5 data/examples/declaration/data/strictness.hs+1−5 data/examples/declaration/data/unnamed-field-comment-0-out.hs−7 data/examples/declaration/data/unnamed-field-comment-0.hs−5 data/examples/declaration/data/unnamed-field-comment-1-out.hs−5 data/examples/declaration/data/unnamed-field-comment-1.hs−4 data/examples/declaration/data/with-comment-out.hs−4 data/examples/declaration/data/with-comment.hs−5 data/examples/declaration/data/with-weird-haddock-out.hs−4 data/examples/declaration/data/with-weird-haddock.hs−2 data/examples/declaration/default/default-out.hs+1−1 data/examples/declaration/deriving/multiline-out.hs+20 data/examples/declaration/deriving/multiline.hs+17 data/examples/declaration/deriving/overlapping-out.hs−19 data/examples/declaration/deriving/overlapping.hs−17 data/examples/declaration/foreign/foreign-export-out.hs+1−2 data/examples/declaration/foreign/foreign-import-out.hs+10−10 data/examples/declaration/instance/associated-data-out.hs+3 data/examples/declaration/instance/associated-data.hs−1 data/examples/declaration/instance/associated-types-out.hs+1 data/examples/declaration/instance/associated-types.hs−2 data/examples/declaration/instance/contexts-comments-out.hs−17 data/examples/declaration/instance/contexts-comments.hs−18 data/examples/declaration/instance/contexts-out.hs+28−7 data/examples/declaration/instance/contexts.hs+19 data/examples/declaration/instance/data-family-instances-gadt-out.hs−13 data/examples/declaration/instance/data-family-instances-gadt.hs−10 data/examples/declaration/instance/data-family-instances-newtype-out.hs−6 data/examples/declaration/instance/data-family-instances-newtype.hs−6 data/examples/declaration/instance/data-family-instances-out.hs+16−2 data/examples/declaration/instance/data-family-instances.hs+12 data/examples/declaration/instance/instance-sigs-multiple-out.hs−10 data/examples/declaration/instance/instance-sigs-multiple.hs−10 data/examples/declaration/instance/instance-sigs-out.hs+17−4 data/examples/declaration/instance/instance-sigs.hs+9 data/examples/declaration/instance/multi-parameter-out.hs+2 data/examples/declaration/instance/newlines-after-where-out.hs−5 data/examples/declaration/instance/newlines-after-where.hs−7 data/examples/declaration/instance/newlines-between-methods-out.hs−18 data/examples/declaration/instance/newlines-between-methods.hs−16 data/examples/declaration/instance/overlappable-instances-out.hs+3 data/examples/declaration/instance/single-parameter-out.hs+2 data/examples/declaration/instance/type-family-instances-out.hs+2−2 data/examples/declaration/rewrite-rule/basic2-out.hs → data/examples/declaration/rewrite-rule/basic-out.hs+19 data/examples/declaration/rewrite-rule/basic2.hs → data/examples/declaration/rewrite-rule/basic.hs+17 data/examples/declaration/rewrite-rule/basic1-out.hs−19 data/examples/declaration/rewrite-rule/basic1.hs−17 data/examples/declaration/rewrite-rule/forall-1-out.hs−23 data/examples/declaration/rewrite-rule/forall-1.hs−17 data/examples/declaration/rewrite-rule/forall-0-out.hs → data/examples/declaration/rewrite-rule/forall-out.hs data/examples/declaration/rewrite-rule/forall-0.hs → data/examples/declaration/rewrite-rule/forall.hs data/examples/declaration/rewrite-rule/phase-out.hs+2−4 data/examples/declaration/rewrite-rule/prelude-out.hs+74 data/examples/declaration/rewrite-rule/prelude.hs+73 data/examples/declaration/rewrite-rule/prelude1-out.hs−18 data/examples/declaration/rewrite-rule/prelude1.hs−17 data/examples/declaration/rewrite-rule/prelude2-out.hs−31 data/examples/declaration/rewrite-rule/prelude2.hs−29 data/examples/declaration/rewrite-rule/prelude3-out.hs−10 data/examples/declaration/rewrite-rule/prelude3.hs−10 data/examples/declaration/rewrite-rule/prelude4-out.hs−7 data/examples/declaration/rewrite-rule/prelude4.hs−9 data/examples/declaration/rewrite-rule/type-signature-out.hs+5−6 data/examples/declaration/role-annotation/multi-line-out.hs−15 data/examples/declaration/role-annotation/multi-line.hs−15 data/examples/declaration/role-annotation/single-line-out.hs → data/examples/declaration/role-annotation/simple-out.hs+16 data/examples/declaration/role-annotation/single-line.hs → data/examples/declaration/role-annotation/simple.hs+16 data/examples/declaration/signature/complete/complete-out.hs+2−2 data/examples/declaration/signature/inline/inline-out.hs−4 data/examples/declaration/signature/inline/inline.hs−5 data/examples/declaration/signature/minimal/minimal-out.hs+3−1 data/examples/declaration/signature/pattern/multiline-out.hs+4−17 data/examples/declaration/signature/pattern/multiline.hs−10 data/examples/declaration/signature/pattern/single-line-out.hs−2 data/examples/declaration/signature/pattern/single-line.hs−2 data/examples/declaration/signature/specialize/specialize-instance-out.hs+5−1 data/examples/declaration/signature/specialize/specialize-out.hs+6−6 data/examples/declaration/signature/standalone-kind-out.hs−13 data/examples/declaration/signature/standalone-kind.hs−13 data/examples/declaration/signature/type/arguments-out.hs+13−14 data/examples/declaration/signature/type/context-multi-line-out.hs+10−10 data/examples/declaration/signature/type/context-single-line-out.hs+7−7 data/examples/declaration/signature/type/infix-promoted-type-constructor-out.hs+1 data/examples/declaration/signature/type/long-function-name-out.hs+6−6 data/examples/declaration/signature/type/long-multiline-applications-out.hs+15−16 data/examples/declaration/signature/type/long-multiline-applications.hs+1−2 data/examples/declaration/signature/type/multi-value-out.hs+2−11 data/examples/declaration/signature/type/multi-value.hs−9 data/examples/declaration/signature/type/unicode-out.hs−4 data/examples/declaration/signature/type/unicode.hs−4 data/examples/declaration/signature/type/unrelated-out.hs−4 data/examples/declaration/signature/type/unrelated.hs−4 data/examples/declaration/splice/bracket-declaration-out.hs−26 data/examples/declaration/splice/bracket-declaration.hs−22 data/examples/declaration/splice/bracket-out.hs+8−1 data/examples/declaration/splice/bracket.hs+5 data/examples/declaration/splice/grouped-splices-out.hs−3 data/examples/declaration/splice/grouped-splices.hs−3 data/examples/declaration/splice/splice-decl-out.hs+19−1 data/examples/declaration/splice/splice-decl.hs+17 data/examples/declaration/splice/typed-splice-out.hs+1−1 data/examples/declaration/splice/untyped-splice-out.hs+1−1 data/examples/declaration/type-families/closed-type-family/multi-line-out.hs+8−9 data/examples/declaration/type-families/closed-type-family/simple-out.hs−2 data/examples/declaration/type-families/closed-type-family/simple.hs−2 data/examples/declaration/type-families/closed-type-family/with-equal-sign-out.hs−2 data/examples/declaration/type-families/closed-type-family/with-equal-sign.hs−2 data/examples/declaration/type-families/closed-type-family/with-forall-out.hs−3 data/examples/declaration/type-families/closed-type-family/with-forall.hs−3 data/examples/declaration/type-families/data-family/no-annotation-out.hs−2 data/examples/declaration/type-families/data-family/no-annotation.hs−2 data/examples/declaration/type-families/data-family/simple-out.hs−2 data/examples/declaration/type-families/data-family/simple.hs−2 data/examples/declaration/type-families/type-family/no-annotation-out.hs−2 data/examples/declaration/type-families/type-family/no-annotation.hs−2 data/examples/declaration/type-families/type-family/operator-out.hs−3 data/examples/declaration/type-families/type-family/operator.hs−2 data/examples/declaration/type-families/type-family/simple-out.hs−2 data/examples/declaration/type-families/type-family/simple.hs−2 data/examples/declaration/type-synonyms/multi-line-out.hs+8−13 data/examples/declaration/type-synonyms/multi-line.hs−5 data/examples/declaration/type-synonyms/simple-out.hs−2 data/examples/declaration/type-synonyms/simple.hs−2 data/examples/declaration/type-synonyms/with-weird-haddock-out.hs−3 data/examples/declaration/type-synonyms/with-weird-haddock.hs−1 data/examples/declaration/type/forall-out.hs−4 data/examples/declaration/type/forall.hs−4 data/examples/declaration/type/lits-out.hs−6 data/examples/declaration/type/lits.hs−4 data/examples/declaration/type/misc-kind-signatures-out.hs+1 data/examples/declaration/type/type-applications-out.hs−3 data/examples/declaration/type/type-applications.hs−3 data/examples/declaration/type/visible-forall-out.hs−2 data/examples/declaration/type/visible-forall.hs−2 data/examples/declaration/value/function/application-0-out.hs−17 data/examples/declaration/value/function/application-0.hs−12 data/examples/declaration/value/function/application-1-out.hs−19 data/examples/declaration/value/function/application-1.hs−14 data/examples/declaration/value/function/arg-breakpoints-out.hs−3 data/examples/declaration/value/function/arg-breakpoints.hs−3 data/examples/declaration/value/function/arithmetic-sequences-out.hs+2−2 data/examples/declaration/value/function/arrow/expression-applications-out.hs+9 data/examples/declaration/value/function/arrow/expression-applications.hs+9 data/examples/declaration/value/function/arrow/expression-forms-out.hs+13 data/examples/declaration/value/function/arrow/expression-forms.hs+11 data/examples/declaration/value/function/arrow/multiline-case-out.hs−8 data/examples/declaration/value/function/arrow/multiline-case.hs−7 data/examples/declaration/value/function/arrow/proc-applications-out.hs+4−5 data/examples/declaration/value/function/arrow/proc-do-complex-out.hs+26−27 data/examples/declaration/value/function/arrow/proc-do-simple-out.hs+36 data/examples/declaration/value/function/arrow/proc-do-simple2.hs → data/examples/declaration/value/function/arrow/proc-do-simple.hs+19 data/examples/declaration/value/function/arrow/proc-do-simple1-out.hs−18 data/examples/declaration/value/function/arrow/proc-do-simple1.hs−20 data/examples/declaration/value/function/arrow/proc-do-simple2-out.hs−22 data/examples/declaration/value/function/arrow/proc-forms-out.hs+35 data/examples/declaration/value/function/arrow/proc-forms.hs+36 data/examples/declaration/value/function/arrow/proc-forms1-out.hs−21 data/examples/declaration/value/function/arrow/proc-forms1.hs−19 data/examples/declaration/value/function/arrow/proc-forms2-out.hs−22 data/examples/declaration/value/function/arrow/proc-forms2.hs−19 data/examples/declaration/value/function/arrow/proc-ifs-out.hs+7−9 data/examples/declaration/value/function/arrow/proc-lets-out.hs+1−1 data/examples/declaration/value/function/arrow/proc-parentheses-out.hs+5−6 data/examples/declaration/value/function/arrow/recursive-procs-out.hs+9−13 data/examples/declaration/value/function/awkward-comment-0-out.hs−6 data/examples/declaration/value/function/awkward-comment-0.hs−5 data/examples/declaration/value/function/awkward-comment-1-out.hs−9 data/examples/declaration/value/function/awkward-comment-1.hs−7 data/examples/declaration/value/function/blank-lines-let-out.hs−6 data/examples/declaration/value/function/blank-lines-let.hs−9 data/examples/declaration/value/function/blank-lines-where-out.hs−6 data/examples/declaration/value/function/blank-lines-where.hs−7 data/examples/declaration/value/function/block-arguments-out.hs+12−16 data/examples/declaration/value/function/block-arguments.hs−7 data/examples/declaration/value/function/case-multi-line-guards-out.hs−16 data/examples/declaration/value/function/case-multi-line-guards.hs−15 data/examples/declaration/value/function/case-multi-line-out.hs+12−2 data/examples/declaration/value/function/case-multi-line.hs+9 data/examples/declaration/value/function/case-single-line-out.hs+1 data/examples/declaration/value/function/complex-list-out.hs+2−2 data/examples/declaration/value/function/comprehension/transform-multi-line1-out.hs−12 data/examples/declaration/value/function/comprehension/transform-multi-line1.hs−10 data/examples/declaration/value/function/comprehension/transform-multi-line2-out.hs−16 data/examples/declaration/value/function/comprehension/transform-multi-line2.hs−15 data/examples/declaration/value/function/comprehension/transform-multi-line3-out.hs−12 data/examples/declaration/value/function/comprehension/transform-multi-line3.hs−12 data/examples/declaration/value/function/comprehension/transform-multi-line4-out.hs−17 data/examples/declaration/value/function/comprehension/transform-multi-line4.hs−15 data/examples/declaration/value/function/comprehension/transform-single-line-out.hs−9 data/examples/declaration/value/function/comprehension/transform-single-line.hs−9 data/examples/declaration/value/function/do-out.hs+111 data/examples/declaration/value/function/do.hs+111 data/examples/declaration/value/function/do/applications-and-parens-out.hs−9 data/examples/declaration/value/function/do/applications-and-parens.hs−6 data/examples/declaration/value/function/do/blocks-out.hs−19 data/examples/declaration/value/function/do/blocks.hs−17 data/examples/declaration/value/function/do/comment-alignment-out.hs−9 data/examples/declaration/value/function/do/comment-alignment.hs−9 data/examples/declaration/value/function/do/comment-spacing-out.hs−7 data/examples/declaration/value/function/do/comment-spacing.hs−7 data/examples/declaration/value/function/do/expr-out.hs−10 data/examples/declaration/value/function/do/expr.hs−10 data/examples/declaration/value/function/do/hang-rhs-arrow-out.hs−9 data/examples/declaration/value/function/do/hang-rhs-arrow.hs−9 data/examples/declaration/value/function/do/let-out.hs−18 data/examples/declaration/value/function/do/let.hs−18 data/examples/declaration/value/function/do/operator-and-parens-out.hs−7 data/examples/declaration/value/function/do/operator-and-parens.hs−7 data/examples/declaration/value/function/do/recursive-do-mdo-out.hs−12 data/examples/declaration/value/function/do/recursive-do-mdo.hs−8 data/examples/declaration/value/function/do/recursive-do-rec-out.hs−19 data/examples/declaration/value/function/do/recursive-do-rec.hs−20 data/examples/declaration/value/function/explicit-type-out.hs+2−2 data/examples/declaration/value/function/fancy-forall-0-out.hs−10 data/examples/declaration/value/function/fancy-forall-0.hs−6 data/examples/declaration/value/function/fancy-forall-1-out.hs−10 data/examples/declaration/value/function/fancy-forall-1.hs−6 data/examples/declaration/value/function/guards-out.hs+15 data/examples/declaration/value/function/guards.hs+13 data/examples/declaration/value/function/if-multi-line-out.hs+7−14 data/examples/declaration/value/function/if-multi-line.hs−10 data/examples/declaration/value/function/if-with-comment-out.hs−8 data/examples/declaration/value/function/if-with-comment.hs−8 data/examples/declaration/value/function/implicit-params-out.hs+7−8 data/examples/declaration/value/function/implicit-params.hs−2 data/examples/declaration/value/function/infix/simple-out.hs → data/examples/declaration/value/function/infix-out.hs data/examples/declaration/value/function/infix/simple.hs → data/examples/declaration/value/function/infix.hs data/examples/declaration/value/function/infix/applicative-out.hs−4 data/examples/declaration/value/function/infix/applicative.hs−4 data/examples/declaration/value/function/infix/comments-out.hs−8 data/examples/declaration/value/function/infix/comments.hs−8 data/examples/declaration/value/function/infix/do-out.hs−13 data/examples/declaration/value/function/infix/do.hs−13 data/examples/declaration/value/function/infix/dollar-chains-out.hs−22 data/examples/declaration/value/function/infix/dollar-chains.hs−22 data/examples/declaration/value/function/infix/hanging-out.hs−23 data/examples/declaration/value/function/infix/hanging.hs−19 data/examples/declaration/value/function/infix/lenses-out.hs−21 data/examples/declaration/value/function/infix/lenses.hs−16 data/examples/declaration/value/function/infix/unicode-out.hs−3 data/examples/declaration/value/function/infix/unicode.hs−3 data/examples/declaration/value/function/lambda-case-out.hs−2 data/examples/declaration/value/function/lambda-case.hs−2 data/examples/declaration/value/function/lambda-multi-line-out.hs+27 data/examples/declaration/value/function/lambda-multi-line2.hs → data/examples/declaration/value/function/lambda-multi-line.hs+16 data/examples/declaration/value/function/lambda-multi-line1-out.hs−15 data/examples/declaration/value/function/lambda-multi-line1.hs−14 data/examples/declaration/value/function/lambda-multi-line2-out.hs−12 data/examples/declaration/value/function/lambda-single-line-out.hs−2 data/examples/declaration/value/function/lambda-single-line.hs−2 data/examples/declaration/value/function/let-multi-line-out.hs−5 data/examples/declaration/value/function/let-multi-line.hs−4 data/examples/declaration/value/function/let-nested-out.hs−3 data/examples/declaration/value/function/let-nested.hs−3 data/examples/declaration/value/function/let-single-line-out.hs+2−1 data/examples/declaration/value/function/list-comprehensions-out.hs+4−3 data/examples/declaration/value/function/list-notation-0-out.hs−5 data/examples/declaration/value/function/list-notation-0.hs−5 data/examples/declaration/value/function/list-notation-1-out.hs−8 data/examples/declaration/value/function/list-notation-1.hs−7 data/examples/declaration/value/function/list-notation-2-out.hs−6 data/examples/declaration/value/function/list-notation-2.hs−5 data/examples/declaration/value/function/list-notation-3-out.hs−12 data/examples/declaration/value/function/list-notation-3.hs−10 data/examples/declaration/value/function/multi-way-if-out.hs+4−10 data/examples/declaration/value/function/multi-way-if.hs−5 data/examples/declaration/value/function/multiple-guards-out.hs−14 data/examples/declaration/value/function/multiple-guards.hs−13 data/examples/declaration/value/function/operator-comments-0-out.hs−16 data/examples/declaration/value/function/operator-comments-0.hs−17 data/examples/declaration/value/function/operator-comments-1-out.hs−16 data/examples/declaration/value/function/operator-comments-1.hs−17 data/examples/declaration/value/function/operator-comments-2-out.hs−5 data/examples/declaration/value/function/operator-comments-2.hs−4 data/examples/declaration/value/function/operator-sections-out.hs+2−2 data/examples/declaration/value/function/operators-0-out.hs−5 data/examples/declaration/value/function/operators-0.hs−4 data/examples/declaration/value/function/operators-1-out.hs−4 data/examples/declaration/value/function/operators-1.hs−3 data/examples/declaration/value/function/operators-2-out.hs−4 data/examples/declaration/value/function/operators-2.hs−4 data/examples/declaration/value/function/operators-3-out.hs−3 data/examples/declaration/value/function/operators-3.hs−3 data/examples/declaration/value/function/operators-4-out.hs−3 data/examples/declaration/value/function/operators-4.hs−3 data/examples/declaration/value/function/operators-5-out.hs−5 data/examples/declaration/value/function/operators-5.hs−4 data/examples/declaration/value/function/operators-6-out.hs−9 data/examples/declaration/value/function/operators-6.hs−7 data/examples/declaration/value/function/operators-out.hs+45 data/examples/declaration/value/function/operators.hs+40 data/examples/declaration/value/function/overindentation-out.hs−11 data/examples/declaration/value/function/overindentation.hs−9 data/examples/declaration/value/function/parallel-comprehensions-complex-out.hs → data/examples/declaration/value/function/parallel-comprehensions-out.hs+6−2 data/examples/declaration/value/function/parallel-comprehensions-single-line-out.hs−3 data/examples/declaration/value/function/parallel-comprehensions-single-line.hs−4 data/examples/declaration/value/function/parallel-comprehensions-complex.hs → data/examples/declaration/value/function/parallel-comprehensions.hs+4 data/examples/declaration/value/function/parens-out.hs−1 data/examples/declaration/value/function/parens.hs−1 data/examples/declaration/value/function/pattern/as-pattern-out.hs−3 data/examples/declaration/value/function/pattern/as-pattern.hs−3 data/examples/declaration/value/function/pattern/famous-cardano-pattern-out.hs+8−8 data/examples/declaration/value/function/pattern/multiline-case-pattern-out.hs+2−2 data/examples/declaration/value/function/pattern/n-plus-k-pattern-out.hs−3 data/examples/declaration/value/function/pattern/n-plus-k-pattern.hs−3 data/examples/declaration/value/function/pattern/record-patterns-out.hs+1−1 data/examples/declaration/value/function/pattern/sig-pattern-out.hs+2−2 data/examples/declaration/value/function/pattern/splice-pattern-out.hs+2−2 data/examples/declaration/value/function/pattern/strictness-out.hs−2 data/examples/declaration/value/function/pattern/strictness.hs−2 data/examples/declaration/value/function/pattern/unboxed-sum-pattern-out.hs+3−5 data/examples/declaration/value/function/record-constructors-out.hs+26 data/examples/declaration/value/function/record/constructors.hs → data/examples/declaration/value/function/record-constructors.hs+1−1 data/examples/declaration/value/function/record/updaters-out.hs → data/examples/declaration/value/function/record-updaters-out.hs+1−3 data/examples/declaration/value/function/record/updaters.hs → data/examples/declaration/value/function/record-updaters.hs−1 data/examples/declaration/value/function/record/wildcards-out.hs → data/examples/declaration/value/function/record-wildcards-out.hs+5−6 data/examples/declaration/value/function/record/wildcards.hs → data/examples/declaration/value/function/record-wildcards.hs data/examples/declaration/value/function/record/constructors-out.hs−31 data/examples/declaration/value/function/record/dot-out.hs−15 data/examples/declaration/value/function/record/dot.hs−14 data/examples/declaration/value/function/record/hanging-after-equal-con-out.hs−8 data/examples/declaration/value/function/record/hanging-after-equal-con.hs−7 data/examples/declaration/value/function/record/hanging-after-equal-update-out.hs−8 data/examples/declaration/value/function/record/hanging-after-equal-update.hs−7 data/examples/declaration/value/function/record/inter-comments-out.hs−13 data/examples/declaration/value/function/record/inter-comments.hs−11 data/examples/declaration/value/function/static-pointers-out.hs+3−4 data/examples/declaration/value/function/strings-out.hs−10 data/examples/declaration/value/function/strings.hs−7 data/examples/declaration/value/function/transform-comprehensions-out.hs+58 data/examples/declaration/value/function/transform-comprehensions.hs+55 data/examples/declaration/value/function/tricky-parens-out.hs+1−1 data/examples/declaration/value/function/tuples-out.hs+2−2 data/examples/declaration/value/function/type-applications-and-splice-out.hs−4 data/examples/declaration/value/function/type-applications-and-splice.hs−4 data/examples/declaration/value/function/type-applications-out.hs−6 data/examples/declaration/value/function/type-applications.hs−5 data/examples/declaration/value/function/typed-expressions-out.hs+2−2 data/examples/declaration/value/function/unboxed-sums-out.hs+2−3 data/examples/declaration/value/function/unboxed-tuples-out.hs+4−5 data/examples/declaration/value/function/where-nested-out.hs−12 data/examples/declaration/value/function/where-nested.hs−12 data/examples/declaration/value/other/comments-get-before-op-out.hs+1−1 data/examples/declaration/value/other/line-multi-line-out.hs+1−1 data/examples/declaration/value/pattern-synonyms/bidirectional-out.hs+1−4 data/examples/declaration/value/pattern-synonyms/bidirectional.hs−4 data/examples/declaration/value/pattern-synonyms/explicitely-bidirectional-out.hs−5 data/examples/declaration/value/pattern-synonyms/explicitely-bidirectional.hs−6 data/examples/declaration/value/pattern-synonyms/unidirectional-out.hs+1−1 data/examples/declaration/warning/warning-multiline-out.hs+2−1 data/examples/declaration/warning/warning-single-line-out.hs+1 data/examples/import/comments-inside-imports-out.hs−7 data/examples/import/comments-inside-imports.hs−9 data/examples/import/deduplication-bug-out.hs−6 data/examples/import/deduplication-bug.hs−6 data/examples/import/explicit-imports-out.hs+6−6 data/examples/import/explicit-imports-with-comments-out.hs+3−4 data/examples/import/merging-0-out.hs−3 data/examples/import/merging-0.hs−4 data/examples/import/merging-1-out.hs−2 data/examples/import/merging-1.hs−3 data/examples/import/merging-2-out.hs−2 data/examples/import/merging-2.hs−4 data/examples/import/misc-out.hs+7−1 data/examples/import/nested-explicit-imports-out.hs+8−8 data/examples/import/qualified-post-out.hs−5 data/examples/import/qualified-post.hs−5 data/examples/import/qualified-prelude-out.hs+1−1 data/examples/import/simple-out.hs+3−2 data/examples/import/simple.hs−2 data/examples/import/sorted-export-list-out.hs−1 data/examples/import/sorted-export-list.hs−1 data/examples/module-header/double-dot-with-names-out.hs+6−1 data/examples/module-header/leading-empty-line-out.hs−11 data/examples/module-header/leading-empty-line.hs−11 data/examples/module-header/multiline-out.hs+2−2 data/examples/module-header/multiline-with-comments-out.hs+2−3 data/examples/module-header/multiline2-out.hs+2−2 data/examples/module-header/multiline2.hs+2−2 data/examples/module-header/named-section-out.hs−13 data/examples/module-header/named-section.hs−13 data/examples/module-header/preceding-comment-with-haddock-out.hs−8 data/examples/module-header/preceding-comment-with-haddock.hs−8 data/examples/module-header/shebang-out.hs−6 data/examples/module-header/shebang-with-pragmas-out.hs−5 data/examples/module-header/shebang-with-pragmas.hs−5 data/examples/module-header/shebang.hs−6 data/examples/module-header/singleline-empty-out.hs+4−1 data/examples/module-header/stack-header-0-out.hs−7 data/examples/module-header/stack-header-0.hs−4 data/examples/module-header/stack-header-1-out.hs−8 data/examples/module-header/stack-header-1.hs−5 data/examples/module-header/stack-header-2-out.hs−12 data/examples/module-header/stack-header-2.hs−12 data/examples/module-header/warning-pragma-list-multiline-out.hs+3−3 data/examples/module-header/warning-pragma-multiline-out.hs+4−1 data/examples/module-header/warning-pragma-out.hs+1−3 data/examples/other/argument-comment-out.hs+12−14 data/examples/other/comment-after-preceding-haddock-out.hs−12 data/examples/other/comment-after-preceding-haddock.hs−12 data/examples/other/comment-alignment-out.hs+4−4 data/examples/other/comment-before-hanging-out.hs−5 data/examples/other/comment-before-hanging.hs−5 data/examples/other/comment-following-preceding-gap-out.hs−6 data/examples/other/comment-following-preceding-gap.hs−6 data/examples/other/comment-glued-together-out.hs−7 data/examples/other/comment-glued-together.hs−6 data/examples/other/comment-inside-construct-out.hs+2−2 data/examples/other/comment-multiline-after-out.hs−7 data/examples/other/comment-multiline-after.hs−1 data/examples/other/comment-style-transform-out.hs−17 data/examples/other/comment-style-transform.hs−22 data/examples/other/comment-trailing-space-out.hs−9 data/examples/other/comment-trailing-space.hs−9 data/examples/other/comment-two-blocks-out.hs−8 data/examples/other/comment-two-blocks.hs−9 data/examples/other/consequetive-pipe-comments-out.hs−7 data/examples/other/consequetive-pipe-comments.hs−8 data/examples/other/cpp/continuation-out.hs−8 data/examples/other/cpp/continuation.hs−8 data/examples/other/cpp/lonely-hash-out.hs−14 data/examples/other/cpp/lonely-hash.hs−14 data/examples/other/cpp/separation-0a-out.hs−7 data/examples/other/cpp/separation-0a.hs−6 data/examples/other/cpp/separation-0b-out.hs−10 data/examples/other/cpp/separation-0b.hs−9 data/examples/other/cpp/separation-1a-out.hs−12 data/examples/other/cpp/separation-1a.hs−11 data/examples/other/cpp/separation-1b-out.hs−15 data/examples/other/cpp/separation-1b.hs−14 data/examples/other/cpp/separation-2a-out.hs−9 data/examples/other/cpp/separation-2a.hs−8 data/examples/other/cpp/separation-2b-out.hs−11 data/examples/other/cpp/separation-2b.hs−11 data/examples/other/cpp/shifted-out.hs−21 data/examples/other/cpp/shifted.hs−17 data/examples/other/cpp/simple-import-out.hs−14 data/examples/other/cpp/simple-import.hs−14 data/examples/other/disabling/indented-fragment-out.hs−7 data/examples/other/disabling/indented-fragment.hs−7 data/examples/other/disabling/single-definition-out.hs−10 data/examples/other/disabling/single-definition.hs−10 data/examples/other/disabling/whole-file-out.hs−10 data/examples/other/disabling/whole-file.hs−10 data/examples/other/empty-forall-out.hs−18 data/examples/other/empty-forall.hs−17 data/examples/other/empty-haddock-out.hs−5 data/examples/other/empty-haddock.hs−6 data/examples/other/following-comment-last-0-out.hs−2 data/examples/other/following-comment-last-0.hs−2 data/examples/other/following-comment-last-1-out.hs−2 data/examples/other/following-comment-last-1.hs−2 data/examples/other/following-comment-last-2-out.hs−3 data/examples/other/following-comment-last-2.hs−2 data/examples/other/following-comment-last-3-out.hs−2 data/examples/other/following-comment-last-3.hs−2 data/examples/other/haddock-sections-out.hs−7 data/examples/other/haddock-sections.hs−7 data/examples/other/inline-comment-0-out.hs−3 data/examples/other/inline-comment-0.hs−3 data/examples/other/inline-comment-1-out.hs−12 data/examples/other/inline-comment-1.hs−9 data/examples/other/merging-comments-out.hs−12 data/examples/other/merging-comments.hs−9 data/examples/other/multiline-forall-out.hs−58 data/examples/other/multiline-forall.hs−46 data/examples/other/multiple-blank-line-comment-out.hs−9 data/examples/other/multiple-blank-line-comment.hs−10 data/examples/other/overly-indented-out.hs−11 data/examples/other/overly-indented.hs−10 data/examples/other/pragma-comments-after-out.hs−4 data/examples/other/pragma-comments-after.hs−3 data/examples/other/pragma-comments-out.hs−8 data/examples/other/pragma-comments.hs−11 data/examples/other/pragma-out.hs+4−1 data/examples/other/pragma-sorting-out.hs−11 data/examples/other/pragma-sorting.hs−10 data/printer/list0-multi.hs+4 data/printer/list0-single.hs+1 data/printer/list1-multi.hs+8 data/printer/list1-single.hs+1 data/printer/mhdr-multi.hs+7 data/printer/mhdr-single.hs+3 data/printer/ssig-multi.hs+5 data/printer/ssig-single.hs+1 default.nix+10−148 expected-failures/Agda.txt−11 expected-failures/aws.txt−9 expected-failures/distributed-process.txt−7 expected-failures/esqueleto.txt−7 expected-failures/fay.txt−18 expected-failures/hlint.txt−11 expected-failures/idris.txt−7 expected-failures/intero.txt−5 expected-failures/leksah.txt−5 expected-failures/lens.txt−3 expected-failures/pandoc.txt−9 expected-failures/pipes.txt−3 expected-failures/postgrest.txt−5 expected-failures/purescript.txt−18 expected-failures/tensorflow.txt−7 format.sh−14 nix/nixpkgs/default.nix+3−7 nix/ormolize/default.nix+6−39 nix/ormolize/ormolize.sh+16 ormolu.cabal+153−174 region-tests/expected-result-17-18.hs−17 region-tests/expected-result-6-7.hs−17 region-tests/expected-result-6-8.hs−16 region-tests/expected-result-9-12.hs−17 region-tests/expected-result-all.hs−21 region-tests/src.hs−17 shell.nix+2−4 src/GHC.hs−12 src/GHC/DynFlags.hs−49 src/Ormolu.hs+61−84 src/Ormolu/Config.hs+32−70 src/Ormolu/Diff.hs+52−112 src/Ormolu/Exception.hs+45−60 src/Ormolu/Imports.hs+62−176 src/Ormolu/Parser.hs+157−183 src/Ormolu/Parser/Anns.hs+20−18 src/Ormolu/Parser/CommentStream.hs+89−184 src/Ormolu/Parser/Pragma.hs+33−34 src/Ormolu/Parser/Result.hs+20−34 src/Ormolu/Parser/Shebang.hs−27 src/Ormolu/Printer.hs+16−25 src/Ormolu/Printer/Combinators.hs+174−165 src/Ormolu/Printer/Comments.hs+145−194 src/Ormolu/Printer/Internal.hs+261−437 src/Ormolu/Printer/Meat/Common.hs+45−91 src/Ormolu/Printer/Meat/Declaration.hs+90−260 src/Ormolu/Printer/Meat/Declaration.hs-boot+1−3 src/Ormolu/Printer/Meat/Declaration/Annotation.hs+6−5 src/Ormolu/Printer/Meat/Declaration/Class.hs+51−48 src/Ormolu/Printer/Meat/Declaration/Data.hs+104−176 src/Ormolu/Printer/Meat/Declaration/Default.hs+7−6 src/Ormolu/Printer/Meat/Declaration/Foreign.hs+14−16 src/Ormolu/Printer/Meat/Declaration/Instance.hs+40−38 src/Ormolu/Printer/Meat/Declaration/RoleAnnotation.hs+11−5 src/Ormolu/Printer/Meat/Declaration/Rule.hs+29−28 src/Ormolu/Printer/Meat/Declaration/Signature.hs+113−153 src/Ormolu/Printer/Meat/Declaration/Splice.hs+4−3 src/Ormolu/Printer/Meat/Declaration/Type.hs+18−24 src/Ormolu/Printer/Meat/Declaration/TypeFamily.hs+45−58 src/Ormolu/Printer/Meat/Declaration/Value.hs+524−917 src/Ormolu/Printer/Meat/Declaration/Value.hs-boot+7−6 src/Ormolu/Printer/Meat/Declaration/Warning.hs+13−11 src/Ormolu/Printer/Meat/ImportExport.hs+54−94 src/Ormolu/Printer/Meat/Module.hs+43−49 src/Ormolu/Printer/Meat/Pragma.hs+20−74 src/Ormolu/Printer/Meat/Type.hs+130−201 src/Ormolu/Printer/Operators.hs−177 src/Ormolu/Printer/SpanStream.hs+20−18 src/Ormolu/Processing/Common.hs−27 src/Ormolu/Processing/Cpp.hs−70 src/Ormolu/Processing/Postprocess.hs−31 src/Ormolu/Processing/Preprocess.hs−149 src/Ormolu/Utils.hs+18−137 tests/Ormolu/Parser/PragmaSpec.hs+3−4 tests/Ormolu/Printer/CombinatorsSpec.hs+112 tests/Ormolu/PrinterSpec.hs+22−31
.buildkite/pipeline.ymldeleted−18
@@ -1,18 +0,0 @@
1−steps:
2− - label: Build and test with GHC 8.6.5
3− command: |
4− nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc865
5− timeout: 100
6− - label: Build and test with GHC 8.8.4
7− command: |
8− nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc884
9− timeout: 100
10− - label: Build and test with GHC 8.10.1
11− command: |
12− nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc8101
13− timeout: 100
14− - wait
15− - label: Check formatting
16− command: |
17− ./format.sh
18− git diff --exit-code --color=always
.circleci/config.ymlnew file+44
@@ -0,0 +1,44 @@
1+version: 2
2+
3+jobs:
4+ build_ghc864:
5+ docker:
6+ - image: nixos/nix:2.1.3
7+ steps:
8+ - checkout
9+ - run:
10+ name: Add ca-certificates
11+ command: |
12+ apk --no-progress update
13+ apk --no-progress add ca-certificates
14+ - run:
15+ name: Setup Cachix
16+ command: |
17+ nix-env -f nix/nixpkgs/ -iA cachix
18+ USER=dummy cachix use tweag
19+ - run:
20+ name: Build environment
21+ command: |
22+ nix-shell --pure --run :
23+ - run:
24+ name: Push Cachix
25+ command: |
26+ if [ -n "$CACHIX_SIGNING_KEY" ];
27+ then nix-store -qR --include-outputs $(nix-instantiate default.nix) | cachix push tweag;
28+ fi
29+ - run:
30+ name: Build the package (includes running the tests)
31+ command: nix-build
32+ - run:
33+ name: Generate Haddocks
34+ command: nix-build --attr ormolu.doc
35+ - store_artifacts:
36+ path: result-doc/share/doc
37+ destination: haddock
38+
39+workflows:
40+ version: 2
41+ build:
42+ jobs:
43+ - build_ghc864:
44+ context: org-global
.github/workflows/binaries.ymldeleted−39
@@ -1,39 +0,0 @@
1−name: Build binaries
2−on:
3− release:
4− types: [published]
5−jobs:
6− build:
7− strategy:
8− fail-fast: false
9− matrix:
10− os: [ubuntu-latest, macOS-latest, windows-latest]
11− runs-on: ${{ matrix.os }}
12− steps:
13− - uses: actions/checkout@v2
14− - uses: actions/setup-haskell@v1
15− if: runner.os != 'Linux'
16− with:
17− ghc-version: '8.10.1'
18− cabal-version: '3.2'
19− - name: Build Linux binary
20− if: runner.os == 'Linux'
21− run: |
22− docker run \
23− -v $(pwd):/mnt -w /mnt \
24− utdemir/ghc-musl:v14-ghc8101 \
25− bash .github/workflows/build.sh
26− - name: Build ${{ runner.os }} binary
27− if: runner.os != 'Linux'
28− shell: bash
29− run: |
30− cabal build exe:ormolu
31− cp $(find dist-newstyle \( -name ormolu -o -name ormolu.exe \) -type f) ormolu
32− - uses: actions/upload-release-asset@v1
33− env:
34− GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35− with:
36− upload_url: ${{ github.event.release.upload_url }}
37− asset_path: ormolu
38− asset_name: ormolu-${{ runner.os }}
39− asset_content_type: application/octet-stream
.github/workflows/build.shdeleted−7
@@ -1,7 +0,0 @@
1−set -e
2−
3−cabal update
4−cabal build exe:ormolu --enable-executable-static --ghc-options="-split-sections"
5−
6−cp $(find dist-newstyle -name ormolu -type f) .
7−strip -s ormolu
.gitignore−1
@@ -26,5 +26,4 @@ cabal.sandbox.config
2626dist-*/
2727dist/
2828stack.yaml
29−stack.yaml.lock
3029result*
CHANGELOG.md−231
@@ -1,234 +1,3 @@
1−## Unreleased
2−
3−* Ormolu no longer overwrites already formatted files. [PR
4− 649](https://github.com/tweag/ormolu/pull/649).
5−
6−## Ormolu 0.1.2.0
7−
8−* Fixed the bug when comments in different styles got glued together after
9− formatting. [Issue 589](https://github.com/tweag/ormolu/issues/589).
10−
11−* Added `-i` as a shortcut for `--mode inplace`. [Issue
12− 467](https://github.com/tweag/ormolu/issues/467).
13−
14−* Improved grouping of top-level declarations. [Issue
15− 466](https://github.com/tweag/ormolu/issues/466).
16−
17−## Ormolu 0.1.1.0
18−
19−* Imports in a import lists are now normalized: duplicate imports are
20− combined/eliminated intelligently.
21−
22−* Import declarations that can be merged are now automatically merged.
23− [Issue 414](https://github.com/tweag/ormolu/issues/414).
24−
25−* The magic comments for disabling and enabling Ormolu now can encompass any
26− fragment of code provided that the remaining code after exclusion of the
27− disabled part is still syntactically correct. [Issue
28− 601](https://github.com/tweag/ormolu/issues/601).
29−
30−* Improved sorting of operators in imports. [Issue
31− 602](https://github.com/tweag/ormolu/issues/602).
32−
33−* Fixed a bug related to trailing space in multiline comments in certain
34− cases. [Issue 603](https://github.com/tweag/ormolu/issues/602).
35−
36−* Added support for formatting linked lists with `(:)` as line terminator.
37− [Issue 478](https://github.com/tweag/ormolu/issues/478).
38−
39−* Fixed rendering of function arguments in multiline layout. [Issue
40− 609](https://github.com/tweag/ormolu/issues/609).
41−
42−* Blank lines between definitions in `let` and `while` bindings are now
43− preserved. [Issue 554](https://github.com/tweag/ormolu/issues/554).
44−
45−* Fixed the bug when type applications stuck to the `$` of TH splices that
46− followed them. [Issue 613](https://github.com/tweag/ormolu/issues/613).
47−
48−* Improved region formatting so that indented fragments—such as definitions
49− inside of `where` clauses—can be formatted. [Issue
50− 572](https://github.com/tweag/ormolu/issues/572).
51−
52−* Fixed the bug related to the de-association of pragma comments. [Issue
53− 619](https://github.com/tweag/ormolu/issues/619).
54−
55−## Ormolu 0.1.0.0
56−
57−* Fixed rendering of type signatures concerning several identifiers. [Issue
58− 566](https://github.com/tweag/ormolu/issues/566).
59−
60−* Fixed an idempotence issue with inline comments in tuples and parentheses.
61− [Issue 450](https://github.com/tweag/ormolu/issues/450).
62−
63−* Fixed an idempotence issue when certain comments were picked up as
64− “continuation” of a series of comments [Issue
65− 449](https://github.com/tweag/ormolu/issues/449).
66−
67−* Fixed an idempotence issue related to different indentation levels in a
68− comment series. [Issue 512](https://github.com/tweag/ormolu/issues/512).
69−
70−* Fixed an idempotence issue related to comments which may happen to be
71− separated from the elements they are attached to by the equality sign.
72− [Issue 340](https://github.com/tweag/ormolu/issues/340).
73−
74−* Fixed an idempotence issue with type synonym and data declarations where
75− the type has a Haddock. [Issue
76− 578](https://github.com/tweag/ormolu/issues/578).
77−
78−* Fix the false positive about AST differences in presence of comments with
79− multiple blank lines in a row. [Issue
80− 518](https://github.com/tweag/ormolu/issues/518).
81−
82−* Fixed rendering of comments around if expressions. [Issue
83− 458](https://github.com/tweag/ormolu/issues/458).
84−
85−* Unnamed fields of data constructors are now documented using the `-- ^`
86− syntax. [Issue 445](https://github.com/tweag/ormolu/issues/445) and [Issue
87− 428](https://github.com/tweag/ormolu/issues/428).
88−
89−* Fixed non-idempotent transformation of partly documented data definition.
90− [Issue 590](https://github.com/tweag/ormolu/issues/590).
91−
92−* Fixed an idempotence issue related to operators. [Issue
93− 522](https://github.com/tweag/ormolu/issues/522).
94−
95−* Renamed the `--check-idempotency` flag to `--check-idempotence`.
96− Apparently only the latter is correct.
97−
98−## Ormolu 0.0.5.0
99−
100−* Grouping of statements in `do`-blocks is now preserved. [Issue
101− 74](https://github.com/tweag/ormolu/issues/74).
102−
103−* Grouping of TH splices is now preserved. [Issue
104− 507](https://github.com/tweag/ormolu/issues/507).
105−
106−* Comments on pragmas are now preserved. [Issue
107− 216](https://github.com/tweag/ormolu/issues/216).
108−
109−* Ormolu can now be enabled and disabled via special comments. [Issue
110− 435](https://github.com/tweag/ormolu/issues/435).
111−
112−* Added experimental support for simple CPP. [Issue
113− 415](https://github.com/tweag/ormolu/issues/415).
114−
115−* Added two new options `--start-line` and `--end-line` that allow us to
116− select a region to format. [Issue
117− 516](https://github.com/tweag/ormolu/issues/516).
118−
119−* Fixed rendering of module headers in the presence of preceding comments or
120− Haddocks. [Issue 561](https://github.com/tweag/ormolu/issues/561).
121−
122−## Ormolu 0.0.4.0
123−
124−* When given several files to format, Ormolu does not stop on the first
125− failure, but tries to format all the files. [Issue
126− 502](https://github.com/tweag/ormolu/issues/502).
127−
128−* Made rendering of pattern matches involving operators consistent with
129− other cases of rendering of operators. [Issue
130− 500](https://github.com/tweag/ormolu/issues/500).
131−
132−* More compact rendering of type family injectivity constraints. [Issue
133− 482](https://github.com/tweag/ormolu/issues/482).
134−
135−* Improved rendering of the keyword `where` in class, data, and type family
136− declarations. When headers of these declarations are multi-line `where` is
137− now put on its own line. [Issue
138− 509](https://github.com/tweag/ormolu/issues/509).
139−
140−* Fixed the bug pertaining to rendering of arrow notation with multiline
141− expressions. [Issue 513](https://github.com/tweag/ormolu/issues/513).
142−
143−* Made rendering of data type definitions, value-level applications, and
144− application of types use the same style. Moreover, existential now doesn't
145− cause the data constructor be unconditionally rendered in multiline
146− layout. [Issue 427](https://github.com/tweag/ormolu/issues/427).
147−
148−* Records with a single data constructor are now formatted more compactly.
149− [Issue 425](https://github.com/tweag/ormolu/issues/425).
150−
151−* Switched to `ghc-lib-parser-8.10.1`.
152−
153−* Implemented support for the new language extensions `ImportQualifiedPost`
154− and `StandaloneKindSignatures`.
155−
156−## Ormolu 0.0.3.1
157−
158−* Fixed rendering of record updates with the record dot preprocessor syntax
159− [Issue 498](https://github.com/tweag/ormolu/issues/498).
160−
161−## Ormolu 0.0.3.0
162−
163−* Fixed an issue related to unnecessary use of curly braces. [Issue
164− 473](https://github.com/tweag/ormolu/issues/473).
165−
166−* Fixed the issue with formatting multi-way if when it happens to be a
167− function applied to arguments [Issue
168− 488](https://github.com/tweag/ormolu/issues/488). This changed the way
169− multi-line if is formatted in general.
170−
171−* Added support for record dot pre-processor when used via the plugin.
172− [Issue 486](https://github.com/tweag/ormolu/issues/486).
173−
174−* Stopped hanging record constructors and improved placing
175− potentially-hanging consturctions in the presence of comments. [Issue
176− 447](https://github.com/tweag/ormolu/issues/447).
177−
178−* Fixed indentation in presence of type applications. [Issue
179− 493](https://github.com/tweag/ormolu/issues/493).
180−
181−* Class and instance declarations now do not have a blank line after
182− `where`. Grouping of methods from the original input is also preserved
183− with some normalizations. [Issue
184− 431](https://github.com/tweag/ormolu/issues/431).
185−
186−## Ormolu 0.0.2.0
187−
188−* Switched to `ghc-lib-parser` instead of depending on the `ghc` package
189− directly. This should allow us to use newest features of GHC while not
190− necessarily depending on the newest version of the compiler. In addition
191− to that Ormolu is now GHCJS-compatible.
192−
193−* Now unrecognized GHC options passed with `--ghc-opt` cause Ormolu to fail
194− (exit code 7).
195−
196−* Fixed formatting of result type in closed type families. See [issue
197− 420](https://github.com/tweag/ormolu/issues/420).
198−
199−* Fixed a minor inconsistency between formatting of normal and foreign type
200− signatures. See [issue 408](https://github.com/tweag/ormolu/issues/408).
201−
202−* Fixed a bug when comment before module header with Haddock was moved
203− inside the export list. See [issue
204− 430](https://github.com/tweag/ormolu/issues/430).
205−
206−* Empty `forall`s are now correctly preserved. See [issue
207− 429](https://github.com/tweag/ormolu/issues/429).
208−
209−* Fixed [issue 446](https://github.com/tweag/ormolu/issues/446), which
210− involved braces and operators.
211−
212−* When there are comments between preceding Haddock (pipe-style) and its
213− corresponding declaration they are preserved like this in the output
214− instead of being shifted. To be clear, this is not a very good idea to
215− have comments in that position because the Haddock will end up not being
216− associated with the declarations. Issues
217− [440](https://github.com/tweag/ormolu/issues/440) and
218− [448](https://github.com/tweag/ormolu/issues/448).
219−
220−* Implemented correct handling of shebangs. [Issue
221− 377](https://github.com/tweag/ormolu/issues/377).
222−
223−* Implemented correct handling of stack headers. [Issue
224− 393](https://github.com/tweag/ormolu/issues/393).
225−
226−* Sorting language pragmas cannot not change meaning of the input program
227− anymore. [Issue 404](https://github.com/tweag/ormolu/issues/404).
228−
229−* Fixed formatting of applications where function is a complex expression.
230− [Issue 444](https://github.com/tweag/ormolu/issues/444).
231−
2321## Ormolu 0.0.1.0
2332
2343* Initial release.
CONTRIBUTING.md+25−11
@@ -1,7 +1,8 @@
11# Contributing
22
33Issues (bugs, feature requests or otherwise feedback) may be reported in
4−[the GitHub issue tracker for this project][issues]. Pull requests are also
4+[the GitHub issue tracker for this
5+project](https://github.com/tweag/ormolu/issues). Pull requests are also
56welcome.
67
78When contributing to this repository, please first discuss the change you
@@ -17,6 +18,28 @@ messages and PR descriptions.
1718
1819* [Fixing bugs][bugs]. This is the main focus right now.
1920
21+## Implementing rendering of AST
22+
23+The `Ormolu.Printer.Combinators` module provides a DSL for rendering of GHC
24+AST. You'll probably only need this one module for writing new rendering
25+functions. The module documents how to use the printing combinators it
26+provides. Consult the Haddocks to learn more about them.
27+
28+Create new modules corresponding to the things you want to render under
29+`Ormolu.Printer.Meat`. For example, there are `Ormolu.Printer.Meat.Type` and
30+`Ormolu.Printer.Meat.Declaration.Data`.
31+
32+Concrete rendering functions get their names by appending `p_` to the name
33+of the type which describes a particular part of AST. For example, the
34+function for rendering types is correspondingly:
35+
36+```haskell
37+p_hsType :: HsType GhcPs -> R ()
38+```
39+
40+In general rendering functions like this take 1 or more arguments and
41+produce `R ()` which is a rendering action.
42+
2043### Testing
2144
2245Testing has been taken good care of and now it amounts to just adding
@@ -30,15 +53,12 @@ Testing is performed as following:
3053* The result of printing is parsed back again and the AST is compared to the
3154 AST obtained from the original file. They should match.
3255* The output of printer is checked against the expected output.
33−* Idempotence property is verified: formatting already formatted code
56+* Idempotency property is verified: formatting already formatted code
3457 results in exactly the same output.
3558
3659Examples can be organized in sub-directories, see the existing ones for
3760inspiration.
3861
39−Please note that we try to keep individual files at most 25 lines long
40−because otherwise it's hard to figure out want went wrong when a test fails.
41−
4262## CI
4363
4464We use Circle CI. Some outside contributors may have problems, as in, CI
@@ -55,10 +75,4 @@ User settings -> Account integrations -> Refresh permissions
5575
5676in Circle CI app.
5777
58−## Formatting
59−
60−Use `format.sh` script to format Ormolu with current version of Ormolu. If
61−Ormolu is not formatted like this, the CI will fail.
62−
63−[issues]: https://github.com/tweag/ormolu/issues
6478[bugs]: https://github.com/tweag/ormolu/issues?q=is%3Aissue+is%3Aopen+label%3Abug
DESIGN.md+50−26
@@ -1,8 +1,5 @@
11# Ormolu
22
3−*This document represents our discussions and plans at early stages of
4−development, it is no longer being updated.*
5−
63* [Analysis of the existing solutions](#analysis-of-the-existing-solutions)
74 * [Brittany](#brittany)
85 * [Hindent](#hindent)
@@ -17,14 +14,14 @@ development, it is no longer being updated.*
1714 * [Testing](#testing)
1815 * [Functionality of executable](#functionality-of-executable)
1916 * [Why not contribute to/fork Hindent or Brittany?](#why-not-contribute-tofork-hindent-or-brittany)
20−* [Examples](#examples)
17+* [Roadmap](#roadmap)
2118
2219This document describes design of a new formatter for Haskell source code.
2320It also includes recommendations for future implementers.
2421
2522We set for the following goals (mostly taken from
2623[brittany](https://github.com/lspitzner/brittany)):
27−* Preserve the meaning of the formatted functions when no CPP is used;
24+* Preserve the meaning of the formatted functions;
2825* Make reasonable use of screen space;
2926* Use linear space and computation time on the size of the input;
3027* Preserve comments;
@@ -140,10 +137,8 @@ impossible to guess what they'll be called on.
140137
141138### CPP
142139
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
146−do conditional compilation.
140+Formatting a module which uses CPP directives won't be supported. Instead,
141+we hope for a solution to replace CPP to do conditional compilation.
147142
148143There are the following challenges when formatting a module with CPP:
149144
@@ -182,15 +177,14 @@ True
182177```
183178
184179At the time of this writing, formatting this program with Hindent
185−or Ormolu produces the same output we would get if the CPP directives
186−were considered comments:
180+produces the same output we would get if the CPP directives were
181+considered comments:
187182
188183```
189−$ ormolu --version
190−ormolu 0.0.5.0 HEAD fc64eada5c4da7a5b07d2872e253671b48aec115
191−using ghc-lib-parser 8.10.1.20200412
184+$ hindent --version
185+hindent 5.2.7
192186
193−$ ormolu --mode inplace test.hs
187+$ hindent test.hs
194188
195189$ cat test.hs
196190{-# LANGUAGE CPP #-}
@@ -230,6 +224,9 @@ to parse Haskell modules. If CPP is replaced with some language
230224extension or mechanism to do conditional compilation, all tools
231225will benefit from it.
232226
227+Therefore, CPP won't be supported. If the CPP extension
228+is enabled, we should signal an error right away.
229+
233230### Printing
234231
235232Just pretty-printing code (following the approach of Hindent) seems sane. It
@@ -285,22 +282,22 @@ map :: (a -> b) -> [a] -> [b]
285282foldr :: (a -> b -> b) ->
286283 b -> [a] -> [b]
287284-- Is reformatted to:
288−foldr ::
289− (a -> b -> b) ->
290− b ->
291− [a] ->
292− [b]
285+foldr
286+ :: (a -> b -> b)
287+ -> b
288+ -> [a]
289+ -> [b]
293290
294291t = let x = foo bar
295292 baz
296293 in foo bar baz
297294-- Is reformatted to:
298295t =
299− let x =
300− foo
301− bar
302− baz
303− in foo far baz
296+ let x =
297+ foo
298+ bar
299+ baz
300+ in foo far baz
304301```
305302
306303Crucially, no effort is made to fit within reasonable line lengths. That's
@@ -391,7 +388,34 @@ also possible that we'll find a nicer way to write pretty-printer.
391388
392389## Examples
393390
394−A list of formatting examples can be found [here](data/examples).
391+A list of formatting examples can be found [here](EXAMPLES.md).
392+
393+## Roadmap
394+
395+Proposed roadmap (for a single person, about 39 full-time work days):
396+
397+* ~~Create and setup a repo, setup CI (less than 1 day).~~
398+* ~~Implement parsing (2 days).~~
399+* ~~Implement basis for pretty-printing of code. We could take
400+ [this][hindent-printer] as inspiration, although AST from the `ghc`
401+ package may be slightly different. Also, don't forget about annotations
402+ and comments (1 week).~~
403+* Implement executable program so we can easier fool around. Try it on
404+ simple code samples (2 days).
405+* Implement location and reading of configuration file in YAML format (2
406+ days).
407+* Continue writing the pretty-printing code till we cover everything. Start
408+ adding tests, see [the section about testing](#testing). Fix bugs. At this
409+ point just repeat this till we cover everything that Brittany and Hindent
410+ can do maybe by stealing their tests (at least 2 weeks).
411+* Start checking how our formatter works on real-world code from Hackage.
412+ Fix bugs that we find that way (2 weeks).
413+* Write a good readme explaining why the project was created and how it is
414+ better, etc (2 days).
415+* Switch CI to Travis and test with multiple GHC versions (1 day).
416+* Make and announce the first public release on Twitter/Reddit (1 day).
417+* Figure out how to use the formatter application with major text editors
418+ and add the info to the readme (no estimate).
395419
396420[brittany]: https://hackage.haskell.org/package/brittany
397421[hindent]: https://hackage.haskell.org/package/hindent
README.md+19−108
@@ -1,29 +1,26 @@
11# Ormolu
22
3−[![License BSD3](https://img.shields.io/badge/license-BSD3-brightgreen.svg)](http://opensource.org/licenses/BSD-3-Clause)
4−[![Hackage](https://img.shields.io/hackage/v/ormolu.svg?style=flat)](https://hackage.haskell.org/package/ormolu)
5−[![Stackage Nightly](http://stackage.org/package/ormolu/badge/nightly)](http://stackage.org/nightly/package/ormolu)
6−[![Stackage LTS](http://stackage.org/package/ormolu/badge/lts)](http://stackage.org/lts/package/ormolu)
7−[![Build status](https://badge.buildkite.com/8e3b0951f3652b77e1c422b361904136a539b0522029156354.svg?branch=master)](https://buildkite.com/tweag-1/ormolu)
3+[![CircleCI](https://circleci.com/gh/tweag/ormolu/tree/master.svg?style=svg&circle-token=cfd37a39265561eb44e608f97cf953cb2a394c03)](https://circleci.com/gh/tweag/ormolu/tree/master)
84
95Ormolu is a formatter for Haskell source code. The project was created with
106the following goals in mind:
117
128* Using GHC's own parser to avoid parsing problems caused by
139 [`haskell-src-exts`][haskell-src-exts].
14−* Let some whitespace be programmable. The layout of the input influences
15− the layout choices in the output. This means that the choices between
16− single-line/multi-line layouts in each particular situation are made by
17− the user, not by an algorithm. This makes the implementation simpler and
18− leaves some control to the user while still guaranteeing that the
19− formatted code is stylistically consistent.
20−* Writing code in such a way so it's easy to modify and maintain.
10+* Let some whitespace be programmable. The layout of the input
11+ influence the layout choices in the output. This means that the
12+ choices between single-line/multi-line layouts in each particular
13+ situation are made by the user, not by an algorithm. This makes the
14+ implementation simpler and leaves some control to the user while
15+ still guaranteeing that the formatted code is stylistically
16+ consistent.
17+* Writing code in such a way so it's easy to modify and maintain. Roughly,
18+ it means that the project follows the path of [`hindent`][hindent] and is
19+ very much about printing AST in a particular way.
2120* Implementing one “true” formatting style which admits no configuration.
2221* That formatting style aims to result in minimal diffs while still
2322 remaining very close to “conventional” Haskell formatting people use.
24−* Choose a style compatible with modern dialects of Haskell. As new Haskell
25− extensions enter broad use, we may change the style to accommodate them.
26−* Idempotence: formatting already formatted code doesn't change it.
23+* Idempotency: formatting already formatted code doesn't change it.
2724* Be well-tested and robust to the point that it can be used in large
2825 projects without exposing unfortunate, disappointing bugs here and there.
2926
@@ -32,7 +29,7 @@ the following goals in mind:
3229The easiest way to build the project is with Nix:
3330
3431```console
35−$ nix-build -A ormolu
32+$ nix-build
3633```
3734
3835Or with `cabal-install` from the Nix shell:
@@ -45,36 +42,11 @@ Alternatively, `stack` could be used with a `stack.yaml` file as follows.
4542
4643```console
4744$ cat stack.yaml
48−resolver: lts-16.0
45+resolver: lts-13.19
4946packages:
5047- '.'
5148
52−$ stack build # to build
53−$ stack install # to install
54−```
55−
56−To use Ormolu directly from GitHub with Nix, this snippet may come in handy:
57−
58−```nix
59−# This overlay adds Ormolu straight from GitHub.
60−self: super:
61−
62−let source = super.fetchFromGitHub {
63− owner = "tweag";
64− repo = "ormolu";
65− rev = "de279d80122b287374d4ed87c7b630db1f157642"; # update as necessary
66− sha256 = "0qrxfk62ww6b60ha9sqcgl4nb2n5fhf66a65wszjngwkybwlzmrv"; # as well
67− };
68− ormolu = import source { pkgs = self; };
69−in {
70− haskell = super.haskell // {
71− packages = super.haskell.packages // {
72− "${ormolu.ormoluCompiler}" = super.haskell.packages.${ormolu.ormoluCompiler}.override {
73− overrides = ormolu.ormoluOverlay;
74− };
75− };
76− };
77−}
49+$ stack build
7850```
7951
8052## Usage
@@ -92,48 +64,10 @@ formatted output.
9264$ ormolu --mode inplace Module.hs
9365```
9466
95−Use `find` to format a tree recursively:
96−
97−```console
98−$ ormolu --mode inplace $(find . -name '*.hs')
99−```
100−
101−## Magic comments
102−
103−Ormolu understands two magic comments:
104−
105−```haskell
106−{- ORMOLU_DISABLE -}
107−```
108−
109−and
110−
111−```haskell
112−{- ORMOLU_ENABLE -}
113−```
114−
115−This allows us to disable formatting selectively for code between these
116−markers or disable it for the entire file. To achieve the latter, just put
117−`{- ORMOLU_DISABLE -}` at the very top. Note that the source code should
118−still be parseable even without the “excluded” part. Because of that the
119−magic comments cannot be placed arbitrary, but should rather enclose
120−independent top-level definitions.
121−
122−## Current limitations
123−
124−* CPP support is experimental. CPP is virtually impossible to handle
125− correctly, so we process them as a sort of unchangeable snippets. This
126− works only in simple cases when CPP conditionals surround top-level
127− declarations. See the [CPP][design-cpp] section in the design notes for
128− a discussion of the dangers.
129−* Input modules should be parsable by Haddock, which is a bit stricter
130− criterion than just being valid Haskell modules.
131−* Various minor idempotence issues, most of them are related to comments.
132−
13367## Running on Hackage
13468
13569It's possible to try Ormolu on arbitrary packages from Hackage. For that
136−execute (from the root of the cloned repo):
70+execute (from root of clonned repo):
13771
13872```console
13973$ nix-build -A hackage.<package>
@@ -144,38 +78,15 @@ also contain formatted `.hs` files for inspection and original inputs with
14478`.hs-original` extension (those are with CPP dropped, exactly what is fed
14579into Ormolu).
14680
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−
16381## Contributing
16482
165−See [CONTRIBUTING.md][contributing].
83+See [CONTRIBUTING.md](./CONTRIBUTING.md).
16684
16785## License
16886
169−See [LICENSE.md][license].
87+See [LICENSE.md](./LICENSE.md).
17088
17189Copyright © 2018–present Tweag I/O
17290
173−[design-cpp]: https://github.com/tweag/ormolu/blob/master/DESIGN.md#cpp
174−[contributing]: https://github.com/tweag/ormolu/blob/master/CONTRIBUTING.md
175−[license]: https://github.com/tweag/ormolu/blob/master/LICENSE.md
17691[haskell-src-exts]: https://hackage.haskell.org/package/haskell-src-exts
177−[emacs-package]: https://github.com/vyorkin/ormolu.el
178−[vs-code-plugin]: https://marketplace.visualstudio.com/items?itemName=sjurmillidahl.ormolu-vscode
179−[vim-ormolu]: https://github.com/sdiehl/vim-ormolu
180−[neoformat]: https://github.com/sbdchd/neoformat
181−[aur]: https://aur.archlinux.org/packages/ormolu
92+[hindent]: https://hackage.haskell.org/package/hindent
app/Main.hs+101−156
@@ -1,17 +1,12 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE LambdaCase #-}
33{-# LANGUAGE RecordWildCards #-}
44{-# LANGUAGE TemplateHaskell #-}
5−{-# LANGUAGE TypeApplications #-}
65
76module Main (main) where
87
9−import Control.Exception (SomeException, displayException, try)
108import Control.Monad
11−import Data.Bool (bool)
12−import Data.Either (lefts)
13−import Data.List (intercalate, sort)
14−import qualified Data.Text.IO as TIO
9+import Data.List (intercalate)
1510import Data.Version (showVersion)
1611import Development.GitRev
1712import Options.Applicative
@@ -21,183 +16,133 @@ import Ormolu.Utils (showOutputable)
2116import Paths_ormolu (version)
2217import System.Exit (ExitCode (..), exitWith)
2318import System.IO (hPutStrLn, stderr)
19+import qualified Data.Text.IO as TIO
2420
2521-- | Entry point of the program.
22+
2623main :: IO ()
2724main = withPrettyOrmoluExceptions $ do
2825 Opts {..} <- execParser optsParserInfo
29− let formatOne' = formatOne optMode optConfig
30− case optInputFiles of
31− [] -> formatOne' Nothing
32− ["-"] -> formatOne' Nothing
33− [x] -> formatOne' (Just x)
34− xs -> do
35− -- It is possible to get IOException, error's and 'OrmoluException's
36− -- from 'formatOne', so we just catch everything.
37− errs <-
38− lefts <$> mapM (try @SomeException . formatOne' . Just) (sort xs)
39− unless (null errs) $ do
40− mapM_ (hPutStrLn stderr . displayException) errs
41− exitWith (ExitFailure 102)
42−
43−-- | Format a single input.
44−formatOne ::
45− -- | Mode of operation
46− Mode ->
47− -- | Configuration
48− Config RegionIndices ->
49− -- | File to format or stdin as 'Nothing'
50− Maybe FilePath ->
51− IO ()
52−formatOne mode config = \case
53− Nothing -> do
54− r <- ormoluStdin config
55− case mode of
56− Stdout -> TIO.putStr r
57− _ -> do
58− hPutStrLn
59− stderr
60− "This feature is not supported when input comes from stdin."
61− -- 101 is different from all the other exit codes we already use.
62− exitWith (ExitFailure 101)
63− Just inputFile -> do
64− originalInput <- TIO.readFile inputFile
65− formattedInput <- ormoluFile config inputFile
66− case mode of
67− Stdout ->
68− TIO.putStr formattedInput
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) $
74− TIO.writeFile inputFile formattedInput
75− Check -> do
76− when (formattedInput /= originalInput) $
77− -- 100 is different to all the other exit code that are emitted
78− -- either from an 'OrmoluException' or from 'error' and
79− -- 'notImplemented'.
80− exitWith (ExitFailure 100)
26+ r <- case optInputFile of
27+ "-" -> ormoluStdin optConfig
28+ inputFile -> ormoluFile optConfig inputFile
29+ let notForStdin = do
30+ when (optInputFile == "-") $ do
31+ hPutStrLn
32+ stderr
33+ "This feature is not supported when input comes from stdin."
34+ -- 101 is different from all the other exit codes we already use.
35+ exitWith (ExitFailure 101)
36+ case optMode of
37+ Stdout ->
38+ TIO.putStr r
39+ InPlace -> do
40+ notForStdin
41+ TIO.writeFile optInputFile r
42+ Check -> do
43+ notForStdin
44+ r' <- TIO.readFile optInputFile
45+ when (r /= r') $
46+ -- 100 is different to all the other exit code that are emitted
47+ -- either from an 'OrmoluException' or from 'error' and
48+ -- 'notImplemented'.
49+ exitWith (ExitFailure 100)
8150
8251----------------------------------------------------------------------------
8352-- Command line options parsing.
8453
8554data Opts = Opts
86− { -- | Mode of operation
87− optMode :: !Mode,
88− -- | Ormolu 'Config'
89− optConfig :: !(Config RegionIndices),
90− -- | Haskell source files to format or stdin (when the list is empty)
91− optInputFiles :: ![FilePath]
55+ { optMode :: !Mode
56+ -- ^ Mode of operation
57+ , optConfig :: !Config
58+ -- ^ Ormolu 'Config'
59+ , optInputFile :: !FilePath
60+ -- ^ Input source file or stdin ("-")
9261 }
9362
9463-- | Mode of operation.
64+
9565data Mode
96− = -- | Output formatted source code to stdout
97− Stdout
98− | -- | Overwrite original file
99− InPlace
100− | -- | Exit with non-zero status code if
101− -- source is not already formatted
102− Check
66+ = Stdout -- ^ Output formatted source code to stdout
67+ | InPlace -- ^ Overwrite original file
68+ | Check -- ^ Exit with non-zero status code if
69+ -- source is not already formatted
10370 deriving (Eq, Show)
10471
10572optsParserInfo :: ParserInfo Opts
106−optsParserInfo =
107− info (helper <*> ver <*> exts <*> optsParser) . mconcat $
108− [ fullDesc,
109− progDesc "",
110− header ""
111− ]
73+optsParserInfo = info (helper <*> ver <*> exts <*> optsParser) . mconcat $
74+ [ fullDesc
75+ , progDesc ""
76+ , header ""
77+ ]
11278 where
11379 ver :: Parser (a -> a)
114− ver =
115− infoOption verStr . mconcat $
116− [ long "version",
117− short 'v',
118− help "Print version of the program"
119− ]
120− verStr =
121− intercalate
122− "\n"
123− [ unwords
124− [ "ormolu",
125− showVersion version,
126− $gitBranch,
127− $gitHash
128− ],
129− "using ghc-lib-parser " ++ VERSION_ghc_lib_parser
80+ ver = infoOption verStr . mconcat $
81+ [ long "version"
82+ , short 'v'
83+ , help "Print version of the program"
84+ ]
85+ verStr = intercalate "\n"
86+ [ unwords
87+ [ "ormolu"
88+ , showVersion version
89+ , $gitBranch
90+ , $gitHash
13091 ]
92+ , "using ghc " ++ VERSION_ghc
93+ ]
13194 exts :: Parser (a -> a)
132− exts =
133− infoOption displayExts . mconcat $
134− [ long "manual-exts",
135− help "Display extensions that need to be enabled manually"
136− ]
137− displayExts = unlines $ sort (showOutputable <$> manualExts)
95+ exts = infoOption displayExts . mconcat $
96+ [ long "manual-exts"
97+ , help "Display extensions that need to be enabled manually"
98+ ]
99+ displayExts = unlines (showOutputable <$> manualExts)
138100
139101optsParser :: Parser Opts
140−optsParser =
141− Opts
142− <$> ( (fmap (bool Stdout InPlace) . switch . mconcat)
143− [ short 'i',
144− help "A shortcut for --mode inplace"
145− ]
146− <|> (option parseMode . mconcat)
147− [ long "mode",
148− short 'm',
149− metavar "MODE",
150− value Stdout,
151− help "Mode of operation: 'stdout' (default), 'inplace', or 'check'"
152− ]
153− )
154− <*> configParser
155− <*> (many . strArgument . mconcat)
156− [ metavar "FILE",
157− help "Haskell source files to format or stdin (default)"
158− ]
102+optsParser = Opts
103+ <$> (option parseMode . mconcat)
104+ [ long "mode"
105+ , short 'm'
106+ , metavar "MODE"
107+ , value Stdout
108+ , help "Mode of operation: 'stdout', 'inplace', or 'check'"
109+ ]
110+ <*> configParser
111+ <*> (strArgument . mconcat)
112+ [ metavar "FILE"
113+ , value "-"
114+ , help "Haskell source file to format or stdin (default)"
115+ ]
159116
160−configParser :: Parser (Config RegionIndices)
161−configParser =
162− Config
163− <$> (fmap (fmap DynOption) . many . strOption . mconcat)
164− [ long "ghc-opt",
165− short 'o',
166− metavar "OPT",
167− help "GHC options to enable (e.g. language extensions)"
168− ]
169− <*> (switch . mconcat)
170− [ long "unsafe",
171− short 'u',
172− help "Do formatting faster but without automatic detection of defects"
173− ]
174− <*> (switch . mconcat)
175− [ long "debug",
176− short 'd',
177− help "Output information useful for debugging"
178− ]
179− <*> (switch . mconcat)
180− [ long "check-idempotence",
181− short 'c',
182− help "Fail if formatting is not idempotent"
183− ]
184− <*> ( RegionIndices
185− <$> (optional . option auto . mconcat)
186− [ long "start-line",
187− metavar "START",
188− help "Start line of the region to format (starts from 1)"
189− ]
190− <*> (optional . option auto . mconcat)
191− [ long "end-line",
192− metavar "END",
193− help "End line of the region to format (inclusive)"
194− ]
195− )
117+configParser :: Parser Config
118+configParser = Config
119+ <$> (fmap (fmap DynOption) . many . strOption . mconcat)
120+ [ long "ghc-opt"
121+ , short 'o'
122+ , metavar "OPT"
123+ , help "GHC options to enable (e.g. language extensions)"
124+ ]
125+ <*> (switch . mconcat)
126+ [ long "unsafe"
127+ , short 'u'
128+ , help "Do formatting faster but without automatic detection of defects"
129+ ]
130+ <*> (switch . mconcat)
131+ [ long "debug"
132+ , short 'd'
133+ , help "Output information useful for debugging"
134+ ]
135+ <*> (switch . mconcat)
136+ [ long "tolerate-cpp"
137+ , short 'p'
138+ , help "Do not fail if CPP pragma is present"
139+ ]
196140
197141----------------------------------------------------------------------------
198142-- Helpers
199143
200144-- | Parse 'Mode'.
145+
201146parseMode :: ReadM Mode
202147parseMode = eitherReader $ \case
203148 "stdout" -> Right Stdout
data/examples/declaration/annotation/annotation-out.hs+3−4
@@ -2,9 +2,9 @@
22
33{-# ANN
44 module
5− ( 5 ::
6− Int
7− )
5+ ( 5
6+ :: Int
7+ )
88 #-}
99
1010{-# ANN foo "hey" #-}
@@ -18,5 +18,4 @@ foo = 5
1818
1919data Foo = Foo Int
2020{-# ANN type Foo ("HLint: ignore") #-}
21−
2221{- Comment -}
data/examples/declaration/class/associated-data2-out.hs → data/examples/declaration/class/associated-data-out.hsrenamed+13−1
@@ -1,9 +1,21 @@
11{-# LANGUAGE TypeFamilies #-}
22
3−module Main where
3+class Foo a where data FooBar a
4+
5+-- | Something.
6+class Bar a where
7+
8+ -- | Bar bar
9+ data BarBar a
10+
11+ -- | Bar baz
12+ data
13+ BarBaz
14+ a
415
516-- | Something more.
617class Baz a where
18+
719 -- | Baz bar
820 data
921 BazBar
data/examples/declaration/class/associated-data2.hs → data/examples/declaration/class/associated-data.hsrenamed+11−2
@@ -1,7 +1,16 @@
1−module Main where
2−
31{-# LANGUAGE TypeFamilies #-}
42
3+class Foo a where data FooBar a
4+
5+-- | Something.
6+class Bar a
7+ where
8+ -- | Bar bar
9+ data BarBar a
10+ -- | Bar baz
11+ data family BarBaz
12+ a
13+
514-- | Something more.
615class Baz a where
716 -- | Baz bar
data/examples/declaration/class/associated-data1-out.hsdeleted−13
@@ -1,13 +0,0 @@
1−{-# LANGUAGE TypeFamilies #-}
2−
3−class Foo a where data FooBar a
4−
5−-- | Something.
6−class Bar a where
7− -- | Bar bar
8− data BarBar a
9−
10− -- | Bar baz
11− data
12− BarBaz
13− a
data/examples/declaration/class/associated-data1.hsdeleted−12
@@ -1,12 +0,0 @@
1−{-# LANGUAGE TypeFamilies #-}
2−
3−class Foo a where data FooBar a
4−
5−-- | Something.
6−class Bar a
7− where
8− -- | Bar bar
9− data BarBar a
10− -- | Bar baz
11− data family BarBaz
12− a
data/examples/declaration/class/associated-type-defaults-out.hs+2
@@ -4,6 +4,7 @@ class Foo a where type FooBar a = Int
44
55-- | Something.
66class Bar a where
7+
78 -- Define bar
89 type
910 BarBar a =
@@ -17,6 +18,7 @@ class Bar a where
1718 a
1819
1920class Baz a where
21+
2022 type
2123 BazBar
2224 a
data/examples/declaration/class/associated-types2-out.hs → data/examples/declaration/class/associated-types-out.hsrenamed+13−1
@@ -1,9 +1,21 @@
11{-# LANGUAGE TypeFamilies #-}
22
3−module Main where
3+class Foo a where type FooBar a
4+
5+-- | Something.
6+class Bar a where
7+
8+ -- | Bar bar
9+ type BarBar a
10+
11+ -- | Bar baz
12+ type
13+ BarBaz
14+ a
415
516-- | Something more.
617class Baz a where
18+
719 -- | Baz bar
820 type
921 BazBar
data/examples/declaration/class/associated-types2.hs → data/examples/declaration/class/associated-types.hsrenamed+11−2
@@ -1,7 +1,16 @@
1−module Main where
2−
31{-# LANGUAGE TypeFamilies #-}
42
3+class Foo a where type FooBar a
4+
5+-- | Something.
6+class Bar a
7+ where
8+ -- | Bar bar
9+ type BarBar a
10+ -- | Bar baz
11+ type BarBaz
12+ a
13+
514-- | Something more.
615class Baz a where
716 -- | Baz bar
data/examples/declaration/class/associated-types1-out.hsdeleted−13
@@ -1,13 +0,0 @@
1−{-# LANGUAGE TypeFamilies #-}
2−
3−class Foo a where type FooBar a
4−
5−-- | Something.
6−class Bar a where
7− -- | Bar bar
8− type BarBar a
9−
10− -- | Bar baz
11− type
12− BarBaz
13− a
data/examples/declaration/class/associated-types1.hsdeleted−12
@@ -1,12 +0,0 @@
1−{-# LANGUAGE TypeFamilies #-}
2−
3−class Foo a where type FooBar a
4−
5−-- | Something.
6−class Bar a
7− where
8− -- | Bar bar
9− type BarBar a
10− -- | Bar baz
11− type BarBaz
12− a
data/examples/declaration/class/default-implementations-comments-out.hsdeleted−26
@@ -1,26 +0,0 @@
1−module Main where
2−
3−-- | Baz
4−class Baz a where
5− foobar :: a -> a
6− foobar a =
7− barbaz (bazbar a)
8−
9− -- | Bar baz
10− barbaz ::
11− a -> a
12−
13− -- | Baz bar
14− bazbar ::
15− a ->
16− a
17−
18− -- First comment
19− barbaz a =
20− bazbar -- Middle comment
21− a
22−
23− -- Last comment
24− bazbar a =
25− barbaz
26− a
data/examples/declaration/class/default-implementations-comments.hsdeleted−22
@@ -1,22 +0,0 @@
1−module Main where
2−
3−-- | Baz
4−class Baz a where
5− foobar :: a -> a
6− foobar a =
7− barbaz (bazbar a)
8− -- | Bar baz
9− barbaz ::
10− a -> a
11− -- | Baz bar
12− bazbar ::
13− a ->
14− a
15− -- First comment
16− barbaz a
17− = bazbar -- Middle comment
18− a
19− -- Last comment
20− bazbar a
21− = barbaz
22− a
data/examples/declaration/class/default-implementations-out.hs+31−5
@@ -1,13 +1,39 @@
1−module Main where
2−
31-- | Foo
42class Foo a where
3+
54 foo :: a -> a
65 foo a = a
76
87-- | Bar
98class Bar a where
10− bar ::
11− a ->
12− Int
9+
10+ bar
11+ :: a
12+ -> Int
1313 bar = const 0
14+
15+-- | Baz
16+class Baz a where
17+
18+ foobar :: a -> a
19+ foobar a =
20+ barbaz (bazbar a)
21+
22+ -- | Bar baz
23+ barbaz
24+ :: a -> a
25+
26+ -- | Baz bar
27+ bazbar
28+ :: a
29+ -> a
30+
31+ -- First comment
32+ barbaz a =
33+ bazbar -- Middle comment
34+ a
35+
36+ -- Last comment
37+ bazbar a =
38+ barbaz
39+ a
data/examples/declaration/class/default-implementations.hs+21−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Foo
42class Foo a where
53 foo :: a -> a
@@ -11,3 +9,24 @@ class Bar a where
119 a
1210 -> Int
1311 bar = const 0
12+
13+-- | Baz
14+class Baz a where
15+ foobar :: a -> a
16+ foobar a =
17+ barbaz (bazbar a)
18+ -- | Bar baz
19+ barbaz ::
20+ a -> a
21+ -- | Baz bar
22+ bazbar ::
23+ a ->
24+ a
25+ -- First comment
26+ barbaz a
27+ = bazbar -- Middle comment
28+ a
29+ -- Last comment
30+ bazbar a
31+ = barbaz
32+ a
data/examples/declaration/class/default-signatures-out.hs+21−12
@@ -1,22 +1,31 @@
11{-# LANGUAGE DefaultSignatures #-}
22
3−module Main where
3+-- | Something.
4+class Foo a where
5+
6+ -- | Foo
7+ foo :: a -> String
8+
9+ default foo :: Show a => a -> String
10+ foo = show
411
512-- | Something else.
613class Bar a where
14+
715 -- | Bar
8− bar ::
9− String ->
10− String ->
11− a
16+ bar
17+ :: String
18+ -> String
19+ -> a
20+
1221 -- Pointless comment
13− default bar ::
14− ( Read a,
15− Semigroup a
16− ) =>
17− a ->
18− a ->
19− a
22+ default bar
23+ :: ( Read a,
24+ Semigroup a
25+ )
26+ => a
27+ -> a
28+ -> a
2029 -- Even more pointless comment
2130 bar
2231 a
data/examples/declaration/class/default-signatures-simple-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−module Main where
2−
3−-- | Something.
4−class Foo a where
5− -- | Foo
6− foo :: a -> String
7− default foo :: Show a => a -> String
8− foo = show
data/examples/declaration/class/default-signatures-simple.hsdeleted−8
@@ -1,8 +0,0 @@
1−module Main where
2−
3−-- | Something.
4−class Foo a where
5− -- | Foo
6− foo :: a -> String
7− default foo :: Show a => a -> String
8− foo = show
data/examples/declaration/class/default-signatures.hs+7−2
@@ -1,7 +1,12 @@
1−module Main where
2−
31{-# LANGUAGE DefaultSignatures #-}
42
3+-- | Something.
4+class Foo a where
5+ -- | Foo
6+ foo :: a -> String
7+ default foo :: Show a => a -> String
8+ foo = show
9+
510-- | Something else.
611class Bar a
712 where
data/examples/declaration/class/dependency-super-classes-out.hs+11−11
@@ -1,25 +1,25 @@
11{-# LANGUAGE FunctionalDependencies #-}
22
3−module Main where
4−
53-- | Something.
64class (MonadReader r s, MonadWriter w m) => MonadState s m | m -> s where
5+
76 get :: m s
7+
88 put :: s -> m ()
99
1010-- | 'MonadParsec'
1111class
1212 ( Stream s, -- Token streams
1313 MonadPlus m -- Potential for failure
14− ) =>
15− MonadParsec e s m
16− | m -> e s
17− where
14+ )
15+ => MonadParsec e s m
16+ | m -> e s where
17+
1818 -- | 'getState' returns state
19− getState ::
20− m s
19+ getState
20+ :: m s
2121
2222 -- | 'putState' sets state
23− putState ::
24− s ->
25− m ()
23+ putState
24+ :: s
25+ -> m ()
data/examples/declaration/class/dependency-super-classes.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31{-# LANGUAGE FunctionalDependencies #-}
42
53-- | Something.
data/examples/declaration/class/empty-classes-out.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Foo!
42class Foo a
53
data/examples/declaration/class/empty-classes.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Foo!
42class Foo a where
53-- | Bar!
data/examples/declaration/class/functional-dependencies-out.hs+2−4
@@ -1,7 +1,5 @@
11{-# LANGUAGE FunctionalDependencies #-}
22
3−module Main where
4−
53-- | Something.
64class Foo a b | a -> b
75
@@ -14,6 +12,6 @@ class
1412 b c -> a d, -- Bar
1513 a c -> b d, -- Baz
1614 a c d -> b,
17− a b d -> a b c d
18− where
15+ a b d -> a b c d where
16+
1917 baz :: a -> b
data/examples/declaration/class/functional-dependencies.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31{-# LANGUAGE FunctionalDependencies #-}
42
53-- | Something.
data/examples/declaration/class/multi-parameters-out.hsnew file+34
@@ -0,0 +1,34 @@
1+{-# LANGUAGE MultiParamTypeClasses #-}
2+
3+class Foo a b where foo :: a -> b
4+
5+-- | Something.
6+class Bar a b c d where
7+
8+ bar
9+ :: a
10+ -> b
11+ -> c
12+ -> d
13+
14+class -- Before name
15+ Baz where
16+
17+ baz :: Int
18+
19+-- | Something else.
20+class
21+ BarBaz
22+ a -- Foo
23+ b -- Bar
24+ c -- Baz bar
25+ d -- Baz baz
26+ e -- Rest
27+ f where
28+
29+ barbaz
30+ :: a -> f
31+
32+ bazbar
33+ :: e
34+ -> f
data/examples/declaration/class/multi-parameters2.hs → data/examples/declaration/class/multi-parameters.hsrenamed+16−2
@@ -1,7 +1,21 @@
1−module Main where
2−
31{-# LANGUAGE MultiParamTypeClasses #-}
42
3+class Foo a b where foo :: a -> b
4+
5+-- | Something.
6+class Bar a b c d
7+ where
8+ bar ::
9+ a
10+ -> b
11+ -> c
12+ -> d
13+
14+class -- Before name
15+ Baz
16+ where
17+ baz :: Int
18+
519-- | Something else.
620class
721 BarBaz
data/examples/declaration/class/multi-parameters1-out.hsdeleted−15
@@ -1,15 +0,0 @@
1−{-# LANGUAGE MultiParamTypeClasses #-}
2−
3−class Foo a b where foo :: a -> b
4−
5−-- | Something.
6−class Bar a b c d where
7− bar ::
8− a ->
9− b ->
10− c ->
11− d
12−
13−class -- Before name
14− Baz where
15− baz :: Int
data/examples/declaration/class/multi-parameters1.hsdeleted−18
@@ -1,18 +0,0 @@
1−{-# LANGUAGE MultiParamTypeClasses #-}
2−
3−class Foo a b where foo :: a -> b
4−
5−-- | Something.
6−class Bar a b c d
7− where
8− bar ::
9− a
10− -> b
11− -> c
12− -> d
13−
14−class -- Before name
15− Baz
16− where
17− baz :: Int
18−
data/examples/declaration/class/multi-parameters2-out.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# LANGUAGE MultiParamTypeClasses #-}
2−
3−module Main where
4−
5−-- | Something else.
6−class
7− BarBaz
8− a -- Foo
9− b -- Bar
10− c -- Baz bar
11− d -- Baz baz
12− e -- Rest
13− f
14− where
15− barbaz ::
16− a -> f
17− bazbar ::
18− e ->
19− f
data/examples/declaration/class/newlines-after-where-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−class Num a where
2− (+) :: a -> a -> a
3−
4−class Num a where
5− (+) :: a -> a -> a
data/examples/declaration/class/newlines-after-where.hsdeleted−7
@@ -1,7 +0,0 @@
1−class Num a where
2− (+) :: a -> a -> a
3−
4−class Num a where
5−
6−
7− (+) :: a -> a -> a
data/examples/declaration/class/newlines-and-default-decls-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−class Foo a where
2− foo :: a
3− default foo :: ()
4− foo = ()
5− bar :: a
6− default bar :: ()
7− bar = ()
8−
9− qux :: a
10− default qux :: ()
11− qux = ()
data/examples/declaration/class/newlines-and-default-decls.hsdeleted−13
@@ -1,13 +0,0 @@
1−class Foo a where
2− foo :: a
3− default foo :: ()
4− foo = ()
5− bar :: a
6− default bar :: ()
7− bar = ()
8−
9− qux :: a
10−
11− default qux :: ()
12−
13− qux = ()
data/examples/declaration/class/newlines-and-haddocks-out.hsdeleted−23
@@ -1,23 +0,0 @@
1−class Foo a where
2− -- | Haddock
3− foo :: a
4−
5− -- | Another Haddock
6− bar :: a
7−
8− baz :: a
9− -- ^ Post-Haddock
10−
11− raz :: a
12− -- ^ Another Post-Haddock
13−
14− -- | One more Haddock
15− qux :: a
16−
17− -- Comment before a Haddock
18−
19− -- | And one more Haddock
20− xyz :: a
21−
22− -- | Haddock followed by a blank line
23− abc :: a
data/examples/declaration/class/newlines-and-haddocks.hsdeleted−19
@@ -1,19 +0,0 @@
1−class Foo a where
2− -- | Haddock
3− foo :: a
4− -- | Another Haddock
5− bar :: a
6− baz :: a
7− -- ^ Post-Haddock
8− raz :: a
9− -- ^ Another Post-Haddock
10−
11− -- | One more Haddock
12− qux :: a
13− -- Comment before a Haddock
14− -- | And one more Haddock
15− xyz :: a
16−
17− -- | Haddock followed by a blank line
18−
19− abc :: a
data/examples/declaration/class/newlines-between-methods-out.hsdeleted−17
@@ -1,17 +0,0 @@
1−class Num a where
2− (+) :: a -> a -> a
3− (-) :: a -> a -> a
4− (*) :: a -> a -> a
5−
6− -- Comment before definition
7− negate :: a -> a
8−
9− -- Comment after definition
10−
11− -- Separator
12−
13− abs :: a -> a
14− signum :: a -> a
15−
16− -- Comment between unrelated definitions
17− fromInteger :: Integer -> a
data/examples/declaration/class/newlines-between-methods.hsdeleted−15
@@ -1,15 +0,0 @@
1−class Num a where
2− (+) :: a -> a -> a
3− (-) :: a -> a -> a
4− (*) :: a -> a -> a
5−
6− -- Comment before definition
7− negate :: a -> a
8− -- Comment after definition
9−
10− -- Separator
11−
12− abs :: a -> a
13− signum :: a -> a
14− -- Comment between unrelated definitions
15− fromInteger :: Integer -> a
data/examples/declaration/class/poly-kinded-classes-out.hs+3−3
@@ -4,6 +4,6 @@ class Foo (a :: k)
44
55class
66 Bar
7− ( a :: -- Variable
8− * -- Star
9− )
7+ ( a -- Variable
8+ :: * -- Star
9+ )
data/examples/declaration/class/single-parameters-out.hs+12−13
@@ -1,26 +1,25 @@
1−module Main where
2−
31-- | Something.
42class Foo a where foo :: a
53
64-- | Something more.
75class Bar a where
6+
87 -- | Bar
98 bar :: a -> a -> a
109
1110class Baz a where
11+
1212 -- | Baz
13− baz ::
14− -- | First argument
15− ( a,
16− a
17− ) ->
18− -- | Second argument
19− a ->
20− -- | Return value
21− a
13+ baz
14+ :: ( a,
15+ a -- ^ First argument
16+ )
17+ -> a -- ^ Second argument
18+ -> a -- ^ Return value
2219
2320class BarBaz a where
24− barbaz ::
25− a -> b
21+
22+ barbaz
23+ :: a -> b
24+
2625 bazbar :: b -> a
data/examples/declaration/class/single-parameters.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Something.
42class Foo a where foo :: a
53
data/examples/declaration/class/super-classes-out.hs+4−4
@@ -3,12 +3,12 @@ class Foo a
33class Foo a => Bar a
44
55class
6− (Foo a, Bar a) =>
7− Baz a
6+ (Foo a, Bar a)
7+ => Baz a
88
99class
1010 ( Foo a, -- Foo?
1111 Bar a, -- Bar?
1212 Baz a -- Baz
13− ) =>
14− BarBar a
13+ )
14+ => BarBar a
data/examples/declaration/class/type-operators-out.hsnew file+43
@@ -0,0 +1,43 @@
1+{-# LANGUAGE MultiParamTypeClasses #-}
2+{-# LANGUAGE TypeOperators #-}
3+
4+class (:$) a b
5+
6+class
7+ (:&)
8+ a
9+ b
10+
11+class a :* b
12+
13+class
14+ a -- Before operator
15+ :+ b -- After operator
16+
17+class
18+ ( f
19+ :. g
20+ )
21+ a
22+
23+class a `Pair` b
24+
25+class
26+ a
27+ `Sum` b
28+
29+class (f `Product` g) a
30+
31+class
32+ ( f
33+ `Sum` g
34+ )
35+ a
36+
37+type API
38+ = "route1" :> ApiRoute1
39+ :<|> "route2"
40+ :> ApiRoute2 -- comment here
41+ :<|> OmitDocs
42+ :> "i"
43+ :> ASomething API
data/examples/declaration/class/type-operators.hsnew file+39
@@ -0,0 +1,39 @@
1+{-# LANGUAGE MultiParamTypeClasses #-}
2+{-# LANGUAGE TypeOperators #-}
3+
4+class (:$) a b
5+
6+class (:&)
7+ a
8+ b
9+
10+class a:*b
11+
12+class
13+ a -- Before operator
14+ :+
15+ b -- After operator
16+
17+class (
18+ f :. g
19+ ) a
20+
21+class
22+ a`Pair`b
23+
24+class
25+ a
26+ `Sum` b
27+
28+class (f`Product`g)a
29+
30+class (
31+ f `Sum` g
32+ ) a
33+
34+type API
35+ = "route1" :> ApiRoute1
36+ :<|> "route2" :> ApiRoute2 -- comment here
37+ :<|> OmitDocs :> "i" :> ASomething API
38+
39+
data/examples/declaration/class/type-operators1-out.hsdeleted−21
@@ -1,21 +0,0 @@
1−{-# LANGUAGE MultiParamTypeClasses #-}
2−{-# LANGUAGE TypeOperators #-}
3−
4−class (:$) a b
5−
6−class
7− (:&)
8− a
9− b
10−
11−class a :* b
12−
13−class
14− a -- Before operator
15− :+ b -- After operator
16−
17−class
18− ( f
19− :. g
20− )
21− a
data/examples/declaration/class/type-operators1.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# LANGUAGE MultiParamTypeClasses #-}
2−{-# LANGUAGE TypeOperators #-}
3−
4−class (:$) a b
5−
6−class (:&)
7− a
8− b
9−
10−class a:*b
11−
12−class
13− a -- Before operator
14− :+
15− b -- After operator
16−
17−class (
18− f :. g
19− ) a
data/examples/declaration/class/type-operators2-out.hsdeleted−16
@@ -1,16 +0,0 @@
1−{-# LANGUAGE MultiParamTypeClasses #-}
2−{-# LANGUAGE TypeOperators #-}
3−
4−class a `Pair` b
5−
6−class
7− a
8− `Sum` b
9−
10−class (f `Product` g) a
11−
12−class
13− ( f
14− `Sum` g
15− )
16− a
data/examples/declaration/class/type-operators2.hsdeleted−16
@@ -1,16 +0,0 @@
1−{-# LANGUAGE MultiParamTypeClasses #-}
2−{-# LANGUAGE TypeOperators #-}
3−
4−class
5− a`Pair`b
6−
7−class
8− a
9− `Sum` b
10−
11−class (f`Product`g)a
12−
13−class (
14− f `Sum` g
15− ) a
16−
data/examples/declaration/class/type-operators3-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE PolyKinds #-}
2−{-# LANGUAGE TypeFamilies #-}
3−{-# LANGUAGE TypeOperators #-}
4−{-# LANGUAGE NoStarIsType #-}
5−
6−class PNum x where
7− type (a :: x) * (b :: x)
8−
9−instance PNum Nat where
10− type a * b = ()
data/examples/declaration/class/type-operators3.hsdeleted−7
@@ -1,7 +0,0 @@
1−{-# LANGUAGE TypeFamilies, TypeOperators, NoStarIsType, PolyKinds #-}
2−
3−class PNum x where
4− type (a :: x) * (b :: x)
5−
6−instance PNum Nat where
7− type a * b = ()
data/examples/declaration/data/deriving-strategies-out.hs+1−3
@@ -1,12 +1,10 @@
1−module Main where
2−
31-- | Something.
42newtype Foo = Foo Int
53 deriving stock (Eq, Show, Generic)
64 deriving anyclass
75 ( ToJSON,
86 FromJSON
9− )
7+ )
108 deriving newtype (Num)
119 deriving (Monoid) via (Sum Int)
1210 deriving
data/examples/declaration/data/deriving-strategies.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Something.
42
53newtype Foo = Foo Int
data/examples/declaration/data/existential-multiline-out.hs−12
@@ -3,15 +3,3 @@
33data Foo
44 = forall a. MkFoo a (a -> Bool)
55 | forall a. Eq a => MkBar a
6−
7−data Bar
8− = forall x y.
9− Bar x y x y
10−
11−data Baz
12− = forall x y.
13− Baz
14− x
15− y
16− x
17− y
data/examples/declaration/data/existential-multiline.hs−7
@@ -3,10 +3,3 @@
33data Foo
44 = forall a. MkFoo a (a -> Bool)
55 | forall a. Eq a => MkBar a
6−
7−data Bar = forall x y.
8− Bar x y x y
9−
10−data Baz = forall x y.
11− Baz x y x
12− y
data/examples/declaration/data/existential-out.hs−2
@@ -1,5 +1,3 @@
11{-# LANGUAGE ExistentialQuantification #-}
22
33data Foo = forall a. MkFoo a (a -> Bool)
4−
5−data Bar = forall a b. a + b => Bar a b
data/examples/declaration/data/existential.hs−2
@@ -1,5 +1,3 @@
11{-# LANGUAGE ExistentialQuantification #-}
22
33data Foo = forall a. MkFoo a (a -> Bool)
4−
5−data Bar = forall a b. a + b => Bar a b
data/examples/declaration/data/fat-multiline-out.hs+4−6
@@ -1,12 +1,10 @@
1−module Main where
2−
31-- | Something.
42data Foo
5− = -- | Foo
6− Foo
3+ = Foo
74 Int
85 Int
9− | -- | Bar
10− Bar
6+ -- ^ Foo
7+ | Bar
118 Bool
129 Bool
10+ -- ^ Bar
data/examples/declaration/data/fat-multiline.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Something.
42
53data Foo
data/examples/declaration/data/field-layout/gadt-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−data Foo a b where
5− -- | Something
6− Foo :: Foo Int Int
7− -- | Something else
8− Bar ::
9− Foo
10− Char
11− Char
data/examples/declaration/data/field-layout/gadt.hsdeleted−10
@@ -1,10 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−
5−data Foo a b where
6− -- | Something
7− Foo :: Foo Int Int
8− -- | Something else
9− Bar :: Foo Char
10− Char
data/examples/declaration/data/field-layout/record-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−data Foo = Foo
5− { -- | Something
6− foo :: Foo Int Int,
7− -- | Something else
8− bar ::
9− Bar
10− Char
11− Char
12− }
data/examples/declaration/data/field-layout/record.hsdeleted−11
@@ -1,11 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−
5−data Foo = Foo
6− { foo :: Foo Int Int
7− -- ^ Something
8− , bar :: Bar Char
9− Char
10− -- ^ Something else
11− }
data/examples/declaration/data/field-layout/variants-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−data Foo
5− = -- | Something
6− Foo Int Int
7− | -- | Something else
8− Bar
9− Char
10− Char
data/examples/declaration/data/field-layout/variants.hsdeleted−10
@@ -1,10 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−
5−data Foo =
6− Foo Int Int
7− -- ^ Something
8− | Bar Char
9− Char
10− -- ^ Something else
data/examples/declaration/data/gadt-syntax-out.hs+1−2
@@ -1,3 +1,2 @@
1−{-# LANGUAGE GADTSyntax #-}
2−
1+{-# LANUGAGE GADTSyntax #-}
32data Foo where MKFoo :: a -> (a -> Bool) -> Foo
data/examples/declaration/data/gadt-syntax.hs+1−1
@@ -1,3 +1,3 @@
1−{-# LANGUAGE GADTSyntax #-}
1+{-# LANUGAGE GADTSyntax #-}
22
33data Foo where { MKFoo :: a -> (a->Bool) -> Foo }
data/examples/declaration/data/gadt/multiline-out.hs+13−17
@@ -1,25 +1,21 @@
11{-# LANGUAGE ExplicitForAll #-}
22
3−module Main where
4−
53-- | Here goes a comment.
64data Foo a where
75 -- | 'Foo' is wonderful.
8− Foo ::
9− forall a b.
10− (Show a, Eq b) => -- foo
11− -- bar
12− a ->
13− b ->
14− Foo 'Int
6+ Foo
7+ :: forall a b. (Show a, Eq b) -- foo
8+ -- bar
9+ => a
10+ -> b
11+ -> Foo 'Int
1512 -- | But 'Bar' is also not too bad.
16− Bar ::
17− Int ->
18− Maybe Text ->
19− Foo 'Bool
13+ Bar
14+ :: Int
15+ -> Maybe Text
16+ -> Foo 'Bool
2017 -- | So is 'Baz'.
21− Baz ::
22− forall a.
23− a ->
24− Foo 'String
18+ Baz
19+ :: forall a. a
20+ -> Foo 'String
2521 (:~>) :: Foo a -> Foo a -> Foo a
data/examples/declaration/data/gadt/multiline-where-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−data
2− Foo
3− a
4− b
5− c
6− where
7− Foo :: a -> b -> c -> Foo a b c
data/examples/declaration/data/gadt/multiline-where.hsdeleted−6
@@ -1,6 +0,0 @@
1−data
2− Foo
3− a
4− b
5− c where
6− Foo :: a -> b -> c -> Foo a b c
data/examples/declaration/data/gadt/multiline.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31{-# LANGUAGE ExplicitForAll #-}
42
53-- | Here goes a comment.
data/examples/declaration/data/gadt/multiple-declaration-out.hs+6−6
@@ -3,13 +3,13 @@ data GADT0 a where
33
44data GADT1 a where
55 GADT11,
6− GADT12 ::
7− Int ->
8− GADT1 a
6+ GADT12
7+ :: Int
8+ -> GADT1 a
99
1010data GADT2 a where
1111 GADT21,
1212 GADT21,
13− GADT22 ::
14− Int ->
15− GADT2 a
13+ GADT22
14+ :: Int
15+ -> GADT2 a
data/examples/declaration/data/gadt/record-out.hs+9−11
@@ -1,14 +1,12 @@
1−module Main where
2−
31-- | Something.
42data Foo where
53 Foo :: {fooX :: Int} -> Foo
6− Bar ::
7− { fooY :: Int,
8− fooBar, fooBaz :: Bool,
9− fooFoo,
10− barBar,
11− bazBaz ::
12− Int
13− } ->
14− Foo
4+ Bar
5+ :: { fooY :: Int,
6+ fooBar, fooBaz :: Bool,
7+ fooFoo,
8+ barBar,
9+ bazBaz
10+ :: Int
11+ }
12+ -> Foo
data/examples/declaration/data/gadt/record.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Something.
42
53data Foo where
data/examples/declaration/data/gadt/simple-out.hs+2−12
@@ -1,18 +1,8 @@
11{-# LANGUAGE ExplicitForAll #-}
22
3−module Main where
4−
53-- | Here goes a comment.
64data Foo a where
75 -- | 'Foo' is wonderful.
86 Foo :: forall a b. (Show a, Eq b) => a -> b -> Foo 'Int
9− Bar ::
10− Int ->
11− Text ->
12− -- | But 'Bar' is also not too bad.
13− Foo 'Bool
14− Baz ::
15− forall a.
16− a ->
17− -- | So is 'Baz'.
18− Foo 'String
7+ Bar :: Int -> Text -> Foo 'Bool -- ^ But 'Bar' is also not too bad.
8+ Baz :: forall a. a -> Foo 'String -- ^ So is 'Baz'.
data/examples/declaration/data/gadt/simple.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31{-# LANGUAGE ExplicitForAll #-}
42
53-- | Here goes a comment.
data/examples/declaration/data/gadt/strictness-out.hs+1−2
@@ -1,3 +1,2 @@
11data Foo a where
2− Foo1 :: !Int -> {-# UNPACK #-} !Bool -> Foo Int
3− Foo2 :: {-# UNPACK #-} Maybe Int && Bool -> Foo Int
2+ Foo :: !Int -> {-# UNPACK #-} !Bool -> Foo Int
data/examples/declaration/data/gadt/strictness.hs+1−2
@@ -1,3 +1,2 @@
11data Foo a where
2− Foo1 :: !Int -> {-# UNPACK #-} !Bool -> Foo Int
3− Foo2 :: {-# UNPACK #-} Maybe Int && Bool -> Foo Int
2+ Foo :: !Int -> {-# UNPACK #-} !Bool -> Foo Int
data/examples/declaration/data/kind-annotations-out.hs−10
@@ -1,11 +1 @@
11data Something (n :: Nat) = Something
2−
3−data Format (k :: *) (k' :: *) (k'' :: *)
4−
5−type Parens1 = Proxy '(a :: A, b :: (B :: *))
6−
7−type Parens2 = Proxy '((a :: A), (b :: B))
8−
9−type family Foo a where
10− Foo '(a :: Int, b :: Bool) = Int
11− Foo '((a :: Int), (b :: Bool)) = Int
data/examples/declaration/data/kind-annotations.hs−9
@@ -1,10 +1 @@
11data Something (n :: Nat) = Something
2−
3−data Format (k :: *) (k' :: *) (k'' :: *)
4−
5−type Parens1 = Proxy '(a :: A, b :: (B :: *))
6−type Parens2 = Proxy '((a :: A), (b :: B))
7−
8−type family Foo a where
9− Foo '(a :: Int, b :: Bool) = Int
10− Foo '((a :: Int), (b :: Bool)) = Int
data/examples/declaration/data/multiline-arg-parens-out.hs+1−3
@@ -1,10 +1,8 @@
1−module Main where
2−
31-- | Something.
42data Foo
53 = Foo
64 Bar
75 (Set Baz) -- and here we go
8− -- and that's it
6+ -- and that's it
97 Text
108 deriving (Eq)
data/examples/declaration/data/multiline-arg-parens.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Something.
42
53data Foo
data/examples/declaration/data/multiline-names-out.hs+2−2
@@ -11,7 +11,7 @@ data (f :* g) a = f a :* g a
1111data
1212 ( f
1313 :+ g
14− )
14+ )
1515 a
1616 = L (f a)
1717 | R (g a)
@@ -23,7 +23,7 @@ data (f `Product` g) a = f a `Product` g a
2323data
2424 ( f
2525 `Sum` g
26− )
26+ )
2727 a
2828 = L' (f a)
2929 | R' (g a)
data/examples/declaration/data/multiline-out.hs+3−8
@@ -1,12 +1,7 @@
1−module Main where
2−
31-- | Here we have 'Foo'.
42data Foo
5− = -- | One
6− Foo
7− | -- | Two
8− Bar Int
9− | -- | Three
10− Baz
3+ = Foo -- ^ One
4+ | Bar Int -- ^ Two
5+ | Baz -- ^ Three
116 deriving
127 (Eq, Show)
data/examples/declaration/data/multiline.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Here we have 'Foo'.
42
53data Foo
data/examples/declaration/data/newtype-out.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Something.
42newtype Foo = Foo Int
53 deriving (Eq, Show)
data/examples/declaration/data/newtype.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Something.
42
53newtype Foo = Foo Int
data/examples/declaration/data/operators-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−data ErrorMessage' s
2− = -- | Show the text as is.
3− Text s
4− | -- | Pretty print the type.
5− -- @ShowType :: k -> ErrorMessage@
6− forall t. ShowType t
7− | -- | Put two pieces of error message next
8− -- to each other.
9− ErrorMessage' s :<>: ErrorMessage' s
10− | -- | Stack two pieces of error message on top
11− -- of each other.
12− ErrorMessage' s :$$: ErrorMessage' s
data/examples/declaration/data/operators.hsdeleted−12
@@ -1,12 +0,0 @@
1−data ErrorMessage' s
2− = -- | Show the text as is.
3− Text s
4− | -- | Pretty print the type.
5− -- @ShowType :: k -> ErrorMessage@
6− forall t. ShowType t
7− | -- | Put two pieces of error message next
8− -- to each other.
9− ErrorMessage' s :<>: ErrorMessage' s
10− | -- | Stack two pieces of error message on top
11− -- of each other.
12− ErrorMessage' s :$$: ErrorMessage' s
data/examples/declaration/data/partly-documented-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−data Optimisation
2− = PETransform
3− | -- | partial eval and associated transforms
4− GeneralisedNatHack
5− deriving (Show, Eq, Generic)
data/examples/declaration/data/partly-documented.hsdeleted−2
@@ -1,2 +0,0 @@
1−data Optimisation = PETransform | GeneralisedNatHack -- ^ partial eval and associated transforms
2− deriving (Show, Eq, Generic)
data/examples/declaration/data/record-multi-const-out.hsdeleted−17
@@ -1,17 +0,0 @@
1−module Main where
2−
3−-- | Something.
4−data Foo
5− = Foo
6− { -- | X
7− fooX :: Int,
8− -- | Y
9− fooY :: Int
10− }
11− | Bar
12− { -- | X
13− barX :: Int,
14− -- | Y
15− barY :: Int
16− }
17− deriving (Eq, Show)
data/examples/declaration/data/record-multi-const.hsdeleted−13
@@ -1,13 +0,0 @@
1−module Main where
2−
3−-- | Something.
4−
5−data Foo = Foo
6− { fooX :: Int -- ^ X
7− , fooY :: Int -- ^ Y
8− } |
9− Bar
10− { barX :: Int -- ^ X
11− , barY :: Int -- ^ Y
12− }
13− deriving (Eq, Show)
data/examples/declaration/data/record-out.hs+16−21
@@ -1,23 +1,18 @@
1−module Main where
2−
31-- | Something.
4−data Foo = Foo
5− { -- | X
6− fooX :: Int,
7− -- | Y
8− fooY :: Int,
9− -- | BarBaz
10− fooBar, fooBaz :: NonEmpty (Identity Bool),
11− -- | GagGog
12− fooGag,
13− fooGog ::
14− NonEmpty
15− ( Indentity
16− Bool
17− ),
18− -- | Huh!
19− fooFoo,
20− barBar ::
21− Int
22− }
2+data Foo
3+ = Foo
4+ { fooX :: Int, -- ^ X
5+ fooY :: Int, -- ^ Y
6+ fooBar, fooBaz :: NonEmpty (Identity Bool), -- ^ BarBaz
7+ fooGag,
8+ fooGog
9+ :: NonEmpty
10+ ( Indentity
11+ Bool
12+ ),
13+ -- ^ GagGog
14+ fooFoo,
15+ barBar
16+ :: Int -- ^ Huh!
17+ }
2318 deriving (Eq, Show)
data/examples/declaration/data/record-singleline-out.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Something.
42data Foo = Foo {fooX :: Int, fooY :: Int}
53 deriving (Eq, Show)
data/examples/declaration/data/record-singleline.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Something.
42
53data Foo = Foo { fooX :: Int , fooY :: Int }
data/examples/declaration/data/record.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Something.
42
53data Foo = Foo
data/examples/declaration/data/simple-broken-out.hs+2−3
@@ -1,7 +1,6 @@
1−module Main where
2−
31-- | Here we go.
4−data Foo = Foo {unFoo :: Int}
2+data Foo
3+ = Foo {unFoo :: Int}
54 deriving (Eq)
65
76-- | And once again.
data/examples/declaration/data/simple-broken.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Here we go.
42
53data Foo
data/examples/declaration/data/simple-out.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | And here we have 'Foo'.
42data Foo = Foo | Bar Int | Baz
53 deriving (Eq, Show)
data/examples/declaration/data/simple.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | And here we have 'Foo'.
42
53data Foo = Foo | Bar Int | Baz
data/examples/declaration/data/strictness-out.hs+1−5
@@ -1,6 +1,2 @@
1−module Main where
2−
31-- | Something.
4−data Foo
5− = Foo1 !Int {-# UNPACK #-} !Bool {-# NOUNPACK #-} !String
6− | Foo2 {a :: {-# UNPACK #-} Maybe Int && Bool}
2+data Foo = Foo !Int {-# UNPACK #-} !Bool {-# NOUNPACK #-} !String
data/examples/declaration/data/strictness.hs+1−5
@@ -1,7 +1,3 @@
1−module Main where
2−
31-- | Something.
42
5−data Foo
6− = Foo1 !Int {-# UNPACK #-} !Bool {-# NOUNPACK #-} !String
7− | Foo2 { a :: {-# UNPACK #-} Maybe Int && Bool }
3+data Foo = Foo !Int {-# UNPACK #-} !Bool {-# NOUNPACK #-} !String
data/examples/declaration/data/unnamed-field-comment-0-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−data Foo
2− = -- | Bar
3− Bar
4− Field1
5− -- ^ Field 1
6− Field2
7− -- ^ Field 2
data/examples/declaration/data/unnamed-field-comment-0.hsdeleted−5
@@ -1,5 +0,0 @@
1−data Foo
2− = -- | Bar
3− Bar
4− Field1 -- ^ Field 1
5− Field2 -- ^ Field 2
data/examples/declaration/data/unnamed-field-comment-1-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−data X
2− = B
3− !Int
4− -- ^ y
5− C
data/examples/declaration/data/unnamed-field-comment-1.hsdeleted−4
@@ -1,4 +0,0 @@
1−data X
2− = B
3− !Int -- ^ y
4− C
data/examples/declaration/data/with-comment-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−data A
2− = B -- C
3− | -- D
4− E
data/examples/declaration/data/with-comment.hsdeleted−5
@@ -1,5 +0,0 @@
1−data A =
2− B -- C
3−
4− -- D
5− | E
data/examples/declaration/data/with-weird-haddock-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−data PlusLevel' t
2− = -- | @n + ℓ@.
3− Plus Integer (LevelAtom' t)
4− deriving (Show, Data)
data/examples/declaration/data/with-weird-haddock.hsdeleted−2
@@ -1,2 +0,0 @@
1−data PlusLevel' t = Plus Integer (LevelAtom' t) -- ^ @n + ℓ@.
2− deriving (Show, Data)
data/examples/declaration/default/default-out.hs+1−1
@@ -4,4 +4,4 @@ default
44 ( Int,
55 Foo,
66 Bar
7− )
7+ )
data/examples/declaration/deriving/multiline-out.hs+20
@@ -14,6 +14,26 @@ deriving newtype instance
1414 Data
1515 Foo
1616
17+deriving instance
18+ {-# OVERLAPPABLE #-}
19+ Ord
20+ Foo
21+
22+deriving instance
23+ {-# OVERLAPPING #-}
24+ Num
25+ Foo
26+
27+deriving instance
28+ {-# OVERLAPS #-}
29+ Read
30+ Foo
31+
32+deriving instance
33+ {-# INCOHERENT #-}
34+ Show
35+ Foo
36+
1737deriving via
1838 Foo
1939 Int
data/examples/declaration/deriving/multiline.hs+17
@@ -11,6 +11,23 @@ deriving newtype instance
1111 Data
1212 Foo
1313
14+deriving instance
15+ {-# OVERLAPPABLE #-}
16+ Ord
17+ Foo
18+deriving instance
19+ {-# OVERLAPPING #-}
20+ Num
21+ Foo
22+deriving instance
23+ {-# OVERLAPS #-}
24+ Read
25+ Foo
26+deriving instance
27+ {-# INCOHERENT #-}
28+ Show
29+ Foo
30+
1431deriving via Foo
1532 Int
1633 instance Triple
data/examples/declaration/deriving/overlapping-out.hsdeleted−19
@@ -1,19 +0,0 @@
1−deriving instance
2− {-# OVERLAPPABLE #-}
3− Ord
4− Foo
5−
6−deriving instance
7− {-# OVERLAPPING #-}
8− Num
9− Foo
10−
11−deriving instance
12− {-# OVERLAPS #-}
13− Read
14− Foo
15−
16−deriving instance
17− {-# INCOHERENT #-}
18− Show
19− Foo
data/examples/declaration/deriving/overlapping.hsdeleted−17
@@ -1,17 +0,0 @@
1−deriving instance
2− {-# OVERLAPPABLE #-}
3− Ord
4− Foo
5−deriving instance
6− {-# OVERLAPPING #-}
7− Num
8− Foo
9−deriving instance
10− {-# OVERLAPS #-}
11− Read
12− Foo
13−deriving instance
14− {-# INCOHERENT #-}
15− Show
16− Foo
17−
data/examples/declaration/foreign/foreign-export-out.hs+1−2
@@ -2,8 +2,7 @@ foreign export ccall foo :: Int -> IO Int
22
33-- | 'foreignTomFun' is a very important thing
44foreign export ccall "tomography"
5− foreignTomFun ::
6− StablePtr Storage {- Storage is bad -} -> TomForegin
5+ foreignTomFun :: StablePtr Storage -> TomForegin {- Storage is bad -}
76
87foreign export {- We can't use capi here -} ccall "dynamic"
98 export_nullaryMeth :: (IO HRESULT) -> IO (Ptr ())
data/examples/declaration/foreign/foreign-import-out.hs+10−10
@@ -10,16 +10,16 @@ foreign import stdcall unsafe "boo"
1010 boo :: Int -> Text -> IO Array
1111
1212foreign import javascript
13− baz ::
14− String ->
15− Int ->
16− IO Foo
13+ baz
14+ :: String
15+ -> Int
16+ -> IO Foo
1717
1818foreign import {- We use capi here -} capi "pi.h value pi" c_pi :: CDouble
1919
20−foreign import stdcall {- This is a bad place for a comment -} "dynamic"
21− dyn_gluBeginSurface ::
22− -- | This 'FunPtr' is extremely dangerous, beware
23− FunPtr (Ptr GLUnurbs -> IO ()) ->
24− Ptr GLUnurbs ->
25− IO ()
20+foreign import stdcall "dynamic" {- This is a bad place for a comment -}
21+ dyn_gluBeginSurface
22+ :: FunPtr (Ptr GLUnurbs -> IO ())
23+ -- ^ This 'FunPtr' is extremely dangerous, beware
24+ -> Ptr GLUnurbs
25+ -> IO ()
data/examples/declaration/instance/associated-data-out.hs+3
@@ -3,6 +3,7 @@
33instance Foo Int where data Bar Int = IntBar Int Int
44
55instance Foo Double where
6+
67 newtype
78 Bar
89 Double
@@ -11,7 +12,9 @@ instance Foo Double where
1112 Double
1213
1314instance Foo [a] where
15+
1416 data Bar [a]
1517 = ListBar [Bar a]
18+
1619 data Baz [a]
1720 = ListBaz
data/examples/declaration/instance/associated-data.hs−1
@@ -13,7 +13,6 @@ instance Foo Double where
1313
1414instance Foo [a]
1515 where
16−
1716 data Bar [a] =
1817 ListBar [Bar a]
1918 data Baz [a] =
data/examples/declaration/instance/associated-types-out.hs+1
@@ -3,6 +3,7 @@
33instance Foo Int where type Bar Int = Double
44
55instance Foo Double where
6+
67 type
78 Bar
89 Double =
data/examples/declaration/instance/associated-types.hs−2
@@ -9,7 +9,5 @@ instance Foo Double
99 Double
1010 =
1111 [Double]
12−
13−
1412 type instance Baz Double
1513 = [Double]
data/examples/declaration/instance/contexts-comments-out.hsdeleted−17
@@ -1,17 +0,0 @@
1−instance
2− ( Read a, -- Foo
3− Read b,
4− Read
5− ( c, -- Bar
6− d
7− )
8− ) =>
9− Read
10− ( a, -- Baz
11− b,
12− ( c, -- Quux
13− d
14− )
15− )
16− where
17− readsPrec = undefined
data/examples/declaration/instance/contexts-comments.hsdeleted−18
@@ -1,18 +0,0 @@
1−instance (
2− Read a, -- Foo
3− Read b
4− , Read (
5− c, -- Bar
6− d
7− )
8− )
9− =>
10− Read (
11− a, -- Baz
12− b
13− ,(
14− c, -- Quux
15− d
16− )
17− ) where
18− readsPrec = undefined
data/examples/declaration/instance/contexts-out.hs+28−7
@@ -3,16 +3,37 @@ instance Eq a => Eq [a] where (==) _ _ = False
33instance
44 ( Ord a,
55 Ord b
6− ) =>
7− Ord (a, b)
6+ )
7+ => Ord (a, b)
88 where
9+
910 compare _ _ = GT
1011
1112instance
12− (Show a, Show b) =>
13− Show
14− ( a,
15− b
16− )
13+ (Show a, Show b)
14+ => Show
15+ ( a,
16+ b
17+ )
1718 where
19+
1820 showsPrec _ _ = showString ""
21+
22+instance
23+ ( Read a, -- Foo
24+ Read b,
25+ Read
26+ ( c, -- Bar
27+ d
28+ )
29+ )
30+ => Read
31+ ( a, -- Baz
32+ b,
33+ ( c, -- Quux
34+ d
35+ )
36+ )
37+ where
38+
39+ readsPrec = undefined
data/examples/declaration/instance/contexts.hs+19
@@ -12,3 +12,22 @@ instance (Show a, Show b) =>
1212 b
1313 ) where
1414 showsPrec _ _ = showString ""
15+
16+instance (
17+ Read a, -- Foo
18+ Read b
19+ , Read (
20+ c, -- Bar
21+ d
22+ )
23+ )
24+ =>
25+ Read (
26+ a, -- Baz
27+ b
28+ ,(
29+ c, -- Quux
30+ d
31+ )
32+ ) where
33+ readsPrec = undefined
data/examples/declaration/instance/data-family-instances-gadt-out.hsdeleted−13
@@ -1,13 +0,0 @@
1−{-# LANGUAGE GADTSyntax #-}
2−{-# LANGUAGE TypeFamilies #-}
3−
4−data instance Bar Int a where
5− SameBar ::
6− Bar
7− Int
8− Int
9− CloseBar :: Bar Int Double
10− OtherBar ::
11− Bar
12− Int
13− a
data/examples/declaration/instance/data-family-instances-gadt.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE GADTSyntax #-}
2−{-# LANGUAGE TypeFamilies #-}
3−data instance Bar Int a where
4− SameBar
5− :: Bar Int
6− Int
7− CloseBar :: Bar Int Double
8− OtherBar
9− :: Bar Int
10− a
data/examples/declaration/instance/data-family-instances-newtype-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−{-# LANGUAGE GADTSyntax #-}
2−{-# LANGUAGE TypeFamilies #-}
3−
4−newtype instance Foo [Double] = DoubleListFoo
5− { unDoubleListFoo :: Double
6− }
data/examples/declaration/instance/data-family-instances-newtype.hsdeleted−6
@@ -1,6 +0,0 @@
1−{-# LANGUAGE GADTSyntax #-}
2−{-# LANGUAGE TypeFamilies #-}
3−newtype instance Foo [Double] = DoubleListFoo {
4− unDoubleListFoo :: Double
5−}
6−
data/examples/declaration/instance/data-family-instances-out.hs+16−2
@@ -9,12 +9,26 @@ data instance
99 = IntListFoo
1010 ( Int,
1111 Int
12− )
12+ )
1313 ( Double,
1414 Double
15− )
15+ )
16+
17+newtype instance Foo [Double]
18+ = DoubleListFoo
19+ { unDoubleListFoo :: Double
20+ }
1621
1722data instance Bar Double a
1823 = DoubleBar
1924 Double
2025 (Bar a)
26+
27+data instance Bar Int a where
28+ SameBar
29+ :: Bar Int
30+ Int
31+ CloseBar :: Bar Int Double
32+ OtherBar
33+ :: Bar Int
34+ a
data/examples/declaration/instance/data-family-instances.hs+12
@@ -13,8 +13,20 @@ data instance
1313 Double
1414 )
1515
16+newtype instance Foo [Double] = DoubleListFoo {
17+ unDoubleListFoo :: Double
18+}
19+
1620data instance Bar Double a =
1721 DoubleBar
1822 Double
1923 (Bar a)
2024
25+data instance Bar Int a where
26+ SameBar
27+ :: Bar Int
28+ Int
29+ CloseBar :: Bar Int Double
30+ OtherBar
31+ :: Bar Int
32+ a
data/examples/declaration/instance/instance-sigs-multiple-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE InstanceSigs #-}
2−
3−instance Applicative [] where
4− pure ::
5− a ->
6− [a]
7− pure a = [a]
8− (<*>) ::
9− [a] -> [a] -> [a]
10− (<*>) _ _ = []
data/examples/declaration/instance/instance-sigs-multiple.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE InstanceSigs #-}
2−
3−instance Applicative [] where
4− pure ::
5− a
6− -> [a]
7− pure a = [a]
8− (<*>)
9− :: [ a ] -> [ a ] -> [ a ]
10− (<*>) _ _ = []
data/examples/declaration/instance/instance-sigs-out.hs+17−4
@@ -1,15 +1,28 @@
11{-# LANGUAGE InstanceSigs #-}
22
33instance Eq Int where
4+
45 (==) :: Int -> Int -> Bool
56 (==) _ _ = False
67
78instance Ord Int where
8− compare ::
9− Int ->
10− Int ->
11− Ordering
9+
10+ compare
11+ :: Int
12+ -> Int
13+ -> Ordering
1214 compare
1315 _
1416 _ =
1517 GT
18+
19+instance Applicative [] where
20+
21+ pure
22+ :: a
23+ -> [a]
24+ pure a = [a]
25+
26+ (<*>)
27+ :: [a] -> [a] -> [a]
28+ (<*>) _ _ = []
data/examples/declaration/instance/instance-sigs.hs+9
@@ -14,3 +14,12 @@ instance Ord Int where
1414 _
1515 _
1616 = GT
17+
18+instance Applicative [] where
19+ pure ::
20+ a
21+ -> [a]
22+ pure a = [a]
23+ (<*>)
24+ :: [ a ] -> [ a ] -> [ a ]
25+ (<*>) _ _ = []
data/examples/declaration/instance/multi-parameter-out.hs+2
@@ -1,5 +1,7 @@
11instance MonadReader a ((->) a) where ask = id
22
33instance MonadState s (State s) where
4+
45 get = State.get
6+
57 put = State.put
data/examples/declaration/instance/newlines-after-where-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−instance Num X where
2− (+) = undefined
3−
4−instance Num Y where
5− (+) = undefined
data/examples/declaration/instance/newlines-after-where.hsdeleted−7
@@ -1,7 +0,0 @@
1−instance Num X where
2− (+) = undefined
3−
4−instance Num Y where
5−
6−
7− (+) = undefined
data/examples/declaration/instance/newlines-between-methods-out.hsdeleted−18
@@ -1,18 +0,0 @@
1−instance Num a => Num (Diff a) where
2− D u dudx + D v dvdx = D (u + v) (dudx + dvdx)
3− D u dudx - D v dvdx = D (u - v) (dudx - dvdx)
4− D u dudx * D v dvdx = D (u * v) (u * dvdx + v * dudx)
5−
6− -- Comment before definition
7− negate (D u dudx) = D (- u) (- dudx)
8− negate (Z u dudx) = undefined
9−
10− -- Comment after definition
11−
12− -- Separator
13−
14− abs (D u _) = D (abs u) (signum u)
15− signum (D u _) = D (signum u) 0
16−
17− -- Comment between unrelated definitions
18− fromInteger n = D (fromInteger n) 0
data/examples/declaration/instance/newlines-between-methods.hsdeleted−16
@@ -1,16 +0,0 @@
1−instance Num a => Num (Diff a) where
2− D u dudx + D v dvdx = D (u + v) (dudx + dvdx)
3− D u dudx - D v dvdx = D (u - v) (dudx - dvdx)
4− D u dudx * D v dvdx = D (u * v) (u * dvdx + v * dudx)
5−
6− -- Comment before definition
7− negate (D u dudx) = D (-u) (-dudx)
8− negate (Z u dudx) = undefined
9− -- Comment after definition
10−
11− -- Separator
12−
13− abs (D u _) = D (abs u) (signum u)
14− signum (D u _) = D (signum u) 0
15− -- Comment between unrelated definitions
16− fromInteger n = D (fromInteger n) 0
data/examples/declaration/instance/overlappable-instances-out.hs+3
@@ -1,9 +1,11 @@
11instance {-# OVERLAPPABLE #-} Eq Int where (==) _ _ = False
22
33instance {-# OVERLAPPING #-} Ord Int where
4+
45 compare _ _ = GT
56
67instance {-# OVERLAPS #-} Eq Double where
8+
79 (==) _ _ = False
810
911instance
@@ -11,4 +13,5 @@ instance
1113 Ord
1214 Double
1315 where
16+
1417 compare _ _ = GT
data/examples/declaration/instance/single-parameter-out.hs+2
@@ -1,7 +1,9 @@
11instance Monoid Int where (<>) x y = x + y
22
33instance Enum Int where
4+
45 fromEnum x = x
6+
57 toEnum =
68 \x ->
79 x
data/examples/declaration/instance/type-family-instances-out.hs+2−2
@@ -7,7 +7,7 @@ type instance
77 [Int] =
88 ( Int,
99 Int
10− )
10+ )
1111
1212type instance Bar Int [Int] Double = (Int, Double)
1313
@@ -18,4 +18,4 @@ type instance
1818 Double =
1919 ( Int,
2020 Double
21− )
21+ )
data/examples/declaration/rewrite-rule/basic2-out.hs → data/examples/declaration/rewrite-rule/basic-out.hsrenamed+19
@@ -1,3 +1,22 @@
1+{-# RULES
2+"fold/build" foldr k z (build g) = g k z
3+ #-}
4+
5+{-# RULES
6+"fusable/aux"
7+ fusable x (aux y) =
8+ faux x y
9+ #-}
10+
11+{-# RULES
12+"map/map"
13+ map f
14+ (map g xs) =
15+ map
16+ (f . g)
17+ xs
18+ #-}
19+
120{-# RULES
221"++" xs ++ ys = augment (\c n -> foldr c n xs) ys
322"concat" xs `concat` ys = augment (\c n -> foldr c n xs) ys
data/examples/declaration/rewrite-rule/basic2.hs → data/examples/declaration/rewrite-rule/basic.hsrenamed+17
@@ -1,3 +1,20 @@
1+{-# RULES
2+"fold/build" foldr k z (build g) = g k z
3+ #-}
4+
5+{-# RULES
6+"fusable/aux"
7+ fusable x (aux y) = faux x y
8+ #-}
9+
10+{-# RULES
11+"map/map"
12+ map f
13+ (map g xs) = map
14+ (f . g)
15+ xs
16+ #-}
17+
118{-# RULES
219"++" xs ++ ys = augment (\c n -> foldr c n xs) ys
320"concat" xs `concat` ys = augment (\c n -> foldr c n xs) ys
data/examples/declaration/rewrite-rule/basic1-out.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# RULES
2−"fold/build" foldr k z (build g) = g k z
3− #-}
4−
5−{-# RULES
6−"fusable/aux"
7− fusable x (aux y) =
8− faux x y
9− #-}
10−
11−{-# RULES
12−"map/map"
13− map
14− f
15− (map g xs) =
16− map
17− (f . g)
18− xs
19− #-}
data/examples/declaration/rewrite-rule/basic1.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# RULES
2−"fold/build" foldr k z (build g) = g k z
3− #-}
4−
5−{-# RULES
6−"fusable/aux"
7− fusable x (aux y) = faux x y
8− #-}
9−
10−{-# RULES
11−"map/map"
12− map f
13− (map g xs) = map
14− (f . g)
15− xs
16− #-}
17−
data/examples/declaration/rewrite-rule/forall-1-out.hsdeleted−23
@@ -1,23 +0,0 @@
1−{-# RULES "rd_tyvs" forall a. forall (x :: a). id x = x #-}
2−
3−{-# RULES "rd_tyvs'" forall f a. forall (x :: f a). id x = x #-}
4−
5−{-# RULES "rd_tyvs''" forall (a :: *). forall (x :: a). id x = x #-}
6−
7−{-# RULES
8−"rd_tyvs_multiline1" forall (a :: *). forall (x :: a).
9− id x =
10− x
11− #-}
12−
13−{-# RULES
14−"rd_tyvs_multiline2" forall
15− ( a ::
16− *
17− ). forall
18− ( x ::
19− a
20− ).
21− id x =
22− x
23− #-}
data/examples/declaration/rewrite-rule/forall-1.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# RULES "rd_tyvs" forall a. forall (x :: a). id x = x #-}
2−
3−{-# RULES "rd_tyvs'" forall f a. forall (x :: f a). id x = x #-}
4−
5−{-# RULES "rd_tyvs''" forall (a :: *). forall (x :: a). id x = x #-}
6−
7−{-# RULES "rd_tyvs_multiline1"
8− forall (a :: *).
9− forall (x :: a).
10− id x = x #-}
11−
12−{-# RULES "rd_tyvs_multiline2"
13− forall (a ::
14− *).
15− forall (x ::
16− a).
17− id x = x #-}
data/examples/declaration/rewrite-rule/forall-0-out.hs → data/examples/declaration/rewrite-rule/forall-out.hsrenamed

The content is the same.

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

The content is the same.

data/examples/declaration/rewrite-rule/phase-out.hs+2−4
@@ -1,7 +1,6 @@
11{-# RULES
22"map/map" [2]
3− map
4− f
3+ map f
54 (map g xs) =
65 map
76 (f . g)
@@ -10,8 +9,7 @@
109
1110{-# RULES
1211"map/map" [1] forall x y z.
13− map
14− f
12+ map f
1513 (map g xs) =
1614 map
1715 (f . g)
data/examples/declaration/rewrite-rule/prelude-out.hsnew file+74
@@ -0,0 +1,74 @@
1+{-# LANGUAGE MagicHash #-}
2+
3+{-# RULES
4+"map/map" forall f g xs. map f (map g xs) = map (f . g) xs
5+"map/append" forall f xs ys. map f (xs ++ ys) = map f xs ++ map f ys
6+ #-}
7+
8+{-# RULES
9+"fold/build" forall k z (g :: forall b. (a -> b -> b) -> b -> b).
10+ foldr k z (build g) =
11+ g k z
12+"foldr/augment" forall k z xs (g :: forall b. (a -> b -> b) -> b -> b).
13+ foldr k z (augment g xs) =
14+ g k (foldr k z xs)
15+"foldr/id" foldr (:) [] = \x -> x
16+"foldr/app" [1] forall ys. foldr (:) ys = \xs -> xs ++ ys
17+-- Only activate this from phase 1, because that's
18+-- when we disable the rule that expands (++) into foldr
19+
20+-- The foldr/cons rule looks nice, but it can give disastrously
21+-- bloated code when commpiling
22+-- array (a,b) [(1,2), (2,2), (3,2), ...very long list... ]
23+-- i.e. when there are very very long literal lists
24+-- So I've disabled it for now. We could have special cases
25+-- for short lists, I suppose.
26+-- "foldr/cons" forall k z x xs. foldr k z (x:xs) = k x (foldr k z xs)
27+"foldr/single" forall k z x. foldr k z [x] = k x z
28+"foldr/nil" forall k z. foldr k z [] = z
29+"augment/build" forall
30+ (g :: forall b. (a -> b -> b) -> b -> b)
31+ (h :: forall b. (a -> b -> b) -> b -> b).
32+ augment g (build h) =
33+ build (\c n -> g c (h c n))
34+"augment/nil" forall (g :: forall b. (a -> b -> b) -> b -> b).
35+ augment g [] =
36+ build g
37+ #-}
38+
39+{-# RULES
40+"map" [~1] forall f xs. map f xs = build (\c n -> foldr (mapFB c f) n xs)
41+"mapList" [1] forall f. foldr (mapFB (:) f) [] = map f
42+"mapFB" forall c f g. mapFB (mapFB c f) g = mapFB c (f . g)
43+ #-}
44+
45+{-# RULES
46+"map/map" [~2] forall f g xs.
47+ map f (map g xs) =
48+ map (f . g) xs
49+"f" op True y = False
50+"g" op True y = False
51+ #-}
52+
53+{-# RULES
54+"x# `eqChar#` x#" forall x#. x# `eqChar#` x# = True
55+"x# `neChar#` x#" forall x#. x# `neChar#` x# = False
56+"x# `gtChar#` x#" forall x#. x# `gtChar#` x# = False
57+"x# `geChar#` x#" forall x#. x# `geChar#` x# = True
58+"x# `leChar#` x#" forall x#. x# `leChar#` x# = True
59+"x# `ltChar#` x#" forall x#. x# `ltChar#` x# = False
60+ #-}
61+
62+{-# RULES
63+"unpack" [~1] forall a. unpackCString# a = build (unpackFoldrCString# a)
64+"unpack-list" [1] forall a. unpackFoldrCString# a (:) [] = unpackCString# a
65+"unpack-append" forall a n. unpackFoldrCString# a (:) n = unpackAppendCString# a n
66+-- There's a built-in rule (in PrelRules.lhs) for
67+-- unpackFoldr "foo" c (unpackFoldr "baz" c n) = unpackFoldr "foobaz" c n
68+ #-}
69+
70+{-# RULES
71+"foldr/build" forall f n (g :: forall b. (a -> b -> b) -> b -> b).
72+ foldr f n (build g) =
73+ g f n
74+ #-}
data/examples/declaration/rewrite-rule/prelude.hsnew file+73
@@ -0,0 +1,73 @@
1+{-# LANGUAGE MagicHash #-}
2+
3+{-# RULES
4+"map/map" forall f g xs. map f (map g xs) = map (f.g) xs
5+"map/append" forall f xs ys. map f (xs ++ ys) = map f xs ++ map f ys
6+ #-}
7+
8+{-# RULES
9+"fold/build" forall k z (g::forall b. (a->b->b) -> b -> b) .
10+ foldr k z (build g) = g k z
11+
12+"foldr/augment" forall k z xs (g::forall b. (a->b->b) -> b -> b) .
13+ foldr k z (augment g xs) = g k (foldr k z xs)
14+
15+"foldr/id" foldr (:) [] = \x -> x
16+"foldr/app" [1] forall ys. foldr (:) ys = \xs -> xs ++ ys
17+ -- Only activate this from phase 1, because that's
18+ -- when we disable the rule that expands (++) into foldr
19+
20+-- The foldr/cons rule looks nice, but it can give disastrously
21+-- bloated code when commpiling
22+-- array (a,b) [(1,2), (2,2), (3,2), ...very long list... ]
23+-- i.e. when there are very very long literal lists
24+-- So I've disabled it for now. We could have special cases
25+-- for short lists, I suppose.
26+-- "foldr/cons" forall k z x xs. foldr k z (x:xs) = k x (foldr k z xs)
27+
28+"foldr/single" forall k z x. foldr k z [x] = k x z
29+"foldr/nil" forall k z. foldr k z [] = z
30+
31+"augment/build" forall (g::forall b. (a->b->b) -> b -> b)
32+ (h::forall b. (a->b->b) -> b -> b) .
33+ augment g (build h) = build (\c n -> g c (h c n))
34+"augment/nil" forall (g::forall b. (a->b->b) -> b -> b) .
35+ augment g [] = build g
36+ #-}
37+
38+{-# RULES
39+"map" [~1] forall f xs. map f xs = build (\c n -> foldr (mapFB c f) n xs)
40+"mapList" [1] forall f. foldr (mapFB (:) f) [] = map f
41+"mapFB" forall c f g. mapFB (mapFB c f) g = mapFB c (f.g)
42+ #-}
43+
44+{-# RULES
45+ "map/map" [~2] forall f g xs.
46+ map f (map g xs) = map (f.g) xs; "f" op True y = False;
47+ "g" op True y = False
48+#-}
49+
50+{-# RULES
51+"x# `eqChar#` x#" forall x#. x# `eqChar#` x# = True
52+"x# `neChar#` x#" forall x#. x# `neChar#` x# = False
53+"x# `gtChar#` x#" forall x#. x# `gtChar#` x# = False
54+"x# `geChar#` x#" forall x#. x# `geChar#` x# = True
55+"x# `leChar#` x#" forall x#. x# `leChar#` x# = True
56+"x# `ltChar#` x#" forall x#. x# `ltChar#` x# = False
57+ #-}
58+
59+{-# RULES
60+"unpack" [~1] forall a . unpackCString# a = build (unpackFoldrCString# a)
61+"unpack-list" [1] forall a . unpackFoldrCString# a (:) [] = unpackCString# a
62+"unpack-append" forall a n . unpackFoldrCString# a (:) n = unpackAppendCString# a n
63+
64+-- There's a built-in rule (in PrelRules.lhs) for
65+-- unpackFoldr "foo" c (unpackFoldr "baz" c n) = unpackFoldr "foobaz" c n
66+
67+ #-}
68+
69+{-# RULES
70+ "foldr/build"
71+ forall f n (g :: forall b. (a -> b -> b) -> b -> b).
72+ foldr f n (build g) = g f n
73+#-}
data/examples/declaration/rewrite-rule/prelude1-out.hsdeleted−18
@@ -1,18 +0,0 @@
1−{-# RULES
2−"map/map" forall f g xs. map f (map g xs) = map (f . g) xs
3−"map/append" forall f xs ys. map f (xs ++ ys) = map f xs ++ map f ys
4− #-}
5−
6−{-# RULES
7−"map" [~1] forall f xs. map f xs = build (\c n -> foldr (mapFB c f) n xs)
8−"mapList" [1] forall f. foldr (mapFB (:) f) [] = map f
9−"mapFB" forall c f g. mapFB (mapFB c f) g = mapFB c (f . g)
10− #-}
11−
12−{-# RULES
13−"map/map" [~2] forall f g xs.
14− map f (map g xs) =
15− map (f . g) xs
16−"f" op True y = False
17−"g" op True y = False
18− #-}
data/examples/declaration/rewrite-rule/prelude1.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# RULES
2−"map/map" forall f g xs. map f (map g xs) = map (f.g) xs
3−"map/append" forall f xs ys. map f (xs ++ ys) = map f xs ++ map f ys
4− #-}
5−
6−{-# RULES
7−"map" [~1] forall f xs. map f xs = build (\c n -> foldr (mapFB c f) n xs)
8−"mapList" [1] forall f. foldr (mapFB (:) f) [] = map f
9−"mapFB" forall c f g. mapFB (mapFB c f) g = mapFB c (f.g)
10− #-}
11−
12−{-# RULES
13− "map/map" [~2] forall f g xs.
14− map f (map g xs) = map (f.g) xs; "f" op True y = False;
15− "g" op True y = False
16−#-}
17−
data/examples/declaration/rewrite-rule/prelude2-out.hsdeleted−31
@@ -1,31 +0,0 @@
1−{-# RULES
2−"fold/build" forall k z (g :: forall b. (a -> b -> b) -> b -> b).
3− foldr k z (build g) =
4− g k z
5−"foldr/augment" forall k z xs (g :: forall b. (a -> b -> b) -> b -> b).
6− foldr k z (augment g xs) =
7− g k (foldr k z xs)
8−"foldr/id" foldr (:) [] = \x -> x
9−"foldr/app" [1] forall ys. foldr (:) ys = \xs -> xs ++ ys
10−-- Only activate this from phase 1, because that's
11−-- when we disable the rule that expands (++) into foldr
12−
13−-- The foldr/cons rule looks nice, but it can give disastrously
14−-- bloated code when commpiling
15−-- array (a,b) [(1,2), (2,2), (3,2), ...very long list... ]
16−-- i.e. when there are very very long literal lists
17−-- So I've disabled it for now. We could have special cases
18−-- for short lists, I suppose.
19−-- "foldr/cons" forall k z x xs. foldr k z (x:xs) = k x (foldr k z xs)
20−
21−"foldr/single" forall k z x. foldr k z [x] = k x z
22−"foldr/nil" forall k z. foldr k z [] = z
23−"augment/build" forall
24− (g :: forall b. (a -> b -> b) -> b -> b)
25− (h :: forall b. (a -> b -> b) -> b -> b).
26− augment g (build h) =
27− build (\c n -> g c (h c n))
28−"augment/nil" forall (g :: forall b. (a -> b -> b) -> b -> b).
29− augment g [] =
30− build g
31− #-}
data/examples/declaration/rewrite-rule/prelude2.hsdeleted−29
@@ -1,29 +0,0 @@
1−{-# RULES
2−"fold/build" forall k z (g::forall b. (a->b->b) -> b -> b) .
3− foldr k z (build g) = g k z
4−
5−"foldr/augment" forall k z xs (g::forall b. (a->b->b) -> b -> b) .
6− foldr k z (augment g xs) = g k (foldr k z xs)
7−
8−"foldr/id" foldr (:) [] = \x -> x
9−"foldr/app" [1] forall ys. foldr (:) ys = \xs -> xs ++ ys
10− -- Only activate this from phase 1, because that's
11− -- when we disable the rule that expands (++) into foldr
12−
13−-- The foldr/cons rule looks nice, but it can give disastrously
14−-- bloated code when commpiling
15−-- array (a,b) [(1,2), (2,2), (3,2), ...very long list... ]
16−-- i.e. when there are very very long literal lists
17−-- So I've disabled it for now. We could have special cases
18−-- for short lists, I suppose.
19−-- "foldr/cons" forall k z x xs. foldr k z (x:xs) = k x (foldr k z xs)
20−
21−"foldr/single" forall k z x. foldr k z [x] = k x z
22−"foldr/nil" forall k z. foldr k z [] = z
23−
24−"augment/build" forall (g::forall b. (a->b->b) -> b -> b)
25− (h::forall b. (a->b->b) -> b -> b) .
26− augment g (build h) = build (\c n -> g c (h c n))
27−"augment/nil" forall (g::forall b. (a->b->b) -> b -> b) .
28− augment g [] = build g
29− #-}
data/examples/declaration/rewrite-rule/prelude3-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE MagicHash #-}
2−
3−{-# RULES
4−"x# `eqChar#` x#" forall x#. x# `eqChar#` x# = True
5−"x# `neChar#` x#" forall x#. x# `neChar#` x# = False
6−"x# `gtChar#` x#" forall x#. x# `gtChar#` x# = False
7−"x# `geChar#` x#" forall x#. x# `geChar#` x# = True
8−"x# `leChar#` x#" forall x#. x# `leChar#` x# = True
9−"x# `ltChar#` x#" forall x#. x# `ltChar#` x# = False
10− #-}
data/examples/declaration/rewrite-rule/prelude3.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE MagicHash #-}
2−
3−{-# RULES
4−"x# `eqChar#` x#" forall x#. x# `eqChar#` x# = True
5−"x# `neChar#` x#" forall x#. x# `neChar#` x# = False
6−"x# `gtChar#` x#" forall x#. x# `gtChar#` x# = False
7−"x# `geChar#` x#" forall x#. x# `geChar#` x# = True
8−"x# `leChar#` x#" forall x#. x# `leChar#` x# = True
9−"x# `ltChar#` x#" forall x#. x# `ltChar#` x# = False
10− #-}
data/examples/declaration/rewrite-rule/prelude4-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−{-# RULES
2−"unpack" [~1] forall a. unpackCString # a = build (unpackFoldrCString # a)
3−"unpack-list" [1] forall a. unpackFoldrCString # a (:) [] = unpackCString # a
4−"unpack-append" forall a n. unpackFoldrCString # a (:) n = unpackAppendCString # a n
5−-- There's a built-in rule (in PrelRules.lhs) for
6−-- unpackFoldr "foo" c (unpackFoldr "baz" c n) = unpackFoldr "foobaz" c n
7− #-}
data/examples/declaration/rewrite-rule/prelude4.hsdeleted−9
@@ -1,9 +0,0 @@
1−{-# RULES
2−"unpack" [~1] forall a . unpackCString# a = build (unpackFoldrCString# a)
3−"unpack-list" [1] forall a . unpackFoldrCString# a (:) [] = unpackCString# a
4−"unpack-append" forall a n . unpackFoldrCString# a (:) n = unpackAppendCString# a n
5−
6−-- There's a built-in rule (in PrelRules.lhs) for
7−-- unpackFoldr "foo" c (unpackFoldr "baz" c n) = unpackFoldr "foobaz" c n
8−
9− #-}
data/examples/declaration/rewrite-rule/type-signature-out.hs+5−6
@@ -6,12 +6,11 @@
66"fold/build" forall
77 k
88 z
9− ( g ::
10− forall b.
11− (a -> b -> b) ->
12− b ->
13− b
14− ).
9+ ( g
10+ :: forall b. (a -> b -> b)
11+ -> b
12+ -> b
13+ ).
1514 foldr k z (build g) =
1615 g k z
1716 #-}
data/examples/declaration/role-annotation/multi-line-out.hsdeleted−15
@@ -1,15 +0,0 @@
1−type role
2− D
3− phantom
4− nominal
5−
6−type role
7− E
8− _
9− nominal
10−
11−type role
12− E
13− _
14− nominal
15− phantom
data/examples/declaration/role-annotation/multi-line.hsdeleted−15
@@ -1,15 +0,0 @@
1−type role
2− D phantom nominal
3−
4−type
5− role
6− E
7− _
8− nominal
9−
10−type
11− role
12− E
13− _
14− nominal
15− phantom
data/examples/declaration/role-annotation/single-line-out.hs → data/examples/declaration/role-annotation/simple-out.hsrenamed+16
@@ -8,3 +8,19 @@ type role A nominal nominal
88type role B _ phantom
99
1010type role C _ _
11+
12+type role
13+ D
14+ phantom
15+ nominal
16+
17+type role
18+ E
19+ _
20+ nominal
21+
22+type role
23+ E
24+ _
25+ nominal
26+ phantom
data/examples/declaration/role-annotation/single-line.hs → data/examples/declaration/role-annotation/simple.hsrenamed+16
@@ -7,3 +7,19 @@ type role A nominal nominal
77
88type role B _ phantom
99type role C _ _
10+
11+type role
12+ D phantom nominal
13+
14+type
15+ role
16+ E
17+ _
18+ nominal
19+
20+type
21+ role
22+ E
23+ _
24+ nominal
25+ phantom
data/examples/declaration/signature/complete/complete-out.hs+2−2
@@ -5,6 +5,6 @@
55{-# COMPLETE
66 A,
77 B,
8− C ::
9− Foo
8+ C
9+ :: Foo
1010 #-}
data/examples/declaration/signature/inline/inline-out.hs−4
@@ -9,7 +9,3 @@ bar = id
99baz :: Int -> Int
1010baz = id
1111{-# INLINE [~2] baz #-}
12−
13−reVector :: Bundle u a -> Bundle v a
14−{-# INLINE reVector #-}
15−reVector = M.reVector
data/examples/declaration/signature/inline/inline.hs−5
@@ -11,8 +11,3 @@ bar = id
1111baz :: Int -> Int
1212baz = id
1313{-# INLINE [~2] baz #-}
14−
15−reVector :: Bundle u a -> Bundle v a
16−
17−{-# INLINE reVector #-}
18−reVector = M.reVector
data/examples/declaration/signature/minimal/minimal-out.hs+3−1
@@ -1,4 +1,5 @@
11class Foo a where
2+
23 {-# MINIMAL (==) | ((/=), foo) #-}
34
45 {-# MINIMAL
@@ -6,9 +7,10 @@ class Foo a where
67 | ( b, c, d
78 | e,
89 f
9− )
10+ )
1011 | g
1112 #-}
1213
1314 (==) :: a -> a -> Bool
15+
1416 (/=) :: a -> a -> Bool
data/examples/declaration/signature/pattern/multiline-out.hs+4−17
@@ -1,19 +1,6 @@
11{-# LANGUAGE PatternSynonyms #-}
22
3−pattern Arrow ::
4− Type ->
5− Type ->
6− Type
7−
8−pattern
9− Foo,
10− Bar ::
11− Type -> Type -> Type
12−
13−pattern
14− TypeSignature,
15− FunctionBody,
16− PatternSignature,
17− WarningPragma ::
18− [RdrName] ->
19− HsDecl GhcPs
3+pattern Arrow
4+ :: Type
5+ -> Type
6+ -> Type
data/examples/declaration/signature/pattern/multiline.hs−10
@@ -1,13 +1,3 @@
11{-# LANGUAGE PatternSynonyms #-}
2−
32pattern Arrow :: Type
43 -> Type -> Type
5−
6−pattern Foo, Bar ::
7− Type -> Type -> Type
8−
9−pattern TypeSignature
10− , FunctionBody
11− , PatternSignature
12− , WarningPragma :: [RdrName]
13− -> HsDecl GhcPs
data/examples/declaration/signature/pattern/single-line-out.hs−2
@@ -1,5 +1,3 @@
11{-# LANGUAGE PatternSynonyms #-}
22
33pattern Arrow :: Type -> Type -> Type
4−
5−pattern Foo, Bar :: Type -> Type -> Type
data/examples/declaration/signature/pattern/single-line.hs−2
@@ -1,5 +1,3 @@
11{-# LANGUAGE PatternSynonyms #-}
22
33pattern Arrow :: Type -> Type -> Type
4−
5−pattern Foo, Bar :: Type -> Type -> Type
data/examples/declaration/signature/specialize/specialize-instance-out.hs+5−1
@@ -3,12 +3,16 @@ data Foo a = Foo a
33data VT v m r = VT v m r
44
55instance (Eq a) => Eq (Foo a) where
6+
67 {-# SPECIALIZE instance Eq (Foo [(Int, Bar)]) #-}
8+
79 (==) (Foo a) (Foo b) = (==) a b
810
911instance (Num r, V.Vector v r, Factored m r) => Num (VT v m r) where
12+
1013 {-# SPECIALIZE instance
1114 ( Factored m Int => Num (VT U.Vector m Int)
12− )
15+ )
1316 #-}
17+
1418 VT x + VT y = VT $ V.zipWith (+) x y
data/examples/declaration/signature/specialize/specialize-out.hs+6−6
@@ -9,15 +9,15 @@ bar = id
99
1010baz :: Num a => a -> a
1111baz = id
12−{-# SPECIALIZE [~2] baz ::
13− Int ->
14− Int
12+{-# SPECIALIZE [~2] baz
13+ :: Int
14+ -> Int
1515 #-}
1616
1717{-# SPECIALIZE fits13Bits :: Int -> Bool, Integer -> Bool #-}
18−{-# SPECIALIZE fits13Bits ::
19− Int ->
20− Bool,
18+{-# SPECIALIZE fits13Bits
19+ :: Int
20+ -> Bool,
2121 Integer -> Bool
2222 #-}
2323fits13Bits :: Integral a => a -> Bool
data/examples/declaration/signature/standalone-kind-out.hsdeleted−13
@@ -1,13 +0,0 @@
1−{-# LANGUAGE StandaloneKindSignatures #-}
2−
3−type T ::
4− (k -> Type) ->
5− k ->
6− Type
7−data T m a = MkT (m a) (T Maybe (m a))
8−
9−type C1 :: Type -> Constraint
10−class C1 a
11−
12−type F :: Type -> Type
13−type family F
data/examples/declaration/signature/standalone-kind.hsdeleted−13
@@ -1,13 +0,0 @@
1−{-# LANGUAGE StandaloneKindSignatures #-}
2−
3−type T :: (k -> Type)
4− -> k
5− -> Type
6−
7−data T m a = MkT (m a) (T Maybe (m a))
8−
9−type C1 :: Type -> Constraint
10−class C1 a
11−
12−type F :: Type -> Type
13−type family F
data/examples/declaration/signature/type/arguments-out.hs+13−14
@@ -1,16 +1,15 @@
11{-# LANGUAGE RankNTypes #-}
22
3−functionName ::
4− (C1, C2, C3, C4, C5) =>
5− a ->
6− b ->
7− ( forall a.
8− (C6, C7) =>
9− LongDataTypeName ->
10− a ->
11− AnotherLongDataTypeName ->
12− b ->
13− c
14− ) ->
15− (c -> d) ->
16− (a, b, c, d)
3+functionName
4+ :: (C1, C2, C3, C4, C5)
5+ => a
6+ -> b
7+ -> ( forall a. (C6, C7)
8+ => LongDataTypeName
9+ -> a
10+ -> AnotherLongDataTypeName
11+ -> b
12+ -> c
13+ )
14+ -> (c -> d)
15+ -> (a, b, c, d)
data/examples/declaration/signature/type/context-multi-line-out.hs+10−10
@@ -1,10 +1,10 @@
1−functionName ::
2− ( C1,
3− C2,
4− C3
5− ) =>
6− a ->
7− b ->
8− c ->
9− d ->
10− (a, b, c, d)
1+functionName
2+ :: ( C1,
3+ C2,
4+ C3
5+ )
6+ => a
7+ -> b
8+ -> c
9+ -> d
10+ -> (a, b, c, d)
data/examples/declaration/signature/type/context-single-line-out.hs+7−7
@@ -1,7 +1,7 @@
1−functionName ::
2− (C1, C2, C3) =>
3− a ->
4− b ->
5− c ->
6− d ->
7− (a, b, c, d)
1+functionName
2+ :: (C1, C2, C3)
3+ => a
4+ -> b
5+ -> c
6+ -> d
7+ -> (a, b, c, d)
data/examples/declaration/signature/type/infix-promoted-type-constructor-out.hs+1
@@ -1,2 +1,3 @@
11fun1 :: Def ('[Ref s (Stored Uint32), IBool] 'T.:-> IBool)
2+
23fun2 :: Def ('[Ref s (Stored Uint32), IBool] ':-> IBool)
data/examples/declaration/signature/type/long-function-name-out.hs+6−6
@@ -1,6 +1,6 @@
1−longFunctionName ::
2− a ->
3− b ->
4− c ->
5− d ->
6− (a, b, c, d)
1+longFunctionName
2+ :: a
3+ -> b
4+ -> c
5+ -> d
6+ -> (a, b, c, d)
data/examples/declaration/signature/type/long-multiline-applications-out.hs+15−16
@@ -1,16 +1,15 @@
1−functionName ::
2− (C1, C2, C3, C4, C5) =>
3− forall a b c.
4− a ->
5− b ->
6− ( LongDataTypeName
7− AnotherLongDataTypeName
8− AnotherLongDataTypeName2
9− AnotherLongDataTypeName3 ->
10− a ->
11− AnotherLongDataTypeName4 ->
12− b ->
13− c
14− ) ->
15− (c -> d) ->
16− (a, b, c, d)
1+functionName
2+ :: (C1, C2, C3, C4, C5)
3+ => a
4+ -> b
5+ -> ( LongDataTypeName
6+ AnotherLongDataTypeName
7+ AnotherLongDataTypeName2
8+ AnotherLongDataTypeName3
9+ -> a
10+ -> AnotherLongDataTypeName4
11+ -> b
12+ -> c
13+ )
14+ -> (c -> d)
15+ -> (a, b, c, d)
data/examples/declaration/signature/type/long-multiline-applications.hs+1−2
@@ -1,7 +1,6 @@
11functionName
22 :: (C1, C2, C3, C4, C5)
3− => forall a b c
4− . a
3+ => a
54 -> b
65 -> ( LongDataTypeName
76 AnotherLongDataTypeName
data/examples/declaration/signature/type/multi-value-out.hs+2−11
@@ -1,15 +1,6 @@
11foo, bar :: Int
2−foo = 1
3−bar = 2
4−
5−a, b, c :: Int
6−a = 1
7−b = 2
8−c = 3
92
103foo,
114 bar,
12− baz ::
13− Int
14−bar = 2
15−baz = 3
5+ baz
6+ :: Int
data/examples/declaration/signature/type/multi-value.hs−9
@@ -1,14 +1,5 @@
11foo, bar :: Int
2−foo = 1
3−bar = 2
4−
5−a, b, c :: Int
6−a = 1
7−b = 2
8−c = 3
92
103foo,
114 bar,
125 baz :: Int
13−bar = 2
14−baz = 3
data/examples/declaration/signature/type/unicode-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−{-# LANGUAGE UnicodeSyntax #-}
2−
3−foo :: forall a. Show a => a -> String
4−foo = const ()
data/examples/declaration/signature/type/unicode.hsdeleted−4
@@ -1,4 +0,0 @@
1−{-# LANGUAGE UnicodeSyntax #-}
2−
3−foo ∷ ∀a. Show a ⇒ a → String
4−foo = const ()
data/examples/declaration/signature/type/unrelated-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−clientFunc1 :: SomeType1
2−clientFunc2 :: SomeType2
3−clientFunc3 :: SomeType3
4−clientFunc1 :<|> clientFunc2 :<|> clientFunc3 = hoistClient foo bar baz
data/examples/declaration/signature/type/unrelated.hsdeleted−4
@@ -1,4 +0,0 @@
1−clientFunc1 :: SomeType1
2−clientFunc2 :: SomeType2
3−clientFunc3 :: SomeType3
4−clientFunc1 :<|> clientFunc2 :<|> clientFunc3 = hoistClient foo bar baz
data/examples/declaration/splice/bracket-declaration-out.hsdeleted−26
@@ -1,26 +0,0 @@
1−{-# LANGUAGE TemplateHaskell #-}
2−
3−[d|data T a where Foo :: T ()|]
4−
5−foo =
6− [d|
7− foo :: Int -> Char
8−
9− bar = 42
10− |]
11−
12−[d|
13− data T = T
14− deriving (Eq, Ord, Enum, Bounded, Show)
15− |]
16−
17−$(do [d|baz = baz|])
18−
19−$(singletons [d|data T = T deriving (Eq, Ord, Enum, Bounded, Show)|])
20−
21−$( singletons
22− [d|
23− data T = T
24− deriving (Eq, Ord, Enum, Bounded, Show)
25− |]
26− )
data/examples/declaration/splice/bracket-declaration.hsdeleted−22
@@ -1,22 +0,0 @@
1−{-# LANGUAGE TemplateHaskell #-}
2−
3−[d| data T a where Foo :: T () |]
4−
5−foo = [d|
6− foo:: Int -> Char
7− bar = 42
8− |]
9−
10−[d|
11− data T = T
12− deriving (Eq, Ord, Enum, Bounded, Show)
13− |]
14−
15−$( do [d| baz = baz |] )
16−
17−$(singletons [d| data T = T deriving (Eq, Ord, Enum, Bounded, Show) |])
18−
19−$(singletons [d|
20− data T = T
21− deriving (Eq, Ord, Enum, Bounded, Show)
22− |])
data/examples/declaration/splice/bracket-out.hs+8−1
@@ -1,7 +1,7 @@
11{-# LANGUAGE TemplateHaskell #-}
22
33foo =
4− [|
4+ [e|
55 foo bar
66 |]
77
@@ -12,6 +12,13 @@ foo =
1212
1313foo = [t|Char|]
1414
15+foo =
16+ [d|
17+ foo :: Int -> Char
18+
19+ bar = 42
20+ |]
21+
1522foo =
1623 [||
1724 foo bar
data/examples/declaration/splice/bracket.hs+5
@@ -8,5 +8,10 @@ foo = [e| foo bar
88
99foo = [t| Char |]
1010
11+foo = [d|
12+ foo:: Int -> Char
13+ bar = 42
14+ |]
15+
1116foo = [|| foo bar
1217 ||]
data/examples/declaration/splice/grouped-splices-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−$(deriveJSON fieldLabelMod ''A)
2−$(deriveJSON fieldLabelMod ''B)
3−$(deriveJSON fieldLabelMod ''C)
data/examples/declaration/splice/grouped-splices.hsdeleted−3
@@ -1,3 +0,0 @@
1−$(deriveJSON fieldLabelMod ''A)
2−$(deriveJSON fieldLabelMod ''B)
3−$(deriveJSON fieldLabelMod ''C)
data/examples/declaration/splice/splice-decl-out.hs+19−1
@@ -10,8 +10,26 @@ $$foo
1010
1111foo bar
1212
13−[|booya|]
13+[e|booya|]
1414
1515-- TemplateHaskell allows Q () at the top level
1616do
1717 pure []
18+
19+$(do [d|baz = baz|])
20+
21+[d|data T a where Foo :: T ()|]
22+
23+[d|
24+ data T = T
25+ deriving (Eq, Ord, Enum, Bounded, Show)
26+ |]
27+
28+$(singletons [d|data T = T deriving (Eq, Ord, Enum, Bounded, Show)|])
29+
30+$( singletons
31+ [d|
32+ data T = T
33+ deriving (Eq, Ord, Enum, Bounded, Show)
34+ |]
35+ )
data/examples/declaration/splice/splice-decl.hs+17
@@ -15,3 +15,20 @@ foo bar
1515-- TemplateHaskell allows Q () at the top level
1616do
1717 pure []
18+
19+$( do [d| baz = baz |] )
20+
21+[d| data T a where Foo :: T () |]
22+
23+[d|
24+ data T = T
25+ deriving (Eq, Ord, Enum, Bounded, Show)
26+ |]
27+
28+$(singletons [d| data T = T deriving (Eq, Ord, Enum, Bounded, Show) |])
29+
30+$(singletons [d|
31+ data T = T
32+ deriving (Eq, Ord, Enum, Bounded, Show)
33+ |])
34+
data/examples/declaration/splice/typed-splice-out.hs+1−1
@@ -2,6 +2,6 @@
22
33x =
44 $$( foo bar
5− )
5+ )
66
77x = $$foo
data/examples/declaration/splice/untyped-splice-out.hs+1−1
@@ -5,6 +5,6 @@ x = $(foo bar)
55x =
66 $( foo
77 bar
8− )
8+ )
99
1010x = $foo
data/examples/declaration/type-families/closed-type-family/multi-line-out.hs+8−9
@@ -1,7 +1,7 @@
11type family
2− Id a =
3− result | result -> a
4− where
2+ Id a
3+ = result
4+ | result -> a where
55 Id a =
66 a
77
@@ -9,16 +9,15 @@ type family
99 G
1010 (a :: k)
1111 b
12− c =
13− foo | foo -> k b
14− where
12+ c
13+ = foo
14+ | foo -> k b where
1515 G a b c =
1616 (a, b)
1717
1818type family
19− F a ::
20− * -> *
21− where
19+ F a
20+ :: * -> * where
2221 F Int = Double
2322 F Bool =
2423 Char
data/examples/declaration/type-families/closed-type-family/simple-out.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Documentation.
42type family F a :: * -> * where
53 F Int = Double
data/examples/declaration/type-families/closed-type-family/simple.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Documentation.
42
53type family F a :: * -> * where
data/examples/declaration/type-families/closed-type-family/with-equal-sign-out.hsdeleted−2
@@ -1,2 +0,0 @@
1−type family TF a b = result where
2− TF a b = Int
data/examples/declaration/type-families/closed-type-family/with-equal-sign.hsdeleted−2
@@ -1,2 +0,0 @@
1−type family TF a b = result where
2− TF a b = Int
data/examples/declaration/type-families/closed-type-family/with-forall-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−type family G a b where
2− forall x y. G [x] (Proxy y) = Double
3− forall z. z `G` z = Bool
data/examples/declaration/type-families/closed-type-family/with-forall.hsdeleted−3
@@ -1,3 +0,0 @@
1−type family G a b where
2− forall x y. G [x] (Proxy y) = Double
3− forall z. z `G` z = Bool
data/examples/declaration/type-families/data-family/no-annotation-out.hs−2
@@ -1,4 +1,2 @@
1−module Main where
2−
31-- | Documentation.
42data family Array e
data/examples/declaration/type-families/data-family/no-annotation.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Documentation.
42
53data family Array e
data/examples/declaration/type-families/data-family/simple-out.hs−2
@@ -1,4 +1,2 @@
1−module Main where
2−
31-- | Documentation.
42data family GMap k :: Type -> Type
data/examples/declaration/type-families/data-family/simple.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Documentation.
42
53data family GMap k :: Type -> Type
data/examples/declaration/type-families/type-family/no-annotation-out.hs−2
@@ -1,4 +1,2 @@
1−module Main where
2−
31-- | Documentation.
42type family F a b :: Type -> Type
data/examples/declaration/type-families/type-family/no-annotation.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Documentation.
42
53type family F a b :: Type -> Type
data/examples/declaration/type-families/type-family/operator-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−type family a ! b
2−
3−type family a . b
data/examples/declaration/type-families/type-family/operator.hsdeleted−2
@@ -1,2 +0,0 @@
1−type family a ! b
2−type family a . b
data/examples/declaration/type-families/type-family/simple-out.hs−2
@@ -1,4 +1,2 @@
1−module Main where
2−
31-- | Documentation.
42type family Elem c :: Type
data/examples/declaration/type-families/type-family/simple.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Documentation.
42
53type family Elem c :: Type
data/examples/declaration/type-synonyms/multi-line-out.hs+8−13
@@ -1,18 +1,13 @@
1−type Foo a b c =
2− Bar c a b
1+type Foo a b c
2+ = Bar c a b
33
44type Foo
55 a
66 b
7− c =
8− Bar c a b
7+ c
8+ = Bar c a b
99
10−type Foo =
11− Bar
12− Baz
13− Quux
14−
15−type API =
16− "route1" :> ApiRoute1
17− :<|> "route2" :> ApiRoute2 -- comment here
18− :<|> OmitDocs :> "i" :> ASomething API
10+type Foo
11+ = Bar
12+ Baz
13+ Quux
data/examples/declaration/type-synonyms/multi-line.hs−5
@@ -10,8 +10,3 @@ type Foo =
1010 Bar
1111 Baz
1212 Quux
13−
14−type API
15− = "route1" :> ApiRoute1
16− :<|> "route2" :> ApiRoute2 -- comment here
17− :<|> OmitDocs :> "i" :> ASomething API
data/examples/declaration/type-synonyms/simple-out.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Documentation.
42type Foo a b c = Bar c a b
53
data/examples/declaration/type-synonyms/simple.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Documentation.
42
53type Foo a b c = Bar c a b
data/examples/declaration/type-synonyms/with-weird-haddock-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−type Elims =
2− -- | eliminations ordered left-to-right.
3− [Elim]
data/examples/declaration/type-synonyms/with-weird-haddock.hsdeleted−1
@@ -1 +0,0 @@
1−type Elims = [Elim] -- ^ eliminations ordered left-to-right.
data/examples/declaration/type/forall-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−type CoerceLocalSig m m' =
2− forall r a.
3− LocalSig m r a ->
4− LocalSig m' r a
data/examples/declaration/type/forall.hsdeleted−4
@@ -1,4 +0,0 @@
1−type CoerceLocalSig m m' =
2− forall r a.
3− LocalSig m r a ->
4− LocalSig m' r a
data/examples/declaration/type/lits-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−type A = "foo"
2−
3−type B =
4− "foo\
5− \bar" ->
6− ()
data/examples/declaration/type/lits.hsdeleted−4
@@ -1,4 +0,0 @@
1−type A = "foo"
2−
3−type B = "foo\
4− \bar" -> ()
data/examples/declaration/type/misc-kind-signatures-out.hs+1
@@ -1,4 +1,5 @@
11instance DemoteNodeTypes ('[] :: [NodeType]) where
2+
23 demoteNodeTypes _ = []
34
45b :: (Bool :: *)
data/examples/declaration/type/type-applications-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−{-# LANGUAGE TypeApplications #-}
2−
3−type P = K @Bool @(Bool :: *) 'True 'False
data/examples/declaration/type/type-applications.hsdeleted−3
@@ -1,3 +0,0 @@
1−{-# LANGUAGE TypeApplications #-}
2−
3−type P = K @Bool @(Bool :: *) 'True 'False
data/examples/declaration/type/visible-forall-out.hsdeleted−2
@@ -1,2 +0,0 @@
1−-- source: https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0081-forall-arrow.rst
2−data T :: forall k -> k -> Type
data/examples/declaration/type/visible-forall.hsdeleted−2
@@ -1,2 +0,0 @@
1−-- source: https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0081-forall-arrow.rst
2−data T :: forall k -> k -> Type
data/examples/declaration/value/function/application-0-out.hsdeleted−17
@@ -1,17 +0,0 @@
1−foo =
2− f1
3− p1
4− p2
5− p3
6−
7−foo' =
8− f2
9− p1
10− p2
11− p3
12−
13−foo'' =
14− f3
15− p1
16− p2
17− p3
data/examples/declaration/value/function/application-0.hsdeleted−12
@@ -1,12 +0,0 @@
1−foo =
2− f1
3− p1
4− p2 p3
5−
6−foo' = f2 p1
7− p2
8− p3
9−
10−foo'' =
11− f3 p1 p2
12− p3
data/examples/declaration/value/function/application-1-out.hsdeleted−19
@@ -1,19 +0,0 @@
1−main =
2− do
3− x
4− y
5− z
6−
7−main =
8− case foo of
9− x -> a
10− foo
11− a
12− b
13−
14−main =
15− do
16− if x then y else z
17− foo
18− a
19− b
data/examples/declaration/value/function/application-1.hsdeleted−14
@@ -1,14 +0,0 @@
1−main =
2− do
3− x
4− y
5− z
6−
7−main =
8− case foo of
9− x -> a
10− foo a b
11−
12−main = do
13− if x then y else z
14− foo a b
data/examples/declaration/value/function/arg-breakpoints-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo
2− bar =
3− body
data/examples/declaration/value/function/arg-breakpoints.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo
2− bar =
3− body
data/examples/declaration/value/function/arithmetic-sequences-out.hs+2−2
@@ -5,13 +5,13 @@ foo' = [0 .. 5]
55bar x =
66 [ 0
77 .. x
8− ]
8+ ]
99
1010baz x =
1111 [ 1,
1212 3
1313 .. x
14− ]
14+ ]
1515
1616barbaz x = [0, 1 ..]
1717
data/examples/declaration/value/function/arrow/expression-applications-out.hsnew file+9
@@ -0,0 +1,9 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo x y = x -< y
4+
5+bar f x =
6+ f x -< -- Hello
7+ x -- World
8+
9+baz x y = x -<< y
data/examples/declaration/value/function/arrow/expression-applications.hsnew file+9
@@ -0,0 +1,9 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo x y = x -< y
4+
5+bar f x
6+ = f x -- Hello
7+ -< x -- World
8+
9+baz x y = x -<< y
data/examples/declaration/value/function/arrow/expression-forms-out.hsnew file+13
@@ -0,0 +1,13 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo f g x y = (|test (f -< x) (g -< y)|)
4+
5+bar f g x y =
6+ (| test
7+ ( f -<
8+ x
9+ )
10+ ( g -<
11+ y
12+ )
13+ |)
data/examples/declaration/value/function/arrow/expression-forms.hsnew file+11
@@ -0,0 +1,11 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo f g x y = (| test (f -< x) (g -< y) |)
4+
5+bar f g x y = (|
6+ test
7+ (f
8+ -< x)
9+ (g
10+ -< y)
11+ |)
data/examples/declaration/value/function/arrow/multiline-case-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−f = proc x -> do
4− x <-
5− case x of X -> x
6− -<
7− y
8− a -< b
data/examples/declaration/value/function/arrow/multiline-case.hsdeleted−7
@@ -1,7 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−f = proc x -> do
4− x
5− <- case x of X -> x
6− -< y
7− a -< b
data/examples/declaration/value/function/arrow/proc-applications-out.hs+4−5
@@ -9,11 +9,10 @@ bar f x =
99 w
1010 )
1111 ->
12− f -- The value
13− -<
14− ( x, -- Foo
15− w, -- Bar
16− z -- Baz
12+ f -< -- The value
13+ ( x, -- Foo
14+ w, -- Bar
15+ z -- Baz
1716 )
1817
1918baz x = proc a -> a -<< x
data/examples/declaration/value/function/arrow/proc-do-complex-out.hs+26−27
@@ -16,16 +16,16 @@ foo
1616 f -- Call into f
1717 ( a,
1818 c -- Tuple together arguments
19− )
19+ )
2020 ( b,
2121 d
22− )
23− -<
24− ( b + 1, -- Funnel into arrow
25− d * b
22+ ) -<
23+ ( b + 1, -- Funnel into arrow
24+ d * b
2625 )
2726 if x `mod` y == 0 -- Basic condition
28− then case e of -- Only left case is relevant
27+ then
28+ case e of -- Only left case is relevant
2929 Left
3030 ( z,
3131 w
@@ -33,30 +33,29 @@ foo
3333 let v =
3434 u -- Actually never used
3535 ^ 2
36− in ( returnA
37− -<
38− -- Just do the calculation
39− (x + y * z)
40− )
41− else do
36+ in ( returnA -<
37+ -- Just do the calculation
38+ (x + y * z)
39+ )
40+ else
41+ do
4242 let u = x -- Let bindings bind expressions, not commands
43− -- Could pattern match directly on x
44− i <- case u of
45− 0 -> (g . h -< u)
46− n ->
47− ( ( h . g
48− -<
43+ -- Could pattern match directly on x
44+ i <-
45+ case u of
46+ 0 -> (g . h -< u)
47+ n ->
48+ ( ( h . g -<
4949 y -- First actual use of y
50− )
51− )
50+ )
51+ )
5252 returnA -< ()
5353 -- Sometimes execute effects
5454 if i > 0
55− then ma -< ()
56− else returnA -< ()
57− returnA
58− -<
59− ( i
60− + x
61− * y -- Just do the calculation
55+ then ma -< ()
56+ else returnA -< ()
57+ returnA -<
58+ ( i
59+ + x
60+ * y -- Just do the calculation
6261 )
data/examples/declaration/value/function/arrow/proc-do-simple-out.hsnew file+36
@@ -0,0 +1,36 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo f = proc a -> do
4+ f -< a
5+
6+bar f = proc a -> do
7+ b <- f -< a
8+
9+barbar f g = proc a -> do
10+ b <- f -< a
11+ returnA -< b
12+
13+barbaz f g = proc (a, b) -> do
14+ c <- f -< a
15+ d <- g -< b
16+
17+bazbar f = proc a -> do
18+ a <-
19+ f -<
20+ a
21+
22+bazbaz f g h = proc (a, b, c) -> do
23+ x <-
24+ f b -< a
25+ y <-
26+ g b -< b
27+ z <-
28+ h
29+ x
30+ y -<
31+ ( a,
32+ b,
33+ c
34+ )
35+ returnA -<
36+ (x, y, z)
data/examples/declaration/value/function/arrow/proc-do-simple2.hs → data/examples/declaration/value/function/arrow/proc-do-simple.hsrenamed+19
@@ -1,7 +1,26 @@
11{-# LANGUAGE Arrows #-}
2+
23foo f = proc a ->
34 do f -< a
45
6+bar f = proc a ->
7+ do b <- f -< a
8+
9+barbar f g = proc a ->
10+ do b <- f -< a
11+ returnA -< b
12+
13+barbaz f g = proc (a, b) ->
14+ do c <- f -< a
15+ d <- g -< b
16+
17+bazbar f = proc a ->
18+ do a
19+ <-
20+ f
21+ -<
22+ a
23+
524bazbaz f g h = proc (a, b, c) ->
625 do x
726 <- f b -< a
data/examples/declaration/value/function/arrow/proc-do-simple1-out.hsdeleted−18
@@ -1,18 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−bar f = proc a -> do
4− b <- f -< a
5−
6−barbar f g = proc a -> do
7− b <- f -< a
8− returnA -< b
9−
10−barbaz f g = proc (a, b) -> do
11− c <- f -< a
12− d <- g -< b
13−
14−bazbar f = proc a -> do
15− a <-
16− f
17− -<
18− a
data/examples/declaration/value/function/arrow/proc-do-simple1.hsdeleted−20
@@ -1,20 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−bar f = proc a ->
4− do b <- f -< a
5−
6−barbar f g = proc a ->
7− do b <- f -< a
8− returnA -< b
9−
10−barbaz f g = proc (a, b) ->
11− do c <- f -< a
12− d <- g -< b
13−
14−bazbar f = proc a ->
15− do a
16− <-
17− f
18− -<
19− a
20−
data/examples/declaration/value/function/arrow/proc-do-simple2-out.hsdeleted−22
@@ -1,22 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−foo f = proc a -> do
4− f -< a
5−
6−bazbaz f g h = proc (a, b, c) -> do
7− x <-
8− f b -< a
9− y <-
10− g b -< b
11− z <-
12− h
13− x
14− y
15− -<
16− ( a,
17− b,
18− c
19− )
20− returnA
21− -<
22− (x, y, z)
data/examples/declaration/value/function/arrow/proc-forms-out.hsnew file+35
@@ -0,0 +1,35 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo0 f g x y = proc _ -> (|f (g -< (x, y))|)
4+
5+foo1 f g h x =
6+ proc (y, z) ->
7+ (|test (h f . (h g) -< (y x) . y z) ((h g) . h f -< y z . (y x))|)
8+
9+foo2 f g h x =
10+ proc (y, z) ->
11+ (| test
12+ ( h f
13+ . h g -<
14+ y x
15+ . y z
16+ )
17+ ( h g
18+ . h f -<
19+ y z
20+ . y x
21+ )
22+ |)
23+
24+bar0 f g x y = proc _ -> f -< x &&& g -< y
25+
26+bar1 f g h x =
27+ proc (y, z) ->
28+ h f . (h g) -< (y x) . y z ||| (h g) . h f -< y z . (y x)
29+
30+bar2 f g h x =
31+ proc (y, z) ->
32+ (h f . h g) -<
33+ (y x) . y z
34+ ||| (h g . h f) -<
35+ y z . (y x)
data/examples/declaration/value/function/arrow/proc-forms.hsnew file+36
@@ -0,0 +1,36 @@
1+{-# LANGUAGE Arrows #-}
2+
3+foo0 f g x y = proc _ -> (| f (g -< (x, y)) |)
4+
5+foo1 f g h x =
6+ proc (y, z) ->
7+ (| test (h f.(h g) -< (y x).y z)((h g) . h f-<y z . (y x)) |)
8+
9+foo2 f g h x =
10+ proc (y, z) -> (|
11+ test ( h f
12+ . h g
13+ -<
14+ y x
15+ . y z
16+ )
17+ ( h g
18+ . h f
19+ -<
20+ y z
21+ . y x)
22+ |)
23+
24+bar0 f g x y = proc _ -> f -< x&&&g -< y
25+
26+bar1 f g h x =
27+ proc (y, z) ->
28+ h f.(h g) -< (y x).y z ||| (h g) . h f-<y z . (y x)
29+
30+bar2 f g h x =
31+ proc (y, z) ->
32+ (h f.h g)
33+ -< (y x).y z
34+ |||
35+ (h g . h f)
36+ -<y z . (y x)
data/examples/declaration/value/function/arrow/proc-forms1-out.hsdeleted−21
@@ -1,21 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−foo0 f g x y = proc _ -> (| f (g -< (x, y)) |)
4−
5−foo1 f g h x =
6− proc (y, z) ->
7− (|
8− test
9− ( h f
10− . h g
11− -<
12− y x
13− . y z
14− )
15− ( h g
16− . h f
17− -<
18− y z
19− . y x
20− )
21− |)
data/examples/declaration/value/function/arrow/proc-forms1.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−foo0 f g x y = proc _ -> (| f (g -< (x, y)) |)
4−
5−foo1 f g h x =
6− proc (y, z) -> (|
7− test ( h f
8− . h g
9− -<
10− y x
11− . y z
12− )
13− ( h g
14− . h f
15− -<
16− y z
17− . y x)
18− |)
19−
data/examples/declaration/value/function/arrow/proc-forms2-out.hsdeleted−22
@@ -1,22 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−bar0 f g h x =
4− proc (y, z) ->
5− (| test (h f . (h g) -< (y x) . y z) ((h g) . h f -< y z . (y x)) |)
6−
7−bar1 f g x y = proc _ -> (f -< x) &&& (g -< y)
8−
9−bar2 f g h x =
10− proc (y, z) ->
11− (h f . (h g) -< (y x) . y z) ||| ((h g) . h f -< y z . (y x))
12−
13−bar3 f g h x =
14− proc (y, z) ->
15− ( (h f . h g)
16− -<
17− (y x) . y z
18− ) |||
19− ( (h g . h f)
20− -<
21− y z . (y x)
22− )
data/examples/declaration/value/function/arrow/proc-forms2.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# LANGUAGE Arrows #-}
2−
3−bar0 f g h x =
4− proc (y, z) ->
5− (| test (h f.(h g) -< (y x).y z)((h g) . h f-<y z . (y x)) |)
6−
7−bar1 f g x y = proc _ -> (f -< x)&&&(g -< y)
8−
9−bar2 f g h x =
10− proc (y, z) ->
11− (h f.(h g) -< (y x).y z) ||| ((h g) . h f-<y z . (y x))
12−
13−bar3 f g h x =
14− proc (y, z) ->
15− ((h f.h g)
16− -< (y x).y z)
17− |||
18− ((h g . h f)
19− -<y z . (y x))
data/examples/declaration/value/function/arrow/proc-ifs-out.hs+7−9
@@ -4,12 +4,10 @@ foo f = proc a -> if a then f -< 0 else f -< 1
44
55bar f g = proc a ->
66 if f a
7− then
8− f
9− . g
10− -<
11− a
12− else
13− g
14− -<
15− b
7+ then
8+ f
9+ . g -<
10+ a
11+ else
12+ g -<
13+ b
data/examples/declaration/value/function/arrow/proc-lets-out.hs+1−1
@@ -9,4 +9,4 @@ bar f g = proc a ->
99 j =
1010 g
1111 . h
12− in id -< (h, j)
12+ in id -< (h, j)
data/examples/declaration/value/function/arrow/proc-parentheses-out.hs+5−6
@@ -5,15 +5,14 @@ foo f = proc a -> (f -< a)
55bar f g = proc a ->
66 ( ( (f)
77 ( g
8− )
9− )
10− -<
11− ( ( ( ( ( ( g
12− a
8+ )
9+ ) -<
10+ ( ( ( ( ( ( g
11+ a
1312 )
1413 )
1514 )
1615 )
1716 )
1817 )
19− )
18+ )
data/examples/declaration/value/function/arrow/recursive-procs-out.hs+9−13
@@ -3,21 +3,17 @@
33foo f g = proc (x, y) -> do
44 rec a <- f y -< x
55 b <-
6− g x
7− -<
8− y
9− bar
10− -<
11− ( a,
12− b
6+ g x -<
7+ y
8+ bar -<
9+ ( a,
10+ b
1311 )
1412 rec p <-
1513 f
16− p
17− -<
18− a
14+ p -<
15+ a
1916 rec q <-
2017 g
21− q
22− -<
23− b
18+ q -<
19+ b
data/examples/declaration/value/function/awkward-comment-0-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−mergeErrorReply :: ParseError -> Reply s u a -> Reply s u a
2−mergeErrorReply err1 reply -- XXX where to put it?
3− =
4− case reply of
5− Ok x state err2 -> Ok x state (mergeError err1 err2)
6− Error err2 -> Error (mergeError err1 err2)
data/examples/declaration/value/function/awkward-comment-0.hsdeleted−5
@@ -1,5 +0,0 @@
1−mergeErrorReply :: ParseError -> Reply s u a -> Reply s u a
2−mergeErrorReply err1 reply -- XXX where to put it?
3− = case reply of
4− Ok x state err2 -> Ok x state (mergeError err1 err2)
5− Error err2 -> Error (mergeError err1 err2)
data/examples/declaration/value/function/awkward-comment-1-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−doForeign :: Vars -> [Name] -> [Term] -> Idris LExp
2−doForeign x = x
3− where
4− splitArg tm | (_, [_, _, l, r]) <- unApply tm -- pair, two implicits
5− =
6− do
7− let l' = toFDesc l
8− r' <- irTerm (sMN 0 "__foreignCall") vs env r
9− return (l', r')
data/examples/declaration/value/function/awkward-comment-1.hsdeleted−7
@@ -1,7 +0,0 @@
1−doForeign :: Vars -> [Name] -> [Term] -> Idris LExp
2−doForeign x = x
3− where
4− splitArg tm | (_, [_,_,l,r]) <- unApply tm -- pair, two implicits
5− = do let l' = toFDesc l
6− r' <- irTerm (sMN 0 "__foreignCall") vs env r
7− return (l', r')
data/examples/declaration/value/function/blank-lines-let-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−foo =
2− let x = 10
3−
4− y = 11
5− z = 12
6− in x + y + z
data/examples/declaration/value/function/blank-lines-let.hsdeleted−9
@@ -1,9 +0,0 @@
1−foo =
2− let
3−
4− x = 10
5−
6− y = 11
7− z = 12
8−
9− in x + y + z
data/examples/declaration/value/function/blank-lines-where-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−foo = x + y + z
2− where
3− x = 10
4−
5− y = 11
6− z = 12
data/examples/declaration/value/function/blank-lines-where.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo = x + y + z
2− where
3−
4− x = 10
5−
6− y = 11
7− z = 12
data/examples/declaration/value/function/block-arguments-out.hs+12−16
@@ -1,11 +1,13 @@
11f1 = foo do bar
22
3−f2 = foo do
4− bar
3+f2 =
4+ foo do
5+ bar
56
6−f3 = foo case True of
7− True -> bar
8− False -> baz
7+f3 =
8+ foo case True of
9+ True -> bar
10+ False -> baz
911
1012f4 = foo let a = 3 in b
1113
@@ -18,17 +20,11 @@ f5 =
1820f6 =
1921 foo
2022 if bar
21− then baz
22− else not baz
23+ then baz
24+ else not baz
2325
2426f7 = foo \x -> y
2527
26−f8 = foo \x ->
27− y
28−
29−f9 = foo do { bar } baz
30−
31−f10 = foo
32− do a
33− do b
34− do c
28+f8 =
29+ foo \x ->
30+ y
data/examples/declaration/value/function/block-arguments.hs−7
@@ -21,10 +21,3 @@ f7 = foo \x -> y
2121
2222f8 = foo \x ->
2323 y
24−
25−f9 = foo do { bar } baz
26−
27−f10 = foo
28− do { a }
29− do { b }
30− do c
data/examples/declaration/value/function/case-multi-line-guards-out.hsdeleted−16
@@ -1,16 +0,0 @@
1−withGuards :: Int -> Int
2−withGuards x =
3− case x of
4− x
5− | x > 10 ->
6− foo
7− + bar
8− x | x > 5 -> 10
9− _ -> 20
10−
11−case x of
12− '-' | not isUrl -> case xs of
13− _ -> emitc '-'
14− '*' | not isUrl ->
15− case xs of
16− _ -> emitc '*'
data/examples/declaration/value/function/case-multi-line-guards.hsdeleted−15
@@ -1,15 +0,0 @@
1−withGuards :: Int -> Int
2−withGuards x =
3− case x of
4− x | x > 10 ->
5− foo +
6− bar
7− x | x > 5 -> 10
8− _ -> 20
9−
10−case x of
11− '-' | not isUrl -> case xs of
12− _ -> emitc '-'
13− '*' | not isUrl ->
14− case xs of
15− _ -> emitc '*'
data/examples/declaration/value/function/case-multi-line-out.hs+12−2
@@ -8,8 +8,8 @@ bar x =
88 case x of
99 5 ->
1010 if x > 5
11− then 10
12− else 12
11+ then 10
12+ else 12
1313 _ -> 12
1414
1515baz :: Int -> Int
@@ -21,6 +21,16 @@ quux :: Int -> Int
2121quux x = case x of
2222 x -> x
2323
24+withGuards :: Int -> Int
25+withGuards x =
26+ case x of
27+ x
28+ | x > 10 ->
29+ foo
30+ + bar
31+ x | x > 5 -> 10
32+ _ -> 20
33+
2434funnyComment =
2535 -- comment
2636 case () of
data/examples/declaration/value/function/case-multi-line.hs+9
@@ -18,6 +18,15 @@ quux :: Int -> Int
1818quux x = case x of
1919 x -> x
2020
21+withGuards :: Int -> Int
22+withGuards x =
23+ case x of
24+ x | x > 10 ->
25+ foo +
26+ bar
27+ x | x > 5 -> 10
28+ _ -> 20
29+
2130funnyComment = -- comment
2231 case () of
2332 () -> ()
data/examples/declaration/value/function/case-single-line-out.hs+1
@@ -3,4 +3,5 @@ foo x = case x of x -> x
33
44foo :: IO ()
55foo = case [1] of [_] -> "singleton"; _ -> "not singleton"
6+
67foo = case [1] of { [] -> foo; _ -> bar } `finally` baz
data/examples/declaration/value/function/complex-list-out.hs+2−2
@@ -4,7 +4,7 @@ handleStuff =
44 something,
55 \ExceptionB ->
66 somethingElse
7− ]
7+ ]
88
99handleStuff =
1010 handle
@@ -12,4 +12,4 @@ handleStuff =
1212 bar,
1313 baz
1414 qux
15− ]
15+ ]
data/examples/declaration/value/function/comprehension/transform-multi-line1-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−{-# LANGUAGE TransformListComp #-}
2−
3−foo' xs ys =
4− [ ( x,
5− y
6− )
7− | x <- xs,
8− y <- ys,
9− then
10− -- First comment
11− reverse -- Second comment
12− ]
data/examples/declaration/value/function/comprehension/transform-multi-line1.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE TransformListComp #-}
2−
3−foo' xs ys = [
4− (x,
5− y) |
6− x <- xs,
7− y <- ys,
8− then -- First comment
9− reverse -- Second comment
10− ]
data/examples/declaration/value/function/comprehension/transform-multi-line2-out.hsdeleted−16
@@ -1,16 +0,0 @@
1−{-# LANGUAGE TransformListComp #-}
2−
3−bar' xs ys =
4− [ ( x,
5− y
6− )
7− | x <- xs,
8− y <- ys,
9− then
10− -- First comment
11− sortWith
12− by
13− ( x
14− + y -- Second comment
15− )
16− ]
data/examples/declaration/value/function/comprehension/transform-multi-line2.hsdeleted−15
@@ -1,15 +0,0 @@
1−{-# LANGUAGE TransformListComp #-}
2−
3−bar' xs ys = [
4− (x,
5− y) |
6− x <- xs,
7− y <- ys,
8− then -- First comment
9− sortWith
10− by
11− (x
12− + y) -- Second comment
13− ]
14−
15−
data/examples/declaration/value/function/comprehension/transform-multi-line3-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−{-# LANGUAGE TransformListComp #-}
2−
3−baz' xs ys =
4− [ ( x,
5− y
6− )
7− | x <- xs,
8− y <- ys,
9− then group using
10− -- First comment
11− permutations -- Second comment
12− ]
data/examples/declaration/value/function/comprehension/transform-multi-line3.hsdeleted−12
@@ -1,12 +0,0 @@
1−{-# LANGUAGE TransformListComp #-}
2−
3−baz' xs ys = [
4− (x,
5− y) |
6− x <- xs,
7− y <- ys,
8− then
9− group
10− using -- First comment
11− permutations -- Second comment
12− ]
data/examples/declaration/value/function/comprehension/transform-multi-line4-out.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# LANGUAGE TransformListComp #-}
2−
3−quux' xs ys =
4− [ ( x,
5− y
6− )
7− | x <- xs,
8− y <- ys,
9− then group by
10− -- First comment
11− ( x
12− + y
13− )
14− using
15− -- Second comment
16− groupWith -- Third comment
17− ]
data/examples/declaration/value/function/comprehension/transform-multi-line4.hsdeleted−15
@@ -1,15 +0,0 @@
1−{-# LANGUAGE TransformListComp #-}
2−
3−quux' xs ys = [
4− (x,
5− y) |
6− x <- xs,
7− y <- ys,
8− then
9− group
10− by -- First comment
11− (x
12− + y)
13− using -- Second comment
14− groupWith -- Third comment
15− ]
data/examples/declaration/value/function/comprehension/transform-single-line-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−{-# LANGUAGE TransformListComp #-}
2−
3−foo xs ys = [(x, y) | x <- xs, y <- ys, then reverse]
4−
5−bar xs ys = [(x, y) | x <- xs, y <- ys, then sortWith by (x + y)]
6−
7−baz xs ys = [(x, y) | x <- xs, y <- ys, then group using permutations]
8−
9−quux xs ys = [(x, y) | x <- xs, y <- ys, then group by (x + y) using groupWith]
data/examples/declaration/value/function/comprehension/transform-single-line.hsdeleted−9
@@ -1,9 +0,0 @@
1−{-# LANGUAGE TransformListComp #-}
2−
3−foo xs ys = [(x, y) | x <- xs, y <- ys, then reverse]
4−
5−bar xs ys = [(x, y) | x <- xs, y <- ys, then sortWith by (x + y)]
6−
7−baz xs ys = [(x, y) | x <- xs, y <- ys, then group using permutations]
8−
9−quux xs ys = [(x, y) | x <- xs, y <- ys, then group by (x + y) using groupWith]
data/examples/declaration/value/function/do-out.hsnew file+111
@@ -0,0 +1,111 @@
1+{-# LANGUAGE RecursiveDo #-}
2+
3+bar = do foo; bar
4+
5+baz =
6+ mdo
7+ bar a
8+ a <- foo
9+ b <-
10+ bar
11+ 1
12+ 2
13+ 3
14+ return (a + b)
15+
16+baz = do
17+ a <- foo
18+ let b = a + 2
19+ c = b + 3
20+ bar c
21+ let d = c + 2
22+ return d
23+
24+quux = something $ do
25+ foo
26+ case x of
27+ 1 -> 10
28+ 2 -> 20
29+ bar
30+ if something
31+ then x
32+ else y
33+ baz
34+
35+foo = do
36+ rec a <- b + 5
37+ let d = c
38+ b <- a * 5
39+ something
40+ c <- a + b
41+ print c
42+ rec something $ do
43+ x <- a
44+ print x
45+ y <- c
46+ print y
47+
48+trickyLet = do
49+ foo
50+ let x = 5
51+ in bar x
52+
53+f = unFoo . foo bar baz 3 $ do
54+ act
55+ ret
56+
57+g = unFoo
58+ . foo
59+ bar
60+ baz
61+ 3
62+ $ do
63+ act
64+ ret
65+
66+main =
67+ do stuff
68+ `finally` do
69+ recover
70+
71+main = do stuff `finally` recover
72+
73+main = do { stuff } `finally` recover
74+
75+foo = do do { foo; bar }; baz
76+
77+foo =
78+ do
79+ 1
80+ + 2
81+
82+-- single line let-where
83+samples n f = do
84+ gen <- newQCGen
85+ let rands g = g1 : rands g2 where { (g1, g2) = split g }
86+ return $ rands gen
87+
88+main = do bar
89+
90+main = do bar; baz
91+
92+main = do
93+ bar
94+ baz
95+
96+main = do
97+ a <- bar
98+ let a = b; c = d
99+ baz d
100+ let e = f
101+ g = h
102+ return c
103+
104+readInClause = do
105+ do
106+ lookAhead g_Do
107+ parseNote ErrorC 1063 "You need a line feed or semicolon before the 'do'."
108+ <|> do
109+ optional g_Semi
110+ void allspacing
111+ return things
data/examples/declaration/value/function/do.hsnew file+111
@@ -0,0 +1,111 @@
1+{-# LANGUAGE RecursiveDo #-}
2+
3+bar = do { foo; bar }
4+
5+baz =
6+ mdo bar a
7+ a <- foo
8+ b <- bar
9+ 1 2 3
10+ return (a + b)
11+
12+baz = do
13+ a <- foo
14+ let b = a + 2
15+ c = b + 3
16+ bar c
17+ let d = c + 2
18+ return d
19+
20+quux = something $ do
21+ foo
22+ case x of
23+ 1 -> 10
24+ 2 -> 20
25+ bar
26+ if something
27+ then x
28+ else y
29+ baz
30+
31+foo = do
32+ rec
33+ a <- b + 5
34+
35+ let d = c
36+
37+ b <- a * 5
38+
39+ something
40+
41+ c <- a + b
42+ print c
43+ rec something $ do
44+ x <- a
45+ print x
46+
47+ y <- c
48+ print y
49+
50+trickyLet = do
51+ foo
52+ let x = 5
53+ in bar x
54+
55+f = unFoo . foo bar baz 3 $ do
56+ act
57+ ret
58+
59+g = unFoo . foo
60+ bar
61+ baz 3 $ do
62+ act
63+ ret
64+
65+main =
66+ do stuff
67+ `finally` do
68+ recover
69+
70+main = do stuff `finally` recover
71+
72+main = do { stuff } `finally` recover
73+
74+foo = do { do {foo; bar}; baz }
75+
76+foo = do
77+ 1
78+ +
79+ 2
80+
81+-- single line let-where
82+samples n f = do
83+ gen <- newQCGen
84+ let rands g = g1 : rands g2 where (g1, g2) = split g
85+ return $ rands gen
86+
87+main = do bar
88+main = do { bar; baz }
89+main = do { bar
90+ ; baz
91+ }
92+
93+main = do
94+ a <- bar
95+ let a = b; c = d
96+ baz d
97+ let e = f
98+ g = h
99+ return c
100+
101+readInClause = do
102+ do {
103+ lookAhead g_Do;
104+ parseNote ErrorC 1063 "You need a line feed or semicolon before the 'do'.";
105+ } <|> do {
106+ optional g_Semi;
107+ void allspacing;
108+ }
109+
110+ return things
111+
data/examples/declaration/value/function/do/applications-and-parens-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−warningFor var place = do
2− guard $ isVariableName var
3− guard . not $ isInArray var place || isGuarded place
4− ( if includeGlobals || isLocal var
5− then warningForLocals
6− else warningForGlobals
7− )
8− var
9− place
data/examples/declaration/value/function/do/applications-and-parens.hsdeleted−6
@@ -1,6 +0,0 @@
1−warningFor var place = do
2− guard $ isVariableName var
3− guard . not $ isInArray var place || isGuarded place
4− (if includeGlobals || isLocal var
5− then warningForLocals
6− else warningForGlobals) var place
data/examples/declaration/value/function/do/blocks-out.hsdeleted−19
@@ -1,19 +0,0 @@
1−foo = do bar
2−
3−foo = do bar; baz
4−
5−foo = do
6− bar
7− baz
8−
9−foo = do do { foo; bar }; baz
10−
11−readInClause = do
12− do
13− lookAhead g_Do
14− parseNote ErrorC 1063 "You need a line feed or semicolon before the 'do'."
15− <|> do
16− optional g_Semi
17− void allspacing
18−
19− return things
data/examples/declaration/value/function/do/blocks.hsdeleted−17
@@ -1,17 +0,0 @@
1−foo = do bar
2−foo = do { bar; baz }
3−foo = do { bar
4− ; baz
5− }
6−foo = do { do {foo; bar}; baz }
7−
8−readInClause = do
9− do {
10− lookAhead g_Do;
11− parseNote ErrorC 1063 "You need a line feed or semicolon before the 'do'.";
12− } <|> do {
13− optional g_Semi;
14− void allspacing;
15− }
16−
17− return things
data/examples/declaration/value/function/do/comment-alignment-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−main = do
2− case blah of
3− Nothing -> return ()
4− Just xs -> do
5− forM_ xs foo
6− bar
7− -- and here it goes
8− unless bobla $
9− quux
data/examples/declaration/value/function/do/comment-alignment.hsdeleted−9
@@ -1,9 +0,0 @@
1−main = do
2− case blah of
3− Nothing -> return ()
4− Just xs -> do
5− forM_ xs foo
6− bar
7− -- and here it goes
8− unless bobla $
9− quux
data/examples/declaration/value/function/do/comment-spacing-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo = do
2− bar
3− -- foo
4− baz
5−
6− -- foo
7− quux
data/examples/declaration/value/function/do/comment-spacing.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo = do
2− bar
3− -- foo
4− baz
5−
6− -- foo
7− quux
data/examples/declaration/value/function/do/expr-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−quux = something $ do
2− foo
3− case x of
4− 1 -> 10
5− 2 -> 20
6− bar
7− if something
8− then x
9− else y
10− baz
data/examples/declaration/value/function/do/expr.hsdeleted−10
@@ -1,10 +0,0 @@
1−quux = something $ do
2− foo
3− case x of
4− 1 -> 10
5− 2 -> 20
6− bar
7− if something
8− then x
9− else y
10− baz
data/examples/declaration/value/function/do/hang-rhs-arrow-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−foo = do
2− something <- case bar of
3− Foo -> return 1
4− Bar -> return 2
5− somethingElse <-
6− case boom of
7− Foo -> return 1
8− Bar -> return 2
9− quux something somethingElse
data/examples/declaration/value/function/do/hang-rhs-arrow.hsdeleted−9
@@ -1,9 +0,0 @@
1−foo = do
2− something <- case bar of
3− Foo -> return 1
4− Bar -> return 2
5− somethingElse <-
6− case boom of
7− Foo -> return 1
8− Bar -> return 2
9− quux something somethingElse
data/examples/declaration/value/function/do/let-out.hsdeleted−18
@@ -1,18 +0,0 @@
1−main = do
2− a <- bar
3− let a = b; c = d
4− baz d
5− let e = f
6− g = h
7− return c
8−
9−-- single line let-where
10−samples n f = do
11− gen <- newQCGen
12− let rands g = g1 : rands g2 where (g1, g2) = split g
13− return $ rands gen
14−
15−trickyLet = do
16− foo
17− let x = 5
18− in bar x
data/examples/declaration/value/function/do/let.hsdeleted−18
@@ -1,18 +0,0 @@
1−main = do
2− a <- bar
3− let a = b; c = d
4− baz d
5− let e = f
6− g = h
7− return c
8−
9−-- single line let-where
10−samples n f = do
11− gen <- newQCGen
12− let rands g = g1 : rands g2 where (g1, g2) = split g
13− return $ rands gen
14−
15−trickyLet = do
16− foo
17− let x = 5
18− in bar x
data/examples/declaration/value/function/do/operator-and-parens-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−scientifically :: (Scientific -> a) -> Parser a
2−scientifically h = do
3− something
4− ( I.satisfy (\w -> w == 'e' || w == 'E')
5− *> fmap (h . Sci.scientific signedCoeff . (e +)) (signed decimal)
6− )
7− <|> return (h $ Sci.scientific signedCoeff e)
data/examples/declaration/value/function/do/operator-and-parens.hsdeleted−7
@@ -1,7 +0,0 @@
1−scientifically :: (Scientific -> a) -> Parser a
2−scientifically h = do
3− something
4− ( I.satisfy (\w -> w == 'e' || w == 'E')
5− *> fmap (h . Sci.scientific signedCoeff . (e +)) (signed decimal)
6− )
7− <|> return (h $ Sci.scientific signedCoeff e)
data/examples/declaration/value/function/do/recursive-do-mdo-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−{-# LANGUAGE RecursiveDo #-}
2−
3−baz =
4− mdo
5− bar a
6− a <- foo
7− b <-
8− bar
9− 1
10− 2
11− 3
12− return (a + b)
data/examples/declaration/value/function/do/recursive-do-mdo.hsdeleted−8
@@ -1,8 +0,0 @@
1−{-# LANGUAGE RecursiveDo #-}
2−
3−baz =
4− mdo bar a
5− a <- foo
6− b <- bar
7− 1 2 3
8− return (a + b)
data/examples/declaration/value/function/do/recursive-do-rec-out.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# LANGUAGE RecursiveDo #-}
2−
3−foo = do
4− rec a <- b + 5
5−
6− let d = c
7−
8− b <- a * 5
9−
10− something
11−
12− c <- a + b
13− print c
14− rec something $ do
15− x <- a
16− print x
17−
18− y <- c
19− print y
data/examples/declaration/value/function/do/recursive-do-rec.hsdeleted−20
@@ -1,20 +0,0 @@
1−{-# LANGUAGE RecursiveDo #-}
2−
3−foo = do
4− rec
5− a <- b + 5
6−
7− let d = c
8−
9− b <- a * 5
10−
11− something
12−
13− c <- a + b
14− print c
15− rec something $ do
16− x <- a
17− print x
18−
19− y <- c
20− print y
data/examples/declaration/value/function/explicit-type-out.hs+2−2
@@ -1,5 +1,5 @@
11foo = 5 :: Int
22
33bar =
4− 5 ::
5− Int
4+ 5
5+ :: Int
data/examples/declaration/value/function/fancy-forall-0-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−wrapError ::
2− forall outertag innertag t outer inner m a.
3− ( forall x. Coercible (t m x) (m x),
4− forall m'.
5− HasCatch outertag outer m' =>
6− HasCatch innertag inner (t m'),
7− HasCatch outertag outer m
8− ) =>
9− (forall m'. HasCatch innertag inner m' => m' a) ->
10− m a
data/examples/declaration/value/function/fancy-forall-0.hsdeleted−6
@@ -1,6 +0,0 @@
1−wrapError :: forall outertag innertag t outer inner m a.
2− ( forall x. Coercible (t m x) (m x)
3− , forall m'. HasCatch outertag outer m'
4− => HasCatch innertag inner (t m')
5− , HasCatch outertag outer m )
6− => (forall m'. HasCatch innertag inner m' => m' a) -> m a
data/examples/declaration/value/function/fancy-forall-1-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−magnify ::
2− forall outertag innertag t outer inner m a.
3− ( forall x. Coercible (t m x) (m x),
4− forall m'.
5− HasReader outertag outer m' =>
6− HasReader innertag inner (t m'),
7− HasReader outertag outer m
8− ) =>
9− (forall m'. HasReader innertag inner m' => m' a) ->
10− m a
data/examples/declaration/value/function/fancy-forall-1.hsdeleted−6
@@ -1,6 +0,0 @@
1−magnify :: forall outertag innertag t outer inner m a.
2− ( forall x. Coercible (t m x) (m x)
3− , forall m'. HasReader outertag outer m'
4− => HasReader innertag inner (t m')
5− , HasReader outertag outer m )
6− => (forall m'. HasReader innertag inner m' => m' a) -> m a
data/examples/declaration/value/function/guards-out.hs+15
@@ -1,3 +1,18 @@
1+foo :: Int -> Int
2+foo x
3+ | x == 5 = 10
4+ | otherwise = 12
5+
6+bar :: Int -> Int
7+bar x
8+ | x == 5 =
9+ foo x
10+ + foo 10
11+ | x == 6 =
12+ foo x
13+ + foo 20
14+ | otherwise = foo 100
15+
116baz :: Int -> Int
217baz x | x < 0 = x
318baz x | otherwise = x
data/examples/declaration/value/function/guards.hs+13
@@ -1,3 +1,16 @@
1+foo :: Int -> Int
2+foo x
3+ | x == 5 = 10
4+ | otherwise = 12
5+
6+bar :: Int -> Int
7+bar x
8+ | x == 5 = foo x
9+ + foo 10
10+ | x == 6 = foo x
11+ + foo 20
12+ | otherwise = foo 100
13+
114baz :: Int -> Int
215baz x | x < 0 = x
316baz x | otherwise = x
data/examples/declaration/value/function/if-multi-line-out.hs+7−14
@@ -1,23 +1,16 @@
11foo :: Int -> Int
22foo x =
33 if x > 5
4− then 10
5− else 12
4+ then 10
5+ else 12
66
77bar :: Int -> Int
88bar x =
99 if x > 5
10− then
11− foo x
12− + 100
13− else case x of
10+ then
11+ foo x
12+ + 100
13+ else
14+ case x of
1415 1 -> 10
1516 _ -> 20
16−
17−baz :: Int -> Bar
18−baz x =
19− if x > 5
20− then \case
21− Foo -> bar
22− else do
23− undefined
data/examples/declaration/value/function/if-multi-line.hs−10
@@ -10,13 +10,3 @@ bar x =
1010 else case x of
1111 1 -> 10
1212 _ -> 20
13−
14−baz :: Int -> Bar
15−baz x =
16− if x > 5
17− then
18− \case
19− Foo -> bar
20− else
21− do
22− undefined
data/examples/declaration/value/function/if-with-comment-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo =
2− if undefined
3− then -- then comment
4− undefined
5− else -- else comment
6−
7− do
8− undefined
data/examples/declaration/value/function/if-with-comment.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo =
2− if undefined
3− -- then comment
4− then undefined
5− -- else comment
6− else
7− do
8− undefined
data/examples/declaration/value/function/implicit-params-out.hs+7−8
@@ -1,16 +1,15 @@
11{-# LANGUAGE ImplicitParams #-}
22
33sortBy :: (a -> a -> Bool) -> [a] -> [a]
4−sortBy = undefined
54
65sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
76sort = sortBy ?cmp
87
9−sort' ::
10− ( ?cmp ::
11− a -> a -> Bool,
12− ?foo :: Int
13− ) =>
14− [a] ->
15− [a]
8+sort'
9+ :: ( ?cmp
10+ :: a -> a -> Bool,
11+ ?foo :: Int
12+ )
13+ => [a]
14+ -> [a]
1615sort' = sort
data/examples/declaration/value/function/implicit-params.hs−2
@@ -1,8 +1,6 @@
11{-# LANGUAGE ImplicitParams #-}
22sortBy :: (a -> a -> Bool) -> [a] -> [a]
33
4−sortBy = undefined
5−
64sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
75sort = sortBy ?cmp
86
data/examples/declaration/value/function/infix/simple-out.hs → data/examples/declaration/value/function/infix-out.hsrenamed

The content is the same.

data/examples/declaration/value/function/infix/simple.hs → data/examples/declaration/value/function/infix.hsrenamed

The content is the same.

data/examples/declaration/value/function/infix/applicative-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−f =
2− Foo <$> bar
3− <*> baz
4− <*> baz'
data/examples/declaration/value/function/infix/applicative.hsdeleted−4
@@ -1,4 +0,0 @@
1−f =
2− Foo <$> bar
3− <*> baz
4− <*> baz'
data/examples/declaration/value/function/infix/comments-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−main =
2− bar $ -- bar
3− baz -- baz
4−
5−bar $
6− {- foo
7− -}
8− bar
data/examples/declaration/value/function/infix/comments.hsdeleted−8
@@ -1,8 +0,0 @@
1−main =
2− bar $ -- bar
3− baz -- baz
4−
5−bar $
6− {- foo
7− -}
8− bar
data/examples/declaration/value/function/infix/do-out.hsdeleted−13
@@ -1,13 +0,0 @@
1−main =
2− do stuff
3− `finally` do
4− recover
5−
6−main = do stuff `finally` recover
7−
8−main = do { stuff } `finally` recover
9−
10−foo =
11− do
12− 1
13− + 2
data/examples/declaration/value/function/infix/do.hsdeleted−13
@@ -1,13 +0,0 @@
1−main =
2− do stuff
3− `finally` do
4− recover
5−
6−main = do stuff `finally` recover
7−
8−main = do { stuff } `finally` recover
9−
10−foo = do
11− 1
12− +
13− 2
data/examples/declaration/value/function/infix/dollar-chains-out.hsdeleted−22
@@ -1,22 +0,0 @@
1−module Main where
2−
3−foo =
4− fmap escapeLeadingDollar
5− . dropPaddingSpace
6− . dropWhileEnd T.null
7− . fmap (T.stripEnd . T.pack)
8− . lines
9− $ unpackHDS docStr
10−
11−foo =
12− when (GHC.xopt Cpp dynFlags && not cfgTolerateCpp) $
13− throwIO (OrmoluCppEnabled path)
14−
15−foo =
16− bar $
17− baz $
18− quux
19−
20−x =
21− case l of { A -> B } $
22− case q of r -> s
data/examples/declaration/value/function/infix/dollar-chains.hsdeleted−22
@@ -1,22 +0,0 @@
1−module Main where
2−
3−foo =
4− fmap escapeLeadingDollar
5− . dropPaddingSpace
6− . dropWhileEnd T.null
7− . fmap (T.stripEnd . T.pack)
8− . lines
9− $ unpackHDS docStr
10−
11−foo =
12− when (GHC.xopt Cpp dynFlags && not cfgTolerateCpp) $
13− throwIO (OrmoluCppEnabled path)
14−
15−foo =
16− bar
17− $ baz
18− $ quux
19−
20−x =
21− case l of { A -> B } $
22− case q of r -> s
data/examples/declaration/value/function/infix/hanging-out.hsdeleted−23
@@ -1,23 +0,0 @@
1−f = unFoo . foo bar baz 3 $ do
2− act
3− ret
4−
5−g = unFoo
6− . foo
7− bar
8− baz
9− 3
10− $ do
11− act
12− ret
13−
14−update =
15− do
16− foobar
17− `catch` \case
18− a -> a
19−
20−foo =
21− bar
22− ++ case foo of
23− a -> a
data/examples/declaration/value/function/infix/hanging.hsdeleted−19
@@ -1,19 +0,0 @@
1−f = unFoo . foo bar baz 3 $ do
2− act
3− ret
4−
5−g = unFoo . foo
6− bar
7− baz 3 $ do
8− act
9− ret
10−
11−update =
12− do
13− foobar
14− `catch` \case
15− a -> a
16−
17−foo = bar ++
18− case foo of
19− a -> a
data/examples/declaration/value/function/infix/lenses-out.hsdeleted−21
@@ -1,21 +0,0 @@
1−lenses =
2− Just $
3− M.fromList $
4− "type" .= ("user.connection" :: Text)
5− # "connection" .= uc
6− # "user" .= case name of
7− Just n -> Just $ object ["name" .= n]
8− Nothing -> Nothing
9− # []
10−
11−foo =
12− a
13− & b .~ 2
14− & c .~ 3
15−
16−wreq =
17− let opts =
18− defaults & auth ?~ awsAuth AWSv4 "key" "secret"
19− & header "Accept" .~ ["application/json"]
20− & header "Runscope-Bucket-Auth" .~ ["1example-1111-4yyyy-zzzz-xxxxxxxx"]
21− in getWith opts
data/examples/declaration/value/function/infix/lenses.hsdeleted−16
@@ -1,16 +0,0 @@
1−lenses = Just $ M.fromList
2− $ "type" .= ("user.connection" :: Text)
3− # "connection" .= uc
4− # "user" .= case name of
5− Just n -> Just $ object ["name" .= n]
6− Nothing -> Nothing
7− # []
8−
9−foo = a
10− & b .~ 2 & c .~ 3
11−
12−wreq =
13− let opts = defaults & auth ?~ awsAuth AWSv4 "key" "secret"
14− & header "Accept" .~ ["application/json"]
15− & header "Runscope-Bucket-Auth" .~ ["1example-1111-4yyyy-zzzz-xxxxxxxx"]
16− in getWith opts
data/examples/declaration/value/function/infix/unicode-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−main = print ('a' → 'a')
2− where
3− (→) = (,)
data/examples/declaration/value/function/infix/unicode.hsdeleted−3
@@ -1,3 +0,0 @@
1−main = print ('a' → 'a')
2− where
3− (→) = (,)
data/examples/declaration/value/function/lambda-case-out.hs−2
@@ -1,7 +1,5 @@
11{-# LANGUAGE LambdaCase #-}
22
3−foo = bar (\case JKey {} -> True; _ -> False)
4−
53foo :: Int -> Int
64foo = \case
75 5 -> 10
data/examples/declaration/value/function/lambda-case.hs−2
@@ -1,7 +1,5 @@
11{-# LANGUAGE LambdaCase #-}
22
3−foo = bar (\case JKey{} -> True; _ -> False)
4−
53foo :: Int -> Int
64foo = \case
75 5 -> 10
data/examples/declaration/value/function/lambda-multi-line-out.hsnew file+27
@@ -0,0 +1,27 @@
1+foo :: a -> a -> a
2+foo x = \y ->
3+ x
4+
5+bar :: Int -> Int -> Int
6+bar x = \y ->
7+ if x > y
8+ then 10
9+ else 12
10+
11+tricky0 =
12+ flip all (zip ws gs) $ \(wt, gt) ->
13+ canUnify poly_given_ok wt gt || go False wt gt
14+
15+tricky1 =
16+ flip all (zip ws gs)
17+ $ \(wt, gt) -> canUnify poly_given_ok wt gt || go False wt gt
18+
19+tricky2 =
20+ flip all (zip ws gs)
21+ $ \(wt, gt) ->
22+ canUnify poly_given_ok wt gt || go False wt gt
23+
24+foo =
25+ prop "is inverse to closure" $ \(f :: StaticPtr (Int -> Int))
26+ (x :: Int) ->
27+ (unclosure . closure) f x == deRefStaticPtr f x
data/examples/declaration/value/function/lambda-multi-line2.hs → data/examples/declaration/value/function/lambda-multi-line.hsrenamed+16
@@ -1,3 +1,13 @@
1+foo :: a -> a -> a
2+foo x = \y ->
3+ x
4+
5+bar :: Int -> Int -> Int
6+bar x = \y ->
7+ if x > y
8+ then 10
9+ else 12
10+
111tricky0 =
212 flip all (zip ws gs) $ \(wt, gt) ->
313 canUnify poly_given_ok wt gt || go False wt gt
@@ -10,3 +20,9 @@ tricky2 =
1020 flip all (zip ws gs) $
1121 \(wt, gt) ->
1222 canUnify poly_given_ok wt gt || go False wt gt
23+
24+foo =
25+ prop "is inverse to closure" $ \(f :: StaticPtr (Int -> Int))
26+ (x :: Int) ->
27+ (unclosure . closure) f x == deRefStaticPtr f x
28+
data/examples/declaration/value/function/lambda-multi-line1-out.hsdeleted−15
@@ -1,15 +0,0 @@
1−foo :: a -> a -> a
2−foo x = \y ->
3− x
4−
5−bar :: Int -> Int -> Int
6−bar x = \y ->
7− if x > y
8− then 10
9− else 12
10−
11−foo =
12− prop "is inverse to closure" $
13− \(f :: StaticPtr (Int -> Int))
14− (x :: Int) ->
15− (unclosure . closure) f x == deRefStaticPtr f x
data/examples/declaration/value/function/lambda-multi-line1.hsdeleted−14
@@ -1,14 +0,0 @@
1−foo :: a -> a -> a
2−foo x = \y ->
3− x
4−
5−bar :: Int -> Int -> Int
6−bar x = \y ->
7− if x > y
8− then 10
9− else 12
10−
11−foo =
12− prop "is inverse to closure" $ \(f :: StaticPtr (Int -> Int))
13− (x :: Int) ->
14− (unclosure . closure) f x == deRefStaticPtr f x
data/examples/declaration/value/function/lambda-multi-line2-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−tricky0 =
2− flip all (zip ws gs) $ \(wt, gt) ->
3− canUnify poly_given_ok wt gt || go False wt gt
4−
5−tricky1 =
6− flip all (zip ws gs) $
7− \(wt, gt) -> canUnify poly_given_ok wt gt || go False wt gt
8−
9−tricky2 =
10− flip all (zip ws gs) $
11− \(wt, gt) ->
12− canUnify poly_given_ok wt gt || go False wt gt
data/examples/declaration/value/function/lambda-single-line-out.hs−2
@@ -1,5 +1,3 @@
1−{-# LANGUAGE BangPatterns #-}
2−
31foo :: a -> a -> a
42foo x = \y -> x
53
data/examples/declaration/value/function/lambda-single-line.hs−2
@@ -1,5 +1,3 @@
1−{-# LANGUAGE BangPatterns #-}
2−
31foo :: a -> a -> a
42foo x = \y -> x
53
data/examples/declaration/value/function/let-multi-line-out.hs−5
@@ -21,8 +21,3 @@ implicitParams :: HasCallStack => Int
2121implicitParams =
2222 let ?cs = ?callstack
2323 in foo cs
24−
25−sitting =
26− foo $
27− let x = 20
28− in x
data/examples/declaration/value/function/let-multi-line.hs−4
@@ -21,7 +21,3 @@ implicitParams :: HasCallStack => Int
2121implicitParams =
2222 let ?cs = ?callstack
2323 in foo cs
24−
25−sitting =
26− foo $ let x = 20
27− in x
data/examples/declaration/value/function/let-nested-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−_ = _
2− where
3− _ = [_ | let _ = _]
data/examples/declaration/value/function/let-nested.hsdeleted−3
@@ -1,3 +0,0 @@
1−_ = _
2− where
3− _ = [_ | let _ = _]
data/examples/declaration/value/function/let-single-line-out.hs+2−1
@@ -1,10 +1,11 @@
11foo :: a -> a
22foo x = let x = x in x
3−foo x = let x = z where z = 2 in x
3+foo x = let x = z where { z = 2 } in x
44foo x = let x = z where { z = 2 }; a = 3 in x
55foo x = let g :: Int -> Int; g = id in ()
66
77let a = b; c = do { foo; bar }; d = baz in b
8+
89let a = case True of { True -> foo; False -> bar }; b = foo a in b
910
1011foo x = let ?g = id; ?f = g in x
data/examples/declaration/value/function/list-comprehensions-out.hs+4−3
@@ -10,7 +10,8 @@ barbaz x y z w =
1010 any even [a, b],
1111 c <-
1212 z
13− * z ^ 2, -- Bar baz
13+ * z
14+ ^ 2, -- Bar baz
1415 d <-
1516 w
1617 + w, -- Baz bar
@@ -20,5 +21,5 @@ barbaz x y z w =
2021 b,
2122 c,
2223 d
23− ]
24− ]
24+ ]
25+ ]
data/examples/declaration/value/function/list-notation-0-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−foo =
2− testCase "Foo" testFoo :
3− testCase "Bar" testBar :
4− testCase "Baz" testBaz :
5− []
data/examples/declaration/value/function/list-notation-0.hsdeleted−5
@@ -1,5 +0,0 @@
1−foo =
2− testCase "Foo" testFoo :
3− testCase "Bar" testBar :
4− testCase "Baz" testBaz :
5− []
data/examples/declaration/value/function/list-notation-1-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−instance A.ToJSON UpdateTable where
2− toJSON a =
3− A.object $
4− "TableName" .= updateTableName a :
5− "ProvisionedThroughput" .= updateProvisionedThroughput a :
6− case updateGlobalSecondaryIndexUpdates a of
7− [] -> []
8− l -> ["GlobalSecondaryIndexUpdates" .= l]
data/examples/declaration/value/function/list-notation-1.hsdeleted−7
@@ -1,7 +0,0 @@
1−instance A.ToJSON UpdateTable where
2− toJSON a = A.object
3− $ "TableName" .= updateTableName a
4− : "ProvisionedThroughput" .= updateProvisionedThroughput a
5− : case updateGlobalSecondaryIndexUpdates a of
6− [] -> []
7− l -> [ "GlobalSecondaryIndexUpdates" .= l ]
data/examples/declaration/value/function/list-notation-2-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−-- A list of the element and all its parents up to the root node.
2−getPath tree t =
3− t :
4− case Map.lookup (getId t) tree of
5− Nothing -> []
6− Just parent -> getPath tree parent
data/examples/declaration/value/function/list-notation-2.hsdeleted−5
@@ -1,5 +0,0 @@
1−-- A list of the element and all its parents up to the root node.
2−getPath tree t = t :
3− case Map.lookup (getId t) tree of
4− Nothing -> []
5− Just parent -> getPath tree parent
data/examples/declaration/value/function/list-notation-3-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−foo =
2− reportSDoc "tc.cc" 30 $
3− sep $ do
4− (prettyTCM q <+> " before compilation") : do
5− map (prettyTCM . map unArg . clPats) cls
6−
7−foo =
8− reportSDoc "tc.cc" 30 $
9− sep $ do
10− (prettyTCM q <+> " before compilation") :
11− do
12− map (prettyTCM . map unArg . clPats) cls
data/examples/declaration/value/function/list-notation-3.hsdeleted−10
@@ -1,10 +0,0 @@
1−foo =
2− reportSDoc "tc.cc" 30 $ sep $ do
3− (prettyTCM q <+> " before compilation") : do
4− map (prettyTCM . map unArg . clPats) cls
5−
6−foo =
7− reportSDoc "tc.cc" 30 $ sep $ do
8− (prettyTCM q <+> " before compilation") :
9− do
10− map (prettyTCM . map unArg . clPats) cls
data/examples/declaration/value/function/multi-way-if-out.hs+4−10
@@ -4,13 +4,7 @@ foo x = if | x == 5 -> 5
44
55bar x y =
66 if
7− | x > y -> x
8− | x < y ->
9− y
10− | otherwise -> x
11−
12−baz =
13− if
14− | p -> f
15− | otherwise -> g
16− x
7+ | x > y -> x
8+ | x < y ->
9+ y
10+ | otherwise -> x
data/examples/declaration/value/function/multi-way-if.hs−5
@@ -7,8 +7,3 @@ bar x y = if
77 | x < y
88 -> y
99 | otherwise -> x
10−
11−baz =
12− if | p -> f
13− | otherwise -> g
14− x
data/examples/declaration/value/function/multiple-guards-out.hsdeleted−14
@@ -1,14 +0,0 @@
1−foo :: Int -> Int
2−foo x
3− | x == 5 = 10
4− | otherwise = 12
5−
6−bar :: Int -> Int
7−bar x
8− | x == 5 =
9− foo x
10− + foo 10
11− | x == 6 =
12− foo x
13− + foo 20
14− | otherwise = foo 100
data/examples/declaration/value/function/multiple-guards.hsdeleted−13
@@ -1,13 +0,0 @@
1−foo :: Int -> Int
2−foo x
3− | x == 5 = 10
4− | otherwise = 12
5−
6−bar :: Int -> Int
7−bar x
8− | x == 5 = foo x
9− + foo 10
10− | x == 6 = foo x
11− + foo 20
12− | otherwise = foo 100
13−
data/examples/declaration/value/function/operator-comments-0-out.hsdeleted−16
@@ -1,16 +0,0 @@
1−foo =
2− bar
3− ++
4− {- some comment -}
5− case foo of
6− a -> a
7−
8−foo =
9− bar
10− ++ {- some comment -} case foo of
11− a -> a
12−
13−foo =
14− bar
15− ++ case foo {- some comment -} of
16− a -> a
data/examples/declaration/value/function/operator-comments-0.hsdeleted−17
@@ -1,17 +0,0 @@
1−foo =
2− bar
3− ++
4− {- some comment -}
5− case foo of
6− a -> a
7−
8−foo =
9− bar
10− ++ {- some comment -}
11− case foo of
12− a -> a
13−
14−foo =
15− bar
16− ++ case foo of {- some comment -}
17− a -> a
data/examples/declaration/value/function/operator-comments-1-out.hsdeleted−16
@@ -1,16 +0,0 @@
1−foo =
2− bar
3− ++
4− -- some comment
5− case foo of
6− a -> a
7−
8−foo =
9− bar
10− ++ case foo of -- some comment
11− a -> a
12−
13−foo =
14− bar
15− ++ case foo of -- some comment
16− a -> a
data/examples/declaration/value/function/operator-comments-1.hsdeleted−17
@@ -1,17 +0,0 @@
1−foo =
2− bar
3− ++
4− -- some comment
5− case foo of
6− a -> a
7−
8−foo =
9− bar
10− ++ -- some comment
11− case foo of
12− a -> a
13−
14−foo =
15− bar
16− ++ case foo of -- some comment
17− a -> a
data/examples/declaration/value/function/operator-comments-2-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−x =
2− y
3− ++ f g -- commentA
4− -- commentB
5− -- commentC
data/examples/declaration/value/function/operator-comments-2.hsdeleted−4
@@ -1,4 +0,0 @@
1−x =
2− y ++ -- commentA
3−-- commentB
4− f g -- commentC
data/examples/declaration/value/function/operator-sections-out.hs+2−2
@@ -5,9 +5,9 @@ bar = (<> "hello")
55baz =
66 ( 1 * 2
77 +
8− )
8+ )
99 ( *
1010 3 ^ 5
11− )
11+ )
1212
1313quux = (,) <$> foo <$> bar
data/examples/declaration/value/function/operators-0-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−a =
2− b & c .~ d
3− & e
4− %~ f
5− g
data/examples/declaration/value/function/operators-0.hsdeleted−4
@@ -1,4 +0,0 @@
1−a =
2− b & c .~ d
3− & e %~ f
4− g
data/examples/declaration/value/function/operators-1-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−foo =
2− f
3− . g
4− =<< h . i
data/examples/declaration/value/function/operators-1.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo = f
2− . g
3− =<< h . i
data/examples/declaration/value/function/operators-2-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−foo n
2− | x || y && z || n ** x
3− || x && n =
4− 42
data/examples/declaration/value/function/operators-2.hsdeleted−4
@@ -1,4 +0,0 @@
1−foo n
2− | x || y && z || n ** x
3− || x && n =
4− 42
data/examples/declaration/value/function/operators-3-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo =
2− op <> n <+> colon <+> prettySe <+> text "="
3− <+> prettySe <> text sc
data/examples/declaration/value/function/operators-3.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo =
2− op <> n <+> colon <+> prettySe <+> text "=" <+>
3− prettySe <> text sc
data/examples/declaration/value/function/operators-4-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo =
2− line <> bindingOf <+> text "=" <+> tPretty <+> colon
3− <+> align <> prettyPs
data/examples/declaration/value/function/operators-4.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo =
2− line <> bindingOf <+> text "=" <+> tPretty <+> colon <+>
3− align <> prettyPs
data/examples/declaration/value/function/operators-5-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−foo =
2− map bar $
3− [ baz
4− ]
5− ++ quux
data/examples/declaration/value/function/operators-5.hsdeleted−4
@@ -1,4 +0,0 @@
1−foo =
2− map bar $
3− [ baz
4− ] ++ quux
data/examples/declaration/value/function/operators-6-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−type PermuteRef =
2− "a"
3− :> ( "b" :> "c" :> End
4− :<|> "c" :> "b" :> End
5− )
6− :<|> "b"
7− :> ( "a" :> "c" :> End
8− :<|> "c" :> "a" :> End
9− )
data/examples/declaration/value/function/operators-6.hsdeleted−7
@@ -1,7 +0,0 @@
1−type PermuteRef =
2− "a" :> ( "b" :> "c" :> End
3− :<|> "c" :> "b" :> End
4− )
5− :<|> "b" :> ( "a" :> "c" :> End
6− :<|> "c" :> "a" :> End
7− )
data/examples/declaration/value/function/operators-out.hsnew file+45
@@ -0,0 +1,45 @@
1+foo = bar
2+ ++ case foo of
3+ a -> a
4+
5+main =
6+ bar
7+ $ baz -- bar
8+ -- baz
9+
10+bar
11+ $ {- foo
12+ -}
13+ bar
14+
15+f =
16+ Foo <$> bar
17+ <*> baz
18+
19+update =
20+ do
21+ foobar
22+ `catch` \case
23+ a -> a
24+
25+foo =
26+ do
27+ 1
28+ + 2
29+
30+main =
31+ do stuff
32+ `finally` do
33+ recover
34+
35+lenses =
36+ Just $ M.fromList
37+ $ "type"
38+ .= ("user.connection" :: Text)
39+ # "connection"
40+ .= uc
41+ # "user"
42+ .= case name of
43+ Just n -> Just $ object ["name" .= n]
44+ Nothing -> Nothing
45+ # []
data/examples/declaration/value/function/operators.hsnew file+40
@@ -0,0 +1,40 @@
1+foo = bar ++
2+ case foo of
3+ a -> a
4+
5+main =
6+ bar $ -- bar
7+ baz -- baz
8+
9+bar $
10+ {- foo
11+ -}
12+ bar
13+
14+f =
15+ Foo <$> bar
16+ <*> baz
17+
18+update =
19+ do
20+ foobar
21+ `catch` \case
22+ a -> a
23+
24+foo = do
25+ 1
26+ +
27+ 2
28+
29+main =
30+ do stuff
31+ `finally` do
32+ recover
33+
34+lenses = Just $ M.fromList
35+ $ "type" .= ("user.connection" :: Text)
36+ # "connection" .= uc
37+ # "user" .= case name of
38+ Just n -> Just $ object ["name" .= n]
39+ Nothing -> Nothing
40+ # []
data/examples/declaration/value/function/overindentation-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−reallyincrediblyLongName =
2− f
3− a
4− A
5− { reallyincrediblyLongName =
6− f
7− a
8− A
9− { reallyincrediblyLongName
10− }
11− }
data/examples/declaration/value/function/overindentation.hsdeleted−9
@@ -1,9 +0,0 @@
1−reallyincrediblyLongName = f
2− a
3− A
4− { reallyincrediblyLongName = f
5− a
6− A
7− { reallyincrediblyLongName
8− }
9− }
data/examples/declaration/value/function/parallel-comprehensions-complex-out.hs → data/examples/declaration/value/function/parallel-comprehensions-out.hsrenamed+6−2
@@ -1,3 +1,7 @@
1+foo x y = [(a, b) | a <- x | b <- y]
2+
3+bar x y z w = [(a, b, c, d) | a <- x, b <- y, a `mod` b == 0 | c <- z | d <- w]
4+
15baz x y z w =
26 [ ( a,
37 b,
@@ -9,7 +13,7 @@ baz x y z w =
913 h,
1014 i,
1115 j
12− )
16+ )
1317 | a <- -- Foo 1
1418 x, -- Foo 2
1519 b <- -- Bar 1
@@ -32,4 +36,4 @@ baz x y z w =
3236 -- Bar bar 3
3337 j <- -- Bar baz 1
3438 a + b -- Bar baz 2
35− ]
39+ ]
data/examples/declaration/value/function/parallel-comprehensions-single-line-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−foo x y = [(a, b) | a <- x | b <- y]
2−
3−bar x y z w = [(a, b, c, d) | a <- x, b <- y, a `mod` b == 0 | c <- z | d <- w]
data/examples/declaration/value/function/parallel-comprehensions-single-line.hsdeleted−4
@@ -1,4 +0,0 @@
1−foo x y = [(a,b) | a<-x | b<-y]
2−
3−bar x y z w = [(a,b,c,d) | a<-x, b<-y, a`mod`b == 0|c<-z|d<-w ]
4−
data/examples/declaration/value/function/parallel-comprehensions-complex.hs → data/examples/declaration/value/function/parallel-comprehensions.hsrenamed+4
@@ -1,3 +1,7 @@
1+foo x y = [(a,b) | a<-x | b<-y]
2+
3+bar x y z w = [(a,b,c,d) | a<-x, b<-y, a`mod`b == 0|c<-z|d<-w ]
4+
15baz x y z w = [
26 (a,b,c,d,e,
37 f,g,h,i,j) |
data/examples/declaration/value/function/parens-out.hsdeleted−1
@@ -1 +0,0 @@
1−f = p (do foo; bar) baz
data/examples/declaration/value/function/parens.hsdeleted−1
@@ -1 +0,0 @@
1−f = p (do foo; bar) baz
data/examples/declaration/value/function/pattern/as-pattern-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−main = case [1] of
2− xs@(x : _) -> print (x, xs)
3− xs@[] -> print xs
data/examples/declaration/value/function/pattern/as-pattern.hsdeleted−3
@@ -1,3 +0,0 @@
1−main = case [1] of
2− xs @ (x:_) -> print (x, xs)
3− xs@[] -> print xs
data/examples/declaration/value/function/pattern/famous-cardano-pattern-out.hs+8−8
@@ -1,8 +1,8 @@
1−( getNodeSettingsR
2− :<|> getNodeInfoR
3− :<|> getNextUpdateR
4− :<|> restartNodeR
5− )
6− :<|> ( getUtxoR
7− :<|> getConfirmedProposalsR
8− ) = client nodeV1Api
1+( getNodeSettingsR :<|>
2+ getNodeInfoR :<|>
3+ getNextUpdateR :<|>
4+ restartNodeR
5+ ) :<|>
6+ ( getUtxoR :<|>
7+ getConfirmedProposalsR
8+ ) = client nodeV1Api
data/examples/declaration/value/function/pattern/multiline-case-pattern-out.hs+2−2
@@ -10,6 +10,6 @@ f xs = case xs of
1010 ] -> a + b
1111
1212g xs = case xs of
13− ( a
14− : bs
13+ ( a :
14+ bs
1515 ) -> a + b
data/examples/declaration/value/function/pattern/n-plus-k-pattern-out.hs−3
@@ -8,6 +8,3 @@ multiline
88 ( n
99 + 1
1010 ) = n
11−
12−n :: Int
13−(n + 1) = 3
data/examples/declaration/value/function/pattern/n-plus-k-pattern.hs−3
@@ -5,6 +5,3 @@ singleline (n + 1) = n
55multiline :: Int
66multiline(n
77 + 1) = n
8−
9−n :: Int
10−(n + 1) = 3
data/examples/declaration/value/function/pattern/record-patterns-out.hs+1−1
@@ -16,4 +16,4 @@ quux
1616 { boom = a,
1717 foom = b,
1818 ..
19− } = a + b
19+ } = a + b
data/examples/declaration/value/function/pattern/sig-pattern-out.hs+2−2
@@ -2,6 +2,6 @@ f = do
22 x :: a <- g
33
44f = do
5− (x, y) ::
6− (a, b) <-
5+ (x, y)
6+ :: (a, b) <-
77 g
data/examples/declaration/value/function/pattern/splice-pattern-out.hs+2−2
@@ -7,7 +7,7 @@ singleLine = case () of
77multiline = case () of
88 $( x
99 + y
10− ) -> ()
10+ ) -> ()
1111 $( y
1212 "something"
13− ) -> ()
13+ ) -> ()
data/examples/declaration/value/function/pattern/strictness-out.hs−2
@@ -1,5 +1,3 @@
1−{-# LANGUAGE BangPatterns #-}
2−
31!a = ()
42
53~b = ()
data/examples/declaration/value/function/pattern/strictness.hs−2
@@ -1,4 +1,2 @@
1−{-# LANGUAGE BangPatterns #-}
2−
31!a = ()
42~b = ()
data/examples/declaration/value/function/pattern/unboxed-sum-pattern-out.hs+3−5
@@ -18,9 +18,7 @@ z = True
1818
1919z_multiline = True
2020 where
21− (#
22− | | _x
21+ (# | | _x
2322 #) =
24− (#
25− | | True
26− #)
23+ (# | | True
24+ #)
data/examples/declaration/value/function/record-constructors-out.hsnew file+26
@@ -0,0 +1,26 @@
1+foo = Foo {a = 3}
2+
3+bar = Bar
4+ { abc = foo,
5+ def = Foo {a = 10}
6+ }
7+
8+baz = Baz {}
9+
10+aLongVariableName =
11+ ALongRecordName
12+ { short = baz,
13+ aLongRecordFieldName = YetAnotherLongRecordName
14+ { yetAnotherLongRecordFieldName = "a long string"
15+ },
16+ aLongRecordFieldName2 =
17+ Just YetAnotherLongRecordName
18+ { yetAnotherLongRecordFieldName = "a long string",
19+ yetAnotherLongRecordFieldName =
20+ Just
21+ "a long string"
22+ },
23+ aLongRecordFieldName3 = do
24+ foo
25+ bar
26+ }
data/examples/declaration/value/function/record/constructors.hs → data/examples/declaration/value/function/record-constructors.hsrenamed+1−1
@@ -4,7 +4,7 @@ bar = Bar {
44 def = Foo {a = 10}
55}
66baz = Baz{ }
7−sym = Foo { (+) = 3 }
7+
88aLongVariableName =
99 ALongRecordName
1010 { short = baz,
data/examples/declaration/value/function/record/updaters-out.hs → data/examples/declaration/value/function/record-updaters-out.hsrenamed+1−3
@@ -4,8 +4,6 @@ bar x =
44 x
55 { abc = foo,
66 def = Foo {a = 10}
7− }
7+ }
88
99baz x = x {}
10−
11−sym x = x {(+) = 4}
data/examples/declaration/value/function/record/updaters.hs → data/examples/declaration/value/function/record-updaters.hsrenamed−1
@@ -4,4 +4,3 @@ bar x = x {
44 def = Foo {a = 10}
55}
66baz x = x{ }
7−sym x = x { (+) = 4 }
data/examples/declaration/value/function/record/wildcards-out.hs → data/examples/declaration/value/function/record-wildcards-out.hsrenamed+5−6
@@ -3,12 +3,11 @@
33
44foo x y = Foo {x, y}
55
6−bar x y z =
7− Bar
8− { x,
9− y,
10− z,
11− ..
6+bar x y z = Bar
7+ { x,
8+ y,
9+ z,
10+ ..
1211 }
1312
1413baz = Baz {..}
data/examples/declaration/value/function/record/wildcards.hs → data/examples/declaration/value/function/record-wildcards.hsrenamed

The content is the same.

data/examples/declaration/value/function/record/constructors-out.hsdeleted−31
@@ -1,31 +0,0 @@
1−foo = Foo {a = 3}
2−
3−bar =
4− Bar
5− { abc = foo,
6− def = Foo {a = 10}
7− }
8−
9−baz = Baz {}
10−
11−sym = Foo {(+) = 3}
12−
13−aLongVariableName =
14− ALongRecordName
15− { short = baz,
16− aLongRecordFieldName =
17− YetAnotherLongRecordName
18− { yetAnotherLongRecordFieldName = "a long string"
19− },
20− aLongRecordFieldName2 =
21− Just
22− YetAnotherLongRecordName
23− { yetAnotherLongRecordFieldName = "a long string",
24− yetAnotherLongRecordFieldName =
25− Just
26− "a long string"
27− },
28− aLongRecordFieldName3 = do
29− foo
30− bar
31− }
data/examples/declaration/value/function/record/dot-out.hsdeleted−15
@@ -1,15 +0,0 @@
1−{-# OPTIONS_GHC -fplugin=RecordDotPreprocessor #-}
2−
3−data Foo = Foo {bar :: Int}
4−
5−mfoo = fmap (.bar) $ Nothing
6−
7−bar = (Foo 1).bar
8−
9−fooplus f n = f{foo = f.bar + n}
10−
11−fooplus' f n = f {foo = f.bar + n}
12−
13−fooplus'' f n = f {foo = f.bar + n}
14−
15−fooplus''' f n = f {foo = f.bar + n}
data/examples/declaration/value/function/record/dot.hsdeleted−14
@@ -1,14 +0,0 @@
1−{-# OPTIONS_GHC -fplugin=RecordDotPreprocessor #-}
2−data Foo = Foo { bar :: Int }
3−
4−mfoo = fmap (.bar) $ Nothing
5−
6−bar = ( Foo 1).bar
7−
8−fooplus f n = f{foo = f.bar + n}
9−
10−fooplus' f n = f { foo = f.bar + n}
11−
12−fooplus'' f n = f {foo = f.bar + n}
13−
14−fooplus''' f n = f{ foo = f.bar + n}
data/examples/declaration/value/function/record/hanging-after-equal-con-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo =
2− Foo
3− { foo =
4− -- Blah blah
5− case x of
6− Blah -> 1
7− Blim -> 2
8− }
data/examples/declaration/value/function/record/hanging-after-equal-con.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo = Foo
2− { foo =
3− -- Blah blah
4− case x of
5− Blah -> 1
6− Blim -> 2
7− }
data/examples/declaration/value/function/record/hanging-after-equal-update-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo =
2− foo
3− { foo =
4− -- Blah blah
5− case x of
6− Blah -> 1
7− Blim -> 2
8− }
data/examples/declaration/value/function/record/hanging-after-equal-update.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo = foo
2− { foo =
3− -- Blah blah
4− case x of
5− Blah -> 1
6− Blim -> 2
7− }
data/examples/declaration/value/function/record/inter-comments-out.hsdeleted−13
@@ -1,13 +0,0 @@
1−x =
2− Just
3− -- comment
4− A
5− { x
6− }
7−
8−x =
9− Just
10− -- comment
11− a
12− { x
13− }
data/examples/declaration/value/function/record/inter-comments.hsdeleted−11
@@ -1,11 +0,0 @@
1−x = Just
2− -- comment
3− A
4− { x
5− }
6−
7−x = Just
8− -- comment
9− a
10− { x
11− }
data/examples/declaration/value/function/static-pointers-out.hs+3−4
@@ -9,12 +9,11 @@ bar =
99 [ 1,
1010 2,
1111 3
12− ]
12+ ]
1313
1414baz :: StaticPtr Bool
1515baz =
1616 static
17− ( fun
18− 1
17+ ( fun 1
1918 2
20− )
19+ )
data/examples/declaration/value/function/strings-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE MagicHash #-}
2−
3−foo = "foobar"
4−
5−bar = "foo\&barbaz"
6−
7−baz =
8− "foo\
9− \bar\
10− \baz"
data/examples/declaration/value/function/strings.hsdeleted−7
@@ -1,7 +0,0 @@
1−{-# LANGUAGE MagicHash #-}
2−
3−foo = "foobar"
4−bar = "foo\&bar\ \baz"
5−baz = "foo\
6− \bar\
7− \baz"
data/examples/declaration/value/function/transform-comprehensions-out.hsnew file+58
@@ -0,0 +1,58 @@
1+{-# LANGUAGE TransformListComp #-}
2+
3+foo xs ys = [(x, y) | x <- xs, y <- ys, then reverse]
4+
5+foo' xs ys =
6+ [ ( x,
7+ y
8+ )
9+ | x <- xs,
10+ y <- ys,
11+ -- First comment
12+ then reverse -- Second comment
13+ ]
14+
15+bar xs ys = [(x, y) | x <- xs, y <- ys, then sortWith by (x + y)]
16+
17+bar' xs ys =
18+ [ ( x,
19+ y
20+ )
21+ | x <- xs,
22+ y <- ys,
23+ -- First comment
24+ then sortWith
25+ by
26+ ( x
27+ + y -- Second comment
28+ )
29+ ]
30+
31+baz xs ys = [(x, y) | x <- xs, y <- ys, then group using permutations]
32+
33+baz' xs ys =
34+ [ ( x,
35+ y
36+ )
37+ | x <- xs,
38+ y <- ys,
39+ -- First comment
40+ then group using permutations -- Second comment
41+ ]
42+
43+quux xs ys = [(x, y) | x <- xs, y <- ys, then group by (x + y) using groupWith]
44+
45+quux' xs ys =
46+ [ ( x,
47+ y
48+ )
49+ | x <- xs,
50+ y <- ys,
51+ -- First comment
52+ then group by
53+ ( x
54+ + y
55+ )
56+ -- Second comment
57+ using groupWith -- Third comment
58+ ]
data/examples/declaration/value/function/transform-comprehensions.hsnew file+55
@@ -0,0 +1,55 @@
1+{-# LANGUAGE TransformListComp #-}
2+
3+foo xs ys = [(x, y) | x <- xs, y <- ys, then reverse]
4+
5+foo' xs ys = [
6+ (x,
7+ y) |
8+ x <- xs,
9+ y <- ys,
10+ then -- First comment
11+ reverse -- Second comment
12+ ]
13+
14+bar xs ys = [(x, y) | x <- xs, y <- ys, then sortWith by (x + y)]
15+
16+bar' xs ys = [
17+ (x,
18+ y) |
19+ x <- xs,
20+ y <- ys,
21+ then -- First comment
22+ sortWith
23+ by
24+ (x
25+ + y) -- Second comment
26+ ]
27+
28+baz xs ys = [(x, y) | x <- xs, y <- ys, then group using permutations]
29+
30+baz' xs ys = [
31+ (x,
32+ y) |
33+ x <- xs,
34+ y <- ys,
35+ then
36+ group
37+ using -- First comment
38+ permutations -- Second comment
39+ ]
40+
41+quux xs ys = [(x, y) | x <- xs, y <- ys, then group by (x + y) using groupWith]
42+
43+quux' xs ys = [
44+ (x,
45+ y) |
46+ x <- xs,
47+ y <- ys,
48+ then
49+ group
50+ by -- First comment
51+ (x
52+ + y)
53+ using -- Second comment
54+ groupWith -- Third comment
55+ ]
data/examples/declaration/value/function/tricky-parens-out.hs+1−1
@@ -1,4 +1,4 @@
11handleStuff =
22 ( let foo = foo
33 in foo
4− )
4+ )
data/examples/declaration/value/function/tuples-out.hs+2−2
@@ -4,11 +4,11 @@ bar =
44 ( 1,
55 2,
66 3
7− )
7+ )
88
99handleStuff =
1010 ( let foo = foo
1111 in foo,
1212 let bar = bar
1313 in bar
14− )
14+ )
data/examples/declaration/value/function/type-applications-and-splice-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−{-# LANGUAGE TemplateHaskell #-}
2−{-# LANGUAGE TypeApplications #-}
3−
4−staticKey name = [|sing @ $(symFQN name)|]
data/examples/declaration/value/function/type-applications-and-splice.hsdeleted−4
@@ -1,4 +0,0 @@
1−{-# LANGUAGE TemplateHaskell #-}
2−{-# LANGUAGE TypeApplications #-}
3−
4−staticKey name = [| sing @ $(symFQN name) |]
data/examples/declaration/value/function/type-applications-out.hs−6
@@ -8,9 +8,3 @@ baz =
88 f @Int @String
99 a
1010 b
11−
12−goo =
13− hash
14− @(HASH TPraosStandardCrypto)
15− @ByteString
16− "And the lamb lies down on Broadway"
data/examples/declaration/value/function/type-applications.hs−5
@@ -6,8 +6,3 @@ bar = f @(Maybe Int) a b
66
77baz = f @Int @String
88 a b
9−
10−goo = hash
11− @(HASH TPraosStandardCrypto)
12− @ByteString
13− "And the lamb lies down on Broadway"
data/examples/declaration/value/function/typed-expressions-out.hs+2−2
@@ -1,5 +1,5 @@
11foo x = x :: Int
22
33bar x =
4− Just x ::
5− Maybe String
4+ Just x
5+ :: Maybe String
data/examples/declaration/value/function/unboxed-sums-out.hs+2−3
@@ -5,6 +5,5 @@ foo = (# 1 | #)
55bar = (# | | 2 | #)
66
77baz =
8− (#
9− | | | 10 | | | | |
10− #)
8+ (# | | | 10 | | | | |
9+ #)
data/examples/declaration/value/function/unboxed-tuples-out.hs+4−5
@@ -3,8 +3,7 @@
33foo = (# 1, 2, 3 #)
44
55bar =
6− (#
7− 1,
8− 2,
9− 3
10− #)
6+ (# 1,
7+ 2,
8+ 3
9+ #)
data/examples/declaration/value/function/where-nested-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−foo = bar
2− where
3− f1 = f1
4− where
5− f1 = 3
6− f2 = f2
7− where
8− f2 = 3
9−
10−foo2 = bar
11− where
12− f1 = f1 where { f1 = 3; f1' = 4 }; f2 = f2 where f2 = 3; f2' = 4
data/examples/declaration/value/function/where-nested.hsdeleted−12
@@ -1,12 +0,0 @@
1−foo = bar
2− where
3− f1 = f1
4− where
5− f1 = 3
6− f2 = f2
7− where
8− f2 = 3
9−
10−foo2 = bar
11− where
12− { f1 = f1 where { f1 = 3; f1' = 4 }; f2 = f2 where { f2 = 3; f2' = 4 } }
data/examples/declaration/value/other/comments-get-before-op-out.hs+1−1
@@ -6,5 +6,5 @@ main = do
66 migration3
77 -- When adding migrations here, don't forget to update
88 -- 'schemaVersion' in Galley.Data
9− ]
9+ ]
1010 `finally` Log.close
data/examples/declaration/value/other/line-multi-line-out.hs+1−1
@@ -3,4 +3,4 @@ x =
33 [ 1,
44 2,
55 somethingSomething 3
6− ]
6+ ]
data/examples/declaration/value/pattern-synonyms/bidirectional-out.hs+1−4
@@ -8,7 +8,7 @@ pattern Arrow {t1, t2} = App "->" [t1, t2]
88pattern Arrow
99 { t1,
1010 t2
11− } =
11+ } =
1212 App "->" [t1, t2]
1313
1414pattern Int =
@@ -23,6 +23,3 @@ pattern Maybe t =
2323 App
2424 "Maybe"
2525 [t]
26−
27−pattern a :< b <-
28− (a, b)
data/examples/declaration/value/pattern-synonyms/bidirectional.hs−4
@@ -15,7 +15,3 @@ pattern Maybe t =
1515 App
1616 "Maybe"
1717 [t]
18−
19−pattern a :< b <-
20− (a , b)
21−
data/examples/declaration/value/pattern-synonyms/explicitely-bidirectional-out.hs−5
@@ -14,8 +14,3 @@ pattern Simple <-
1414 "Simple"
1515 where
1616 Simple = "Complicated"
17−
18−pattern a :< b <-
19− (a, b)
20− where
21− a :< b = (a, b)
data/examples/declaration/value/pattern-synonyms/explicitely-bidirectional.hs−6
@@ -11,9 +11,3 @@ pattern HeadC' x <-
1111pattern Simple <- "Simple"
1212 where
1313 Simple = "Complicated"
14−
15−pattern a :< b <-
16− (a , b)
17− where
18− a :< b = (a, b)
19−
data/examples/declaration/value/pattern-synonyms/unidirectional-out.hs+1−1
@@ -14,7 +14,7 @@ pattern FirstTwo {x, y} <-
1414pattern FirstTwo'
1515 { x,
1616 y
17− } <-
17+ } <-
1818 x : (y : xs)
1919
2020pattern Simple <- "Simple"
data/examples/declaration/warning/warning-multiline-out.hs+2−1
@@ -3,7 +3,8 @@
33 foo
44 [ "These are bad functions",
55 "Really bad!"
6− ]
6+ ]
77 #-}
8+
89test :: IO ()
910test = pure ()
data/examples/declaration/warning/warning-single-line-out.hs+1
@@ -1,4 +1,5 @@
11{-# DEPRECATED test, foo "This is a deprecation" #-}
2+
23{-# WARNING test "This is a warning" #-}
34test :: IO ()
45test = pure ()
data/examples/import/comments-inside-imports-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−-- x
2−
3−import qualified -- x
4− Bar
5−import qualified -- x
6− Baz
7−import Foo
data/examples/import/comments-inside-imports.hsdeleted−9
@@ -1,9 +0,0 @@
1−import -- x
2− Foo
3−
4−import -- x
5− qualified Bar
6−
7−import qualified
8− -- x
9− Baz
data/examples/import/deduplication-bug-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−import Foo1 (Bar1 (..), Baz1)
2−import Foo2 (Bar2 (..), Baz2)
3−import Foo3 (Bar3 (x1, x2, x3))
4−import Foo4 (Bar4 (x1, x2))
5−import Foo5 (Bar5 (x1))
6−import Foo6 (Bar6 (..))
data/examples/import/deduplication-bug.hsdeleted−6
@@ -1,6 +0,0 @@
1−import Foo1 (Bar1, Baz1, Bar1(..))
2−import Foo2 (Bar2(..), Baz2, Bar2)
3−import Foo3 (Bar3(x1,x3), Bar3(x1, x2))
4−import Foo4 (Bar4(x1), Bar4(x2))
5−import Foo5 (Bar5, Bar5(x1))
6−import Foo6 (Bar6(x1), Bar6(..))
data/examples/import/explicit-imports-out.hs+6−6
@@ -1,12 +1,12 @@
11import qualified MegaModule as M
2− ( Either,
2+ ( (<<<),
3+ (>>>),
4+ Either,
35 Maybe (Just, Nothing),
46 MaybeT (..),
5− Monad (return, (>>), (>>=)),
7+ Monad ((>>), (>>=), return),
68 MonadBaseControl,
79 join,
810 liftIO,
9− void,
10− (<<<),
11− (>>>),
12− )
11+ void
12+ )
data/examples/import/explicit-imports-with-comments-out.hs+3−4
@@ -1,7 +1,6 @@
11import qualified MegaModule as M
22 ( -- (1)
3− -- (2)
4− Either, -- (3)
5− (<<<),
3+ (<<<), -- (2)
64 (>>>),
7− )
5+ Either -- (3)
6+ )
data/examples/import/merging-0-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−import Foo
2−import Foo (bar, foo)
3−import Foo as F
data/examples/import/merging-0.hsdeleted−4
@@ -1,4 +0,0 @@
1−import Foo
2−import Foo (foo)
3−import Foo (bar)
4−import Foo as F
data/examples/import/merging-1-out.hsdeleted−2
@@ -1,2 +0,0 @@
1−import "bar" Foo (bar)
2−import "foo" Foo (baz, foo)
data/examples/import/merging-1.hsdeleted−3
@@ -1,3 +0,0 @@
1−import "foo" Foo (foo)
2−import "bar" Foo (bar)
3−import "foo" Foo (baz)
data/examples/import/merging-2-out.hsdeleted−2
@@ -1,2 +0,0 @@
1−import Foo hiding (bar4, foo2)
2−import qualified Foo (bar3, foo1)
data/examples/import/merging-2.hsdeleted−4
@@ -1,4 +0,0 @@
1−import qualified Foo (foo1)
2−import Foo hiding (foo2)
3−import qualified Foo (bar3)
4−import Foo hiding (bar4)
data/examples/import/misc-out.hs+7−1
@@ -1,5 +1,11 @@
11import A hiding
22 ( foobarbazqux,
3− )
3+ foobarbazqux,
4+ foobarbazqux,
5+ foobarbazqux,
6+ foobarbazqux,
7+ foobarbazqux,
8+ foobarbazqux
9+ )
410import {-# SOURCE #-} safe qualified Module as M hiding (a, b, c, d, e, f)
511import Name hiding ()
data/examples/import/nested-explicit-imports-out.hs+8−8
@@ -1,10 +1,10 @@
11import qualified MegaModule as M
2− ( Either,
3− Monad
4− ( return,
5− (>>),
6− (>>=)
7− ),
8− (<<<),
2+ ( (<<<),
93 (>>>),
10− )
4+ Either,
5+ Monad
6+ ( (>>),
7+ (>>=),
8+ return
9+ )
10+ )
data/examples/import/qualified-post-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−{-# LANGUAGE ImportQualifiedPost #-}
2−
3−import Data.Text qualified (a, b, c)
4−import Data.Text qualified hiding (a, b, c)
5−import Data.Text qualified as T
data/examples/import/qualified-post.hsdeleted−5
@@ -1,5 +0,0 @@
1−{-# LANGUAGE ImportQualifiedPost #-}
2−
3−import qualified Data.Text as T
4−import qualified Data.Text (a, c, b)
5−import Data.Text qualified hiding (c, b, a)
data/examples/import/qualified-prelude-out.hs+1−1
@@ -1,4 +1,4 @@
11module P where
22
3−import Prelude hiding (id, (.))
3+import Prelude hiding ((.), id)
44import qualified Prelude
data/examples/import/simple-out.hs+3−2
@@ -1,5 +1,6 @@
11import Data.Text
2+import Data.Text
3+import qualified Data.Text as T
4+import qualified Data.Text (a, b, c)
25import Data.Text (a, b, c)
36import Data.Text hiding (a, b, c)
4−import qualified Data.Text (a, b, c)
5−import qualified Data.Text as T
data/examples/import/simple.hs−2
@@ -4,5 +4,3 @@ import qualified Data.Text as T
44import qualified Data.Text (a, c, b)
55import Data.Text (a, b, c)
66import Data.Text hiding (c, b, a)
7−import Data.Text (a, b, c, b, a)
8−import Data.Text hiding (c, b, a, b, c)
data/examples/import/sorted-export-list-out.hsdeleted−1
@@ -1 +0,0 @@
1−import Linear.Vector (Additive (..), (*^), (^*))
data/examples/import/sorted-export-list.hsdeleted−1
@@ -1 +0,0 @@
1−import Linear.Vector (Additive (..), (*^), (^*))
data/examples/module-header/double-dot-with-names-out.hs+6−1
@@ -1,6 +1,11 @@
11{-# LANGUAGE PatternSynonyms #-}
22
3−module ExportSyntax (A (.., NoA), Q (F, ..), G (T, .., U)) where
3+module ExportSyntax
4+ ( A (.., NoA),
5+ Q (F, ..),
6+ G (T, .., U)
7+ )
8+where
49
510data A = A | B
611
data/examples/module-header/leading-empty-line-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−-- |
2−-- Module : Text.Megaparsec
3−-- Copyright : © 2015–2019 Megaparsec contributors
4−-- © 2007 Paolo Martini
5−-- © 1999–2001 Daan Leijen
6−-- License : FreeBSD
7−--
8−-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
9−-- Stability : experimental
10−-- Portability : portable
11−module Main where
data/examples/module-header/leading-empty-line.hsdeleted−11
@@ -1,11 +0,0 @@
1−-- |
2−-- Module : Text.Megaparsec
3−-- Copyright : © 2015–2019 Megaparsec contributors
4−-- © 2007 Paolo Martini
5−-- © 1999–2001 Daan Leijen
6−-- License : FreeBSD
7−--
8−-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
9−-- Stability : experimental
10−-- Portability : portable
11−module Main where
data/examples/module-header/multiline-out.hs+2−2
@@ -1,6 +1,6 @@
11module Foo
22 ( foo,
33 bar,
4− baz,
5− )
4+ baz
5+ )
66where
data/examples/module-header/multiline-with-comments-out.hs+2−3
@@ -6,7 +6,6 @@ module My.Module
66 ( -- * Something
77 foo,
88 bar,
9−
109 -- * Another thing
1110 (<?>),
1211 {- some other thing -} foo2, -- yet another
@@ -15,8 +14,8 @@ module My.Module
1514 bar2, -- a multiline comment
1615 -- the second line
1716 bar3,
18− module Foo.Bar.Baz,
19− )
17+ module Foo.Bar.Baz
18+ )
2019where
2120
2221-- Wow
data/examples/module-header/multiline2-out.hs+2−2
@@ -1,6 +1,6 @@
11module Foo
22 ( foo,
33 bar,
4− baz,
5− )
4+ baz
5+ )
66where
data/examples/module-header/multiline2.hs+2−2
@@ -1,2 +1,2 @@
1−module Foo (
2− foo, bar, baz) where
1+module Foo
2+ (foo, bar, baz) where
data/examples/module-header/named-section-out.hsdeleted−13
@@ -1,13 +0,0 @@
1−module Magic
2− ( -- * Something
3− -- $explanation
4−
5− -- ** Another level
6− foo,
7− bar,
8− )
9−where
10−
11−-- $explanation
12−--
13−-- Here it goes.
data/examples/module-header/named-section.hsdeleted−13
@@ -1,13 +0,0 @@
1−module Magic
2− ( -- * Something
3− -- $explanation
4−
5− -- ** Another level
6− foo
7− , bar
8− )
9−where
10−
11−-- $explanation
12−--
13−-- Here it goes.
data/examples/module-header/preceding-comment-with-haddock-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−{-
2− Here we go.
3−-}
4−
5−-- | This is the module's Haddock.
6−module Main (main) where
7−
8−main = return ()
data/examples/module-header/preceding-comment-with-haddock.hsdeleted−8
@@ -1,8 +0,0 @@
1−{-
2− Here we go.
3−-}
4−
5−-- | This is the module's Haddock.
6−module Main (main) where
7−
8−main = return ()
data/examples/module-header/shebang-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−#! /usr/bin/env runhaskell
2−
3−import Prelude
4−
5−main :: IO ()
6−main = putStrLn "hello world"
data/examples/module-header/shebang-with-pragmas-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−#!/usr/bin/env stack
2−
3−{-# LANGUAGE OverloadedStrings #-}
4−
5−main = pure ()
data/examples/module-header/shebang-with-pragmas.hsdeleted−5
@@ -1,5 +0,0 @@
1−#!/usr/bin/env stack
2−
3−{-# LANGUAGE OverloadedStrings #-}
4−
5−main = pure ()
data/examples/module-header/shebang.hsdeleted−6
@@ -1,6 +0,0 @@
1−#! /usr/bin/env runhaskell
2−
3−import Prelude
4−
5−main :: IO ()
6−main = putStrLn "hello world"
data/examples/module-header/singleline-empty-out.hs+4−1
@@ -1,2 +1,5 @@
11-- | This demonstrates a BUG.
2−module Foo () where
2+module Foo
3+ (
4+ )
5+where
data/examples/module-header/stack-header-0-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−-- stack runhaskell
2−
3−{-# LANGUAGE OverloadedStrings #-}
4−
5−main = return ()
6−
7−-- stack runhaskell
data/examples/module-header/stack-header-0.hsdeleted−4
@@ -1,4 +0,0 @@
1−-- stack runhaskell
2−{-# LANGUAGE OverloadedStrings #-}
3−main = return ()
4−-- stack runhaskell
data/examples/module-header/stack-header-1-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−#!/usr/bin/env stack
2−-- stack runhaskell
3−
4−{-# LANGUAGE OverloadedStrings #-}
5−
6−main = return ()
7−
8−-- stack runhaskell
data/examples/module-header/stack-header-1.hsdeleted−5
@@ -1,5 +0,0 @@
1−#!/usr/bin/env stack
2−-- stack runhaskell
3−{-# LANGUAGE OverloadedStrings #-}
4−main = return ()
5−-- stack runhaskell
data/examples/module-header/stack-header-2-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−#!/usr/bin/env stack
2−{- stack
3− script
4− --resolver lts-6.25
5− --package turtle
6− --package "stm async"
7− --package http-client,http-conduit
8−-}
9−
10−{-# LANGUAGE OverloadedStrings #-}
11−
12−main = return ()
data/examples/module-header/stack-header-2.hsdeleted−12
@@ -1,12 +0,0 @@
1−#!/usr/bin/env stack
2−{- stack
3− script
4− --resolver lts-6.25
5− --package turtle
6− --package "stm async"
7− --package http-client,http-conduit
8−-}
9−
10−{-# LANGUAGE OverloadedStrings #-}
11−
12−main = return ()
data/examples/module-header/warning-pragma-list-multiline-out.hs+3−3
@@ -2,10 +2,10 @@ module Test
22 {-# DEPRECATED
33 [ "This module is deprecated.",
44 "Please use OtherModule instead."
5− ]
5+ ]
66 #-}
77 ( foo,
88 bar,
9− baz,
10− )
9+ baz
10+ )
1111where
data/examples/module-header/warning-pragma-multiline-out.hs+4−1
@@ -1,6 +1,9 @@
11module Test
22 {-# DEPRECATED "This module is unstable" #-}
3− (foo, bar, baz)
3+ ( foo,
4+ bar,
5+ baz
6+ )
47where
58
69import Blah
data/examples/module-header/warning-pragma-out.hs+1−3
@@ -1,5 +1,3 @@
11module Test
2− {-# WARNING
3− "This module is very internal"
4− #-}
2+ {-# WARNING "This module is very internal" #-}
53where
data/examples/other/argument-comment-out.hs+12−14
@@ -1,16 +1,14 @@
1−foo ::
2− -- | Documentation
3− Int ->
4− Bool
1+foo
2+ :: Int -- ^ Documentation
3+ -> Bool
54foo _ = True
65
7−foo ::
8− Foo a =>
9− -- | Foo
10− Int ->
11− Int
12−foo ::
13− Foo a =>
14− -- | Foo
15− Int ->
16− Int
6+foo
7+ :: Foo a
8+ => Int -- ^ Foo
9+ -> Int
10+
11+foo
12+ :: Foo a
13+ => Int -- ^ Foo
14+ -> Int
data/examples/other/comment-after-preceding-haddock-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−module Main where
2−
3−-- | A
4−
5−-- B
6−
7−type D = E
8−
9−-- | This is 'f'
10−
11−-- * Comment
12−f :: a -> b
data/examples/other/comment-after-preceding-haddock.hsdeleted−12
@@ -1,12 +0,0 @@
1−module Main where
2−
3−-- | A
4−
5−-- B
6−
7−type D = E
8−
9−-- | This is 'f'
10−
11−-- * Comment
12−f :: a -> b
data/examples/other/comment-alignment-out.hs+4−4
@@ -1,9 +1,9 @@
11class Foo a where
2+
23 -- | Foo.
3− foo ::
4− Int ->
5− -- | Something
6− a
4+ foo
5+ :: Int
6+ -> a -- ^ Something
77
88 -- | Bar.
99 bar :: a
data/examples/other/comment-before-hanging-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−x = Just
2− -- comment
3− do
4− foo
5− bar
data/examples/other/comment-before-hanging.hsdeleted−5
@@ -1,5 +0,0 @@
1−x = Just
2− -- comment
3− do
4− foo
5− bar
data/examples/other/comment-following-preceding-gap-out.hsdeleted−6
@@ -1,6 +0,0 @@
1−foo = bar
2− where
3− baz = return (quux) -- Foo
4−
5− -- Bar
6− meme = gege
data/examples/other/comment-following-preceding-gap.hsdeleted−6
@@ -1,6 +0,0 @@
1−foo = bar
2− where
3− baz = return (quux) -- Foo
4−
5− -- Bar
6− meme = gege
data/examples/other/comment-glued-together-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−module Main (main) where
2−
3−-- | Foo.
4−
5−-- Bar
6−main :: IO ()
7−main = return ()
data/examples/other/comment-glued-together.hsdeleted−6
@@ -1,6 +0,0 @@
1−module Main (main) where
2−
3−{- | Foo. -}
4−-- Bar
5−main :: IO ()
6−main = return ()
data/examples/other/comment-inside-construct-out.hs+2−2
@@ -3,6 +3,6 @@ xs =
33 [ inner list first item,
44 inner list second item
55 -- inner list last item commented
6− ],
6+ ],
77 outer list item
8− ]
8+ ]
data/examples/other/comment-multiline-after-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo ::
2− -- | start index
3− Int ->
4− -- | length
5− Int ->
6− t a ->
7− t a
data/examples/other/comment-multiline-after.hsdeleted−1
@@ -1 +0,0 @@
1−foo :: Int {- ^ start index -} -> Int {- ^ length -} -> t a -> t a
data/examples/other/comment-style-transform-out.hsdeleted−17
@@ -1,17 +0,0 @@
1−-- |
2−-- Module: Data.Aeson.TH
3−-- Copyright: (c) 2011-2016 Bryan O'Sullivan
4−-- (c) 2011 MailRank, Inc.
5−-- License: BSD3
6−-- Stability: experimental
7−-- Portability: portable
8−module Main where
9−
10−-- |
11−--
12−-- Here is a snippet:
13−--
14−-- @
15−-- x = y + 2
16−-- @
17−x = y + 2
data/examples/other/comment-style-transform.hsdeleted−22
@@ -1,22 +0,0 @@
1−{-|
2−Module: Data.Aeson.TH
3−Copyright: (c) 2011-2016 Bryan O'Sullivan
4− (c) 2011 MailRank, Inc.
5−License: BSD3
6−Stability: experimental
7−Portability: portable
8−-}
9−
10−module Main where
11−
12−{- |
13−
14−Here is a snippet:
15−
16−@
17−x = y + 2
18−@
19−
20−-}
21−
22−x = y + 2
data/examples/other/comment-trailing-space-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−data T
2− = {-
3−
4− some multi-line comment
5−
6− with empty lines
7−
8− -}
9− A
data/examples/other/comment-trailing-space.hsdeleted−9
@@ -1,9 +0,0 @@
1−data T
2− = {-
3−
4− some multi-line comment
5−
6− with empty lines
7−
8− -}
9− A
data/examples/other/comment-two-blocks-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−newNames :: [(String, String)]
2−newNames =
3− let (*) = flip (,)
4− in [ "Control" * "Monad"
5− -- Foo
6−
7− -- Bar
8− ]
data/examples/other/comment-two-blocks.hsdeleted−9
@@ -1,9 +0,0 @@
1−newNames :: [(String, String)]
2−newNames = let (*) = flip (,) in
3− ["Control" * "Monad"
4−
5− -- Foo
6−
7− -- Bar
8−
9− ]
data/examples/other/consequetive-pipe-comments-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−
5−-- | Bar.
6−bar :: Int
7−bar = 5
data/examples/other/consequetive-pipe-comments.hsdeleted−8
@@ -1,8 +0,0 @@
1−module Main where
2−
3−-- | Foo.
4−
5−-- | Bar.
6−
7−bar :: Int
8−bar = 5
data/examples/other/cpp/continuation-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo :: Int
2−foo = 5
3−
4−#define message_for(a, b) \
5− printf(#a " and " #b ": We love you!\n")
6−
7−bar :: Int
8−bar = 6
data/examples/other/cpp/continuation.hsdeleted−8
@@ -1,8 +0,0 @@
1−foo :: Int
2−foo = 5
3−
4−#define message_for(a, b) \
5− printf(#a " and " #b ": We love you!\n")
6−
7−bar :: Int
8−bar = 6
data/examples/other/cpp/lonely-hash-out.hsdeleted−14
@@ -1,14 +0,0 @@
1−module Main (main) where
2−
3−import Data.Void
4−import Test.Hspec
5−import Test.Hspec.Megaparsec
6−import Text.Megaparsec
7−import Text.Megaparsec.Char
8−
9−# if !MIN_VERSION_base(4,13,0)
10−import Data.Semigroup ((<>))
11−# endif
12−
13−main :: IO ()
14−main = return ()
data/examples/other/cpp/lonely-hash.hsdeleted−14
@@ -1,14 +0,0 @@
1−module Main (main) where
2−
3−import Data.Void
4−import Test.Hspec
5−import Test.Hspec.Megaparsec
6−import Text.Megaparsec
7−import Text.Megaparsec.Char
8−
9−# if !MIN_VERSION_base(4,13,0)
10−import Data.Semigroup ((<>))
11−# endif
12−
13−main :: IO ()
14−main = return ()
data/examples/other/cpp/separation-0a-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−instance Stream s => Monad (ParsecT e s m) where
2− return = pure
3− (>>=) = pBind
4−
5−#if !(MIN_VERSION_base(4,13,0))
6− fail = Fail.fail
7−#endif
data/examples/other/cpp/separation-0a.hsdeleted−6
@@ -1,6 +0,0 @@
1−instance Stream s => Monad (ParsecT e s m) where
2− return = pure
3− (>>=) = pBind
4−#if !(MIN_VERSION_base(4,13,0))
5− fail = Fail.fail
6−#endif
data/examples/other/cpp/separation-0b-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−instance Stream s => Monad (ParsecT e s m) where
2− return = pure
3− (>>=) = pBind
4−
5−#if !(MIN_VERSION_base(4,13,0))
6− fail = Fail.fail
7−#endif
8−
9−foo :: Int
10−foo = undefined
data/examples/other/cpp/separation-0b.hsdeleted−9
@@ -1,9 +0,0 @@
1−instance Stream s => Monad (ParsecT e s m) where
2− return = pure
3− (>>=) = pBind
4−#if !(MIN_VERSION_base(4,13,0))
5− fail = Fail.fail
6−#endif
7−
8−foo :: Int
9−foo = undefined
data/examples/other/cpp/separation-1a-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−decompressingPipe ::
2− (PrimMonad m, MonadThrow m, MonadResource m) =>
3− CompressionMethod ->
4− ConduitT ByteString ByteString m ()
5−decompressingPipe Store = C.awaitForever C.yield
6−decompressingPipe Deflate = Z.decompress $ Z.WindowBits (-15)
7−
8−#ifdef ENABLE_BZIP2
9−decompressingPipe BZip2 = BZ.bunzip2
10−#else
11−decompressingPipe BZip2 = throwM BZip2Unsupported
12−#endif
data/examples/other/cpp/separation-1a.hsdeleted−11
@@ -1,11 +0,0 @@
1−decompressingPipe
2− :: (PrimMonad m, MonadThrow m, MonadResource m)
3− => CompressionMethod
4− -> ConduitT ByteString ByteString m ()
5−decompressingPipe Store = C.awaitForever C.yield
6−decompressingPipe Deflate = Z.decompress $ Z.WindowBits (-15)
7−#ifdef ENABLE_BZIP2
8−decompressingPipe BZip2 = BZ.bunzip2
9−#else
10−decompressingPipe BZip2 = throwM BZip2Unsupported
11−#endif
data/examples/other/cpp/separation-1b-out.hsdeleted−15
@@ -1,15 +0,0 @@
1−decompressingPipe ::
2− (PrimMonad m, MonadThrow m, MonadResource m) =>
3− CompressionMethod ->
4− ConduitT ByteString ByteString m ()
5−decompressingPipe Store = C.awaitForever C.yield
6−decompressingPipe Deflate = Z.decompress $ Z.WindowBits (-15)
7−
8−#ifdef ENABLE_BZIP2
9−decompressingPipe BZip2 = BZ.bunzip2
10−#else
11−decompressingPipe BZip2 = throwM BZip2Unsupported
12−#endif
13−
14−foo :: Int
15−foo = undefined
data/examples/other/cpp/separation-1b.hsdeleted−14
@@ -1,14 +0,0 @@
1−decompressingPipe
2− :: (PrimMonad m, MonadThrow m, MonadResource m)
3− => CompressionMethod
4− -> ConduitT ByteString ByteString m ()
5−decompressingPipe Store = C.awaitForever C.yield
6−decompressingPipe Deflate = Z.decompress $ Z.WindowBits (-15)
7−#ifdef ENABLE_BZIP2
8−decompressingPipe BZip2 = BZ.bunzip2
9−#else
10−decompressingPipe BZip2 = throwM BZip2Unsupported
11−#endif
12−
13−foo :: Int
14−foo = undefined
data/examples/other/cpp/separation-2a-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−ffff, ffffffff :: Natural
2−
3−#ifdef HASKELL_ZIP_DEV_MODE
4−ffff = 200
5−ffffffff = 5000
6−#else
7−ffff = 0xffff
8−ffffffff = 0xffffffff
9−#endif
data/examples/other/cpp/separation-2a.hsdeleted−8
@@ -1,8 +0,0 @@
1−ffff, ffffffff :: Natural
2−#ifdef HASKELL_ZIP_DEV_MODE
3−ffff = 200
4−ffffffff = 5000
5−#else
6−ffff = 0xffff
7−ffffffff = 0xffffffff
8−#endif
data/examples/other/cpp/separation-2b-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−ffff, ffffffff :: Natural
2−#ifdef HASKELL_ZIP_DEV_MODE
3−ffff = 200
4−ffffffff = 5000
5−#else
6−ffff = 0xffff
7−ffffffff = 0xffffffff
8−#endif
9−
10−foo :: Int
11−foo = undefined
data/examples/other/cpp/separation-2b.hsdeleted−11
@@ -1,11 +0,0 @@
1−ffff, ffffffff :: Natural
2−#ifdef HASKELL_ZIP_DEV_MODE
3−ffff = 200
4−ffffffff = 5000
5−#else
6−ffff = 0xffff
7−ffffffff = 0xffffffff
8−#endif
9−
10−foo :: Int
11−foo = undefined
data/examples/other/cpp/shifted-out.hsdeleted−21
@@ -1,21 +0,0 @@
1−sinkData h compression = do
2− (uncompressedSize, crc32, compressedSize) <-
3− case compression of
4− Store ->
5− withCompression
6− dataSink
7− Deflate ->
8− withCompression $
9− Z.compress 9 (Z.WindowBits (-15)) .| dataSink
10−#ifdef ENABLE_BZIP2
11− BZip2 -> withCompression $
12− BZ.bzip2 .| dataSink
13−#else
14− BZip2 -> throwM BZip2Unsupported
15−#endif
16− return
17− DataDescriptor
18− { ddCRC32 = fromIntegral crc32,
19− ddCompressedSize = compressedSize,
20− ddUncompressedSize = uncompressedSize
21− }
data/examples/other/cpp/shifted.hsdeleted−17
@@ -1,17 +0,0 @@
1−sinkData h compression = do
2− (uncompressedSize, crc32, compressedSize) <-
3− case compression of
4− Store -> withCompression
5− dataSink
6− Deflate -> withCompression $
7− Z.compress 9 (Z.WindowBits (-15)) .| dataSink
8−#ifdef ENABLE_BZIP2
9− BZip2 -> withCompression $
10− BZ.bzip2 .| dataSink
11−#else
12− BZip2 -> throwM BZip2Unsupported
13−#endif
14− return DataDescriptor
15− { ddCRC32 = fromIntegral crc32
16− , ddCompressedSize = compressedSize
17− , ddUncompressedSize = uncompressedSize }
data/examples/other/cpp/simple-import-out.hsdeleted−14
@@ -1,14 +0,0 @@
1−module Main (main) where
2−
3−import Data.Void
4−import Test.Hspec
5−import Test.Hspec.Megaparsec
6−import Text.Megaparsec
7−import Text.Megaparsec.Char
8−
9−#if !MIN_VERSION_base(4,13,0)
10−import Data.Semigroup ((<>))
11−#endif
12−
13−main :: IO ()
14−main = return ()
data/examples/other/cpp/simple-import.hsdeleted−14
@@ -1,14 +0,0 @@
1−module Main (main) where
2−
3−import Data.Void
4−import Test.Hspec
5−import Test.Hspec.Megaparsec
6−import Text.Megaparsec
7−import Text.Megaparsec.Char
8−
9−#if !MIN_VERSION_base(4,13,0)
10−import Data.Semigroup ((<>))
11−#endif
12−
13−main :: IO ()
14−main = return ()
data/examples/other/disabling/indented-fragment-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo =
2− {- ORMOLU_DISABLE -}
3− testCase "Foo" testFoo :
4− testCase "Bar" testBar :
5− testCase "Baz" testBaz :
6− {- ORMOLU_ENABLE -}
7− []
data/examples/other/disabling/indented-fragment.hsdeleted−7
@@ -1,7 +0,0 @@
1−foo =
2− {- ORMOLU_DISABLE -}
3− testCase "Foo" testFoo :
4− testCase "Bar" testBar :
5− testCase "Baz" testBaz :
6− {- ORMOLU_ENABLE -}
7− []
data/examples/other/disabling/single-definition-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−module Foo (foo, bar) where
2−
3−{- ORMOLU_DISABLE -}
4−foo :: Int -> Int
5−foo = (+5)
6−{- ORMOLU_ENABLE -}
7−
8−bar :: Bool -> Bool
9−bar True = True
10−bar False = True
data/examples/other/disabling/single-definition.hsdeleted−10
@@ -1,10 +0,0 @@
1−module Foo (foo,bar) where
2−
3−{- ORMOLU_DISABLE -}
4−foo :: Int -> Int
5−foo = (+5)
6−{- ORMOLU_ENABLE -}
7−
8−bar :: Bool -> Bool
9−bar True = True
10−bar False = True
data/examples/other/disabling/whole-file-out.hsdeleted−10
@@ -1,10 +0,0 @@
1−{- ORMOLU_DISABLE -}
2−
3−module Foo (foo,bar) where
4−
5−foo :: Int -> Int
6−foo = (+5)
7−
8−bar :: Bool -> Bool
9−bar True = True
10−bar False = True
data/examples/other/disabling/whole-file.hsdeleted−10
@@ -1,10 +0,0 @@
1−{- ORMOLU_DISABLE -}
2−
3−module Foo (foo,bar) where
4−
5−foo :: Int -> Int
6−foo = (+5)
7−
8−bar :: Bool -> Bool
9−bar True = True
10−bar False = True
data/examples/other/empty-forall-out.hsdeleted−18
@@ -1,18 +0,0 @@
1−-- Empty foralls are handled correctly in different situations.
2−
3−data D = forall. D Int
4−
5−data G where
6− G :: forall. Int -> G
7−
8−f :: forall. a -> a
9−f x = x
10−
11−type family T x where
12− forall. T x = x
13−
14−{-# RULES
15−"r"
16− r a =
17− ()
18− #-}
data/examples/other/empty-forall.hsdeleted−17
@@ -1,17 +0,0 @@
1−-- Empty foralls are handled correctly in different situations.
2−
3−data D = forall. D Int
4−
5−data G where
6− G :: forall. Int -> G
7−
8−f :: forall. a -> a
9−f x = x
10−
11−type family T x where
12− forall. T x = x
13−
14−{-# RULES
15− "r"
16− forall. r a = ()
17−#-}
data/examples/other/empty-haddock-out.hsdeleted−5
@@ -1,5 +0,0 @@
1−module Main where
2−
3−-- |
4−foo :: Int
5−foo = 5
data/examples/other/empty-haddock.hsdeleted−6
@@ -1,6 +0,0 @@
1−module Main where
2−
3−-- |
4−
5−foo :: Int
6−foo = 5
data/examples/other/following-comment-last-0-out.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Another datatype...
42data D'
53-- ^ ...with two docstrings.
data/examples/other/following-comment-last-0.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Another datatype...
42data D'
53-- ^ ...with two docstrings.
data/examples/other/following-comment-last-1-out.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Another datatype...
42data D'
53 deriving (Show)
data/examples/other/following-comment-last-1.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Another datatype...
42data D'
53 deriving (Show)
data/examples/other/following-comment-last-2-out.hs−3
@@ -1,10 +1,7 @@
1−module Main where
2−
31-- | Another datatype...
42data D'
53 deriving (Show)
64-- ^ ...with two docstrings.
75
86-- more
9−
107data B
data/examples/other/following-comment-last-2.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Another datatype...
42data D'
53 deriving (Show)
data/examples/other/following-comment-last-3-out.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Another datatype...
42data D'
53-- ^ ...with two docstrings.
data/examples/other/following-comment-last-3.hs−2
@@ -1,5 +1,3 @@
1−module Main where
2−
31-- | Another datatype...
42data D'
53-- ^ ...with two docstrings.
data/examples/other/haddock-sections-out.hsdeleted−7
@@ -1,7 +0,0 @@
1−-- $weird #anchor#
2−--
3−-- Section 1
4−
5−-- $normal
6−--
7−-- Section 2
data/examples/other/haddock-sections.hsdeleted−7
@@ -1,7 +0,0 @@
1−-- $weird #anchor#
2−--
3−-- Section 1
4−
5−-- $normal
6−--
7−-- Section 2
data/examples/other/inline-comment-0-out.hsdeleted−3
@@ -1,3 +0,0 @@
1−x = ({-a-} b, c)
2−
3−y = ({-a-} b)
data/examples/other/inline-comment-0.hsdeleted−3
@@ -1,3 +0,0 @@
1−x = ({-a-}b, c)
2−
3−y = ({-a-}b)
data/examples/other/inline-comment-1-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−showPs env ((n, _, Let _ t v) : bs) =
2− " " ++ show n ++ " : "
3− ++ showEnv env ({- normalise ctxt env -} t)
4− ++ " = "
5− ++ showEnv env ({- normalise ctxt env -} v)
6− ++ "\n"
7− ++ showPs env bs
8−showPs env ((n, _, b) : bs) =
9− " " ++ show n ++ " : "
10− ++ showEnv env ({- normalise ctxt env -} (binderTy b))
11− ++ "\n"
12− ++ showPs env bs
data/examples/other/inline-comment-1.hsdeleted−9
@@ -1,9 +0,0 @@
1−showPs env ((n, _, Let _ t v):bs)
2− = " " ++ show n ++ " : " ++
3− showEnv env ({- normalise ctxt env -} t) ++ " = " ++
4− showEnv env ({- normalise ctxt env -} v) ++
5− "\n" ++ showPs env bs
6−showPs env ((n, _, b):bs)
7− = " " ++ show n ++ " : " ++
8− showEnv env ({- normalise ctxt env -} (binderTy b)) ++
9− "\n" ++ showPs env bs
data/examples/other/merging-comments-out.hsdeleted−12
@@ -1,12 +0,0 @@
1−foo xs = baz
2− where
3− bar =
4− catMaybes
5− [ lookup langKey gets, -- 1
6− lookup langKey cookies, -- 2
7− lookupText langKey session -- 3
8− ]
9− ++ xs -- 4
10−
11− -- Blah
12− baz = addTwoLetters (id, Set.empty) bar
data/examples/other/merging-comments.hsdeleted−9
@@ -1,9 +0,0 @@
1−foo xs = baz
2− where
3− bar = catMaybes [ lookup langKey gets -- 1
4− , lookup langKey cookies -- 2
5− , lookupText langKey session -- 3
6− ] ++ xs -- 4
7−
8− -- Blah
9− baz = addTwoLetters (id, Set.empty) bar
data/examples/other/multiline-forall-out.hsdeleted−58
@@ -1,58 +0,0 @@
1−{-# LANGUAGE GADTs #-}
2−{-# LANGUAGE PolyKinds #-}
3−{-# LANGUAGE RankNTypes #-}
4−{-# LANGUAGE TypeFamilies #-}
5−
6−-- Multiline foralls are consistent across all declarations
7−
8−data D
9− = forall
10− ( f ::
11− * -> * -> *
12− )
13− (x :: *)
14− (y :: *).
15− D (f x y)
16−
17−data G where
18− G ::
19− forall
20− ( f ::
21− * -> * -> *
22− )
23− (x :: *)
24− (y :: *).
25− f x y ->
26− G
27−
28−f ::
29− forall
30− ( f ::
31− * -> * -> *
32− )
33− (x :: *)
34− (y :: *).
35− f x y ->
36− ()
37−f = const ()
38−
39−type family T f x y where
40− forall
41− ( f ::
42− * -> * -> *
43− )
44− (x :: *)
45− (y :: *).
46− T f x y =
47− f x y
48−
49−{-# RULES
50−"r" forall
51− ( f ::
52− * -> * -> *
53− )
54− (x :: *)
55− (y :: *).
56− r (a :: f x y) =
57− ()
58− #-}
data/examples/other/multiline-forall.hsdeleted−46
@@ -1,46 +0,0 @@
1−{-# LANGUAGE RankNTypes, PolyKinds, GADTs, TypeFamilies #-}
2−
3−-- Multiline foralls are consistent across all declarations
4−
5−data D =
6− forall
7− (f ::
8− * -> * -> *)
9− (x :: *)
10− (y :: *)
11− . D (f x y)
12−
13−data G where
14− G :: forall
15− (f ::
16− * -> * -> *)
17− (x :: *)
18− (y :: *)
19− . f x y -> G
20−
21−f :: forall
22− (f ::
23− * -> * -> *)
24− (x :: *)
25− (y :: *)
26− . f x y -> ()
27−f = const ()
28−
29−type family T f x y where
30− forall
31− (f ::
32− * -> * -> *)
33− (x :: *)
34− (y :: *)
35− . T f x y = f x y
36−
37−{-# RULES
38− "r"
39− forall
40− (f ::
41− * -> * -> *)
42− (x :: *)
43− (y :: *)
44− . r (a :: f x y) =
45− ()
46− #-}
data/examples/other/multiple-blank-line-comment-out.hsdeleted−9
@@ -1,9 +0,0 @@
1−module A where
2−
3−a =
4− b
5− [ f
6− {-,
7−
8− -}
9− ]
data/examples/other/multiple-blank-line-comment.hsdeleted−10
@@ -1,10 +0,0 @@
1−module A where
2−
3−a =
4− b
5− [ f
6− {-,
7−
8−
9− -}
10− ]
data/examples/other/overly-indented-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−tagCloudField ::
2− -- | Destination key
3− String ->
4− -- | Smallest font size, in percent
5− Double ->
6− -- | Biggest font size, in percent
7− Double ->
8− -- | Input tags
9− Tags ->
10− -- | Context
11− Context a
data/examples/other/overly-indented.hsdeleted−10
@@ -1,10 +0,0 @@
1−tagCloudField :: String
2− -- ^ Destination key
3− -> Double
4− -- ^ Smallest font size, in percent
5− -> Double
6− -- ^ Biggest font size, in percent
7− -> Tags
8− -- ^ Input tags
9− -> Context a
10− -- ^ Context
data/examples/other/pragma-comments-after-out.hsdeleted−4
@@ -1,4 +0,0 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−-- TODO: Fix and delete this pragma
4−{-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-}
data/examples/other/pragma-comments-after.hsdeleted−3
@@ -1,3 +0,0 @@
1−{-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-} -- TODO: Fix and delete this pragma
2−{-# LANGUAGE AllowAmbiguousTypes #-}
3−{-# LANGUAGE ConstraintKinds #-}
data/examples/other/pragma-comments-out.hsdeleted−8
@@ -1,8 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−-- TODO This extension is probably too dangerous, remove it.
3−{-# LANGUAGE RecordWildCards #-}
4−-- Avoid warning produced by TH.
5−{-# OPTIONS_GHC -fno-warn-overlapping-patterns #-}
6−
7−-- | Header comment.
8−module Foo () where
data/examples/other/pragma-comments.hsdeleted−11
@@ -1,11 +0,0 @@
1−-- | Header comment.
2−
3−{-# LANGUAGE OverloadedStrings #-}
4−
5−-- Avoid warning produced by TH.
6−{-# OPTIONS_GHC -fno-warn-overlapping-patterns #-}
7−
8−-- TODO This extension is probably too dangerous, remove it.
9−{-# LANGUAGE RecordWildCards #-}
10−
11−module Foo () where
data/examples/other/pragma-out.hs+4−1
@@ -9,4 +9,7 @@
99{-# OPTIONS_HADDOCK prune, show-extensions #-}
1010
1111-- | Header comment.
12−module Foo () where
12+module Foo
13+ (
14+ )
15+where
data/examples/other/pragma-sorting-out.hsdeleted−11
@@ -1,11 +0,0 @@
1−{-# LANGUAGE NondecreasingIndentation #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE TypeFamilies #-}
4−-- This gap is necessary for stylish Haskell not to re-arrange
5−-- NoMonoLocalBinds before TypeFamilies
6−{-# LANGUAGE NoMonoLocalBinds #-}
7−
8−module Foo
9− ( bar,
10− )
11−where
data/examples/other/pragma-sorting.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE ScopedTypeVariables #-}
2−{-# LANGUAGE TypeFamilies #-}
3−{-# LANGUAGE NondecreasingIndentation #-}
4−-- This gap is necessary for stylish Haskell not to re-arrange
5−-- NoMonoLocalBinds before TypeFamilies
6−{-# LANGUAGE NoMonoLocalBinds #-}
7−
8−module Foo (
9− bar
10− ) where
data/printer/list0-multi.hsnew file+4
@@ -0,0 +1,4 @@
1+[ foo,
2+ bar,
3+ baz
4+ ]
data/printer/list0-single.hsnew file+1
@@ -0,0 +1 @@
1+[foo, bar, baz]
data/printer/list1-multi.hsnew file+8
@@ -0,0 +1,8 @@
1+[ foo,
2+ bar,
3+ foo
4+ :: ( Int
5+ -> Int
6+ )
7+ -> Bool
8+ ]
data/printer/list1-single.hsnew file+1
@@ -0,0 +1 @@
1+[foo, bar, foo :: (Int -> Int) -> Bool]
data/printer/mhdr-multi.hsnew file+7
@@ -0,0 +1,7 @@
1+module MyModule
2+ ( R,
3+ runR,
4+ txt,
5+ blah
6+ )
7+where
data/printer/mhdr-single.hsnew file+3
@@ -0,0 +1,3 @@
1+module MyModule
2+ (R, runR, txt, blah)
3+where
data/printer/ssig-multi.hsnew file+5
@@ -0,0 +1,5 @@
1+foo
2+ :: ( Int
3+ -> Int
4+ )
5+ -> Bool
data/printer/ssig-single.hsnew file+1
@@ -0,0 +1 @@
1+foo :: (Int -> Int) -> Bool
default.nix+10−148
@@ -1,14 +1,12 @@
1−{ pkgs ? (import ./nix/nixpkgs { inherit system; })
2−, system ? builtins.currentSystem
3−, ormoluCompiler ? "ghc884" # the shell doesn't work with ghc8101 yet
4−}:
1+{ pkgs ? (import ./nix/nixpkgs) }:
52
63let
7− source = pkgs.lib.sourceByRegex ./. [
4+ ormoluCompiler = "ghc864";
5+ source = pkgs.lib.sourceByRegex ./.[
86 "^.*\.md$"
97 "^app.*$"
108 "^data.*$"
11− "^ormolu\.cabal$"
9+ "^ormolu.cabal$"
1210 "^src.*$"
1311 "^tests.*$"
1412 ];
@@ -16,154 +14,18 @@ let
1614 overrides = ormoluOverlay;
1715 };
1816 ormoluOverlay = self: super: {
19− "ormolu" = super.callCabal2nixWithOptions "ormolu" source "-fdev" { };
20− };
17+ "ormolu" = super.callCabal2nix "ormolu" source { };
18+ };
2119 ormolize = import ./nix/ormolize {
2220 inherit pkgs;
2321 inherit haskellPackages;
2422 };
25− expectedFailures = [
26− "Agda"
27− "aws"
28− "distributed-process"
29− "esqueleto"
30− "fay"
31− "hlint"
32− "idris"
33− "intero"
34− "leksah"
35− "pandoc"
36− "pipes"
37− "postgrest"
38− "purescript"
39− "tensorflow"
40− ] ++ (if ormoluCompiler == "ghc8101" then [] else ["lens"]);
41− ormolizedPackages = doCheck:
42− pkgs.lib.mapAttrs (name: p: ormolize {
43− package = p;
44− inherit doCheck;
45− expectedFailures =
46− if pkgs.lib.lists.any (x: x == name) expectedFailures
47− then ./expected-failures + "/${name}.txt"
48− else null;
49− }) haskellPackages;
5023in {
5124 ormolu = haskellPackages.ormolu;
52− # We put the derivations in another attribute set to avoid building them
53− # when nix-build is run.
54− dev = {
55− ormoluShell =
56− haskellPackages.shellFor {
57− packages = ps: [
58− ps.ormolu
59− ];
60− buildInputs = [
61− haskellPackages.cabal-install
62− haskellPackages.ghcid
63− ];
64− };
65− withOrmolu = haskellPackages.shellFor {
66− packages = ps: [];
67− buildInputs = [
68− haskellPackages.cabal-install
69− haskellPackages.ormolu
70− ];
71− };
25+ ormoluShell = haskellPackages.shellFor {
26+ packages = ps: [ ps.ormolu ];
27+ buildInputs = [ haskellPackages.cabal-install haskellPackages.ghcid ];
7228 };
7329 inherit ormoluOverlay ormoluCompiler;
74− hackage = ormolizedPackages false;
75− hackageTests = with pkgs.lib; pkgs.recurseIntoAttrs (
76− let ps = [
77− "Agda"
78− "QuickCheck"
79− "ShellCheck"
80− "aeson"
81− "attoparsec"
82− "aws"
83− "brick"
84− "capability"
85− "cassava"
86− "conduit"
87− "cryptonite"
88− "diagrams-core"
89− "distributed-process"
90− "esqueleto"
91− "fay"
92− "hakyll"
93− "haxl"
94− "hedgehog"
95− "hledger"
96− "hlint"
97− "http-client"
98− "idris"
99− "intero"
100− "leksah"
101− "lens"
102− "megaparsec"
103− "optics"
104− "ormolu"
105− "pandoc"
106− "parsec3"
107− "pipes"
108− "postgrest"
109− "purescript"
110− "servant"
111− "servant-server"
112− "stack"
113− "tensorflow"
114− "text_1_2_4_0"
115− "tls"
116− "yesod-core"
117− ];
118− in listToAttrs (map (p: nameValuePair p (ormolizedPackages true).${p}) ps)
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− };
30+ hackage = pkgs.lib.mapAttrs ormolize haskellPackages;
16931}
expected-failures/Agda.txtdeleted−11
@@ -1,11 +0,0 @@
1−Formatting is not idempotent:
2− dist/build/Agda/Syntax/Parser/Lexer.hs<rendered>:1602:17
3− before: " = (check_ac"
4− after: " =\n "
5−Please, consider reporting the bug.
6−
7−Formatting is not idempotent:
8− src/full/Agda/Syntax/Translation/InternalToAbstract.hs<rendered>:769:4
9− before: " nes\n\n "
10− after: " nes\n\n -- Andreas"
11−Please, consider reporting the bug.
expected-failures/aws.txtdeleted−9
@@ -1,9 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− Examples/PutBucketNearLine.hs:5:1-6
3− parse error on input `import'
4−
5−The GHC parser (in Haddock mode) failed:
6− Examples/Sqs.hs:(88,3)-(90,4)
7− parse error on input `{- | Let's make sure the queue was actually deleted and that the same number of queues exist at when
8− | the program ends as when it started.
9− -}'
expected-failures/distributed-process.txtdeleted−7
@@ -1,7 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− benchmarks/Channels.hs:2:1-6
3− parse error on input `import'
4−
5−The GHC parser (in Haddock mode) failed:
6− benchmarks/Spawns.hs:5:1-6
7− parse error on input `import'
expected-failures/esqueleto.txtdeleted−7
@@ -1,7 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− src/Database/Esqueleto/Internal/Internal.hs:379:1
3− lexical error in string/character literal at character 's'
4−
5−The GHC parser (in Haddock mode) failed:
6− test/PostgreSQL/Test.hs:562:9-41
7− parse error on input `-- | Check the result is not null'
expected-failures/fay.txtdeleted−18
@@ -1,18 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− examples/Separated.hs:12:1-6
3− parse error on input `module'
4−
5−The GHC parser (in Haddock mode) failed:
6− examples/calc.hs:(4,1)-(6,2)
7− parse error on input `-- $ fay -p --html-wrapper --html-js-lib jquery.min.js examples/calc.hs
8−-- You also need to download jquery.min.js.
9−--'
10−
11−The GHC parser (in Haddock mode) failed:
12− examples/canvaswater.hs:(6,1)-(7,17)
13− parse error on input `-- | A demonstration of Fay using the canvas element to display a
14−-- simple effect.'
15−
16−The GHC parser (in Haddock mode) failed:
17− examples/data.hs:9:1-6
18− parse error on input `module'
expected-failures/hlint.txtdeleted−11
@@ -1,11 +0,0 @@
1−Formatting is not idempotent:
2− src/Extension.hs<rendered>:19:22
3− before: "DoRec , -} Recursive"
4− after: "DoRec , -}\n "
5−Please, consider reporting the bug.
6−
7−Formatting is not idempotent:
8− src/Hint/Bracket.hs<rendered>:249:50
9− before: "\" x y [r]) {ideaSpan"
10− after: "\" x y [r])\n "
11−Please, consider reporting the bug.
expected-failures/idris.txtdeleted−7
@@ -1,7 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− src/Idris/Parser.hs:1052:1
3− parse error on input `@'
4−
5−The GHC parser (in Haddock mode) failed:
6− src/Idris/Parser/Expr.hs:75:1
7− parse error on input `@'
expected-failures/intero.txtdeleted−5
@@ -1,5 +0,0 @@
1−Formatting is not idempotent:
2− src/InteractiveUI.hs<rendered>:3748:33
3− before: "text \"Try\" <+> doWha"
4− after: "text \"Try\"\n "
5−Please, consider reporting the bug.
expected-failures/leksah.txtdeleted−5
@@ -1,5 +0,0 @@
1−Formatting is not idempotent:
2− src/IDE/Pane/Modules.hs<rendered>:1184:7
3− before: "cr\n -- show"
4− after: "cr\n in -- show"
5−Please, consider reporting the bug.
expected-failures/lens.txtdeleted−3
@@ -1,3 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− src/Control/Exception/Lens.hs:180:13-37
3− parse error on input `AllocationLimitExceeded__'
expected-failures/pandoc.txtdeleted−9
@@ -1,9 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− benchmark/weigh-pandoc.hs:14:1-6
3− parse error on input `import'
4−
5−Formatting is not idempotent:
6− src/Text/Pandoc/Readers/Vimwiki.hs<rendered>:613:19
7− before: ".softbreak <$ endlin"
8− after: ".softbreak\n <$ en"
9−Please, consider reporting the bug.
expected-failures/pipes.txtdeleted−3
@@ -1,3 +0,0 @@
1−AST of input and AST of formatted code differ.
2− at src/Pipes/Core.hs:(128,1)-(151,2)
3−Please, consider reporting the bug.
expected-failures/postgrest.txtdeleted−5
@@ -1,5 +0,0 @@
1−Formatting is not idempotent:
2− src/PostgREST/DbRequestBuilder.hs<rendered>:149:24
3− before: " || -- clients"
4− after: " || ( origin ="
5−Please, consider reporting the bug.
expected-failures/purescript.txtdeleted−18
@@ -1,18 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− src/Language/PureScript/AST/Declarations.hs:479:1-17
3− Invalid type signature: pattern ValueDecl :: ...
4−Perhaps you meant to use PatternSynonyms?
5−
6−The GHC parser (in Haddock mode) failed:
7− src/Language/PureScript/AST/SourcePos.hs:99:1-22
8− Invalid type signature: pattern NullSourceSpan :: ...
9−Perhaps you meant to use PatternSynonyms?
10−
11−The GHC parser (in Haddock mode) failed:
12− src/Language/PureScript/Constants.hs:42:1-15
13− Invalid type signature: pattern Discard :: ...
14−Perhaps you meant to use PatternSynonyms?
15−
16−The GHC parser (in Haddock mode) failed:
17− src/Language/PureScript/Crash.hs:16:1-6
18− parse error on input `import'
expected-failures/tensorflow.txtdeleted−7
@@ -1,7 +0,0 @@
1−The GHC parser (in Haddock mode) failed:
2− tensorflow-mnist/app/Main.hs:50:13-14
3− parse error on input `->'
4−
5−The GHC parser (in Haddock mode) failed:
6− tensorflow-ops/tests/RegressionTest.hs:3:1-6
7− parse error on input `import'
format.shdeleted−14
@@ -1,14 +0,0 @@
1−#!/usr/bin/env nix-shell
2−#!nix-shell default.nix -A dev.withOrmolu -i bash --pure
3−#
4−# Format Ormolu using current version of Ormolu.
5−
6−set -e
7−
8−export LANG="C.UTF-8"
9−
10−cabal format
11−
12−ormolu -m inplace $(find app -type f -name "*.hs")
13−ormolu -m inplace $(find src -type f \( -name "*.hs" -o -name "*.hs-boot" \))
14−ormolu -m inplace $(find tests -type f -name "*.hs")
nix/nixpkgs/default.nix+3−7
@@ -1,13 +1,9 @@
1−{ system ? builtins.currentSystem }:
21let
3− rev = "32b46dd897ab2143a609988a04d87452f0bbef59";
4− sha256 = "1gzfrpjnr1bz9zljsyg3a4zrhk8r927sz761mrgcg56dwinkhpjk";
2+ rev = "454eea84a757ca5f733c4ec0f234eba2281c74eb";
3+ sha256 = "1k9jbix4w43brqlfmvwy218pf5fbmzsnc08shaww9qfdl1rdlaxy";
54 nixpkgs = builtins.fetchTarball {
65 url = "https://github.com/NixOS/nixpkgs/archive/${rev}.tar.gz";
76 inherit sha256;
87 };
9− pkgs = import nixpkgs {
10− inherit system;
11− config.allowUnfree = true;
12− };
8+ pkgs = import nixpkgs { config.allowUnfree = true; };
139in pkgs
nix/ormolize/default.nix+6−39
@@ -1,49 +1,16 @@
1−{ pkgs
2−, haskellPackages
3−}:
4−{ package
5−, expectedFailures ? null
6−, doCheck ? false
7−}:
8− pkgs.stdenv.mkDerivation rec {
9− name = package.name + "-ormolized";
10− src = package.src;
1+{ pkgs, haskellPackages }: _: p:
2+ pkgs.stdenv.mkDerivation {
3+ name = p.name + "-ormolized";
4+ src = p.src;
115 buildInputs = [
126 haskellPackages.cpphs
13− haskellPackages.ormolu
14− pkgs.diffutils
7+ (pkgs.haskell.lib.dontCheck haskellPackages.ormolu)
158 pkgs.glibcLocales
169 ];
1710 LANG = "en_US.UTF-8";
1811 buildPhase = ''
19− hs_files=$(find . -name '*.hs')
20− for hs_file in $hs_files; do
21−
22− # drop includes
23− sed -i '/^#include/d' "$hs_file"
24−
25− # deal with CPP
26− cpphs "$hs_file" --noline -DARCH_X86 > "''${hs_file}-nocpp" 2> /dev/null
27−
28− # annoyingly, cpphs cannot modify files in place
29− mv "''${hs_file}-nocpp" "$hs_file"
30−
31− # preserve the original
32− cp "$hs_file" "''${hs_file}-original"
33− done
34−
35− (ormolu --check-idempotence --mode inplace $hs_files || true) 2> log.txt
12+ find . -name '*.hs' -exec bash ${./ormolize.sh} {} \; 2> log.txt
3613 '';
37− inherit doCheck;
38− checkPhase =
39− if expectedFailures == null
40− then ''
41− echo "No failures expected"
42− if [[ -s log.txt ]]; then exit 1; fi
43− ''
44− else ''
45− diff --ignore-blank-lines --color=always ${expectedFailures} log.txt
46− '';
4714 installPhase = ''
4815 mkdir "$out"
4916 find . -name '*.hs-original' -exec cp --parents {} $out \;
nix/ormolize/ormolize.shnew file+16
@@ -0,0 +1,16 @@
1+set -euo pipefail
2+
3+# drop includes
4+sed -i '/^#include/d' "$1"
5+
6+# deal with CPP in a fairly straightforward way
7+cpphs "$1" --noline > "$1-nocpp" 2> /dev/null
8+
9+# annoyingly, cpphs cannot modify files in place
10+mv "$1-nocpp" "$1"
11+
12+# preserve the original
13+cp "$1" "$1-original"
14+
15+# run ormolu
16+ormolu --tolerate-cpp --mode inplace "$1" || ormolu --tolerate-cpp --unsafe --mode inplace "$1"
ormolu.cabal+153−174
@@ -1,184 +1,163 @@
1−cabal-version: 1.18
2−name: ormolu
3−version: 0.1.2.0
4−license: BSD3
5−license-file: LICENSE.md
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
9−bug-reports: https://github.com/tweag/ormolu/issues
10−synopsis: A formatter for Haskell source code
11−description: A formatter for Haskell source code.
12−category: Development, Formatting
13−build-type: Simple
14−data-files:
15− data/examples/declaration/annotation/*.hs
16− data/examples/declaration/class/*.hs
17− data/examples/declaration/data/*.hs
18− data/examples/declaration/data/gadt/*.hs
19− data/examples/declaration/default/*.hs
20− data/examples/declaration/deriving/*.hs
21− data/examples/declaration/foreign/*.hs
22− data/examples/declaration/instance/*.hs
23− data/examples/declaration/rewrite-rule/*.hs
24− data/examples/declaration/role-annotation/*.hs
25− data/examples/declaration/signature/complete/*.hs
26− data/examples/declaration/signature/fixity/*.hs
27− data/examples/declaration/signature/inline/*.hs
28− data/examples/declaration/signature/minimal/*.hs
29− data/examples/declaration/signature/pattern/*.hs
30− data/examples/declaration/signature/set-cost-centre/*.hs
31− data/examples/declaration/signature/specialize/*.hs
32− data/examples/declaration/signature/type/*.hs
33− data/examples/declaration/splice/*.hs
34− data/examples/declaration/type-families/closed-type-family/*.hs
35− data/examples/declaration/type-families/data-family/*.hs
36− data/examples/declaration/type-families/type-family/*.hs
37− data/examples/declaration/type-synonyms/*.hs
38− data/examples/declaration/type/*.hs
39− data/examples/declaration/value/function/*.hs
40− data/examples/declaration/value/function/arrow/*.hs
41− data/examples/declaration/value/function/comprehension/*.hs
42− data/examples/declaration/value/function/do/*.hs
43− data/examples/declaration/value/function/infix/*.hs
44− data/examples/declaration/value/function/pattern/*.hs
45− data/examples/declaration/value/other/*.hs
46− data/examples/declaration/value/pattern-synonyms/*.hs
47− data/examples/declaration/warning/*.hs
48− data/examples/import/*.hs
49− data/examples/module-header/*.hs
50− data/examples/other/*.hs
51−
52−extra-doc-files:
53− CONTRIBUTING.md
54− CHANGELOG.md
55− DESIGN.md
56− README.md
1+name: ormolu
2+version: 0.0.1.0
3+cabal-version: 1.18
4+tested-with: GHC==8.6.4
5+license: BSD3
6+license-file: LICENSE.md
7+maintainer: Mark Karpov <mark.karpov@tweag.io>
8+homepage: https://github.com/tweag/ormolu
9+bug-reports: https://github.com/tweag/ormolu/issues
10+category: Development, Formatting
11+synopsis: A formatter for Haskell source code
12+build-type: Simple
13+description: A formatter for Haskell source code.
14+extra-doc-files: CONTRIBUTING.md
15+ , CHANGELOG.md
16+ , DESIGN.md
17+ , README.md
18+data-files: data/examples/declaration/annotation/*.hs
19+ , data/examples/declaration/class/*.hs
20+ , data/examples/declaration/data/*.hs
21+ , data/examples/declaration/data/gadt/*.hs
22+ , data/examples/declaration/default/*.hs
23+ , data/examples/declaration/deriving/*.hs
24+ , data/examples/declaration/foreign/*.hs
25+ , data/examples/declaration/instance/*.hs
26+ , data/examples/declaration/rewrite-rule/*.hs
27+ , data/examples/declaration/role-annotation/*.hs
28+ , data/examples/declaration/signature/complete/*.hs
29+ , data/examples/declaration/signature/fixity/*.hs
30+ , data/examples/declaration/signature/inline/*.hs
31+ , data/examples/declaration/signature/minimal/*.hs
32+ , data/examples/declaration/signature/pattern/*.hs
33+ , data/examples/declaration/signature/set-cost-centre/*.hs
34+ , data/examples/declaration/signature/specialize/*.hs
35+ , data/examples/declaration/signature/type/*.hs
36+ , data/examples/declaration/splice/*.hs
37+ , data/examples/declaration/type/*.hs
38+ , data/examples/declaration/type-families/closed-type-family/*.hs
39+ , data/examples/declaration/type-families/data-family/*.hs
40+ , data/examples/declaration/type-families/type-family/*.hs
41+ , data/examples/declaration/type-synonyms/*.hs
42+ , data/examples/declaration/value/function/*.hs
43+ , data/examples/declaration/value/function/arrow/*.hs
44+ , data/examples/declaration/value/function/pattern/*.hs
45+ , data/examples/declaration/value/other/*.hs
46+ , data/examples/declaration/value/pattern-synonyms/*.hs
47+ , data/examples/declaration/warning/*.hs
48+ , data/examples/import/*.hs
49+ , data/examples/module-header/*.hs
50+ , data/examples/other/*.hs
51+ , data/printer/*.hs
5752
5853source-repository head
59− type: git
60− location: https://github.com/tweag/ormolu.git
54+ type: git
55+ location: https://github.com/tweag/ormolu.git
6156
6257flag dev
63− description: Turn on development settings.
64− default: False
65− manual: True
58+ description: Turn on development settings.
59+ manual: True
60+ default: False
6661
6762library
68− exposed-modules:
69− Ormolu
70− Ormolu.Config
71− Ormolu.Diff
72− Ormolu.Exception
73− Ormolu.Imports
74− Ormolu.Parser
75− Ormolu.Parser.Anns
76− Ormolu.Parser.CommentStream
77− Ormolu.Parser.Pragma
78− Ormolu.Parser.Result
79− Ormolu.Parser.Shebang
80− Ormolu.Printer
81− Ormolu.Printer.Combinators
82− Ormolu.Printer.Comments
83− Ormolu.Printer.Internal
84− Ormolu.Printer.Meat.Common
85− Ormolu.Printer.Meat.Declaration
86− Ormolu.Printer.Meat.Declaration.Annotation
87− Ormolu.Printer.Meat.Declaration.Class
88− Ormolu.Printer.Meat.Declaration.Data
89− Ormolu.Printer.Meat.Declaration.Default
90− Ormolu.Printer.Meat.Declaration.Foreign
91− Ormolu.Printer.Meat.Declaration.Instance
92− Ormolu.Printer.Meat.Declaration.RoleAnnotation
93− Ormolu.Printer.Meat.Declaration.Rule
94− Ormolu.Printer.Meat.Declaration.Signature
95− Ormolu.Printer.Meat.Declaration.Splice
96− Ormolu.Printer.Meat.Declaration.Type
97− Ormolu.Printer.Meat.Declaration.TypeFamily
98− Ormolu.Printer.Meat.Declaration.Value
99− Ormolu.Printer.Meat.Declaration.Warning
100− Ormolu.Printer.Meat.ImportExport
101− Ormolu.Printer.Meat.Module
102− Ormolu.Printer.Meat.Pragma
103− Ormolu.Printer.Meat.Type
104− Ormolu.Printer.Operators
105− Ormolu.Printer.SpanStream
106− Ormolu.Processing.Common
107− Ormolu.Processing.Cpp
108− Ormolu.Processing.Postprocess
109− Ormolu.Processing.Preprocess
110− Ormolu.Utils
111−
112− hs-source-dirs: src
113− other-modules:
114− GHC
115− GHC.DynFlags
116−
117− default-language: Haskell2010
118− build-depends:
119− base >=4.12 && <5.0,
120− bytestring >=0.2 && <0.11,
121− containers >=0.5 && <0.7,
122− dlist >=0.8 && <2.0,
123− exceptions >=0.6 && <0.11,
124− ghc-lib-parser >=8.10 && <8.11,
125− mtl >=2.0 && <3.0,
126− syb >=0.7 && <0.8,
127− text >=0.2 && <1.3
128−
129− if flag(dev)
130− ghc-options:
131− -Wall -Werror -Wcompat -Wincomplete-record-updates
132− -Wincomplete-uni-patterns -Wnoncanonical-monad-instances
133− -Wno-missing-home-modules
134−
135− else
136− ghc-options: -O2 -Wall
137−
138−executable ormolu
139− main-is: Main.hs
140− hs-source-dirs: app
141− other-modules: Paths_ormolu
142− default-language: Haskell2010
143− build-depends:
144− base >=4.12 && <5.0,
145− ghc-lib-parser >=8.10 && <8.11,
146− gitrev >=1.3 && <1.4,
147− optparse-applicative >=0.14 && <0.17,
148− ormolu -any,
149− text >=0.2 && <1.3
150−
151− if flag(dev)
152− ghc-options:
153− -Wall -Werror -Wcompat -Wincomplete-record-updates
154− -Wincomplete-uni-patterns -Wnoncanonical-monad-instances
155− -optP-Wno-nonportable-include-path
156−
157− else
158− ghc-options: -O2 -Wall -rtsopts
63+ hs-source-dirs: src
64+ build-depends: base >= 4.12 && < 5.0
65+ , bytestring >= 0.2 && < 0.11
66+ , containers >= 0.5 && < 0.7
67+ , dlist >= 0.8 && < 0.9
68+ , exceptions >= 0.6 && < 0.11
69+ , ghc >= 8.4.3
70+ , ghc-boot-th >= 8.4.3
71+ , ghc-paths >= 0.1 && < 0.2
72+ , mtl >= 2.0 && < 3.0
73+ , syb >= 0.7 && < 0.8
74+ , text >= 0.2 && < 1.3
75+ exposed-modules: Ormolu
76+ , Ormolu.Config
77+ , Ormolu.Diff
78+ , Ormolu.Exception
79+ , Ormolu.Imports
80+ , Ormolu.Parser
81+ , Ormolu.Parser.Anns
82+ , Ormolu.Parser.CommentStream
83+ , Ormolu.Parser.Pragma
84+ , Ormolu.Parser.Result
85+ , Ormolu.Printer
86+ , Ormolu.Printer.Combinators
87+ , Ormolu.Printer.Comments
88+ , Ormolu.Printer.Internal
89+ , Ormolu.Printer.Meat.Common
90+ , Ormolu.Printer.Meat.Declaration
91+ , Ormolu.Printer.Meat.Declaration.Annotation
92+ , Ormolu.Printer.Meat.Declaration.Class
93+ , Ormolu.Printer.Meat.Declaration.Data
94+ , Ormolu.Printer.Meat.Declaration.Default
95+ , Ormolu.Printer.Meat.Declaration.Foreign
96+ , Ormolu.Printer.Meat.Declaration.Instance
97+ , Ormolu.Printer.Meat.Declaration.RoleAnnotation
98+ , Ormolu.Printer.Meat.Declaration.Rule
99+ , Ormolu.Printer.Meat.Declaration.Signature
100+ , Ormolu.Printer.Meat.Declaration.Splice
101+ , Ormolu.Printer.Meat.Declaration.Type
102+ , Ormolu.Printer.Meat.Declaration.TypeFamily
103+ , Ormolu.Printer.Meat.Declaration.Value
104+ , Ormolu.Printer.Meat.Declaration.Warning
105+ , Ormolu.Printer.Meat.ImportExport
106+ , Ormolu.Printer.Meat.Pragma
107+ , Ormolu.Printer.Meat.Module
108+ , Ormolu.Printer.Meat.Type
109+ , Ormolu.Printer.SpanStream
110+ , Ormolu.Utils
111+ if flag(dev)
112+ ghc-options: -Wall -Werror -Wcompat
113+ -Wincomplete-record-updates
114+ -Wincomplete-uni-patterns
115+ -Wnoncanonical-monad-instances
116+ -Wnoncanonical-monadfail-instances
117+ else
118+ ghc-options: -O2 -Wall
119+ default-language: Haskell2010
159120
160121test-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
122+ main-is: Spec.hs
123+ hs-source-dirs: tests
124+ type: exitcode-stdio-1.0
125+ build-depends: base >= 4.12 && < 5.0
126+ , containers >= 0.5 && < 0.7
127+ , filepath >= 1.2 && < 1.5
128+ , hspec >= 2.0 && < 3.0
129+ , ormolu
130+ , path >= 0.6 && < 0.7
131+ , path-io >= 1.4.2 && < 2.0
132+ , text >= 0.2 && < 1.3
133+ build-tools: hspec-discover >= 2.0 && < 3.0
134+ other-modules:
135+ Ormolu.Printer.CombinatorsSpec
136+ , Ormolu.Parser.PragmaSpec
137+ , Ormolu.PrinterSpec
168138
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
139+ if flag(dev)
140+ ghc-options: -Wall -Werror
141+ else
142+ ghc-options: -O2 -Wall
143+ default-language: Haskell2010
179144
180− if flag(dev)
181− ghc-options: -Wall -Werror
182−
183− else
184− ghc-options: -O2 -Wall
145+executable ormolu
146+ main-is: Main.hs
147+ hs-source-dirs: app
148+ build-depends: base >= 4.12 && < 5.0
149+ , ghc >= 8.4.3
150+ , gitrev >= 1.3 && < 1.4
151+ , optparse-applicative >= 0.14 && < 0.15
152+ , ormolu
153+ , text >= 0.2 && < 1.3
154+ other-modules: Paths_ormolu
155+ if flag(dev)
156+ ghc-options: -Wall -Werror -Wcompat
157+ -Wincomplete-record-updates
158+ -Wincomplete-uni-patterns
159+ -Wnoncanonical-monad-instances
160+ -Wnoncanonical-monadfail-instances
161+ else
162+ ghc-options: -O2 -Wall
163+ default-language: Haskell2010
region-tests/expected-result-17-18.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo (
4− foo, bar, baz) where
5−
6−foo :: Int
7−foo = 5
8−
9−bar :: Int -> Int
10−bar = \case
11− 0 -> foo
12− x -> x - foo
13−
14−baz :: Int -> Int
15−baz = gege
16− where
17− gege = 1 + 2
region-tests/expected-result-6-7.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo (
4− foo, bar, baz) where
5−
6−foo :: Int
7−foo = 5
8−
9−bar :: Int -> Int
10−bar = \case
11− 0 -> foo
12− x -> x - foo
13−
14−baz :: Int -> Int
15−baz = gege
16− where
17− gege = 1 + 2
region-tests/expected-result-6-8.hsdeleted−16
@@ -1,16 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo (
4− foo, bar, baz) where
5−
6−foo :: Int
7−foo = 5
8−bar :: Int -> Int
9−bar = \case
10− 0 -> foo
11− x -> x - foo
12−
13−baz :: Int -> Int
14−baz = gege
15− where
16− gege = 1 + 2
region-tests/expected-result-9-12.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo (
4− foo, bar, baz) where
5−
6−foo :: Int
7−foo = 5
8−
9−bar :: Int -> Int
10−bar = \case
11− 0 -> foo
12− x -> x - foo
13−
14−baz :: Int -> Int
15−baz = gege
16− where
17− gege = 1 + 2
region-tests/expected-result-all.hsdeleted−21
@@ -1,21 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo
4− ( foo,
5− bar,
6− baz,
7− )
8−where
9−
10−foo :: Int
11−foo = 5
12−
13−bar :: Int -> Int
14−bar = \case
15− 0 -> foo
16− x -> x - foo
17−
18−baz :: Int -> Int
19−baz = gege
20− where
21− gege = 1 + 2
region-tests/src.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−module Foo (
4− foo, bar, baz) where
5−
6−foo :: Int
7−foo = 5
8−
9−bar :: Int -> Int
10−bar = \case
11− 0 -> foo
12− x -> x - foo
13−
14−baz :: Int -> Int
15−baz = gege
16− where
17− gege = 1 + 2
shell.nix+2−4
@@ -1,5 +1,3 @@
1−{ pkgs ? (import ./nix/nixpkgs { inherit system; })
2−, system ? builtins.currentSystem
3−}:
1+{ pkgs ? (import ./nix/nixpkgs) }:
42
5−(import ./default.nix { inherit pkgs; }).dev.ormoluShell
3+(import ./default.nix { inherit pkgs; }).ormoluShell
src/GHC.hsdeleted−12
@@ -1,12 +0,0 @@
1−module GHC
2− ( module X,
3− )
4−where
5−
6−import ApiAnnotation as X
7−import BasicTypes as X
8−import GHC.Hs as X
9−import GHC.Hs.Instances as X ()
10−import Module as X
11−import RdrName as X
12−import SrcLoc as X
src/GHC/DynFlags.hsdeleted−49
@@ -1,49 +0,0 @@
1−{-# OPTIONS_GHC -Wno-missing-fields #-}
2−
3−-- Modified from ghc-lib-api-ext.
4−
5−module GHC.DynFlags
6− ( baseDynFlags,
7− )
8−where
9−
10−import Config
11−import DynFlags
12−import Fingerprint
13−import GHC.Platform
14−import ToolSettings
15−
16−fakeSettings :: Settings
17−fakeSettings =
18− Settings
19− { sGhcNameVersion =
20− GhcNameVersion
21− { ghcNameVersion_programName = "ghc",
22− ghcNameVersion_projectVersion = cProjectVersion
23− },
24− sFileSettings = FileSettings {},
25− sTargetPlatform =
26− Platform
27− { platformWordSize = PW8,
28− platformMini =
29− PlatformMini
30− { platformMini_arch = ArchUnknown,
31− platformMini_os = OSUnknown
32− },
33− platformUnregisterised = True
34− },
35− sPlatformMisc = PlatformMisc {},
36− sPlatformConstants =
37− PlatformConstants {pc_DYNAMIC_BY_DEFAULT = False, pc_WORD_SIZE = 8},
38− sToolSettings =
39− ToolSettings
40− { toolSettings_opt_P_fingerprint = fingerprint0,
41− toolSettings_pgm_F = ""
42− }
43− }
44−
45−fakeLlvmConfig :: LlvmConfig
46−fakeLlvmConfig = LlvmConfig [] []
47−
48−baseDynFlags :: DynFlags
49−baseDynFlags = defaultDynFlags fakeSettings fakeLlvmConfig
src/Ormolu.hs+61−84
@@ -1,25 +1,23 @@
1−{-# LANGUAGE BangPatterns #-}
2−
31-- | A formatter for Haskell source code.
2+
3+{-# LANGUAGE RecordWildCards #-}
4+
45module Ormolu
5− ( ormolu,
6− ormoluFile,
7− ormoluStdin,
8− Config (..),
9− RegionIndices (..),
10− defaultConfig,
11− DynOption (..),
12− OrmoluException (..),
13− withPrettyOrmoluExceptions,
6+ ( ormolu
7+ , ormoluFile
8+ , ormoluStdin
9+ , Config (..)
10+ , defaultConfig
11+ , DynOption (..)
12+ , OrmoluException (..)
13+ , withPrettyOrmoluExceptions
1414 )
1515where
1616
17−import qualified CmdLineParser as GHC
1817import Control.Exception
1918import Control.Monad
2019import Control.Monad.IO.Class (MonadIO (..))
2120import Data.Text (Text)
22−import qualified Data.Text as T
2321import Debug.Trace
2422import Ormolu.Config
2523import Ormolu.Diff
@@ -28,7 +26,10 @@ import Ormolu.Parser
2826import Ormolu.Parser.Result
2927import Ormolu.Printer
3028import Ormolu.Utils (showOutputable)
31−import qualified SrcLoc as GHC
29+import qualified CmdLineParser as GHC
30+import qualified Data.Text as T
31+import qualified GHC
32+import System.IO (hGetContents, stdin)
3233
3334-- | Format a 'String', return formatted version as 'Text'.
3435--
@@ -40,52 +41,33 @@ import qualified SrcLoc as GHC
4041-- side-effects though.
4142-- * Takes file name just to use it in parse error messages.
4243-- * Throws 'OrmoluException'.
43−ormolu ::
44− MonadIO m =>
45− -- | Ormolu configuration
46− Config RegionIndices ->
47− -- | Location of source file
48− FilePath ->
49− -- | Input to format
50− String ->
51− m Text
52−ormolu cfgWithIndices path str = do
53− let totalLines = length (lines str)
54− cfg = regionIndicesToDeltas totalLines <$> cfgWithIndices
55− (warnings, result0) <-
44+
45+ormolu
46+ :: MonadIO m
47+ => Config -- ^ Ormolu configuration
48+ -> FilePath -- ^ Location of source file
49+ -> String -- ^ Input to format
50+ -> m Text
51+ormolu cfg path str = do
52+ (ws, result0) <-
5653 parseModule' cfg OrmoluParsingFailed path str
5754 when (cfgDebug cfg) $ do
5855 traceM "warnings:\n"
59− traceM (concatMap showWarn warnings)
56+ traceM (concatMap showWarn ws)
6057 traceM (prettyPrintParseResult result0)
61− -- We're forcing 'txt' here because otherwise errors (such as messages
62− -- about not-yet-supported functionality) will be thrown later when we try
63− -- to parse the rendered code back, inside of GHC monad wrapper which will
64− -- lead to error messages presenting the exceptions as GHC bugs.
65− let !txt = printModule result0
66− when (not (cfgUnsafe cfg) || cfgCheckIdempotence cfg) $ do
67− let pathRendered = path ++ "<rendered>"
68− -- Parse the result of pretty-printing again and make sure that AST
69− -- is the same as AST of original snippet module span positions.
58+ let txt = printModule (cfgDebug cfg) result0
59+ -- Parse the result of pretty-printing again and make sure that AST is the
60+ -- same as AST of original snippet module span positions.
61+ unless (cfgUnsafe cfg) $ do
7062 (_, result1) <-
7163 parseModule'
7264 cfg
7365 OrmoluOutputParsingFailed
74− pathRendered
66+ (path ++ "<rendered>")
7567 (T.unpack txt)
76− unless (cfgUnsafe cfg) $
77− case diffParseResult result0 result1 of
78− Same -> return ()
79− Different ss -> liftIO $ throwIO (OrmoluASTDiffers path ss)
80− -- Try re-formatting the formatted result to check if we get exactly
81− -- the same output.
82− when (cfgCheckIdempotence cfg) $
83− let txt2 = printModule result1
84− in case diffText txt txt2 pathRendered of
85− Nothing -> return ()
86− Just (loc, l, r) ->
87− liftIO $
88− throwIO (OrmoluNonIdempotentOutput loc l r)
68+ case diff result0 result1 of
69+ Same -> return ()
70+ Different ss -> liftIO $ throwIO (OrmoluASTDiffers path ss)
8971 return txt
9072
9173-- | Load a file and format it. The file stays intact and the rendered
@@ -93,14 +75,12 @@ ormolu cfgWithIndices path str = do
9375--
9476-- > ormoluFile cfg path =
9577-- > liftIO (readFile path) >>= ormolu cfg path
96−ormoluFile ::
97− MonadIO m =>
98− -- | Ormolu configuration
99− Config RegionIndices ->
100− -- | Location of source file
101− FilePath ->
102− -- | Resulting rendition
103− m Text
78+
79+ormoluFile
80+ :: MonadIO m
81+ => Config -- ^ Ormolu configuration
82+ -> FilePath -- ^ Location of source file
83+ -> m Text -- ^ Resulting rendition
10484ormoluFile cfg path =
10585 liftIO (readFile path) >>= ormolu cfg path
10686
@@ -108,40 +88,37 @@ ormoluFile cfg path =
10888--
10989-- > ormoluStdin cfg =
11090-- > liftIO (hGetContents stdin) >>= ormolu cfg "<stdin>"
111−ormoluStdin ::
112− MonadIO m =>
113− -- | Ormolu configuration
114− Config RegionIndices ->
115− -- | Resulting rendition
116− m Text
91+
92+ormoluStdin
93+ :: MonadIO m
94+ => Config -- ^ Ormolu configuration
95+ -> m Text -- ^ Resulting rendition
11796ormoluStdin cfg =
118− liftIO getContents >>= ormolu cfg "<stdin>"
97+ liftIO (hGetContents stdin) >>= ormolu cfg "<stdin>"
11998
12099----------------------------------------------------------------------------
121100-- Helpers
122101
123102-- | A wrapper around 'parseModule'.
124−parseModule' ::
125− MonadIO m =>
126− -- | Ormolu configuration
127− Config RegionDeltas ->
128− -- | How to obtain 'OrmoluException' to throw when parsing fails
129− (GHC.SrcSpan -> String -> OrmoluException) ->
130− -- | File name to use in errors
131− FilePath ->
132− -- | Actual input for the parser
133− String ->
134− m ([GHC.Warn], ParseResult)
103+
104+parseModule'
105+ :: MonadIO m
106+ => Config -- ^ Ormolu configuration
107+ -> (GHC.SrcSpan -> String -> OrmoluException)
108+ -- ^ How to obtain 'OrmoluException' to throw when parsing fails
109+ -> FilePath -- ^ File name to use in errors
110+ -> String -- ^ Actual input for the parser
111+ -> m ([GHC.Warn], ParseResult)
135112parseModule' cfg mkException path str = do
136− (warnings, r) <- parseModule cfg path str
113+ (ws, r) <- parseModule cfg path str
137114 case r of
138115 Left (spn, err) -> liftIO $ throwIO (mkException spn err)
139− Right x -> return (warnings, x)
116+ Right x -> return (ws, x)
140117
141118-- | Pretty-print a 'GHC.Warn'.
119+
142120showWarn :: GHC.Warn -> String
143−showWarn (GHC.Warn reason l) =
144− unlines
145− [ showOutputable reason,
146− showOutputable l
147− ]
121+showWarn (GHC.Warn reason l) = unlines
122+ [ showOutputable reason
123+ , showOutputable l
124+ ]
src/Ormolu/Config.hs+32−70
@@ -1,89 +1,51 @@
1−{-# LANGUAGE DeriveFunctor #-}
2−{-# LANGUAGE RecordWildCards #-}
1+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
34
45-- | Configuration options used by the tool.
6+
57module Ormolu.Config
6− ( Config (..),
7− RegionIndices (..),
8− RegionDeltas (..),
9− defaultConfig,
10− regionIndicesToDeltas,
11− DynOption (..),
12− dynOptionToLocatedStr,
8+ ( Config (..)
9+ , defaultConfig
10+ , DynOption (..)
11+ , dynOptionToLocatedStr
1312 )
1413where
1514
1615import qualified SrcLoc as GHC
1716
1817-- | Ormolu configuration.
19−data Config region = Config
20− { -- | Dynamic options to pass to GHC parser
21− cfgDynOptions :: ![DynOption],
22− -- | Do formatting faster but without automatic detection of defects
23− cfgUnsafe :: !Bool,
24− -- | Output information useful for debugging
25− cfgDebug :: !Bool,
26− -- | Checks if re-formatting the result is idempotent
27− cfgCheckIdempotence :: !Bool,
28− -- | Region selection
29− cfgRegion :: !region
30− }
31− deriving (Eq, Show, Functor)
3218
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)
19+data Config = Config
20+ { cfgDynOptions :: ![DynOption]
21+ -- ^ Dynamic options to pass to GHC parser
22+ , cfgUnsafe :: !Bool
23+ -- ^ Do formatting faster but without automatic detection of defects
24+ , cfgDebug :: !Bool
25+ -- ^ Output information useful for debugging
26+ , cfgTolerateCpp :: !Bool
27+ -- ^ Do not fail if CPP pragma is present (still doesn't handle CPP but
28+ -- useful for formatting of files that enable the extension without
29+ -- actually containing CPP macros)
30+ } deriving (Eq, Show)
31+
32+-- | Default 'Config'.
33+
34+defaultConfig :: Config
35+defaultConfig = Config
36+ { cfgDynOptions = []
37+ , cfgUnsafe = False
38+ , cfgDebug = False
39+ , cfgTolerateCpp = False
3940 }
40− deriving (Eq, Show)
41−
42−-- | Region selection as the length of the literal prefix and the literal
43−-- suffix.
44−data RegionDeltas = RegionDeltas
45− { -- | Prefix length in number of lines
46− regionPrefixLength :: !Int,
47− -- | Suffix length in number of lines
48− regionSuffixLength :: !Int
49− }
50− deriving (Eq, Show)
51−
52−-- | Default @'Config' 'RegionIndices'@.
53−defaultConfig :: Config RegionIndices
54−defaultConfig =
55− Config
56− { cfgDynOptions = [],
57− cfgUnsafe = False,
58− cfgDebug = False,
59− cfgCheckIdempotence = False,
60− cfgRegion =
61− RegionIndices
62− { regionStartLine = Nothing,
63− regionEndLine = Nothing
64− }
65− }
66−
67−-- | Convert 'RegionIndices' into 'RegionDeltas'.
68−regionIndicesToDeltas ::
69− -- | Total number of lines in the input
70− Int ->
71− -- | Region indices
72− RegionIndices ->
73− -- | Region deltas
74− RegionDeltas
75−regionIndicesToDeltas total RegionIndices {..} =
76− RegionDeltas
77− { regionPrefixLength = maybe 0 (subtract 1) regionStartLine,
78− regionSuffixLength = maybe 0 (total -) regionEndLine
79− }
8041
8142-- | A wrapper for dynamic options.
43+
8244newtype DynOption = DynOption
8345 { unDynOption :: String
84− }
85− deriving (Eq, Ord, Show)
46+ } deriving (Eq, Ord, Show)
8647
8748-- | Convert 'DynOption' to @'GHC.Located' 'String'@.
49+
8850dynOptionToLocatedStr :: DynOption -> GHC.Located String
8951dynOptionToLocatedStr (DynOption o) = GHC.L GHC.noSrcSpan o
src/Ormolu/Diff.hs+52−112
@@ -1,30 +1,27 @@
1−{-# LANGUAGE RankNTypes #-}
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE RankNTypes #-}
3+{-# LANGUAGE RecordWildCards #-}
24
35-- | Diffing GHC ASTs modulo span positions.
6+
47module Ormolu.Diff
5− ( Diff (..),
6− diffParseResult,
7− diffText,
8+ ( diff
9+ , Diff(..)
810 )
911where
1012
13+import BasicTypes (SourceText)
1114import Data.ByteString (ByteString)
1215import Data.Generics
13−import Data.Text (Text)
14−import qualified Data.Text as T
15−import qualified FastString as GHC
1616import GHC
17−import Ormolu.Imports (normalizeImports)
18−import Ormolu.Parser.CommentStream
17+import Ormolu.Imports (sortImports)
1918import Ormolu.Parser.Result
20−import Ormolu.Utils
2119
2220-- | Result of comparing two 'ParseResult's.
21+
2322data Diff
24− = -- | Two parse results are the same
25− Same
26− | -- | Two parse results differ
27− Different [SrcSpan]
23+ = Same -- ^ Two parse results are the same
24+ | Different [SrcSpan] -- ^ Two parse results differ
2825
2926instance Semigroup Diff where
3027 Same <> a = a
@@ -34,125 +31,68 @@ instance Semigroup Diff where
3431instance Monoid Diff where
3532 mempty = Same
3633
37−-- | Return 'Diff' of two 'ParseResult's.
38−diffParseResult :: ParseResult -> ParseResult -> Diff
39−diffParseResult
40− ParseResult
41− { prCommentStream = cstream0,
42− prParsedSource = hs0
43− }
44− ParseResult
45− { prCommentStream = cstream1,
46− prParsedSource = hs1
47− } =
48− matchIgnoringSrcSpans cstream0 cstream1
49− <> matchIgnoringSrcSpans
50− hs0 {hsmodImports = normalizeImports (hsmodImports hs0)}
51− hs1 {hsmodImports = normalizeImports (hsmodImports hs1)}
34+-- | Return 'False' if two annotated ASTs are the same modulo span
35+-- positions.
36+
37+diff :: ParseResult -> ParseResult -> Diff
38+diff ParseResult { prCommentStream = cstream0
39+ , prParsedSource = ps0
40+ }
41+ ParseResult { prCommentStream = cstream1
42+ , prParsedSource = ps1
43+ } =
44+ matchIgnoringSrcSpans cstream0 cstream1 <>
45+ matchIgnoringSrcSpans ps0 ps1
5246
5347-- | Compare two values for equality disregarding differences in 'SrcSpan's
5448-- and the ordering of import lists.
49+
5550matchIgnoringSrcSpans :: Data a => a -> a -> Diff
5651matchIgnoringSrcSpans = genericQuery
5752 where
5853 genericQuery :: GenericQ (GenericQ Diff)
5954 genericQuery x y
60− -- 'ByteString' implements 'Data' instance manually and does not
55+ -- NOTE 'ByteString' implement 'Data' instance manually and does not
6156 -- implement 'toConstr', so we have to deal with it in a special way.
62− | Just x' <- cast x,
63− Just y' <- cast y =
57+ | Just x' <- cast x, Just y' <- cast y =
6458 if x' == (y' :: ByteString)
6559 then Same
6660 else Different []
67− | typeOf x == typeOf y,
68− toConstr x == toConstr y =
69− mconcat $
70− gzipWithQ
71− ( genericQuery
72− `extQ` srcSpanEq
73− `extQ` commentEq
74− `extQ` sourceTextEq
75− `extQ` hsDocStringEq
76− `extQ` importDeclQualifiedStyleEq
77− `ext2Q` forLocated
78− )
79− x
80− y
61+ | typeOf x == typeOf y, toConstr x == toConstr y =
62+ mconcat $ gzipWithQ
63+ (genericQuery
64+ `extQ` srcSpanEq
65+ `extQ` hsModuleEq
66+ `extQ` sourceTextEq
67+ `ext2Q` forLocated)
68+ x y
8169 | otherwise = Different []
70+
8271 srcSpanEq :: SrcSpan -> GenericQ Diff
8372 srcSpanEq _ _ = Same
84− commentEq :: Comment -> GenericQ Diff
85− commentEq (Comment _ x) d =
86− case cast d :: Maybe Comment of
73+
74+ hsModuleEq :: HsModule GhcPs -> GenericQ Diff
75+ hsModuleEq hs0 hs1' =
76+ case cast hs1' :: Maybe (HsModule GhcPs) of
8777 Nothing -> Different []
88− Just (Comment _ y) ->
89− if x == y
90− then Same
91− else Different []
78+ Just hs1 ->
79+ matchIgnoringSrcSpans
80+ hs0 { hsmodImports = sortImports (hsmodImports hs0) }
81+ hs1 { hsmodImports = sortImports (hsmodImports hs1) }
82+
9283 sourceTextEq :: SourceText -> GenericQ Diff
9384 sourceTextEq _ _ = Same
94− importDeclQualifiedStyleEq :: ImportDeclQualifiedStyle -> GenericQ Diff
95− importDeclQualifiedStyleEq d0 d1' =
96− case (d0, cast d1' :: Maybe ImportDeclQualifiedStyle) of
97− (x, Just x') | x == x' -> Same
98− (QualifiedPre, Just QualifiedPost) -> Same
99− (QualifiedPost, Just QualifiedPre) -> Same
100− _ -> Different []
101− hsDocStringEq :: HsDocString -> GenericQ Diff
102− hsDocStringEq str0 str1' =
103− case cast str1' :: Maybe HsDocString of
104− Nothing -> Different []
105− Just str1 ->
106− if splitDocString str0 == splitDocString str1
107− then Same
108− else Different []
109− forLocated ::
110− (Data e0, Data e1) =>
111− GenLocated e0 e1 ->
112− GenericQ Diff
85+
86+ forLocated
87+ :: (Data e0, Data e1)
88+ => GenLocated e0 e1
89+ -> GenericQ Diff
11390 forLocated x@(L mspn _) y =
11491 maybe id appendSpan (cast mspn) (genericQuery x y)
92+
11593 appendSpan :: SrcSpan -> Diff -> Diff
116− appendSpan s (Different ss) | fresh && helpful = Different (s : ss)
94+ appendSpan s (Different ss) | fresh && helpful = Different (s:ss)
11795 where
118− fresh = not $ any (`isSubspanOf` s) ss
96+ fresh = not $ any (flip isSubspanOf s) ss
11997 helpful = isGoodSrcSpan s
12098 appendSpan _ d = d
121−
122−-- | Diff two texts and return the location they start to differ, alongside
123−-- with excerpts around that location.
124−diffText ::
125− -- | Text before
126− Text ->
127− -- | Text after
128− Text ->
129− -- | Path to use to construct 'GHC.RealSrcLoc'
130− FilePath ->
131− Maybe (GHC.RealSrcLoc, Text, Text)
132−diffText left right fp =
133− case go (0, 0, 0) left right of
134− Nothing -> Nothing
135− Just (row, col, loc) ->
136− Just
137− ( GHC.mkRealSrcLoc (GHC.mkFastString fp) row col,
138− getSpan loc left,
139− getSpan loc right
140− )
141− where
142− go (row, col, loc) t1 t2 =
143− case (T.uncons t1, T.uncons t2) of
144− -- both text empty, all good
145− (Nothing, Nothing) ->
146− Nothing
147− -- first chars are the same, adjust position and recurse
148− (Just (c1, r1), Just (c2, r2))
149− | c1 == c2 ->
150− let (row', col', loc') =
151− if c1 == '\n'
152− then (row + 1, 0, loc + 1)
153− else (row, col + 1, loc + 1)
154− in go (row', col', loc') r1 r2
155− -- something is different, return the position
156− _ ->
157− Just (row, col, loc)
158− getSpan loc = T.take 20 . T.drop (loc - 10)
src/Ormolu/Exception.hs+45−60
@@ -1,72 +1,58 @@
11{-# LANGUAGE LambdaCase #-}
22
33-- | 'OrmoluException' type and surrounding definitions.
4+
45module Ormolu.Exception
5− ( OrmoluException (..),
6− withPrettyOrmoluExceptions,
6+ ( OrmoluException (..)
7+ , withPrettyOrmoluExceptions
78 )
89where
910
1011import Control.Exception
11−import Data.List.NonEmpty (NonEmpty (..))
12−import qualified Data.List.NonEmpty as NE
13−import Data.Text (Text)
14−import qualified GHC
1512import Ormolu.Utils (showOutputable)
16−import qualified Outputable as GHC
1713import System.Exit (ExitCode (..), exitWith)
1814import System.IO
15+import qualified GHC
1916
2017-- | Ormolu exception representing all cases when Ormolu can fail.
18+
2119data OrmoluException
22− = -- | Parsing of original source code failed
23− OrmoluParsingFailed GHC.SrcSpan String
24− | -- | Parsing of formatted source code failed
25− OrmoluOutputParsingFailed GHC.SrcSpan String
26− | -- | Original and resulting ASTs differ
27− OrmoluASTDiffers FilePath [GHC.SrcSpan]
28− | -- | Formatted source code is not idempotent
29− OrmoluNonIdempotentOutput GHC.RealSrcLoc Text Text
30− | -- | Some GHC options were not recognized
31− OrmoluUnrecognizedOpts (NonEmpty String)
20+ = OrmoluCppEnabled FilePath
21+ -- ^ Ormolu does not work with source files that use CPP
22+ | OrmoluParsingFailed GHC.SrcSpan String
23+ -- ^ Parsing of original source code failed
24+ | OrmoluOutputParsingFailed GHC.SrcSpan String
25+ -- ^ Parsing of formatted source code failed
26+ | OrmoluASTDiffers FilePath [GHC.SrcSpan]
27+ -- ^ Original and resulting ASTs differ
3228 deriving (Eq, Show)
3329
3430instance Exception OrmoluException where
3531 displayException = \case
32+ OrmoluCppEnabled path -> unlines
33+ [ "CPP is not supported:"
34+ , withIndent path
35+ ]
3636 OrmoluParsingFailed s e ->
37− showParsingErr "The GHC parser (in Haddock mode) failed:" s [e]
37+ showParsingErr "Parsing of source code failed:" s e
3838 OrmoluOutputParsingFailed s e ->
39− showParsingErr "Parsing of formatted code failed:" s [e]
40− ++ "Please, consider reporting the bug.\n"
41− OrmoluASTDiffers path ss ->
42− unlines $
43− [ "AST of input and AST of formatted code differ."
44− ]
45− ++ fmap
46− withIndent
47− ( case fmap (\s -> "at " ++ showOutputable s) ss of
48− [] -> ["in " ++ path]
49− xs -> xs
50− )
51− ++ ["Please, consider reporting the bug."]
52− OrmoluNonIdempotentOutput loc left right ->
53− showParsingErr
54− "Formatting is not idempotent:"
55− loc
56− ["before: " ++ show left, "after: " ++ show right]
57− ++ "Please, consider reporting the bug.\n"
58− OrmoluUnrecognizedOpts opts ->
59− unlines
60− [ "The following GHC options were not recognized:",
61− (withIndent . unwords . NE.toList) opts
62− ]
39+ showParsingErr "Parsing of formatted code failed:" s e ++
40+ "Please, consider reporting the bug.\n"
41+ OrmoluASTDiffers path ss -> unlines $
42+ [ "AST of input and AST of formatted code differ."
43+ ]
44+ ++ (fmap withIndent $ case fmap (\s -> "at " ++ showOutputable s) ss of
45+ [] -> ["in " ++ path]
46+ xs -> xs) ++
47+ [ "Please, consider reporting the bug."
48+ ]
6349
6450-- | Inside this wrapper 'OrmoluException' will be caught and displayed
6551-- nicely using 'displayException'.
66−withPrettyOrmoluExceptions ::
67− -- | Action that may throw the exception
68− IO a ->
69− IO a
52+
53+withPrettyOrmoluExceptions
54+ :: IO a -- ^ Action that may throw the exception
55+ -> IO a
7056withPrettyOrmoluExceptions m = m `catch` h
7157 where
7258 h :: OrmoluException -> IO a
@@ -74,26 +60,25 @@ withPrettyOrmoluExceptions m = m `catch` h
7460 hPutStrLn stderr (displayException e)
7561 exitWith . ExitFailure $
7662 case e of
77− -- Error code 1 is for 'error' or 'notImplemented'
78− -- 2 used to be for erroring out on CPP
79− OrmoluParsingFailed {} -> 3
80− OrmoluOutputParsingFailed {} -> 4
81− OrmoluASTDiffers {} -> 5
82− OrmoluNonIdempotentOutput {} -> 6
83− OrmoluUnrecognizedOpts {} -> 7
63+ -- Error code 1 is for `error` or `notImplemented`
64+ OrmoluCppEnabled _ -> 2
65+ OrmoluParsingFailed _ _ -> 3
66+ OrmoluOutputParsingFailed _ _ -> 4
67+ OrmoluASTDiffers _ _ -> 5
8468
8569----------------------------------------------------------------------------
8670-- Helpers
8771
8872-- | Show a parse error.
89−showParsingErr :: GHC.Outputable a => String -> a -> [String] -> String
90−showParsingErr msg spn err =
91− unlines $
92− [ msg,
93− withIndent (showOutputable spn)
94− ]
95− ++ map withIndent err
73+
74+showParsingErr :: String -> GHC.SrcSpan -> String -> String
75+showParsingErr msg spn err = unlines
76+ [ msg
77+ , withIndent (showOutputable spn)
78+ , withIndent err
79+ ]
9680
9781-- | Indent with 2 spaces for readability.
82+
9883withIndent :: String -> String
9984withIndent txt = " " ++ txt
src/Ormolu/Imports.hs+62−176
@@ -1,202 +1,88 @@
11{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE RankNTypes #-}
3−{-# LANGUAGE RecordWildCards #-}
43
54-- | Manipulations on import lists.
5+
66module Ormolu.Imports
7− ( normalizeImports,
7+ ( sortImports
88 )
99where
1010
1111import Data.Bifunctor
12−import Data.Char (isAlphaNum)
1312import Data.Function (on)
14−import Data.List (foldl', nubBy, sortBy, sortOn)
15−import Data.Map.Strict (Map)
16−import qualified Data.Map.Strict as M
17−import FastString (FastString)
13+import Data.Generics (gcompare)
14+import Data.List (sortBy)
1815import GHC hiding (GhcPs, IE)
19−import GHC.Hs.Extension
20−import GHC.Hs.ImpExp (IE (..))
21−import Ormolu.Utils (notImplemented, showOutputable)
22−
23−-- | Sort and normalize imports.
24−normalizeImports :: [LImportDecl GhcPs] -> [LImportDecl GhcPs]
25−normalizeImports =
26− fmap snd
27− . M.toAscList
28− . M.fromListWith combineImports
29− . fmap (\x -> (importId x, g x))
30− where
31− g (L l ImportDecl {..}) =
32− L
33− l
34− ImportDecl
35− { ideclHiding = second (fmap normalizeLies) <$> ideclHiding,
36− ..
37− }
38− g _ = notImplemented "XImportDecl"
39−
40−-- | Combine two import declarations. It should be assumed that 'ImportId's
41−-- are equal.
42−combineImports ::
43− LImportDecl GhcPs ->
44− LImportDecl GhcPs ->
45− LImportDecl GhcPs
46−combineImports (L lx ImportDecl {..}) (L _ y) =
47− L
48− lx
49− ImportDecl
50− { ideclHiding = case (ideclHiding, GHC.ideclHiding y) of
51− (Just (hiding, L l' xs), Just (_, L _ ys)) ->
52− Just (hiding, (L l' (normalizeLies (xs ++ ys))))
53− _ -> Nothing,
54− ..
55− }
56−combineImports _ _ = notImplemented "XImportDecl"
57−
58−-- | Import id, a collection of all things that justify having a separate
59−-- import entry. This is used for merging of imports. If two imports have
60−-- the same 'ImportId' they can be merged.
61−data ImportId = ImportId
62− { importIsPrelude :: Bool,
63− importIdName :: ModuleName,
64− importPkgQual :: Maybe FastString,
65− importSource :: Bool,
66− importSafe :: Bool,
67− importQualified :: Bool,
68− importImplicit :: Bool,
69− importAs :: Maybe ModuleName,
70− importHiding :: Maybe Bool
71− }
72− deriving (Eq, Ord)
73−
74−-- | Obtain an 'ImportId' for a given import.
75−importId :: LImportDecl GhcPs -> ImportId
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− }
16+import HsExtension
17+import HsImpExp (IE (..))
18+import Ormolu.Utils (notImplemented)
19+
20+-- | Sort imports by module name. This also sorts explicit import lists for
21+-- each declaration.
22+
23+sortImports :: [LImportDecl GhcPs] -> [LImportDecl GhcPs]
24+sortImports = sortBy compareIdecl . fmap (fmap sortImportLists)
9125 where
92− isPrelude = moduleNameString moduleName == "Prelude"
93− moduleName = unLoc ideclName
94−importId _ = notImplemented "XImportDecl"
26+ sortImportLists :: ImportDecl GhcPs -> ImportDecl GhcPs
27+ sortImportLists decl =
28+ decl { ideclHiding = second (fmap sortLies) <$> ideclHiding decl
29+ }
9530
96−-- | Normalize a collection of import\/export items.
97−normalizeLies :: [LIE GhcPs] -> [LIE GhcPs]
98−normalizeLies = sortOn (getIewn . unLoc) . M.elems . foldl' combine M.empty
31+-- | Compare two @'LImportDecl' 'GhcPs'@ things.
32+
33+compareIdecl :: LImportDecl GhcPs -> LImportDecl GhcPs -> Ordering
34+compareIdecl (L _ m0) (L _ m1) =
35+ case (isPrelude n0, isPrelude n1) of
36+ (False, False) -> n0 `compare` n1
37+ (True, False) -> GT
38+ (False, True) -> LT
39+ (True, True) -> m0 `gcompare` m1
9940 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
151−
152−-- | A wrapper for @'IEWrappedName' 'RdrName'@ that allows us to define an
153−-- 'Ord' instance for it.
154−newtype IEWrappedNameOrd = IEWrappedNameOrd (IEWrappedName RdrName)
155− deriving (Eq)
156−
157−instance Ord IEWrappedNameOrd where
158− compare (IEWrappedNameOrd x) (IEWrappedNameOrd y) = compareIewn x y
41+ n0 = unLoc (ideclName m0)
42+ n1 = unLoc (ideclName m1)
43+ isPrelude = (== "Prelude") . moduleNameString
44+
45+-- | Sort located import or export.
46+
47+sortLies :: [LIE GhcPs] -> [LIE GhcPs]
48+sortLies = sortBy (compareIE `on` unLoc) . fmap (fmap sortThings)
49+
50+-- | Sort imports\/exports inside of 'IEThingWith'.
51+
52+sortThings :: IE GhcPs -> IE GhcPs
53+sortThings = \case
54+ IEThingWith NoExt x w xs fl ->
55+ IEThingWith NoExt x w (sortBy (compareIewn `on` unLoc) xs) fl
56+ other -> other
57+
58+-- | Compare two located imports or exports.
59+
60+compareIE :: IE GhcPs -> IE GhcPs -> Ordering
61+compareIE = compareIewn `on` getIewn
15962
16063-- | Project @'IEWrappedName' 'RdrName'@ from @'IE' 'GhcPs'@.
161−getIewn :: IE GhcPs -> IEWrappedNameOrd
64+
65+getIewn :: IE GhcPs -> IEWrappedName RdrName
16266getIewn = \case
163− IEVar NoExtField x -> IEWrappedNameOrd (unLoc x)
164− IEThingAbs NoExtField x -> IEWrappedNameOrd (unLoc x)
165− IEThingAll NoExtField x -> IEWrappedNameOrd (unLoc x)
166− IEThingWith NoExtField x _ _ _ -> IEWrappedNameOrd (unLoc x)
167− IEModuleContents NoExtField _ -> notImplemented "IEModuleContents"
168− IEGroup NoExtField _ _ -> notImplemented "IEGroup"
169− IEDoc NoExtField _ -> notImplemented "IEDoc"
170− IEDocNamed NoExtField _ -> notImplemented "IEDocNamed"
171− XIE x -> noExtCon x
172−
173−-- | Like 'compareIewn' for located wrapped names.
174−compareLIewn :: LIEWrappedName RdrName -> LIEWrappedName RdrName -> Ordering
175−compareLIewn = compareIewn `on` unLoc
67+ IEVar NoExt x -> unLoc x
68+ IEThingAbs NoExt x -> unLoc x
69+ IEThingAll NoExt x -> unLoc x
70+ IEThingWith NoExt x _ _ _ -> unLoc x
71+ IEModuleContents NoExt _ -> notImplemented "IEModuleContents"
72+ IEGroup NoExt _ _ -> notImplemented "IEGroup"
73+ IEDoc NoExt _ -> notImplemented "IEDoc"
74+ IEDocNamed NoExt _ -> notImplemented "IEDocNamed"
75+ XIE NoExt -> notImplemented "XIE"
17676
17777-- | Compare two @'IEWrapppedName' 'RdrName'@ things.
78+
17879compareIewn :: IEWrappedName RdrName -> IEWrappedName RdrName -> Ordering
179−compareIewn (IEName x) (IEName y) = unLoc x `compareRdrName` unLoc y
80+compareIewn (IEName x) (IEName y) = unLoc x `compare` unLoc y
18081compareIewn (IEName _) (IEPattern _) = LT
18182compareIewn (IEName _) (IEType _) = LT
18283compareIewn (IEPattern _) (IEName _) = GT
183−compareIewn (IEPattern x) (IEPattern y) = unLoc x `compareRdrName` unLoc y
84+compareIewn (IEPattern x) (IEPattern y) = unLoc x `compare` unLoc y
18485compareIewn (IEPattern _) (IEType _) = LT
18586compareIewn (IEType _) (IEName _) = GT
18687compareIewn (IEType _) (IEPattern _) = GT
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
88+compareIewn (IEType x) (IEType y) = unLoc x `compare` unLoc y
src/Ormolu/Parser.hs+157−183
@@ -1,219 +1,193 @@
1−{-# LANGUAGE LambdaCase #-}
2−{-# LANGUAGE RecordWildCards #-}
1+{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE StandaloneDeriving #-}
33{-# OPTIONS_GHC -fno-warn-orphans #-}
44
55-- | Parser for Haskell source code.
6+
67module Ormolu.Parser
7− ( parseModule,
8− manualExts,
8+ ( parseModule
9+ , manualExts
910 )
1011where
1112
12−import Bag (bagToList)
13−import qualified CmdLineParser as GHC
1413import Control.Exception
14+import Control.Monad
1515import Control.Monad.IO.Class
16−import qualified Data.List as L
17−import qualified Data.List.NonEmpty as NE
18−import Data.Ord (Down (Down))
19−import qualified Data.Text as T
20−import DynFlags as GHC
21−import ErrUtils (Severity (..), errMsgSeverity, errMsgSpan)
22−import qualified FastString as GHC
23−import GHC hiding (IE, UnicodeSyntax)
24−import GHC.DynFlags (baseDynFlags)
16+import Data.List (isPrefixOf, foldl', (\\))
17+import Data.Maybe (catMaybes)
18+import GHC hiding (IE, parseModule, parser)
2519import GHC.LanguageExtensions.Type (Extension (..))
26−import qualified HeaderInfo as GHC
27−import qualified HscTypes as GHC
28−import qualified Lexer as GHC
20+import GHC.Paths (libdir)
2921import Ormolu.Config
3022import Ormolu.Exception
3123import Ormolu.Parser.Anns
3224import Ormolu.Parser.CommentStream
3325import Ormolu.Parser.Result
34−import Ormolu.Processing.Preprocess (preprocess)
35−import Ormolu.Utils (incSpanLine, removeIndentation)
36−import qualified Panic as GHC
26+import qualified CmdLineParser as GHC
27+import qualified DynFlags as GHC
28+import qualified FastString as GHC
29+import qualified HeaderInfo as GHC
30+import qualified Lexer as GHC
31+import qualified Outputable as GHC
3732import qualified Parser as GHC
33+import qualified SrcLoc as GHC
3834import qualified StringBuffer as GHC
3935
4036-- | Parse a complete module from string.
41−parseModule ::
42− MonadIO m =>
43− -- | Ormolu configuration
44− Config RegionDeltas ->
45− -- | File name (only for source location annotations)
46− FilePath ->
47− -- | Input for parser
48− String ->
49− m
50− ( [GHC.Warn],
51− Either (SrcSpan, String) ParseResult
52− )
53−parseModule Config {..} path rawInput = liftIO $ do
54− let (literalPrefix, indentedInput, literalSuffix, extraComments) =
55− preprocess path rawInput cfgRegion
56− (input, indent) = removeIndentation indentedInput
57− -- It's important that 'setDefaultExts' is done before
58− -- 'parsePragmasIntoDynFlags', because otherwise we might enable an
59− -- extension that was explicitly disabled in the file.
60− let baseFlags =
61− GHC.setGeneralFlag'
62− GHC.Opt_Haddock
63− (setDefaultExts baseDynFlags)
64− extraOpts = dynOptionToLocatedStr <$> cfgDynOptions
65− (warnings, dynFlags) <-
66− parsePragmasIntoDynFlags baseFlags extraOpts path rawInput >>= \case
67− Right res -> pure res
68− Left err ->
69− let loc =
70− mkSrcSpan
71− (mkSrcLoc (GHC.mkFastString path) 1 1)
72− (mkSrcLoc (GHC.mkFastString path) 1 1)
73− in throwIO (OrmoluParsingFailed loc err)
74− let useRecordDot =
75− "record-dot-preprocessor" == pgm_F dynFlags
76− || any
77− (("RecordDotPreprocessor" ==) . moduleNameString)
78− (pluginModNames dynFlags)
79− pStateErrors = \pstate ->
80− let errs = bagToList $ GHC.getErrorMessages pstate dynFlags
81− fixupErrSpan = incSpanLine (regionPrefixLength cfgRegion)
82− in case L.sortOn (Down . SeverityOrd . errMsgSeverity) errs of
83− [] -> Nothing
84− err : _ ->
85− -- Show instance returns a short error message
86− Just (fixupErrSpan (errMsgSpan err), show err)
87− r = case runParser GHC.parseModule dynFlags path input of
88− GHC.PFailed pstate ->
89− case pStateErrors pstate of
90− Just err -> Left err
91− Nothing -> error "PFailed does not have an error"
92− GHC.POk pstate (L _ hsModule) ->
93− case pStateErrors pstate of
94− -- Some parse errors (pattern/arrow syntax in expr context)
95− -- do not cause a parse error, but they are replaced with "_"
96− -- by the parser and the modified AST is propagated to the
97− -- later stages; but we fail in those cases.
98− Just err -> Left err
99− Nothing ->
100− let (stackHeader, shebangs, pragmas, comments) =
101− mkCommentStream input extraComments pstate
102− in Right
103− ParseResult
104− { prParsedSource = hsModule,
105− prAnns = mkAnns pstate,
106− prStackHeader = stackHeader,
107− prShebangs = shebangs,
108− prPragmas = pragmas,
109− prCommentStream = comments,
110− prUseRecordDot = useRecordDot,
111− prImportQualifiedPost =
112− GHC.xopt ImportQualifiedPost dynFlags,
113− prLiteralPrefix = T.pack literalPrefix,
114− prLiteralSuffix = T.pack literalSuffix,
115− prIndent = indent
116− }
117− return (warnings, r)
11837
119−-- | Enable all language extensions that we think should be enabled by
120−-- default for ease of use.
121−setDefaultExts :: DynFlags -> DynFlags
122−setDefaultExts flags = L.foldl' xopt_set flags autoExts
123− where
124− autoExts = allExts L.\\ manualExts
125− allExts = [minBound .. maxBound]
38+parseModule
39+ :: MonadIO m
40+ => Config -- ^ Ormolu configuration
41+ -> FilePath -- ^ File name (only for source location annotations)
42+ -> String -- ^ Input for parser
43+ -> m ( [GHC.Warn]
44+ , Either (SrcSpan, String) ParseResult
45+ )
46+parseModule Config {..} path input' = liftIO $ do
47+ let (input, extraComments) = stripLinePragmas input'
48+ (ws, dynFlags) <- ghcWrapper $ do
49+ dynFlags0 <- initDynFlagsPure path input
50+ (dynFlags1, _, ws) <- GHC.parseDynamicFilePragma
51+ dynFlags0
52+ (dynOptionToLocatedStr <$> cfgDynOptions)
53+ return (ws, dynFlags1)
54+ -- NOTE It's better to throw this outside of 'ghcWrapper' because
55+ -- otherwise the exception will be wrapped as a GHC panic, which we don't
56+ -- want.
57+ when (GHC.xopt Cpp dynFlags && not cfgTolerateCpp) $
58+ throwIO (OrmoluCppEnabled path)
59+ let r = case runParser GHC.parseModule dynFlags path input of
60+ GHC.PFailed _ ss m ->
61+ Left (ss, GHC.showSDoc dynFlags m)
62+ GHC.POk pstate pmod ->
63+ let (comments, exts) = mkCommentStream extraComments pstate
64+ in Right ParseResult
65+ { prParsedSource = pmod
66+ , prAnns = mkAnns pstate
67+ , prCommentStream = comments
68+ , prExtensions = exts
69+ }
70+ return (ws, r)
12671
12772-- | Extensions that are not enabled automatically and should be activated
12873-- by user.
74+
12975manualExts :: [Extension]
13076manualExts =
131− [ Arrows, -- steals proc
132− Cpp, -- forbidden
133− BangPatterns, -- makes certain patterns with ! fail
134− PatternSynonyms, -- steals the pattern keyword
135− RecursiveDo, -- steals the rec keyword
136− StaticPointers, -- steals static keyword
137− TransformListComp, -- steals the group keyword
138− UnboxedTuples, -- breaks (#) lens operator
139− MagicHash, -- screws {-# these things #-}
140− TypeApplications, -- steals (@) operator on some cases
141− AlternativeLayoutRule,
142− AlternativeLayoutRuleTransitional,
143− MonadComprehensions,
144− UnboxedSums,
145− UnicodeSyntax, -- gives special meanings to operators like (→)
146− TemplateHaskellQuotes, -- enables TH subset of quasi-quotes, this
147− -- apparently interferes with QuasiQuotes in
148− -- weird ways
149− ImportQualifiedPost -- affects how Ormolu renders imports, so the
150− -- decision of enabling this style is left to the user
77+ [ Arrows -- steals proc
78+ , Cpp -- forbidden
79+ , PatternSynonyms -- steals the pattern keyword
80+ , RecursiveDo -- steals the rec keyword
81+ , StaticPointers -- steals static keyword
82+ , TransformListComp -- steals the group keyword
83+ , UnboxedTuples -- breaks (#) lens operator
84+ , MagicHash -- screws {-# these things #-}
85+ , AlternativeLayoutRule
86+ , AlternativeLayoutRuleTransitional
87+ , MonadComprehensions
88+ , UnboxedSums
89+ , TemplateHaskellQuotes -- enables TH subset of quasi-quotes, this
90+ -- apparently interferes with QuasiQuotes in
91+ -- weird ways
15192 ]
15293
94+----------------------------------------------------------------------------
95+-- Helpers (taken from ghc-exactprint)
96+
97+-- | Requires GhcMonad constraint because there is no pure variant of
98+-- 'parseDynamicFilePragma'. Yet, in constrast to 'initDynFlags', it does
99+-- not (try to) read the file at filepath, but solely depends on the module
100+-- source in the input string.
101+--
102+-- Passes "-hide-all-packages" to the GHC API to prevent parsing of package
103+-- environment files. However this only works if there is no invocation of
104+-- 'setSessionDynFlags' before calling 'initDynFlagsPure'. See GHC tickets
105+-- #15513, #15541.
106+
107+initDynFlagsPure
108+ :: GHC.GhcMonad m
109+ => FilePath -- ^ Module path
110+ -> String -- ^ Module contents
111+ -> m GHC.DynFlags -- ^ Dynamic flags for that module
112+initDynFlagsPure fp input = do
113+ -- I was told we could get away with using the 'unsafeGlobalDynFlags'. as
114+ -- long as 'parseDynamicFilePragma' is impure there seems to be no reason
115+ -- to use it.
116+ dflags0 <- setDefaultExts <$> GHC.getSessionDynFlags
117+ let tokens = GHC.getOptions dflags0 (GHC.stringToStringBuffer input) fp
118+ (dflags1, _, _) <- GHC.parseDynamicFilePragma dflags0 tokens
119+ -- Turn this on last to avoid T10942
120+ let dflags2 = dflags1 `GHC.gopt_set` GHC.Opt_KeepRawTokenStream
121+ -- Prevent parsing of .ghc.environment.* "package environment files"
122+ (dflags3, _, _) <- GHC.parseDynamicFlagsCmdLine
123+ dflags2
124+ [GHC.noLoc "-hide-all-packages"]
125+ _ <- GHC.setSessionDynFlags dflags3
126+ return dflags3
127+
128+-- | Default runner of 'GHC.Ghc' action in 'IO'.
129+
130+ghcWrapper :: GHC.Ghc a -> IO a
131+ghcWrapper
132+ = GHC.defaultErrorHandler GHC.defaultFatalMessager GHC.defaultFlushOut
133+ . GHC.runGhc (Just libdir)
134+
153135-- | Run a 'GHC.P' computation.
154−runParser ::
155− -- | Computation to run
156− GHC.P a ->
157− -- | Dynamic flags
158− GHC.DynFlags ->
159− -- | Module path
160− FilePath ->
161− -- | Module contents
162− String ->
163− -- | Parse result
164− GHC.ParseResult a
136+
137+runParser
138+ :: GHC.P a -- ^ Computation to run
139+ -> GHC.DynFlags -- ^ Dynamic flags
140+ -> FilePath -- ^ Module path
141+ -> String -- ^ Module contents
142+ -> GHC.ParseResult a -- ^ Parse result
165143runParser parser flags filename input = GHC.unP parser parseState
166144 where
167145 location = GHC.mkRealSrcLoc (GHC.mkFastString filename) 1 1
168146 buffer = GHC.stringToStringBuffer input
169147 parseState = GHC.mkPState flags buffer location
170148
171−-- | Wrap GHC's 'Severity' to add 'Ord' instance.
172−newtype SeverityOrd = SeverityOrd Severity
173−
174−instance Eq SeverityOrd where
175− s1 == s2 = compare s1 s2 == EQ
176−
177−instance Ord SeverityOrd where
178− compare (SeverityOrd s1) (SeverityOrd s2) =
179− compare (f s1) (f s2)
180− where
181− f :: Severity -> Int
182− f SevOutput = 1
183− f SevFatal = 2
184− f SevInteractive = 3
185− f SevDump = 4
186− f SevInfo = 5
187− f SevWarning = 6
188− f SevError = 7
149+-- | Remove GHC style line pragams (@{-# LINE .. #-}@) and convert them into
150+-- comments.
189151
190−----------------------------------------------------------------------------
191−-- Helpers taken from HLint
192−
193−parsePragmasIntoDynFlags ::
194− -- | Pre-set 'DynFlags'
195− DynFlags ->
196− -- | Extra options (provided by user)
197− [Located String] ->
198− -- | File name (only for source location annotations)
199− FilePath ->
200− -- | Input for parser
201− String ->
202− IO (Either String ([GHC.Warn], DynFlags))
203−parsePragmasIntoDynFlags flags extraOpts filepath str =
204− catchErrors $ do
205− let opts = GHC.getOptions flags (GHC.stringToStringBuffer str) filepath
206− (flags', leftovers, warnings) <-
207− parseDynamicFilePragma flags (opts <> extraOpts)
208− case NE.nonEmpty leftovers of
209− Nothing -> return ()
210− Just unrecognizedOpts ->
211− throwIO (OrmoluUnrecognizedOpts (unLoc <$> unrecognizedOpts))
212− let flags'' = flags' `gopt_set` Opt_KeepRawTokenStream
213− return $ Right (warnings, flags'')
152+stripLinePragmas :: String -> (String, [Located String])
153+stripLinePragmas = unlines' . unzip . findLines . lines
154+ where
155+ unlines' (a, b) = (unlines a, catMaybes b)
156+
157+findLines :: [String] -> [(String, Maybe (Located String))]
158+findLines = zipWith checkLine [1..]
159+
160+checkLine :: Int -> String -> (String, Maybe (Located String))
161+checkLine line s
162+ | "{-# LINE" `isPrefixOf` s =
163+ let (pragma, res) = getPragma s
164+ size = length pragma
165+ mSrcLoc = mkSrcLoc (GHC.mkFastString "LINE")
166+ ss = mkSrcSpan (mSrcLoc line 1) (mSrcLoc line (size+1))
167+ in (res, Just $ L ss pragma)
168+ -- Deal with shebang/cpp directives too
169+ -- x | "#" `isPrefixOf` s = ("",Just $ Comment ((line, 1), (line, length s)) s)
170+ | "#!" `isPrefixOf` s =
171+ let mSrcLoc = mkSrcLoc (GHC.mkFastString "SHEBANG")
172+ ss = mkSrcSpan (mSrcLoc line 1) (mSrcLoc line (length s))
173+ in ("",Just $ L ss s)
174+ | otherwise = (s, Nothing)
175+
176+getPragma :: String -> (String, String)
177+getPragma [] = error "Ormolu.Parser.getPragma: input must not be empty"
178+getPragma s@(x:xs)
179+ | "#-}" `isPrefixOf` s = ("#-}", " " ++ drop 3 s)
180+ | otherwise =
181+ let (prag, remline) = getPragma xs
182+ in (x:prag, ' ':remline)
183+
184+-- | Enable all language extensions that we think should be enabled by
185+-- default for ease of use.
186+
187+setDefaultExts :: DynFlags -> DynFlags
188+setDefaultExts flags = foldl' GHC.xopt_set flags autoExts
214189 where
215− catchErrors act =
216− GHC.handleGhcException
217− reportErr
218− (GHC.handleSourceError reportErr act)
219− reportErr e = return $ Left (show e)
190+ autoExts = allExts \\ manualExts
191+ allExts = [minBound..maxBound]
192+
193+deriving instance Bounded Extension
src/Ormolu/Parser/Anns.hs+20−18
@@ -1,34 +1,37 @@
11-- | Ormolu-specific representation of GHC annotations.
2+
23module Ormolu.Parser.Anns
3− ( Anns (..),
4− emptyAnns,
5− mkAnns,
6− lookupAnns,
4+ ( Anns (..)
5+ , emptyAnns
6+ , mkAnns
7+ , lookupAnns
78 )
89where
910
1011import Data.Map.Strict (Map)
11−import qualified Data.Map.Strict as M
1212import Data.Maybe (mapMaybe)
13+import SrcLoc
14+import qualified Data.Map.Strict as M
1315import qualified GHC
1416import qualified Lexer as GHC
15−import SrcLoc
1617
1718-- | Ormolu-specific representation of GHC annotations.
19+
1820newtype Anns = Anns (Map RealSrcSpan [GHC.AnnKeywordId])
1921 deriving (Eq)
2022
2123-- | Empty 'Anns'.
24+
2225emptyAnns :: Anns
2326emptyAnns = Anns M.empty
2427
2528-- | Create 'Anns' from 'GHC.PState'.
26−mkAnns ::
27− GHC.PState ->
28− Anns
29−mkAnns pstate =
30− Anns $
31− M.fromListWith (++) (mapMaybe f (GHC.annotations pstate))
29+
30+mkAnns
31+ :: GHC.PState
32+ -> Anns
33+mkAnns pstate = Anns $
34+ M.fromListWith (++) (mapMaybe f (GHC.annotations pstate))
3235 where
3336 f ((spn, kid), _) =
3437 case spn of
@@ -36,11 +39,10 @@ mkAnns pstate =
3639 UnhelpfulSpan _ -> Nothing
3740
3841-- | Lookup 'GHC.AnnKeywordId's corresponding to a given 'SrcSpan'.
39−lookupAnns ::
40− -- | Span to lookup with
41− SrcSpan ->
42− -- | Collection of annotations
43− Anns ->
44− [GHC.AnnKeywordId]
42+
43+lookupAnns
44+ :: SrcSpan -- ^ Span to lookup with
45+ -> Anns -- ^ Collection of annotations
46+ -> [GHC.AnnKeywordId]
4547lookupAnns (RealSrcSpan rspn) (Anns m) = M.findWithDefault [] rspn m
4648lookupAnns (UnhelpfulSpan _) _ = []
src/Ormolu/Parser/CommentStream.hs+89−184
@@ -1,226 +1,131 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE DeriveDataTypeable #-}
23{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3−{-# LANGUAGE LambdaCase #-}
4+{-# LANGUAGE LambdaCase #-}
5+{-# LANGUAGE TupleSections #-}
46
57-- | Functions for working with comment stream.
8+
69module Ormolu.Parser.CommentStream
7− ( -- * Comment stream
8− CommentStream (..),
9− mkCommentStream,
10− showCommentStream,
11−
12− -- * Comment
13− Comment (..),
14− unComment,
15− hasAtomsBefore,
16− isMultilineComment,
10+ ( CommentStream (..)
11+ , Comment (..)
12+ , mkCommentStream
13+ , isPrevHaddock
14+ , showCommentStream
1715 )
1816where
1917
2018import Data.Char (isSpace)
2119import Data.Data (Data)
22−import qualified Data.List as L
20+import Data.Either (partitionEithers)
21+import Data.List (isPrefixOf, sortOn, dropWhileEnd)
2322import Data.List.NonEmpty (NonEmpty (..))
24−import qualified Data.List.NonEmpty as NE
2523import Data.Maybe (mapMaybe)
26−import qualified GHC
27−import qualified Lexer as GHC
2824import Ormolu.Parser.Pragma
29−import Ormolu.Parser.Shebang
30−import Ormolu.Processing.Common
31−import Ormolu.Utils (onTheSameLine, showOutputable)
25+import Ormolu.Utils (showOutputable)
3226import SrcLoc
33−
34−----------------------------------------------------------------------------
35−-- Comment stream
27+import qualified Data.List.NonEmpty as NE
28+import qualified GHC
29+import qualified Lexer as GHC
3630
3731-- | A stream of 'RealLocated' 'Comment's in ascending order with respect to
3832-- beginning of corresponding spans.
33+
3934newtype CommentStream = CommentStream [RealLocated Comment]
4035 deriving (Eq, Data, Semigroup, Monoid)
4136
42−-- | Create 'CommentStream' from 'GHC.PState'. The pragmas and shebangs are
43−-- removed from the 'CommentStream'. Shebangs are only extracted from the
44−-- comments that come from the first argument.
45−mkCommentStream ::
46− -- | Original input
47− String ->
48− -- | Extra comments to include
49− [Located String] ->
50− -- | Parser state to use for comment extraction
51− GHC.PState ->
52− -- | Stack header, shebangs, pragmas, and comment stream
53− ( Maybe (RealLocated Comment),
54− [Shebang],
55− [([RealLocated Comment], Pragma)],
56− CommentStream
57− )
58−mkCommentStream input extraComments pstate =
59− ( mstackHeader,
60− shebangs,
61− pragmas,
62− CommentStream comments
37+-- | A wrapper for a single comment. The 'NonEmpty' list inside contains
38+-- lines of multiline comment @{- … -}@ or just single item\/line otherwise.
39+
40+newtype Comment = Comment (NonEmpty String)
41+ deriving (Eq, Show, Data)
42+
43+-- | Create 'CommentStream' from 'GHC.PState'. We also create a 'Set' of
44+-- extensions here, which is not sorted in any way. The pragma comment are
45+-- removed from the 'CommentStream'.
46+
47+mkCommentStream
48+ :: [Located String] -- ^ Extra comments to include
49+ -> GHC.PState -- ^ Parser state to use for comment extraction
50+ -> (CommentStream, [Pragma])
51+ -- ^ Comment stream and a set of extracted pragmas
52+mkCommentStream extraComments pstate =
53+ ( CommentStream $
54+ -- NOTE It's easier to normalize pragmas right when we construct comment
55+ -- streams. Because this way we need to do it only once and when we
56+ -- perform checking later they'll automatically match.
57+ mkComment <$> sortOn (realSrcSpanStart . getLoc) comments
58+ , pragmas
6359 )
6460 where
65− (comments, pragmas) = extractPragmas input rawComments1
66− (rawComments1, mstackHeader) = extractStackHeader rawComments0
67− rawComments0 =
68− L.sortOn (realSrcSpanStart . getRealSrcSpan) . mapMaybe toRealSpan $
69− otherExtraComments
70− ++ mapMaybe (liftMaybe . fmap unAnnotationComment) (GHC.comment_q pstate)
71− ++ concatMap
72− (mapMaybe (liftMaybe . fmap unAnnotationComment) . snd)
73− (GHC.annotations_comments pstate)
74− (shebangs, otherExtraComments) = extractShebangs extraComments
61+ (comments, pragmas) = partitionEithers (partitionComments <$> rawComments)
62+ rawComments = mapMaybe toRealSpan $
63+ extraComments ++
64+ (fmap unAnnotationComment <$> GHC.comment_q pstate) ++
65+ concatMap (fmap (fmap unAnnotationComment) . snd)
66+ (GHC.annotations_comments pstate)
67+
68+-- | Test whether a 'Comment' looks like a Haddock following a definition,
69+-- i.e. something starting with @-- ^@.
70+
71+isPrevHaddock :: Comment -> Bool
72+isPrevHaddock (Comment (x :| _)) = "-- ^" `isPrefixOf` x
7573
7674-- | Pretty-print a 'CommentStream'.
75+
7776showCommentStream :: CommentStream -> String
78−showCommentStream (CommentStream xs) =
79− unlines $
80− showComment <$> xs
77+showCommentStream (CommentStream xs) = unlines $
78+ showComment <$> xs
8179 where
8280 showComment (GHC.L l str) = showOutputable l ++ " " ++ show str
8381
8482----------------------------------------------------------------------------
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)
83+-- Helpers
9384
9485-- | Normalize comment string. Sometimes one multi-line comment is turned
9586-- into several lines for subsequent outputting with correct indentation for
9687-- each line.
97−mkComment ::
98− -- | Lines of original input with their indices
99− [(Int, String)] ->
100− -- | Raw comment string
101− RealLocated String ->
102− -- | Remaining lines of original input and the constructed 'Comment'
103− ([(Int, String)], RealLocated Comment)
104−mkComment ls (L l s) = (ls', comment)
105− where
106− comment =
107− L l . Comment atomsBefore . removeConseqBlanks . fmap dropTrailing $
108− if "{-" `L.isPrefixOf` s
109− then case NE.nonEmpty (lines s) of
110− Nothing -> s :| []
111− Just (x :| xs) ->
112− let getIndent y =
113− if all isSpace y || y == endDisabling
114− then startIndent
115− else length (takeWhile isSpace y)
116− n = minimum (startIndent : fmap getIndent xs)
117− removeIndent y =
118− if y == endDisabling
119− then y
120− else drop n y
121− in x :| (removeIndent <$> xs)
122− else s :| []
123− (atomsBefore, ls') =
124− case dropWhile ((< commentLine) . fst) ls of
125− [] -> (False, [])
126− ((_, i) : ls'') ->
127− case take 2 (dropWhile isSpace i) of
128− "--" -> (False, ls'')
129− "{-" -> (False, ls'')
130− _ -> (True, ls'')
131− dropTrailing = L.dropWhileEnd isSpace
132− startIndent = srcSpanStartCol l - 1
133− commentLine = srcSpanStartLine l
134−
135−-- | Get a collection of lines from a 'Comment'.
136−unComment :: Comment -> NonEmpty String
137−unComment (Comment _ xs) = xs
138−
139−-- | Check whether the 'Comment' had some non-whitespace atoms in front of
140−-- it in the original input.
141−hasAtomsBefore :: Comment -> Bool
142−hasAtomsBefore (Comment atomsBefore _) = atomsBefore
143−
144−-- | Is this comment multiline-style?
145−isMultilineComment :: Comment -> Bool
146−isMultilineComment (Comment _ (x :| _)) = "{-" `L.isPrefixOf` x
14788
148−----------------------------------------------------------------------------
149−-- Helpers
150−
151−-- | Detect and extract stack header if it is present.
152−extractStackHeader ::
153− -- | Comment stream to analyze
154− [RealLocated String] ->
155− ([RealLocated String], Maybe (RealLocated Comment))
156−extractStackHeader = \case
157− [] -> ([], Nothing)
158− (x : xs) ->
159− let comment = snd (mkComment [] x)
160− in if isStackHeader (unRealSrcSpan comment)
161− then (xs, Just comment)
162− else (x : xs, Nothing)
163− where
164− isStackHeader (Comment _ (x :| _)) =
165− "stack" `L.isPrefixOf` dropWhile isSpace (drop 2 x)
166−
167−-- | Extract pragmas and their associated comments.
168−extractPragmas ::
169− -- | Input
170− String ->
171− -- | Comment stream to analyze
172− [RealLocated String] ->
173− ([RealLocated Comment], [([RealLocated Comment], Pragma)])
174−extractPragmas input = go initialLs id id
89+mkComment :: RealLocated String -> RealLocated Comment
90+mkComment (L l s) = L l . Comment . fmap dropTrailing $
91+ if "{-" `isPrefixOf` s
92+ then case NE.nonEmpty (lines s) of
93+ Nothing -> s :| []
94+ Just (x:|xs) ->
95+ let getIndent y =
96+ if all isSpace y
97+ then startIndent
98+ else length (takeWhile isSpace y)
99+ n = minimum (startIndent : fmap getIndent xs)
100+ in x :| (drop n <$> xs)
101+ else s :| []
175102 where
176− initialLs = zip [1 ..] (lines input)
177− go ls csSoFar pragmasSoFar = \case
178− [] -> (csSoFar [], pragmasSoFar [])
179− (x : xs) ->
180− case parsePragma (unRealSrcSpan x) of
181− Nothing ->
182− let (ls', x') = mkComment ls x
183− in go ls' (csSoFar . (x' :)) pragmasSoFar xs
184− Just pragma ->
185− let combined ys = (csSoFar ys, pragma)
186− go' ls' ys rest = go ls' id (pragmasSoFar . (combined ys :)) rest
187− in case xs of
188− [] -> go' ls [] xs
189− (y : ys) ->
190− let (ls', y') = mkComment ls y
191− in if onTheSameLine
192− (RealSrcSpan (getRealSrcSpan x))
193− (RealSrcSpan (getRealSrcSpan y))
194− then go' ls' [y'] ys
195− else go' ls [] xs
103+ dropTrailing = dropWhileEnd isSpace
104+ startIndent = srcSpanStartCol l - 1
196105
197106-- | Get a 'String' from 'GHC.AnnotationComment'.
198−unAnnotationComment :: GHC.AnnotationComment -> Maybe String
107+
108+unAnnotationComment :: GHC.AnnotationComment -> String
199109unAnnotationComment = \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)
110+ GHC.AnnDocCommentNext s -> s
111+ GHC.AnnDocCommentPrev s -> s
112+ GHC.AnnDocCommentNamed s -> s
113+ GHC.AnnDocSection _ s -> s
114+ GHC.AnnDocOptions s -> s
115+ GHC.AnnLineComment s -> s
116+ GHC.AnnBlockComment s -> s
212117
213118toRealSpan :: Located a -> Maybe (RealLocated a)
214119toRealSpan (L (RealSrcSpan l) a) = Just (L l a)
215120toRealSpan _ = Nothing
216121
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
122+-- | If a given comment is a pragma, return it in parsed form in 'Right'.
123+-- Otherwise return the original comment unchanged.
124+
125+partitionComments
126+ :: RealLocated String
127+ -> Either (RealLocated String) Pragma
128+partitionComments input =
129+ case parsePragma (unLoc input) of
130+ Nothing -> Left input
131+ Just pragma -> Right pragma
src/Ormolu/Parser/Pragma.hs+33−34
@@ -1,42 +1,41 @@
1−{-# LANGUAGE LambdaCase #-}
1+-- | A module for parsing of pragmas from comments.
2+
3+{-# LANGUAGE LambdaCase #-}
24{-# LANGUAGE OverloadedStrings #-}
35
4−-- | A module for parsing of pragmas from comments.
56module Ormolu.Parser.Pragma
6− ( Pragma (..),
7− parsePragma,
7+ ( Pragma (..)
8+ , parsePragma
89 )
910where
1011
1112import Control.Monad
12−import Data.Char (isSpace, toLower)
13−import qualified Data.List as L
14−import qualified EnumSet as ES
13+import Data.Char (toLower, isSpace)
14+import Data.List
1515import FastString (mkFastString, unpackFS)
16−import qualified Lexer as L
17−import Module (ComponentId (..), newSimpleUnitId)
16+import Module (newSimpleUnitId, ComponentId (..))
1817import SrcLoc
1918import StringBuffer
19+import qualified EnumSet as ES
20+import qualified Lexer as L
2021
2122-- | Ormolu's representation of pragmas.
23+
2224data Pragma
23− = -- | Language pragma
24− PragmaLanguage [String]
25− | -- | GHC options pragma
26− PragmaOptionsGHC String
27− | -- | Haddock options pragma
28− PragmaOptionsHaddock String
25+ = PragmaLanguage [String] -- ^ Language pragma
26+ | PragmaOptionsGHC String -- ^ GHC options pragma
27+ | PragmaOptionsHaddock String -- ^ Haddock options pragma
2928 deriving (Show, Eq)
3029
3130-- | Extract a pragma from a comment if possible, or return 'Nothing'
3231-- otherwise.
33−parsePragma ::
34− -- | Comment to try to parse
35− String ->
36− Maybe Pragma
32+
33+parsePragma
34+ :: String -- ^ Comment to try to parse
35+ -> Maybe Pragma
3736parsePragma input = do
38− inputNoPrefix <- L.stripPrefix "{-#" input
39− guard ("#-}" `L.isSuffixOf` input)
37+ inputNoPrefix <- stripPrefix "{-#" input
38+ guard ("#-}" `isSuffixOf` input)
4039 let contents = take (length inputNoPrefix - 3) inputNoPrefix
4140 (pragmaName, cs) = (break isSpace . dropWhile isSpace) contents
4241 case toLower <$> pragmaName of
@@ -46,19 +45,21 @@ parsePragma input = do
4645 _ -> Nothing
4746 where
4847 trimSpaces :: String -> String
49− trimSpaces = L.dropWhileEnd isSpace . dropWhile isSpace
48+ trimSpaces = dropWhileEnd isSpace . dropWhile isSpace
5049
5150-- | Assuming the input consists of a series of tokens from a language
5251-- pragma, return the set of enabled extensions.
53−parseExtensions :: String -> Maybe [String]
52+
53+parseExtensions :: String -> Maybe [String]
5454parseExtensions str = tokenize str >>= go
5555 where
5656 go = \case
57− [L.ITconid ext] -> return [unpackFS ext]
57+ (L.ITconid ext : []) -> return [unpackFS ext]
5858 (L.ITconid ext : L.ITcomma : xs) -> (unpackFS ext :) <$> go xs
5959 _ -> Nothing
6060
6161-- | Tokenize a given input using GHC's lexer.
62+
6263tokenize :: String -> Maybe [L.Token]
6364tokenize input =
6465 case L.unP pLexer parseState of
@@ -68,17 +69,15 @@ tokenize input =
6869 location = mkRealSrcLoc (mkFastString "") 1 1
6970 buffer = stringToStringBuffer input
7071 parseState = L.mkPStatePure parserFlags buffer location
71− parserFlags =
72− L.mkParserFlags'
73− ES.empty
74− ES.empty
75− (newSimpleUnitId (ComponentId (mkFastString "")))
76− True
77− True
78− True
79− True
72+ parserFlags = L.ParserFlags
73+ { L.pWarningFlags = ES.empty
74+ , L.pExtensionFlags = ES.empty
75+ , L.pThisPackage = newSimpleUnitId (ComponentId (mkFastString ""))
76+ , L.pExtsBitmap = 0xffffffffffffffff
77+ }
8078
8179-- | Haskell lexer.
80+
8281pLexer :: L.P [L.Token]
8382pLexer = go
8483 where
@@ -86,4 +85,4 @@ pLexer = go
8685 r <- L.lexer False return
8786 case unLoc r of
8887 L.ITeof -> return []
89− x -> (x :) <$> go
88+ x -> (x:) <$> go
src/Ormolu/Parser/Result.hs+20−34
@@ -1,51 +1,37 @@
1+-- | A type for result of parsing.
2+
13{-# LANGUAGE RecordWildCards #-}
24
3−-- | A type for result of parsing.
45module Ormolu.Parser.Result
5− ( ParseResult (..),
6− prettyPrintParseResult,
6+ ( ParseResult (..)
7+ , prettyPrintParseResult
78 )
89where
910
10−import Data.Text (Text)
1111import GHC
1212import Ormolu.Parser.Anns
1313import Ormolu.Parser.CommentStream
1414import Ormolu.Parser.Pragma (Pragma)
15−import Ormolu.Parser.Shebang (Shebang)
1615
1716-- | A collection of data that represents a parsed module in Ormolu.
17+
1818data ParseResult = ParseResult
19− { -- | 'ParsedSource' from GHC
20− prParsedSource :: HsModule GhcPs,
21− -- | Ormolu-specfic representation of annotations
22− prAnns :: Anns,
23− -- | Stack header
24− prStackHeader :: Maybe (RealLocated Comment),
25− -- | Shebangs found in the input
26− prShebangs :: [Shebang],
27− -- | Pragmas and the associated comments
28− prPragmas :: [([RealLocated Comment], Pragma)],
29− -- | Comment stream
30− prCommentStream :: CommentStream,
31− -- | Whether or not record dot syntax is enabled
32− prUseRecordDot :: Bool,
33− -- | Whether or not ImportQualifiedPost is enabled
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
19+ { prParsedSource :: ParsedSource
20+ -- ^ 'ParsedSource' from GHC
21+ , prAnns :: Anns
22+ -- ^ Ormolu-specfic representation of annotations
23+ , prCommentStream :: CommentStream
24+ -- ^ Comment stream
25+ , prExtensions :: [Pragma]
26+ -- ^ Extensions enabled in that module
4127 }
4228
4329-- | Pretty-print a 'ParseResult'.
30+
4431prettyPrintParseResult :: ParseResult -> String
45−prettyPrintParseResult ParseResult {..} =
46− unlines
47− [ "parse result:",
48− " comment stream:",
49− showCommentStream prCommentStream
50− -- XXX extend as needed
51− ]
32+prettyPrintParseResult ParseResult {..} = unlines
33+ [ "parse result:"
34+ , " comment stream:"
35+ , showCommentStream prCommentStream
36+ -- XXX extend as needed
37+ ]
src/Ormolu/Parser/Shebang.hsdeleted−27
@@ -1,27 +0,0 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−
3−-- | A module for dealing with shebangs.
4−module Ormolu.Parser.Shebang
5− ( Shebang (..),
6− extractShebangs,
7− isShebang,
8− )
9−where
10−
11−import Data.Data (Data)
12−import qualified Data.List as L
13−import SrcLoc
14−
15−-- | A wrapper for a shebang.
16−newtype Shebang = Shebang (Located String)
17− deriving (Eq, Data)
18−
19−-- | Extract shebangs from the beginning of a comment stream.
20−extractShebangs :: [Located String] -> ([Shebang], [Located String])
21−extractShebangs comments = (Shebang <$> shebangs, rest)
22− where
23− (shebangs, rest) = span (isShebang . unLoc) comments
24−
25−-- | Return 'True' if given 'String' is a shebang.
26−isShebang :: String -> Bool
27−isShebang str = "#!" `L.isPrefixOf` str
src/Ormolu/Printer.hs+16−25
@@ -1,8 +1,11 @@
1−{-# LANGUAGE RecordWildCards #-}
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
24
35-- | Pretty-printer for Haskell AST.
6+
47module Ormolu.Printer
5− ( printModule,
8+ ( printModule
69 )
710where
811
@@ -11,28 +14,16 @@ import Ormolu.Parser.Result
1114import Ormolu.Printer.Combinators
1215import Ormolu.Printer.Meat.Module
1316import Ormolu.Printer.SpanStream
14−import Ormolu.Processing.Postprocess (postprocess)
1517
1618-- | Render a module.
17−printModule ::
18− -- | Result of parsing
19− ParseResult ->
20− -- | Resulting rendition
21− Text
22−printModule ParseResult {..} =
23− prLiteralPrefix <> region <> prLiteralSuffix
24− where
25− region =
26− postprocess prIndent $
27− runR
28− ( p_hsModule
29− prStackHeader
30− prShebangs
31− prPragmas
32− prImportQualifiedPost
33− prParsedSource
34− )
35− (mkSpanStream prParsedSource)
36− prCommentStream
37− prAnns
38− prUseRecordDot
19+
20+printModule
21+ :: Bool -- ^ Whether to trace debugging information
22+ -> ParseResult -- ^ Result of parsing
23+ -> Text -- ^ Resulting rendition
24+printModule debugOn ParseResult {..} =
25+ runR debugOn
26+ (p_hsModule prExtensions prParsedSource)
27+ (mkSpanStream prParsedSource)
28+ prCommentStream
29+ prAnns
src/Ormolu/Printer/Combinators.hs+174−165
@@ -1,113 +1,112 @@
1−{-# LANGUAGE FlexibleContexts #-}
2−{-# LANGUAGE GADTs #-}
3−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
42{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
54
65-- | Printing combinators. The definitions here are presented in such an
76-- order so you can just go through the Haddocks and by the end of the file
87-- you should have a pretty good idea how to program rendering logic.
8+
99module Ormolu.Printer.Combinators
1010 ( -- * The 'R' monad
11− R,
12− runR,
13− getAnns,
14− getEnclosingSpan,
15−
11+ R
12+ , runR
1613 -- * Combinators
17−
1814 -- ** Basic
19− txt,
20− atom,
21− space,
22− newline,
23− inci,
24− inciIf,
25− located,
26− located',
27− switchLayout,
28− Layout (..),
29− vlayout,
30− getLayout,
31− breakpoint,
32− breakpoint',
33−
15+ , txt
16+ , atom
17+ , newline
18+ , inci
19+ , located
20+ , located'
21+ , switchLayout
22+ , vlayout
23+ , breakpoint
24+ , breakpoint'
3425 -- ** Formatting lists
35− sep,
36− sepSemi,
37− canUseBraces,
38− useBraces,
39− dontUseBraces,
40−
26+ , sep
27+ , sepSemi
28+ , useBraces
29+ , dontUseBraces
4130 -- ** Wrapping
42− BracketStyle (..),
43− sitcc,
44− backticks,
45− banana,
46− braces,
47− brackets,
48− parens,
49− parensHash,
50− pragmaBraces,
51− pragma,
52−
31+ , sitcc
32+ , line
33+ , backticks
34+ , banana
35+ , braces
36+ , brackets
37+ , bracketsPar
38+ , parens
39+ , parensHash
40+ , pragmaBraces
41+ , pragma
5342 -- ** Literals
54− comma,
55− commaDel,
56− equals,
57−
58− -- ** Stateful markers
59− SpanMark (..),
60− spanMarkSpan,
61− HaddockStyle (..),
62− setSpanMark,
63− getSpanMark,
43+ , comma
44+ , space
6445 )
6546where
6647
6748import Control.Monad
49+import Data.Data (Data)
6850import Data.List (intersperse)
6951import Data.Text (Text)
7052import Ormolu.Printer.Comments
7153import Ormolu.Printer.Internal
54+import Ormolu.Utils (isModule, showOutputable)
55+import Outputable (Outputable)
7256import SrcLoc
57+import qualified Data.Text as T
7358
7459----------------------------------------------------------------------------
7560-- Basic
7661
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
62+-- | Output a fixed 'Text' fragment. The argument may not contain any line
63+-- breaks or tab characters. 'txt' is used to output all sorts of “fixed”
64+-- bits of syntax like keywords and pipes @|@ in functional dependencies.
65+
66+txt :: Text -> R ()
67+txt t = ensureIndent >> spit t
68+
69+-- | Output 'Outputable' fragment of AST. This can be used to output numeric
70+-- literals and similar. Everything that doesn't have inner structure but
71+-- does have an 'Outputable' instance.
72+
73+atom :: Outputable a => a -> R ()
74+atom = txt . T.pack . showOutputable
8575
8676-- | Enter a 'Located' entity. This combinator handles outputting comments
8777-- and sets layout (single-line vs multi-line) for the inner computation.
8878-- Roughly, the rule for using 'located' is that every time there is a
8979-- 'Located' wrapper, it should be “discharged” with a corresponding
9080-- 'located' invocation.
91−located ::
92− -- | Thing to enter
93− Located a ->
94− -- | How to render inner value
95− (a -> R ()) ->
96− R ()
97−located (L (UnhelpfulSpan _) a) f = f a
98−located (L (RealSrcSpan l) a) f = do
99− spitPrecedingComments l
100− withEnclosingSpan l $
101− switchLayout [RealSrcSpan l] (f a)
102− spitFollowingComments l
81+
82+located
83+ :: Data a
84+ => Located a -- ^ Thing to enter
85+ -> (a -> R ()) -- ^ How to render inner value
86+ -> R ()
87+located loc f = do
88+ let withRealLocated (L l a) g =
89+ case l of
90+ UnhelpfulSpan _ -> return ()
91+ RealSrcSpan l' -> g (L l' a)
92+ withRealLocated loc spitPrecedingComments
93+ let setEnclosingSpan =
94+ case getLoc loc of
95+ UnhelpfulSpan _ -> id
96+ RealSrcSpan orf ->
97+ if isModule (unLoc loc)
98+ then id
99+ else withEnclosingSpan orf
100+ setEnclosingSpan $ switchLayout [getLoc loc] (f (unLoc loc))
101+ withRealLocated loc spitFollowingComments
103102
104103-- | A version of 'located' with arguments flipped.
105−located' ::
106− -- | How to render inner value
107− (a -> R ()) ->
108− -- | Thing to enter
109− Located a ->
110− R ()
104+
105+located'
106+ :: Data a
107+ => (a -> R ()) -- ^ How to render inner value
108+ -> Located a -- ^ Thing to enter
109+ -> R ()
111110located' = flip located
112111
113112-- | Set layout according to combination of given 'SrcSpan's for a given.
@@ -116,19 +115,19 @@ located' = flip located
116115-- provided by GHC AST. It is relatively rare that this one is needed.
117116--
118117-- Given empty list this function will set layout to single line.
119−switchLayout ::
120− -- | Span that controls layout
121− [SrcSpan] ->
122− -- | Computation to run with changed layout
123− R () ->
124− R ()
118+
119+switchLayout
120+ :: [SrcSpan] -- ^ Span that controls layout
121+ -> R () -- ^ Computation to run with changed layout
122+ -> R ()
125123switchLayout spans' = enterLayout (spansLayout spans')
126124
127125-- | Which layout combined spans result in?
126+
128127spansLayout :: [SrcSpan] -> Layout
129128spansLayout = \case
130129 [] -> SingleLine
131− (x : xs) ->
130+ (x:xs) ->
132131 if isOneLineSpan (foldr combineSrcSpans x xs)
133132 then SingleLine
134133 else MultiLine
@@ -137,6 +136,7 @@ spansLayout = \case
137136-- multiline.
138137--
139138-- > breakpoint = vlayout space newline
139+
140140breakpoint :: R ()
141141breakpoint = vlayout space newline
142142
@@ -144,6 +144,7 @@ breakpoint = vlayout space newline
144144-- layout.
145145--
146146-- > breakpoint' = vlayout (return ()) newline
147+
147148breakpoint' :: R ()
148149breakpoint' = vlayout (return ()) newline
149150
@@ -151,14 +152,12 @@ breakpoint' = vlayout (return ()) newline
151152-- Formatting lists
152153
153154-- | Render a collection of elements inserting a separator between them.
154−sep ::
155− -- | Separator
156− R () ->
157− -- | How to render an element
158− (a -> R ()) ->
159− -- | Elements to render
160− [a] ->
161− R ()
155+
156+sep
157+ :: R () -- ^ Separator
158+ -> (a -> R ()) -- ^ How to render an element
159+ -> [a] -- ^ Elements to render
160+ -> R ()
162161sep s f xs = sequence_ (intersperse s (f <$> xs))
163162
164163-- | Render a collection of elements layout-sensitively using given printer,
@@ -170,12 +169,11 @@ sep s f xs = sequence_ (intersperse s (f <$> xs))
170169--
171170-- > dontUseBraces $ sepSemi txt ["foo", "bar"]
172171-- > == vlayout (txt "foo; bar") (txt "foo\nbar")
173−sepSemi ::
174− -- | How to render an element
175− (a -> R ()) ->
176− -- | Elements to render
177− [a] ->
178− R ()
172+
173+sepSemi
174+ :: (a -> R ()) -- ^ How to render an element
175+ -> [a] -- ^ Elements to render
176+ -> R ()
179177sepSemi f xs = vlayout singleLine multiLine
180178 where
181179 singleLine = do
@@ -184,28 +182,31 @@ sepSemi f xs = vlayout singleLine multiLine
184182 [] -> when ub $ txt "{}"
185183 xs' ->
186184 if ub
187− then do
188− txt "{"
189− space
190− sep (txt ";" >> space) (dontUseBraces . f) xs'
191− space
192− txt "}"
193− else sep (txt ";" >> space) f xs'
185+ then do
186+ txt "{ "
187+ sep (txt "; ") (dontUseBraces . f) xs'
188+ txt " }"
189+ else
190+ sep (txt "; ") f xs'
194191 multiLine =
195192 sep newline (dontUseBraces . f) xs
196193
197194----------------------------------------------------------------------------
198195-- Wrapping
199196
200−-- | 'BracketStyle' controlling how closing bracket is rendered.
201−data BracketStyle
202− = -- | Normal
203− N
204− | -- | Shifted one level
205− S
206− deriving (Eq, Show)
197+-- | Finish given entity by a 'newline'.
198+--
199+-- > line m = do
200+-- > m
201+-- > newline
202+
203+line :: R () -> R ()
204+line m = do
205+ m
206+ newline
207207
208208-- | Surround given entity by backticks.
209+
209210backticks :: R () -> R ()
210211backticks m = do
211212 txt "`"
@@ -213,86 +214,94 @@ backticks m = do
213214 txt "`"
214215
215216-- | Surround given entity by banana brackets (i.e., from arrow notation.)
217+
216218banana :: R () -> R ()
217−banana = brackets_ True "(|" "|)" N
219+banana m = sitcc $ do
220+ txt "(|"
221+ ospaces m
222+ txt "|)"
218223
219224-- | Surround given entity by curly braces @{@ and @}@.
220−braces :: BracketStyle -> R () -> R ()
221−braces = brackets_ False "{" "}"
225+
226+braces :: R () -> R ()
227+braces m = sitcc $ do
228+ txt "{"
229+ ospaces m
230+ txt "}"
222231
223232-- | Surround given entity by square brackets @[@ and @]@.
224−brackets :: BracketStyle -> R () -> R ()
225−brackets = brackets_ False "[" "]"
233+
234+brackets :: R () -> R ()
235+brackets m = sitcc $ do
236+ txt "["
237+ ospaces m
238+ txt "]"
239+
240+-- | Surround given entity by parallel array brackets @[:@ and @:]@.
241+
242+bracketsPar :: R () -> R ()
243+bracketsPar m = sitcc $ do
244+ txt "[: "
245+ m
246+ vlayout (return ()) space
247+ txt " :]"
226248
227249-- | Surround given entity by parentheses @(@ and @)@.
228−parens :: BracketStyle -> R () -> R ()
229−parens = brackets_ False "(" ")"
250+
251+parens :: R () -> R ()
252+parens m = sitcc $ do
253+ txt "("
254+ ospaces m
255+ txt ")"
230256
231257-- | Surround given entity by @(# @ and @ #)@.
232−parensHash :: BracketStyle -> R () -> R ()
233−parensHash = brackets_ True "(#" "#)"
258+
259+parensHash :: R () -> R ()
260+parensHash m = sitcc $ do
261+ txt "(# "
262+ m
263+ vlayout space (newline >> txt " ")
264+ txt "#)"
234265
235266-- | Braces as used for pragmas: @{-#@ and @#-}@.
267+
236268pragmaBraces :: R () -> R ()
237269pragmaBraces m = sitcc $ do
238− txt "{-#"
239− space
270+ txt "{-# "
240271 m
241− breakpoint
242− inci (txt "#-}")
272+ vlayout space (newline >> txt " ")
273+ txt "#-}"
243274
244275-- | Surround the body with a pragma name and 'pragmaBraces'.
245−pragma ::
246− -- | Pragma text
247− Text ->
248− -- | Pragma body
249− R () ->
250− R ()
276+
277+pragma
278+ :: Text -- ^ Pragma text
279+ -> R () -- ^ Pragma body
280+ -> R ()
251281pragma pragmaText body = pragmaBraces $ do
252282 txt pragmaText
253283 breakpoint
254284 body
255285
256−-- | A helper for defining wrappers like 'parens' and 'braces'.
257−brackets_ ::
258− -- | Insert breakpoints around brackets
259− Bool ->
260− -- | Opening bracket
261− Text ->
262− -- | Closing bracket
263− Text ->
264− -- | Bracket style
265− BracketStyle ->
266− -- | Inner expression
267− R () ->
268− R ()
269−brackets_ needBreaks open close style m = sitcc (vlayout singleLine multiLine)
270− where
271− singleLine = do
272− txt open
273− when needBreaks space
274− m
275− when needBreaks space
276− txt close
277− multiLine = do
278− txt open
279− if needBreaks
280− then newline >> inci m
281− else space >> sitcc m
282− newline
283− inciIf (style == S) (txt close)
286+-- | Surround given entity by optional space before and a newline after, iff
287+-- current layout is multiline.
288+
289+ospaces :: R () -> R ()
290+ospaces m = vlayout m $ do
291+ space
292+ sitcc m
293+ newline
294+ txt " "
284295
285296----------------------------------------------------------------------------
286297-- Literals
287298
288299-- | Print @,@.
300+
289301comma :: R ()
290302comma = txt ","
291303
292−-- | Delimiting combination with 'comma'. To be used with 'sep'.
293−commaDel :: R ()
294−commaDel = comma >> breakpoint
304+-- | Print single space.
295305
296−-- | Print @=@. Do not use @'txt' "="@.
297−equals :: R ()
298−equals = interferingTxt "="
306+space :: R ()
307+space = txt " "
src/Ormolu/Printer/Comments.hs+145−194
@@ -1,200 +1,179 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
33
44-- | Helpers for formatting of comments. This is low-level code, use
55-- "Ormolu.Printer.Combinators" unless you know what you are doing.
6+
67module Ormolu.Printer.Comments
7− ( spitPrecedingComments,
8− spitFollowingComments,
9− spitRemainingComments,
10− spitCommentNow,
11− spitCommentPending,
8+ ( spitPrecedingComments
9+ , spitFollowingComments
10+ , spitRemainingComments
11+ , hasMoreComments
1212 )
1313where
1414
1515import Control.Monad
16−import qualified Data.List.NonEmpty as NE
17−import Data.Maybe (listToMaybe)
18−import qualified Data.Text as T
16+import Data.Coerce (coerce)
17+import Data.Data (Data)
1918import Ormolu.Parser.CommentStream
2019import Ormolu.Printer.Internal
20+import Ormolu.Utils (isModule)
2121import SrcLoc
22+import qualified Data.List.NonEmpty as NE
23+import qualified Data.Text as T
2224
2325----------------------------------------------------------------------------
2426-- Top-level
2527
2628-- | Output all preceding comments for an element at given location.
27−spitPrecedingComments ::
28− -- | Span of the element to attach comments to
29− RealSrcSpan ->
30− R ()
31−spitPrecedingComments ref = do
32− gotSome <- handleCommentSeries (spitPrecedingComment ref)
33− when gotSome $ do
34− lastMark <- getSpanMark
35− -- Insert a blank line between the preceding comments and the thing
36− -- after them if there was a blank line in the input.
37− when (needsNewlineBefore ref lastMark) newline
29+
30+spitPrecedingComments
31+ :: Data a
32+ => RealLocated a -- ^ AST element to attach comments to
33+ -> R ()
34+spitPrecedingComments = handleCommentSeries . spitPrecedingComment
3835
3936-- | Output all comments following an element at given location.
40−spitFollowingComments ::
41− -- | Span of the element to attach comments to
42− RealSrcSpan ->
43− R ()
37+
38+spitFollowingComments
39+ :: Data a
40+ => RealLocated a -- ^ AST element of attach comments to
41+ -> R ()
4442spitFollowingComments ref = do
45− trimSpanStream ref
46− void $ handleCommentSeries (spitFollowingComment ref)
43+ trimSpanStream (getLoc ref)
44+ handleCommentSeries (spitFollowingComment ref)
4745
4846-- | Output all remaining comments in the comment stream.
47+
4948spitRemainingComments :: R ()
50−spitRemainingComments = do
51− -- Make sure we have a blank a line between the last definition and the
52− -- trailing comments.
53− newline
54− void $ handleCommentSeries spitRemainingComment
49+spitRemainingComments = handleCommentSeries spitRemainingComment
5550
5651----------------------------------------------------------------------------
5752-- Single-comment functions
5853
5954-- | Output a single preceding comment for an element at given location.
60−spitPrecedingComment ::
61− -- | Span of the element to attach comments to
62− RealSrcSpan ->
63− -- | Are we done?
64− R Bool
65−spitPrecedingComment ref = do
66− mlastMark <- getSpanMark
55+
56+spitPrecedingComment
57+ :: Data a
58+ => RealLocated a -- ^ AST element to attach comments to
59+ -> Maybe RealSrcSpan -- ^ Location of last comment in the series
60+ -> R (Maybe RealSrcSpan) -- ^ Location of this comment
61+spitPrecedingComment (L ref a) mlastSpn = do
6762 let p (L l _) = realSrcSpanEnd l <= realSrcSpanStart ref
6863 withPoppedComment p $ \l comment -> do
69− lineSpans <- thisLineSpans
70− let thisCommentLine = srcLocLine (realSrcSpanStart l)
71− needsNewline =
72− case listToMaybe lineSpans of
73− Nothing -> False
74− Just spn -> srcLocLine (realSrcSpanEnd spn) /= thisCommentLine
75− when (needsNewline || needsNewlineBefore l mlastMark) newline
76− spitCommentNow l comment
77− if theSameLinePre l ref
78− then space
64+ when (needsNewlineBefore l mlastSpn) newline
65+ spitComment comment
66+ if theSameLine l ref && not (isModule a)
67+ then spit " "
7968 else newline
8069
8170-- | Output a comment that follows element at given location immediately on
8271-- the same line, if there is any.
83−spitFollowingComment ::
84− -- | AST element to attach comments to
85− RealSrcSpan ->
86− -- | Are we done?
87− R Bool
88−spitFollowingComment ref = do
89− mlastMark <- getSpanMark
72+
73+spitFollowingComment
74+ :: Data a
75+ => RealLocated a -- ^ AST element to attach comments to
76+ -> Maybe RealSrcSpan -- ^ Location of last comment in the series
77+ -> R (Maybe RealSrcSpan) -- ^ Location of this comment
78+spitFollowingComment (L ref a) mlastSpn = do
9079 mnSpn <- nextEltSpan
91− -- Get first enclosing span that is not equal to reference span, i.e. it's
92− -- truly something enclosing the AST element.
93− meSpn <- getEnclosingSpan (/= ref)
94− withPoppedComment (commentFollowsElt ref mnSpn meSpn mlastMark) $ \l comment ->
95− if theSameLinePost l ref
96− then
97− if isMultilineComment comment
98− then space >> spitCommentNow l comment
99− else spitCommentPending OnTheSameLine l comment
100− else do
101− when (needsNewlineBefore l mlastMark) $
102− registerPendingCommentLine OnNextLine ""
103− spitCommentPending OnNextLine l comment
80+ meSpn <- getEnclosingSpan ref
81+ newlineModified <- isNewlineModified
82+ i <- getIndent
83+ withPoppedComment (commentFollowsElt ref mnSpn meSpn mlastSpn) $ \l comment ->
84+ if theSameLine l ref && not (isModule a)
85+ then modNewline $ \m -> setIndent i $ do
86+ if newlineModified
87+ then do
88+ -- This happens when we have several lines each with its own
89+ -- comment and they get merged by the formatter.
90+ m
91+ spitComment comment
92+ newline
93+ else do
94+ spit " "
95+ spitComment comment
96+ m
97+ else modNewline $ \m -> setIndent i $ do
98+ m
99+ when (needsNewlineBefore l mlastSpn) newline
100+ spitComment comment
101+ newline
104102
105103-- | Output a single remaining comment from the comment stream.
106−spitRemainingComment ::
107− -- | Are we done?
108− R Bool
109−spitRemainingComment = do
110− mlastMark <- getSpanMark
104+
105+spitRemainingComment
106+ :: Maybe RealSrcSpan -- ^ Location of last comment in the series
107+ -> R (Maybe RealSrcSpan) -- ^ Location of this comment
108+spitRemainingComment mlastSpn =
111109 withPoppedComment (const True) $ \l comment -> do
112− when (needsNewlineBefore l mlastMark) newline
113− spitCommentNow l comment
110+ when (needsNewlineBefore l mlastSpn) newline
111+ spitComment comment
114112 newline
115113
116114----------------------------------------------------------------------------
117115-- Helpers
118116
119117-- | Output series of comments.
120−handleCommentSeries ::
121− -- | Given location of previous comment, output the next comment
122− -- returning 'True' if we're done
123− R Bool ->
124− -- | Whether we printed any comments
125− R Bool
126−handleCommentSeries f = go False
118+
119+handleCommentSeries
120+ :: (Maybe RealSrcSpan -> R (Maybe RealSrcSpan))
121+ -- ^ Given location of previous comment, output the next comment
122+ -- returning its location, or 'Nothing' if we are done
123+ -> R ()
124+handleCommentSeries f = go Nothing
127125 where
128− go gotSome = do
129− done <- f
130− if done
131− then return gotSome
132− else go True
126+ go mlastSpn = do
127+ r <- f mlastSpn
128+ case r of
129+ Nothing -> return ()
130+ Just spn -> go (Just spn)
133131
134132-- | Try to pop a comment using given predicate and if there is a comment
135133-- matching the predicate, print it out.
136−withPoppedComment ::
137− -- | Comment predicate
138− (RealLocated Comment -> Bool) ->
139− -- | Printing function
140− (RealSrcSpan -> Comment -> R ()) ->
141− -- | Are we done?
142− R Bool
134+
135+withPoppedComment
136+ :: (RealLocated Comment -> Bool) -- ^ Comment predicate
137+ -> (RealSrcSpan -> Comment -> R ()) -- ^ Priting function
138+ -> R (Maybe RealSrcSpan)
143139withPoppedComment p f = do
144140 r <- popComment p
145141 case r of
146− Nothing -> return True
147− Just (L l comment) -> False <$ f l comment
142+ Nothing -> return Nothing
143+ Just (L l comment) -> Just l <$ f l comment
148144
149145-- | Determine if we need to insert a newline between current comment and
150146-- last printed comment.
151−needsNewlineBefore ::
152− -- | Current comment span
153− RealSrcSpan ->
154− -- | Last printed comment span
155− Maybe SpanMark ->
156− Bool
157−needsNewlineBefore _ (Just (HaddockSpan _ _)) = True
158−needsNewlineBefore l mlastMark =
159− case spanMarkSpan <$> mlastMark of
147+
148+needsNewlineBefore
149+ :: RealSrcSpan -- ^ Current comment span
150+ -> Maybe RealSrcSpan -- ^ Last printed comment span
151+ -> Bool
152+needsNewlineBefore l mlastSpn =
153+ case mlastSpn of
160154 Nothing -> False
161− Just lastMark ->
162− srcSpanStartLine l > srcSpanEndLine lastMark + 1
163−
164−-- | Is the preceding comment and AST element are on the same line?
165−theSameLinePre ::
166− -- | Current comment span
167− RealSrcSpan ->
168− -- | AST element location
169− RealSrcSpan ->
170− Bool
171−theSameLinePre l ref =
172− srcSpanEndLine l == srcSpanStartLine ref
155+ Just lastSpn ->
156+ srcSpanStartLine l > srcSpanEndLine lastSpn + 1
157+
158+-- | Is the comment and AST element are on the same line?
173159
174−-- | Is the following comment and AST element are on the same line?
175−theSameLinePost ::
176− -- | Current comment span
177− RealSrcSpan ->
178− -- | AST element location
179− RealSrcSpan ->
180− Bool
181−theSameLinePost l ref =
182− srcSpanStartLine l == srcSpanEndLine ref
160+theSameLine
161+ :: RealSrcSpan -- ^ Current comment span
162+ -> RealSrcSpan -- ^ AST element location
163+ -> Bool
164+theSameLine l ref =
165+ srcSpanEndLine l == srcSpanStartLine ref
183166
184167-- | Determine if given comment follows AST element.
185−commentFollowsElt ::
186− -- | Location of AST element
187− RealSrcSpan ->
188− -- | Location of next AST element
189− Maybe RealSrcSpan ->
190− -- | Location of enclosing AST element
191− Maybe RealSrcSpan ->
192− -- | Location of last comment in the series
193− Maybe SpanMark ->
194− -- | Comment to test
195− RealLocated Comment ->
196− Bool
197−commentFollowsElt ref mnSpn meSpn mlastMark (L l comment) =
168+
169+commentFollowsElt
170+ :: RealSrcSpan -- ^ Location of AST element
171+ -> Maybe RealSrcSpan -- ^ Location of next AST element
172+ -> Maybe RealSrcSpan -- ^ Location of enclosing AST element
173+ -> Maybe RealSrcSpan -- ^ Location of last comment in the series
174+ -> RealLocated Comment -- ^ Comment to test
175+ -> Bool
176+commentFollowsElt ref mnSpn meSpn mlastSpn (L l comment) =
198177 -- A comment follows a AST element if all 4 conditions are satisfied:
199178 goesAfter
200179 && logicallyFollows
@@ -205,10 +184,11 @@ commentFollowsElt ref mnSpn meSpn mlastMark (L l comment) =
205184 goesAfter =
206185 realSrcSpanStart l >= realSrcSpanEnd ref
207186 -- 2) The comment logically belongs to the element, four cases:
208− logicallyFollows =
209− theSameLinePost l ref -- a) it's on the same line
210− || continuation -- b) it's a continuation of a comment block
211− || lastInEnclosing -- c) it's the last element in the enclosing construct
187+ logicallyFollows
188+ = theSameLine l ref -- a) it's on the same line
189+ || isPrevHaddock comment -- b) it's a Haddock string starting with -- ^
190+ || continuation -- c) it's a continuation of a comment block
191+ || lastInEnclosing -- d) it's the last element in the enclosing construct
212192
213193 -- 3) There is no other AST element between this element and the comment:
214194 noEltBetween =
@@ -230,57 +210,28 @@ commentFollowsElt ref mnSpn meSpn mlastMark (L l comment) =
230210 Nothing -> True
231211 Just espn ->
232212 let startColumn = srcLocCol . realSrcSpanStart
233− in startColumn espn > startColumn ref
234− || ( abs (startColumn espn - startColumn l)
235− >= abs (startColumn ref - startColumn l)
236− )
213+ in if startColumn espn > startColumn ref
214+ then True
215+ else abs (startColumn espn - startColumn l)
216+ >= abs (startColumn ref - startColumn l)
237217 continuation =
238− -- A comment is a continuation when it doesn't have non-whitespace
239− -- lexemes in front of it and goes right after the previous comment.
240− not (hasAtomsBefore comment)
241− && ( case mlastMark of
242− Just (HaddockSpan _ _) -> False
243− Just (CommentSpan spn) ->
244− srcSpanEndLine spn + 1 == srcSpanStartLine l
245− _ -> False
246− )
218+ case mlastSpn of
219+ Nothing -> False
220+ Just spn -> srcSpanEndLine spn + 1 == srcSpanStartLine l
221+
247222 lastInEnclosing =
248− case meSpn of
249− -- When there is no enclosing element, return false
223+ case (,) <$> meSpn <*> mnSpn of
250224 Nothing -> False
251− -- When there is an enclosing element,
252− Just espn ->
253− let -- Make sure that the comment is inside the enclosing element
254− insideParent = realSrcSpanEnd l <= realSrcSpanEnd espn
255− -- And check if the next element is outside of the parent
256− nextOutsideParent = case mnSpn of
257− Nothing -> True
258− Just nspn -> realSrcSpanEnd espn < realSrcSpanStart nspn
259− in insideParent && nextOutsideParent
260−
261−-- | Output a 'Comment' immediately. This is a low-level printing function.
262−spitCommentNow :: RealSrcSpan -> Comment -> R ()
263−spitCommentNow spn comment = do
264− sitcc
265− . sequence_
266− . NE.intersperse newline
267− . fmap (txt . T.pack)
268− . unComment
269− $ comment
270− setSpanMark (CommentSpan spn)
271−
272−-- | Output a 'Comment' at the end of correct line or after it depending on
273−-- 'CommentPosition'. Used for comments that may potentially follow on the
274−-- same line as something we just rendered, but not immediately after it.
275−spitCommentPending :: CommentPosition -> RealSrcSpan -> Comment -> R ()
276−spitCommentPending position spn comment = do
277− let wrapper = case position of
278− OnTheSameLine -> sitcc
279− OnNextLine -> id
280− wrapper
281− . sequence_
282− . NE.toList
283− . fmap (registerPendingCommentLine position . T.pack)
284− . unComment
285− $ comment
286− setSpanMark (CommentSpan spn)
225+ Just (espn, nspn) ->
226+ -- Make sure that the comment is inside the parent
227+ realSrcSpanEnd l <= realSrcSpanEnd espn
228+ -- Check if the next element is outside of the parent
229+ && realSrcSpanEnd espn < realSrcSpanStart nspn
230+
231+-- | Output a 'Comment'. This is a low-level printing function.
232+
233+spitComment :: Comment -> R ()
234+spitComment =
235+ sitcc . sequence_ . NE.intersperse newline . fmap f . coerce
236+ where
237+ f x = ensureIndent >> spit (T.pack x)
src/Ormolu/Printer/Internal.hs+261−437
@@ -1,577 +1,401 @@
11{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE RankNTypes #-}
2+{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE RankNTypes #-}
55
66-- | In most cases import "Ormolu.Printer.Combinators" instead, these
77-- functions are the low-level building blocks and should not be used on
88-- their own. The 'R' monad is re-exported from "Ormolu.Printer.Combinators"
99-- as well.
10+
1011module Ormolu.Printer.Internal
1112 ( -- * The 'R' monad
12− R,
13− runR,
14−
13+ R
14+ , runR
1515 -- * Internal functions
16− txt,
17− interferingTxt,
18− atom,
19− space,
20− newline,
21− useRecordDot,
22− inci,
23− sitcc,
24− Layout (..),
25− enterLayout,
26− vlayout,
27− getLayout,
28−
16+ , spit
17+ , newline
18+ , modNewline
19+ , isNewlineModified
20+ , ensureIndent
21+ , inci
22+ , sitcc
23+ , Layout (..)
24+ , enterLayout
25+ , vlayout
2926 -- * Helpers for braces
30− useBraces,
31− dontUseBraces,
32− canUseBraces,
33−
27+ , useBraces
28+ , dontUseBraces
29+ , canUseBraces
3430 -- * Special helpers for comment placement
35− CommentPosition (..),
36− registerPendingCommentLine,
37− trimSpanStream,
38− nextEltSpan,
39− popComment,
40− getEnclosingSpan,
41− withEnclosingSpan,
42− thisLineSpans,
43−
44− -- * Stateful markers
45− SpanMark (..),
46− spanMarkSpan,
47− HaddockStyle (..),
48− setSpanMark,
49− getSpanMark,
50−
31+ , trimSpanStream
32+ , nextEltSpan
33+ , popComment
34+ , hasMoreComments
35+ , getIndent
36+ , setIndent
37+ , getEnclosingSpan
38+ , withEnclosingSpan
5139 -- * Annotations
52− getAnns,
40+ , getAnns
5341 )
5442where
5543
5644import Control.Monad.Reader
5745import Control.Monad.State.Strict
58−import Data.Bool (bool)
5946import Data.Coerce
60−import Data.Maybe (listToMaybe)
47+import Data.Maybe (fromMaybe, isJust, listToMaybe)
6148import Data.Text (Text)
62−import qualified Data.Text as T
63−import qualified Data.Text.Lazy as TL
6449import Data.Text.Lazy.Builder
50+import Debug.Trace
6551import GHC
6652import Ormolu.Parser.Anns
6753import Ormolu.Parser.CommentStream
6854import Ormolu.Printer.SpanStream
69−import Ormolu.Utils (showOutputable)
70−import Outputable (Outputable)
55+import SrcLoc
56+import qualified Data.Text as T
57+import qualified Data.Text.Lazy as TL
7158
7259----------------------------------------------------------------------------
7360-- The 'R' monad
7461
7562-- | The 'R' monad hosts combinators that allow us to describe how to render
7663-- AST.
64+
7765newtype R a = R (ReaderT RC (State SC) a)
7866 deriving (Functor, Applicative, Monad)
7967
80−-- | Reader context of 'R'. This should be used when we control rendering by
81−-- enclosing certain expressions with wrappers.
68+-- | Reader context of 'R'.
69+
8270data RC = RC
83− { -- | Indentation level, as the column index we need to start from after
84− -- a newline if we break lines
85− rcIndent :: !Int,
86− -- | Current layout
87− rcLayout :: Layout,
88− -- | Spans of enclosing elements of AST
89− rcEnclosingSpans :: [RealSrcSpan],
90− -- | Collection of annotations
91− rcAnns :: Anns,
92− -- | Whether the last expression in the layout can use braces
93− rcCanUseBraces :: Bool,
94− -- | Whether the source could have used the record dot preprocessor
95− rcUseRecDot :: Bool
71+ { rcIndent :: !Int
72+ -- ^ Indentation level, as the column index we need to start from after a
73+ -- newline if we break lines
74+ , rcLayout :: Layout
75+ -- ^ Current layout
76+ , rcDebug :: Bool
77+ -- ^ Whether to print debugging info as we go
78+ , rcEnclosingSpans :: [RealSrcSpan]
79+ -- ^ Span of enclosing element of AST
80+ , rcAnns :: Anns
81+ -- ^ Collection of annotations
82+ , rcCanUseBraces :: Bool
83+ -- ^ If the last expression in the layout can use braces
9684 }
9785
9886-- | State context of 'R'.
87+
9988data SC = SC
100− { -- | Index of the next column to render
101− scColumn :: !Int,
102− -- | Indentation level that was used for the current line
103− scIndent :: !Int,
104− -- | Rendered source code so far
105− scBuilder :: Builder,
106− -- | Span stream
107− scSpanStream :: SpanStream,
108− -- | Spans of atoms that have been printed on the current line so far
109− scThisLineSpans :: [RealSrcSpan],
110− -- | Comment stream
111− scCommentStream :: CommentStream,
112− -- | Pending comment lines (in reverse order) to be inserted before next
113− -- newline, 'Int' is the indentation level
114− scPendingComments :: ![(CommentPosition, Text)],
115− -- | Whether to output a space before the next output
116− scRequestedDelimiter :: !RequestedDelimiter,
117− -- | An auxiliary marker for keeping track of last output element
118− scSpanMark :: !(Maybe SpanMark)
89+ { scColumn :: !Int
90+ -- ^ Index of the next column to render
91+ , scBuilder :: Builder
92+ -- ^ Rendered source code so far
93+ , scSpanStream :: SpanStream
94+ -- ^ Span stream
95+ , scCommentStream :: CommentStream
96+ -- ^ Comment stream
97+ , scNewline :: Maybe (R ())
98+ -- ^ What to render as newline, or 'Nothing' ('newlineRaw' will be used)
11999 }
120100
121−-- | Make sure next output is delimited by one of the following.
122−data RequestedDelimiter
123− = -- | A space
124− RequestedSpace
125− | -- | A newline
126− RequestedNewline
127− | -- | Nothing
128− RequestedNothing
129− | -- | We just output a newline
130− AfterNewline
131− | -- | We haven't printed anything yet
132− VeryBeginning
133− deriving (Eq, Show)
134−
135101-- | 'Layout' options.
136−data Layout
137− = -- | Put everything on single line
138− SingleLine
139− | -- | Use multiple lines
140− MultiLine
141− deriving (Eq, Show)
142102
143−-- | Modes for rendering of pending comments.
144−data CommentPosition
145− = -- | Put the comment on the same line
146− OnTheSameLine
147− | -- | Put the comment on next line
148− OnNextLine
103+data Layout
104+ = SingleLine -- ^ Put everything on single line
105+ | MultiLine -- ^ Use multiple lines
149106 deriving (Eq, Show)
150107
151108-- | Run an 'R' monad.
152−runR ::
153− -- | Monad to run
154− R () ->
155− -- | Span stream
156− SpanStream ->
157− -- | Comment stream
158− CommentStream ->
159− -- | Annotations
160− Anns ->
161− -- | Use Record Dot Syntax
162− Bool ->
163− -- | Resulting rendition
164− Text
165−runR (R m) sstream cstream anns recDot =
109+
110+runR
111+ :: Bool -- ^ Whether to print debugging info
112+ -> R () -- ^ Monad to run
113+ -> SpanStream -- ^ Span stream
114+ -> CommentStream -- ^ Comment stream
115+ -> Anns -- ^ Annotations
116+ -> Text -- ^ Resulting rendition
117+runR debug (R m) sstream cstream anns =
166118 TL.toStrict . toLazyText . scBuilder $ execState (runReaderT m rc) sc
167119 where
168− rc =
169− RC
170− { rcIndent = 0,
171− rcLayout = MultiLine,
172− rcEnclosingSpans = [],
173− rcAnns = anns,
174− rcCanUseBraces = False,
175− rcUseRecDot = recDot
176− }
177− sc =
178− SC
179− { scColumn = 0,
180− scIndent = 0,
181− scBuilder = mempty,
182− scSpanStream = sstream,
183− scThisLineSpans = [],
184− scCommentStream = cstream,
185− scPendingComments = [],
186− scRequestedDelimiter = VeryBeginning,
187− scSpanMark = Nothing
188− }
120+ rc = RC
121+ { rcIndent = 0
122+ , rcLayout = MultiLine
123+ , rcDebug = debug
124+ , rcEnclosingSpans = []
125+ , rcAnns = anns
126+ , rcCanUseBraces = False
127+ }
128+ sc = SC
129+ { scColumn = 0
130+ , scBuilder = mempty
131+ , scSpanStream = sstream
132+ , scCommentStream = cstream
133+ , scNewline = Nothing
134+ }
189135
190136----------------------------------------------------------------------------
191137-- Internal functions
192138
193−-- | Type of the thing to output. Influences the primary low-level rendering
194−-- function 'spit'.
195−data SpitType
196− = -- | Simple opaque text that breaks comment series.
197− SimpleText
198− | -- | Like 'SimpleText', but assume that when this text is inserted it
199− -- will separate an 'Atom' and its pending comments, so insert an extra
200− -- 'newline' in that case to force the pending comments and continue on
201− -- a fresh line.
202− InterferingText
203− | -- | An atom that typically have span information in the AST and can
204− -- have comments attached to it.
205− Atom
206− | -- | Used for rendering comment lines.
207− CommentPart
208− deriving (Show, Eq)
209−
210−-- | Output a fixed 'Text' fragment. The argument may not contain any line
211−-- breaks. 'txt' is used to output all sorts of “fixed” bits of syntax like
212−-- keywords and pipes @|@ in functional dependencies.
213−--
214−-- To separate various bits of syntax with white space use 'space' instead
215−-- of @'txt' " "@. To output 'Outputable' Haskell entities like numbers use
216−-- 'atom'.
217−txt ::
218− -- | 'Text' to output
219− Text ->
220− R ()
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
230−
231−-- | Output 'Outputable' fragment of AST. This can be used to output numeric
232−-- literals and similar. Everything that doesn't have inner structure but
233−-- does have an 'Outputable' instance.
234−atom ::
235− Outputable a =>
236− a ->
237− R ()
238−atom = spit Atom . T.pack . showOutputable
239−
240−-- | Low-level non-public helper to define 'txt' and 'atom'.
241−spit ::
242− -- | Type of the thing to spit
243− SpitType ->
244− -- | 'Text' to output
245− Text ->
246− R ()
247−spit _ "" = return ()
248−spit stype text = do
249− requestedDel <- R (gets scRequestedDelimiter)
250− pendingComments <- R (gets scPendingComments)
251− when (stype == InterferingText && not (null pendingComments)) newline
252− case requestedDel of
253− RequestedNewline -> do
254− R . modify $ \sc ->
255− sc
256− { scRequestedDelimiter = RequestedNothing
257− }
258− case stype of
259− CommentPart -> newlineRaw
260− _ -> newline
261− _ -> return ()
262− R $ do
263− i <- asks rcIndent
264− c <- gets scColumn
265− closestEnclosing <- listToMaybe <$> asks rcEnclosingSpans
266− let indentedTxt = spaces <> text
267− spaces = T.replicate spacesN " "
268− spacesN =
269− if c == 0
270− then i
271− else bool 0 1 (requestedDel == RequestedSpace)
272− modify $ \sc ->
273− sc
274− { scBuilder = scBuilder sc <> fromText indentedTxt,
275− scColumn = scColumn sc + T.length indentedTxt,
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,
287− scRequestedDelimiter = RequestedNothing,
288− scSpanMark =
289− -- If there are pending comments, do not reset last comment
290− -- location.
291− if (stype == CommentPart) || (not . null . scPendingComments) sc
292− then scSpanMark sc
293− else Nothing
294− }
139+-- | Grow current output by appending given 'Text' to it, which may not
140+-- contain newlines.
295141
296−-- | This primitive /does not/ necessarily output a space. It just ensures
297−-- that the next thing that will be printed on the same line will be
298−-- separated by a single space from the previous output. Using this
299−-- combinator twice results in at most one space.
300−--
301−-- In practice this design prevents trailing white space and makes it hard
302−-- to output more than one delimiting space in a row, which is what we
303−-- usually want.
304−space :: R ()
305−space = R . modify $ \sc ->
306− sc
307− { scRequestedDelimiter = case scRequestedDelimiter sc of
308− RequestedNothing -> RequestedSpace
309− other -> other
142+spit :: Text -> R ()
143+spit x = do
144+ traceR "spit_before" (Just x)
145+ R . modify $ \sc -> sc
146+ { scBuilder = scBuilder sc <> fromText x
147+ , scColumn = scColumn sc + T.length x
310148 }
149+ traceR "spit_after" Nothing
150+
151+-- | Output a newline.
311152
312−-- | Output a newline. First time 'newline' is used after some non-'newline'
313−-- output it gets inserted immediately. Second use of 'newline' does not
314−-- output anything but makes sure that the next non-white space output will
315−-- be prefixed by a newline. Using 'newline' more than twice in a row has no
316−-- effect. Also, using 'newline' at the very beginning has no effect, this
317−-- is to avoid leading whitespace.
318−--
319−-- Similarly to 'space', this design prevents trailing newlines and makes it
320−-- hard to output more than one blank newline in a row.
321153newline :: R ()
322154newline = do
323− indent <- R (gets scIndent)
324− cs <- reverse <$> R (gets scPendingComments)
325− case cs of
326− [] -> newlineRaw
327− ((position, _) : _) -> do
328− case position of
329− OnTheSameLine -> space
330− OnNextLine -> newlineRaw
331− R . forM_ cs $ \(_, text) ->
332− let modRC rc =
333− rc
334− { rcIndent = indent
335− }
336− R m = do
337− unless (T.null text) $
338− spit CommentPart text
339− newlineRaw
340− in local modRC m
341− R . modify $ \sc ->
342− sc
343− { scPendingComments = []
344− }
155+ n <- R (gets scNewline)
156+ R . modify $ \sc -> sc
157+ { scNewline = Nothing
158+ }
159+ fromMaybe newlineRaw n
345160
346161-- | Low-level newline primitive. This one always just inserts a newline, no
347162-- hooks can be attached.
163+
348164newlineRaw :: R ()
349−newlineRaw = R . modify $ \sc ->
350− let requestedDel = scRequestedDelimiter sc
351− builderSoFar = scBuilder sc
352− in sc
353− { scBuilder = case requestedDel of
354− AfterNewline -> builderSoFar
355− RequestedNewline -> builderSoFar
356− VeryBeginning -> builderSoFar
357− _ -> builderSoFar <> "\n",
358− scColumn = 0,
359− scIndent = 0,
360− scThisLineSpans = [],
361− scRequestedDelimiter = case scRequestedDelimiter sc of
362− AfterNewline -> RequestedNewline
363− RequestedNewline -> RequestedNewline
364− VeryBeginning -> VeryBeginning
365− _ -> AfterNewline
366− }
165+newlineRaw = do
166+ traceR "newline_before" (Just "\n")
167+ R . modify $ \sc -> sc
168+ { scBuilder = scBuilder sc <> "\n"
169+ , scColumn = 0
170+ }
171+ traceR "newline_after" Nothing
367172
368−-- | Return 'True' if we should print record dot syntax.
369−useRecordDot :: R Bool
370−useRecordDot = R (asks rcUseRecDot)
173+-- | The 'modNewline' function can be used to alter what will be inserted as
174+-- a newline. This is used to output comments following an element of AST
175+-- because we cannot output comments immediately, e.g. because we need to
176+-- close parentheses first, etc.
177+--
178+-- 'newline' auto-resets its modifications so the changes introduced with
179+-- 'modNewline' only have effect once.
180+--
181+-- The argument of the call-back is the version of 'newline' built so far.
182+
183+modNewline :: (R () -> R ()) -> R ()
184+modNewline f = R $ do
185+ old <- gets scNewline
186+ modify $ \sc -> sc
187+ { scNewline = Just $ f (fromMaybe newlineRaw old)
188+ }
189+
190+-- | Check if newline is in modified state.
191+
192+isNewlineModified :: R Bool
193+isNewlineModified = isJust <$> R (gets scNewline)
194+
195+-- | Ensure that indentation level is satisfied. Insert correct number of
196+-- spaces if it isn't.
197+
198+ensureIndent :: R ()
199+ensureIndent = do
200+ traceR "ensure_indent" Nothing
201+ i <- R (asks rcIndent)
202+ c <- R (gets scColumn)
203+ when (c < i) $
204+ spit (T.replicate (i - c) " ")
371205
372206-- | Increase indentation level by one indentation step for the inner
373207-- computation. 'inci' should be used when a part of code must be more
374208-- indented relative to the parts outside of 'inci' in order for the output
375209-- to be valid Haskell. When layout is single-line there is no obvious
376210-- effect, but with multi-line layout correct indentation levels matter.
211+
377212inci :: R () -> R ()
378−inci (R m) = R (local modRC m)
379− where
380− modRC rc =
381− rc
213+inci m' = do
214+ traceR "inci_before" Nothing
215+ let R m = traceR "inci_inside" Nothing >> m'
216+ modRC rc = rc
382217 { rcIndent = rcIndent rc + indentStep
383218 }
219+ R (local modRC m)
220+ traceR "inci_ended" Nothing
384221
385222-- | Set indentation level for the inner computation equal to current
386223-- column. This makes sure that the entire inner block is uniformly
387−-- \"shifted\" to the right.
224+-- \"shifted\" to the right. Only works (and makes sense) when enclosing
225+-- layout is multi-line.
226+
388227sitcc :: R () -> R ()
389−sitcc (R m) = do
390− requestedDel <- R (gets scRequestedDelimiter)
228+sitcc m' = do
229+ traceR "sitcc_before" Nothing
391230 i <- R (asks rcIndent)
392231 c <- R (gets scColumn)
393− let modRC rc =
394− rc
395− { rcIndent = max i (c + bool 0 1 (requestedDel == RequestedSpace))
396− }
397− R (local modRC m)
232+ let R m = traceR "sitcc_inside" Nothing >> m'
233+ modRC rc = rc
234+ { rcIndent = max i c
235+ }
236+ vlayout m' (R (local modRC m))
237+ traceR "sitcc_ended" Nothing
398238
399239-- | Set 'Layout' for internal computation.
240+
400241enterLayout :: Layout -> R () -> R ()
401−enterLayout l (R m) = R (local modRC m)
402− where
403− modRC rc =
404− rc
242+enterLayout l (R m) = do
243+ let label =
244+ case l of
245+ SingleLine -> "single_line"
246+ MultiLine -> "multi_line"
247+ traceR ("lstart_" ++ label) Nothing
248+ let modRC rc = rc
405249 { rcLayout = l
406250 }
251+ x <- R (local modRC m)
252+ traceR ("lend_" ++ label) Nothing
253+ return x
407254
408255-- | Do one or another thing depending on current 'Layout'.
409−vlayout ::
410− -- | Single line
411− R a ->
412− -- | Multi line
413− R a ->
414− R a
256+
257+vlayout
258+ :: R a -- ^ Single line
259+ -> R a -- ^ Multi line
260+ -> R a
415261vlayout sline mline = do
416− l <- getLayout
262+ l <- R (asks rcLayout)
417263 case l of
418264 SingleLine -> sline
419265 MultiLine -> mline
420266
421−-- | Get current 'Layout'.
422−getLayout :: R Layout
423−getLayout = R (asks rcLayout)
424−
425267----------------------------------------------------------------------------
426268-- Special helpers for comment placement
427269
428−-- | Register a comment line for outputting. It will be inserted right
429−-- before next newline. When the comment goes after something else on the
430−-- same line, a space will be inserted between preceding text and the
431−-- comment when necessary.
432−registerPendingCommentLine ::
433− -- | Comment position
434− CommentPosition ->
435− -- | 'Text' to output
436− Text ->
437− R ()
438−registerPendingCommentLine position text = R $ do
439− modify $ \sc ->
440− sc
441− { scPendingComments = (position, text) : scPendingComments sc
442− }
443−
444270-- | Drop elements that begin before or at the same place as given
445271-- 'SrcSpan'.
446−trimSpanStream ::
447− -- | Reference span
448− RealSrcSpan ->
449− R ()
272+
273+trimSpanStream
274+ :: RealSrcSpan -- ^ Reference span
275+ -> R ()
450276trimSpanStream ref = do
451277 let leRef :: RealSrcSpan -> Bool
452278 leRef x = realSrcSpanStart x <= realSrcSpanStart ref
453− R . modify $ \sc ->
454− sc
455− { scSpanStream = coerce (dropWhile leRef) (scSpanStream sc)
456− }
279+ R . modify $ \sc -> sc
280+ { scSpanStream = coerce (dropWhile leRef) (scSpanStream sc)
281+ }
457282
458283-- | Get location of next element in AST.
284+
459285nextEltSpan :: R (Maybe RealSrcSpan)
460286nextEltSpan = listToMaybe . coerce <$> R (gets scSpanStream)
461287
462288-- | Pop a 'Comment' from the 'CommentStream' if given predicate is
463289-- satisfied and there are comments in the stream.
464−popComment ::
465− (RealLocated Comment -> Bool) ->
466− R (Maybe (RealLocated Comment))
290+
291+popComment
292+ :: (RealLocated Comment -> Bool)
293+ -> R (Maybe (RealLocated Comment))
467294popComment f = R $ do
468295 CommentStream cstream <- gets scCommentStream
469296 case cstream of
470297 [] -> return Nothing
471− (x : xs) ->
298+ (x:xs) ->
472299 if f x
473− then
474− Just x
475− <$ modify
476− ( \sc ->
477− sc
478− { scCommentStream = CommentStream xs
479− }
480− )
300+ then Just x <$ modify (\sc -> sc
301+ { scCommentStream = CommentStream xs
302+ })
481303 else return Nothing
482304
483−-- | Get the first enclosing 'RealSrcSpan' that satisfies given predicate.
484−getEnclosingSpan ::
485− -- | Predicate to use
486− (RealSrcSpan -> Bool) ->
487− R (Maybe RealSrcSpan)
488−getEnclosingSpan f =
489− listToMaybe . filter f <$> R (asks rcEnclosingSpans)
305+-- | Return 'True' if there are more comments in the 'CommentStream'.
490306
491−-- | Set 'RealSrcSpan' of enclosing span for the given computation.
492−withEnclosingSpan :: RealSrcSpan -> R () -> R ()
493−withEnclosingSpan spn (R m) = R (local modRC m)
494− where
495− modRC rc =
496− rc
497− { rcEnclosingSpans = spn : rcEnclosingSpans rc
307+hasMoreComments :: R Bool
308+hasMoreComments = R $ do
309+ CommentStream cstream <- gets scCommentStream
310+ (return . not . null) cstream
311+
312+-- | Current indentation level.
313+
314+getIndent :: R Int
315+getIndent = R (asks rcIndent)
316+
317+-- | Set indentation level for the given computation.
318+
319+setIndent :: Int -> R () -> R ()
320+setIndent i m' = do
321+ traceR "set_indent_before" Nothing
322+ let R m = traceR "set_indent_inside" Nothing >> m'
323+ modRC rc = rc
324+ { rcIndent = i
498325 }
326+ R (local modRC m)
327+ traceR "set_indent_after" Nothing
499328
500−-- | Get spans on this line so far.
501−thisLineSpans :: R [RealSrcSpan]
502−thisLineSpans = R (gets scThisLineSpans)
329+-- | Get 'RealSrcSpan' of enclosing span for given referencne span.
503330
504−----------------------------------------------------------------------------
505−-- Stateful markers
506−
507−-- | An auxiliary marker for keeping track of last output element.
508−data SpanMark
509− = -- | Haddock comment
510− HaddockSpan HaddockStyle RealSrcSpan
511− | -- | Non-haddock comment
512− CommentSpan RealSrcSpan
513− | -- | A statement in a do-block and such span
514− StatementSpan RealSrcSpan
515−
516−-- | Project 'RealSrcSpan' from 'SpanMark'.
517−spanMarkSpan :: SpanMark -> RealSrcSpan
518−spanMarkSpan = \case
519− HaddockSpan _ s -> s
520− CommentSpan s -> s
521− StatementSpan s -> s
522−
523−-- | Haddock string style.
524−data HaddockStyle
525− = -- | @-- |@
526− Pipe
527− | -- | @-- ^@
528− Caret
529− | -- | @-- *@
530− Asterisk Int
531− | -- | @-- $@
532− Named String
533−
534−-- | Set span of last output comment.
535−setSpanMark ::
536− -- | Span mark to set
537− SpanMark ->
538− R ()
539−setSpanMark spnMark = R . modify $ \sc ->
540− sc
541− { scSpanMark = Just spnMark
542− }
331+getEnclosingSpan :: RealSrcSpan -> R (Maybe RealSrcSpan)
332+getEnclosingSpan r =
333+ listToMaybe . dropWhile (== r) <$> R (asks rcEnclosingSpans)
543334
544−-- | Get span of last output comment.
545−getSpanMark :: R (Maybe SpanMark)
546−getSpanMark = R (gets scSpanMark)
335+-- | Set 'RealSrcSpan' of enclosing span for the given computation.
336+
337+withEnclosingSpan :: RealSrcSpan -> R () -> R ()
338+withEnclosingSpan spn (R m) = do
339+ let modRC rc = rc
340+ { rcEnclosingSpans = spn : rcEnclosingSpans rc
341+ }
342+ R (local modRC m)
547343
548344----------------------------------------------------------------------------
549345-- Annotations
550346
551347-- | For a given span return 'AnnKeywordId's associated with it.
552−getAnns ::
553− SrcSpan ->
554− R [AnnKeywordId]
348+
349+getAnns
350+ :: SrcSpan
351+ -> R [AnnKeywordId]
555352getAnns spn = lookupAnns spn <$> R (asks rcAnns)
556353
557354----------------------------------------------------------------------------
558355-- Helpers for braces
559356
560357-- | Make the inner computation use braces around single-line layouts.
358+
561359useBraces :: R () -> R ()
562−useBraces (R r) = R (local (\i -> i {rcCanUseBraces = True}) r)
360+useBraces (R r) = R (local (\i -> i {rcCanUseBraces = True}) r)
563361
564362-- | Make the inner computation omit braces around single-line layouts.
363+
565364dontUseBraces :: R () -> R ()
566−dontUseBraces (R r) = R (local (\i -> i {rcCanUseBraces = False}) r)
365+dontUseBraces (R r) = R (local (\i -> i {rcCanUseBraces = False}) r)
567366
568367-- | Return 'True' if we can use braces in this context.
368+
569369canUseBraces :: R Bool
570−canUseBraces = R (asks rcCanUseBraces)
370+canUseBraces = R $ asks rcCanUseBraces
371+
372+----------------------------------------------------------------------------
373+-- Debug helpers
374+
375+-- | Tracing helper.
376+
377+traceR
378+ :: String -- ^ Label
379+ -> Maybe Text -- ^ Output, if any
380+ -> R ()
381+traceR label moutput = R $ do
382+ debug <- asks rcDebug
383+ i <- asks rcIndent
384+ c <- gets scColumn
385+ when debug . traceM . concat $
386+ [ replicate i ' '
387+ , unwords [ label ++ ":"
388+ , "i=" ++ show i
389+ , "c=" ++ show c
390+ ]
391+ ] ++ case moutput of
392+ Nothing -> []
393+ Just output -> [" out=" ++ show output]
571394
572395----------------------------------------------------------------------------
573396-- Constants
574397
575398-- | Indentation step.
399+
576400indentStep :: Int
577401indentStep = 2
src/Ormolu/Printer/Meat/Common.hs+45−91
@@ -1,55 +1,51 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
33
44-- | Rendering of commonly useful bits.
5+
56module Ormolu.Printer.Meat.Common
6− ( FamilyStyle (..),
7− p_hsmodName,
8− p_ieWrappedName,
9− p_rdrName,
10− doesNotNeedExtraParens,
11− p_qualName,
12− p_infixDefHelper,
13− p_hsDocString,
14− p_hsDocName,
7+ ( FamilyStyle (..)
8+ , p_hsmodName
9+ , p_ieWrappedName
10+ , p_rdrName
11+ , doesNotNeedExtraParens
12+ , p_qualName
13+ , p_infixDefHelper
1514 )
1615where
1716
1817import Control.Monad
1918import Data.List (isPrefixOf)
20−import qualified Data.Text as T
2119import GHC hiding (GhcPs, IE)
2220import Name (nameStableString)
2321import OccName (OccName (..))
2422import Ormolu.Printer.Combinators
25−import Ormolu.Utils
23+import Ormolu.Printer.Internal (getAnns)
24+import RdrName (RdrName (..))
2625
2726-- | Data and type family style.
27+
2828data FamilyStyle
29− = -- | Declarations in type classes
30− Associated
31− | -- | Top-level declarations
32− Free
29+ = Associated -- ^ Declarations in type classes
30+ | Free -- ^ Top-level declarations
3331
3432p_hsmodName :: ModuleName -> R ()
3533p_hsmodName mname = do
36− txt "module"
37− space
34+ txt "module "
3835 atom mname
3936
4037p_ieWrappedName :: IEWrappedName RdrName -> R ()
4138p_ieWrappedName = \case
4239 IEName x -> p_rdrName x
4340 IEPattern x -> do
44− txt "pattern"
45− space
41+ txt "pattern "
4642 p_rdrName x
4743 IEType x -> do
48− txt "type"
49− space
44+ txt "type "
5045 p_rdrName x
5146
5247-- | Render a @'Located' 'RdrName'@.
48+
5349p_rdrName :: Located RdrName -> R ()
5450p_rdrName l@(L spn _) = located l $ \x -> do
5551 ids <- getAnns spn
@@ -59,14 +55,14 @@ p_rdrName l@(L spn _) = located l $ \x -> do
5955 else id
6056 parensWrapper =
6157 if AnnOpenP `elem` ids
62− then parens N
58+ then parens
6359 else id
6460 singleQuoteWrapper =
6561 if AnnSimpleQuote `elem` ids
6662 then \y -> do
67− txt "'"
68− y
69− else id
63+ txt "'"
64+ y
65+ else id
7066 m =
7167 case x of
7268 Unqual occName ->
@@ -74,10 +70,10 @@ p_rdrName l@(L spn _) = located l $ \x -> do
7470 Qual mname occName ->
7571 p_qualName mname occName
7672 Orig _ occName ->
77− -- This is used when GHC generates code that will be fed into
78− -- the renamer (e.g. from deriving clauses), but where we want
79− -- to say that something comes from given module which is not
80− -- specified in the source code, e.g. @Prelude.map@.
73+ -- NOTE This is used when GHC generates code that will be fed
74+ -- into the renamer (e.g. from deriving clauses), but where we
75+ -- want to say that something comes from given module which is
76+ -- not specified in the source code, e.g. @Prelude.map@.
8177 --
8278 -- My current understanding is that the provided module name
8379 -- serves no purpose for us and can be safely ignored.
@@ -93,15 +89,16 @@ p_rdrName l@(L spn _) = located l $ \x -> do
9389-- to detect e.g. tuples for which annotations will indicate parentheses,
9490-- but the parentheses are already part of the symbol, so no extra layer of
9591-- parentheses should be added. It also detects the [] literal.
92+
9693doesNotNeedExtraParens :: RdrName -> Bool
9794doesNotNeedExtraParens = \case
9895 Exact name ->
9996 let s = nameStableString name
100− in -- I'm not sure this "stable string" is stable enough, but it looks
101− -- like this is the most robust way to tell if we're looking at
102− -- exactly this piece of built-in syntax.
103− ("$ghc-prim$GHC.Tuple$" `isPrefixOf` s)
104− || ("$ghc-prim$GHC.Types$[]" `isPrefixOf` s)
97+ -- NOTE I'm not sure this "stable string" is stable enough, but it looks
98+ -- like this is the most robust way to tell if we're looking at exactly
99+ -- this piece of built-in syntax.
100+ in ("$ghc-prim$GHC.Tuple$" `isPrefixOf` s) ||
101+ ("$ghc-prim$GHC.Types$[]" `isPrefixOf` s)
105102 _ -> False
106103
107104p_qualName :: ModuleName -> OccName -> R ()
@@ -111,75 +108,32 @@ p_qualName mname occName = do
111108 atom occName
112109
113110-- | A helper for formatting infix constructions in lhs of definitions.
114−p_infixDefHelper ::
115− -- | Whether to format in infix style
116− Bool ->
117− -- | Whether to bump indentation for arguments
118− Bool ->
119− -- | How to print the operator\/name
120− R () ->
121− -- | How to print the arguments
122− [R ()] ->
123− R ()
124−p_infixDefHelper isInfix indentArgs name args =
111+
112+p_infixDefHelper
113+ :: Bool -- ^ Whether to format in infix style
114+ -> (R () -> R ()) -- ^ Indentation-bumping wrapper
115+ -> R () -- ^ How to print the operator\/name
116+ -> [R ()] -- ^ How to print the arguments
117+ -> R ()
118+p_infixDefHelper isInfix inci' name args =
125119 case (isInfix, args) of
126− (True, p0 : p1 : ps) -> do
120+ (True, p0:p1:ps) -> do
127121 let parens' =
128122 if null ps
129123 then id
130− else parens N
124+ else parens
131125 parens' $ do
132126 p0
133127 breakpoint
134− inci . sitcc $ do
128+ inci $ sitcc $ do
135129 name
136130 space
137131 p1
138− unless (null ps) . inciIf indentArgs $ do
132+ unless (null ps) . inci' $ do
139133 breakpoint
140134 sitcc (sep breakpoint sitcc ps)
141135 (_, ps) -> do
142136 name
143137 unless (null ps) $ do
144138 breakpoint
145− inciIf indentArgs $ sitcc (sep breakpoint sitcc args)
146−
147−-- | Print a Haddock.
148−p_hsDocString ::
149− -- | Haddock style
150− HaddockStyle ->
151− -- | Finish the doc string with a newline
152− Bool ->
153− -- | The doc string to render
154− LHsDocString ->
155− R ()
156−p_hsDocString hstyle needsNewline (L l str) = do
157− let isCommentSpan = \case
158− HaddockSpan _ _ -> True
159− CommentSpan _ -> True
160− _ -> False
161− goesAfterComment <- maybe False isCommentSpan <$> getSpanMark
162− -- Make sure the Haddock is separated by a newline from other comments.
163− when goesAfterComment newline
164− forM_ (zip (splitDocString str) (True : repeat False)) $ \(x, isFirst) -> do
165− if isFirst
166− then case hstyle of
167− Pipe -> txt "-- |"
168− Caret -> txt "-- ^"
169− Asterisk n -> txt ("-- " <> T.replicate n "*")
170− Named name -> p_hsDocName name
171− else newline >> txt "--"
172− space
173− unless (T.null x) (txt x)
174− when needsNewline newline
175− case l of
176− UnhelpfulSpan _ ->
177− -- It's often the case that the comment itself doesn't have a span
178− -- attached to it and instead its location can be obtained from
179− -- nearest enclosing span.
180− getEnclosingSpan (const True) >>= mapM_ (setSpanMark . HaddockSpan hstyle)
181− RealSrcSpan spn -> setSpanMark (HaddockSpan hstyle spn)
182−
183−-- | Print anchor of named doc section.
184−p_hsDocName :: String -> R ()
185−p_hsDocName name = txt ("-- $" <> T.pack name)
139+ inci' $ sitcc (sep breakpoint sitcc args)
src/Ormolu/Printer/Meat/Declaration.hs+90−260
@@ -1,20 +1,17 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
33{-# LANGUAGE PatternSynonyms #-}
44{-# LANGUAGE RecordWildCards #-}
5−{-# LANGUAGE ViewPatterns #-}
5+{-# LANGUAGE ViewPatterns #-}
66
77-- | Rendering of declarations.
8+
89module Ormolu.Printer.Meat.Declaration
9− ( p_hsDecls,
10− p_hsDeclsRespectGrouping,
10+ ( p_hsDecls
1111 )
1212where
1313
14−import Data.List (sort)
15−import Data.List.NonEmpty (NonEmpty (..), (<|))
16−import qualified Data.List.NonEmpty as NE
17−import GHC hiding (InlinePragma)
14+import GHC
1815import OccName (occNameFS)
1916import Ormolu.Printer.Combinators
2017import Ormolu.Printer.Meat.Common
@@ -34,99 +31,41 @@ import Ormolu.Printer.Meat.Declaration.Value
3431import Ormolu.Printer.Meat.Declaration.Warning
3532import Ormolu.Printer.Meat.Type
3633import Ormolu.Utils
37−
38−data UserGrouping
39− = -- | Always put newlines where we think they should be
40− Disregard
41− | -- | Respect user preferences regarding grouping
42− Respect
43− deriving (Eq, Show)
34+import RdrName (rdrNameOcc)
4435
4536p_hsDecls :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
46−p_hsDecls = p_hsDecls' Disregard
47−
48−-- | Like 'p_hsDecls' but respects user choices regarding grouping. If the
49−-- user omits newlines between declarations, we also omit them in most
50−-- cases, except when said declarations have associated Haddocks.
51−--
52−-- Does some normalization (compress subsequent newlines into a single one)
53−p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
54−p_hsDeclsRespectGrouping = p_hsDecls' Respect
55−
56−p_hsDecls' :: UserGrouping -> FamilyStyle -> [LHsDecl GhcPs] -> R ()
57−p_hsDecls' grouping style decls =
58− sepSemi id $
59− -- Return a list of rendered declarations, adding a newline to separate
60− -- groups.
61− case groupDecls decls of
62− [] -> []
63− (x : xs) -> renderGroup x ++ concat (zipWith renderGroupWithPrev (x : xs) xs)
64− where
65− renderGroup = NE.toList . fmap (located' $ dontUseBraces . p_hsDecl style)
66− renderGroupWithPrev prev curr =
67− -- We can omit a blank line when the user didn't add one, but we must
68− -- ensure we always add blank lines around documented declarations
69− case grouping of
70− Disregard ->
71− breakpoint : renderGroup curr
72− Respect ->
73− if separatedByBlankNE getLoc prev curr
74− || isDocumented prev
75− || isDocumented curr
76− then breakpoint : renderGroup curr
77− else renderGroup curr
78−
79−-- | Is a declaration group documented?
80−isDocumented :: NonEmpty (LHsDecl GhcPs) -> Bool
81−isDocumented = any (isHaddock . unLoc)
37+p_hsDecls style decls = do
38+ sepSemi (\(x, r) -> located x pDecl >> r) (separated decls)
8239 where
83− isHaddock DocNext = True
84− isHaddock DocPrev = True
85− isHaddock _ = False
40+ pDecl = dontUseBraces . p_hsDecl style
8641
87−-- | Group relevant declarations together.
88−groupDecls :: [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]
89−groupDecls [] = []
90−groupDecls (l@(L _ DocNext) : xs) =
91− -- If the first element is a doc string for next element, just include it
92− -- in the next block:
93− case groupDecls xs of
94− [] -> [l :| []]
95− (x : xs') -> (l <| x) : xs'
96−groupDecls (header : xs) =
97− let (grp, rest) = flip span (zip (header : xs) xs) $ \(previous, current) ->
98− let relevantToHdr = groupedDecls header current
99− relevantToPrev = groupedDecls previous current
100− isDeclSeries = declSeries previous current
101− in isDeclSeries || relevantToHdr || relevantToPrev
102− in (header :| map snd grp) : groupDecls (map snd rest)
42+ separated [] = []
43+ separated [x] = [(x, return ())]
44+ separated (x:y:xs) =
45+ if separatedDecls (unLoc x) (unLoc y)
46+ then (x, breakpoint') : separated (y:xs)
47+ else (x, return ()) : separated (y:xs)
10348
10449p_hsDecl :: FamilyStyle -> HsDecl GhcPs -> R ()
10550p_hsDecl style = \case
106− TyClD NoExtField x -> p_tyClDecl style x
107− ValD NoExtField x -> p_valDecl x
108− SigD NoExtField x -> p_sigDecl x
109− InstD NoExtField x -> p_instDecl style x
110− DerivD NoExtField x -> p_derivDecl x
111− DefD NoExtField x -> p_defaultDecl x
112− ForD NoExtField x -> p_foreignDecl x
113− WarningD NoExtField x -> p_warnDecls x
114− AnnD NoExtField x -> p_annDecl x
115− RuleD NoExtField x -> p_ruleDecls x
116− SpliceD NoExtField x -> p_spliceDecl x
117− DocD NoExtField docDecl ->
118− case docDecl of
119− DocCommentNext str -> p_hsDocString Pipe False (noLoc str)
120− DocCommentPrev str -> p_hsDocString Caret False (noLoc str)
121− DocCommentNamed name str -> p_hsDocString (Named name) False (noLoc str)
122− DocGroup n str -> p_hsDocString (Asterisk n) False (noLoc str)
123− RoleAnnotD NoExtField x -> p_roleAnnot x
124− KindSigD NoExtField s -> p_standaloneKindSig s
125− XHsDecl x -> noExtCon x
51+ TyClD NoExt x -> p_tyClDecl style x
52+ ValD NoExt x -> p_valDecl x
53+ SigD NoExt x -> p_sigDecl x
54+ InstD NoExt x -> p_instDecl style x
55+ DerivD NoExt x -> p_derivDecl x
56+ DefD NoExt x -> p_defaultDecl x
57+ ForD NoExt x -> p_foreignDecl x
58+ WarningD NoExt x -> p_warnDecls x
59+ AnnD NoExt x -> p_annDecl x
60+ RuleD NoExt x -> p_ruleDecls x
61+ SpliceD NoExt x -> p_spliceDecl x
62+ DocD _ _ -> notImplemented "DocD"
63+ RoleAnnotD NoExt x -> p_roleAnnot x
64+ XHsDecl _ -> notImplemented "XHsDecl"
12665
12766p_tyClDecl :: FamilyStyle -> TyClDecl GhcPs -> R ()
12867p_tyClDecl style = \case
129− FamDecl NoExtField x -> p_famDecl style x
68+ FamDecl NoExt x -> p_famDecl style x
13069 SynDecl {..} -> p_synDecl tcdLName tcdFixity tcdTyVars tcdRhs
13170 DataDecl {..} ->
13271 p_dataDecl
@@ -146,182 +85,73 @@ p_tyClDecl style = \case
14685 tcdMeths
14786 tcdATs
14887 tcdATDefs
149− tcdDocs
150− XTyClDecl x -> noExtCon x
88+ XTyClDecl {} -> notImplemented "XTyClDecl"
15189
15290p_instDecl :: FamilyStyle -> InstDecl GhcPs -> R ()
15391p_instDecl style = \case
154− ClsInstD NoExtField x -> p_clsInstDecl x
155− TyFamInstD NoExtField x -> p_tyFamInstDecl style x
156− DataFamInstD NoExtField x -> p_dataFamInstDecl style x
157− XInstDecl x -> noExtCon x
92+ ClsInstD NoExt x -> p_clsInstDecl x
93+ TyFamInstD NoExt x -> p_tyFamInstDecl style x
94+ DataFamInstD NoExt x -> p_dataFamInstDecl style x
95+ XInstDecl _ -> notImplemented "XInstDecl"
15896
15997p_derivDecl :: DerivDecl GhcPs -> R ()
16098p_derivDecl = \case
161− d@DerivDecl {} -> p_standaloneDerivDecl d
162− XDerivDecl x -> noExtCon x
163−
164−-- | Determine if these declarations should be grouped together.
165−groupedDecls ::
166− LHsDecl GhcPs ->
167− LHsDecl GhcPs ->
168− Bool
169−groupedDecls (L l_x x') (L l_y y') =
170− case (x', y') of
171− (TypeSignature ns, FunctionBody ns') -> ns `intersects` ns'
172− (TypeSignature ns, DefaultSignature ns') -> ns `intersects` ns'
173− (DefaultSignature ns, TypeSignature ns') -> ns `intersects` ns'
174− (DefaultSignature ns, FunctionBody ns') -> ns `intersects` ns'
175− (x, FunctionBody ns) | Just ns' <- isPragma x -> ns `intersects` ns'
176− (FunctionBody ns, x) | Just ns' <- isPragma x -> ns `intersects` ns'
177− (x, DataDeclaration n) | Just ns <- isPragma x -> n `elem` ns
178− (DataDeclaration n, x)
179− | Just ns <- isPragma x ->
180− let f = occNameFS . rdrNameOcc in f n `elem` map f ns
181− (x, y)
182− | Just ns <- isPragma x,
183− Just ns' <- isPragma y ->
184− ns `intersects` ns'
185− (x, TypeSignature ns) | Just ns' <- isPragma x -> ns `intersects` ns'
186− (TypeSignature ns, x) | Just ns' <- isPragma x -> ns `intersects` ns'
187− (PatternSignature ns, Pattern n) -> n `elem` ns
188− (KindSignature n, DataDeclaration n') -> n == n'
189− (KindSignature n, ClassDeclaration n') -> n == n'
190− (KindSignature n, FamilyDeclaration n') -> n == n'
191− -- Special case for TH splices, we look at locations
192− (Splice, Splice) -> not (separatedByBlank id l_x l_y)
193− -- This looks only at Haddocks, normal comments are handled elsewhere
194− (DocNext, _) -> True
195− (_, DocPrev) -> True
196− _ -> False
197−
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−
210−intersects :: Ord a => [a] -> [a] -> Bool
211−intersects a b = go (sort a) (sort b)
212− where
213− go :: Ord a => [a] -> [a] -> Bool
214− go _ [] = False
215− go [] _ = False
216− go (x : xs) (y : ys)
217− | x < y = go xs (y : ys)
218− | x > y = go (x : xs) ys
219− | otherwise = True
220−
221−isPragma ::
222− HsDecl GhcPs ->
223− Maybe [RdrName]
99+ d@DerivDecl {..} -> p_standaloneDerivDecl d
100+ XDerivDecl _ -> notImplemented "XDerivDecl standalone deriving"
101+
102+-- | Determine if these declarations should be separated by a blank line.
103+
104+separatedDecls
105+ :: HsDecl GhcPs
106+ -> HsDecl GhcPs
107+ -> Bool
108+separatedDecls (TypeSignature n) (FunctionBody n') = n /= n'
109+separatedDecls x (FunctionBody n) | Just n' <- isPragma x = n /= n'
110+separatedDecls (FunctionBody n) x | Just n' <- isPragma x = n /= n'
111+separatedDecls x (DataDeclaration n) | Just n' <- isPragma x = n /= n'
112+separatedDecls (DataDeclaration n) x | Just n' <- isPragma x =
113+ let f = occNameFS . rdrNameOcc in f n /= f n'
114+separatedDecls x y | Just n <- isPragma x, Just n' <- isPragma y = n /= n'
115+separatedDecls x (TypeSignature n') | Just n <- isPragma x = n /= n'
116+separatedDecls (PatternSignature n) (Pattern n') = n /= n'
117+separatedDecls _ _ = True
118+
119+isPragma
120+ :: HsDecl GhcPs
121+ -> (Maybe RdrName)
224122isPragma = \case
225− InlinePragma n -> Just [n]
226− SpecializePragma n -> Just [n]
227− SCCPragma n -> Just [n]
228− AnnTypePragma n -> Just [n]
229− AnnValuePragma n -> Just [n]
123+ InlinePragma n -> Just n
124+ SpecializePragma n -> Just n
125+ SCCPragma n -> Just n
126+ AnnTypePragma n -> Just n
127+ AnnValuePragma n -> Just n
230128 WarningPragma n -> Just n
231129 _ -> Nothing
232130
233−-- Declarations that do not refer to names
234−
235−pattern Splice :: HsDecl GhcPs
236−pattern Splice <- SpliceD NoExtField (SpliceDecl NoExtField _ _)
237−
238−-- Declarations referring to a single name
239−
240−pattern
241− InlinePragma,
242− SpecializePragma,
243− SCCPragma,
244− AnnTypePragma,
245− AnnValuePragma,
246− Pattern,
247− DataDeclaration,
248− ClassDeclaration,
249− KindSignature,
250− FamilyDeclaration ::
251− RdrName -> HsDecl GhcPs
252−pattern InlinePragma n <- SigD NoExtField (InlineSig NoExtField (L _ n) _)
253−pattern SpecializePragma n <- SigD NoExtField (SpecSig NoExtField (L _ n) _ _)
254−pattern SCCPragma n <- SigD NoExtField (SCCFunSig NoExtField _ (L _ n) _)
255−pattern AnnTypePragma n <- AnnD NoExtField (HsAnnotation NoExtField _ (TypeAnnProvenance (L _ n)) _)
256−pattern AnnValuePragma n <- AnnD NoExtField (HsAnnotation NoExtField _ (ValueAnnProvenance (L _ n)) _)
257−pattern Pattern n <- ValD NoExtField (PatSynBind NoExtField (PSB _ (L _ n) _ _ _))
258−pattern DataDeclaration n <- TyClD NoExtField (DataDecl NoExtField (L _ n) _ _ _)
259−pattern ClassDeclaration n <- TyClD NoExtField (ClassDecl NoExtField _ (L _ n) _ _ _ _ _ _ _ _)
260−pattern KindSignature n <- KindSigD NoExtField (StandaloneKindSig NoExtField (L _ n) _)
261−pattern FamilyDeclaration n <- TyClD NoExtField (FamDecl NoExtField (FamilyDecl NoExtField _ (L _ n) _ _ _ _))
262−
263−-- Declarations which can refer to multiple names
264−
265−pattern
266− TypeSignature,
267− DefaultSignature,
268− FunctionBody,
269− PatternSignature,
270− WarningPragma ::
271− [RdrName] -> HsDecl GhcPs
272−pattern TypeSignature n <- (sigRdrNames -> Just n)
273−pattern DefaultSignature n <- (defSigRdrNames -> Just n)
274−pattern FunctionBody n <- (funRdrNames -> Just n)
275−pattern PatternSignature n <- (patSigRdrNames -> Just n)
276−pattern WarningPragma n <- (warnSigRdrNames -> Just n)
277−
278−pattern DocNext, DocPrev :: HsDecl GhcPs
279−pattern DocNext <- (DocD NoExtField (DocCommentNext _))
280−pattern DocPrev <- (DocD NoExtField (DocCommentPrev _))
281−
282−sigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
283−sigRdrNames (SigD NoExtField (TypeSig NoExtField ns _)) = Just $ map unLoc ns
284−sigRdrNames (SigD NoExtField (ClassOpSig NoExtField _ ns _)) = Just $ map unLoc ns
285−sigRdrNames (SigD NoExtField (PatSynSig NoExtField ns _)) = Just $ map unLoc ns
286−sigRdrNames _ = Nothing
287−
288−defSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
289−defSigRdrNames (SigD NoExtField (ClassOpSig NoExtField True ns _)) = Just $ map unLoc ns
290−defSigRdrNames _ = Nothing
291−
292−funRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
293−funRdrNames (ValD NoExtField (FunBind NoExtField (L _ n) _ _ _)) = Just [n]
294−funRdrNames (ValD NoExtField (PatBind NoExtField (L _ n) _ _)) = Just $ patBindNames n
295−funRdrNames _ = Nothing
296−
297−patSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
298−patSigRdrNames (SigD NoExtField (PatSynSig NoExtField ns _)) = Just $ map unLoc ns
299−patSigRdrNames _ = Nothing
300−
301−warnSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
302−warnSigRdrNames (WarningD NoExtField (Warnings NoExtField _ ws)) = Just $
303− flip concatMap ws $ \case
304− L _ (Warning NoExtField ns _) -> map unLoc ns
305− L _ (XWarnDecl x) -> noExtCon x
306−warnSigRdrNames _ = Nothing
307−
308−patBindNames :: Pat GhcPs -> [RdrName]
309−patBindNames (TuplePat NoExtField ps _) = concatMap (patBindNames . unLoc) ps
310−patBindNames (VarPat NoExtField (L _ n)) = [n]
311−patBindNames (WildPat NoExtField) = []
312−patBindNames (LazyPat NoExtField (L _ p)) = patBindNames p
313−patBindNames (BangPat NoExtField (L _ p)) = patBindNames p
314−patBindNames (ParPat NoExtField (L _ p)) = patBindNames p
315−patBindNames (ListPat NoExtField ps) = concatMap (patBindNames . unLoc) ps
316−patBindNames (AsPat NoExtField (L _ n) (L _ p)) = n : patBindNames p
317−patBindNames (SumPat NoExtField (L _ p) _ _) = patBindNames p
318−patBindNames (ViewPat NoExtField _ (L _ p)) = patBindNames p
319−patBindNames (SplicePat NoExtField _) = []
320−patBindNames (LitPat NoExtField _) = []
321−patBindNames (SigPat _ (L _ p) _) = patBindNames p
322−patBindNames (NPat NoExtField _ _ _) = []
323−patBindNames (NPlusKPat NoExtField (L _ n) _ _ _ _) = [n]
324−patBindNames (ConPatIn _ d) = concatMap (patBindNames . unLoc) (hsConPatArgs d)
325−patBindNames ConPatOut {} = notImplemented "ConPatOut" -- created by renamer
326−patBindNames (CoPat NoExtField _ p _) = patBindNames p
327−patBindNames (XPat x) = noExtCon x
131+pattern TypeSignature
132+ , FunctionBody
133+ , InlinePragma
134+ , SpecializePragma
135+ , SCCPragma
136+ , AnnTypePragma
137+ , AnnValuePragma
138+ , PatternSignature
139+ , Pattern
140+ , WarningPragma
141+ , DataDeclaration :: RdrName -> HsDecl GhcPs
142+pattern TypeSignature n <- (sigRdrName -> Just n)
143+pattern FunctionBody n <- ValD NoExt (FunBind NoExt (L _ n) _ _ _)
144+pattern InlinePragma n <- SigD NoExt (InlineSig NoExt (L _ n) _)
145+pattern SpecializePragma n <- SigD NoExt (SpecSig NoExt (L _ n) _ _)
146+pattern SCCPragma n <- SigD NoExt (SCCFunSig NoExt _ (L _ n) _)
147+pattern AnnTypePragma n <- AnnD NoExt (HsAnnotation NoExt _ (TypeAnnProvenance (L _ n)) _)
148+pattern AnnValuePragma n <- AnnD NoExt (HsAnnotation NoExt _ (ValueAnnProvenance (L _ n)) _)
149+pattern PatternSignature n <- SigD NoExt (PatSynSig NoExt ((L _ n):_) _)
150+pattern Pattern n <- ValD NoExt (PatSynBind NoExt (PSB _ (L _ n) _ _ _))
151+pattern WarningPragma n <- WarningD NoExt (Warnings NoExt _ [(L _ (Warning NoExt [(L _ n)] _))])
152+pattern DataDeclaration n <- TyClD NoExt (DataDecl NoExt (L _ n) _ _ _)
153+
154+sigRdrName :: HsDecl GhcPs -> Maybe RdrName
155+sigRdrName (SigD NoExt (TypeSig NoExt ((L _ n):_) _)) = Just n
156+sigRdrName (SigD NoExt (ClassOpSig NoExt _ ((L _ n):_) _)) = Just n
157+sigRdrName _ = Nothing
src/Ormolu/Printer/Meat/Declaration.hs-boot+1−3
@@ -1,6 +1,5 @@
11module Ormolu.Printer.Meat.Declaration
2− ( p_hsDecls,
3− p_hsDeclsRespectGrouping,
2+ ( p_hsDecls
43 )
54where
65
@@ -9,4 +8,3 @@ import Ormolu.Printer.Combinators
98import Ormolu.Printer.Meat.Common
109
1110p_hsDecls :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
12−p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
src/Ormolu/Printer/Meat/Declaration/Annotation.hs+6−5
@@ -1,8 +1,8 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
33
44module Ormolu.Printer.Meat.Declaration.Annotation
5− ( p_annDecl,
5+ ( p_annDecl
66 )
77where
88
@@ -10,17 +10,18 @@ import GHC
1010import Ormolu.Printer.Combinators
1111import Ormolu.Printer.Meat.Common
1212import Ormolu.Printer.Meat.Declaration.Value
13+import Ormolu.Utils
1314
1415p_annDecl :: AnnDecl GhcPs -> R ()
1516p_annDecl = \case
16− HsAnnotation NoExtField _ annProv expr -> pragma "ANN" . inci $ do
17+ HsAnnotation NoExt _ annProv expr -> pragma "ANN" . inci $ do
1718 p_annProv annProv
1819 breakpoint
1920 located expr p_hsExpr
20− XAnnDecl x -> noExtCon x
21+ XAnnDecl {} -> notImplemented "XAnnDecl"
2122
2223p_annProv :: AnnProvenance (IdP GhcPs) -> R ()
2324p_annProv = \case
2425 ValueAnnProvenance name -> p_rdrName name
25− TypeAnnProvenance name -> txt "type" >> space >> p_rdrName name
26+ TypeAnnProvenance name -> txt "type " >> p_rdrName name
2627 ModuleAnnProvenance -> txt "module"
src/Ormolu/Printer/Meat/Declaration/Class.hs+51−48
@@ -1,10 +1,11 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
44
55-- | Rendering of type class declarations.
6+
67module Ormolu.Printer.Meat.Declaration.Class
7− ( p_classDecl,
8+ ( p_classDecl
89 )
910where
1011
@@ -12,89 +13,91 @@ import Class
1213import Control.Arrow
1314import Control.Monad
1415import Data.Foldable
15−import Data.List (sortOn)
16+import Data.List (sortBy)
17+import Data.Ord (comparing)
1618import GHC
1719import Ormolu.Printer.Combinators
1820import Ormolu.Printer.Meat.Common
19−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
2021import Ormolu.Printer.Meat.Type
22+import Ormolu.Utils
23+import RdrName (RdrName (..))
24+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
2125
22−p_classDecl ::
23− LHsContext GhcPs ->
24− Located RdrName ->
25− LHsQTyVars GhcPs ->
26− LexicalFixity ->
27− [Located (FunDep (Located RdrName))] ->
28− [LSig GhcPs] ->
29− LHsBinds GhcPs ->
30− [LFamilyDecl GhcPs] ->
31− [LTyFamDefltDecl GhcPs] ->
32− [LDocDecl] ->
33− R ()
34−p_classDecl ctx name HsQTvs {..} fixity fdeps csigs cdefs cats catdefs cdocs = do
35− let variableSpans = getLoc <$> hsq_explicit
26+p_classDecl
27+ :: LHsContext GhcPs
28+ -> Located RdrName
29+ -> LHsQTyVars GhcPs
30+ -> LexicalFixity
31+ -> [Located (FunDep (Located RdrName))]
32+ -> [LSig GhcPs]
33+ -> LHsBinds GhcPs
34+ -> [LFamilyDecl GhcPs]
35+ -> [LTyFamDefltEqn GhcPs]
36+ -> R ()
37+p_classDecl ctx name tvars fixity fdeps csigs cdefs cats catdefs = do
38+ let HsQTvs {..} = tvars
39+ variableSpans = getLoc <$> hsq_explicit
3640 signatureSpans = getLoc name : variableSpans
3741 dependencySpans = getLoc <$> fdeps
3842 combinedSpans = getLoc ctx : (signatureSpans ++ dependencySpans)
39− -- GHC's AST does not necessarily store each kind of element in source
40− -- location order. This happens because different declarations are stored
41− -- in different lists. Consequently, to get all the declarations in proper
42− -- order, they need to be manually sorted.
43− sigs = (getLoc &&& fmap (SigD NoExtField)) <$> csigs
44− vals = (getLoc &&& fmap (ValD NoExtField)) <$> toList cdefs
45− tyFams = (getLoc &&& fmap (TyClD NoExtField . FamDecl NoExtField)) <$> cats
46− docs = (getLoc &&& fmap (DocD NoExtField)) <$> cdocs
47− tyFamDefs =
48− ( getLoc &&& fmap (InstD NoExtField . TyFamInstD NoExtField)
49− )
50− <$> catdefs
51− allDecls =
52− snd <$> sortOn fst (sigs <> vals <> tyFams <> tyFamDefs <> docs)
5343 txt "class"
5444 switchLayout combinedSpans $ do
5545 breakpoint
5646 inci $ do
5747 p_classContext ctx
58− switchLayout signatureSpans $
48+ switchLayout signatureSpans $ do
5949 p_infixDefHelper
6050 (isInfix fixity)
61− True
51+ inci
6252 (p_rdrName name)
6353 (located' p_hsTyVarBndr <$> hsq_explicit)
6454 inci (p_classFundeps fdeps)
65− unless (null allDecls) $ do
66− breakpoint
67− txt "where"
55+ -- GHC's AST does not necessarily store each kind of element in source
56+ -- location order. This happens because different declarations are stored in
57+ -- different lists. Consequently, to get all the declarations in proper order,
58+ -- they need to be manually sorted.
59+ let sigs = (getLoc &&& fmap (SigD NoExt)) <$> csigs
60+ vals = (getLoc &&& fmap (ValD NoExt)) <$> toList cdefs
61+ tyFams = (getLoc &&& fmap (TyClD NoExt . FamDecl NoExt)) <$> cats
62+ tyFamDefs =
63+ ( getLoc &&& fmap (InstD NoExt . TyFamInstD NoExt . defltEqnToInstDecl)
64+ ) <$> catdefs
65+ allDecls =
66+ snd <$> sortBy (comparing fst) (sigs <> vals <> tyFams <> tyFamDefs)
6867 unless (null allDecls) $ do
68+ txt " where"
6969 breakpoint -- Ensure whitespace is added after where clause.
70− inci (p_hsDeclsRespectGrouping Associated allDecls)
71−p_classDecl _ _ (XLHsQTyVars c) _ _ _ _ _ _ _ = noExtCon c
70+ breakpoint' -- Add newline before first declaration.
71+ inci (p_hsDecls Associated allDecls)
7272
7373p_classContext :: LHsContext GhcPs -> R ()
7474p_classContext ctx = unless (null (unLoc ctx)) $ do
7575 located ctx p_hsContext
76− space
77− txt "=>"
7876 breakpoint
77+ txt "=> "
7978
8079p_classFundeps :: [Located (FunDep (Located RdrName))] -> R ()
8180p_classFundeps fdeps = unless (null fdeps) $ do
8281 breakpoint
83− txt "|"
84− space
85− inci $ sep commaDel (sitcc . located' p_funDep) fdeps
82+ txt "| "
83+ sitcc $ sep (comma >> breakpoint) (sitcc . located' p_funDep) fdeps
8684
8785p_funDep :: FunDep (Located RdrName) -> R ()
8886p_funDep (before, after) = do
8987 sep space p_rdrName before
90− space
91− txt "->"
92− space
88+ txt " -> "
9389 sep space p_rdrName after
9490
9591----------------------------------------------------------------------------
9692-- Helpers
9793
94+defltEqnToInstDecl :: TyFamDefltEqn GhcPs -> TyFamInstDecl GhcPs
95+defltEqnToInstDecl FamEqn {..} = TyFamInstDecl {..}
96+ where
97+ eqn = FamEqn {feqn_pats = tyVarsToTypes feqn_pats, ..}
98+ tfid_eqn = HsIB {hsib_ext = NoExt, hsib_body = eqn}
99+defltEqnToInstDecl XFamEqn {} = notImplemented "XFamEqn"
100+
98101isInfix :: LexicalFixity -> Bool
99102isInfix = \case
100103 Infix -> True
src/Ormolu/Printer/Meat/Declaration/Data.hs+104−176
@@ -1,33 +1,31 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
44
55-- | Renedring of data type declarations.
6+
67module Ormolu.Printer.Meat.Declaration.Data
7− ( p_dataDecl,
8+ ( p_dataDecl
89 )
910where
1011
1112import Control.Monad
12−import Data.Maybe (isJust, maybeToList)
13+import Data.Maybe (isJust)
1314import GHC
1415import Ormolu.Printer.Combinators
1516import Ormolu.Printer.Meat.Common
1617import Ormolu.Printer.Meat.Type
1718import Ormolu.Utils
19+import RdrName (RdrName (..))
20+import SrcLoc (Located)
1821
19−p_dataDecl ::
20− -- | Whether to format as data family
21− FamilyStyle ->
22− -- | Type constructor
23− Located RdrName ->
24− -- | Type patterns
25− [LHsType GhcPs] ->
26− -- | Lexical fixity
27− LexicalFixity ->
28− -- | Data definition
29− HsDataDefn GhcPs ->
30− R ()
22+p_dataDecl
23+ :: FamilyStyle -- ^ Whether to format as data family
24+ -> Located RdrName -- ^ Type constructor
25+ -> [LHsType GhcPs] -- ^ Type patterns
26+ -> LexicalFixity -- ^ Lexical fixity
27+ -> HsDataDefn GhcPs -- ^ Data definition
28+ -> R ()
3129p_dataDecl style name tpats fixity HsDataDefn {..} = do
3230 txt $ case dd_ND of
3331 NewType -> "newtype"
@@ -35,160 +33,107 @@ p_dataDecl style name tpats fixity HsDataDefn {..} = do
3533 txt $ case style of
3634 Associated -> mempty
3735 Free -> " instance"
38− let constructorSpans = getLoc name : fmap getLoc tpats
39− switchLayout constructorSpans $ do
36+ switchLayout (getLoc name : fmap getLoc tpats) $ do
4037 breakpoint
41− inci $
42− p_infixDefHelper
43− (isInfix fixity)
44− True
45− (p_rdrName name)
46− (located' p_hsType <$> tpats)
38+ inci $ p_infixDefHelper
39+ (isInfix fixity)
40+ inci
41+ (p_rdrName name)
42+ (located' p_hsType <$> tpats)
4743 case dd_kindSig of
4844 Nothing -> return ()
4945 Just k -> do
5046 space
51− txt "::"
52− space
47+ txt ":: "
5348 located k p_hsType
5449 let gadt = isJust dd_kindSig || any (isGadt . unLoc) dd_cons
5550 unless (null dd_cons) $
5651 if gadt
57− then inci $ do
58− switchLayout constructorSpans $ do
59− breakpoint
60− txt "where"
52+ then do
53+ txt " where"
6154 breakpoint
62− sepSemi (located' (p_conDecl False)) dd_cons
63− else switchLayout (getLoc name : (getLoc <$> dd_cons)) . inci $ do
64− let singleConstRec = isSingleConstRec dd_cons
65− if singleConstRec
66− then space
67− else
68− if hasHaddocks dd_cons
69− then newline
70− else breakpoint
71− equals
72− space
73− layout <- getLayout
74− let s =
75− if layout == MultiLine || hasHaddocks dd_cons
76− then newline >> txt "|" >> space
77− else space >> txt "|" >> space
78− sitcc' =
79− if singleConstRec
80− then id
81− else sitcc
82− sep s (sitcc' . located' (p_conDecl singleConstRec)) dd_cons
55+ inci $ sepSemi (located' p_conDecl) dd_cons
56+ else switchLayout (getLoc name : (getLoc <$> dd_cons)) $
57+ inci $ do
58+ breakpoint
59+ txt "= "
60+ let s = vlayout (txt " | ") (newline >> txt "| ")
61+ sep s (sitcc . located' p_conDecl) dd_cons
62+
8363 unless (null $ unLoc dd_derivs) breakpoint
84− inci . located dd_derivs $ \xs ->
64+ inci . located dd_derivs $ \xs -> do
8565 sep newline (located' p_hsDerivingClause) xs
86−p_dataDecl _ _ _ _ (XHsDataDefn x) = noExtCon x
66+p_dataDecl _ _ _ _ (XHsDataDefn NoExt) = notImplemented "XHsDataDefn"
8767
88−p_conDecl ::
89− Bool ->
90− ConDecl GhcPs ->
91− R ()
92−p_conDecl singleConstRec = \case
68+p_conDecl :: ConDecl GhcPs -> R ()
69+p_conDecl = \case
9370 ConDeclGADT {..} -> do
94− mapM_ (p_hsDocString Pipe True) con_doc
95− let conDeclSpn =
96− fmap getLoc con_names
97− <> [getLoc con_forall]
98− <> conTyVarsSpans con_qvars
99− <> maybeToList (fmap getLoc con_mb_cxt)
100− <> conArgsSpans con_args
101− switchLayout conDeclSpn $ do
102− case con_names of
103− [] -> return ()
104− (c : cs) -> do
105− p_rdrName c
106− unless (null cs) . inci $ do
107− commaDel
108− sep commaDel p_rdrName cs
109− inci $ do
110− space
111− txt "::"
112− let interArgBreak =
113− if hasDocStrings (unLoc con_res_ty)
114− then newline
115− else breakpoint
116− interArgBreak
117− when (unLoc con_forall) $ do
118− p_forallBndrs ForallInvis p_hsTyVarBndr (hsq_explicit con_qvars)
119− interArgBreak
120− forM_ con_mb_cxt p_lhsContext
121− case con_args of
122− PrefixCon xs -> do
123− sep breakpoint (located' p_hsType) xs
124− unless (null xs) $ do
125− space
126− txt "->"
127− breakpoint
128− RecCon l -> do
129− located l p_conDeclFields
130− unless (null $ unLoc l) $ do
131− space
132− txt "->"
133− breakpoint
134− InfixCon _ _ -> notImplemented "InfixCon"
135− p_hsType (unLoc con_res_ty)
136− ConDeclH98 {..} -> do
137− mapM_ (p_hsDocString Pipe True) con_doc
138− let conDeclWithContextSpn =
139− [getLoc con_forall]
140− <> fmap getLoc con_ex_tvs
141− <> maybeToList (fmap getLoc con_mb_cxt)
142− <> conDeclSpn
143− conDeclSpn =
144− getLoc con_name : conArgsSpans con_args
145− switchLayout conDeclWithContextSpn $ do
146− when (unLoc con_forall) $ do
147− p_forallBndrs ForallInvis p_hsTyVarBndr con_ex_tvs
148− breakpoint
71+ case con_names of
72+ [] -> return ()
73+ (c:cs) -> do
74+ p_rdrName c
75+ unless (null cs) . inci $ do
76+ comma
77+ breakpoint
78+ sitcc $ sep (comma >> breakpoint) p_rdrName cs
79+ breakpoint
80+ inci $ do
81+ txt ":: "
82+ p_forallBndrs (hsq_explicit con_qvars)
14983 forM_ con_mb_cxt p_lhsContext
150− switchLayout conDeclSpn $ case con_args of
84+ case con_args of
15185 PrefixCon xs -> do
152− p_rdrName con_name
153− unless (null xs) breakpoint
154− inci . sitcc $ sep breakpoint (sitcc . located' p_hsTypePostDoc) xs
86+ sep breakpoint (located' p_hsType) xs
87+ unless (null xs) $ do
88+ breakpoint
89+ txt "-> "
15590 RecCon l -> do
91+ located l p_conDeclFields
92+ unless (null $ unLoc l) $ do
93+ breakpoint
94+ txt "-> "
95+ InfixCon _ _ -> notImplemented "InfixCon"
96+ p_hsType (unLoc con_res_ty)
97+ ConDeclH98 {..} -> do
98+ p_forallBndrs con_ex_tvs
99+ forM_ con_mb_cxt p_lhsContext
100+ case con_args of
101+ PrefixCon xs -> do
102+ p_rdrName con_name
103+ unless (null xs) breakpoint
104+ inci . sitcc $ sep breakpoint (sitcc . located' p_hsType) xs
105+ RecCon l -> do
106+ p_rdrName con_name
107+ breakpoint
108+ inci $ located l p_conDeclFields
109+ InfixCon x y -> do
110+ located x p_hsType
111+ breakpoint
112+ inci $ do
156113 p_rdrName con_name
157− breakpoint
158− inciIf (not singleConstRec) (located l p_conDeclFields)
159− InfixCon x y -> do
160− located x p_hsType
161− breakpoint
162− inci $ do
163− p_rdrName con_name
164− space
165− located y p_hsType
166− XConDecl x -> noExtCon x
167−
168−conArgsSpans :: HsConDeclDetails GhcPs -> [SrcSpan]
169−conArgsSpans = \case
170− PrefixCon xs ->
171− getLoc <$> xs
172− RecCon l ->
173− [getLoc l]
174− InfixCon x y ->
175− [getLoc x, getLoc y]
114+ space
115+ located y p_hsType
116+ XConDecl NoExt -> notImplemented "XConDecl"
176117
177−conTyVarsSpans :: LHsQTyVars GhcPs -> [SrcSpan]
178−conTyVarsSpans = \case
179− HsQTvs {..} -> getLoc <$> hsq_explicit
180− XLHsQTyVars x -> noExtCon x
118+p_forallBndrs
119+ :: [LHsTyVarBndr GhcPs]
120+ -> R ()
121+p_forallBndrs = \case
122+ [] -> return ()
123+ bndrs -> do
124+ txt "forall "
125+ sep space (located' p_hsTyVarBndr) bndrs
126+ txt ". "
181127
182−p_lhsContext ::
183− LHsContext GhcPs ->
184− R ()
128+p_lhsContext
129+ :: LHsContext GhcPs
130+ -> R ()
185131p_lhsContext = \case
186132 L _ [] -> pure ()
187133 ctx -> do
188134 located ctx p_hsContext
189− space
190− txt "=>"
191135 breakpoint
136+ txt "=> "
192137
193138isGadt :: ConDecl GhcPs -> Bool
194139isGadt = \case
@@ -196,35 +141,32 @@ isGadt = \case
196141 ConDeclH98 {} -> False
197142 XConDecl {} -> False
198143
199−p_hsDerivingClause ::
200− HsDerivingClause GhcPs ->
201− R ()
144+p_hsDerivingClause
145+ :: HsDerivingClause GhcPs
146+ -> R ()
202147p_hsDerivingClause HsDerivingClause {..} = do
203148 txt "deriving"
204149 let derivingWhat = located deriv_clause_tys $ \case
205150 [] -> txt "()"
206− xs ->
207− parens N $
208− sep
209− commaDel
210− (sitcc . located' p_hsType . hsib_body)
211− xs
212− space
151+ xs -> parens . sitcc $ sep
152+ (comma >> breakpoint)
153+ (sitcc . located' p_hsType . hsib_body)
154+ xs
213155 case deriv_clause_strategy of
214156 Nothing -> do
215157 breakpoint
216158 inci derivingWhat
217159 Just (L _ a) -> case a of
218160 StockStrategy -> do
219− txt "stock"
161+ txt " stock"
220162 breakpoint
221163 inci derivingWhat
222164 AnyclassStrategy -> do
223− txt "anyclass"
165+ txt " anyclass"
224166 breakpoint
225167 inci derivingWhat
226168 NewtypeStrategy -> do
227− txt "newtype"
169+ txt " newtype"
228170 breakpoint
229171 inci derivingWhat
230172 ViaStrategy HsIB {..} -> do
@@ -232,12 +174,11 @@ p_hsDerivingClause HsDerivingClause {..} = do
232174 inci $ do
233175 derivingWhat
234176 breakpoint
235− txt "via"
236− space
177+ txt "via "
237178 located hsib_body p_hsType
238− ViaStrategy (XHsImplicitBndrs x) ->
239− noExtCon x
240−p_hsDerivingClause (XHsDerivingClause x) = noExtCon x
179+ ViaStrategy (XHsImplicitBndrs NoExt) ->
180+ notImplemented "XHsImplicitBndrs"
181+p_hsDerivingClause (XHsDerivingClause NoExt) = notImplemented "XHsDerivingClause"
241182
242183----------------------------------------------------------------------------
243184-- Helpers
@@ -246,16 +187,3 @@ isInfix :: LexicalFixity -> Bool
246187isInfix = \case
247188 Infix -> True
248189 Prefix -> False
249−
250−isSingleConstRec :: [LConDecl GhcPs] -> Bool
251−isSingleConstRec [(L _ ConDeclH98 {..})] =
252− case con_args of
253− RecCon _ -> True
254− _ -> False
255−isSingleConstRec _ = False
256−
257−hasHaddocks :: [LConDecl GhcPs] -> Bool
258−hasHaddocks = any (f . unLoc)
259− where
260− f ConDeclH98 {..} = isJust con_doc
261− f _ = False
src/Ormolu/Printer/Meat/Declaration/Default.hs+7−6
@@ -1,20 +1,21 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
33
44module Ormolu.Printer.Meat.Declaration.Default
5− ( p_defaultDecl,
5+ ( p_defaultDecl
66 )
77where
88
99import GHC
1010import Ormolu.Printer.Combinators
1111import Ormolu.Printer.Meat.Type
12+import Ormolu.Utils
1213
1314p_defaultDecl :: DefaultDecl GhcPs -> R ()
1415p_defaultDecl = \case
15− DefaultDecl NoExtField ts -> do
16+ DefaultDecl NoExt ts -> do
1617 txt "default"
1718 breakpoint
18− inci . parens N $
19− sep commaDel (sitcc . located' p_hsType) ts
20− XDefaultDecl x -> noExtCon x
19+ inci . parens . sitcc $
20+ sep (comma >> breakpoint) (sitcc . located' p_hsType) ts
21+ XDefaultDecl {} -> notImplemented "XDefaultDecl"
src/Ormolu/Printer/Meat/Declaration/Foreign.hs+14−16
@@ -1,9 +1,9 @@
1−{-# LANGUAGE LambdaCase #-}
2−{-# LANGUAGE NamedFieldPuns #-}
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE NamedFieldPuns #-}
33{-# LANGUAGE OverloadedStrings #-}
44
55module Ormolu.Printer.Meat.Declaration.Foreign
6− ( p_foreignDecl,
6+ ( p_foreignDecl
77 )
88where
99
@@ -15,6 +15,7 @@ import GHC
1515import Ormolu.Printer.Combinators
1616import Ormolu.Printer.Meat.Common
1717import Ormolu.Printer.Meat.Declaration.Signature
18+import Ormolu.Utils
1819
1920p_foreignDecl :: ForeignDecl GhcPs -> R ()
2021p_foreignDecl = \case
@@ -24,21 +25,19 @@ p_foreignDecl = \case
2425 fd@ForeignExport {fd_fe} -> do
2526 p_foreignExport fd_fe
2627 p_foreignTypeSig fd
27− XForeignDecl x -> noExtCon x
28+ XForeignDecl {} -> notImplemented "XForeignDecl"
2829
2930-- | Printer for the last part of an import\/export, which is function name
3031-- and type signature.
32+
3133p_foreignTypeSig :: ForeignDecl GhcPs -> R ()
3234p_foreignTypeSig fd = do
3335 breakpoint
34− inci
35− . switchLayout
36− [ getLoc (fd_name fd),
37− (getLoc . hsib_body . fd_sig_ty) fd
38− ]
39− $ do
40− p_rdrName (fd_name fd)
41− p_typeAscription (HsWC NoExtField (fd_sig_ty fd))
36+ -- Switch into the layout of the signature, to allow us to pull name and
37+ -- signature onto a single line.
38+ inci . switchLayout [getLoc . hsib_body $ fd_sig_ty fd] $ do
39+ p_rdrName (fd_name fd)
40+ p_typeAscription (HsWC NoExt (fd_sig_ty fd))
4241
4342-- | Printer for 'ForeignImport'.
4443--
@@ -52,10 +51,10 @@ p_foreignTypeSig fd = do
5251-- We also layout the identifier using the 'SourceText', because printing
5352-- with the other two fields of 'CImport' is very complicated. See the
5453-- 'Outputable' instance of 'ForeignImport' for details.
54+
5555p_foreignImport :: ForeignImport -> R ()
5656p_foreignImport (CImport cCallConv safety _ _ sourceText) = do
57− txt "foreign import"
58− space
57+ txt "foreign import "
5958 located cCallConv atom
6059 -- Need to check for 'noLoc' for the 'safe' annotation
6160 when (isGoodSrcSpan $ getLoc safety) (space >> atom safety)
@@ -63,8 +62,7 @@ p_foreignImport (CImport cCallConv safety _ _ sourceText) = do
6362
6463p_foreignExport :: ForeignExport -> R ()
6564p_foreignExport (CExport (L loc (CExportStatic _ _ cCallConv)) sourceText) = do
66− txt "foreign export"
67− space
65+ txt "foreign export "
6866 located (L loc cCallConv) atom
6967 located sourceText p_sourceText
7068
src/Ormolu/Printer/Meat/Declaration/Instance.hs+40−38
@@ -1,13 +1,14 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
44
55-- | Type class, type family, and data family instance declarations.
6+
67module Ormolu.Printer.Meat.Declaration.Instance
7− ( p_clsInstDecl,
8− p_tyFamInstDecl,
9− p_dataFamInstDecl,
10− p_standaloneDerivDecl,
8+ ( p_clsInstDecl
9+ , p_tyFamInstDecl
10+ , p_dataFamInstDecl
11+ , p_standaloneDerivDecl
1112 )
1213where
1314
@@ -15,15 +16,16 @@ import BasicTypes
1516import Control.Arrow
1617import Control.Monad
1718import Data.Foldable
18−import Data.List (sortOn)
19+import Data.List (sortBy)
20+import Data.Ord (comparing)
1921import GHC
2022import Ormolu.Printer.Combinators
2123import Ormolu.Printer.Meat.Common
22−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
2324import Ormolu.Printer.Meat.Declaration.Data
2425import Ormolu.Printer.Meat.Declaration.TypeFamily
2526import Ormolu.Printer.Meat.Type
2627import Ormolu.Utils
28+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
2729
2830p_standaloneDerivDecl :: DerivDecl GhcPs -> R ()
2931p_standaloneDerivDecl DerivDecl {..} = do
@@ -32,30 +34,32 @@ p_standaloneDerivDecl DerivDecl {..} = do
3234 txt "instance"
3335 breakpoint
3436 match_overlap_mode deriv_overlap_mode breakpoint
35− inciIf toIndent typesAfterInstance
37+ if toIndent
38+ then inci typesAfterInstance
39+ else typesAfterInstance
3640 txt "deriving"
37− space
3841 case deriv_strategy of
39− Nothing ->
42+ Nothing -> do
43+ space
4044 instTypes False
4145 Just (L _ a) -> case a of
4246 StockStrategy -> do
43− txt "stock "
47+ txt " stock "
4448 instTypes False
4549 AnyclassStrategy -> do
46− txt "anyclass "
50+ txt " anyclass "
4751 instTypes False
4852 NewtypeStrategy -> do
49− txt "newtype "
53+ txt " newtype "
5054 instTypes False
5155 ViaStrategy HsIB {..} -> do
52− txt "via"
56+ txt " via"
5357 breakpoint
5458 inci (located hsib_body p_hsType)
5559 breakpoint
5660 instTypes True
57− ViaStrategy (XHsImplicitBndrs x) ->
58− noExtCon x
61+ ViaStrategy (XHsImplicitBndrs NoExt) ->
62+ notImplemented "XHsImplicitBndrs"
5963p_standaloneDerivDecl (XDerivDecl _) = notImplemented "XDerivDecl"
6064
6165p_clsInstDecl :: ClsInstDecl GhcPs -> R ()
@@ -68,18 +72,17 @@ p_clsInstDecl = \case
6872 -- location order. This happens because different declarations are stored in
6973 -- different lists. Consequently, to get all the declarations in proper
7074 -- order, they need to be manually sorted.
71− let sigs = (getLoc &&& fmap (SigD NoExtField)) <$> cid_sigs
72− vals = (getLoc &&& fmap (ValD NoExtField)) <$> toList cid_binds
75+ let sigs = (getLoc &&& fmap (SigD NoExt)) <$> cid_sigs
76+ vals = (getLoc &&& fmap (ValD NoExt)) <$> toList cid_binds
7377 tyFamInsts =
74− ( getLoc &&& fmap (InstD NoExtField . TyFamInstD NoExtField)
75− )
76− <$> cid_tyfam_insts
78+ ( getLoc &&& fmap (InstD NoExt . TyFamInstD NoExt)
79+ ) <$> cid_tyfam_insts
7780 dataFamInsts =
78− ( getLoc &&& fmap (InstD NoExtField . DataFamInstD NoExtField)
79− )
80− <$> cid_datafam_insts
81+ ( getLoc &&& fmap (InstD NoExt . DataFamInstD NoExt)
82+ ) <$> cid_datafam_insts
8183 allDecls =
82− snd <$> sortOn fst (sigs <> vals <> tyFamInsts <> dataFamInsts)
84+ snd <$>
85+ sortBy (comparing fst) (sigs <> vals <> tyFamInsts <> dataFamInsts)
8386 located hsib_body $ \x -> do
8487 breakpoint
8588 inci $ do
@@ -88,12 +91,13 @@ p_clsInstDecl = \case
8891 unless (null allDecls) $ do
8992 breakpoint
9093 txt "where"
91− unless (null allDecls) . inci $ do
92− -- Ensure whitespace is added after where clause.
93− breakpoint
94− dontUseBraces $ p_hsDeclsRespectGrouping Associated allDecls
95− XHsImplicitBndrs x -> noExtCon x
96− XClsInstDecl x -> noExtCon x
94+ unless (null allDecls) $ do
95+ inci $ do
96+ breakpoint -- Ensure whitespace is added after where clause.
97+ breakpoint' -- Add newline before first declaration
98+ dontUseBraces $ p_hsDecls Associated allDecls
99+ XHsImplicitBndrs NoExt -> notImplemented "XHsImplicitBndrs"
100+ XClsInstDecl NoExt -> notImplemented "XClsInstDecl"
97101
98102p_tyFamInstDecl :: FamilyStyle -> TyFamInstDecl GhcPs -> R ()
99103p_tyFamInstDecl style = \case
@@ -106,12 +110,10 @@ p_tyFamInstDecl style = \case
106110
107111p_dataFamInstDecl :: FamilyStyle -> DataFamInstDecl GhcPs -> R ()
108112p_dataFamInstDecl style = \case
109− DataFamInstDecl {dfid_eqn = HsIB {hsib_body = FamEqn {..}}} ->
110− p_dataDecl style feqn_tycon (map typeArgToType feqn_pats) feqn_fixity feqn_rhs
111− DataFamInstDecl {dfid_eqn = HsIB {hsib_body = XFamEqn {}}} ->
112− notImplemented "XFamEqn"
113− DataFamInstDecl {dfid_eqn = XHsImplicitBndrs {}} ->
114− notImplemented "XHsImplicitBndrs"
113+ DataFamInstDecl {..} -> do
114+ let HsIB {..} = dfid_eqn
115+ FamEqn {..} = hsib_body
116+ p_dataDecl style feqn_tycon feqn_pats feqn_fixity feqn_rhs
115117
116118match_overlap_mode :: Maybe (Located OverlapMode) -> R () -> R ()
117119match_overlap_mode overlap_mode layoutStrategy =
src/Ormolu/Printer/Meat/Declaration/RoleAnnotation.hs+11−5
@@ -1,10 +1,12 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
34{-# LANGUAGE TypeFamilies #-}
45
56-- | Rendering of Role annotation declarations.
7+
68module Ormolu.Printer.Meat.Declaration.RoleAnnotation
7− ( p_roleAnnot,
9+ ( p_roleAnnot
810 )
911where
1012
@@ -12,11 +14,14 @@ import CoAxiom
1214import GHC
1315import Ormolu.Printer.Combinators
1416import Ormolu.Printer.Meat.Common
17+import Ormolu.Utils
18+import RdrName (RdrName (..))
19+import SrcLoc (Located)
1520
1621p_roleAnnot :: RoleAnnotDecl GhcPs -> R ()
1722p_roleAnnot = \case
18− RoleAnnotDecl NoExtField l_name anns -> p_roleAnnot' l_name anns
19− XRoleAnnotDecl x -> noExtCon x
23+ RoleAnnotDecl NoExt l_name anns -> p_roleAnnot' l_name anns
24+ XRoleAnnotDecl _ -> notImplemented "XRoleAnnotDecl"
2025
2126p_roleAnnot' :: Located RdrName -> [Located (Maybe Role)] -> R ()
2227p_roleAnnot' l_name anns = do
@@ -25,7 +30,8 @@ p_roleAnnot' l_name anns = do
2530 inci $ do
2631 p_rdrName l_name
2732 breakpoint
28− let p_role' = maybe (txt "_") p_role
33+ let
34+ p_role' = maybe (txt "_") p_role
2935 inci . sitcc $ sep breakpoint (sitcc . located' p_role') anns
3036
3137p_role :: Role -> R ()
src/Ormolu/Printer/Meat/Declaration/Rule.hs+29−28
@@ -1,61 +1,62 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
34
45module Ormolu.Printer.Meat.Declaration.Rule
5− ( p_ruleDecls,
6+ ( p_ruleDecls
67 )
78where
89
910import BasicTypes
10−import Control.Monad (unless)
11+import Control.Monad
1112import GHC
1213import Ormolu.Printer.Combinators
1314import Ormolu.Printer.Meat.Common
1415import Ormolu.Printer.Meat.Declaration.Signature
1516import Ormolu.Printer.Meat.Declaration.Value
16−import Ormolu.Printer.Meat.Type
17+import Ormolu.Utils
1718
1819p_ruleDecls :: RuleDecls GhcPs -> R ()
1920p_ruleDecls = \case
20− HsRules NoExtField _ xs ->
21− pragma "RULES" $
22− sep breakpoint (sitcc . located' p_ruleDecl) xs
23− XRuleDecls x -> noExtCon x
21+ HsRules NoExt _ xs -> pragma "RULES" . sitcc $
22+ sep breakpoint (sitcc . located' p_ruleDecl) xs
23+ XRuleDecls NoExt -> notImplemented "XRuleDecls"
2424
2525p_ruleDecl :: RuleDecl GhcPs -> R ()
2626p_ruleDecl = \case
27− HsRule NoExtField ruleName activation tyvars ruleBndrs lhs rhs -> do
27+ HsRule NoExt ruleName activation ruleBndrs lhs rhs -> do
2828 located ruleName p_ruleName
29− space
29+ let gotBinders = not (null ruleBndrs)
30+ when (visibleActivation activation || gotBinders) space
3031 p_activation activation
31− space
32− case tyvars of
33− Nothing -> return ()
34− Just xs -> do
35− p_forallBndrs ForallInvis p_hsTyVarBndr xs
36− space
37− -- It appears that there is no way to tell if there was an empty forall
38− -- in the input or no forall at all. We do not want to add redundant
39− -- foralls, so let's just skip the empty ones.
40− unless (null ruleBndrs) $
41− p_forallBndrs ForallInvis p_ruleBndr ruleBndrs
32+ when (visibleActivation activation && gotBinders) space
33+ p_ruleBndrs ruleBndrs
4234 breakpoint
4335 inci $ do
4436 located lhs p_hsExpr
45− space
46− equals
37+ txt " ="
4738 inci $ do
4839 breakpoint
4940 located rhs p_hsExpr
50− XRuleDecl x -> noExtCon x
41+ XRuleDecl NoExt -> notImplemented "XRuleDecl"
5142
5243p_ruleName :: (SourceText, RuleName) -> R ()
53−p_ruleName (_, name) = atom $ (HsString NoSourceText name :: HsLit GhcPs)
44+p_ruleName (_, name) = atom $ HsString NoSourceText name
45+
46+p_ruleBndrs :: [LRuleBndr GhcPs] -> R ()
47+p_ruleBndrs [] = return ()
48+p_ruleBndrs bndrs =
49+ switchLayout (getLoc <$> bndrs) $ do
50+ txt "forall"
51+ breakpoint
52+ inci $ do
53+ sitcc $ sep breakpoint (sitcc . located' p_ruleBndr) bndrs
54+ txt "."
5455
5556p_ruleBndr :: RuleBndr GhcPs -> R ()
5657p_ruleBndr = \case
57− RuleBndr NoExtField x -> p_rdrName x
58− RuleBndrSig NoExtField x hswc -> parens N $ do
58+ RuleBndr NoExt x -> p_rdrName x
59+ RuleBndrSig NoExt x hswc -> parens $ do
5960 p_rdrName x
6061 p_typeAscription hswc
61− XRuleBndr x -> noExtCon x
62+ XRuleBndr NoExt -> notImplemented "XRuleBndr"
src/Ormolu/Printer/Meat/Declaration/Signature.hs+113−153
@@ -1,13 +1,14 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
44
55-- | Type signature declarations.
6+
67module Ormolu.Printer.Meat.Declaration.Signature
7− ( p_sigDecl,
8− p_typeAscription,
9− p_activation,
10− p_standaloneKindSig,
8+ ( p_sigDecl
9+ , p_typeAscription
10+ , p_activation
11+ , visibleActivation
1112 )
1213where
1314
@@ -22,81 +23,65 @@ import Ormolu.Utils
2223
2324p_sigDecl :: Sig GhcPs -> R ()
2425p_sigDecl = \case
25− TypeSig NoExtField names hswc -> p_typeSig True names hswc
26− PatSynSig NoExtField names hsib -> p_patSynSig names hsib
27− ClassOpSig NoExtField def names hsib -> p_classOpSig def names hsib
28− FixSig NoExtField sig -> p_fixSig sig
29− InlineSig NoExtField name inlinePragma -> p_inlineSig name inlinePragma
30− SpecSig NoExtField name ts inlinePragma -> p_specSig name ts inlinePragma
31− SpecInstSig NoExtField _ hsib -> p_specInstSig hsib
32− MinimalSig NoExtField _ booleanFormula -> p_minimalSig booleanFormula
33− CompleteMatchSig NoExtField _sourceText cs ty -> p_completeSig cs ty
34− SCCFunSig NoExtField _ name literal -> p_sccSig name literal
26+ TypeSig NoExt names hswc -> p_typeSig names hswc
27+ PatSynSig NoExt names hsib -> p_patSynSig names hsib
28+ ClassOpSig NoExt def names hsib -> p_classOpSig def names hsib
29+ FixSig NoExt sig -> p_fixSig sig
30+ InlineSig NoExt name inlinePragma -> p_inlineSig name inlinePragma
31+ SpecSig NoExt name ts inlinePragma -> p_specSig name ts inlinePragma
32+ SpecInstSig NoExt _ hsib -> p_specInstSig hsib
33+ MinimalSig NoExt _ booleanFormula -> p_minimalSig booleanFormula
34+ CompleteMatchSig NoExt _sourceText cs ty -> p_completeSig cs ty
35+ SCCFunSig NoExt _ name literal -> p_sccSig name literal
3536 _ -> notImplemented "certain types of signature declarations"
3637
37−p_typeSig ::
38− -- | Should the tail of the names be indented
39− Bool ->
40− -- | Names (before @::@)
41− [Located RdrName] ->
42− -- | Type
43− LHsSigWcType GhcPs ->
44− R ()
45−p_typeSig _ [] _ = return () -- should not happen though
46−p_typeSig indentTail (n : ns) hswc = do
38+p_typeSig
39+ :: [Located RdrName] -- ^ Names (before @::@)
40+ -> LHsSigWcType GhcPs -- ^ Type
41+ -> R ()
42+p_typeSig [] _ = return () -- should not happen though
43+p_typeSig (n:ns) hswc = do
4744 p_rdrName n
4845 if null ns
4946 then p_typeAscription hswc
50− else inciIf indentTail $ do
51− commaDel
52− sep commaDel p_rdrName ns
47+ else inci $ do
48+ comma
49+ breakpoint
50+ sep (comma >> breakpoint) p_rdrName ns
5351 p_typeAscription hswc
5452
55−p_typeAscription ::
56− LHsSigWcType GhcPs ->
57− R ()
58−p_typeAscription HsWC {..} = inci $ do
59− space
60− txt "::"
61− let t = hsib_body hswc_body
62− if hasDocStrings (unLoc t)
63− then newline
64− else breakpoint
65− located t p_hsType
66−p_typeAscription (XHsWildCardBndrs x) = noExtCon x
67−
68−p_patSynSig ::
69− [Located RdrName] ->
70− HsImplicitBndrs GhcPs (LHsType GhcPs) ->
71− R ()
53+p_typeAscription
54+ :: LHsSigWcType GhcPs
55+ -> R ()
56+p_typeAscription HsWC {..} = do
57+ breakpoint
58+ inci $ do
59+ txt ":: "
60+ located (hsib_body hswc_body) p_hsType
61+p_typeAscription (XHsWildCardBndrs NoExt) = notImplemented "XHsWildCardBndrs"
62+
63+p_patSynSig
64+ :: [Located RdrName]
65+ -> HsImplicitBndrs GhcPs (LHsType GhcPs)
66+ -> R ()
7267p_patSynSig names hsib = do
73− txt "pattern"
74− let body =
75− p_typeSig
76− False
77− names
78− HsWC {hswc_ext = NoExtField, hswc_body = hsib}
79− if length names > 1
80− then breakpoint >> inci body
81− else space >> body
82−
83−p_classOpSig ::
84− -- | Whether this is a \"default\" signature
85− Bool ->
86− -- | Names (before @::@)
87− [Located RdrName] ->
88− -- | Type
89− HsImplicitBndrs GhcPs (LHsType GhcPs) ->
90− R ()
91−p_classOpSig def names hsib = do
92− when def (txt "default" >> space)
93− p_typeSig True names HsWC {hswc_ext = NoExtField, hswc_body = hsib}
94−
95−p_fixSig ::
96− FixitySig GhcPs ->
97− R ()
68+ txt "pattern "
69+ p_typeSig names HsWC {hswc_ext = NoExt, hswc_body = hsib}
70+
71+p_classOpSig
72+ :: Bool -- ^ Whether this is a \"default\" signature
73+ -> [Located RdrName] -- ^ Names (before @::@)
74+ -> HsImplicitBndrs GhcPs (LHsType GhcPs) -- ^ Type
75+ -> R ()
76+p_classOpSig def names hsib = do
77+ when def (txt "default ")
78+ p_typeSig names HsWC {hswc_ext = NoExt, hswc_body = hsib}
79+
80+p_fixSig
81+ :: FixitySig GhcPs
82+ -> R ()
9883p_fixSig = \case
99− FixitySig NoExtField names (Fixity _ n dir) -> do
84+ FixitySig NoExt names (Fixity _ n dir) -> do
10085 txt $ case dir of
10186 InfixL -> "infixl"
10287 InfixR -> "infixr"
@@ -104,53 +89,45 @@ p_fixSig = \case
10489 space
10590 atom n
10691 space
107− sitcc $ sep commaDel p_rdrName names
108− XFixitySig x -> noExtCon x
109−
110−p_inlineSig ::
111− -- | Name
112− Located RdrName ->
113− -- | Inline pragma specification
114− InlinePragma ->
115− R ()
92+ sitcc $ sep (comma >> breakpoint) p_rdrName names
93+ XFixitySig NoExt -> notImplemented "XFixitySig"
94+
95+p_inlineSig
96+ :: Located RdrName -- ^ Name
97+ -> InlinePragma -- ^ Inline pragma specification
98+ -> R ()
11699p_inlineSig name InlinePragma {..} = pragmaBraces $ do
117100 p_inlineSpec inl_inline
118− space
119101 case inl_rule of
120− ConLike -> txt "CONLIKE"
102+ ConLike -> txt "CONLIKE "
121103 FunLike -> return ()
122− space
123104 p_activation inl_act
124− space
105+ when (visibleActivation inl_act) space
125106 p_rdrName name
126107
127−p_specSig ::
128− -- | Name
129− Located RdrName ->
130− -- | The types to specialize to
131− [LHsSigType GhcPs] ->
132− -- | For specialize inline
133− InlinePragma ->
134− R ()
108+p_specSig
109+ :: Located RdrName -- ^ Name
110+ -> [LHsSigType GhcPs] -- ^ The types to specialize to
111+ -> InlinePragma -- ^ For specialize inline
112+ -> R ()
135113p_specSig name ts InlinePragma {..} = pragmaBraces $ do
136114 txt "SPECIALIZE"
137115 space
138116 p_inlineSpec inl_inline
139− space
140117 p_activation inl_act
141− space
118+ when (visibleActivation inl_act) space
142119 p_rdrName name
143− space
144− txt "::"
145120 breakpoint
146− inci $ sep commaDel (located' p_hsType . hsib_body) ts
121+ inci $ do
122+ txt ":: "
123+ sep (comma >> breakpoint) (located' p_hsType . hsib_body) ts
147124
148125p_inlineSpec :: InlineSpec -> R ()
149−p_inlineSpec = \case
150− Inline -> txt "INLINE"
151− Inlinable -> txt "INLINEABLE"
152− NoInline -> txt "NOINLINE"
153− NoUserInline -> return ()
126+p_inlineSpec = txt . \case
127+ Inline -> "INLINE "
128+ Inlinable -> "INLINEABLE "
129+ NoInline -> "NOINLINE "
130+ NoUserInline -> ""
154131
155132p_activation :: Activation -> R ()
156133p_activation = \case
@@ -165,54 +142,51 @@ p_activation = \case
165142 atom n
166143 txt "]"
167144
145+visibleActivation :: Activation -> Bool
146+visibleActivation = \case
147+ NeverActive -> False
148+ AlwaysActive -> False
149+ _ -> True
150+
168151p_specInstSig :: LHsSigType GhcPs -> R ()
169−p_specInstSig hsib =
170− pragma "SPECIALIZE instance" . inci $
171− located (hsib_body hsib) p_hsType
172−
173−p_minimalSig ::
174− -- | Boolean formula
175− LBooleanFormula (Located RdrName) ->
176− R ()
152+p_specInstSig hsib = pragma "SPECIALIZE instance" . inci $
153+ located (hsib_body hsib) p_hsType
154+
155+p_minimalSig
156+ :: LBooleanFormula (Located RdrName) -- ^ Boolean formula
157+ -> R ()
177158p_minimalSig =
178159 located' $ \booleanFormula ->
179160 pragma "MINIMAL" (inci $ p_booleanFormula booleanFormula)
180161
181−p_booleanFormula ::
182− -- | Boolean formula
183− BooleanFormula (Located RdrName) ->
184− R ()
162+p_booleanFormula
163+ :: BooleanFormula (Located RdrName) -- ^ Boolean formula
164+ -> R ()
185165p_booleanFormula = \case
186166 Var name -> p_rdrName name
187− And xs ->
188− sitcc $
189− sep
190− commaDel
191− (located' p_booleanFormula)
192− xs
193− Or xs ->
194− sitcc $
195− sep
196− (breakpoint >> txt "|" >> space)
197− (located' p_booleanFormula)
198− xs
199− Parens l -> located l (parens N . p_booleanFormula)
200−
201−p_completeSig ::
202− -- | Constructors\/patterns
203− Located [Located RdrName] ->
204− -- | Type
205− Maybe (Located RdrName) ->
206− R ()
167+ And xs -> sitcc $ sep
168+ (comma >> breakpoint)
169+ (located' p_booleanFormula)
170+ xs
171+ Or xs -> sitcc $ sep
172+ (breakpoint >> txt "| ")
173+ (located' p_booleanFormula)
174+ xs
175+ Parens l -> located l (parens . p_booleanFormula)
176+
177+p_completeSig
178+ :: Located [Located RdrName] -- ^ Constructors\/patterns
179+ -> Maybe (Located RdrName) -- ^ Type
180+ -> R ()
207181p_completeSig cs' mty =
208182 located cs' $ \cs ->
209183 pragma "COMPLETE" . inci $ do
210− sep commaDel p_rdrName cs
184+ sitcc $ sep (comma >> breakpoint) p_rdrName cs
211185 forM_ mty $ \ty -> do
212− space
213− txt "::"
214186 breakpoint
215− inci (p_rdrName ty)
187+ inci $ do
188+ txt ":: "
189+ p_rdrName ty
216190
217191p_sccSig :: Located (IdP GhcPs) -> Maybe (Located StringLiteral) -> R ()
218192p_sccSig loc literal = pragma "SCC" . inci $ do
@@ -220,17 +194,3 @@ p_sccSig loc literal = pragma "SCC" . inci $ do
220194 forM_ literal $ \x -> do
221195 breakpoint
222196 atom x
223−
224−p_standaloneKindSig :: StandaloneKindSig GhcPs -> R ()
225−p_standaloneKindSig (StandaloneKindSig NoExtField name bndrs) = do
226− txt "type"
227− inci $ do
228− space
229− p_rdrName name
230− space
231− txt "::"
232− breakpoint
233− case bndrs of
234− HsIB NoExtField sig -> located sig p_hsType
235− XHsImplicitBndrs x -> noExtCon x
236−p_standaloneKindSig (XStandaloneKindSig c) = noExtCon c
src/Ormolu/Printer/Meat/Declaration/Splice.hs+4−3
@@ -1,15 +1,16 @@
11{-# LANGUAGE LambdaCase #-}
22
33module Ormolu.Printer.Meat.Declaration.Splice
4− ( p_spliceDecl,
4+ ( p_spliceDecl
55 )
66where
77
88import GHC
99import Ormolu.Printer.Combinators
1010import Ormolu.Printer.Meat.Declaration.Value (p_hsSplice)
11+import Ormolu.Utils
1112
1213p_spliceDecl :: SpliceDecl GhcPs -> R ()
1314p_spliceDecl = \case
14− SpliceDecl NoExtField splice _explicit -> located splice p_hsSplice
15− XSpliceDecl x -> noExtCon x
15+ SpliceDecl NoExt splice _explicit -> located splice p_hsSplice
16+ XSpliceDecl {} -> notImplemented "XSpliceDecl"
src/Ormolu/Printer/Meat/Declaration/Type.hs+18−24
@@ -1,9 +1,10 @@
11{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE RecordWildCards #-}
33
44-- | Rendering of type synonym declarations.
5+
56module Ormolu.Printer.Meat.Declaration.Type
6− ( p_synDecl,
7+ ( p_synDecl
78 )
89where
910
@@ -11,30 +12,23 @@ import GHC
1112import Ormolu.Printer.Combinators
1213import Ormolu.Printer.Meat.Common
1314import Ormolu.Printer.Meat.Type
15+import RdrName (RdrName (..))
16+import SrcLoc (Located)
1417
15−p_synDecl ::
16− -- | Type constructor
17− Located RdrName ->
18− -- | Fixity
19− LexicalFixity ->
20− -- | Type variables
21− LHsQTyVars GhcPs ->
22− -- | RHS of type declaration
23− LHsType GhcPs ->
24− R ()
25−p_synDecl name fixity HsQTvs {..} t = do
26− txt "type"
27− space
28− switchLayout (getLoc name : map getLoc hsq_explicit) $
18+p_synDecl
19+ :: Located RdrName -- ^ Type constructor
20+ -> LexicalFixity -- ^ Fixity
21+ -> LHsQTyVars GhcPs -- ^ Type variables
22+ -> LHsType GhcPs -- ^ RHS of type declaration
23+ -> R ()
24+p_synDecl name fixity tvars t = do
25+ txt "type "
26+ let HsQTvs {..} = tvars
27+ switchLayout (getLoc name : map getLoc hsq_explicit) $ do
2928 p_infixDefHelper
3029 (case fixity of Infix -> True; _ -> False)
31− True
30+ inci
3231 (p_rdrName name)
3332 (map (located' p_hsTyVarBndr) hsq_explicit)
34− space
35− equals
36− if hasDocStrings (unLoc t)
37− then newline
38− else breakpoint
39− inci (located t p_hsType)
40−p_synDecl _ _ (XLHsQTyVars x) _ = noExtCon x
33+ breakpoint
34+ inci (txt "= " >> located t p_hsType)
src/Ormolu/Printer/Meat/Declaration/TypeFamily.hs+45−58
@@ -1,24 +1,27 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
44
55-- | Rendering of data\/type families.
6+
67module Ormolu.Printer.Meat.Declaration.TypeFamily
7− ( p_famDecl,
8− p_tyFamInstEqn,
8+ ( p_famDecl
9+ , p_tyFamInstEqn
910 )
1011where
1112
13+import BasicTypes (LexicalFixity (..))
1214import Control.Monad
13−import Data.Maybe (isNothing)
15+import Data.Maybe (isNothing, isJust)
1416import GHC
1517import Ormolu.Printer.Combinators
1618import Ormolu.Printer.Meat.Common
1719import Ormolu.Printer.Meat.Type
1820import Ormolu.Utils
21+import SrcLoc (Located, GenLocated (..))
1922
2023p_famDecl :: FamilyStyle -> FamilyDecl GhcPs -> R ()
21−p_famDecl style FamilyDecl {fdTyVars = HsQTvs {..}, ..} = do
24+p_famDecl style FamilyDecl {..} = do
2225 mmeqs <- case fdInfo of
2326 DataFamily -> Nothing <$ txt "data"
2427 OpenTypeFamily -> Nothing <$ txt "type"
@@ -26,86 +29,70 @@ p_famDecl style FamilyDecl {fdTyVars = HsQTvs {..}, ..} = do
2629 txt $ case style of
2730 Associated -> mempty
2831 Free -> " family"
32+ let HsQTvs {..} = fdTyVars
2933 breakpoint
3034 inci $ do
31− switchLayout (getLoc fdLName : (getLoc <$> hsq_explicit)) $
35+ switchLayout (getLoc fdLName : (getLoc <$> hsq_explicit)) $ do
3236 p_infixDefHelper
3337 (isInfix fdFixity)
34− True
38+ inci
3539 (p_rdrName fdLName)
3640 (located' p_hsTyVarBndr <$> hsq_explicit)
37− let resultSig = p_familyResultSigL fdResultSig
38− unless (isNothing resultSig && isNothing fdInjectivityAnn) space
41+ let rsig = p_familyResultSigL (isJust fdInjectivityAnn) fdResultSig
42+ unless (isNothing rsig && isNothing fdInjectivityAnn) $
43+ breakpoint
3944 inci $ do
40− sequence_ resultSig
41− space
45+ sequence_ rsig
46+ when (isJust rsig && isJust fdInjectivityAnn) breakpoint
4247 forM_ fdInjectivityAnn (located' p_injectivityAnn)
4348 case mmeqs of
4449 Nothing -> return ()
4550 Just meqs -> do
46− inci $ do
47− breakpoint
48− txt "where"
51+ txt " where"
4952 case meqs of
50− Nothing -> do
51− space
52− txt ".."
53+ Nothing -> txt " .."
5354 Just eqs -> do
5455 newline
5556 sep newline (located' (inci . p_tyFamInstEqn)) eqs
56−p_famDecl _ FamilyDecl {fdTyVars = XLHsQTyVars {}} =
57− notImplemented "XLHsQTyVars"
58−p_famDecl _ (XFamilyDecl x) = noExtCon x
57+p_famDecl _ (XFamilyDecl NoExt) = notImplemented "XFamilyDecl"
5958
60−p_familyResultSigL ::
61− Located (FamilyResultSig GhcPs) ->
62− Maybe (R ())
63−p_familyResultSigL l =
59+p_familyResultSigL
60+ :: Bool
61+ -> Located (FamilyResultSig GhcPs)
62+ -> Maybe (R ())
63+p_familyResultSigL injAnn l =
6464 case l of
6565 L _ a -> case a of
66− NoSig NoExtField -> Nothing
67− KindSig NoExtField k -> Just $ do
68− txt "::"
69− breakpoint
66+ NoSig NoExt -> Nothing
67+ KindSig NoExt k -> Just $ do
68+ if injAnn then txt "= " else txt ":: "
7069 located k p_hsType
71− TyVarSig NoExtField bndr -> Just $ do
72− equals
73− breakpoint
70+ TyVarSig NoExt bndr -> Just $ do
71+ if injAnn then txt "= " else txt ":: "
7472 located bndr p_hsTyVarBndr
75− XFamilyResultSig x ->
76− noExtCon x
73+ XFamilyResultSig NoExt ->
74+ notImplemented "XFamilyResultSig"
7775
7876p_injectivityAnn :: InjectivityAnn GhcPs -> R ()
7977p_injectivityAnn (InjectivityAnn a bs) = do
80− txt "|"
81− space
78+ txt "| "
8279 p_rdrName a
8380 space
84− txt "->"
85− space
81+ txt "-> "
8682 sep space p_rdrName bs
8783
8884p_tyFamInstEqn :: TyFamInstEqn GhcPs -> R ()
89−p_tyFamInstEqn HsIB {hsib_body = FamEqn {..}} = do
90− case feqn_bndrs of
91− Nothing -> return ()
92− Just bndrs -> do
93− p_forallBndrs ForallInvis p_hsTyVarBndr bndrs
94− breakpoint
95− inciIf (not $ null feqn_bndrs) $ do
96− let famLhsSpn = getLoc feqn_tycon : fmap (getLoc . typeArgToType) feqn_pats
97− switchLayout famLhsSpn $
98− p_infixDefHelper
99− (isInfix feqn_fixity)
100− True
101− (p_rdrName feqn_tycon)
102− (located' p_hsType . typeArgToType <$> feqn_pats)
103− space
104− equals
105− breakpoint
106− inci (located feqn_rhs p_hsType)
107−p_tyFamInstEqn HsIB {hsib_body = XFamEqn x} = noExtCon x
108−p_tyFamInstEqn (XHsImplicitBndrs x) = noExtCon x
85+p_tyFamInstEqn HsIB {..} = do
86+ let FamEqn {..} = hsib_body
87+ switchLayout (getLoc feqn_tycon : (getLoc <$> feqn_pats)) $ p_infixDefHelper
88+ (isInfix feqn_fixity)
89+ inci
90+ (p_rdrName feqn_tycon)
91+ (located' p_hsType <$> feqn_pats)
92+ txt " ="
93+ breakpoint
94+ inci (located feqn_rhs p_hsType)
95+p_tyFamInstEqn (XHsImplicitBndrs NoExt) = notImplemented "XHsImplicitBndrs"
10996
11097----------------------------------------------------------------------------
11198-- Helpers
src/Ormolu/Printer/Meat/Declaration/Value.hs+524−917
@@ -1,43 +1,36 @@
1−{-# LANGUAGE LambdaCase #-}
2−{-# LANGUAGE MultiWayIf #-}
1+{-# LANGUAGE LambdaCase #-}
32{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE RecordWildCards #-}
5−{-# LANGUAGE TypeApplications #-}
3+{-# LANGUAGE RecordWildCards #-}
64
75module Ormolu.Printer.Meat.Declaration.Value
8− ( p_valDecl,
9− p_pat,
10− p_hsExpr,
11− p_hsSplice,
12− p_stringLit,
6+ ( p_valDecl
7+ , p_pat
8+ , p_hsExpr
9+ , p_hsSplice
1310 )
1411where
1512
13+import Ormolu.Printer.Internal
1614import Bag (bagToList)
1715import BasicTypes
1816import Control.Monad
19−import Ctype (is_space)
2017import Data.Bool (bool)
2118import Data.Char (isPunctuation, isSymbol)
2219import Data.Data hiding (Infix, Prefix)
23−import Data.Functor ((<&>))
2420import Data.List (intersperse, sortOn)
25−import Data.List.NonEmpty (NonEmpty (..), (<|))
26−import qualified Data.List.NonEmpty as NE
2721import Data.Text (Text)
28−import qualified Data.Text as Text
2922import GHC
30−import OccName (occNameString)
3123import Ormolu.Printer.Combinators
32−import Ormolu.Printer.Internal
3324import Ormolu.Printer.Meat.Common
34−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
3525import Ormolu.Printer.Meat.Declaration.Signature
3626import Ormolu.Printer.Meat.Type
37−import Ormolu.Printer.Operators
3827import Ormolu.Utils
28+import Outputable (Outputable (..))
29+import RdrName (rdrNameOcc)
30+import SrcLoc (combineSrcSpans, isOneLineSpan)
31+import qualified Data.List.NonEmpty as NE
32+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
3933
40−-- | Style of a group of equations.
4134data MatchGroupStyle
4235 = Function (Located RdrName)
4336 | PatternBind
@@ -45,62 +38,55 @@ data MatchGroupStyle
4538 | Lambda
4639 | LambdaCase
4740
48−-- | Style of equations in a group.
4941data GroupStyle
5042 = EqualSign
5143 | RightArrow
5244
5345-- | Expression placement. This marks the places where expressions that
5446-- implement handing forms may use them.
47+
5548data Placement
56− = -- | Multi-line layout should cause
57− -- insertion of a newline and indentation
58− -- bump
59− Normal
60− | -- | Expressions that have hanging form
61− -- should use it and avoid bumping one level
62− -- of indentation
63− Hanging
64− deriving (Eq, Show)
49+ = Normal -- ^ Multi-line layout should cause
50+ -- insertion of a newline and indentation
51+ -- bump
52+ | Hanging -- ^ Expressions that have hanging form
53+ -- should use it and avoid bumping one level
54+ -- of indentation
6555
6656p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
6757p_valDecl = \case
68− FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
69− PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
58+ FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
59+ PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
7060 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
7161 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
72− PatSynBind NoExtField psb -> p_patSynBind psb
73− XHsBindsLR x -> noExtCon x
62+ PatSynBind NoExt psb -> p_patSynBind psb
63+ XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
7464
75−p_funBind ::
76− Located RdrName ->
77− MatchGroup GhcPs (LHsExpr GhcPs) ->
78− R ()
65+p_funBind
66+ :: Located RdrName
67+ -> MatchGroup GhcPs (LHsExpr GhcPs)
68+ -> R ()
7969p_funBind name = p_matchGroup (Function name)
8070
81−p_matchGroup ::
82− MatchGroupStyle ->
83− MatchGroup GhcPs (LHsExpr GhcPs) ->
84− R ()
71+p_matchGroup
72+ :: MatchGroupStyle
73+ -> MatchGroup GhcPs (LHsExpr GhcPs)
74+ -> R ()
8575p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
8676
87−p_matchGroup' ::
88− Data body =>
89− -- | How to get body placement
90− (body -> Placement) ->
91− -- | How to print body
92− (body -> R ()) ->
93− -- | Style of this group of equations
94− MatchGroupStyle ->
95− -- | Match group
96− MatchGroup GhcPs (Located body) ->
97− R ()
98−p_matchGroup' placer render style MG {..} = do
77+p_matchGroup'
78+ :: Data body
79+ => (body -> Placement)
80+ -> (body -> R ())
81+ -> MatchGroupStyle
82+ -> MatchGroup GhcPs (Located body)
83+ -> R ()
84+p_matchGroup' placer pretty style MG {..} = do
9985 let ob = case style of
10086 Case -> id
10187 LambdaCase -> id
10288 _ -> dontUseBraces
103− -- Since we are forcing braces on 'sepSemi' based on 'ob', we have to
89+ -- NOTE since we are forcing braces on 'sepSemi' based on 'ob', we have to
10490 -- restore the brace state inside the sepsemi.
10591 ub <- bool dontUseBraces useBraces <$> canUseBraces
10692 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -108,14 +94,14 @@ p_matchGroup' placer render style MG {..} = do
10894 p_Match m@Match {..} =
10995 p_match'
11096 placer
111− render
97+ pretty
11298 (adjustMatchGroupStyle m style)
11399 (isInfixMatch m)
114100 (matchStrictness m)
115101 m_pats
116102 m_grhss
117− p_Match (XMatch x) = noExtCon x
118−p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
103+ p_Match _ = notImplemented "XMatch"
104+p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
119105
120106-- | Function id obtained through pattern matching on 'FunBind' should not
121107-- be used to print the actual equations because the different ‘RdrNames’
@@ -123,10 +109,11 @@ p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
123109-- and paretheses) associated with them. It is necessary to use per-equation
124110-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
125111-- name inside of 'Function' accordingly.
126−adjustMatchGroupStyle ::
127− Match GhcPs body ->
128− MatchGroupStyle ->
129− MatchGroupStyle
112+
113+adjustMatchGroupStyle
114+ :: Match GhcPs body
115+ -> MatchGroupStyle
116+ -> MatchGroupStyle
130117adjustMatchGroupStyle m = \case
131118 Function _ -> (Function . mc_fun . m_ctxt) m
132119 style -> style
@@ -134,43 +121,31 @@ adjustMatchGroupStyle m = \case
134121matchStrictness :: Match id body -> SrcStrictness
135122matchStrictness match =
136123 case m_ctxt match of
137− FunRhs {mc_strictness = s} -> s
124+ FunRhs{mc_strictness=s} -> s
138125 _ -> NoSrcStrict
139126
140−p_match ::
141− -- | Style of the group
142− MatchGroupStyle ->
143− -- | Is this an infix match?
144− Bool ->
145− -- | Strictness prefix (FunBind)
146− SrcStrictness ->
147− -- | Argument patterns
148− [LPat GhcPs] ->
149− -- | Equations
150− GRHSs GhcPs (LHsExpr GhcPs) ->
151− R ()
127+p_match
128+ :: MatchGroupStyle
129+ -> Bool -- ^ Is this an infix match?
130+ -> SrcStrictness -- ^ Strictness prefix (FunBind)
131+ -> [LPat GhcPs]
132+ -> GRHSs GhcPs (LHsExpr GhcPs)
133+ -> R ()
152134p_match = p_match' exprPlacement p_hsExpr
153135
154−p_match' ::
155− Data body =>
156− -- | How to get body placement
157− (body -> Placement) ->
158− -- | How to print body
159− (body -> R ()) ->
160− -- | Style of this group of equations
161− MatchGroupStyle ->
162− -- | Is this an infix match?
163− Bool ->
164− -- | Strictness prefix (FunBind)
165− SrcStrictness ->
166− -- | Argument patterns
167− [LPat GhcPs] ->
168− -- | Equations
169− GRHSs GhcPs (Located body) ->
170− R ()
171−p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
172− -- Normally, since patterns may be placed in a multi-line layout, it is
173− -- necessary to bump indentation for the pattern group so it's more
136+p_match'
137+ :: Data body
138+ => (body -> Placement)
139+ -> (body -> R ())
140+ -> MatchGroupStyle
141+ -> Bool -- ^ Is this an infix match?
142+ -> SrcStrictness -- ^ Strictness prefix (FunBind)
143+ -> [LPat GhcPs]
144+ -> GRHSs GhcPs (Located body)
145+ -> R ()
146+p_match' placer pretty style isInfix strictness m_pats m_grhss = do
147+ -- NOTE Normally, since patterns may be placed in a multi-line layout, it
148+ -- is necessary to bump indentation for the pattern group so it's more
174149 -- indented than function name. This in turn means that indentation for
175150 -- the body should also be bumped. Normally this would mean that bodies
176151 -- would start with two indentation steps applied, which is ugly, so we
@@ -180,24 +155,23 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
180155 NoSrcStrict -> return ()
181156 SrcStrict -> txt "!"
182157 SrcLazy -> txt "~"
183− indentBody <- case NE.nonEmpty m_pats of
184− Nothing ->
185− False <$ case style of
186− Function name -> p_rdrName name
187− _ -> return ()
158+ inci' <- case NE.nonEmpty m_pats of
159+ Nothing -> id <$ case style of
160+ Function name -> p_rdrName name
161+ _ -> return ()
188162 Just ne_pats -> do
189− let combinedSpans = case style of
190− Function name -> combineSrcSpans (getLoc name) patSpans
191− _ -> patSpans
192− patSpans = combineSrcSpans' (getLoc <$> ne_pats)
193− indentBody = not (isOneLineSpan combinedSpans)
163+ let combinedSpans = combineSrcSpans' $
164+ getLoc <$> ne_pats
165+ inci' = if isOneLineSpan combinedSpans
166+ then id
167+ else inci
194168 switchLayout [combinedSpans] $ do
195169 let stdCase = sep breakpoint (located' p_pat) m_pats
196170 case style of
197171 Function name ->
198172 p_infixDefHelper
199173 isInfix
200− indentBody
174+ inci'
201175 (p_rdrName name)
202176 (located' p_pat <$> m_pats)
203177 PatternBind -> stdCase
@@ -208,44 +182,49 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
208182 BangPat _ _ -> True
209183 SplicePat _ _ -> True
210184 _ -> False
211− txt "\\"
212− when needsSpace space
213− sitcc stdCase
185+ txt (if needsSpace then "\\ " else "\\")
186+ stdCase
214187 LambdaCase -> stdCase
215− return indentBody
216− let -- Calculate position of end of patterns. This is useful when we decide
217− -- about putting certain constructions in hanging positions.
218− endOfPats = case NE.nonEmpty m_pats of
219− Nothing -> case style of
220− Function name -> Just (getLoc name)
221− _ -> Nothing
222− Just pats -> (Just . getLoc . NE.last) pats
223− isCase = \case
224− Case -> True
225− LambdaCase -> True
226− _ -> False
188+ return inci'
189+ let
190+ -- Calculate position of end of patterns. This is useful when we decide
191+ -- about putting certain constructions in hanging positions.
192+ endOfPats = case NE.nonEmpty m_pats of
193+ Nothing -> case style of
194+ Function name -> (Just . srcSpanEnd . getLoc) name
195+ _ -> Nothing
196+ Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
197+ isCase = \case
198+ Case -> True
199+ LambdaCase -> True
200+ _ -> False
201+ let GRHSs {..} = m_grhss
227202 hasGuards = withGuards grhssGRHSs
228− grhssSpan =
229− combineSrcSpans' $
230− getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
231− patGrhssSpan =
232− maybe
233− grhssSpan
234− (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
235− endOfPats
203+ unless (length grhssGRHSs > 1) $ do
204+ case style of
205+ Function _ | hasGuards -> return ()
206+ Function _ -> txt " ="
207+ PatternBind -> txt " ="
208+ s | isCase s && hasGuards -> return ()
209+ _ -> txt " ->"
210+ let grhssSpan = combineSrcSpans' $
211+ getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
212+ patGrhssSpan = maybe grhssSpan
213+ (combineSrcSpans grhssSpan . srcLocSpan) endOfPats
236214 placement =
237215 case endOfPats of
238216 Nothing -> blockPlacement placer grhssGRHSs
239217 Just spn ->
240− if onTheSameLine spn grhssSpan
218+ if isOneLineSpan
219+ (mkSrcSpan spn (srcSpanStart grhssSpan))
241220 then blockPlacement placer grhssGRHSs
242221 else Normal
243222 p_body = do
244223 let groupStyle =
245224 if isCase style && hasGuards
246− then RightArrow
247− else EqualSign
248− sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
225+ then RightArrow
226+ else EqualSign
227+ sep newline (located' (p_grhs' pretty groupStyle)) grhssGRHSs
249228 p_where = do
250229 let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
251230 unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
@@ -253,211 +232,166 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
253232 txt "where"
254233 unless whereIsEmpty breakpoint
255234 inci $ located grhssLocalBinds p_hsLocalBinds
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 "->"
235+ inci' $ do
264236 switchLayout [patGrhssSpan] $
265237 placeHanging placement p_body
266238 inci p_where
267−p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
268239
269240p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
270−p_grhs = p_grhs' exprPlacement p_hsExpr
271−
272−p_grhs' ::
273− Data body =>
274− -- | How to get body placement
275− (body -> Placement) ->
276− -- | How to print body
277− (body -> R ()) ->
278− GroupStyle ->
279− GRHS GhcPs (Located body) ->
280− R ()
281−p_grhs' placer render style (GRHS NoExtField guards body) =
241+p_grhs = p_grhs' p_hsExpr
242+
243+p_grhs'
244+ :: Data body
245+ => (body -> R ())
246+ -> GroupStyle
247+ -> GRHS GhcPs (Located body)
248+ -> R ()
249+p_grhs' pretty style (GRHS NoExt guards body) =
282250 case guards of
283251 [] -> p_body
284252 xs -> do
285− txt "|"
253+ txt "| "
254+ sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
286255 space
287− sitcc (sep commaDel (sitcc . located' p_stmt) xs)
288− space
289− inci $ case style of
290− EqualSign -> equals
291− RightArrow -> txt "->"
292− placeHanging placement p_body
256+ txt $ case style of
257+ EqualSign -> "="
258+ RightArrow -> "->"
259+ breakpoint
260+ inci p_body
293261 where
294− placement =
295− case endOfGuards of
296− Nothing -> placer (unLoc body)
297− Just spn ->
298− if onTheSameLine spn (getLoc body)
299− then placer (unLoc body)
300− else Normal
301− endOfGuards =
302− case NE.nonEmpty guards of
303− Nothing -> Nothing
304− Just gs -> (Just . getLoc . NE.last) gs
305− p_body = located body render
306−p_grhs' _ _ _ (XGRHS x) = noExtCon x
262+ p_body = located body pretty
263+p_grhs' _ _ (XGRHS NoExt) = notImplemented "XGRHS"
307264
308265p_hsCmd :: HsCmd GhcPs -> R ()
309266p_hsCmd = \case
310− HsCmdArrApp NoExtField body input arrType _ -> do
267+ HsCmdArrApp NoExt body input arrType _ -> do
311268 located body p_hsExpr
312− breakpoint
313− inci $ do
314− case arrType of
315− HsFirstOrderApp -> txt "-<"
316− HsHigherOrderApp -> txt "-<<"
317− placeHanging (exprPlacement (unLoc input)) $
318− located input p_hsExpr
319− HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ do
269+ txt $ case arrType of
270+ HsFirstOrderApp -> " -<"
271+ HsHigherOrderApp -> " -<<"
272+ placeHanging (exprPlacement (unLoc input)) $
273+ located input p_hsExpr
274+ HsCmdArrForm NoExt form Prefix _ cmds -> banana $ sitcc $ do
320275 located form p_hsExpr
321276 unless (null cmds) $ do
322277 breakpoint
323278 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
324− HsCmdArrForm NoExtField form Infix _ [left, right] -> do
279+ HsCmdArrForm NoExt form Infix _ [left, right] -> do
325280 located left p_hsCmdTop
326281 space
327282 located form p_hsExpr
328283 placeHanging (cmdTopPlacement (unLoc right)) $
329284 located right p_hsCmdTop
330− HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
285+ HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
331286 HsCmdApp {} ->
332287 -- XXX Does this ever occur in the syntax tree? It does not seem like it
333288 -- does. Open an issue and ping @yumiova if this ever occurs in output.
334289 notImplemented "HsCmdApp"
335− HsCmdLam NoExtField mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
336− HsCmdPar NoExtField c -> parens N (located c p_hsCmd)
337− HsCmdCase NoExtField e mgroup ->
338− p_case cmdPlacement p_hsCmd e mgroup
339− HsCmdIf NoExtField _ if' then' else' ->
340− p_if cmdPlacement p_hsCmd if' then' else'
341− HsCmdLet NoExtField localBinds c ->
342− p_let p_hsCmd localBinds c
343− HsCmdDo NoExtField es -> do
290+ HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
291+ HsCmdPar NoExt c -> parens (located c p_hsCmd)
292+ HsCmdCase NoExt e mgroup -> do
293+ txt "case "
294+ located e p_hsExpr
295+ txt " of"
296+ breakpoint
297+ inci (p_matchGroup' cmdPlacement p_hsCmd Case mgroup)
298+ HsCmdIf NoExt _ if' then' else' -> do
299+ txt "if "
300+ located if' p_hsExpr
301+ breakpoint
302+ txt "then"
303+ located then' $ \x -> do
304+ breakpoint
305+ inci (p_hsCmd x)
306+ breakpoint
307+ txt "else"
308+ located else' $ \x -> do
309+ breakpoint
310+ inci (p_hsCmd x)
311+ HsCmdLet NoExt localBinds c -> do
312+ txt "let "
313+ sitcc (located localBinds p_hsLocalBinds)
314+ breakpoint
315+ txt "in "
316+ sitcc (located c p_hsCmd)
317+ HsCmdDo NoExt es -> do
344318 txt "do"
345319 newline
346− inci . located es $
347− sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
320+ inci (located es (sitcc . sep newline (located' (sitcc . p_stmt' p_hsCmd))))
348321 HsCmdWrap {} -> notImplemented "HsCmdWrap"
349− XCmd x -> noExtCon x
322+ XCmd {} -> notImplemented "XCmd"
350323
351324p_hsCmdTop :: HsCmdTop GhcPs -> R ()
352325p_hsCmdTop = \case
353− HsCmdTop NoExtField cmd -> located cmd p_hsCmd
354− XCmdTop x -> noExtCon x
355−
356−-- | Render an expression preserving blank lines between such consecutive
357−-- expressions found in the original source code.
358−withSpacing ::
359− -- | Rendering function
360− (a -> R ()) ->
361− -- | Entity to render
362− Located a ->
363− R ()
364−withSpacing f l = located l $ \x -> do
365− case getLoc l of
366− UnhelpfulSpan _ -> f x
367− RealSrcSpan currentSpn -> do
368− getSpanMark >>= \case
369− -- Spacing before comments will be handled by the code
370− -- that prints comments, so we just have to deal with
371− -- blank lines between statements here.
372− Just (StatementSpan lastSpn) ->
373− if srcSpanStartLine currentSpn > srcSpanEndLine lastSpn + 1
374− then newline
375− else return ()
376− _ -> return ()
377− f x
378− -- In some cases the (f x) expression may insert a new mark. We want
379− -- to be careful not to override comment marks.
380− getSpanMark >>= \case
381− Just (HaddockSpan _ _) -> return ()
382− Just (CommentSpan _) -> return ()
383− _ -> setSpanMark (StatementSpan currentSpn)
326+ HsCmdTop NoExt cmd -> located cmd p_hsCmd
327+ XCmdTop {} -> notImplemented "XHsCmdTop"
384328
385329p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
386−p_stmt = p_stmt' exprPlacement p_hsExpr
387−
388−p_stmt' ::
389− Data body =>
390− -- | Placer
391− (body -> Placement) ->
392− -- | Render
393− (body -> R ()) ->
394− -- | Statement to render
395− Stmt GhcPs (Located body) ->
396− R ()
397−p_stmt' placer render = \case
398− LastStmt NoExtField body _ _ -> located body render
399− BindStmt NoExtField p f _ _ -> do
400− located p p_pat
330+p_stmt = p_stmt' p_hsExpr
331+
332+p_stmt'
333+ :: Data body
334+ => (body -> R ())
335+ -> Stmt GhcPs (Located body)
336+ -> R ()
337+p_stmt' pretty = \case
338+ LastStmt NoExt body _ _ -> located body pretty
339+ BindStmt NoExt l f _ _ -> do
340+ located l p_pat
401341 space
402342 txt "<-"
403− let loc = getLoc p
404− placement =
405− case f of
406− L l' x ->
407− if isOneLineSpan
408− (mkSrcSpan (srcSpanEnd loc) (srcSpanStart l'))
409− then placer x
410− else Normal
411− switchLayout [loc, getLoc f] $
412− placeHanging placement (located f render)
343+ breakpoint
344+ inci (located f pretty)
413345 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
414− BodyStmt NoExtField body _ _ -> located body render
415− LetStmt NoExtField binds -> do
416− txt "let"
417− space
346+ BodyStmt NoExt body _ _ -> located body pretty
347+ LetStmt NoExt binds -> do
348+ txt "let "
418349 sitcc $ located binds p_hsLocalBinds
419350 ParStmt {} ->
420− -- 'ParStmt' should always be eliminated in 'gatherStmt' already, such
421− -- that it never occurs in 'p_stmt''. Consequently, handling it here
422− -- would be redundant.
351+ -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
352+ -- such that it never occurs in 'p_stmt''. Consequently, handling it
353+ -- here would be redundant.
423354 notImplemented "ParStmt"
424− TransStmt {..} ->
425− -- 'TransStmt' only needs to account for render printing itself, since
426− -- pretty printing of relevant statements (e.g., in 'trS_stmts') is
427− -- handled through 'gatherStmt'.
355+ TransStmt {..} -> do
356+ -- NOTE 'TransStmt' only needs to account for pretty printing itself,
357+ -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
358+ -- is handled through 'gatherStmt'.
428359 case (trS_form, trS_by) of
429− (ThenForm, Nothing) -> do
360+ (ThenForm, Nothing) -> located trS_using $ \x -> do
430361 txt "then"
431362 breakpoint
432− inci $ located trS_using p_hsExpr
363+ inci (p_hsExpr x)
433364 (ThenForm, Just e) -> do
434− txt "then"
435− breakpoint
436− inci $ located trS_using p_hsExpr
437− breakpoint
438− txt "by"
365+ located trS_using $ \x -> do
366+ txt "then"
367+ breakpoint
368+ inci (p_hsExpr x)
439369 breakpoint
440− inci $ located e p_hsExpr
441− (GroupForm, Nothing) -> do
370+ located e $ \x -> do
371+ txt "by"
372+ breakpoint
373+ inci (p_hsExpr x)
374+ (GroupForm, Nothing) -> located trS_using $ \x -> do
442375 txt "then group using"
443376 breakpoint
444− inci $ located trS_using p_hsExpr
377+ inci (p_hsExpr x)
445378 (GroupForm, Just e) -> do
446− txt "then group by"
447− breakpoint
448− inci $ located e p_hsExpr
449− breakpoint
450− txt "using"
379+ located e $ \x -> do
380+ txt "then group by"
381+ breakpoint
382+ inci (p_hsExpr x)
451383 breakpoint
452− inci $ located trS_using p_hsExpr
384+ located trS_using $ \x -> do
385+ txt "using"
386+ breakpoint
387+ inci (p_hsExpr x)
453388 RecStmt {..} -> do
454− txt "rec"
455− space
456− sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457− XStmtLR c -> noExtCon c
389+ txt "rec "
390+ sitcc $ sepSemi (located' (p_stmt' pretty)) recS_stmts
391+ XStmtLR {} -> notImplemented "XStmtLR"
458392
459393gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
460−gatherStmt (L _ (ParStmt NoExtField block _ _)) =
394+gatherStmt (L _ (ParStmt NoExt block _ _)) =
461395 foldr ((<>) . gatherStmtBlock) [] block
462396gatherStmt (L s stmt@TransStmt {..}) =
463397 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -466,337 +400,256 @@ gatherStmt stmt = [[stmt]]
466400gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
467401gatherStmtBlock (ParStmtBlock _ stmts _ _) =
468402 foldr (liftAppend . gatherStmt) [] stmts
469−gatherStmtBlock (XParStmtBlock x) = noExtCon x
403+gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
470404
471405p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
472406p_hsLocalBinds = \case
473− HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
474− -- When in a single-line layout, there is a chance that the inner
475− -- elements will also contain semicolons and they will confuse the
476− -- parser. so we request braces around every element except the last.
477− br <- layoutToBraces <$> getLayout
478− let items =
479− let injectLeft (L l x) = L l (Left x)
480− injectRight (L l x) = L l (Right x)
481− in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
482− positionToBracing = \case
483− SinglePos -> id
484− FirstPos -> br
485− MiddlePos -> br
486− LastPos -> id
487− p_item' (p, item) =
488− positionToBracing p $
489− withSpacing (either p_valDecl p_sigDecl) item
490− binds = sortOn (srcSpanStart . getLoc) items
491− sitcc $ sepSemi p_item' (attachRelativePos binds)
492− HsValBinds NoExtField _ -> notImplemented "HsValBinds"
493− HsIPBinds NoExtField (IPBinds NoExtField xs) ->
407+ HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
408+ let ssStart = either
409+ (srcSpanStart . getLoc)
410+ (srcSpanStart . getLoc)
411+ items =
412+ (Left <$> bagToList bag) ++ (Right <$> lsigs)
413+ p_item (Left x) = located x p_valDecl
414+ p_item (Right x) = located x p_sigDecl
415+ sitcc $ sepSemi (useBraces . p_item) (sortOn ssStart items)
416+ HsValBinds NoExt _ -> notImplemented "HsValBinds"
417+ HsIPBinds NoExt (IPBinds NoExt xs) ->
494418 -- Second argument of IPBind is always Left before type-checking.
495− let p_ipBind (IPBind NoExtField (Left name) expr) = do
419+ let p_ipBind (IPBind NoExt (Left name) expr) = do
496420 atom name
497− space
498− equals
421+ txt " ="
499422 breakpoint
500− useBraces $ inci $ located expr p_hsExpr
501− p_ipBind (IPBind NoExtField (Right _) _) =
502− -- Should only occur after the type checker
503− notImplemented "IPBind _ (Right _) _"
504− p_ipBind (XIPBind x) = noExtCon x
423+ dontUseBraces $ inci $ located expr p_hsExpr
424+ p_ipBind _ = notImplemented "XHsIPBinds"
505425 in sepSemi (located' p_ipBind) xs
506− HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507− EmptyLocalBinds NoExtField -> return ()
508− XHsLocalBindsLR x -> noExtCon x
509−
510−p_hsRecField ::
511− HsRecField' RdrName (LHsExpr GhcPs) ->
512− R ()
513−p_hsRecField HsRecField {..} = do
514− p_rdrName hsRecFieldLbl
426+ HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
427+ EmptyLocalBinds NoExt -> return ()
428+ XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
429+
430+p_hsRecField
431+ :: (Data id, Outputable id)
432+ => HsRecField' id (LHsExpr GhcPs)
433+ -> R ()
434+p_hsRecField = \HsRecField {..} -> do
435+ located hsRecFieldLbl atom
515436 unless hsRecPun $ do
516− space
517− equals
518− let placement =
519− if onTheSameLine (getLoc hsRecFieldLbl) (getLoc hsRecFieldArg)
520− then exprPlacement (unLoc hsRecFieldArg)
521− else Normal
522− placeHanging placement (located hsRecFieldArg p_hsExpr)
437+ txt " ="
438+ let placement = exprPlacement (unLoc hsRecFieldArg)
439+ placeHanging placement $ located hsRecFieldArg p_hsExpr
523440
524−p_hsExpr :: HsExpr GhcPs -> R ()
525−p_hsExpr = p_hsExpr' N
441+p_hsTupArg :: HsTupArg GhcPs -> R ()
442+p_hsTupArg = \case
443+ Present NoExt x -> located x p_hsExpr
444+ Missing NoExt -> pure ()
445+ XTupArg {} -> notImplemented "XTupArg"
526446
527−p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
528−p_hsExpr' s = \case
529− HsVar NoExtField name -> p_rdrName name
530− HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
531− HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
532− HsRecFld NoExtField x ->
447+p_hsExpr :: HsExpr GhcPs -> R ()
448+p_hsExpr = \case
449+ HsVar NoExt name -> p_rdrName name
450+ HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
451+ HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
452+ HsRecFld NoExt x ->
533453 case x of
534− Unambiguous NoExtField name -> p_rdrName name
535− Ambiguous NoExtField name -> p_rdrName name
536− XAmbiguousFieldOcc xx -> noExtCon xx
537− HsOverLabel NoExtField _ v -> do
454+ Unambiguous NoExt name -> p_rdrName name
455+ Ambiguous NoExt name -> p_rdrName name
456+ XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
457+ HsOverLabel NoExt _ v -> do
538458 txt "#"
539459 atom v
540− HsIPVar NoExtField (HsIPName name) -> do
460+ HsIPVar NoExt (HsIPName name) -> do
541461 txt "?"
542462 atom name
543− HsOverLit NoExtField v -> atom (ol_val v)
544− HsLit NoExtField lit ->
545− case lit of
546− HsString (SourceText stxt) _ -> p_stringLit stxt
547− HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
548− r -> atom r
549− HsLam NoExtField mgroup ->
463+ HsOverLit NoExt v -> atom (ol_val v)
464+ HsLit NoExt lit -> atom lit
465+ HsLam NoExt mgroup ->
550466 p_matchGroup Lambda mgroup
551− HsLamCase NoExtField mgroup -> do
467+ HsLamCase NoExt mgroup -> do
552468 txt "\\case"
553− breakpoint
469+ newline
554470 inci (p_matchGroup LambdaCase mgroup)
555− HsApp NoExtField f x -> do
556− let -- In order to format function applications with multiple parameters
557− -- nicer, traverse the AST to gather the function and all the
558− -- parameters together.
559− gatherArgs f' knownArgs =
560− case f' of
561− L _ (HsApp _ l r) -> gatherArgs l (r <| knownArgs)
562− _ -> (f', knownArgs)
563− (func, args) = gatherArgs f (x :| [])
564− -- We need to handle the last argument specially if it is a
565− -- hanging construct, so separate it from the rest.
566− (initp, lastp) = (NE.init args, NE.last args)
567− initSpan =
568− combineSrcSpans' $
569− getLoc f :| [(srcLocSpan . srcSpanStart . getLoc) lastp]
570− -- Hang the last argument only if the initial arguments span one
571− -- line.
572− placement =
573− if isOneLineSpan initSpan
574− then exprPlacement (unLoc lastp)
575− else Normal
576− -- If the last argument is not hanging, just separate every argument as
577− -- usual. If it is hanging, print the initial arguments and hang the
578− -- last one. Also, use braces around the every argument except the last
579− -- one.
580− case placement of
581− Normal -> do
582− let -- Usually we want to bump indentation for arguments for the
583− -- sake of readability. However, when the function itself is a
584− -- do-block or case expression it is not a good idea. It seems
585− -- to be safe to always bump indentation when the function
586− -- expression is parenthesised.
587− doIndent =
588− case func of
589− L _ (HsPar NoExtField _) -> True
590− L _ (HsAppType NoExtField _ _) -> True
591− L _ (HsMultiIf NoExtField _) -> True
592− L spn _ -> isOneLineSpan spn
593− ub <-
594− getLayout <&> \case
595− SingleLine -> useBraces
596− MultiLine -> id
597− ub $ do
598− located func (p_hsExpr' s)
599− breakpoint
600− inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
601− inciIf doIndent $ do
602− unless (null initp) breakpoint
603− located lastp p_hsExpr
604− Hanging -> do
605− useBraces . switchLayout [initSpan] $ do
606− located func (p_hsExpr' s)
607− breakpoint
608− sep breakpoint (located' p_hsExpr) initp
609− placeHanging placement $
610− located lastp p_hsExpr
611− HsAppType NoExtField e a -> do
471+ HsApp NoExt f x -> sitcc $ do
472+ located f p_hsExpr
473+ -- Second argument can be a `do` or `case` block with `-XBlockArguments`.
474+ placeHanging (exprPlacement (unLoc x)) $
475+ located x p_hsExpr
476+ HsAppType a e -> do
612477 located e p_hsExpr
613478 breakpoint
614479 inci $ do
615480 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 ()
621481 located (hswc_body a) p_hsType
622− OpApp NoExtField x op y -> do
623− let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
624− p_exprOpTree s (reassociateOpTree getOpName opTree)
625− NegApp NoExtField e _ -> do
626− txt "-"
627− space
482+ OpApp NoExt x op y -> do
483+ -- NOTE If the beginning of the first argument and the second argument
484+ -- are on the same line, and the second argument has a hanging form, use
485+ -- hanging placement.
486+ let placement =
487+ if isOneLineSpan
488+ (mkSrcSpan (srcSpanStart (getLoc x)) (srcSpanStart (getLoc y)))
489+ then exprPlacement (unLoc y)
490+ else Normal
491+ opWrapper = case unLoc op of
492+ EWildPat NoExt -> backticks
493+ _ -> id
494+ ub <- vlayout
495+ (return useBraces)
496+ (return $ case placement of
497+ Hanging -> useBraces
498+ Normal -> dontUseBraces)
499+ ub $ located x p_hsExpr
500+ placeHanging placement $ do
501+ located op (opWrapper . p_hsExpr)
502+ space
503+ located y p_hsExpr
504+ NegApp NoExt e _ -> do
505+ txt "- "
628506 located e p_hsExpr
629− HsPar NoExtField e ->
630− parens s (located e (dontUseBraces . p_hsExpr))
631− SectionL NoExtField x op -> do
507+ HsPar NoExt e -> parens (located e p_hsExpr)
508+ SectionL NoExt x op -> do
632509 located x p_hsExpr
633510 breakpoint
634511 inci (located op p_hsExpr)
635− SectionR NoExtField op x -> do
512+ SectionR NoExt op x -> do
636513 located op p_hsExpr
637− useRecordDot' <- useRecordDot
638− let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639− unless (useRecordDot' && isRecordDot') breakpoint
514+ breakpoint
640515 inci (located x p_hsExpr)
641− ExplicitTuple NoExtField args boxity ->
516+ ExplicitTuple NoExt args boxity -> do
642517 let isSection = any (isMissing . unLoc) args
643518 isMissing = \case
644− Missing NoExtField -> True
519+ Missing NoExt -> True
645520 _ -> False
646− p_arg = \case
647− Present NoExtField x -> located x p_hsExpr
648− Missing NoExtField -> pure ()
649− XTupArg x -> noExtCon x
650− p_larg = sitcc . located' p_arg
651− parens' =
521+ let parens' =
652522 case boxity of
653523 Boxed -> parens
654524 Unboxed -> parensHash
655− in if isSection
656− then
657− switchLayout [] . parens' s $
658− sep comma p_larg args
659− else
660− switchLayout (getLoc <$> args) . parens' s $
661− sep commaDel p_larg args
662− ExplicitSum NoExtField tag arity e ->
663− p_unboxedSum N tag arity (located e p_hsExpr)
664− HsCase NoExtField e mgroup ->
665− p_case exprPlacement p_hsExpr e mgroup
666− HsIf NoExtField _ if' then' else' ->
667− p_if exprPlacement p_hsExpr if' then' else'
668− HsMultiIf NoExtField guards -> do
525+ if isSection
526+ then switchLayout [] . parens' $
527+ sep comma (located' p_hsTupArg) args
528+ else switchLayout (getLoc <$> args) . parens' . sitcc $
529+ sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
530+ ExplicitSum NoExt tag arity e ->
531+ p_unboxedSum tag arity (located e p_hsExpr)
532+ HsCase NoExt e mgroup -> do
533+ txt "case "
534+ located e p_hsExpr
535+ txt " of"
536+ breakpoint
537+ inci (p_matchGroup Case mgroup)
538+ HsIf NoExt _ if' then' else' -> do
539+ txt "if "
540+ located if' p_hsExpr
541+ breakpoint
542+ txt "then"
543+ located then' $ \x -> do
544+ breakpoint
545+ inci (p_hsExpr x)
546+ breakpoint
547+ txt "else"
548+ located else' $ \x -> do
549+ breakpoint
550+ inci (p_hsExpr x)
551+ HsMultiIf NoExt guards -> do
669552 txt "if"
670553 breakpoint
671− inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
672− HsLet NoExtField localBinds e ->
673− p_let p_hsExpr localBinds e
674− HsDo NoExtField ctx es -> do
554+ inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
555+ HsLet NoExt localBinds e -> do
556+ txt "let "
557+ sitcc (located localBinds p_hsLocalBinds)
558+ vlayout space (newline >> space)
559+ txt "in "
560+ sitcc (located e p_hsExpr)
561+ HsDo NoExt ctx es -> do
675562 let doBody header = do
676563 txt header
677564 breakpoint
678− ub <- layoutToBraces <$> getLayout
679− inci $
680− sepSemi
681− (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
682− (unLoc es)
683− compBody = brackets N . located es $ \xs -> do
684− let p_parBody =
685− sep
686− (breakpoint >> txt "|" >> space)
687− p_seqBody
688− p_seqBody =
689− sitcc
690− . sep
691− commaDel
692− (located' (sitcc . p_stmt))
565+ ub <- vlayout (return useBraces) (return id)
566+ inci $ sepSemi (located' (ub . p_stmt)) (unLoc es)
567+ compBody = brackets $ located es $ \xs -> do
568+ let p_parBody = sep
569+ (breakpoint >> txt "| ")
570+ p_seqBody
571+ p_seqBody = sitcc . sep
572+ (comma >> breakpoint)
573+ (located' (sitcc . p_stmt))
693574 stmts = init xs
694575 yield = last xs
695576 lists = foldr (liftAppend . gatherStmt) [] stmts
696577 located yield p_stmt
697578 breakpoint
698− txt "|"
699− space
579+ txt "| "
700580 p_parBody lists
701581 case ctx of
702582 DoExpr -> doBody "do"
703583 MDoExpr -> doBody "mdo"
704584 ListComp -> compBody
705585 MonadComp -> notImplemented "MonadComp"
706− ArrowExpr -> notImplemented "ArrowExpr"
586+ ArrowExpr -> notImplemented "ArrowExpr"
707587 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
708588 PatGuard _ -> notImplemented "PatGuard"
709589 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
710590 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
711591 ExplicitList _ _ xs ->
712− brackets s $
713− sep commaDel (sitcc . located' p_hsExpr) xs
592+ brackets . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
714593 RecordCon {..} -> do
715594 located rcon_con_name atom
716595 breakpoint
717596 let HsRecFields {..} = rcon_flds
718− updName f =
719− (f :: HsRecField GhcPs (LHsExpr GhcPs))
720− { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
721− FieldOcc _ n -> n
722− XFieldOcc x -> noExtCon x
723− }
724− fields = located' (p_hsRecField . updName) <$> rec_flds
597+ fields = located' p_hsRecField <$> rec_flds
725598 dotdot =
726599 case rec_dotdot of
727600 Just {} -> [txt ".."]
728601 Nothing -> []
729− inci . braces N $
730− sep commaDel sitcc (fields <> dotdot)
602+ inci . braces . sitcc $ sep (comma >> breakpoint) sitcc (fields <> dotdot)
731603 RecordUpd {..} -> do
732604 located rupd_expr p_hsExpr
733− useRecordDot' <- useRecordDot
734− let mrs sp = case getLoc sp of
735− RealSrcSpan r -> Just r
736− _ -> Nothing
737− let isPluginForm =
738− ((1 +) . srcSpanEndCol <$> mrs rupd_expr)
739− == (srcSpanStartCol <$> mrs (head rupd_flds))
740− unless (useRecordDot' && isPluginForm) breakpoint
741− let updName f =
742− (f :: HsRecUpdField GhcPs)
743− { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
744− Ambiguous _ n -> n
745− Unambiguous _ n -> n
746− XAmbiguousFieldOcc x -> noExtCon x
747− }
748− inci . braces N $
749− sep
750− commaDel
751− (sitcc . located' (p_hsRecField . updName))
752− rupd_flds
753− ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
605+ breakpoint
606+ inci . braces . sitcc $
607+ sep (comma >> breakpoint) (sitcc . located' p_hsRecField) rupd_flds
608+ ExprWithTySig affix x -> sitcc $ do
754609 located x p_hsExpr
755− space
756− txt "::"
757610 breakpoint
758− inci $ located hsib_body p_hsType
759− ExprWithTySig NoExtField _ HsWC {hswc_body = XHsImplicitBndrs x} -> noExtCon x
760− ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
761− ArithSeq NoExtField _ x ->
611+ inci $ do
612+ txt ":: "
613+ let HsWC {..} = affix
614+ HsIB {..} = hswc_body
615+ located hsib_body p_hsType
616+ ArithSeq NoExt _ x -> do
762617 case x of
763− From from -> brackets s $ do
618+ From from -> brackets . sitcc $ do
764619 located from p_hsExpr
765620 breakpoint
766621 txt ".."
767− FromThen from next -> brackets s $ do
768− sep commaDel (located' p_hsExpr) [from, next]
622+ FromThen from next -> brackets . sitcc $ do
623+ sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
769624 breakpoint
770625 txt ".."
771− FromTo from to -> brackets s $ do
626+ FromTo from to -> brackets . sitcc $ do
772627 located from p_hsExpr
773628 breakpoint
774− txt ".."
775− space
629+ txt ".. "
776630 located to p_hsExpr
777− FromThenTo from next to -> brackets s $ do
778− sep commaDel (located' p_hsExpr) [from, next]
631+ FromThenTo from next to -> brackets . sitcc $ do
632+ sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
779633 breakpoint
780− txt ".."
781− space
634+ txt ".. "
782635 located to p_hsExpr
783− HsSCC NoExtField _ name x -> do
636+ HsSCC NoExt _ name x -> do
784637 txt "{-# SCC "
785638 atom name
786639 txt " #-}"
787640 breakpoint
788641 located x p_hsExpr
789− HsCoreAnn NoExtField _ value x -> do
642+ HsCoreAnn NoExt _ value x -> do
790643 txt "{-# CORE "
791644 atom value
792645 txt " #-}"
793646 breakpoint
794647 located x p_hsExpr
795− HsBracket NoExtField x -> p_hsBracket x
648+ HsBracket NoExt x -> p_hsBracket x
796649 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
797650 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
798− HsSpliceE NoExtField splice -> p_hsSplice splice
799− HsProc NoExtField p e -> do
651+ HsSpliceE NoExt splice -> p_hsSplice splice
652+ HsProc NoExt p e -> do
800653 txt "proc"
801654 located p $ \x -> do
802655 breakpoint
@@ -805,159 +658,92 @@ p_hsExpr' s = \case
805658 txt "->"
806659 placeHanging (cmdTopPlacement (unLoc e)) $
807660 located e p_hsCmdTop
808− HsStatic _ e -> do
661+ HsStatic _ e -> do
809662 txt "static"
810663 breakpoint
811664 inci (located e p_hsExpr)
665+ HsArrApp NoExt body input arrType cond ->
666+ p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
667+ HsArrForm NoExt form mfixity cmds ->
668+ p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
812669 HsTick {} -> notImplemented "HsTick"
813670 HsBinTick {} -> notImplemented "HsBinTick"
814671 HsTickPragma {} -> notImplemented "HsTickPragma"
672+ EWildPat NoExt -> txt "_"
673+ EAsPat {} -> notImplemented "EAsPat"
674+ EViewPat {} -> notImplemented "EViewPat"
675+ ELazyPat {} -> notImplemented "ELazyPat"
815676 HsWrap {} -> notImplemented "HsWrap"
816− XExpr x -> noExtCon x
677+ XExpr {} -> notImplemented "XExpr"
817678
818679p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
819680p_patSynBind PSB {..} = do
820− let rhs = do
821− space
822− case psb_dir of
823− Unidirectional -> do
824− txt "<-"
825− breakpoint
826− located psb_def p_pat
827− ImplicitBidirectional -> do
828− equals
829− breakpoint
830− located psb_def p_pat
831− ExplicitBidirectional mgroup -> do
832− txt "<-"
833− breakpoint
834− located psb_def p_pat
835− newline
836− txt "where"
837− newline
838− inci (p_matchGroup (Function psb_id) mgroup)
839− txt "pattern"
840− case psb_args of
841− PrefixCon xs -> do
842− space
681+ txt "pattern "
682+ case psb_dir of
683+ Unidirectional -> do
843684 p_rdrName psb_id
844685 inci $ do
845− switchLayout (getLoc <$> xs) $ do
846− unless (null xs) breakpoint
847− sitcc (sep breakpoint p_rdrName xs)
848− rhs
849− RecCon xs -> do
850− space
686+ p_patSynDetails psb_args
687+ txt " <-"
688+ breakpoint
689+ located psb_def p_pat
690+ ImplicitBidirectional -> do
851691 p_rdrName psb_id
852692 inci $ do
853− switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
854− unless (null xs) breakpoint
855− braces N $
856− sep commaDel (p_rdrName . recordPatSynPatVar) xs
857− rhs
858− InfixCon l r -> do
859− switchLayout [getLoc l, getLoc r] $ do
860− space
861− p_rdrName l
693+ p_patSynDetails psb_args
694+ txt " ="
862695 breakpoint
863− inci $ do
864− p_rdrName psb_id
865− space
866− p_rdrName r
867− inci rhs
868−p_patSynBind (XPatSynBind x) = noExtCon x
869−
870−p_case ::
871− Data body =>
872− -- | Placer
873− (body -> Placement) ->
874− -- | Render
875− (body -> R ()) ->
876− -- | Expression
877− LHsExpr GhcPs ->
878− -- | Match group
879− MatchGroup GhcPs (Located body) ->
880− R ()
881−p_case placer render e mgroup = do
882− txt "case"
883− space
884− located e p_hsExpr
885− space
886− txt "of"
887− breakpoint
888− inci (p_matchGroup' placer render Case mgroup)
889−
890−p_if ::
891− Data body =>
892− -- | Placer
893− (body -> Placement) ->
894− -- | Render
895− (body -> R ()) ->
896− -- | If
897− LHsExpr GhcPs ->
898− -- | Then
899− Located body ->
900− -- | Else
901− Located body ->
902− R ()
903−p_if placer render if' then' else' = do
904− txt "if"
905− space
906− located if' p_hsExpr
907− breakpoint
908− inci $ do
909− txt "then"
910− space
911− located then' $ \x ->
912− placeHanging (placer x) (render x)
913− breakpoint
914− txt "else"
915− space
916− located else' $ \x ->
917− placeHanging (placer x) (render x)
918−
919−p_let ::
920− Data body =>
921− -- | Render
922− (body -> R ()) ->
923− Located (HsLocalBindsLR GhcPs GhcPs) ->
924− Located body ->
925− R ()
926−p_let render localBinds e = sitcc $ do
927− txt "let"
928− space
929− dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
930− vlayout space (newline >> txt " ")
931− txt "in"
932− space
933− sitcc (located e render)
696+ located psb_def p_pat
697+ ExplicitBidirectional mgroup -> do
698+ p_rdrName psb_id
699+ inci $ do
700+ p_patSynDetails psb_args
701+ txt " <-"
702+ breakpoint
703+ located psb_def p_pat
704+ newline
705+ line (txt "where")
706+ inci (p_matchGroup (Function psb_id) mgroup)
707+p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
708+
709+p_patSynDetails :: HsPatSynDetails (Located RdrName) -> R ()
710+p_patSynDetails = \case
711+ PrefixCon xs ->
712+ switchLayout (getLoc <$> xs) $ do
713+ unless (null xs) breakpoint
714+ sitcc (sep breakpoint p_rdrName xs)
715+ RecCon xs ->
716+ switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
717+ unless (null xs) breakpoint
718+ braces . sitcc $ sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
719+ InfixCon _ _ -> notImplemented "InfixCon"
934720
935721p_pat :: Pat GhcPs -> R ()
936722p_pat = \case
937− WildPat NoExtField -> txt "_"
938− VarPat NoExtField name -> p_rdrName name
939− LazyPat NoExtField pat -> do
723+ WildPat NoExt -> txt "_"
724+ VarPat NoExt name -> p_rdrName name
725+ LazyPat NoExt pat -> do
940726 txt "~"
941727 located pat p_pat
942− AsPat NoExtField name pat -> do
728+ AsPat NoExt name pat -> do
943729 p_rdrName name
944730 txt "@"
945731 located pat p_pat
946− ParPat NoExtField pat ->
947− located pat (parens S . p_pat)
948− BangPat NoExtField pat -> do
732+ ParPat NoExt pat ->
733+ located pat (parens . p_pat)
734+ BangPat NoExt pat -> do
949735 txt "!"
950736 located pat p_pat
951− ListPat NoExtField pats ->
952− brackets S $ sep commaDel (located' p_pat) pats
953− TuplePat NoExtField pats boxing -> do
954− let parens' =
737+ ListPat NoExt pats -> do
738+ brackets . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
739+ TuplePat NoExt pats boxing -> do
740+ let f =
955741 case boxing of
956− Boxed -> parens S
957− Unboxed -> parensHash S
958− parens' $ sep commaDel (sitcc . located' p_pat) pats
959− SumPat NoExtField pat tag arity ->
960− p_unboxedSum S tag arity (located pat p_pat)
742+ Boxed -> parens
743+ Unboxed -> parensHash
744+ f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
745+ SumPat NoExt pat tag arity ->
746+ p_unboxedSum tag arity (located pat p_pat)
961747 ConPatIn pat details ->
962748 case details of
963749 PrefixCon xs -> sitcc $ do
@@ -971,115 +757,102 @@ p_pat = \case
971757 let f = \case
972758 Nothing -> txt ".."
973759 Just x -> located x p_pat_hsRecField
974− inci . braces N . sep commaDel f $
975− case dotdot of
976− Nothing -> Just <$> fields
977− Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
978− InfixCon l r -> do
979− switchLayout [getLoc l, getLoc r] $ do
980− located l p_pat
981− breakpoint
982− inci $ do
983− p_rdrName pat
984− space
985− located r p_pat
760+ inci . braces . sitcc . sep (comma >> breakpoint) f $ case dotdot of
761+ Nothing -> Just <$> fields
762+ Just n -> (Just <$> take n fields) ++ [Nothing]
763+ InfixCon x y -> do
764+ located x p_pat
765+ space
766+ p_rdrName pat
767+ breakpoint
768+ inci (located y p_pat)
986769 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
987− ViewPat NoExtField expr pat -> sitcc $ do
770+ ViewPat NoExt expr pat -> sitcc $ do
988771 located expr p_hsExpr
989− space
990− txt "->"
772+ txt " ->"
991773 breakpoint
992774 inci (located pat p_pat)
993− SplicePat NoExtField splice -> p_hsSplice splice
994− LitPat NoExtField p -> atom p
995− NPat NoExtField v _ _ -> located v (atom . ol_val)
996− NPlusKPat NoExtField n k _ _ _ -> sitcc $ do
775+ SplicePat NoExt splice -> p_hsSplice splice
776+ LitPat NoExt p -> atom p
777+ NPat NoExt v _ _ -> located v (atom . ol_val)
778+ NPlusKPat NoExt n k _ _ _ -> sitcc $ do
997779 p_rdrName n
998780 breakpoint
999781 inci $ do
1000− txt "+"
1001− space
782+ txt "+ "
1002783 located k (atom . ol_val)
1003− SigPat NoExtField pat hswc -> do
784+ SigPat hswc pat -> do
1004785 located pat p_pat
1005786 p_typeAscription hswc
1006787 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1007− XPat x -> noExtCon x
788+ XPat NoExt -> notImplemented "XPat"
1008789
1009790p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
1010791p_pat_hsRecField HsRecField {..} = do
1011792 located hsRecFieldLbl $ \x ->
1012793 p_rdrName (rdrNameFieldOcc x)
1013794 unless hsRecPun $ do
1014− space
1015− equals
795+ txt " ="
1016796 breakpoint
1017797 inci (located hsRecFieldArg p_pat)
1018798
1019−p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1020−p_unboxedSum s tag arity m = do
799+p_unboxedSum :: ConTag -> Arity -> R () -> R ()
800+p_unboxedSum tag arity m = do
1021801 let before = tag - 1
1022802 after = arity - before - 1
1023803 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1024− f x =
804+ f (x,i) = do
805+ let isFirst = i == 0
806+ isLast = i == arity - 1
1025807 case x :: Maybe (R ()) of
1026808 Nothing ->
1027− space
809+ unless (isFirst || isLast) space
1028810 Just m' -> do
1029− space
811+ unless isFirst space
1030812 m'
1031− space
1032− parensHash s $ sep (txt "|") f args
813+ unless isLast space
814+ parensHash $ sep (txt "|") f (zip args [0..])
1033815
1034816p_hsSplice :: HsSplice GhcPs -> R ()
1035817p_hsSplice = \case
1036− HsTypedSplice NoExtField deco _ expr -> p_hsSpliceTH True expr deco
1037− HsUntypedSplice NoExtField deco _ expr -> p_hsSpliceTH False expr deco
1038− HsQuasiQuote NoExtField _ quoterName srcSpan str -> do
818+ HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
819+ HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
820+ HsQuasiQuote NoExt _ quoterName srcSpan str -> do
1039821 txt "["
1040822 p_rdrName (L srcSpan quoterName)
1041823 txt "|"
1042− -- QuasiQuoters often rely on precise custom strings. We cannot do any
1043− -- formatting here without potentially breaking someone's code.
824+ -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
825+ -- any formatting here without potentially breaking someone's code.
1044826 atom str
1045827 txt "|]"
1046828 HsSpliced {} -> notImplemented "HsSpliced"
1047− HsSplicedT {} -> notImplemented "HsSplicedT"
1048− XSplice x -> noExtCon x
829+ XSplice {} -> notImplemented "XSplice"
1049830
1050−p_hsSpliceTH ::
1051− -- | Typed splice?
1052− Bool ->
1053− -- | Splice expression
1054− LHsExpr GhcPs ->
1055− -- | Splice decoration
1056− SpliceDecoration ->
1057− R ()
831+p_hsSpliceTH
832+ :: Bool -- ^ Typed splice?
833+ -> LHsExpr GhcPs -- ^ Splice expression
834+ -> SpliceDecoration -- ^ Splice decoration
835+ -> R ()
1058836p_hsSpliceTH isTyped expr = \case
1059837 HasParens -> do
1060838 txt decoSymbol
1061− parens N (located expr (sitcc . p_hsExpr))
839+ parens (located expr (sitcc . p_hsExpr))
1062840 HasDollar -> do
1063841 txt decoSymbol
1064842 located expr (sitcc . p_hsExpr)
1065− NoParens ->
843+ NoParens -> do
1066844 located expr (sitcc . p_hsExpr)
1067845 where
1068846 decoSymbol = if isTyped then "$$" else "$"
1069847
1070848p_hsBracket :: HsBracket GhcPs -> R ()
1071849p_hsBracket = \case
1072− ExpBr NoExtField expr -> do
1073− anns <- getEnclosingAnns
1074− let name = case anns of
1075− AnnOpenEQ : _ -> ""
1076− _ -> "e"
1077− quote name (located expr p_hsExpr)
1078− PatBr NoExtField pat -> located pat (quote "p" . p_pat)
1079− DecBrL NoExtField decls -> quote "d" (p_hsDecls Free decls)
1080− DecBrG NoExtField _ -> notImplemented "DecBrG" -- result of renamer
1081− TypBr NoExtField ty -> quote "t" (located ty p_hsType)
1082− VarBr NoExtField isSingleQuote name -> do
850+ ExpBr NoExt expr -> quote "e" (located expr p_hsExpr)
851+ PatBr NoExt pat -> quote "p" (located pat p_pat)
852+ DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
853+ DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
854+ TypBr NoExt ty -> quote "t" (located ty p_hsType)
855+ VarBr NoExt isSingleQuote name -> do
1083856 txt (bool "''" "'" isSingleQuote)
1084857 -- HACK As you can see we use 'noLoc' here to be able to pass name into
1085858 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -1087,20 +860,19 @@ p_hsBracket = \case
1087860 -- turn makes it impossible to detect if there are parentheses around
1088861 -- it, etc. So we have to add parentheses manually assuming they are
1089862 -- necessary for all operators.
1090− let isOperator =
1091− all
1092− (\i -> isPunctuation i || isSymbol i)
1093− (showOutputable (rdrNameOcc name))
1094− && not (doesNotNeedExtraParens name)
1095− wrapper = if isOperator then parens N else id
863+ let isOperator = all
864+ (\i -> isPunctuation i || isSymbol i)
865+ (showOutputable (rdrNameOcc name))
866+ && not (doesNotNeedExtraParens name)
867+ wrapper = if isOperator then parens else id
1096868 wrapper $ p_rdrName (noLoc name)
1097− TExpBr NoExtField expr -> do
869+ TExpBr NoExt expr -> do
1098870 txt "[||"
1099871 breakpoint'
1100872 located expr p_hsExpr
1101873 breakpoint'
1102874 txt "||]"
1103− XBracket x -> noExtCon x
875+ XBracket {} -> notImplemented "XBracket"
1104876 where
1105877 quote :: Text -> R () -> R ()
1106878 quote name body = do
@@ -1113,65 +885,12 @@ p_hsBracket = \case
1113885 breakpoint'
1114886 txt "|]"
1115887
1116−-- Print the source text of a string literal while indenting
1117−-- gaps correctly.
1118−
1119−p_stringLit :: String -> R ()
1120−p_stringLit src =
1121− let s = splitGaps src
1122− singleLine =
1123− txt $ Text.pack (mconcat s)
1124− multiLine =
1125− sitcc $ sep breakpoint (txt . Text.pack) (backslashes s)
1126− in vlayout singleLine multiLine
1127− where
1128− -- Split a string on gaps (backslash delimited whitespaces)
1129− --
1130− -- > splitGaps "bar\\ \\fo\\&o" == ["bar", "fo\\&o"]
1131− splitGaps :: String -> [String]
1132− splitGaps "" = []
1133− splitGaps s =
1134− let -- A backslash and a whitespace starts a "gap"
1135− p (Just '\\', _, _) = True
1136− p (_, '\\', Just c) | ghcSpace c = False
1137− p _ = True
1138− in case span p (zipPrevNext s) of
1139− (l, r) ->
1140− let -- drop the initial '\', any amount of 'ghcSpace', and another '\'
1141− r' = drop 1 . dropWhile ghcSpace . drop 1 $ map orig r
1142− in map orig l : splitGaps r'
1143− -- GHC's definition of whitespaces in strings
1144− -- See: https://gitlab.haskell.org/ghc/ghc/blob/86753475/compiler/parser/Lexer.x#L1653
1145− ghcSpace :: Char -> Bool
1146− ghcSpace c = c <= '\x7f' && is_space c
1147− -- Add backslashes to the inner side of the strings
1148− --
1149− -- > backslashes ["a", "b", "c"] == ["a\\", "\\b\\", "\\c"]
1150− backslashes :: [String] -> [String]
1151− backslashes (x : y : xs) = (x ++ "\\") : backslashes (('\\' : y) : xs)
1152− backslashes xs = xs
1153− -- Attaches previous and next items to each list element
1154− zipPrevNext :: [a] -> [(Maybe a, a, Maybe a)]
1155− zipPrevNext xs =
1156− let z =
1157− zip
1158− (zip (Nothing : map Just xs) xs)
1159− (map Just (tail xs) ++ repeat Nothing)
1160− in map (\((p, x), n) -> (p, x, n)) z
1161− orig (_, x, _) = x
1162−
1163888----------------------------------------------------------------------------
1164889-- Helpers
1165890
1166−-- | Return the wrapping function controlling the use of braces according to
1167−-- the current layout.
1168−layoutToBraces :: Layout -> R () -> R ()
1169−layoutToBraces = \case
1170− SingleLine -> useBraces
1171− MultiLine -> id
1172−
1173891-- | Append each element in both lists with semigroups. If one list is shorter
1174892-- than the other, return the rest of the longer list unchanged.
893+
1175894liftAppend :: Semigroup a => [a] -> [a] -> [a]
1176895liftAppend [] [] = []
1177896liftAppend [] (y : ys) = y : ys
@@ -1179,15 +898,15 @@ liftAppend (x : xs) [] = x : xs
1179898liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
1180899
1181900getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1182−getGRHSSpan (GRHS NoExtField guards body) =
1183− combineSrcSpans' $ getLoc body :| map getLoc guards
1184−getGRHSSpan (XGRHS x) = noExtCon x
901+getGRHSSpan (GRHS NoExt _ body) = getLoc body
902+getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1185903
1186904-- | Place a thing that may have a hanging form. This function handles how
1187905-- to separate it from preceding expressions and whether to bump indentation
1188906-- depending on what sort of expression we have.
907+
1189908placeHanging :: Placement -> R () -> R ()
1190−placeHanging placement m =
909+placeHanging placement m = do
1191910 case placement of
1192911 Hanging -> do
1193912 space
@@ -1198,165 +917,53 @@ placeHanging placement m =
1198917
1199918-- | Check if given block contains single expression which has a hanging
1200919-- form.
1201−blockPlacement ::
1202− (body -> Placement) ->
1203− [LGRHS GhcPs (Located body)] ->
1204− Placement
1205−blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
920+
921+blockPlacement
922+ :: (body -> Placement)
923+ -> [LGRHS GhcPs (Located body)]
924+ -> Placement
925+blockPlacement placer [(L _ (GRHS NoExt _ (L _ x)))] = placer x
1206926blockPlacement _ _ = Normal
1207927
1208928-- | Check if given command has a hanging form.
929+
1209930cmdPlacement :: HsCmd GhcPs -> Placement
1210931cmdPlacement = \case
1211− HsCmdLam NoExtField _ -> Hanging
1212− HsCmdCase NoExtField _ _ -> Hanging
1213− HsCmdDo NoExtField _ -> Hanging
932+ HsCmdLam NoExt _ -> Hanging
933+ HsCmdCase NoExt _ _ -> Hanging
934+ HsCmdDo NoExt _ -> Hanging
1214935 _ -> Normal
1215936
1216937cmdTopPlacement :: HsCmdTop GhcPs -> Placement
1217938cmdTopPlacement = \case
1218− HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219− XCmdTop x -> noExtCon x
939+ HsCmdTop NoExt (L _ x) -> cmdPlacement x
940+ XCmdTop {} -> notImplemented "XCmdTop"
1220941
1221942-- | Check if given expression has a hanging form.
943+
1222944exprPlacement :: HsExpr GhcPs -> Placement
1223945exprPlacement = \case
1224− -- Only hang lambdas with single line parameter lists
1225− HsLam NoExtField mg -> case mg of
1226− MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
1227− | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
1228− Hanging
1229− _ -> Normal
1230− HsLamCase NoExtField _ -> Hanging
1231− HsCase NoExtField _ _ -> Hanging
1232− HsDo NoExtField DoExpr _ -> Hanging
1233− HsDo NoExtField MDoExpr _ -> Hanging
1234− OpApp NoExtField _ op y ->
1235− case (fmap getOpNameStr . getOpName . unLoc) op of
1236− Just "$" -> exprPlacement (unLoc y)
1237− _ -> Normal
1238− HsApp NoExtField _ y -> exprPlacement (unLoc y)
1239− HsProc NoExtField p _ ->
946+ HsLam NoExt _ -> Hanging
947+ HsLamCase NoExt _ -> Hanging
948+ HsCase NoExt _ _ -> Hanging
949+ HsDo NoExt DoExpr _ -> Hanging
950+ HsDo NoExt MDoExpr _ -> Hanging
951+ RecordCon NoExt _ _ -> Hanging
952+ -- If the rightmost expression in an operator chain is hanging, make the
953+ -- whole block hanging; so that we can use the common @f = foo $ do@
954+ -- style.
955+ OpApp NoExt _ _ y -> exprPlacement (unLoc y)
956+ HsProc NoExt (L s _) _ ->
1240957 -- Indentation breaks if pattern is longer than one line and left
1241958 -- hanging. Consequently, only apply hanging when it is safe.
1242− if isOneLineSpan (getLoc p)
1243− then Hanging
1244− else Normal
959+ if isOneLineSpan s
960+ then Hanging
961+ else Normal
1245962 _ -> Normal
1246963
1247964withGuards :: [LGRHS GhcPs (Located body)] -> Bool
1248965withGuards = any (checkOne . unLoc)
1249966 where
1250967 checkOne :: GRHS GhcPs (Located body) -> Bool
1251− checkOne (GRHS NoExtField [] _) = False
968+ checkOne (GRHS NoExt [] _) = False
1252969 checkOne _ = True
1253−
1254−exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1255−exprOpTree (L _ (OpApp NoExtField x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
1256−exprOpTree n = OpNode n
1257−
1258−getOpName :: HsExpr GhcPs -> Maybe RdrName
1259−getOpName = \case
1260− HsVar NoExtField (L _ a) -> Just a
1261− _ -> Nothing
1262−
1263−getOpNameStr :: RdrName -> String
1264−getOpNameStr = occNameString . rdrNameOcc
1265−
1266−p_exprOpTree ::
1267− -- | Bracket style to use
1268− BracketStyle ->
1269− OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
1270− R ()
1271−p_exprOpTree s (OpNode x) = located x (p_hsExpr' s)
1272−p_exprOpTree s (OpBranch x op y) = do
1273− -- If the beginning of the first argument and the second argument are on
1274− -- the same line, and the second argument has a hanging form, use hanging
1275− -- placement.
1276− let placement =
1277− if isOneLineSpan
1278− (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1279− then case y of
1280− OpNode (L _ n) -> exprPlacement n
1281− _ -> Normal
1282− else Normal
1283− -- Distinguish holes used in infix notation.
1284− -- eg. '1 _foo 2' and '1 `_foo` 2'
1285− opWrapper = case unLoc op of
1286− HsUnboundVar NoExtField _ -> backticks
1287− _ -> id
1288− layout <- getLayout
1289− let ub = case layout of
1290− SingleLine -> useBraces
1291− MultiLine -> case placement of
1292− Hanging -> useBraces
1293− Normal -> dontUseBraces
1294− opNameStr = (fmap getOpNameStr . getOpName . unLoc) op
1295− gotDollar = opNameStr == Just "$"
1296− gotColon = opNameStr == Just ":"
1297− gotRecordDot = isRecordDot (unLoc op) (opTreeLoc y)
1298− lhs =
1299− switchLayout [opTreeLoc x] $
1300− p_exprOpTree s x
1301− p_op = located op (opWrapper . p_hsExpr)
1302− p_y = switchLayout [opTreeLoc y] (p_exprOpTree N y)
1303− isSection = case (opTreeLoc x, getLoc op) of
1304− (RealSrcSpan treeSpan, RealSrcSpan opSpan) ->
1305− srcSpanEndCol treeSpan /= srcSpanStartCol opSpan
1306− _ -> False
1307− isDoBlock = \case
1308− OpNode (L _ HsDo {}) -> True
1309− _ -> False
1310− useRecordDot' <- useRecordDot
1311− if
1312− | gotColon -> do
1313− lhs
1314− space
1315− p_op
1316− case placement of
1317− Hanging -> do
1318− space
1319− p_y
1320− Normal -> do
1321− breakpoint
1322− inciIf (isDoBlock y) p_y
1323− | gotDollar
1324− && isOneLineSpan (opTreeLoc x)
1325− && placement == Normal -> do
1326− useBraces lhs
1327− space
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
1342−
1343−-- | Return 'True' if given expression is a record-dot operator expression.
1344−isRecordDot ::
1345− -- | Operator expression
1346− HsExpr GhcPs ->
1347− -- | Span of the expression on the right-hand side of the operator
1348− SrcSpan ->
1349− Bool
1350−isRecordDot op (RealSrcSpan ySpan) = case op of
1351− HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1352− (getOpNameStr opName == ".") && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1353− _ -> False
1354−isRecordDot _ _ = False
1355−
1356−-- | Get annotations for the enclosing element.
1357−getEnclosingAnns :: R [AnnKeywordId]
1358−getEnclosingAnns = do
1359− e <- getEnclosingSpan (const True)
1360− case e of
1361− Nothing -> return []
1362− Just e' -> getAnns (RealSrcSpan e')
src/Ormolu/Printer/Meat/Declaration/Value.hs-boot+7−6
@@ -1,9 +1,8 @@
11module Ormolu.Printer.Meat.Declaration.Value
2− ( p_valDecl,
3− p_pat,
4− p_hsExpr,
5− p_hsSplice,
6− p_stringLit,
2+ ( p_valDecl
3+ , p_pat
4+ , p_hsExpr
5+ , p_hsSplice
76 )
87where
98
@@ -11,7 +10,9 @@ import GHC
1110import Ormolu.Printer.Combinators
1211
1312p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
13+
1414p_pat :: Pat GhcPs -> R ()
15+
1516p_hsExpr :: HsExpr GhcPs -> R ()
17+
1618p_hsSplice :: HsSplice GhcPs -> R ()
17−p_stringLit :: String -> R ()
src/Ormolu/Printer/Meat/Declaration/Warning.hs+13−11
@@ -1,9 +1,9 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
33
44module Ormolu.Printer.Meat.Declaration.Warning
5− ( p_warnDecls,
6− p_moduleWarning,
5+ ( p_warnDecls
6+ , p_moduleWarning
77 )
88where
99
@@ -13,28 +13,30 @@ import Data.Text (Text)
1313import GHC
1414import Ormolu.Printer.Combinators
1515import Ormolu.Printer.Meat.Common
16+import Ormolu.Utils
1617
1718p_warnDecls :: WarnDecls GhcPs -> R ()
18−p_warnDecls (Warnings NoExtField _ warnings) =
19+p_warnDecls (Warnings NoExt _ warnings) =
1920 traverse_ (located' p_warnDecl) warnings
20−p_warnDecls (XWarnDecls x) = noExtCon x
21+p_warnDecls XWarnDecls {} = notImplemented "XWarnDecls"
2122
2223p_warnDecl :: WarnDecl GhcPs -> R ()
23−p_warnDecl (Warning NoExtField functions warningTxt) =
24+p_warnDecl (Warning NoExt functions warningTxt) =
2425 p_topLevelWarning functions warningTxt
25−p_warnDecl (XWarnDecl x) = noExtCon x
26+p_warnDecl XWarnDecl {} = notImplemented "XWarnDecl"
2627
2728p_moduleWarning :: WarningTxt -> R ()
2829p_moduleWarning wtxt = do
2930 let (pragmaText, lits) = warningText wtxt
30− inci $ pragma pragmaText $ inci $ p_lits lits
31+ switchLayout (getLoc <$> lits) $ do
32+ inci $ pragma pragmaText (inci $ p_lits lits)
3133
3234p_topLevelWarning :: [Located RdrName] -> WarningTxt -> R ()
3335p_topLevelWarning fnames wtxt = do
3436 let (pragmaText, lits) = warningText wtxt
35− switchLayout (fmap getLoc fnames ++ fmap getLoc lits) $
37+ switchLayout (fmap getLoc fnames ++ fmap getLoc lits) $ do
3638 pragma pragmaText . inci $ do
37− sep commaDel p_rdrName fnames
39+ sitcc $ sep (comma >> breakpoint) p_rdrName fnames
3840 breakpoint
3941 p_lits lits
4042
@@ -46,4 +48,4 @@ warningText = \case
4648p_lits :: [Located StringLiteral] -> R ()
4749p_lits = \case
4850 [l] -> atom l
49− ls -> brackets N $ sep commaDel atom ls
51+ ls -> brackets . sitcc $ sep (comma >> breakpoint) atom ls
src/Ormolu/Printer/Meat/ImportExport.hs+54−94
@@ -1,19 +1,21 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
44
55-- | Rendering of import and export lists.
6+
67module Ormolu.Printer.Meat.ImportExport
7− ( p_hsmodExports,
8− p_hsmodImport,
8+ ( p_hsmodExports
9+ , p_hsmodImport
910 )
1011where
1112
1213import Control.Monad
1314import GHC
15+import HsImpExp (IE (..))
1416import Ormolu.Printer.Combinators
1517import Ormolu.Printer.Meat.Common
16−import Ormolu.Utils (RelativePos (..), attachRelativePos)
18+import Ormolu.Utils
1719
1820p_hsmodExports :: [LIE GhcPs] -> R ()
1921p_hsmodExports [] = do
@@ -21,106 +23,64 @@ p_hsmodExports [] = do
2123 breakpoint'
2224 txt ")"
2325p_hsmodExports xs =
24− parens N $ do
25− layout <- getLayout
26− sep
27− breakpoint
28− (\(p, l) -> sitcc (located l (p_lie layout p)))
29− (attachRelativePos xs)
26+ parens . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_lie) xs
3027
31−p_hsmodImport :: Bool -> ImportDecl GhcPs -> R ()
32−p_hsmodImport useQualifiedPost ImportDecl {..} = do
33− txt "import"
34− space
35− when ideclSource (txt "{-# SOURCE #-}")
36− space
37− when ideclSafe (txt "safe")
38− space
39− when
40− (isImportDeclQualified ideclQualified && not useQualifiedPost)
41− (txt "qualified")
42− space
28+p_hsmodImport :: ImportDecl GhcPs -> R ()
29+p_hsmodImport ImportDecl {..} = line $ do
30+ txt "import "
31+ when ideclSource $
32+ txt "{-# SOURCE #-} "
33+ when ideclSafe $
34+ txt "safe "
35+ when ideclQualified $
36+ txt "qualified "
4337 case ideclPkgQual of
4438 Nothing -> return ()
45− Just slit -> atom slit
46− space
47− inci $ do
48− located ideclName atom
49− when
50− (isImportDeclQualified ideclQualified && useQualifiedPost)
51− (space >> txt "qualified")
52− case ideclAs of
53− Nothing -> return ()
54− Just l -> do
55− space
56− txt "as"
57− space
58− located l atom
59− space
60− case ideclHiding of
61− Nothing -> return ()
62− Just (hiding, _) ->
63− when hiding (txt "hiding")
64− case ideclHiding of
65− Nothing -> return ()
66− Just (_, L _ xs) -> do
67− breakpoint
68− parens N $ do
69− layout <- getLayout
70− sep
71− breakpoint
72− (\(p, l) -> sitcc (located l (p_lie layout p)))
73− (attachRelativePos xs)
74− newline
75−p_hsmodImport _ (XImportDecl x) = noExtCon x
39+ Just slit -> do
40+ atom slit
41+ space
42+ located ideclName atom
43+ case ideclAs of
44+ Nothing -> return ()
45+ Just l -> do
46+ txt " as "
47+ located l atom
48+ case ideclHiding of
49+ Nothing -> return ()
50+ Just (hiding, _) ->
51+ when hiding $
52+ txt " hiding"
53+ case ideclHiding of
54+ Nothing -> return ()
55+ Just (_, (L _ a)) -> do
56+ breakpoint
57+ inci . parens . sitcc $
58+ sep (comma >> breakpoint) (sitcc . located' p_lie) a
59+p_hsmodImport (XImportDecl NoExt) = notImplemented "XImportDecl"
7660
77−p_lie :: Layout -> RelativePos -> IE GhcPs -> R ()
78−p_lie encLayout relativePos = \case
79− IEVar NoExtField l1 -> do
80− located l1 p_ieWrappedName
81− p_comma
82− IEThingAbs NoExtField l1 -> do
83− located l1 p_ieWrappedName
84− p_comma
85− IEThingAll NoExtField l1 -> do
61+p_lie :: IE GhcPs -> R ()
62+p_lie = \case
63+ IEVar NoExt l1 -> located l1 p_ieWrappedName
64+ IEThingAbs NoExt l1 -> located l1 p_ieWrappedName
65+ IEThingAll NoExt l1 -> do
8666 located l1 p_ieWrappedName
87− space
88− txt "(..)"
89− p_comma
90− IEThingWith NoExtField l1 w xs _ -> sitcc $ do
67+ txt " (..)"
68+ IEThingWith NoExt l1 w xs _ -> sitcc $ do
69+ -- XXX I have no idea what field labels are in this context.
9170 located l1 p_ieWrappedName
9271 breakpoint
9372 inci $ do
9473 let names :: [R ()]
9574 names = located' p_ieWrappedName <$> xs
96− parens N . sep commaDel sitcc $
75+ parens . sitcc . sep (comma >> breakpoint) sitcc $
9776 case w of
9877 NoIEWildcard -> names
9978 IEWildcard n ->
10079 let (before, after) = splitAt n names
101− in before ++ [txt ".."] ++ after
102− p_comma
103− IEModuleContents NoExtField l1 -> do
104− located l1 p_hsmodName
105− p_comma
106− IEGroup NoExtField n str -> do
107− case relativePos of
108− SinglePos -> return ()
109− FirstPos -> return ()
110− MiddlePos -> newline
111− LastPos -> newline
112− p_hsDocString (Asterisk n) False (noLoc str)
113− IEDoc NoExtField str ->
114− p_hsDocString Pipe False (noLoc str)
115− IEDocNamed NoExtField str -> p_hsDocName str
116− XIE x -> noExtCon x
117− where
118− p_comma =
119− case encLayout of
120− SingleLine ->
121− case relativePos of
122− SinglePos -> return ()
123− FirstPos -> comma
124− MiddlePos -> comma
125− LastPos -> return ()
126− MultiLine -> comma
80+ in before ++ [txt ".."] ++ after
81+ IEModuleContents NoExt l1 -> located l1 p_hsmodName
82+ -- XXX I have no idea what these things are for.
83+ IEGroup NoExt _ _ -> return ()
84+ IEDoc NoExt _ -> return ()
85+ IEDocNamed NoExt _ -> return ()
86+ XIE NoExt -> notImplemented "XIE"
src/Ormolu/Printer/Meat/Module.hs+43−49
@@ -1,77 +1,71 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
44
55-- | Rendering of modules.
6+
67module Ormolu.Printer.Meat.Module
7− ( p_hsModule,
8+ ( p_hsModule
89 )
910where
1011
1112import Control.Monad
12−import qualified Data.Text as T
13+import Data.Maybe (isJust)
1314import GHC
14−import Ormolu.Imports (normalizeImports)
15−import Ormolu.Parser.CommentStream
15+import Ormolu.Imports
1616import Ormolu.Parser.Pragma
17−import Ormolu.Parser.Shebang
1817import Ormolu.Printer.Combinators
1918import Ormolu.Printer.Comments
19+import Ormolu.Printer.Internal (isNewlineModified)
2020import Ormolu.Printer.Meat.Common
2121import Ormolu.Printer.Meat.Declaration
2222import Ormolu.Printer.Meat.Declaration.Warning
2323import Ormolu.Printer.Meat.ImportExport
2424import Ormolu.Printer.Meat.Pragma
2525
26−-- | Render a module.
27−p_hsModule ::
28− -- | Stack header
29− Maybe (RealLocated Comment) ->
30− -- | Shebangs
31− [Shebang] ->
32− -- | Pragmas and the associated comments
33− [([RealLocated Comment], Pragma)] ->
34− -- | Whether to use postfix qualified imports
35− Bool ->
36− -- | AST to print
37− HsModule GhcPs ->
38− R ()
39−p_hsModule mstackHeader shebangs pragmas qualifiedPost HsModule {..} = do
40− let deprecSpan = maybe [] (\(L s _) -> [s]) hsmodDeprecMessage
41− exportSpans = maybe [] (\(L s _) -> [s]) hsmodExports
42− switchLayout (deprecSpan <> exportSpans) $ do
43− forM_ shebangs $ \(Shebang x) ->
44− located x $ \shebang -> do
45− txt (T.pack shebang)
46− newline
47− forM_ mstackHeader $ \(L spn comment) -> do
48− spitCommentNow spn comment
49− newline
50− newline
26+p_hsModule :: [Pragma] -> ParsedSource -> R ()
27+p_hsModule pragmas (L moduleSpan HsModule {..}) = do
28+ -- NOTE If span of exports in multiline, the whole thing is multiline.
29+ -- This is especially important because span of module itself always seems
30+ -- to have length zero, so it's not reliable for layout selection.
31+ let exportSpans = maybe [] (\(L s _) -> [s]) hsmodExports
32+ deprecSpan = maybe [] (\(L s _) -> [s]) hsmodDeprecMessage
33+ spans' = exportSpans ++ deprecSpan ++ [moduleSpan]
34+ switchLayout spans' $ do
35+ let hasLangPragmas = not (null pragmas)
36+ hasModuleHeader = isJust hsmodName
37+ hasImports = not (null hsmodImports)
38+ hasDecls = not (null hsmodDecls)
5139 p_pragmas pragmas
52− newline
40+ when (hasLangPragmas &&
41+ (hasModuleHeader || hasImports || hasDecls)) $
42+ newline
5343 case hsmodName of
54− Nothing -> return ()
55− Just hsmodName' -> do
56− located hsmodName' $ \name -> do
57− forM_ hsmodHaddockModHeader (p_hsDocString Pipe True)
58− p_hsmodName name
59− breakpoint
44+ Nothing -> pure ()
45+ Just hsmodName' -> line $ do
46+ located hsmodName' p_hsmodName
6047 forM_ hsmodDeprecMessage $ \w -> do
61− located' p_moduleWarning w
6248 breakpoint
49+ located' p_moduleWarning w
6350 case hsmodExports of
6451 Nothing -> return ()
65− Just l -> do
66− located l $ \exports -> do
67− inci (p_hsmodExports exports)
52+ Just hsmodExports' -> do
6853 breakpoint
54+ inci (p_hsmodExports (unLoc hsmodExports'))
55+ breakpoint
6956 txt "where"
70− newline
71− newline
72− forM_ (normalizeImports hsmodImports) (located' (p_hsmodImport qualifiedPost))
73− newline
74− switchLayout (getLoc <$> hsmodDecls) $ do
57+ when (hasImports || hasDecls) newline
58+ forM_ (sortImports hsmodImports) (located' p_hsmodImport)
59+ when (hasImports && hasDecls) newline
60+ switchLayout (map getLoc hsmodDecls) $ do
7561 p_hsDecls Free hsmodDecls
76− newline
62+ trailingComments <- hasMoreComments
63+ when hasDecls $ do
64+ newlineModified <- isNewlineModified
65+ newline
66+ -- In this case we need to insert a newline between the comments
67+ -- output as a side effect of the previous newline and trailing
68+ -- comments to prevent them from merging.
69+ when (newlineModified && trailingComments) newline
70+ when (trailingComments && hasModuleHeader) newline
7771 spitRemainingComments
src/Ormolu/Printer/Meat/Pragma.hs+20−74
@@ -1,91 +1,37 @@
1−{-# LANGUAGE LambdaCase #-}
1+-- | Pretty-printing of language pragmas.
2+
3+{-# LANGUAGE LambdaCase #-}
24{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE TupleSections #-}
5+{-# LANGUAGE TupleSections #-}
46
5−-- | Pretty-printing of language pragmas.
67module Ormolu.Printer.Meat.Pragma
7− ( p_pragmas,
8+ ( p_pragmas
89 )
910where
1011
11−import Control.Monad
12−import Data.Char (isUpper)
13−import qualified Data.List as L
14−import Data.Maybe (listToMaybe)
15−import qualified Data.Text as T
16−import Ormolu.Parser.CommentStream
17−import Ormolu.Parser.Pragma (Pragma (..))
1812import Ormolu.Printer.Combinators
19−import Ormolu.Printer.Comments
20−import SrcLoc
21−
22−-- | Pragma classification.
23−data PragmaTy
24− = Language LanguagePragmaClass
25− | OptionsGHC
26− | OptionsHaddock
27− deriving (Eq, Ord)
13+import Ormolu.Parser.Pragma (Pragma (..))
14+import qualified Data.Set as S
15+import qualified Data.Text as T
2816
29−-- | Language pragma classification.
30−--
31−-- The order in which language pragmas are put in the input sometimes
32−-- matters. This is because some language extensions can enable other
33−-- extensions, yet the extensions coming later in the list have the ability
34−-- to change it. So here we classify all extensions by assigning one of the
35−-- four groups to them. Then we only sort inside of the groups.
36−--
37−-- 'Ord' instance of this data type is what affects the sorting.
38−--
39−-- See also: <https://github.com/tweag/ormolu/issues/404>
40−data LanguagePragmaClass
41− = -- | All other extensions
42− Normal
43− | -- | Extensions starting with "No"
44− Disabling
45− | -- | Extensions that should go after everything else
46− Final
17+data PragmaTy = Language | OptionsGHC | OptionsHaddock
4718 deriving (Eq, Ord)
4819
49−-- | Print a collection of 'Pragma's with their associated comments.
50−p_pragmas :: [([RealLocated Comment], Pragma)] -> R ()
51−p_pragmas ps = do
52− let prepare = L.sortOn snd . L.nub . concatMap analyze
53− analyze = \case
54− (cs, PragmaLanguage xs) ->
55− let f x = (cs, (Language (classifyLanguagePragma x), x))
56− in f <$> xs
57− (cs, PragmaOptionsGHC x) -> [(cs, (OptionsGHC, x))]
58− (cs, PragmaOptionsHaddock x) -> [(cs, (OptionsHaddock, x))]
59− forM_ (prepare ps) $ \(cs, (pragmaTy, x)) ->
60− p_pragma cs pragmaTy x
20+p_pragmas :: [Pragma] -> R ()
21+p_pragmas ps =
22+ let prepare = concatMap $ \case
23+ PragmaLanguage xs -> (Language,) <$> xs
24+ PragmaOptionsGHC x -> [(OptionsGHC, x)]
25+ PragmaOptionsHaddock x -> [(OptionsHaddock, x)]
26+ in mapM_ (uncurry p_pragma) (S.toAscList . S.fromList . prepare $ ps)
6127
62−p_pragma :: [RealLocated Comment] -> PragmaTy -> String -> R ()
63−p_pragma comments ty x = do
64− forM_ comments $ \(L l comment) -> do
65− spitCommentNow l comment
66− newline
28+p_pragma :: PragmaTy -> String -> R ()
29+p_pragma ty c = line $ do
6730 txt "{-# "
6831 txt $ case ty of
69− Language _ -> "LANGUAGE"
32+ Language -> "LANGUAGE"
7033 OptionsGHC -> "OPTIONS_GHC"
7134 OptionsHaddock -> "OPTIONS_HADDOCK"
7235 space
73− txt (T.pack x)
36+ txt (T.pack c)
7437 txt " #-}"
75− newline
76−
77−-- | Classify a 'LanguagePragma'.
78−classifyLanguagePragma :: String -> LanguagePragmaClass
79−classifyLanguagePragma = \case
80− "ImplicitPrelude" -> Final
81− "CUSKs" -> Final
82− str ->
83− case splitAt 2 str of
84− ("No", rest) ->
85− case listToMaybe rest of
86− Nothing -> Normal
87− Just x ->
88− if isUpper x
89− then Disabling
90− else Normal
91− _ -> Normal
src/Ormolu/Printer/Meat/Type.hs+130−201
@@ -1,257 +1,191 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
22{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
44
55-- | Rendering of types.
6+
67module Ormolu.Printer.Meat.Type
7− ( p_hsType,
8− p_hsTypePostDoc,
9− hasDocStrings,
10− p_hsContext,
11− p_hsTyVarBndr,
12− p_forallBndrs,
13− p_conDeclFields,
14− tyVarsToTypes,
8+ ( p_hsType
9+ , p_hsContext
10+ , p_hsTyVarBndr
11+ , p_conDeclFields
12+ , tyVarsToTypes
1513 )
1614where
1715
18−import Data.Data (Data)
19−import GHC hiding (isPromoted)
16+import GHC
2017import Ormolu.Printer.Combinators
2118import Ormolu.Printer.Meat.Common
22−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration.Value (p_hsSplice, p_stringLit)
23−import Ormolu.Printer.Operators
2419import Ormolu.Utils
20+import SrcLoc (combineSrcSpans)
21+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration.Value (p_hsSplice)
2522
2623p_hsType :: HsType GhcPs -> R ()
27−p_hsType t = p_hsType' (hasDocStrings t) PipeStyle t
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−
37−p_hsType' :: Bool -> TypeDocStyle -> HsType GhcPs -> R ()
38−p_hsType' multilineArgs docStyle = \case
39− HsForAllTy NoExtField visibility bndrs t -> do
40− p_forallBndrs visibility p_hsTyVarBndr bndrs
41− interArgBreak
42− p_hsTypeR (unLoc t)
43− HsQualTy NoExtField qs t -> do
24+p_hsType = \case
25+ HsForAllTy NoExt bndrs t -> do
26+ txt "forall "
27+ sep space (located' p_hsTyVarBndr) bndrs
28+ txt ". "
29+ p_hsType (unLoc t)
30+ HsQualTy NoExt qs t -> do
4431 located qs p_hsContext
45− space
46− txt "=>"
47− interArgBreak
32+ breakpoint
33+ txt "=> "
4834 case unLoc t of
49− HsQualTy {} -> p_hsTypeR (unLoc t)
50− HsFunTy {} -> p_hsTypeR (unLoc t)
51− _ -> located t p_hsTypeR
52− HsTyVar NoExtField p n -> do
35+ HsQualTy {} -> p_hsType (unLoc t)
36+ HsFunTy {} -> p_hsType (unLoc t)
37+ _ -> located t p_hsType
38+ HsTyVar NoExt p n -> do
5339 case p of
54− IsPromoted -> do
55− txt "'"
56− case showOutputable (unLoc n) of
57− _ : '\'' : _ -> space
58− _ -> return ()
40+ Promoted -> txt "'"
5941 NotPromoted -> return ()
42+ case showOutputable (unLoc n) of
43+ _ : '\'' : _ -> space
44+ _ -> return ()
6045 p_rdrName n
61− HsAppTy NoExtField f x -> do
62− let -- In order to format type applications with multiple parameters
63− -- nicer, traverse the AST to gather the function and all the
64− -- parameters together.
65− gatherArgs f' knownArgs =
66− case f' of
67− L _ (HsAppTy _ l r) -> gatherArgs l (r : knownArgs)
68− _ -> (f', knownArgs)
69− (func, args) = gatherArgs f [x]
70− switchLayout (getLoc f : fmap getLoc args) . sitcc $ do
71− located func p_hsType
72− breakpoint
73− inci $
74− sep breakpoint (located' p_hsType) args
75− HsAppKindTy _ ty kd -> sitcc $ do
76− -- The first argument is the location of the "@..." part. Not 100% sure,
77− -- but I think we can ignore it as long as we use 'located' on both the
78− -- type and the kind.
79− located ty p_hsType
46+ HsAppTy NoExt f x -> sitcc $ do
47+ located f p_hsType
8048 breakpoint
81− inci $ do
82− txt "@"
83− located kd p_hsType
84− HsFunTy NoExtField x y@(L _ y') -> do
49+ inci (located x p_hsType)
50+ HsFunTy NoExt x y@(L _ y') -> do
8551 located x p_hsType
86− space
87− txt "->"
88− interArgBreak
52+ breakpoint
53+ txt "-> "
8954 case y' of
90− HsFunTy {} -> p_hsTypeR y'
91− _ -> located y p_hsTypeR
92− HsListTy NoExtField t ->
93− located t (brackets N . p_hsType)
94− HsTupleTy NoExtField tsort xs ->
55+ HsFunTy{} -> p_hsType y'
56+ _ -> located y p_hsType
57+ HsListTy NoExt t -> located t (brackets . p_hsType)
58+ HsTupleTy NoExt tsort xs ->
9559 let parens' =
9660 case tsort of
97− HsUnboxedTuple -> parensHash N
98− HsBoxedTuple -> parens N
99− HsConstraintTuple -> parens N
100− HsBoxedOrConstraintTuple -> parens N
101− in parens' $ sep commaDel (sitcc . located' p_hsType) xs
102− HsSumTy NoExtField xs ->
103− parensHash N $
104− sep (txt "|" >> breakpoint) (sitcc . located' p_hsType) xs
105− HsOpTy NoExtField x op y ->
106− sitcc $
107− let opTree = OpBranch (tyOpTree x) op (tyOpTree y)
108− in p_tyOpTree (reassociateOpTree Just opTree)
109− HsParTy NoExtField t ->
110− parens N (located t p_hsType)
111− HsIParamTy NoExtField n t -> sitcc $ do
61+ HsUnboxedTuple -> parensHash
62+ HsBoxedTuple -> parens
63+ HsConstraintTuple -> parens
64+ HsBoxedOrConstraintTuple -> parens
65+ in parens' . sitcc $
66+ sep (comma >> breakpoint) (sitcc . located' p_hsType) xs
67+ HsSumTy NoExt xs ->
68+ parensHash . sitcc $
69+ sep (txt "| " >> breakpoint') (sitcc . located' p_hsType) xs
70+ HsOpTy NoExt x op y -> sitcc $ do
71+ -- In the AST, type operators are right-associative instead of left-associative
72+ -- like value level operators. This makes similar constructs look inconsistent.
73+ -- Here, we shake the AST to convert right-associative tree to a left-associative
74+ -- one.
75+ case unLoc y of
76+ HsOpTy NoExt x' op' y' ->
77+ p_hsType $
78+ HsOpTy
79+ NoExt
80+ (L (combineSrcSpans (getLoc x) (getLoc x')) (HsOpTy NoExt x op x'))
81+ op'
82+ y'
83+ _ -> do
84+ located x p_hsType
85+ breakpoint
86+ inci $ do
87+ p_rdrName op
88+ space
89+ located y p_hsType
90+ HsParTy NoExt (L _ t@HsKindSig {}) ->
91+ -- NOTE Kind signatures already put parentheses around in all cases, so
92+ -- skip this layer of parentheses. The reason for this behavior is that
93+ -- parentheses are not always encoded with 'HsParTy', but seem to be
94+ -- always necessary when we have kind signatures in place.
95+ p_hsType t
96+ HsParTy NoExt t ->
97+ parens (located t p_hsType)
98+ HsIParamTy NoExt n t -> sitcc $ do
11299 located n atom
113− space
114− txt "::"
115100 breakpoint
116− inci (located t p_hsType)
117− HsStarTy NoExtField _ -> txt "*"
118− HsKindSig NoExtField t k -> sitcc $ do
119− located t p_hsType
120− space
121− txt "::"
122− breakpoint
123− inci (located k p_hsType)
124− HsSpliceTy NoExtField splice -> p_hsSplice splice
125− HsDocTy NoExtField t str ->
126− case docStyle of
127− PipeStyle -> do
128− p_hsDocString Pipe True str
129− located t p_hsType
130− CaretStyle -> do
131− located t p_hsType
132− newline
133− p_hsDocString Caret False str
134− HsBangTy NoExtField (HsSrcBang _ u s) t -> do
101+ inci $ do
102+ txt ":: "
103+ located t p_hsType
104+ HsStarTy NoExt _ -> txt "*"
105+ HsKindSig NoExt t k ->
106+ -- NOTE Also see the comment for 'HsParTy'.
107+ parens . sitcc $ do
108+ located t p_hsType
109+ space -- FIXME
110+ inci $ do
111+ txt ":: "
112+ located k p_hsType
113+ HsSpliceTy NoExt splice -> p_hsSplice splice
114+ HsDocTy NoExt _ _ -> error "HsDocTy"
115+ HsBangTy NoExt (HsSrcBang _ u s) t -> do
135116 case u of
136− SrcUnpack -> txt "{-# UNPACK #-}" >> space
137− SrcNoUnpack -> txt "{-# NOUNPACK #-}" >> space
117+ SrcUnpack -> txt "{-# UNPACK #-} "
118+ SrcNoUnpack -> txt "{-# NOUNPACK #-} "
138119 NoSrcUnpack -> return ()
139120 case s of
140121 SrcLazy -> txt "~"
141122 SrcStrict -> txt "!"
142123 NoSrcStrict -> return ()
143124 located t p_hsType
144− HsRecTy NoExtField fields ->
125+ HsRecTy NoExt fields ->
145126 p_conDeclFields fields
146− HsExplicitListTy NoExtField p xs -> do
127+ HsExplicitListTy NoExt p xs -> do
147128 case p of
148− IsPromoted -> txt "'"
129+ Promoted -> txt "'"
149130 NotPromoted -> return ()
150− brackets N $ do
131+ brackets $ do
151132 -- If both this list itself and the first element is promoted,
152133 -- we need to put a space in between or it fails to parse.
153134 case (p, xs) of
154− (IsPromoted, L _ t : _) | isPromoted t -> space
135+ (Promoted, ((L _ t):_)) | isPromoted t -> space
155136 _ -> return ()
156− sep commaDel (sitcc . located' p_hsType) xs
157− HsExplicitTupleTy NoExtField xs -> do
137+ sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsType) xs
138+ HsExplicitTupleTy NoExt xs -> do
158139 txt "'"
159− parens N $ do
140+ parens $ do
160141 case xs of
161− L _ t : _ | isPromoted t -> space
142+ ((L _ t):_) | isPromoted t -> space
162143 _ -> return ()
163− sep commaDel (located' p_hsType) xs
164− HsTyLit NoExtField t ->
165− case t of
166− HsStrTy (SourceText s) _ -> p_stringLit s
167− a -> atom a
168− HsWildCardTy NoExtField -> txt "_"
144+ sep (comma >> breakpoint) (located' p_hsType) xs
145+ HsTyLit NoExt t -> atom t
146+ HsWildCardTy NoExt -> txt "_"
169147 XHsType (NHsCoreTy t) -> atom t
170148 where
171149 isPromoted = \case
172− HsTyVar _ IsPromoted _ -> True
173− HsExplicitTupleTy {} -> True
174− HsExplicitListTy {} -> True
150+ HsTyVar _ Promoted _ -> True
151+ HsExplicitListTy _ _ _ -> True
152+ HsExplicitTupleTy _ _ -> True
175153 _ -> False
176− interArgBreak =
177− if multilineArgs
178− then newline
179− else breakpoint
180− p_hsTypeR = p_hsType' multilineArgs docStyle
181154
182−-- | Return 'True' if at least one argument in 'HsType' has a doc string
183−-- attached to it.
184−hasDocStrings :: HsType GhcPs -> Bool
185−hasDocStrings = \case
186− HsDocTy {} -> True
187− HsFunTy _ (L _ x) (L _ y) -> hasDocStrings x || hasDocStrings y
188− _ -> False
189155
190156p_hsContext :: HsContext GhcPs -> R ()
191157p_hsContext = \case
192158 [] -> txt "()"
193159 [x] -> located x p_hsType
194− xs -> parens N $ sep commaDel (sitcc . located' p_hsType) xs
160+ xs -> parens . sitcc $
161+ sep (comma >> breakpoint) (sitcc . located' p_hsType) xs
195162
196163p_hsTyVarBndr :: HsTyVarBndr GhcPs -> R ()
197164p_hsTyVarBndr = \case
198− UserTyVar NoExtField x ->
165+ UserTyVar NoExt x ->
199166 p_rdrName x
200− KindedTyVar NoExtField l k -> parens N $ do
167+ KindedTyVar NoExt l k -> parens $ do
201168 located l atom
202− space
203− txt "::"
204− breakpoint
205− inci (located k p_hsType)
206− XTyVarBndr x -> noExtCon x
207−
208−-- | Render several @forall@-ed variables.
209−p_forallBndrs :: Data a => ForallVisFlag -> (a -> R ()) -> [Located a] -> R ()
210−p_forallBndrs ForallInvis _ [] = txt "forall."
211−p_forallBndrs ForallVis _ [] = txt "forall ->"
212−p_forallBndrs vis p tyvars =
213− switchLayout (getLoc <$> tyvars) $ do
214− txt "forall"
215169 breakpoint
216170 inci $ do
217− sitcc $ sep breakpoint (sitcc . located' p) tyvars
218− case vis of
219− ForallInvis -> txt "."
220− ForallVis -> space >> txt "->"
171+ txt ":: "
172+ located k p_hsType
173+ XTyVarBndr NoExt -> notImplemented "XTyVarBndr"
221174
222175p_conDeclFields :: [LConDeclField GhcPs] -> R ()
223−p_conDeclFields xs =
224− braces N $ sep commaDel (sitcc . located' p_conDeclField) xs
176+p_conDeclFields xs = braces . sitcc $
177+ sep (comma >> breakpoint) (sitcc . located' p_conDeclField) xs
225178
226179p_conDeclField :: ConDeclField GhcPs -> R ()
227180p_conDeclField ConDeclField {..} = do
228− mapM_ (p_hsDocString Pipe True) cd_fld_doc
229− sitcc $
230− sep
231− commaDel
232− (located' (p_rdrName . rdrNameFieldOcc))
233− cd_fld_names
234− space
235− txt "::"
236− breakpoint
237− sitcc . inci $ p_hsType (unLoc cd_fld_type)
238−p_conDeclField (XConDeclField x) = noExtCon x
239−
240−tyOpTree :: LHsType GhcPs -> OpTree (LHsType GhcPs) (Located RdrName)
241−tyOpTree (L _ (HsOpTy NoExtField l op r)) =
242− OpBranch (tyOpTree l) op (tyOpTree r)
243−tyOpTree n = OpNode n
244−
245−p_tyOpTree :: OpTree (LHsType GhcPs) (Located RdrName) -> R ()
246−p_tyOpTree (OpNode n) = located n p_hsType
247−p_tyOpTree (OpBranch l op r) = do
248− switchLayout [opTreeLoc l] $
249− p_tyOpTree l
181+ sitcc $ sep (comma >> breakpoint)
182+ (located' (p_rdrName . rdrNameFieldOcc))
183+ cd_fld_names
250184 breakpoint
251− inci . switchLayout [opTreeLoc r] $ do
252− p_rdrName op
253− space
254− p_tyOpTree r
185+ sitcc . inci $ do
186+ txt ":: "
187+ p_hsType (unLoc cd_fld_type)
188+p_conDeclField (XConDeclField NoExt) = notImplemented "XConDeclField"
255189
256190----------------------------------------------------------------------------
257191-- Conversion functions
@@ -259,17 +193,12 @@ p_tyOpTree (OpBranch l op r) = do
259193tyVarsToTypes :: LHsQTyVars GhcPs -> [LHsType GhcPs]
260194tyVarsToTypes = \case
261195 HsQTvs {..} -> fmap tyVarToType <$> hsq_explicit
262− XLHsQTyVars x -> noExtCon x
196+ XLHsQTyVars {} -> notImplemented "XLHsQTyVars"
263197
264198tyVarToType :: HsTyVarBndr GhcPs -> HsType GhcPs
265199tyVarToType = \case
266− UserTyVar NoExtField tvar -> HsTyVar NoExtField NotPromoted tvar
267− KindedTyVar NoExtField tvar kind ->
268− -- Note: we always add parentheses because for whatever reason GHC does
269− -- not use HsParTy for left-hand sides of declarations. Please see
270− -- <https://gitlab.haskell.org/ghc/ghc/issues/17404>. This is fine as
271− -- long as 'tyVarToType' does not get applied to right-hand sides of
272− -- declarations.
273− HsParTy NoExtField . noLoc $
274− HsKindSig NoExtField (noLoc (HsTyVar NoExtField NotPromoted tvar)) kind
275− XTyVarBndr x -> noExtCon x
200+ UserTyVar NoExt tvar -> HsTyVar NoExt NotPromoted tvar
201+ KindedTyVar NoExt tvar kind ->
202+ HsParTy NoExt $ noLoc $
203+ HsKindSig NoExt (noLoc (HsTyVar NoExt NotPromoted tvar)) kind
204+ XTyVarBndr {} -> notImplemented "XTyVarBndr"
src/Ormolu/Printer/Operators.hsdeleted−177
@@ -1,177 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−
4−-- | This module helps handle operator chains composed of different
5−-- operators that may have different precedence and fixities.
6−module Ormolu.Printer.Operators
7− ( OpTree (..),
8− opTreeLoc,
9− reassociateOpTree,
10− )
11−where
12−
13−import Data.Function (on)
14−import qualified Data.List as L
15−import Data.Map.Strict (Map)
16−import qualified Data.Map.Strict as M
17−import Data.Maybe (fromMaybe, mapMaybe)
18−import GHC
19−import OccName (occNameString)
20−import Ormolu.Utils (unSrcSpan)
21−
22−-- | Intermediate representation of operator trees. It has two type
23−-- parameters: @ty@ is the type of sub-expressions, while @op@ is the type
24−-- of operators.
25−data OpTree ty op
26− = OpNode ty
27− | OpBranch
28− (OpTree ty op)
29− op
30− (OpTree ty op)
31−
32−-- | Return combined 'SrcSpan's of all elements in this 'OpTree'.
33−opTreeLoc :: OpTree (Located a) b -> SrcSpan
34−opTreeLoc (OpNode (L l _)) = l
35−opTreeLoc (OpBranch l _ r) = combineSrcSpans (opTreeLoc l) (opTreeLoc r)
36−
37−-- | Re-associate an 'OpTree' taking into account automagically inferred
38−-- relative precedence of operators. Users are expected to first construct
39−-- an initial 'OpTree', then re-associate it using this function before
40−-- printing.
41−reassociateOpTree ::
42− -- | How to get name of an operator
43− (op -> Maybe RdrName) ->
44− -- | Original 'OpTree'
45− OpTree (Located ty) (Located op) ->
46− -- | Re-associated 'OpTree'
47− OpTree (Located ty) (Located op)
48−reassociateOpTree getOpName opTree =
49− reassociateOpTreeWith
50− (buildFixityMap getOpName normOpTree)
51− (getOpName . unLoc)
52− normOpTree
53− where
54− normOpTree = normalizeOpTree opTree
55−
56−-- | Re-associate an 'OpTree' given the map with operator fixities.
57−reassociateOpTreeWith ::
58− forall ty op.
59− -- | Fixity map for operators
60− Map String Fixity ->
61− -- | How to get the name of an operator
62− (op -> Maybe RdrName) ->
63− -- | Original 'OpTree'
64− OpTree ty op ->
65− -- | Re-associated 'OpTree'
66− OpTree ty op
67−reassociateOpTreeWith fixityMap getOpName = go
68− where
69− fixityOf :: op -> Fixity
70− fixityOf op = fromMaybe defaultFixity $ do
71− s <- occNameString . rdrNameOcc <$> getOpName op
72− M.lookup s fixityMap
73− -- Here, left branch is already associated and the root alongside with
74− -- the right branch is right-associated. This function picks up one item
75− -- from the right and inserts it correctly to the left.
76− --
77− -- Also, we are using the 'compareFixity' function which tells if the
78− -- expression should associate to right.
79− go :: OpTree ty op -> OpTree ty op
80− -- base cases
81− go t@(OpNode _) = t
82− go t@(OpBranch (OpNode _) _ (OpNode _)) = t
83− -- shift one operator to the left at the beginning
84− go (OpBranch l@(OpNode _) op (OpBranch l' op' r')) =
85− go (OpBranch (OpBranch l op l') op' r')
86− -- at the last operator, place the operator and don't recurse
87− go (OpBranch (OpBranch l op r) op' r'@(OpNode _)) =
88− if snd $ compareFixity (fixityOf op) (fixityOf op')
89− then OpBranch l op (go $ OpBranch r op' r')
90− else OpBranch (OpBranch l op r) op' r'
91− -- else, shift one operator to left and recurse.
92− go (OpBranch (OpBranch l op r) op' (OpBranch l' op'' r')) =
93− if snd $ compareFixity (fixityOf op) (fixityOf op')
94− then go $ OpBranch (OpBranch l op (go $ OpBranch r op' l')) op'' r'
95− else go $ OpBranch (OpBranch (OpBranch l op r) op' l') op'' r'
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−
107−-- | Build a map of inferred 'Fixity's from an 'OpTree'.
108−buildFixityMap ::
109− forall ty op.
110− -- | How to get the name of an operator
111− (op -> Maybe RdrName) ->
112− -- | Operator tree
113− OpTree (Located ty) (Located op) ->
114− -- | Fixity map
115− Map String Fixity
116−buildFixityMap getOpName opTree =
117− addOverrides
118− . M.fromList
119− . concatMap (\(i, ns) -> map (\(n, _) -> (n, fixity i InfixL)) ns)
120− . zip [2 ..]
121− . L.groupBy ((==) `on` snd)
122− . selectScores
123− $ score opTree
124− where
125− addOverrides :: Map String Fixity -> Map String Fixity
126− addOverrides m =
127− M.fromList
128− [ ("$", fixity 0 InfixR),
129− (":", fixity 1 InfixR),
130− (".", fixity 100 InfixL)
131− ]
132− `M.union` m
133− fixity = Fixity NoSourceText
134− score :: OpTree (Located ty) (Located op) -> [(String, Score)]
135− score (OpNode _) = []
136− score (OpBranch l o r) = fromMaybe (score r) $ do
137− -- If we fail to get any of these, 'defaultFixity' will be used by
138− -- 'reassociateOpTreeWith'.
139− le <- srcSpanEndLine <$> unSrcSpan (opTreeLoc l) -- left end
140− ob <- srcSpanStartLine <$> unSrcSpan (getLoc o) -- operator begin
141− oe <- srcSpanEndLine <$> unSrcSpan (getLoc o) -- operator end
142− rb <- srcSpanStartLine <$> unSrcSpan (opTreeLoc r) -- right begin
143− oc <- srcSpanStartCol <$> unSrcSpan (getLoc o) -- operator column
144− opName <- occNameString . rdrNameOcc <$> getOpName (unLoc o)
145− let s
146− | le < ob = AtBeginning oc
147− | oe < rb = AtEnd
148− | otherwise = InBetween
149− return $ (opName, s) : score r
150− selectScores :: [(String, Score)] -> [(String, Score)]
151− selectScores =
152− L.sortOn snd
153− . mapMaybe
154− ( \case
155− [] -> Nothing
156− xs@((n, _) : _) -> Just (n, selectScore $ map snd xs)
157− )
158− . L.groupBy ((==) `on` fst)
159− . L.sort
160− selectScore :: [Score] -> Score
161− selectScore xs =
162− case filter (/= InBetween) xs of
163− [] -> InBetween
164− xs' -> maximum xs'
165−
166−----------------------------------------------------------------------------
167−-- Helpers
168−
169−-- | Convert an 'OpTree' to with all operators having the same fixity and
170−-- associativity (left infix).
171−normalizeOpTree :: OpTree ty op -> OpTree ty op
172−normalizeOpTree (OpNode n) =
173− OpNode n
174−normalizeOpTree (OpBranch (OpNode l) lop r) =
175− OpBranch (OpNode l) lop (normalizeOpTree r)
176−normalizeOpTree (OpBranch (OpBranch l' lop' r') lop r) =
177− normalizeOpTree (OpBranch l' lop' (OpBranch r' lop r))
src/Ormolu/Printer/SpanStream.hs+20−18
@@ -1,44 +1,46 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
1+{-# LANGUAGE DeriveDataTypeable #-}
22{-# LANGUAGE GeneralizedNewtypeDeriving #-}
33
44-- | Build span stream from AST.
5+
56module Ormolu.Printer.SpanStream
6− ( SpanStream (..),
7− mkSpanStream,
7+ ( SpanStream (..)
8+ , mkSpanStream
89 )
910where
1011
1112import Data.DList (DList)
12−import qualified Data.DList as D
1313import Data.Data (Data)
1414import Data.Generics (everything, ext2Q)
1515import Data.List (sortOn)
1616import Data.Typeable (cast)
1717import SrcLoc
18+import qualified Data.DList as D
1819
1920-- | A stream of 'RealSrcSpan's in ascending order. This allows us to tell
2021-- e.g. whether there is another \"located\" element of AST between current
2122-- element and comment we're considering for printing.
23+
2224newtype SpanStream = SpanStream [RealSrcSpan]
2325 deriving (Eq, Show, Data, Semigroup, Monoid)
2426
2527-- | Create 'SpanStream' from a data structure containing \"located\"
2628-- elements.
27−mkSpanStream ::
28− Data a =>
29− -- | Data structure to inspect (AST)
30− a ->
31− SpanStream
32−mkSpanStream a =
33− SpanStream
34− . sortOn realSrcSpanStart
35− . D.toList
36− $ everything mappend (const mempty `ext2Q` queryLocated) a
29+
30+mkSpanStream
31+ :: Data a
32+ => a -- ^ Data structure to inspect (AST)
33+ -> SpanStream
34+mkSpanStream a
35+ = SpanStream
36+ . sortOn realSrcSpanStart
37+ . D.toList
38+ $ everything mappend (const mempty `ext2Q` queryLocated) a
3739 where
38− queryLocated ::
39− (Data e0) =>
40− GenLocated e0 e1 ->
41− DList RealSrcSpan
40+ queryLocated
41+ :: (Data e0, Data e1)
42+ => GenLocated e0 e1
43+ -> DList RealSrcSpan
4244 queryLocated (L mspn _) =
4345 case cast mspn :: Maybe SrcSpan of
4446 Nothing -> mempty
src/Ormolu/Processing/Common.hsdeleted−27
@@ -1,27 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−-- | Common definitions for pre- and post- processing.
4−module Ormolu.Processing.Common
5− ( OrmoluState (..),
6− startDisabling,
7− endDisabling,
8− )
9−where
10−
11−import Data.String (IsString (..))
12−
13−-- | Ormolu state.
14−data OrmoluState
15− = -- | Enabled
16− OrmoluEnabled
17− | -- | Disabled
18− OrmoluDisabled
19− deriving (Eq, Show)
20−
21−-- | Marker for the beginning of the region where Ormolu should be disabled.
22−startDisabling :: IsString s => s
23−startDisabling = "{- ORMOLU_DISABLE_START"
24−
25−-- | Marker for the end of the region where Ormolu should be disabled.
26−endDisabling :: IsString s => s
27−endDisabling = "ORMOLU_DISABLE_END -}"
src/Ormolu/Processing/Cpp.hsdeleted−70
@@ -1,70 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−-- | Support for CPP.
4−module Ormolu.Processing.Cpp
5− ( State (..),
6− processLine,
7− unmaskLine,
8− )
9−where
10−
11−import Control.Monad
12−import Data.Char (isSpace)
13−import qualified Data.List as L
14−import Data.Maybe (isJust)
15−import Data.String
16−import Data.Text (Text)
17−import qualified Data.Text as T
18−
19−-- | State of the CPP processor.
20−data State
21− = -- | Outside of CPP directives
22− Outside
23− | -- | In a conditional expression
24− InConditional
25− | -- | In a continuation (after @\\@)
26− InContinuation
27− deriving (Eq, Show)
28−
29−-- | Automatically mask the line when needed and update the 'State'.
30−processLine :: String -> State -> (String, State)
31−processLine line state
32− | for "define " = (masked, state')
33− | for "include " = (masked, state')
34− | for "undef " = (masked, state')
35− | for "ifdef " = (masked, InConditional)
36− | for "ifndef " = (masked, InConditional)
37− | for "if " = (masked, InConditional)
38− | for "else" = (masked, InConditional)
39− | for "elif" = (masked, InConditional)
40− | for "endif" = (masked, state')
41− | otherwise =
42− case state of
43− Outside -> (line, Outside)
44− InConditional -> (masked, InConditional)
45− InContinuation -> (masked, state')
46− where
47− for directive = isJust $ do
48− s <- dropWhile isSpace <$> L.stripPrefix "#" line
49− void (L.stripPrefix directive s)
50− masked = maskLine line
51− state' =
52− if "\\" `L.isSuffixOf` line
53− then InContinuation
54− else Outside
55−
56−-- | Mask the given line.
57−maskLine :: String -> String
58−maskLine x = maskPrefix ++ x
59−
60−-- | If the given line is masked, unmask it. Otherwise return the line
61−-- unchanged.
62−unmaskLine :: Text -> Text
63−unmaskLine x =
64− case T.stripPrefix maskPrefix (T.stripStart x) of
65− Nothing -> x
66− Just x' -> x'
67−
68−-- | Mask prefix for CPP.
69−maskPrefix :: IsString s => s
70−maskPrefix = "-- ORMOLU_CPP_MASK"
src/Ormolu/Processing/Postprocess.hsdeleted−31
@@ -1,31 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE ViewPatterns #-}
3−
4−-- | Postprocessing for the results of printing.
5−module Ormolu.Processing.Postprocess
6− ( postprocess,
7− )
8−where
9−
10−import Data.Text (Text)
11−import qualified Data.Text as T
12−import Ormolu.Processing.Common
13−import qualified Ormolu.Processing.Cpp as Cpp
14−
15−-- | Postprocess output of the formatter.
16−postprocess ::
17− -- | Desired indentation level
18− Int ->
19− -- | Input to process
20− Text ->
21− Text
22−postprocess indent =
23− T.unlines
24− . fmap indentLine
25− . fmap Cpp.unmaskLine
26− . filter (not . magicComment)
27− . T.lines
28− where
29− magicComment (T.stripStart -> x) =
30− x == startDisabling || x == endDisabling
31− indentLine x = T.replicate indent " " <> x
src/Ormolu/Processing/Preprocess.hsdeleted−149
@@ -1,149 +0,0 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE RecordWildCards #-}
4−
5−-- | Preprocessing for input source code.
6−module Ormolu.Processing.Preprocess
7− ( preprocess,
8− )
9−where
10−
11−import Control.Monad
12−import Data.Char (isSpace)
13−import qualified Data.List as L
14−import Data.Maybe (isJust, maybeToList)
15−import FastString
16−import Ormolu.Config (RegionDeltas (..))
17−import Ormolu.Parser.Shebang (isShebang)
18−import Ormolu.Processing.Common
19−import qualified Ormolu.Processing.Cpp as Cpp
20−import SrcLoc
21−
22−-- | Transform given input possibly returning comments extracted from it.
23−-- This handles LINE pragmas, CPP, shebangs, and the magic comments for
24−-- enabling\/disabling of Ormolu.
25−preprocess ::
26− -- | File name, just to use in the spans
27− FilePath ->
28− -- | Input to process
29− String ->
30− -- | Region deltas
31− RegionDeltas ->
32− -- | Literal prefix, pre-processed input, literal suffix, extra comments
33− (String, String, String, [Located String])
34−preprocess path input RegionDeltas {..} =
35− go 1 OrmoluEnabled Cpp.Outside id id regionLines
36− where
37− (prefixLines, otherLines) = splitAt regionPrefixLength (lines input)
38− (regionLines, suffixLines) =
39− let regionLength = length otherLines - regionSuffixLength
40− in splitAt regionLength otherLines
41− go !n ormoluState cppState inputSoFar csSoFar = \case
42− [] ->
43− let input' = unlines (inputSoFar [])
44− in ( unlines prefixLines,
45− case ormoluState of
46− OrmoluEnabled -> input'
47− OrmoluDisabled -> input' ++ endDisabling,
48− unlines suffixLines,
49− csSoFar []
50− )
51− (x : xs) ->
52− let (x', ormoluState', cppState', cs) =
53− processLine path n ormoluState cppState x
54− in go
55− (n + 1)
56− ormoluState'
57− cppState'
58− (inputSoFar . (x' :))
59− (csSoFar . (maybeToList cs ++))
60− xs
61−
62−-- | Transform a given line possibly returning a comment extracted from it.
63−processLine ::
64− -- | File name, just to use in the spans
65− FilePath ->
66− -- | Line number of this line
67− Int ->
68− -- | Whether Ormolu is currently enabled
69− OrmoluState ->
70− -- | CPP state
71− Cpp.State ->
72− -- | The actual line
73− String ->
74− -- | Adjusted line and possibly a comment extracted from it
75− (String, OrmoluState, Cpp.State, Maybe (Located String))
76−processLine path n ormoluState Cpp.Outside line
77− | "{-# LINE" `L.isPrefixOf` line =
78− let (pragma, res) = getPragma line
79− size = length pragma
80− ss = mkSrcSpan (mkSrcLoc' 1) (mkSrcLoc' (size + 1))
81− in (res, ormoluState, Cpp.Outside, Just (L ss pragma))
82− | isOrmoluEnable line =
83− case ormoluState of
84− OrmoluEnabled ->
85− (enableMarker, OrmoluEnabled, Cpp.Outside, Nothing)
86− OrmoluDisabled ->
87− (endDisabling ++ enableMarker, OrmoluEnabled, Cpp.Outside, Nothing)
88− | isOrmoluDisable line =
89− case ormoluState of
90− OrmoluEnabled ->
91− (disableMarker ++ startDisabling, OrmoluDisabled, Cpp.Outside, Nothing)
92− OrmoluDisabled ->
93− (disableMarker, OrmoluDisabled, Cpp.Outside, Nothing)
94− | isShebang line =
95− let ss = mkSrcSpan (mkSrcLoc' 1) (mkSrcLoc' (length line))
96− in ("", ormoluState, Cpp.Outside, Just (L ss line))
97− | otherwise =
98− let (line', cppState') = Cpp.processLine line Cpp.Outside
99− in (line', ormoluState, cppState', Nothing)
100− where
101− mkSrcLoc' = mkSrcLoc (mkFastString path) n
102−processLine _ _ ormoluState cppState line =
103− let (line', cppState') = Cpp.processLine line cppState
104− in (line', ormoluState, cppState', Nothing)
105−
106−-- | Take a line pragma and output its replacement (where line pragma is
107−-- replaced with spaces) and the contents of the pragma itself.
108−getPragma ::
109− -- | Pragma line to analyze
110− String ->
111− -- | Contents of the pragma and its replacement line
112− (String, String)
113−getPragma [] = error "Ormolu.Preprocess.getPragma: input must not be empty"
114−getPragma s@(x : xs)
115− | "#-}" `L.isPrefixOf` s = ("#-}", " " ++ drop 3 s)
116− | otherwise =
117− let (prag, remline) = getPragma xs
118− in (x : prag, ' ' : remline)
119−
120−-- | Canonical enable marker.
121−enableMarker :: String
122−enableMarker = "{- ORMOLU_ENABLE -}"
123−
124−-- | Canonical disable marker.
125−disableMarker :: String
126−disableMarker = "{- ORMOLU_DISABLE -}"
127−
128−-- | Return 'True' if the given string is an enabling marker.
129−isOrmoluEnable :: String -> Bool
130−isOrmoluEnable = magicComment "ORMOLU_ENABLE"
131−
132−-- | Return 'True' if the given string is a disabling marker.
133−isOrmoluDisable :: String -> Bool
134−isOrmoluDisable = magicComment "ORMOLU_DISABLE"
135−
136−-- | Construct a function for whitespace-insensitive matching of string.
137−magicComment ::
138− -- | What to expect
139− String ->
140− -- | String to test
141− String ->
142− -- | Whether or not the two strings watch
143− Bool
144−magicComment expected s0 = isJust $ do
145− let trim = dropWhile isSpace
146− s1 <- trim <$> L.stripPrefix "{-" (trim s0)
147− s2 <- trim <$> L.stripPrefix expected s1
148− s3 <- L.stripPrefix "-}" s2
149− guard (all isSpace s3)
src/Ormolu/Utils.hs+18−137
@@ -1,155 +1,36 @@
1+-- | Random utilities used by the code.
2+
13{-# LANGUAGE LambdaCase #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE ViewPatterns #-}
44
5−-- | Random utilities used by the code.
65module Ormolu.Utils
7− ( RelativePos (..),
8− attachRelativePos,
9− combineSrcSpans',
10− notImplemented,
11− showOutputable,
12− splitDocString,
13− typeArgToType,
14− unSrcSpan,
15− incSpanLine,
16− separatedByBlank,
17− separatedByBlankNE,
18− onTheSameLine,
19− removeIndentation,
6+ ( combineSrcSpans'
7+ , isModule
8+ , notImplemented
9+ , showOutputable
2010 )
2111where
2212
23−import Data.Char (isSpace)
24−import Data.List (dropWhileEnd)
13+import Data.Data (Data, showConstr, toConstr)
2514import Data.List.NonEmpty (NonEmpty (..))
26−import qualified Data.List.NonEmpty as NE
27−import Data.Maybe (fromMaybe)
28−import Data.Text (Text)
29−import qualified Data.Text as T
30−import GHC
31−import GHC.DynFlags (baseDynFlags)
15+import SrcLoc
3216import qualified Outputable as GHC
3317
34−-- | Relative positions in a list.
35−data RelativePos
36− = SinglePos
37− | FirstPos
38− | MiddlePos
39− | LastPos
40− deriving (Eq, Show)
41−
42−-- | Attach 'RelativePos'es to elements of a given list.
43−attachRelativePos :: [a] -> [(RelativePos, a)]
44−attachRelativePos = \case
45− [] -> []
46− [x] -> [(SinglePos, x)]
47− (x : xs) -> (FirstPos, x) : markLast xs
48− where
49− markLast [] = []
50− markLast [x] = [(LastPos, x)]
51− markLast (x : xs) = (MiddlePos, x) : markLast xs
52−
5318-- | Combine all source spans from the given list.
19+
5420combineSrcSpans' :: NonEmpty SrcSpan -> SrcSpan
55−combineSrcSpans' (x :| xs) = foldr combineSrcSpans x xs
21+combineSrcSpans' (x:|xs) = foldr combineSrcSpans x xs
22+
23+-- | Return 'True' if given element of AST is module.
24+
25+isModule :: Data a => a -> Bool
26+isModule x = showConstr (toConstr x) == "HsModule"
5627
5728-- | Placeholder for things that are not yet implemented.
29+
5830notImplemented :: String -> a
5931notImplemented msg = error $ "not implemented yet: " ++ msg
6032
6133-- | Pretty-print an 'GHC.Outputable' thing.
62−showOutputable :: GHC.Outputable o => o -> String
63−showOutputable = GHC.showSDoc baseDynFlags . GHC.ppr
64−
65−-- | Split and normalize a doc string. The result is a list of lines that
66−-- make up the comment.
67−splitDocString :: HsDocString -> [Text]
68−splitDocString docStr =
69− case r of
70− [] -> [""]
71− _ -> r
72− where
73− r =
74− fmap escapeLeadingDollar
75− . dropPaddingSpace
76− . dropWhileEnd T.null
77− . fmap (T.stripEnd . T.pack)
78− . lines
79− $ unpackHDS docStr
80− -- We cannot have the first character to be a dollar because in that
81− -- case it'll be a parse error (apparently collides with named docs
82− -- syntax @-- $name@ somehow).
83− escapeLeadingDollar txt =
84− case T.uncons txt of
85− Just ('$', _) -> T.cons '\\' txt
86− _ -> txt
87− dropPaddingSpace xs =
88− case dropWhile T.null xs of
89− [] -> []
90− (x : _) ->
91− let leadingSpace txt = case T.uncons txt of
92− Just (' ', _) -> True
93− _ -> False
94− dropSpace txt =
95− if leadingSpace txt
96− then T.drop 1 txt
97− else txt
98− in if leadingSpace x
99− then dropSpace <$> xs
100− else xs
101−
102−-- | Get 'LHsType' out of 'LHsTypeArg'.
103−typeArgToType :: LHsTypeArg p -> LHsType p
104−typeArgToType = \case
105− HsValArg tm -> tm
106− HsTypeArg _ ty -> ty
107− HsArgPar _ -> notImplemented "HsArgPar"
108−
109−-- | Get 'RealSrcSpan' out of 'SrcSpan' if the span is “helpful”.
110−unSrcSpan :: SrcSpan -> Maybe RealSrcSpan
111−unSrcSpan = \case
112− RealSrcSpan r -> Just r
113− UnhelpfulSpan _ -> Nothing
114−
115−-- | Increment line number in a 'SrcSpan'.
116−incSpanLine :: Int -> SrcSpan -> SrcSpan
117−incSpanLine i = \case
118− RealSrcSpan s ->
119− let start = realSrcSpanStart s
120− end = realSrcSpanEnd s
121− incLine x =
122− let file = srcLocFile x
123− line = srcLocLine x
124− col = srcLocCol x
125− in mkRealSrcLoc file (line + i) col
126− in RealSrcSpan (mkRealSrcSpan (incLine start) (incLine end))
127− UnhelpfulSpan x -> UnhelpfulSpan x
12834
129−-- | Do two declarations have a blank between them?
130−separatedByBlank :: (a -> SrcSpan) -> a -> a -> Bool
131−separatedByBlank loc a b =
132− fromMaybe False $ do
133− endA <- srcSpanEndLine <$> unSrcSpan (loc a)
134− startB <- srcSpanStartLine <$> unSrcSpan (loc b)
135− pure (startB - endA >= 2)
136−
137−-- | Do two declaration groups have a blank between them?
138−separatedByBlankNE :: (a -> SrcSpan) -> NonEmpty a -> NonEmpty a -> Bool
139−separatedByBlankNE loc a b = separatedByBlank loc (NE.last a) (NE.head b)
140−
141−-- | Return 'True' if one span ends on the same line the second one starts.
142−onTheSameLine :: SrcSpan -> SrcSpan -> Bool
143−onTheSameLine a b =
144− isOneLineSpan (mkSrcSpan (srcSpanEnd a) (srcSpanStart b))
145−
146−-- | Remove indentation from a given 'String'. Return the input with
147−-- indentation removed and the detected indentation level.
148−removeIndentation :: String -> (String, Int)
149−removeIndentation (lines -> xs) = (unlines (drop n <$> xs), n)
150− where
151− n = minimum (getIndent <$> xs)
152− getIndent y =
153− if all isSpace y
154− then 0
155− else length (takeWhile isSpace y)
35+showOutputable :: GHC.Outputable o => o -> String
36+showOutputable = GHC.showSDocUnsafe . GHC.ppr
tests/Ormolu/Parser/PragmaSpec.hs+3−4
@@ -4,7 +4,7 @@ import Ormolu.Parser.Pragma
44import Test.Hspec
55
66spec :: Spec
7−spec =
7+spec = do
88 describe "parsePragma" $ do
99 stdTest "{-# LANGUAGE Foo #-}" (Just (PragmaLanguage ["Foo"]))
1010 stdTest "{-# language Foo #-}" (Just (PragmaLanguage ["Foo"]))
@@ -21,6 +21,5 @@ spec =
2121 stdTest "{-#OPTIONS_HADDOCK foo, bar, baz #-}" (Just $ PragmaOptionsHaddock "foo, bar, baz")
2222
2323stdTest :: String -> Maybe Pragma -> Spec
24−stdTest input result =
25− it input $
26− parsePragma input `shouldBe` result
24+stdTest input result = it input $
25+ parsePragma input `shouldBe` result
tests/Ormolu/Printer/CombinatorsSpec.hsnew file+112
@@ -0,0 +1,112 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+
3+module Ormolu.Printer.CombinatorsSpec (spec) where
4+
5+import Ormolu.Parser.Anns
6+import Ormolu.Printer.Combinators
7+import Ormolu.Printer.Internal
8+import Test.Hspec
9+import qualified Data.Text.IO as T
10+
11+-- NOTE Testing combinators in separation is easy, but it's not very useful
12+-- either because interesting things happen only when combinators are used
13+-- together. However, there are too many combinations to test, so we test
14+-- just a few things here and expect new tests to be added on demand when
15+-- particularly tricky or problematic use cases are discovered.
16+--
17+-- The printing logic is indirectly tested in the main bulk of reformatting
18+-- tests.
19+
20+spec :: Spec
21+spec = do
22+ stdTest "simple signature" rSimpleSig "ssig"
23+ stdTest "list" rList0 "list0"
24+ stdTest "list with annotated name in it" rList1 "list1"
25+ stdTest "module header" rModuleHeader "mhdr"
26+
27+-- | Do a standard test prodedure testing both single-line and multi-line
28+-- layouts.
29+
30+stdTest
31+ :: String -- ^ Test name
32+ -> R () -- ^ Computation to test
33+ -> FilePath -- ^ Base file name where expected result is stored
34+ -> Spec
35+stdTest name m path = describe name $ do
36+ let spath = "data/printer/" ++ path ++ "-single.hs"
37+ mpath = "data/printer/" ++ path ++ "-multi.hs"
38+ it "single-line works" $
39+ singleLine m `shouldRender` spath
40+ it "multi-line works" $
41+ multiLine m `shouldRender` mpath
42+
43+----------------------------------------------------------------------------
44+-- Test computations
45+
46+rSimpleSig :: R ()
47+rSimpleSig = line rFn
48+
49+rList0 :: R ()
50+rList0 = line . brackets . sitcc $
51+ sep (comma >> breakpoint) id
52+ [ txt "foo"
53+ , txt "bar"
54+ , txt "baz"
55+ ]
56+
57+rList1 :: R ()
58+rList1 = line . brackets . sitcc $
59+ sep (comma >> breakpoint) id
60+ [ txt "foo"
61+ , txt "bar"
62+ , rFn
63+ ]
64+
65+rFn :: R ()
66+rFn = sitcc $ sep breakpoint sitcc
67+ [ txt "foo"
68+ , inci . sitcc $ sep breakpoint sitcc
69+ [ do txt ":: "
70+ parens . sitcc $ sep breakpoint sitcc
71+ [ txt "Int"
72+ , txt "-> " >> txt "Int"
73+ ]
74+ , txt "-> " >> txt "Bool"
75+ ]
76+ ]
77+
78+rModuleHeader :: R ()
79+rModuleHeader = do
80+ line $ do
81+ txt "module "
82+ txt "MyModule"
83+ line . inci . parens . sitcc . sep (comma >> breakpoint) sitcc $
84+ [ txt "R"
85+ , txt "runR"
86+ , txt "txt"
87+ , txt "blah"
88+ ]
89+ line (txt "where")
90+
91+----------------------------------------------------------------------------
92+-- Helpers
93+
94+-- | Run given computation in @'R' ()@ monad and compare result of rendering
95+-- with contents of a given file.
96+
97+shouldRender :: R () -> FilePath -> Expectation
98+shouldRender m path = do
99+ let rendered = runR False m mempty mempty emptyAnns
100+ -- T.writeFile path rendered
101+ expected <- T.readFile path
102+ rendered `shouldBe` expected
103+
104+-- | Render using single-line layout.
105+
106+singleLine :: R () -> R ()
107+singleLine = enterLayout SingleLine
108+
109+-- | Render using multi-line layout.
110+
111+multiLine :: R () -> R ()
112+multiLine = enterLayout MultiLine
tests/Ormolu/PrinterSpec.hs+22−31
@@ -2,18 +2,17 @@
22
33module Ormolu.PrinterSpec (spec) where
44
5−import Control.Exception
65import Control.Monad
76import Control.Monad.IO.Class
87import Data.List (isSuffixOf)
98import Data.Text (Text)
10−import qualified Data.Text as T
11−import qualified Data.Text.IO as T
129import Ormolu
1310import Path
1411import Path.IO
15−import qualified System.FilePath as F
12+import System.FilePath (addExtension, dropExtensions, splitExtensions)
1613import Test.Hspec
14+import qualified Data.Text as T
15+import qualified Data.Text.IO as T
1716
1817spec :: Spec
1918spec = do
@@ -21,8 +20,9 @@ spec = do
2120 forM_ es checkExample
2221
2322-- | Check a single given example.
23+
2424checkExample :: Path Rel File -> Spec
25−checkExample srcPath' = it (fromRelFile srcPath' ++ " works") . withNiceExceptions $ do
25+checkExample srcPath' = it (fromRelFile srcPath' ++ " works") $ do
2626 let srcPath = examplesDir </> srcPath'
2727 expectedOutputPath <- deriveOutput srcPath
2828 -- 1. Given input snippet of source code parse it and pretty print it.
@@ -41,51 +41,42 @@ checkExample srcPath' = it (fromRelFile srcPath' ++ " works") . withNiceExceptio
4141 shouldMatch True formatted1 formatted0
4242
4343-- | Build list of examples for testing.
44+
4445locateExamples :: IO [Path Rel File]
4546locateExamples =
4647 filter isInput . snd <$> listDirRecurRel examplesDir
4748
4849-- | Does given path look like input path (as opposed to expected output
4950-- path)?
51+
5052isInput :: Path Rel File -> Bool
5153isInput path =
5254 let s = fromRelFile path
53− (s', exts) = F.splitExtensions s
54− in exts == ".hs" && not ("-out" `isSuffixOf` s')
55+ (s', exts) = splitExtensions s
56+ in exts == ".hs" && not ("-out" `isSuffixOf` s')
5557
5658-- | For given path of input file return expected name of output.
59+
5760deriveOutput :: Path Rel File -> IO (Path Rel File)
58−deriveOutput path =
59− parseRelFile $
60− F.addExtension (F.dropExtensions (fromRelFile path) ++ "-out") "hs"
61+deriveOutput path = parseRelFile $
62+ addExtension (dropExtensions (fromRelFile path) ++ "-out") "hs"
6163
6264-- | A version of 'shouldBe' that is specialized to comparing 'Text' values.
6365-- It also prints multi-line snippets in a more readable form.
66+
6467shouldMatch :: Bool -> Text -> Text -> Expectation
65−shouldMatch idempotenceTest actual expected =
66− when (actual /= expected) . expectationFailure $
67− unlines
68− [ ">>>>>>>>>>>>>>>>>>>>>> expected (" ++ pass ++ "):",
69− T.unpack expected,
70− ">>>>>>>>>>>>>>>>>>>>>> but got:",
71− T.unpack actual
72− ]
68+shouldMatch idempotencyTest actual expected =
69+ when (actual /= expected) . expectationFailure $ unlines
70+ [ ">>>>>>>>>>>>>>>>>>>>>> expected (" ++ pass ++ "):"
71+ , T.unpack expected
72+ , ">>>>>>>>>>>>>>>>>>>>>> but got:"
73+ , T.unpack actual
74+ ]
7375 where
7476 pass =
75− if idempotenceTest
76− then "idempotence pass"
77+ if idempotencyTest
78+ then "idempotency pass"
7779 else "first pass"
7880
7981examplesDir :: Path Rel Dir
8082examplesDir = $(mkRelDir "data/examples")
81−
82−-- | Inside this wrapper 'OrmoluException' will be caught and displayed
83−-- nicely using 'displayException'.
84−withNiceExceptions ::
85− -- | Action that may throw the exception
86− Expectation ->
87− Expectation
88−withNiceExceptions m = m `catch` h
89− where
90− h :: OrmoluException -> IO ()
91− h = expectationFailure . displayException