Im new to tuareg and Ocaml, and I found in file "tuareg.em", the comments said

;; Installation:
;; If you have permissions to the local site-lisp' directory, you ;; only have to copytuareg.el', tuareg_indent.el',ocamldebug.el'
;; and tuareg-site-file.el'. Otherwise, copy the previous files ;; to a local directory and add the following line to your.emacs':
;;
;; (add-to-list 'load-path "DIR")

My qstn is to install tuareg, don't we need to run "Makefile"? What does it mean by "copy the previous files to a local directory"? WHat's the name of local directory?

Would like to see the the real command name displayed too in menu. Also have same docu. WDYT?

Version 2.08 indents begin .. end statements as follows:

match foo with
| bar -> begin
         print_endline "new indentation"
       end
| baz -> ...

if test then begin
            print_endline "new indentation"
          end
else ...

whereas older versions would indent the above expressions as

match foo with
| bar -> begin
  print_endline "old indentation"
end
| baz -> ...

if test then begin
  print_endline "old indentation"
end
else ...

Is there a nice way to revert back to the old indentation style?

Add .eliom and .eliomi as file extensions that trigger tuareg-mode.

.eliom and .eliomi are source files with ocaml code that use Eliom's syntax extension for ocsigen.

Suggest to introduce:

• tuareg-forward-top-level
• tuareg-backward-top-level
• tuareg-forward-block
• tuareg-backward-block
• tuareg-forward-linewise
• tuareg-backward-linewise

where cursor travels indents, resp. end of line

Tuareg loops on re-flowing (M-q) unclosed comments, bringing the whole emacs down. The only thing that saves it afterwards is xkill. For now I've been getting this with version 20141026.743, but I'll try to update to the most recent version to see if it still happens. Screenshot attached.

now tuareg-indent is

begin match a with
| A(a) -> a
| B(a) -> a
end

but, I hope

begin match a with
| A(a) -> a
| B(a) -> a
end

or

begin match a with
| A(a) -> a
| B(a) -> a
end

If you please change begin match indent.
I am sorry my english is poor.
Thanks.

Is ocamldebug able to take arguments to the program it's stepping through when run from Emacs?

I modified it slightly to do so (using read-from-minibuffer) but am not sure if there's an existing/better way. If there isn't, I would also be happy to open a PR.

With emacs 24.3, I get Invalid function: tuareg-with-internal-syntax in the minibuffer when indenting on both master and 2.0.8. No functionality seems to be lost (but I haven't searched for brokenness very far).

Key bindings prefixed with "C-c" are reserved for user definitions.

The bindings currently on "C-c" in Tuareg mode should be bound to a new keymap. Users can then easily bind this new map to "C-c" (or anything else) using define-prefix-command.

Currently having no ~/.opam directory throws at directory-files call here

In OCaml 4.02, match expressions have been extended to allow exception branches. This isn't recognized yet, and using the syntax throws off font-lock and indentation.

let n = match List.find ((=) 3) [1;2] with
  | x -> x
  | exception Not_found -> 0
              in n               (* Should be at leftmost indentation *)

It makes no sense introducing a boolean

tuareg-use-syntax-ppss

if alternatively an error is sent:

(defalias 'tuareg-in-literal-or-comment
[ ... ](eval-and-compile %28if tuareg-use-syntax-ppss
'tuareg-ppss-in-literal-or-comment
'tuareg-!ppss-in-literal-or-comment)))
and than:

(defun tuareg-ppss-in-literal-or-comment () (error "tuareg uses PPSS"))

In the source file [1]: hen I go to line 44 and insert the following code (just typing it), emacs hangs, just after typing '>':

let write_label o = function
    Path name ->

A trace is also attached ([2])

[1] https://raw.githubusercontent.com/choeger/modelica.ml/5d13b58f79a998f30a3186de30703f3a1a1fa21b/test/parse_package.ml
[2] http://pastebin.com/Dv8kbqBK

The module type and begin constructs seem to be left out of the set of things that can be written in a "hanging" style. This is what I'm getting:

module M = struct (* OK *)
  thing
end

module type M = sig (* Compare with the above *)
    thing
  end

if test then begin
            thing
          end

This is what I'd like to get:

module M = struct
  thing
end

module type M = sig
  thing
end

if test then begin
  thing
end

As far as I can tell this is simply due to sig and begin missing from the list of hanging keywords in tuareg-smie-rules. Please see #12.

With emacs 24.4 and tuareg 2.0.8, enabling show-paren-mode results in somewhat strange highlighting. For a buffer containing only the code:

let f () =
  let x = 0 in
  ()

putting the point at in correctly highlights the matching let, but putting the point at that let highlights it as unmatched. For reference, the behavior of forward-sexp and backward-sexp is consistent, moving from in to let, but not back. The highlighting of parens, brackets, etc. as well as begin and end seems to work as expected.

I open a new empty file, type the following code, and then emacs freezes just after typing | key.

let f = function
A -> true
|

I don't know whether this really comes from tuareg 2.0.8 or not, but 2.0.6 seems to be fine (not freezes). I try emacs 23.4.1 and 24.4.1. Will you have any idea?

The build fails if Emacs is not installed:

# make[1]: Entering directory `/home/opam/.opam/system/build/caml-mode.4.02'
# Installing in /home/opam/.opam/system/share/emacs/site-lisp...
# if test -d /home/opam/.opam/system/share/emacs/site-lisp; then : ; else mkdir -p /home/opam/.opam/system/share/emacs/site-lisp; fi
# cp caml-font.el caml-hilit.el caml.el camldebug.el inf-caml.el caml-compat.el caml-help.el caml-types.el caml-xemacs.el caml-emacs.el /home/opam/.opam/system/share/emacs/site-lisp
# if [ -z "" ]; then \
#     cd /home/opam/.opam/system/share/emacs/site-lisp; emacs --batch --eval '(progn (setq load-path (cons "." load-path)) (byte-compile-file "caml-xemacs.el") (byte-compile-file "caml-emacs.el") (byte-compile-file "caml.el") (byte-compile-file "inf-caml.el") (byte-compile-file "caml-help.el") (byte-compile-file "caml-types.el") (byte-compile-file "caml-font.el") (byte-compile-file "camldebug.el"))'; \
#   fi
# make[1]: Leaving directory `/home/opam/.opam/system/build/caml-mode.4.02'
### stderr ###
# [...]
# grep: opam/opam: No such file or directory
# grep: opam/opam: No such file or directory
# grep: opam/opam: No such file or directory
# grep: opam/opam: No such file or directory
# grep: opam/opam: No such file or directory
# grep: opam/opam: No such file or directory
# grep: opam/opam: No such file or directory
# /bin/sh: 2: emacs: not found
# make[1]: *** [simple-install] Error 127
# make: *** [install] Error 2

http://www.recoil.org/~avsm/opam-bulk/logs/local-ubuntu-14.04-ocaml-4.02.1/raw/caml-mode.html#bottom

The following .ml file:

(* this is an unclosed comment

Using tuareg, if you position the cursor inside the comment, and call ESC-q (tuareg-indent-phrase), the emacs process uses 100% CPU and becomes unresponsive, and then has to be killed and restarted.

This is clearly a bug. Can someone confirm this behaviour?

(defvar tuareg-cache-stop (point-min))

can't be right, as the result of (point-min) is not predictable - due to buffer-narrowing.
This this value gets initialized at hazard.

Can we atleast switch off indentation on these files (preserving the syntax highlighting), so that the user doesn't get confused?

Well, one error, anyway. When installing tuareg from MELPA, I get the following message:

Compiling file /home/fs/.emacs.d/elpa/tuareg-20150316.1247/ocamldebug.el at Mon May  4 14:50:40 2015
Entering directory `/home/fs/.emacs.d/elpa/tuareg-20150316.1247/'
ocamldebug.el:42:1:Error: Cannot open load file: no such file or directory, /home/fs/.emacs.d/tuareg

This is on Emacs 24.4, with the spacemacs configuration setup.

Hi! I found a bug when smie is off on the current github version of tuareg. Here is a patch to solve it:

--- a/tuareg.el
+++ b/tuareg.el
@@ -333,7 +333,7 @@ Valid names are browse-url',browse-url-firefox', etc."
`(("Automatic indentation of leading keywords" . 'tuareg-use-abbrev-mode)
("Automatic indentation of ), ] and }" . 'tuareg-electric-indent)
,@(unless tuareg-use-smie

•    '("Automatic matching of [| and {<" . 'tuareg-electric-close-vector))
  

•    '(("Automatic matching of [| and {<" . 'tuareg-electric-close-vector)))
  

  "---"
  ,@(unless tuareg-use-smie
  '(("Indent body of comments" . 'tuareg-indent-comments)

On line 518, kwop-regexp is set to nil, because kr is nil. Then re-search-backward throws an error because its first parameter is nil.

OCaml 4.02 supports a new syntax for string literals like this {eof|this is a string|eof} which are great for multi line strings, etc. As far as I've seen they are not getting highlighted by Tuareg, yet (checked behavior of release 2.0.8 and quickly skimmed the git repo).

See list of 4.02 changes, documentation

I'm wondering when is the next release panned ?
I'm using the dev version for quite some time now because it includes a fix for an infinite loop I had quite a few times so it would be great to have a release I think.

Cheers,

(I am "porting" this from the OCaml Forge bug, since I am still seeing this behavior in tuareg-mode from MELPA, and I am not sure if OCaml Forge bugs are being monitored; the kludge I describe in my comment still "fixes" the behavior for me, but it's pretty ugly)

Date: 2011-04-24 06:17
Priority:3
State:Open
Submitted by:Gabriel Scherer (bluestorm)
Assigned to:Nobody (None)
Hardware:None
Resolution: None
Severity: None
Version: None
Component: None
Operating System: None
Product: None
URL:

Summary:

interactive mode: eval-phrase determines wrong region for modules with both structure and signature

Detailed description

Both the following code snippets fail when I try to send them to the toplevel using tuareg-eval-phrase :

module A : sig
val x : int
end = struct
let x = 0
end

module A = (
struct
let x = 0
end
:
sig
val x : int
end)

In both cases, Tuareg only send the phrase upto the first end, which results in syntax errors.

Followups

Message

Date: 2013-11-27 22:09
Sender: Evgeny Roubinchtein

I hit this also. As a stop-gap measure, I replaced the uses of tuareg-discover-phrase with caml-find-phrase: so far, my experience seems to be an overall improvement ( tuareg-eval-phrase uses tuareg-discover-pharse to find the portion of the buffer it needs to send to OCaml toplevel). The specific Elisp code I used appears below:

(defadvice tuareg-discover-phrase (around use-caml-find-phrase)
"Replace uses of `tuareg-discover-phrase' with `caml-find-phrase'"
(save-excursion
   (let ((begin (caml-find-phrase)))
      (setq ad-return-value (list begin (point) (point))))))
(ad-activate 'tuareg-discover-phrase t)

The above does assume that caml.el is avaliable: I used Emacs package.el to install tuareg, and tuareg package depends on the caml package, so, things "work for me."

The instructions in tuareg.el currently say you need only tuareg.el and ocamldebug.el, but loading tuareg.el fails without tuareg-indent.el.

See discussion at: http://lists.ocaml.org/pipermail/teaching/2015-January/000062.html

The issue is that OSX comes with an older, console version of Emacs, which will be used for the compilation at tuareg installation time; whilst most users will then be using a newer, graphic version, bundled as an app. The .elc that are generated with the older version generate strange problems (uncolored buffer, that can be colored by font-lock-fontify-buffer but then prints an error at every insert).

The easiest would be to not run the compilation by default in the OPAM package.

Providing a workaround for the absence of syntax-ppss (supported since the 15 years old Emacs 21 with the syntax.el add on) leads to code duplication for no good reason nowadays. Syntax-ppss is currently not supported on the 6½ years old XEmacs 21.4.22 but the beta XEmacs 21.5.32, released in 2012, has syntax-ppss.el. I think it should be removed.

If I try to evaluate

let y = [| 1; 2 |] ;;

I get this

# let y = [| 1; 2 |;;
Characters 16-17:
  let y = [| 1; 2 |;;
                  ^
Error: Syntax error

For some reason the last ] is not passed to the ocaml process, resulting in a syntax error.

From line 504 on a bunch of top-level definitions --defvar and defun-- are missing a newline between.
This makes the source difficult to read.

Version 2.0.8 indents function bodys the following way

let g x = h x ~f:(fun y ->
                  y + 1
                 )

while olders versions used to indent it this way:

let g x = h x ~f:(fun y ->
  y + 1
)

Is there a simple way to revert to the old behavior? Thanks!

Tuareg indents functor declarations like this:

module Set =
  functor (Elt: ORDERED_TYPE) ->
          struct
          end

Shouldn't it be more like this:

module Set =
  functor (Elt: ORDERED_TYPE) ->
    struct
    end

At least, that's the style used in the manual

Emacs get stuck when opening .mly file like:

%{
%}

%%
f:
  | g                                        { }

The whitespace between g and {} is important. Maybe some regexps are too expensive.

Tuareg mode completely changed its auto indentation functions, resulting in a quite different user experience. Taste matters left aside, I do not feel that these “new” indentation functions are ready.

There is two serious problems with these new indentation functions:

• They seem to ignore the tuareg-*-indent variables.
• They are stubbornly automatic.

About tuareg-*-indent variables. If the variables are not used anymore, they should be removed, their mere existence induces the user in error. If these variables are currently not used anymore but should soon be used again, it is an objective sign that the feature is not terminated and should live in a development branch.

About stubbornness. It seems that the RETURN key calls the automatic indentation functions on the current line. In the cases where these functions are wrong, this is very annoying, as the user must quote most of its input. There is an important case where these functions are almost always wrong: when editing a codebase prepared with other indentation settings. In this case, it is important to preserve the structure to avoid introducing artificial code changes in the repository.

Suggested resolution

• Revert the change bringing new indentation functions in in the main branch.
• Start a development branch using the new indentation functions.
• Prepare an automatic test suite to help debugging indentation functions.
• Arrange so that a user can choose between the two indentation function sets.

I know very little elisp, but I think I can help for the three first points above.

Hello, it seems that tuareg causes my emacs to fall into infinite loop when I try to press tab in a .mll file, more precisely when I try to indent the parsing rules.

I hope this is a real bug and not just my computer being weird, and that I won't loose your time.

Thx a lot.

Hello! I am new to OCaml, but have been using Emacs for a few years now.

When I try to indent the following code in an otherwise empty source file in tuareg-mode:

let print_world () = print_endline "hello world" ;;
print_world () ;;

I get:

let print_world () = print_endline "hello world" ;;
  print_world () ;;

That seems strange to me. What is the logic behind indenting the second line. Shouldn't it be the same as the first?

At the end of tuareg.el:

;; Pre-SMIE indentation functions.
;; Load it after providing `tuareg' to avoid circular dependencies.
(require 'tuareg_indent)

However in tuareg_indent.el resides:

(require 'tuareg)

So the circular is already there.

Will fix this alongside with in-string/comment re-write

Font-lock rules seems to be failing to apply to type expressions in many cases.

These cases fail for me:

(* type signatures never work *)
val x : int
val f : int -> int
(* inline function type signatures - parameters seem to break it *)
let f x : int = x + 1

Only non-function values declared with let and type definitions work.

If your PATH contains spaces, e.g. "/my directory/bin:/usr/bin:/bin", it gets corrupted when compiling with tuareg. It is trunkated at the first space.

The culprit is 'split-string' in (defadvice compile...

(A pull request is coming to fix this).

I met an issue yesterday. When I upgrade from tuareg 2.0.6 to 2.0.7 my keywords change colors from orange to some strange color.. I have tried to study HISTORY file but it seems that changes for 2.0.5 are last in it. Can you upgrade it, please?

Activating trace messages this:

Debugger entered--Lisp error: (cyclic-function-indirection tuareg-fontify)
indirect-function(tuareg-fontify)
ad-real-orig-definition(tuareg-fontify)
ad-make-advised-definition(tuareg-fontify)
ad-activate-advised-definition(tuareg-fontify nil)
ad-activate(tuareg-fontify nil)
trace-function-internal(tuareg-fontify nil nil)
trace-function(tuareg-fontify)
[ ... ]

Not all OCaml code is compiled with ocamlbuild.

For example, obuild (https://github.com/ocaml-obuild/obuild)
put build results inside of dist/ .

Apparently there is a fix proposed for some .el files here:
http://stackoverflow.com/questions/5004293/how-can-i-specify-a-custom-path-to-the-annotation-files-in-tuareg-mode-emacs

Tuareg indents module definitions as follows currently:

module Foo =
  struct
  end

Notice that the struct is indented relative to module.

How can I get Tuareg to not indent struct relative to module, i.e.

module Foo =
struct
end

I've been having a few cases where tuareg freezes for a long time since I upgraded to emacs 24.3.1 and a recent tuareg mode (currently 20141026.743 from one of the ELPAs).

A simple reproduction case (tested with emacs -Q) is:

class bar = (foo object method private foo : int end

If I place the cursor on the o in object and type : it takes about 30 seconds to respond. If I then press space it freezes entirely (possibly an infinite loop but probably just such a long time that I give up and kill emacs).

If I run the profiler on the 30 second example, it says that 90+% of the time was in some jit-lock functions, so I assume that's where the problem is.

Consider the following:

module Make_comp(C : Comparitor) : Comparitor_intf with type t := C.t =
                                                                    struct
                                                                      type t = C.t
                                                                      let ret = C.comp
                                                                    end

The struct portion should not be indented all the way over there :)

If I have the following buffer, with the point after the last ;;

let x = 12;;

print_endline "hello word!";;

when I type C-x C-e I get this as output:

# let x = 12;;
val x : int = 12

To actually evaluate the last phrase, I need to prefix it with let _.

Is this a misconfiguration on my side?

I'm slightly confused at the state of Tuareg Mode.

Is this project now the “official home” of Tuareg Mode? Where should I report issues now, and from where should I install Tuareg Mode?

There's also a project on OCaml Forge, but it's repository is some commits behind this one. However, issues seem to be handled, that is, there some recent issues and people comment on them. On the other hand, this repo has just one issue (which a collaborator commented on, though).

The problem could be reproduced by:

1. Open a new file in Tuareg mode.
2. Input for i = at the start of the file.
3. Input a space after for i = by pressing the space key.

Then emacs hangs.

The emacs version is 24.4.1; caml package version is 3.12.0.1; tuareg version is 2.0.8.