hls-graph (empty) → 1.3.0.0

raw patch · 9 files changed

+424/−0 lines, 9 filesdep +basedep +bytestringdep +shake

Dependencies added: base, bytestring, shake, unordered-containers

Files

• LICENSE +201/−0
• hls-graph.cabal +57/−0
• src/Development/IDE/Graph.hs +25/−0
• src/Development/IDE/Graph/Classes.hs +6/−0
• src/Development/IDE/Graph/Database.hs +18/−0
• src/Development/IDE/Graph/Internal/Action.hs +38/−0
• src/Development/IDE/Graph/Internal/Options.hs +40/−0
• src/Development/IDE/Graph/Internal/Rules.hs +24/−0
• src/Development/IDE/Graph/Rule.hs +15/−0

@@ -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 [yyyy] [name of copyright owner]++   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.

@@ -0,0 +1,57 @@+cabal-version: 2.4+name:          hls-graph+version:       1.3.0.0+synopsis:      Haskell Language Server internal graph API+description:+  Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>++homepage:      https://github.com/haskell/haskell-language-server#readme+bug-reports:   https://github.com/haskell/haskell-language-server/issues+license:       Apache-2.0+license-file:  LICENSE+author:        The Haskell IDE Team+maintainer:    alan.zimm@gmail.com+copyright:     The Haskell IDE Team+category:      Development+build-type:    Simple++flag pedantic+  description: Enable -Werror+  default:     False+  manual:      True++source-repository head+  type:     git+  location: https://github.com/haskell/haskell-language-server++library+  exposed-modules:+    Development.IDE.Graph+    Development.IDE.Graph.Classes+    Development.IDE.Graph.Database+    Development.IDE.Graph.Rule++  other-modules:+    Development.IDE.Graph.Internal.Action+    Development.IDE.Graph.Internal.Options+    Development.IDE.Graph.Internal.Rules++  hs-source-dirs:     src+  build-depends:+    , base >=4.12 && <5+    , bytestring+    , shake >= 0.19.4+    , unordered-containers++  ghc-options:+    -Wall -Wredundant-constraints -Wno-name-shadowing+    -Wno-unticked-promoted-constructors++  if flag(pedantic)+    ghc-options: -Werror++  default-language:   Haskell2010+  default-extensions:+    DataKinds+    KindSignatures+    TypeOperators

@@ -0,0 +1,25 @@+{-# LANGUAGE PatternSynonyms #-}++module Development.IDE.Graph(+    shakeOptions,+    Rules,+    Action, action,+    actionFinally, actionBracket, actionCatch,+    Shake.ShakeException(..),+    -- * Configuration+    ShakeOptions(shakeAllowRedefineRules, shakeThreads, shakeFiles, shakeExtra),+    getShakeExtra, getShakeExtraRules, newShakeExtra,+    -- * Explicit parallelism+    parallel,+    -- * Oracle rules+    Shake.ShakeValue, Shake.RuleResult,+    -- * Special rules+    alwaysRerun,+    -- * Batching+    reschedule,+    ) where++import qualified Development.Shake as Shake+import Development.IDE.Graph.Internal.Action+import Development.IDE.Graph.Internal.Options+import Development.IDE.Graph.Internal.Rules

@@ -0,0 +1,6 @@++module Development.IDE.Graph.Classes(+    Show(..), Typeable, Eq(..), Hashable(..), Binary(..), NFData(..)+    ) where++import Development.Shake.Classes

@@ -0,0 +1,18 @@++module Development.IDE.Graph.Database(+    Shake.ShakeDatabase,+    shakeOpenDatabase,+    shakeRunDatabase,+    Shake.shakeProfileDatabase,+    ) where++import qualified Development.Shake.Database as Shake+import Development.IDE.Graph.Internal.Action+import Development.IDE.Graph.Internal.Options+import Development.IDE.Graph.Internal.Rules++shakeOpenDatabase :: ShakeOptions -> Rules () -> IO (IO Shake.ShakeDatabase, IO ())+shakeOpenDatabase a b = Shake.shakeOpenDatabase (fromShakeOptions a) (fromRules b)++shakeRunDatabase :: Shake.ShakeDatabase -> [Action a] -> IO ([a], [IO ()])+shakeRunDatabase a b = Shake.shakeRunDatabase a (map fromAction b)

@@ -0,0 +1,38 @@+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE TypeFamilies #-}++module Development.IDE.Graph.Internal.Action where++import qualified Development.Shake as Shake+import qualified Development.Shake.Rule as Shake+import Development.Shake.Classes+import Control.Exception+import Control.Monad.IO.Class+import Control.Monad.Fail++newtype Action a = Action {fromAction :: Shake.Action a}+    deriving (Monad, Applicative, Functor, MonadIO, MonadFail)++alwaysRerun :: Action ()+alwaysRerun = Action Shake.alwaysRerun++reschedule :: Double -> Action ()+reschedule = Action . Shake.reschedule++parallel :: [Action a] -> Action [a]+parallel = Action . Shake.parallel . map fromAction++actionCatch :: Exception e => Action a -> (e -> Action a) -> Action a+actionCatch a b = Action $ Shake.actionCatch (fromAction a) (fromAction . b)++actionBracket :: IO a -> (a -> IO b) -> (a -> Action c) -> Action c+actionBracket a b c = Action $ Shake.actionBracket a b (fromAction . c)++actionFinally :: Action a -> IO b -> Action a+actionFinally a b = Action $ Shake.actionFinally (fromAction a) b++apply1 :: (Shake.RuleResult key ~ value, Shake.ShakeValue key, Typeable value) => key -> Action value+apply1 = Action . Shake.apply1++apply :: (Shake.RuleResult key ~ value, Shake.ShakeValue key, Typeable value) => [key] -> Action [value]+apply = Action . Shake.apply

@@ -0,0 +1,40 @@+{-# LANGUAGE RecordWildCards #-}++module Development.IDE.Graph.Internal.Options where++import qualified Development.Shake as Shake+import qualified Data.HashMap.Strict as Map+import Development.IDE.Graph.Internal.Action+import Development.IDE.Graph.Internal.Rules+import Data.Dynamic++data ShakeOptions = ShakeOptions {+    shakeThreads :: Int,+    shakeFiles :: FilePath,+    shakeExtra :: Maybe Dynamic,+    shakeAllowRedefineRules :: Bool,+    shakeTimings :: Bool+    }++shakeOptions :: ShakeOptions+shakeOptions = ShakeOptions 0 ".shake" Nothing False False++fromShakeOptions :: ShakeOptions -> Shake.ShakeOptions+fromShakeOptions ShakeOptions{..} = Shake.shakeOptions{+    Shake.shakeThreads = shakeThreads,+    Shake.shakeFiles = shakeFiles,+    Shake.shakeExtra = maybe Map.empty f shakeExtra,+    Shake.shakeAllowRedefineRules = shakeAllowRedefineRules,+    Shake.shakeTimings = shakeTimings+    }+    where f x = Map.singleton (dynTypeRep x) x+++getShakeExtra :: Typeable a => Action (Maybe a)+getShakeExtra = Action Shake.getShakeExtra++getShakeExtraRules :: Typeable a => Rules (Maybe a)+getShakeExtraRules = Rules Shake.getShakeExtraRules++newShakeExtra :: Typeable a => a -> Maybe Dynamic+newShakeExtra = Just . toDyn

@@ -0,0 +1,24 @@+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE TypeFamilies #-}++module Development.IDE.Graph.Internal.Rules where++import qualified Development.Shake as Shake+import qualified Development.Shake.Rule as Shake+import Development.Shake.Classes+import Development.IDE.Graph.Internal.Action+import Control.Monad.IO.Class+import Control.Monad.Fail+import qualified Data.ByteString as BS++newtype Rules a = Rules {fromRules :: Shake.Rules a}+    deriving (Monoid, Semigroup, Monad, Applicative, Functor, MonadIO, MonadFail)++action :: Action a -> Rules ()+action = Rules . Shake.action . fromAction++addRule+    :: (Shake.RuleResult key ~ value, Shake.ShakeValue key, Typeable value, NFData value, Show value)+    => (key -> Maybe BS.ByteString -> Shake.RunMode -> Action (Shake.RunResult value))+    -> Rules ()+addRule f = Rules $ Shake.addBuiltinRule Shake.noLint Shake.noIdentity $ \k bs r -> fromAction $ f k bs r

@@ -0,0 +1,15 @@+{-# LANGUAGE TypeFamilies #-}++module Development.IDE.Graph.Rule(+    -- * Defining builtin rules+    -- | Functions and types for defining new types of Shake rules.+    addRule,+    Shake.RunMode(..), Shake.RunChanged(..), Shake.RunResult(..),+    -- * Calling builtin rules+    -- | Wrappers around calling Shake rules. In general these should be specialised to a builtin rule.+    apply, apply1,+    ) where++import qualified Development.Shake.Rule as Shake+import Development.IDE.Graph.Internal.Action+import Development.IDE.Graph.Internal.Rules