haskell/haskell-language-server
1
1
Fork 0
mirror of https://github.com/haskell/haskell-language-server.git synced 2024-09-11 08:45:35 +03:00
Code Issues Projects Releases Wiki Activity

Move HIE files stuff to a new hie-compat package (haskell/ghcide#877)

Browse Source 
* 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 :(((((
This commit is contained in:
wz1000 2020-10-20 12:48:56 +05:30 committed by GitHub
parent d6af61d6ff
commit 243f51b8e4
21 changed files with 325 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ghcide/cabal.project
View File

@ -1,4 +1,4 @@
packages: .
packages: . ./hie-compat/
test-show-details: direct

19
ghcide/ghcide.cabal
View File

@ -54,6 +54,7 @@ library
hashable,
haskell-lsp-types == 0.22.*,
haskell-lsp == 0.22.*,
hie-compat,
mtl,
network-uri,
prettyprinter-ansi-terminal,
@ -184,24 +185,6 @@ library
Development.IDE.Plugin.Completions.Logic
Development.IDE.Plugin.Completions.Types
Development.IDE.Types.Action
if (impl(ghc > 8.5) && impl(ghc < 8.7)) && !flag(ghc-lib)
hs-source-dirs: src-ghc86
other-modules:
Development.IDE.GHC.HieAst
Development.IDE.GHC.HieBin
Development.IDE.GHC.HieTypes
Development.IDE.GHC.HieDebug
Development.IDE.GHC.HieUtils
if (impl(ghc > 8.7) && impl(ghc < 8.10)) || flag(ghc-lib)
hs-source-dirs: src-ghc88
other-modules:
Development.IDE.GHC.HieAst
Development.IDE.GHC.HieBin
if (impl(ghc > 8.9))
hs-source-dirs: src-ghc810
other-modules:
Development.IDE.GHC.HieAst
Development.IDE.GHC.HieBin
ghc-options: -Wall -Wno-name-shadowing -Wincomplete-uni-patterns
executable ghcide-test-preprocessor

22
ghcide/src/Development/IDE/GHC/Compat.hs
View File

@ -57,13 +57,8 @@ module Development.IDE.GHC.Compat(
module GHC,
initializePlugins,
applyPluginsParsedResultAction,
#if MIN_GHC_API_VERSION(8,8,0)
module HieTypes,
module HieUtils,
#else
module Development.IDE.GHC.HieTypes,
module Development.IDE.GHC.HieUtils,
#endif
module Compat.HieTypes,
module Compat.HieUtils,
) where
@ -82,6 +77,10 @@ import NameCache
import qualified Data.ByteString as BS
import MkIface
import TcRnTypes
import Compat.HieAst (mkHieFile,enrichHie)
import Compat.HieBin
import Compat.HieTypes
import Compat.HieUtils
#if MIN_GHC_API_VERSION(8,10,0)
import GHC.Hs.Extension
@ -106,18 +105,11 @@ import Data.List (foldl', isSuffixOf)
import ErrUtils (ErrorMessages)
import FastString (FastString)
import Development.IDE.GHC.HieAst (mkHieFile,enrichHie)
import Development.IDE.GHC.HieBin
import DynamicLoading
import Plugins (Plugin(parsedResultAction), withPlugins)
import Data.Map.Strict (Map)
#if MIN_GHC_API_VERSION(8,8,0)
import HieUtils
import HieTypes
#else
import Development.IDE.GHC.HieUtils
import Development.IDE.GHC.HieTypes
#if !MIN_GHC_API_VERSION(8,8,0)
import System.FilePath ((-<.>))
#endif

1
ghcide/stack.yaml
View File

@ -1,6 +1,7 @@
resolver: nightly-2019-09-21
packages:
- .
- ./hie-compat/
extra-deps:
- aeson-1.4.6.0
- haskell-lsp-0.22.0.0

5
hie-compat/CHANGELOG.md Normal file
View File

@ -0,0 +1,5 @@
# Revision history for hie-compat
## 0.1.0.0 -- 2020-10-19
* Initial Release

201
hie-compat/LICENSE Normal file
View File

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2019 Zubin Duggal
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

20
hie-compat/README.md Normal file
View File

@ -0,0 +1,20 @@
# hie-compat
Mainly a backport of [HIE
Files](https://gitlab.haskell.org/ghc/ghc/-/wikis/hie-files) for ghc 8.6, along
with a few other backports of fixes useful for `ghcide`
Fully compatible with `.hie` files natively produced by versions of GHC that support
them.
**THIS DOES NOT LET YOU READ HIE FILES WITH MISMATCHED VERSIONS OF GHC**
Backports included:
https://gitlab.haskell.org/ghc/ghc/-/merge_requests/4037
https://gitlab.haskell.org/ghc/ghc/-/merge_requests/4068
https://gitlab.haskell.org/ghc/ghc/-/merge_requests/3199
https://gitlab.haskell.org/ghc/ghc/-/merge_requests/2578

67
hie-compat/hie-compat.cabal Normal file
View File

@ -0,0 +1,67 @@
cabal-version: >=1.10
name: hie-compat
version: 0.1.0.0
synopsis: HIE files for GHC 8.6 and other HIE file backports
license: Apache-2.0
description:
Backports for HIE files to GHC 8.6, along with a few other backports
of HIE file related fixes for ghcide
THIS DOES NOT LET YOU READ HIE FILES WITH MISMATCHED VERSIONS OF GHC
license-file: LICENSE
author: Zubin Duggal
maintainer: zubin.duggal@gmail.com
build-type: Simple
extra-source-files: CHANGELOG.md
flag ghc-lib
description: build against ghc-lib instead of the ghc package
default: False
manual: True
library
default-language: Haskell2010
build-depends:
base, array, bytestring, containers, directory, filepath, transformers
if flag(ghc-lib)
build-depends:
ghc-lib
hs-source-dirs: src-ghc88
reexported-modules:
HieTypes as Compat.HieTypes,
HieDebug as Compat.HieDebug,
HieUtils as Compat.HieUtils
exposed-modules:
Compat.HieAst
Compat.HieBin
else
build-depends:
ghc,
ghc-boot
if (impl(ghc > 8.5) && impl(ghc < 8.7) && !flag(ghc-lib))
hs-source-dirs: src-ghc86
exposed-modules:
Compat.HieAst
Compat.HieBin
Compat.HieTypes
Compat.HieDebug
Compat.HieUtils
if (impl(ghc > 8.7) && impl(ghc < 8.10) && !flag(ghc-lib))
hs-source-dirs: src-ghc88
exposed-modules:
Compat.HieAst
Compat.HieBin
if (impl(ghc > 8.9) && impl(ghc < 8.11) && !flag(ghc-lib))
hs-source-dirs: src-ghc810
exposed-modules:
Compat.HieAst
Compat.HieBin
if (impl(ghc > 8.7) && impl(ghc < 8.11) && !flag(ghc-lib))
reexported-modules:
HieTypes as Compat.HieTypes,
HieDebug as Compat.HieDebug,
HieUtils as Compat.HieUtils

2
src-ghc810/Development/IDE/GHC/HieAst.hs → hie-compat/src-ghc810/Compat/HieAst.hs
View File

@ -17,7 +17,7 @@ Main functions for .hie file generation
{-# LANGUAGE AllowAmbiguousTypes #-}
{-# LANGUAGE ViewPatterns #-}
{-# LANGUAGE DeriveDataTypeable #-}
module Development.IDE.GHC.HieAst ( mkHieFile, enrichHie ) where
module Compat.HieAst ( mkHieFile, enrichHie ) where
import GhcPrelude

2
src-ghc810/Development/IDE/GHC/HieBin.hs → hie-compat/src-ghc810/Compat/HieBin.hs
View File

@ -3,7 +3,7 @@ Binary serialization for .hie files.
-}
{- HLINT ignore -}
{-# LANGUAGE ScopedTypeVariables #-}
module Development.IDE.GHC.HieBin ( readHieFile, readHieFileWithVersion, HieHeader, writeHieFile, HieName(..), toHieName, HieFileResult(..), hieMagic, hieNameOcc,NameCacheUpdater(..)) where
module Compat.HieBin ( readHieFile, readHieFileWithVersion, HieHeader, writeHieFile, HieName(..), toHieName, HieFileResult(..), hieMagic, hieNameOcc,NameCacheUpdater(..)) where
import GHC.Settings ( maybeRead )

6
src-ghc86/Development/IDE/GHC/HieAst.hs → hie-compat/src-ghc86/Compat/HieAst.hs
View File

@ -17,7 +17,7 @@ Main functions for .hie file generation
{-# LANGUAGE ViewPatterns #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DataKinds #-}
module Development.IDE.GHC.HieAst ( mkHieFile, enrichHie ) where
module Compat.HieAst ( mkHieFile, enrichHie ) where
import Avail ( Avails )
import Bag ( Bag, bagToList )
@ -41,8 +41,8 @@ import Var ( Id, Var, setVarName, varName, varType )
import TcRnTypes
import MkIface ( mkIfaceExports )
import Development.IDE.GHC.HieTypes
import Development.IDE.GHC.HieUtils
import Compat.HieTypes
import Compat.HieUtils
import qualified Data.Array as A
import qualified Data.ByteString as BS

4
src-ghc86/Development/IDE/GHC/HieBin.hs → hie-compat/src-ghc86/Compat/HieBin.hs
View File

@ -2,7 +2,7 @@
Binary serialization for .hie files.
-}
{-# LANGUAGE ScopedTypeVariables #-}
module Development.IDE.GHC.HieBin ( readHieFile, readHieFileWithVersion, HieHeader, writeHieFile, HieName(..), toHieName, HieFileResult(..), hieMagic,NameCacheUpdater(..)) where
module Compat.HieBin ( readHieFile, readHieFileWithVersion, HieHeader, writeHieFile, HieName(..), toHieName, HieFileResult(..), hieMagic,NameCacheUpdater(..)) where
import Config ( cProjectVersion )
import Binary
@ -32,7 +32,7 @@ import Control.Monad ( replicateM, when )
import System.Directory ( createDirectoryIfMissing )
import System.FilePath ( takeDirectory )
import Development.IDE.GHC.HieTypes
import Compat.HieTypes
-- | `Name`'s get converted into `HieName`'s before being written into @.hie@
-- files. See 'toHieName' and 'fromHieName' for logic on how to convert between

8
src-ghc86/Development/IDE/GHC/HieDebug.hs → hie-compat/src-ghc86/Compat/HieDebug.hs
View File

@ -4,7 +4,7 @@ Functions to validate and check .hie file ASTs generated by GHC.
{-# LANGUAGE StandaloneDeriving #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE FlexibleContexts #-}
module Development.IDE.GHC.HieDebug where
module Compat.HieDebug where
import Prelude hiding ((<>))
import SrcLoc
@ -12,9 +12,9 @@ import Module
import FastString
import Outputable
import Development.IDE.GHC.HieTypes
import Development.IDE.GHC.HieBin
import Development.IDE.GHC.HieUtils
import Compat.HieTypes
import Compat.HieBin
import Compat.HieUtils
import qualified Data.Map as M
import qualified Data.Set as S

2
src-ghc86/Development/IDE/GHC/HieTypes.hs → hie-compat/src-ghc86/Compat/HieTypes.hs
View File

@ -9,7 +9,7 @@ For more information see https://gitlab.haskell.org/ghc/ghc/wikis/hie-files
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# OPTIONS_GHC -Wno-orphans #-}
module Development.IDE.GHC.HieTypes where
module Compat.HieTypes where
import Config
import Binary

4
src-ghc86/Development/IDE/GHC/HieUtils.hs → hie-compat/src-ghc86/Compat/HieUtils.hs
View File

@ -2,7 +2,7 @@
{-# LANGUAGE TupleSections #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE FlexibleInstances #-}
module Development.IDE.GHC.HieUtils where
module Compat.HieUtils where
import CoreMap
import DynFlags ( DynFlags )
@ -18,7 +18,7 @@ import Type
import Var
import VarEnv
import Development.IDE.GHC.HieTypes
import Compat.HieTypes
import qualified Data.Map as M
import qualified Data.Set as S

2
src-ghc88/Development/IDE/GHC/HieAst.hs → hie-compat/src-ghc88/Compat/HieAst.hs
View File

@ -16,7 +16,7 @@ Main functions for .hie file generation
{-# LANGUAGE AllowAmbiguousTypes #-}
{-# LANGUAGE ViewPatterns #-}
{-# LANGUAGE DeriveDataTypeable #-}
module Development.IDE.GHC.HieAst ( mkHieFile, enrichHie ) where
module Compat.HieAst ( mkHieFile, enrichHie ) where
import Avail ( Avails )
import Bag ( Bag, bagToList )

2
src-ghc88/Development/IDE/GHC/HieBin.hs → hie-compat/src-ghc88/Compat/HieBin.hs
View File

@ -3,7 +3,7 @@ Binary serialization for .hie files.
-}
{- HLINT ignore -}
{-# LANGUAGE ScopedTypeVariables #-}
module Development.IDE.GHC.HieBin ( readHieFile, readHieFileWithVersion, HieHeader, writeHieFile, HieName(..), toHieName, HieFileResult(..), hieMagic,NameCacheUpdater(..)) where
module Compat.HieBin ( readHieFile, readHieFileWithVersion, HieHeader, writeHieFile, HieName(..), toHieName, HieFileResult(..), hieMagic,NameCacheUpdater(..)) where
import Config ( cProjectVersion )
import Binary

3
stack-ghc-lib.yaml
View File

@ -1,6 +1,7 @@
resolver: nightly-2019-09-16
packages:
- .
- ./hie-compat/
extra-deps:
- haskell-lsp-0.22.0.0
- haskell-lsp-types-0.22.0.0
@ -21,6 +22,8 @@ nix:
flags:
ghcide:
ghc-lib: True
hie-compat:
ghc-lib: True
ghc-options:
ghc-lib-parser: -O0
ghc-lib: -O0

1
stack810.yaml
View File

@ -2,6 +2,7 @@ resolver: nightly-2020-09-02
allow-newer: true
packages:
- .
- ./hie-compat/
extra-deps:
- haskell-lsp-0.22.0.0
- haskell-lsp-types-0.22.0.0

1
stack8101.yaml
View File

@ -2,6 +2,7 @@ resolver: nightly-2020-06-19
allow-newer: true
packages:
- .
- ./hie-compat/
extra-deps:
- haskell-lsp-0.22.0.0
- haskell-lsp-types-0.22.0.0

1
stack88.yaml
View File

@ -1,6 +1,7 @@
resolver: lts-16.12
packages:
- .
- ./hie-compat/
extra-deps:
- haskell-lsp-0.22.0.0
- haskell-lsp-types-0.22.0.0