Skip to content
This repository was archived by the owner on Oct 7, 2020. It is now read-only.

Support more commands #145

Merged
merged 6 commits into from
Dec 22, 2015
Merged

Support more commands #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7865596
Add paramaters and docstring to the command funs
cocreature Dec 21, 2015
7d14bcd
Pass parameters to hie-run-command
cocreature Dec 21, 2015
ce9534c
Pass additional arguments to hie
cocreature Dec 22, 2015
3423cf6
Ask interactively for additional arguments
cocreature Dec 22, 2015
ca8e74b
Handle refactor responses
cocreature Dec 22, 2015
faddaf8
Fix hare tests
cocreature Dec 22, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 84 additions & 32 deletions elisp/hie.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
(defvar hie-process-handle-invalid-input nil
"A function to handle invalid input.")

(defvar hie-refactor-buffer nil
"Buffer holidng the diff for refactoring")

(defvar hie-post-message-hook nil
"Function to call with message that will be send to hie process.")
(defvar hie-plugins nil
Expand Down Expand Up @@ -159,7 +162,9 @@ association lists and count on HIE to use default values there."
(defun hie-handle-message (json)
(-if-let ((&alist 'type_info type-info) json)
(hie-handle-type-info type-info)
(message (format "%s" json))))
(-if-let ((&alist 'refactor refactor) json)
(hie-handle-refactor refactor)
(message (format "%s" json)))))

(defun hie-handle-type-info (type-info)
(-if-let (((&alist 'type type)) type-info)
Expand All @@ -168,20 +173,43 @@ association lists and count on HIE to use default values there."
(format "Error extracting type from type-info response: %s"
type-info))))

(defun hie-handle-command-detail (json)
(-let* (((&alist 'contexts contexts 'name command-name 'plugin_name plugin-name) json)
(context
(hie-get-context contexts)))
(setq hie-process-handle-message
#'hie-handle-message)
(hie-post-message
`(("cmd" . ,(hie-format-cmd (cons plugin-name command-name)))
("params" . ,context)))))
(defmacro hie-with-refactor-buffer (&rest body)
'(setq hie-refactor-buffer (get-buffer-create "*hie-refactor*"))
`(with-current-buffer hie-refactor-buffer ,@body))

(defmacro hie-literal-save-excursion (&rest body)
"Like save-excursion but preserves line and column instead of point"
`(let ((old-col (current-column))
(old-row (line-number-at-pos)))
(save-excursion
,@body)
(move-to-column old-col)
(goto-line old-row)))

(defun hie-handle-refactor (refactor)
(-if-let (((&alist 'first first 'second second 'diff diff)) refactor)
(progn
(hie-with-refactor-buffer
(erase-buffer)
(insert diff))
(let ((refactored-buffer (create-file-buffer second))
(old-buffer (or (find-buffer-visiting first)
(create-file-buffer first))))
(find-file-noselect-1 refactored-buffer second nil nil second nil)
(with-current-buffer old-buffer
(hie-literal-save-excursion
(erase-buffer)
(with-current-buffer refactored-buffer
(copy-to-buffer old-buffer (point-min) (point-max)))
(kill-buffer refactored-buffer)))))
(message
(format "Error extracting refactor information from refactor response: %s"
refactor))))

(defun hie-format-cmd (cmd)
(format "%s:%s" (car cmd) (cdr cmd)))

(defun hie-get-context (context)
(defun hie-get-context ()
;; we need to increment the column by one, since emacs column
;; numbers start at 0 while ghc column numbers start at 1
(let ((start (save-excursion (if (use-region-p) (goto-char (region-beginning)))
Expand All @@ -190,17 +218,21 @@ association lists and count on HIE to use default values there."
`(("line" . ,(line-number-at-pos)) ("col" . ,(1+ (current-column))))))
(filename (buffer-file-name)))
`(("file" . (("file" . ,filename)))
("start_pos" . ,end)
("end_pos" . ,start))))
("start_pos" . ,start)
("end_pos" . ,end))))

(defun hie-run-command (plugin command)
(defun hie-run-command (plugin command args)
(setq hie-process-handle-message
#'hie-handle-command-detail)
(setq hie-current-cmd (cons plugin command))
(hie-post-message
`(("cmd" . "base:commandDetail")
("params" . (("command" . (("text" . ,command)))
("plugin" . (("text" . ,plugin))))))))
#'hie-handle-message)
(let ((additional-args
(-map
(-lambda ((&alist 'type type 'name name 'val val 'name))
(cons name (list (cons type val))))
args))
(context (hie-get-context)))
(hie-post-message
`(("cmd" . ,(hie-format-cmd (cons plugin command)))
("params" . (,@context ,@ additional-args))))))

(defun hie-handle-first-plugins-command (json)
"Handle first plugins call."
Expand All @@ -218,25 +250,45 @@ association lists and count on HIE to use default values there."
name))))
commands)))
plugins))
(command-names
(-map
(-lambda ((plugin-name . commands))
(cons plugin-name
(-map
(-lambda ((&alist 'name name))
name)
commands)))
plugins)))
(command-names plugins))
(setq hie-plugins plugins)
(hie-create-all-commands command-names)
(easy-menu-define hie-menu hie-mode-map
"Menu for Haskell IDE Engine"
(cons "HIE" menu-items))))

(defun hie-create-command (plugin command)
`(defun ,(intern (concat "hie-" (symbol-name plugin) "-" command)) ()
(interactive)
(hie-run-command ,(symbol-name plugin) ,command)))
(-let* (((&alist 'name command-name 'additional_params params 'ui_description desc)
command)
(required-params
(-filter (-lambda ((&alist 'required required)) required)
params))
(param-names (-map (-lambda ((&alist 'name name)) (downcase name))
required-params))
(param-args (-map 'intern param-names))
(param-docstrings
(-map
(-lambda ((&alist 'name name 'help desc))
(format "%s: %s" (upcase name) desc))
required-params))
(docstring
(format "%s\n%s" desc (mapconcat 'identity param-docstrings "\n")))
(param-vals (-map
(-lambda ((&alist 'name name 'type type))
`(list (cons 'name ,(downcase name))
(cons 'type ,type)
(cons 'val ,(intern (downcase name)))))
required-params))
(interactive-strings
(-map
(-lambda ((&alist 'name name 'help desc))
(format "s%s (%s): " name desc))
required-params)))
`(defun ,(intern (concat "hie-" (symbol-name plugin) "-" command-name)) ,param-args
,docstring
(interactive ,(mapconcat 'identity interactive-strings "\n"))
(hie-run-command ,(symbol-name plugin) ,command-name
(list ,@param-vals)))))

(defun hie-create-all-commands (command-names)
(eval `(progn
Expand Down
1 change: 1 addition & 0 deletions haskell-ide-engine.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ test-suite haskell-ide-test
, containers
, directory
, fast-logger
, filepath
, haskell-ide-engine
, hie-apply-refact
, hie-base
Expand Down
2 changes: 1 addition & 1 deletion hie-hare/Haskell/Ide/HaRePlugin.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ makeRefactorResult changedFiles = do
(HieDiff f s d) <- diffFiles f1 f2
f' <- liftIO $ makeRelativeToCurrentDirectory f
s' <- liftIO $ makeRelativeToCurrentDirectory s
return (HieDiff f' s' d)
return (HieDiff f s d)
diffs <- mapM diffOne changedFiles
return (RefactorResult diffs)

Expand Down
28 changes: 15 additions & 13 deletions test/HaRePluginSpec.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import Haskell.Ide.Engine.PluginDescriptor
import Haskell.Ide.Engine.SemanticTypes
import Haskell.Ide.Engine.Types
import Haskell.Ide.HaRePlugin
import System.Directory
import System.FilePath
import Test.Hspec

-- ---------------------------------------------------------------------
Expand Down Expand Up @@ -48,7 +50,7 @@ dispatchRequest req = do
hareSpec :: Spec
hareSpec = do
describe "hare plugin commands" $ do

cwd <- runIO $ getCurrentDirectory
-- ---------------------------------

it "renames" $ do
Expand All @@ -59,8 +61,8 @@ hareSpec = do
r <- dispatchRequest req
r `shouldBe`
Just (IdeResponseOk (jsWrite (RefactorResult [HieDiff
"test/testdata/HaReRename.hs"
"test/testdata/HaReRename.refactored.hs"
(cwd </> "test/testdata/HaReRename.hs")
(cwd </> "test/testdata/HaReRename.refactored.hs")
("4,5c4,5\n"++
"< foo :: Int -> Int\n"++
"< foo x = x + 3\n"++
Expand Down Expand Up @@ -88,8 +90,8 @@ hareSpec = do
r <- dispatchRequest req
-- r `shouldBe` Just (IdeResponseOk (H.fromList ["refactor" .= ["test/testdata/HaReDemote.hs"::FilePath]]))
r `shouldBe` Just (IdeResponseOk $ jsWrite (RefactorResult [HieDiff
"test/testdata/HaReDemote.hs"
"test/testdata/HaReDemote.refactored.hs"
(cwd </> "test/testdata/HaReDemote.hs")
(cwd </> "test/testdata/HaReDemote.refactored.hs")
("5,6c5,6\n"++
"< \n"++
"< y = 7\n"++
Expand All @@ -112,8 +114,8 @@ hareSpec = do
,("name",ParamValP $ ParamText "foonew")])
r <- dispatchRequest req
r `shouldBe` Just (IdeResponseOk $ jsWrite (RefactorResult [HieDiff
"test/testdata/HaReRename.hs"
"test/testdata/HaReRename.refactored.hs"
(cwd </> "test/testdata/HaReRename.hs")
(cwd </> "test/testdata/HaReRename.refactored.hs")
("6a7,9\n"++
"> foonew :: Int -> Int\n"++
"> foonew x = x + 3\n"++
Expand All @@ -129,8 +131,8 @@ hareSpec = do
,("end_pos", ParamValP $ ParamPos (9,12))])
r <- dispatchRequest req
r `shouldBe` Just (IdeResponseOk $ jsWrite (RefactorResult [HieDiff
"test/testdata/HaReCase.hs"
"test/testdata/HaReCase.refactored.hs"
(cwd </> "test/testdata/HaReCase.hs")
(cwd </> "test/testdata/HaReCase.refactored.hs")
("5,9c5,9\n"++
"< foo x = if odd x\n"++
"< then\n"++
Expand All @@ -152,8 +154,8 @@ hareSpec = do
,("start_pos",ParamValP $ ParamPos (6,5))])
r <- dispatchRequest req
r `shouldBe` Just (IdeResponseOk $ jsWrite (RefactorResult [HieDiff
"test/testdata/HaReMoveDef.hs"
"test/testdata/HaReMoveDef.refactored.hs"
(cwd </> "test/testdata/HaReMoveDef.hs")
(cwd </> "test/testdata/HaReMoveDef.refactored.hs")
("5,6d4\n"++
"< where\n"++
"< y = 4\n"++
Expand All @@ -170,8 +172,8 @@ hareSpec = do
,("start_pos",ParamValP $ ParamPos (12,9))])
r <- dispatchRequest req
r `shouldBe` Just (IdeResponseOk $ jsWrite (RefactorResult [HieDiff
"test/testdata/HaReMoveDef.hs"
"test/testdata/HaReMoveDef.refactored.hs"
(cwd </> "test/testdata/HaReMoveDef.hs")
(cwd </> "test/testdata/HaReMoveDef.refactored.hs")
("11,12d10\n"++
"< where\n"++
"< z = 7\n"++
Expand Down