This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+lang/ocaml/packages.el

168 lines
5.4 KiB
EmacsLisp
Raw Normal View History

2015-02-07 17:37:53 +00:00
;;; packages.el --- ocaml Layer packages File for Spacemacs
;;
2018-01-04 07:00:25 +00:00
;; Copyright (c) 2012-2018 Sylvain Benner & Contributors
2015-02-07 17:37:53 +00:00
;;
;; Author: Sylvain Benner <sylvain.benner@gmail.com>
;; URL: https://github.com/syl20bnr/spacemacs
;;
;; This file is not part of GNU Emacs.
;;
;;; License: GPLv3
(setq ocaml-packages
'(
;; auto-complete
company
flycheck
flycheck-ocaml
ggtags
counsel-gtags
helm-gtags
merlin
ocp-indent
smartparens
tuareg
utop
))
2015-02-07 17:37:53 +00:00
(defun ocaml/post-init-company ()
(when (configuration-layer/package-used-p 'merlin)
Refactor and simplify company backends declaration Enabling a company backend for a specific mode was a tedious tasks with code scattered at different locations, one for local variable definitions, one for company hook function definitions and another where the backends were pushed to the local variables (which was problematic, since we ended up pushing the same backends over and over again with `SPC f e R`, pushes have been replaced by add-to-list calls in the new macro). All these steps are now put together at one place with the new macro spacemacs|add-company-backends, check its docstring for more info on its arguments. This macro also allows to define arbitrary buffer local variables to tune company for specific modes (similar to layer variables via a keyword :variables) The code related to company backends management has been moved to the auto-completion layer in the funcs.el file. A nice side effect of this move is that it enforces correct encapsulation of company backends related code. We can now easily detect if there is some configuration leakage when the auto-completion layer is not used. But we loose macro expansion at file loading time (not sue it is a big concern though). The function spacemacs|enable-auto-complete was never used so it has been deleted which led to the deletion of the now empty file core-auto-completion.el. The example in LAYERS.org regarding auto-completion is now out of date and has been deleted. An example to setup auto-completion is provided in the README.org file of the auto-completion layer.
2017-01-02 05:39:04 +00:00
(spacemacs|add-company-backends
:backends merlin-company-backend
:modes merlin-mode
:variables merlin-completion-with-doc t)))
2015-02-07 17:37:53 +00:00
(when (configuration-layer/layer-used-p 'syntax-checking)
(defun ocaml/post-init-flycheck ()
(spacemacs/enable-flycheck 'tuareg-mode))
(defun ocaml/init-flycheck-ocaml ()
(use-package flycheck-ocaml
:if (configuration-layer/package-used-p 'flycheck)
:defer t
:init
(progn
(with-eval-after-load 'merlin
(setq merlin-error-after-save nil)
(flycheck-ocaml-setup))))))
(defun ocaml/post-init-ggtags ()
(add-hook 'ocaml-mode-local-vars-hook #'spacemacs/ggtags-mode-enable))
(defun ocaml/post-init-counsel-gtags ()
(spacemacs/counsel-gtags-define-keys-for-mode 'ocaml-mode))
(defun ocaml/post-init-helm-gtags ()
(spacemacs/helm-gtags-define-keys-for-mode 'ocaml-mode))
(defun ocaml/init-merlin ()
(use-package merlin
:defer t
:init
(progn
(add-to-list 'spacemacs-jump-handlers-tuareg-mode
2016-08-13 13:43:37 +00:00
'spacemacs/merlin-locate)
(add-hook 'tuareg-mode-hook 'merlin-mode)
(spacemacs/set-leader-keys-for-major-mode 'tuareg-mode
"cp" 'merlin-project-check
"cv" 'merlin-goto-project-file
"Ec" 'merlin-error-check
"En" 'merlin-error-next
"EN" 'merlin-error-prev
"gb" 'merlin-pop-stack
2016-08-13 13:43:37 +00:00
"gG" 'spacemacs/merlin-locate-other-window
"gl" 'merlin-locate-ident
"gi" 'merlin-switch-to-ml
"gI" 'merlin-switch-to-mli
"go" 'merlin-occurrences
"hh" 'merlin-document
"ht" 'merlin-type-enclosing
"hT" 'merlin-type-expr
2016-05-16 09:33:14 +00:00
"rd" 'merlin-destruct)
(spacemacs/declare-prefix-for-mode 'tuareg-mode "mc" "compile/check")
(spacemacs/declare-prefix-for-mode 'tuareg-mode "mE" "errors")
2016-05-16 09:33:14 +00:00
(spacemacs/declare-prefix-for-mode 'tuareg-mode "mg" "goto")
(spacemacs/declare-prefix-for-mode 'tuareg-mode "mh" "help")
(spacemacs/declare-prefix-for-mode 'tuareg-mode "mr" "refactor"))))
2015-04-03 21:35:33 +00:00
(defun ocaml/init-ocp-indent ()
(use-package ocp-indent
:defer t
:init
(add-hook 'tuareg-mode-hook 'ocp-indent-caml-mode-setup)
(spacemacs/set-leader-keys-for-major-mode 'tuareg-mode
"=" 'ocp-indent-buffer)))
(defun ocaml/post-init-smartparens ()
(with-eval-after-load 'smartparens
;; don't auto-close apostrophes (type 'a = foo) and backticks (`Foo)
(sp-local-pair 'tuareg-mode "'" nil :actions nil)
(sp-local-pair 'tuareg-mode "`" nil :actions nil)))
(defun ocaml/init-tuareg ()
(use-package tuareg
:bind (:map tuareg-mode-map
;; Workaround to preserve vim backspace in normal mode
([backspace] . nil))
:mode (("\\.ml[ily]?$" . tuareg-mode)
("\\.topml$" . tuareg-mode))
:defer t
:init
(progn
(spacemacs//init-ocaml-opam)
(spacemacs/set-leader-keys-for-major-mode 'tuareg-mode
"ga" 'tuareg-find-alternate-file
"cc" 'compile)
;; Make OCaml-generated files invisible to filename completion
(dolist (ext '(".cmo" ".cmx" ".cma" ".cmxa" ".cmi" ".cmxs" ".cmt" ".cmti" ".annot"))
(add-to-list 'completion-ignored-extensions ext)))))
(defun ocaml/init-utop ()
(use-package utop
:defer t
:init
(progn
(add-hook 'tuareg-mode-hook 'utop-minor-mode)
(spacemacs/register-repl 'utop 'utop "ocaml"))
:config
(progn
(if (executable-find "opam")
(setq utop-command "opam config exec -- utop -emacs")
(spacemacs-buffer/warning "Cannot find \"opam\" executable."))
(defun spacemacs/utop-eval-phrase-and-go ()
"Send phrase to REPL and evaluate it and switch to the REPL in
`insert state'"
(interactive)
(utop-eval-phrase)
(utop)
Use evil in holy-mode Motivation While disabling Evil in holy-mode makes its implementation shorter and sounds elegant on the paper, in practice it puts a big burden on the configuration parts which need to know if Evil is enable or not. This is a bad separation of concerns and the bunch of fixes that we were forced to do in the past weeks shows this issue. Those fixes were about removing the knowledge of the activation of Evil by implementing new dispatching functions to be used by layers, this is cumbersome and makes Spacemacs layer configuration more subtle which is not good. There was additional bad consequences of the removal of Evil state like the impossibility to use Evil lisp state or iedit states, or we would have been forced to implement a temporary activation of Evil which is awkward. Instead I reintroduce Evil as the central piece of Spacemacs design thus Evil is now re-enabled in holy-mode. It provides the abstraction we need to isolate editing styles and be able to grow the Spacemacs configuration coverage sanely. Layers don't need to check whether the holy mode is active or not and they don't need to know if Evil is available (it is always available). We also don't need to write additional dispatching functions, this is the job of Evil, and I think it provides everything for this. Ideally configuration layer should be implemented with only Evil in mind and the holy-mode (and hybrid-mode) should magically make it work for Emacs style users, for instance we can freely use `evil-insert-state` anywhere in the code without any guard. Evil is now even more part of Spacemacs, we can really say that Spacemacs is Emacs+Evil which is now an indivisible pair. Spacemacs needed this stable API to continue on the right track. While these changes should be rather transparent to the user, I'm sorry for this experimental period, I failed to see all the implications of such a change, I was just excited about the possibility to make Evil optional. The reality is that Spacemacs has to embrace it and keep its strong position on being Emacs+Evil at the core. Implementation - insert, motion and normal states are forced to emacs state using an advice on `evil-insert-state`, `evil-motion-state` and `evil-normal-state` respectively. These functions can be used freely in the layer configuration. - A new general hook `spacemacs-editing-style-hook` allow to hook any code that need to be configured based on the editing style. Functions hooked to this hook takes the current style as parameter, this basically generalize the hook used to setup hjkl navigation bindings. - ESC has been removed from the emacs state map. - Revert unneeded changes - Revert "evil: enter insert-state only from normal-state" commit bdd702dfbe302206bbc989c7a0832daba087a781. - Revert "avoid being evil in deft with emacs editing style" commit f3a16f49ed27cc8cf05f23f93b006d6e04235381. Additional changes All editing style packages have been moved to a layer called `spacemacs-editing-styles` Notes I did not have time to attack hybrid mode, I should be able to do it later.
2016-03-13 23:41:18 +00:00
(evil-insert-state))
2015-02-07 17:37:53 +00:00
2015-05-12 05:35:23 +00:00
(defun spacemacs/utop-eval-buffer-and-go ()
"Send buffer to REPL and evaluate it and switch to the REPL in
`insert state'"
(interactive)
(utop-eval-buffer)
(utop)
Use evil in holy-mode Motivation While disabling Evil in holy-mode makes its implementation shorter and sounds elegant on the paper, in practice it puts a big burden on the configuration parts which need to know if Evil is enable or not. This is a bad separation of concerns and the bunch of fixes that we were forced to do in the past weeks shows this issue. Those fixes were about removing the knowledge of the activation of Evil by implementing new dispatching functions to be used by layers, this is cumbersome and makes Spacemacs layer configuration more subtle which is not good. There was additional bad consequences of the removal of Evil state like the impossibility to use Evil lisp state or iedit states, or we would have been forced to implement a temporary activation of Evil which is awkward. Instead I reintroduce Evil as the central piece of Spacemacs design thus Evil is now re-enabled in holy-mode. It provides the abstraction we need to isolate editing styles and be able to grow the Spacemacs configuration coverage sanely. Layers don't need to check whether the holy mode is active or not and they don't need to know if Evil is available (it is always available). We also don't need to write additional dispatching functions, this is the job of Evil, and I think it provides everything for this. Ideally configuration layer should be implemented with only Evil in mind and the holy-mode (and hybrid-mode) should magically make it work for Emacs style users, for instance we can freely use `evil-insert-state` anywhere in the code without any guard. Evil is now even more part of Spacemacs, we can really say that Spacemacs is Emacs+Evil which is now an indivisible pair. Spacemacs needed this stable API to continue on the right track. While these changes should be rather transparent to the user, I'm sorry for this experimental period, I failed to see all the implications of such a change, I was just excited about the possibility to make Evil optional. The reality is that Spacemacs has to embrace it and keep its strong position on being Emacs+Evil at the core. Implementation - insert, motion and normal states are forced to emacs state using an advice on `evil-insert-state`, `evil-motion-state` and `evil-normal-state` respectively. These functions can be used freely in the layer configuration. - A new general hook `spacemacs-editing-style-hook` allow to hook any code that need to be configured based on the editing style. Functions hooked to this hook takes the current style as parameter, this basically generalize the hook used to setup hjkl navigation bindings. - ESC has been removed from the emacs state map. - Revert unneeded changes - Revert "evil: enter insert-state only from normal-state" commit bdd702dfbe302206bbc989c7a0832daba087a781. - Revert "avoid being evil in deft with emacs editing style" commit f3a16f49ed27cc8cf05f23f93b006d6e04235381. Additional changes All editing style packages have been moved to a layer called `spacemacs-editing-styles` Notes I did not have time to attack hybrid mode, I should be able to do it later.
2016-03-13 23:41:18 +00:00
(evil-insert-state))
(defun spacemacs/utop-eval-region-and-go (start end)
"Send region to REPL and evaluate it and switch to the REPL in
`insert state'"
(interactive "r")
(utop-eval-region start end)
(utop)
Use evil in holy-mode Motivation While disabling Evil in holy-mode makes its implementation shorter and sounds elegant on the paper, in practice it puts a big burden on the configuration parts which need to know if Evil is enable or not. This is a bad separation of concerns and the bunch of fixes that we were forced to do in the past weeks shows this issue. Those fixes were about removing the knowledge of the activation of Evil by implementing new dispatching functions to be used by layers, this is cumbersome and makes Spacemacs layer configuration more subtle which is not good. There was additional bad consequences of the removal of Evil state like the impossibility to use Evil lisp state or iedit states, or we would have been forced to implement a temporary activation of Evil which is awkward. Instead I reintroduce Evil as the central piece of Spacemacs design thus Evil is now re-enabled in holy-mode. It provides the abstraction we need to isolate editing styles and be able to grow the Spacemacs configuration coverage sanely. Layers don't need to check whether the holy mode is active or not and they don't need to know if Evil is available (it is always available). We also don't need to write additional dispatching functions, this is the job of Evil, and I think it provides everything for this. Ideally configuration layer should be implemented with only Evil in mind and the holy-mode (and hybrid-mode) should magically make it work for Emacs style users, for instance we can freely use `evil-insert-state` anywhere in the code without any guard. Evil is now even more part of Spacemacs, we can really say that Spacemacs is Emacs+Evil which is now an indivisible pair. Spacemacs needed this stable API to continue on the right track. While these changes should be rather transparent to the user, I'm sorry for this experimental period, I failed to see all the implications of such a change, I was just excited about the possibility to make Evil optional. The reality is that Spacemacs has to embrace it and keep its strong position on being Emacs+Evil at the core. Implementation - insert, motion and normal states are forced to emacs state using an advice on `evil-insert-state`, `evil-motion-state` and `evil-normal-state` respectively. These functions can be used freely in the layer configuration. - A new general hook `spacemacs-editing-style-hook` allow to hook any code that need to be configured based on the editing style. Functions hooked to this hook takes the current style as parameter, this basically generalize the hook used to setup hjkl navigation bindings. - ESC has been removed from the emacs state map. - Revert unneeded changes - Revert "evil: enter insert-state only from normal-state" commit bdd702dfbe302206bbc989c7a0832daba087a781. - Revert "avoid being evil in deft with emacs editing style" commit f3a16f49ed27cc8cf05f23f93b006d6e04235381. Additional changes All editing style packages have been moved to a layer called `spacemacs-editing-styles` Notes I did not have time to attack hybrid mode, I should be able to do it later.
2016-03-13 23:41:18 +00:00
(evil-insert-state))
(spacemacs/set-leader-keys-for-major-mode 'tuareg-mode
"'" 'utop
"sb" 'utop-eval-buffer
"sB" 'spacemacs/utop-eval-buffer-and-go
"si" 'utop
"sp" 'utop-eval-phrase
"sP" 'spacemacs/utop-eval-phrase-and-go
"sr" 'utop-eval-region
2016-05-16 09:33:14 +00:00
"sR" 'spacemacs/utop-eval-region-and-go)
(spacemacs/declare-prefix-for-mode 'tuareg-mode "ms" "send"))
(define-key utop-mode-map (kbd "C-j") 'utop-history-goto-next)
(define-key utop-mode-map (kbd "C-k") 'utop-history-goto-prev)))