Skip to content

Commit 5bf1532

Browse files
authored
Move HIE files stuff to a new hie-compat package (#877)
* Move HIE files stuff to a new hie-compat package * add ghc-lib flag for hie-compat * ghc-lib :( * ghc-lib :((( * ghc-lib :(((( * ghc-lib :(((((
1 parent 9f3fc61 commit 5bf1532

File tree

21 files changed

+325
-50
lines changed

21 files changed

+325
-50
lines changed

cabal.project

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
packages: .
1+
packages: . ./hie-compat/
22

33
test-show-details: direct
44

ghcide.cabal

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ library
5454
hashable,
5555
haskell-lsp-types == 0.22.*,
5656
haskell-lsp == 0.22.*,
57+
hie-compat,
5758
mtl,
5859
network-uri,
5960
prettyprinter-ansi-terminal,
@@ -184,24 +185,6 @@ library
184185
Development.IDE.Plugin.Completions.Logic
185186
Development.IDE.Plugin.Completions.Types
186187
Development.IDE.Types.Action
187-
if (impl(ghc > 8.5) && impl(ghc < 8.7)) && !flag(ghc-lib)
188-
hs-source-dirs: src-ghc86
189-
other-modules:
190-
Development.IDE.GHC.HieAst
191-
Development.IDE.GHC.HieBin
192-
Development.IDE.GHC.HieTypes
193-
Development.IDE.GHC.HieDebug
194-
Development.IDE.GHC.HieUtils
195-
if (impl(ghc > 8.7) && impl(ghc < 8.10)) || flag(ghc-lib)
196-
hs-source-dirs: src-ghc88
197-
other-modules:
198-
Development.IDE.GHC.HieAst
199-
Development.IDE.GHC.HieBin
200-
if (impl(ghc > 8.9))
201-
hs-source-dirs: src-ghc810
202-
other-modules:
203-
Development.IDE.GHC.HieAst
204-
Development.IDE.GHC.HieBin
205188
ghc-options: -Wall -Wno-name-shadowing -Wincomplete-uni-patterns
206189

207190
executable ghcide-test-preprocessor

hie-compat/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Revision history for hie-compat
2+
3+
## 0.1.0.0 -- 2020-10-19
4+
5+
* Initial Release

hie-compat/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2019 Zubin Duggal
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

hie-compat/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# hie-compat
2+
3+
Mainly a backport of [HIE
4+
Files](https://gitlab.haskell.org/ghc/ghc/-/wikis/hie-files) for ghc 8.6, along
5+
with a few other backports of fixes useful for `ghcide`
6+
7+
Fully compatible with `.hie` files natively produced by versions of GHC that support
8+
them.
9+
10+
**THIS DOES NOT LET YOU READ HIE FILES WITH MISMATCHED VERSIONS OF GHC**
11+
12+
Backports included:
13+
14+
https://gitlab.haskell.org/ghc/ghc/-/merge_requests/4037
15+
16+
https://gitlab.haskell.org/ghc/ghc/-/merge_requests/4068
17+
18+
https://gitlab.haskell.org/ghc/ghc/-/merge_requests/3199
19+
20+
https://gitlab.haskell.org/ghc/ghc/-/merge_requests/2578

hie-compat/hie-compat.cabal

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
cabal-version: >=1.10
2+
name: hie-compat
3+
version: 0.1.0.0
4+
synopsis: HIE files for GHC 8.6 and other HIE file backports
5+
license: Apache-2.0
6+
description:
7+
Backports for HIE files to GHC 8.6, along with a few other backports
8+
of HIE file related fixes for ghcide
9+
THIS DOES NOT LET YOU READ HIE FILES WITH MISMATCHED VERSIONS OF GHC
10+
license-file: LICENSE
11+
author: Zubin Duggal
12+
maintainer: zubin.duggal@gmail.com
13+
build-type: Simple
14+
extra-source-files: CHANGELOG.md
15+
16+
17+
flag ghc-lib
18+
description: build against ghc-lib instead of the ghc package
19+
default: False
20+
manual: True
21+
22+
library
23+
default-language: Haskell2010
24+
build-depends:
25+
base, array, bytestring, containers, directory, filepath, transformers
26+
27+
if flag(ghc-lib)
28+
build-depends:
29+
ghc-lib
30+
hs-source-dirs: src-ghc88
31+
reexported-modules:
32+
HieTypes as Compat.HieTypes,
33+
HieDebug as Compat.HieDebug,
34+
HieUtils as Compat.HieUtils
35+
exposed-modules:
36+
Compat.HieAst
37+
Compat.HieBin
38+
else
39+
build-depends:
40+
ghc,
41+
ghc-boot
42+
43+
if (impl(ghc > 8.5) && impl(ghc < 8.7) && !flag(ghc-lib))
44+
hs-source-dirs: src-ghc86
45+
exposed-modules:
46+
Compat.HieAst
47+
Compat.HieBin
48+
Compat.HieTypes
49+
Compat.HieDebug
50+
Compat.HieUtils
51+
if (impl(ghc > 8.7) && impl(ghc < 8.10) && !flag(ghc-lib))
52+
hs-source-dirs: src-ghc88
53+
exposed-modules:
54+
Compat.HieAst
55+
Compat.HieBin
56+
if (impl(ghc > 8.9) && impl(ghc < 8.11) && !flag(ghc-lib))
57+
hs-source-dirs: src-ghc810
58+
exposed-modules:
59+
Compat.HieAst
60+
Compat.HieBin
61+
62+
if (impl(ghc > 8.7) && impl(ghc < 8.11) && !flag(ghc-lib))
63+
reexported-modules:
64+
HieTypes as Compat.HieTypes,
65+
HieDebug as Compat.HieDebug,
66+
HieUtils as Compat.HieUtils
67+

src-ghc810/Development/IDE/GHC/HieAst.hs renamed to hie-compat/src-ghc810/Compat/HieAst.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Main functions for .hie file generation
1717
{-# LANGUAGE AllowAmbiguousTypes #-}
1818
{-# LANGUAGE ViewPatterns #-}
1919
{-# LANGUAGE DeriveDataTypeable #-}
20-
module Development.IDE.GHC.HieAst ( mkHieFile, enrichHie ) where
20+
module Compat.HieAst ( mkHieFile, enrichHie ) where
2121

2222
import GhcPrelude
2323

src-ghc810/Development/IDE/GHC/HieBin.hs renamed to hie-compat/src-ghc810/Compat/HieBin.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Binary serialization for .hie files.
33
-}
44
{- HLINT ignore -}
55
{-# LANGUAGE ScopedTypeVariables #-}
6-
module Development.IDE.GHC.HieBin ( readHieFile, readHieFileWithVersion, HieHeader, writeHieFile, HieName(..), toHieName, HieFileResult(..), hieMagic, hieNameOcc,NameCacheUpdater(..)) where
6+
module Compat.HieBin ( readHieFile, readHieFileWithVersion, HieHeader, writeHieFile, HieName(..), toHieName, HieFileResult(..), hieMagic, hieNameOcc,NameCacheUpdater(..)) where
77

88
import GHC.Settings ( maybeRead )
99

src-ghc86/Development/IDE/GHC/HieAst.hs renamed to hie-compat/src-ghc86/Compat/HieAst.hs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Main functions for .hie file generation
1717
{-# LANGUAGE ViewPatterns #-}
1818
{-# LANGUAGE DeriveDataTypeable #-}
1919
{-# LANGUAGE DataKinds #-}
20-
module Development.IDE.GHC.HieAst ( mkHieFile, enrichHie ) where
20+
module Compat.HieAst ( mkHieFile, enrichHie ) where
2121

2222
import Avail ( Avails )
2323
import Bag ( Bag, bagToList )
@@ -41,8 +41,8 @@ import Var ( Id, Var, setVarName, varName, varType )
4141
import TcRnTypes
4242
import MkIface ( mkIfaceExports )
4343

44-
import Development.IDE.GHC.HieTypes
45-
import Development.IDE.GHC.HieUtils
44+
import Compat.HieTypes
45+
import Compat.HieUtils
4646

4747
import qualified Data.Array as A
4848
import qualified Data.ByteString as BS

src-ghc86/Development/IDE/GHC/HieBin.hs renamed to hie-compat/src-ghc86/Compat/HieBin.hs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Binary serialization for .hie files.
33
-}
44
{-# LANGUAGE ScopedTypeVariables #-}
5-
module Development.IDE.GHC.HieBin ( readHieFile, readHieFileWithVersion, HieHeader, writeHieFile, HieName(..), toHieName, HieFileResult(..), hieMagic,NameCacheUpdater(..)) where
5+
module Compat.HieBin ( readHieFile, readHieFileWithVersion, HieHeader, writeHieFile, HieName(..), toHieName, HieFileResult(..), hieMagic,NameCacheUpdater(..)) where
66

77
import Config ( cProjectVersion )
88
import Binary
@@ -32,7 +32,7 @@ import Control.Monad ( replicateM, when )
3232
import System.Directory ( createDirectoryIfMissing )
3333
import System.FilePath ( takeDirectory )
3434

35-
import Development.IDE.GHC.HieTypes
35+
import Compat.HieTypes
3636

3737
-- | `Name`'s get converted into `HieName`'s before being written into @.hie@
3838
-- files. See 'toHieName' and 'fromHieName' for logic on how to convert between

0 commit comments

Comments
 (0)