| blob | 08c9fd0db8eb0c2c4f3e71e95fc4a5d8f053743a |
1 ;(***********************************************************************)
2 ;(* *)
3 ;(* Objective Caml *)
4 ;(* *)
5 ;(* Damien Doligez, projet Moscova, INRIA Rocquencourt *)
6 ;(* *)
7 ;(* Copyright 2003 Institut National de Recherche en Informatique et *)
8 ;(* en Automatique. All rights reserved. This file is distributed *)
9 ;(* under the terms of the GNU General Public License. *)
10 ;(* *)
11 ;(***********************************************************************)
13 ;(* $Id: caml-types.el,v 1.29.6.2 2004/11/15 12:50:54 doligez Exp $ *)
15 ; An emacs-lisp complement to the "-dtypes" option of ocamlc and ocamlopt.
17 ;; XEmacs compatibility
29 of ocamlc and ocamlopt.
31 Their format is:
33 file ::= block *
34 block ::= position <SP> position <LF> annotation *
35 position ::= filename <SP> num <SP> num <SP> num
36 annotation ::= keyword open-paren <LF> <SP> <SP> data <LF> close-paren
38 <SP> is a space character (ASCII 0x20)
39 <LF> is a line-feed character (ASCII 0x0A)
40 num is a sequence of decimal digits
41 filename is a string with the lexical conventions of O'Caml
42 open-paren is an open parenthesis (ASCII 0x28)
43 close-paren is a closed parenthesis (ASCII 0x29)
44 data is any sequence of characters where <LF> is always followed by
45 at least two space characters.
47 - in each block, the two positions are respectively the start and the
48 - end of the range described by the block.
49 - in a position, the filename is the name of the file, the first num
50 is the line number, the second num is the offset of the beginning
51 of the line, the third num is the offset of the position itself.
52 - the char number within the line is the difference between the third
53 and second nums.
56 )
62 caml-types-number-re " "
63 caml-types-number-re " "
64 caml-types-number-re)))
99 "Show the type of expression or pattern at point.
100 The smallest expression or pattern that contains point is
101 temporarily highlighted. Its type is highlighted in the .annot
102 file and the mark is set to the beginning of the type.
103 The type is also displayed in the mini-buffer.
105 Hints on using the type display:
106 . If you want the type of an identifier, put point within any
107 occurrence of this identifier.
108 . If you want the result type of a function application, put point
109 at the first space after the function name.
110 . If you want the type of a list, put point on a bracket, on a
111 semicolon, or on the :: constructor.
112 . Even if type checking fails, you can still look at the types
113 in the file, up to where the type checker failed.
115 Types are also displayed in the buffer *caml-types*, which is
116 displayed when the command is called with Prefix argument 4.
118 See also `caml-types-explore' for exploration by mouse dragging.
119 See `caml-types-location-re' for annotation file format.
120 "
135 caml-types-annotation-tree)))
140 ; (with-current-buffer type-buf (narrow-to-region 1 1))
141 )
151 ))))
158 )))
165 type-date
166 caml-types-annotation-date
177 caml-types-annotation-date type-date)
180 )))
188 ; we use an obarray for hash-consing the strings within each tree
197 ; tree of intervals
198 ; each node is a vector
199 ; [ pos-left pos-right type-info child child child... ]
200 ; type-info =
201 ; () if this node does not correspond to an annotated interval
202 ; (type-start . type-end) address of the annotation in the .annot file
235 accu)))
261 result))
269 curr
276 curr))))
278 ; trouve le premier fils qui commence apres la position
279 ; ou (length node) si tous commencent avant
283 med)
289 min))
302 i)
311 right nright)
325 ;; Warning: these comparison functions are not symmetric.
326 ;; The first argument determines the format:
327 ;; when its file component is empty, only the cnum is compared.
368 ; find-file-read-only-noselect seems to be missing from emacs...
377 ))
381 )
384 )
385 buf))
389 nil)
397 "Explore type annotations by mouse dragging.
399 The expression under the mouse is highlighted and its type is displayed
400 in the minibuffer, until the move is released, much as `caml-types-show-type'.
401 The function uses two overlays.
403 . One overlay delimits the largest region whose all subnodes
404 are well-typed.
405 . Another overlay delimits the current node under the mouse (whose type
406 annotation is beeing displayed).
407 "
415 target-pos
416 Left Right limits cnum node mes type
417 region
419 target-tree
423 )
432 ;; (message "Drag the mouse to explore types")
437 ;; we ignore non mouse events
439 ;; we stop when the original button is released
442 ;; we scroll when the motion is outside the window
450 mouse
451 time
452 )
459 )
472 )
474 )))
475 ;; main action, when the motion is inside the window
476 ;; or on orginal button down event
482 ;; mouse remains in outer region
483 nil
484 ;; otherwise, reset the outer region
491 ;; inner region is unchanged
492 nil
493 ;; recompute the inner region and type annotation
498 target-bol))
499 target-pos
510 Right
513 caml-types-expr-ovl Left Right target-buf)
516 target-pos node)
518 )
524 target-buf target-pos target-tree))
525 ))
528 ))
530 )
531 )
532 ;; we read next event, unless it is nil, and loop back.
534 )
535 )
536 ;; delete overlays at end of exploration
539 ))
540 ;; When an error occurs, the mouse release event has not been read.
541 ;; We could wait for mouse release to prevent execution of
542 ;; a binding of mouse release, such as cut or paste.
543 ;; In most common cases, next event will be the mouse release.
544 ;; However, it could also be a key stroke before mouse release.
545 ;; Emacs does not allow to test whether mouse is up or down.
546 ;; Not sure it is robust to loop for mouse release after an error
547 ;; occured, as is done for exploration.
548 ;; So far, we just ignore next event. (Next line also be uncommenting.)
550 )))
563 )
566 ))