From 6e7314861e635f6f1c885c3afd4d175276c9a563 Mon Sep 17 00:00:00 2001
From: Mads Hartmann Jensen <mads379@gmail.com>
Date: Sun, 11 Jan 2015 13:20:03 +0100
Subject: [PATCH] Code review by @diml

- Changed default key-binding for utop to C-c C-s to match tuareg
  default
- Add some compatibility functions to make the transition easier for
  existing users
---
 README.md       |  5 +----
 src/top/utop.el | 44 +++++++++++++++++++++++++++++++++++++++-----
 2 files changed, 40 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 61b15eb..c14c814 100644
--- a/README.md
+++ b/README.md
@@ -139,7 +139,7 @@ utop also ships with a minor mode that has the following key-bindings
 
 | key-binding | function          | Description                  |
 |-------------|-------------------|------------------------------|
-| C-c C-z     | utop              | Start a utop buffer          |
+| C-c C-s     | utop              | Start a utop buffer          |
 | C-x C-e     | utop-eval-phrase  | Evaluate the current phrase  |
 | C-x C-r     | utop-eval-region  | Evaluate the selected region |
 | C-c C-b     | utop-eval-buffer  | Evaluate the current buffer  |
@@ -158,9 +158,6 @@ e.g. typerex, then you will need the following configuration instead
 
 ```scheme
 (autoload 'utop-minor-mode "utop" "Minor mode for utop" t)
-(setq utop-skip-blank-and-comments 'typerex-skip-blank-and-comments)
-(setq utop-skip-to-end-of-phrase 'typerex-skip-to-end-of-phrase)
-(setq utop-discover-phrase 'typerex-discover-phrase)
 (add-hook 'typerex-mode-hook 'utop-minor-mode)
 ```
 
diff --git a/src/top/utop.el b/src/top/utop.el
index e99e89f..84c9d7b 100644
--- a/src/top/utop.el
+++ b/src/top/utop.el
@@ -217,13 +217,13 @@ Useful as file variable."))
    "Name of preprocesor. Currently supported camlp4o, camlp4r.
 Useful as file variable."))
 
-(defvar utop-skip-blank-and-comments 'tuareg-skip-blank-and-comments
+(defvar utop-skip-blank-and-comments 'compat-skip-blank-and-comments
   "The function used to skip blanks and comments.")
 
-(defvar utop-skip-to-end-of-phrase 'tuareg-skip-to-end-of-phrase
+(defvar utop-skip-to-end-of-phrase 'compat-skip-to-end-of-phrase
   "The function used to find the end of a phrase")
 
-(defvar utop-discover-phrase 'tuareg-discover-phrase
+(defvar utop-discover-phrase 'compat-discover-phrase
   "The function used to discover a phrase")
 
 (defvar utop-skip-after-eval-phrase t
@@ -233,7 +233,37 @@ Non-nil means skip to the end of the phrase after evaluation in the
 Caml toplevel")
 
 ;; +-----------------------------------------------------------------+
-;; | Compability                                                     |
+;; | Compability with different ocaml major modes                    |
+;; +-----------------------------------------------------------------+
+
+(defun utop-compat-resolve (symbol)
+  "Resolve a symbol based on the current major mode."
+  (cond
+   ((eq major-mode 'tuareg-mode)
+    (intern (concat "tuareg-" symbol)))
+   ((eq major-mode 'typerex-mode)
+    (intern (concat "typerex-" symbol)))
+   ((eq major-mode 'caml-mode)
+    (intern (concat "caml-" symbol)))
+   ((require 'tuareg nil t)
+    (intern (concat "tuareg-" symbol)))
+   ((require 'typerex nil t)
+    (intern (concat "typerex-" symbol)))
+   ((require 'caml nil t)
+    (intern (concat "caml-" symbol)))
+   (error (concat "unsupported mode: " (symbol-name major-mode) ", utop support only caml, tuareg and typerex modes"))))
+
+(defun compat-skip-blank-and-comments ()
+  (funcall (utop-compat-resolve "skip-blank-and-comments")))
+
+(defun compat-skip-to-end-of-phrase ()
+  (funcall (utop-compat-resolve "skip-to-end-of-phrase")))
+
+(defun compat-discover-phrase ()
+  (funcall (utop-compat-resolve "discover-phrase")))
+
+;; +-----------------------------------------------------------------+
+;; | Compability with previous emacs version                         |
 ;; +-----------------------------------------------------------------+
 
 (unless (featurep 'tabulated-list)
@@ -1115,12 +1145,16 @@ defaults to 0."
     (utop-insert "\nRestarting...\n\n")
     (utop-start arguments)))
 
+(defun utop-setup-ocaml-buffer ()
+  "Deprecated"
+  (error "This function is deprecated. See https://github.com/diml/utop for configuration information."))
+
 ;;;###autoload
 (define-minor-mode utop-minor-mode
   "Minor mode for utop."
   :lighter " utop"
   :keymap (let ((map (make-sparse-keymap)))
-            (define-key map (kbd "C-c C-z") 'utop)
+            (define-key map (kbd "C-c C-s") 'utop)
             (define-key map (kbd "C-x C-e") 'utop-eval-phrase)
             (define-key map (kbd "C-x C-r") 'utop-eval-region)
             (define-key map (kbd "C-c C-b") 'utop-eval-buffer)