nvim-hs-contrib (empty) → 0.0.6
raw patch · 7 files changed
+420/−0 lines, 7 filesdep +QuickCheckdep +ansi-wl-pprintdep +basesetup-changed
Dependencies added: QuickCheck, ansi-wl-pprint, base, bytestring, data-default, directory, exceptions, hspec, hspec-discover, messagepack, mtl, nvim-hs, parsec, process, resourcet, setenv, stm, text, time, transformers, transformers-base, utf8-string
Files
- CHANGELOG.md +2/−0
- LICENSE +202/−0
- Setup.hs +2/−0
- library/Neovim/User/Choice.hs +77/−0
- library/Neovim/User/Input.hs +56/−0
- nvim-hs-contrib.cabal +80/−0
- test-suite/Spec.hs +1/−0
+ CHANGELOG.md view
@@ -0,0 +1,2 @@+$ 0.0.6 Initial version+
+ LICENSE view
@@ -0,0 +1,202 @@+ 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.+
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ library/Neovim/User/Choice.hs view
@@ -0,0 +1,77 @@+{-# LANGUAGE LambdaCase #-}+{- |+Module : Neovim.User.Choice+Description : Ask the user for an answer+Copyright : (c) Sebastian Witte+License : Apache-2.0++Maintainer : woozletoff@gmail.com+Stability : experimental+Portability : GHC++-}+module Neovim.User.Choice+ where++import Neovim++import Data.Char (toLower)+import Data.List (isPrefixOf)+import Text.PrettyPrint.ANSI.Leijen as P hiding ((<$>))+++-- | Call @inputlist()@ on the neovim side and ask the user for a choice. This+-- function returns 'Nothing' if the user input was invalid or 'Just' the chosen+-- element. The elements are rendered via 'Pretty'.+oneOf :: Pretty a => [a] -> Neovim r st (Maybe a)+oneOf cs = fmap (\i -> cs !! (i-1)) <$> askForIndex (zipWith mkChoice cs [1..])+ where+ mkChoice c i = toObject $ int i P.<> text "." <+> pretty c+++-- | Ask user for a choice and 'Maybe' return the index of that choice+-- (1-based).+askForIndex :: [Object] -> Neovim r st (Maybe Int)+askForIndex cs = vim_call_function "inputlist" [ObjectArray cs] >>= \case+ Left e ->+ (err . text . show) e++ Right a -> case fromObject a of+ Right i | i >= 1 && i <= length cs ->+ return $ Just i++ Right _ ->+ return Nothing++ Left e ->+ err e+++-- | Same as 'oneOf' only that @a@ is constrained by 'Show' insted of 'Pretty'.+oneOfS :: Show a => [a] -> Neovim r st (Maybe a)+oneOfS cs = fmap (\i -> cs !! (i-1)) <$> askForIndex (zipWith mkChoice cs [1..])+ where+ mkChoice c i = toObject $ show (i :: Int) ++ ". " ++ show c+++-- | Open @inputdialog@s inside neovim until the user has successfully typed any+-- prefix of @yes@ or @no@ or alternatively aborted the dialog. Defaults to+-- @yes@ for the empty input.+yesOrNo :: String -- ^ Question to the user+ -> Neovim r st Bool+yesOrNo message = do+ spec <- vim_call_function+ "inputdialog" $ (message ++ " (Y/n) ") +: "" +: "no" +: []+ case fmap fromObject spec of+ Right (Right s) | map toLower s `isPrefixOf` "yes" ->+ return True++ Right (Right s) | map toLower s `isPrefixOf` "no" ->+ return False++ Right (Left e) ->+ err e++ _ ->+ yesOrNo message+
+ library/Neovim/User/Input.hs view
@@ -0,0 +1,56 @@+{-# LANGUAGE LambdaCase #-}+{- |+Module : Neovim.User.Input+Description : Utility functions to retrieve user input+Copyright : (c) Sebastian Witte+License : Apache-2.0++Maintainer : woozletoff@gmail.com+Stability : experimental+Portability : GHC++-}+module Neovim.User.Input+ where++import Neovim+import Neovim.User.Choice++import System.Directory+++-- | Helper function that calls the @input()@ function of neovim.+input :: String -- ^ Message to display+ -> Maybe String -- ^ Input fiiled in+ -> Maybe String -- ^ Completion mode+ -> Neovim r st (Either Object Object)+input message mPrefilled mCompletion = vim_call_function "input" $+ (message <> " ")+ +: maybe "" id mPrefilled+ +: maybe [] (+: []) mCompletion+++-- | Prompt the user to specify a directory.+--+-- If the directory does not exist, ask the usere whether it should be created.+askForDirectory :: String -- ^ Message to put in front+ -> Maybe FilePath -- ^ Prefilled text+ -> Neovim r st FilePath+askForDirectory message mPrefilled = do+ fp <- errOnInvalidResult $ input message mPrefilled (Just "dir")++ efp <- errOnInvalidResult $+ vim_call_function "expand" $ (fp :: FilePath) +: []++ whenM (not <$> liftIO (doesDirectoryExist efp)) $+ whenM (yesOrNo (efp ++ " does not exist, create it?")) $+ liftIO $ createDirectoryIfMissing True efp++ return efp+++askForString :: String -- ^ message to put in front+ -> Maybe String -- ^ Prefilled text+ -> Neovim r st String+askForString message mPrefilled =+ errOnInvalidResult $ input message mPrefilled Nothing
+ nvim-hs-contrib.cabal view
@@ -0,0 +1,80 @@+name: nvim-hs-contrib+version: 0.0.6+synopsis: Haskell plugin backend for neovim+description:+ Library for nvim-hs.+homepage: https://github.com/neovimhaskell/nvim-hs+license: Apache-2.0+license-file: LICENSE+author: Sebastian Witte+maintainer: woozletoff@gmail.com+copyright: Copyright (C) Sebastian Witte+category: Editor+build-type: Simple+cabal-version: >=1.10+extra-source-files: CHANGELOG.md+source-repository head+ type: git+ location: https://github.com/neovimhaskell/nvim-hs++library+ exposed-modules: Neovim.User.Choice+ , Neovim.User.Input++ -- other-extensions:+ build-depends: base >=4.6 && < 5+ , nvim-hs >= 0.0.6 && < 0.1+ , ansi-wl-pprint+ , bytestring+ , data-default+ , directory+ , exceptions+ , messagepack >= 0.4+ , mtl >= 2.2.1 && < 2.3+ , parsec >= 3.1.9+ , process+ , resourcet+ , setenv >= 0.1.1.3+ , stm+ , text+ , time+ , transformers+ , transformers-base+ , utf8-string++ hs-source-dirs: library+ default-language: Haskell2010+ ghc-options: -Wall+++test-suite hspec+ type: exitcode-stdio-1.0+ hs-source-dirs: test-suite+ main-is: Spec.hs+ default-language: Haskell2010+ build-depends: base >= 4.6 && < 5+ , nvim-hs >= 0.0.6 && < 0.1++ , hspec ==2.*+ , hspec-discover+ , QuickCheck >=2.6++ , ansi-wl-pprint+ , bytestring+ , data-default+ , exceptions+ , messagepack >= 0.4+ , mtl >= 2.2.1 && < 2.3+ , parsec >= 3.1.9+ , process+ , resourcet+ , setenv >= 0.1.1.3+ , stm+ , text+ , time+ , transformers+ , transformers-base+ , utf8-string++ ghc-options: -threaded -rtsopts -with-rtsopts=-N+
+ test-suite/Spec.hs view
@@ -0,0 +1,1 @@+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}