ensime-vars.el

;;; ensime-var.el --- Customizaton variables

(eval-when-compile
  (require 'cl)
  (require 'ensime-macros))

(require 's)

(defgroup ensime nil
  "Interaction with the ENhanced Scala Environment."
  :group 'tools)

(defgroup ensime-ui nil
  "Interaction with the ENhanced Scala Environment UI."
  :group 'ensime)

(defcustom ensime-default-buffer-prefix "inferior-ensime-server-"
  "The prefix of the buffer that the ENSIME server process runs in."
  :type 'string
  :group 'ensime-ui)

(defcustom ensime-truncate-lines t
  "Set `truncate-lines' in popup buffers.
  This applies to buffers that present lines as rows of data, such as
  debugger backtraces and apropos listings."
  :type 'boolean
  :group 'ensime-ui)

(defcustom ensime-kill-without-query-p t
  "If non-nil, kill ENSIME processes without query when quitting Emacs."
  :type 'boolean
  :group 'ensime-ui)

(defcustom ensime-save-before-compile t
  "If non-nil, save all buffers before compiling."
  :type 'boolean
  :group 'ensime-ui)

(defcustom ensime-tooltip-hints t
  "If non-nil, mouse tooltips are activated."
  :type 'boolean
  :group 'ensime-ui)

(defcustom ensime-tooltip-type-hints t
  "If non-nil, type-inspecting tooltips are activated."
  :type 'boolean
  :group 'ensime-ui)

(defcustom ensime-graphical-tooltips nil
  "If non-nil, show graphical bubbles for tooltips."
  :type 'boolean
  :group 'ensime-ui)

(defgroup ensime-server nil
  "Server configuration."
  :prefix "ensime-"
  :group 'ensime)

(defcustom ensime-connected-hook nil
  "List of functions to call when ENSIME connects to Lisp."
  :type 'hook
  :group 'ensime-server)

(defcustom ensime-sbt-command
  (executable-find "sbt")
  "Location of the sbt executable for starting the server."
  :type 'string
  :group 'ensime-server)

(defcustom ensime-auto-generate-config nil
  "If true, ENSIME will try to create a config file automatically, and
update it when the project definition changes. At the moment, this only
works for sbt projects."
  :type 'boolean
  :group 'ensime-ui)

(defcustom ensime-server-version "0.9.10-SNAPSHOT"
  "Distributed version of the server to upgrade and start.
This is primarily useful for ENSIME developers (or bug reporters)
to test against. The client is designed to work with the default
version."
  :type 'string
  :group 'ensime-server)

(defcustom ensime-default-server-env ()
  "A `process-environment' compatible list of environment variables"
  :type '(repeat string)
  :group 'ensime-server)

(defcustom ensime-server-logback nil
  "The logback file to use when starting the server."
  :type 'string
  :group 'ensime-server)

(defun ensime--parent-dir (dir)
  (unless (equal "/" dir)
    (file-name-directory (directory-file-name dir))))

(defcustom ensime-default-java-flags ()
  "Flags sent to the java instance when the server is started"
  :type '(repeat string)
  :group 'ensime-server)

(defgroup ensime-mode nil
  "Settings for ensime-mode scala source buffers."
  :prefix "ensime-"
  :group 'ensime)

(defcustom ensime-mode-key-prefix [?\C-c]
  "The prefix key for ensime-mode commands."
  :group 'ensime-mode
  :type 'sexp)

(defcustom ensime-typecheck-when-idle t
  "Controls whether a modified buffer should be typechecked automatically.
A typecheck is started when emacs is idle, if the buffer was modified
since the last typecheck."
  :type 'boolean
  :group 'ensime-ui)

(defcustom ensime-typecheck-interval 2
  "Minimum time to wait between two automatic typechecks."
  :type 'number
  :group 'ensime-ui)

(defcustom ensime-typecheck-idle-interval 0.5
  "Idle time to wait before starting an automatic typecheck."
  :type 'number
  :group 'ensime-ui)

(defcustom ensime-sem-high-enabled-p t
  "If true, ensime semantic highlighting is applied whenever the buffer
is saved."
  :type 'boolean
  :group 'ensime-ui)

(defcustom ensime-sem-high-faces
  '((var . scala-font-lock:var-face)
    (val . (:inherit font-lock-constant-face :slant italic))
    (varField . scala-font-lock:var-face)
    (valField . (:inherit font-lock-constant-face :slant italic))
    (functionCall . font-lock-function-name-face)
    (operator . font-lock-keyword-face)
    (param . (:slant italic))
    (class . font-lock-type-face)
    (trait .  (:inherit font-lock-type-face :slant italic))
    (object . font-lock-constant-face)
    (package . font-lock-preprocessor-face)
    (implicitConversion . ensime-implicit-highlight)
    (implicitParams . ensime-implicit-highlight)
    (deprecated . (:strike-through "dark gray")))
  
  "Faces for semantic highlighting. Symbol types not mentioned here
will not be requested from server.  The format is an alist of the form
  ( SYMBOL-TYPE . FACE-SPEC )
where SYMBOL-TYPE is one of:
  var val varField valField functionCall operator params class trait
  object package implicitConversion implicitParams deprecated"
  :type 'alist
  :group 'ensime-ui)

(defcustom ensime-completion-style 'company
  "Should be one of 'company, 'auto-complete or nil."
  :type 'symbol
  :group 'ensime-ui)

(defcustom ensime-goto-test-config-defaults
  '(:test-class-names-fn ensime-goto-test--test-class-names
    :test-class-suffixes ("Test" "Spec" "Specification" "Check")
    :impl-class-name-fn  ensime-goto-test--impl-class-name
    :impl-to-test-dir-fn ensime-goto-test--impl-to-test-dir
    :is-test-dir-fn      ensime-goto-test--is-test-dir
    :test-template-fn    ensime-goto-test--test-template-default)

  "Configures the default behavior of the \"go to test/implementation\"
feature. Behavior can also be defined on a per-project basis. See
`ensime-goto-test-config'.

The value must be a plist with the following keys/values

:test-class-names-fn : a function of one argument, which should
take the fully-qualified name of an implementation class, and
return a list of fully-qualified names of potential test
classes. The first element of the list is used to create a new
test class, if none of the list elements matches an existing
class.

:test-class-suffixes : a list of strings. This is used by
`ensime-goto-test--test-class-names' to generate possible
test class names. The first element in the list is the suffix
used to create a new test class if no existing test is found.

:impl-class-name-fn : a function of one argument, which should
take the fully-qualified name of a test class, and return the
fully-qualified name of the corresponding implementation class.

:impl-to-test-dir-fn : a function of one argument, which should
take an implementation source directory and return the
corresponding test source directory.

:is-test-dir-fn : a function of one argument, which should return
true if the directory being passed is a test directory

:test-template-fn : a function of zero argument that returns a
string used to create new test classes. The string can contain
the following substitution templates:
  %TESTPACKAGE% : the fully-qualified package of the test class
  %TESTCLASS% : the name of the test class (without package)
  %IMPLPACKAGE% : the fully-qualified package of the implementation class
  %IMPLCLASS% : the name of the implementation class (without package)
Several sample templates are provided: see
`ensime-goto-test--test-template-scalatest-2',
`ensime-goto-test--test-template-scalatest-1',
`ensime-goto-test--test-template-scalacheck',
`ensime-goto-test--test-template-specs2'.

"
  :type 'plist
  :group 'ensime-ui)

(defcustom ensime-goto-test-configs
  ()
"Configures the behavior of the \"go to test/implementation\" feature
for specific projects. This overrides the settings of
`ensime-goto-test-config-defaults'.

The value is an alist of the form:
  ((\"PROJECT-NAME-RE\" . CONFIG-PLIST) ...)

where PROJECT-NAME is a regexp matched against the current project's
name (case sensitive), and CONFIG-PLIST has the same format as
`ensime-goto-test-config-defaults'.
"
  :type 'alist
  :group 'ensime-ui)

(provide 'ensime-vars)

;; Local Variables:
;; End: