/
haskell-doc.el
1993 lines (1814 loc) · 78.9 KB
/
haskell-doc.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; haskell-doc.el --- show function types in echo area -*- coding: iso-8859-1 -*-
;; Copyright (C) 2004, 2005, 2006, 2007, 2009 Free Software Foundation, Inc.
;; Copyright (C) 1997 Hans-Wolfgang Loidl
;; Author: Hans-Wolfgang Loidl <hwloidl@dcs.glasgow.ac.uk>
;; Temporary Maintainer and Hacker: Graeme E Moss <gem@cs.york.ac.uk>
;; Keywords: extensions, minor mode, language mode, Haskell
;; Created: 1997-06-17
;; URL: http://cvs.haskell.org/cgi-bin/cvsweb.cgi/fptools/CONTRIB/haskell-modes/emacs/haskell-doc.el?rev=HEAD
;;; Copyright:
;; ==========
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, you can either send email to this
;; program's maintainer or write to: The Free Software Foundation,
;; Inc.; 59 Temple Place, Suite 330; Boston, MA 02111-1307, USA.
;;; Commentary:
;; ===========
;; This program shows the type of the Haskell function under the cursor in the
;; minibuffer. It acts as a kind of "Emacs background process", by regularly
;; checking the word under the cursor and matching it against a list of
;; prelude, library, local and global functions.
;; To show types of global functions, i.e. functions defined in a module
;; imported by the current module, call the function
;; `turn-on-haskell-doc-global-types'. This automatically loads all modules
;; and builds `imenu' tables to get the types of all functions.
;; Note: The modules are loaded recursively, so you might pull in
;; many modules by just turning on global function support.
;; This features is currently not very well supported.
;; This program was inspired by the `eldoc.el' package by Noah Friedman.
;;; Installation:
;; =============
;; One useful way to enable this minor mode is to put the following in your
;; .emacs:
;;
;; (autoload 'turn-on-haskell-doc-mode "haskell-doc" nil t)
;; and depending on the major mode you use for your Haskell programs:
;; (add-hook 'hugs-mode-hook 'turn-on-haskell-doc-mode) ; hugs-mode
;; or
;; (add-hook 'haskell-mode-hook 'turn-on-haskell-doc-mode) ; haskell-mode
;;; Customisation:
;; ==============
;; You can control what exactly is shown by setting the following variables to
;; either t or nil:
;; `haskell-doc-show-global-types' (default: nil)
;; `haskell-doc-show-reserved' (default: t)
;; `haskell-doc-show-prelude' (default: t)
;; `haskell-doc-show-strategy' (default: t)
;; `haskell-doc-show-user-defined' (default: t)
;; If you want to define your own strings for some identifiers define an
;; alist of (ID . STRING) and set `haskell-doc-show-user-defined' to t.
;; E.g:
;;
;; (setq haskell-doc-show-user-defined t)
;; (setq haskell-doc-user-defined-ids
;; (list
;; '("main" . "just another pathetic main function")
;; '("foo" . "a very dummy name")
;; '("bar" . "another dummy name")))
;; The following two variables are useful to make the type fit on one line:
;; If `haskell-doc-chop-off-context' is non-nil the context part of the type
;; of a local fct will be eliminated (default: t).
;; If `haskell-doc-chop-off-fctname' is non-nil the function name is not
;; shown together with the type (default: nil).
;;; Internals:
;; ==========
;; `haskell-doc-mode' is implemented as a minor-mode. So, you can combine it
;; with any other mode. To enable it just type
;; M-x turn-on-haskell-doc-mode
;; These are the names of the functions that can be called directly by the
;; user (with keybindings in `haskell-hugs-mode' and `haskell-mode'):
;; `haskell-doc-mode' ... toggle haskell-doc-mode; with prefix turn it on
;; unconditionally if the prefix is greater 0 otherwise
;; turn it off
;; Key: CTRL-c CTRL-o (CTRL-u CTRL-c CTRL-o)
;; `haskell-doc-ask-mouse-for-type' ... show the type of the id under the mouse
;; Key: C-S-M-mouse-3
;; `haskell-doc-show-reserved' ... toggle echoing of reserved id's types
;; `haskell-doc-show-prelude' ... toggle echoing of prelude id's types
;; `haskell-doc-show-strategy' ... toggle echoing of strategy id's types
;; `haskell-doc-show-user-defined' ... toggle echoing of user def id's types
;; `haskell-doc-check-active' ... check whether haskell-doc is active;
;; Key: CTRL-c ESC-/
;;; ToDo:
;; =====
;; - Fix byte-compile problems in `haskell-doc-prelude-types' for getArgs etc
;; - Write a parser for .hi files and make haskell-doc independent from
;; hugs-mode. Read library interfaces via this parser.
;; - Indicate kind of object with colours
;; - Handle multi-line types
;; - Encode i-am-fct info in the alist of ids and types.
;;; Bugs:
;; =====
;; - Some prelude fcts aren't displayed properly. This might be due to a
;; name clash of Haskell and Elisp functions (e.g. length) which
;; confuses Emacs when reading `haskell-doc-prelude-types'
;;; Changelog:
;; ==========
;; $Log: haskell-doc.el,v $
;; Revision 1.30 2009/02/02 21:00:33 monnier
;; (haskell-doc-imported-list): Don't add current buffer
;; to the imported file list if it is not (yet?) visiting a file.
;;
;; Revision 1.29 2007-12-12 04:04:19 monnier
;; (haskell-doc-in-code-p): New function.
;; (haskell-doc-show-type): Use it.
;;
;; Revision 1.28 2007/08/30 03:10:08 monnier
;; Comment/docs fixes.
;;
;; Revision 1.27 2007/07/30 17:36:50 monnier
;; (displayed-month): Remove declaration since it's not used here.
;;
;; Revision 1.26 2007/02/10 06:28:55 monnier
;; (haskell-doc-get-current-word): Remove.
;; Change all refs to it, to use haskell-ident-at-point instead.
;;
;; Revision 1.25 2007/02/09 21:53:42 monnier
;; (haskell-doc-get-current-word): Correctly distinguish
;; variable identifiers and infix identifiers.
;; (haskell-doc-rescan-files): Avoid switch-to-buffer.
;; (haskell-doc-imported-list): Operate on current buffer.
;; (haskell-doc-make-global-fct-index): Adjust call.
;;
;; Revision 1.24 2006/11/20 20:18:24 monnier
;; (haskell-doc-mode-print-current-symbol-info): Fix thinko.
;;
;; Revision 1.23 2006/10/20 03:12:31 monnier
;; Drop post-command-idle-hook in favor of run-with-idle-timer.
;; (haskell-doc-timer, haskell-doc-buffers): New vars.
;; (haskell-doc-mode): Use them.
;; (haskell-doc-check-active): Update the check.
;; (haskell-doc-mode-print-current-symbol-info): Remove the interactive spec.
;; Don't sit-for unless it's really needed.
;;
;; Revision 1.22 2006/09/20 18:42:35 monnier
;; Doc fix.
;;
;; Revision 1.21 2005/11/21 21:48:52 monnier
;; * haskell-doc.el (haskell-doc-extract-types): Get labelled data working.
;; (haskell-doc-prelude-types): Update via auto-generation.
;;
;; * haskell-doc.el (haskell-doc-extract-types): Get it partly working.
;; (haskell-doc-fetch-lib-urls): Don't use a literal if we apply
;; `nreverse' on it later on.
;; (haskell-doc-prelude-types): Update some parts by auto-generation.
;; (haskell-doc-grab, haskell-doc-string-nub-ws): Simplify.
;;
;; * haskell-doc.el (haskell-doc-maintainer, haskell-doc-varlist)
;; (haskell-doc-submit-bug-report, haskell-doc-ftp-site)
;; (haskell-doc-visit-home): Remove.
;; (haskell-doc-reserved-ids, haskell-doc-fetch-lib-urls)
;; (haskell-doc-extract-and-insert-types): New funs.
;; (haskell-doc-reserved-ids): Fix type of `map'.
;;
;; Revision 1.20 2005/11/21 21:27:57 monnier
;; (haskell-doc-extract-types): Get labelled data working.
;; (haskell-doc-prelude-types): Update via auto-generation.
;;
;; Revision 1.19 2005/11/21 20:44:13 monnier
;; (haskell-doc-extract-types): Get it partly working.
;; (haskell-doc-fetch-lib-urls): Don't use a literal if we apply
;; `nreverse' on it later on.
;; (haskell-doc-prelude-types): Update some parts by auto-generation.
;; (haskell-doc-grab, haskell-doc-string-nub-ws): Simplify.
;;
;; Revision 1.18 2005/11/21 18:02:15 monnier
;; (haskell-doc-maintainer, haskell-doc-varlist)
;; (haskell-doc-submit-bug-report, haskell-doc-ftp-site)
;; (haskell-doc-visit-home): Remove.
;; (haskell-doc-reserved-ids, haskell-doc-fetch-lib-urls)
;; (haskell-doc-extract-and-insert-types): New funs.
;; (haskell-doc-reserved-ids): Fix type of `map'.
;;
;; Revision 1.17 2005/11/20 23:55:09 monnier
;; Add coding cookie.
;;
;; Revision 1.16 2005/11/07 01:28:16 monnier
;; (haskell-doc-xemacs-p, haskell-doc-emacs-p)
;; (haskell-doc-message): Remove.
;; (haskell-doc-is-id-char-at): Remove.
;; (haskell-doc-get-current-word): Rewrite.
;;
;; Revision 1.15 2005/11/04 17:11:12 monnier
;; Add arch-tag.
;;
;; Revision 1.14 2005/08/24 11:36:32 monnier
;; (haskell-doc-message): Paren typo.
;;
;; Revision 1.13 2005/08/23 19:23:27 monnier
;; (haskell-doc-show-type): Assume that the availability
;; of display-message won't change at runtime.
;;
;; Revision 1.12 2005/07/18 21:04:14 monnier
;; (haskell-doc-message): Remove.
;; (haskell-doc-show-type): inline it. Do nothing for if there's no doc to show.
;;
;; Revision 1.11 2004/12/10 17:33:18 monnier
;; (haskell-doc-minor-mode-string): Make it dynamic.
;; (haskell-doc-install-keymap): Remove conflicting C-c C-o binding.
;; (haskell-doc-mode): Make a nil arg turn the mode ON.
;; (turn-on-haskell-doc-mode): Make it an alias for haskell-doc-mode.
;; (haskell-doc-mode): Don't touch haskell-doc-minor-mode-string.
;; (haskell-doc-show-global-types): Don't touch
;; haskell-doc-minor-mode-string. Call haskell-doc-make-global-fct-index.
;; (haskell-doc-check-active): Fix message.
;; (define-key-after): Don't define.
;; (haskell-doc-install-keymap): Check existence of define-key-after.
;;
;; Revision 1.10 2004/11/25 23:03:23 monnier
;; (haskell-doc-sym-doc): Make even the last char bold.
;;
;; Revision 1.9 2004/11/24 22:14:36 monnier
;; (haskell-doc-install-keymap): Don't blindly assume there's a Hugs menu.
;;
;; Revision 1.8 2004/11/22 10:45:35 simonmar
;; Fix type of getLine
;;
;; Revision 1.7 2004/10/14 22:27:47 monnier
;; (turn-off-haskell-doc-mode, haskell-doc-current-info): Don't autoload.
;;
;; Revision 1.6 2004/10/13 22:45:22 monnier
;; (haskell-doc): New group.
;; (haskell-doc-show-reserved, haskell-doc-show-prelude)
;; (haskell-doc-show-strategy, haskell-doc-show-user-defined)
;; (haskell-doc-chop-off-context, haskell-doc-chop-off-fctname):
;; Make them custom vars.
;; (haskell-doc-keymap): Declare and fill it right there.
;; (haskell-doc-mode): Simplify.
;; (haskell-doc-toggle-var): Make it into what it was supposed to be.
;; (haskell-doc-mode-print-current-symbol-info): Simplify.
;; (haskell-doc-current-info): New autoloaded function.
;; (haskell-doc-sym-doc): New fun extracted from haskell-doc-show-type.
;; (haskell-doc-show-type): Use it.
;; (haskell-doc-wrapped-type-p): Remove unused var `lim'.
;; (haskell-doc-forward-sexp-safe, haskell-doc-current-symbol): Remove. Unused.
;; (haskell-doc-visit-home): Don't require ange-ftp, it's autoloaded.
;; (haskell-doc-install-keymap): Simplify.
;;
;; Revision 1.5 2003/01/09 11:56:26 simonmar
;; Patches from Ville Skyttä <scop@xemacs.org>, the XEmacs maintainer of
;; the haskell-mode:
;;
;; - Make the auto-mode-alist modifications autoload-only.
;;
;; Revision 1.4 2002/10/14 09:55:03 simonmar
;; Patch to update the Prelude/libraries function names and to remove
;; support for older versions of Haskell.
;;
;; Submitted by: Anders Lau Olsen <alauo@mip.sdu.dk>
;;
;; Revision 1.3 2002/04/30 09:34:37 rrt
;; Remove supporting Haskell 1.4 and 1.2 from the ToDo list. It's Far Too Late.
;;
;; Add (require 'imenu). Thanks to N. Y. Kwok.
;;
;; Revision 1.2 2002/04/23 14:45:10 simonmar
;; Tweaks to the doc strings and support for customization, from
;; Ville Skyttä <scop@xemacs.org>.
;;
;; Revision 1.1 2001/07/19 16:17:36 rrt
;; Add the current version of the Moss/Thorn/Marlow Emacs mode, along with its
;; web pages and sample files. This is now the preferred mode, and the
;; haskell.org pages are being changed to reflect that. Also includes the new
;; GHCi mode from Chris Webb.
;;
;; Revision 1.6 1998/12/10 16:27:25 hwloidl
;; Minor changes ("Doc" as modeline string, mouse-3 moved to C-S-M-mouse-3)
;;
;; Revision 1.5 1998/09/24 14:25:46 gem
;; Fixed minor compatibility bugs with Haskell mode of Moss&Thorn.
;; Disabled M-/ binding.
;;
;; Revision 1.4 1997/11/12 23:51:19 hwloidl
;; Fixed start-up problem under emacs-19.34.
;; Added support for wrapped (multi-line) types and 2 vars to control the
;; behaviour with long fct types
;;
;; Revision 1.3 1997/11/03 00:48:03 hwloidl
;; Major revision for first release.
;; Added alists for showing prelude fcts, haskell syntax, and strategies
;; Added mouse interface to show type under mouse
;; Fixed bug which causes demon to fall over
;; Works now with hugs-mode and haskell-mode under emacs 19.34,20 and xemacs 19.15
;;
;;; Code:
;; =====
;;@menu
;;* Constants and Variables::
;;* Install as minor mode::
;;* Menubar Support::
;;* Haskell Doc Mode::
;;* Switch it on or off::
;;* Check::
;;* Top level function::
;;* Mouse interface::
;;* Print fctsym::
;;* Movement::
;;* Bug Reports::
;;* Visit home site::
;;* Index::
;;* Token::
;;@end menu
;;@node top, Constants and Variables, (dir), (dir)
;;@top
;;@node Constants and Variables, Install as minor mode, top, top
;;@section Constants and Variables
;;@menu
;;* Emacs portability::
;;* Maintenance stuff::
;;* Mode Variable::
;;* Variables::
;;* Prelude types::
;;* Test membership::
;;@end menu
;;@node Emacs portability, Maintenance stuff, Constants and Variables, Constants and Variables
;;@subsection Emacs portability
(require 'haskell-mode)
(eval-when-compile (require 'cl))
(defgroup haskell-doc nil
"Show Haskell function types in echo area."
:group 'haskell
:prefix "haskell-doc-")
;;@node Mode Variable, Variables, Maintenance stuff, Constants and Variables
;;@subsection Mode Variable
(defvar haskell-doc-mode nil
"*If non-nil, show the type of the function near point or a related comment.
If the identifier near point is a Haskell keyword and the variable
`haskell-doc-show-reserved' is non-nil show a one line summary
of the syntax.
If the identifier near point is a Prelude or one of the standard library
functions and `haskell-doc-show-prelude' is non-nil show its type.
If the identifier near point is local \(i.e. defined in this module\) check
the `imenu' list of functions for the type. This obviously requires that
your language mode uses `imenu'.
If the identifier near point is global \(i.e. defined in an imported module\)
and the variable `haskell-doc-show-global-types' is non-nil show the type of its
function.
If the identifier near point is a standard strategy or a function, type related
related to strategies and `haskell-doc-show-strategy' is non-nil show the type
of the function. Strategies are special to the parallel execution of Haskell.
If you're not interested in that just turn it off.
If the identifier near point is a user defined function that occurs as key
in the alist `haskell-doc-user-defined-ids' and the variable
`haskell-doc-show-user-defined' is non-nil show the type of the function.
This variable is buffer-local.")
(make-variable-buffer-local 'haskell-doc-mode)
(defvar haskell-doc-mode-hook nil
"Hook invoked when entering `haskell-doc-mode'.")
(defvar haskell-doc-index nil
"Variable holding an alist matching file names to fct-type alists.
The function `haskell-doc-make-global-fct-index' rebuilds this variables
\(similar to an `imenu' rescan\).
This variable is buffer-local.")
(make-variable-buffer-local 'haskell-doc-index)
(defcustom haskell-doc-show-global-types nil
"If non-nil, search for the types of global functions by loading the files.
This variable is buffer-local."
:group 'haskell-doc
:type 'boolean)
(make-variable-buffer-local 'haskell-doc-show-global-types)
(defcustom haskell-doc-show-reserved t
"If non-nil, show a documentation string for reserved ids.
This variable is buffer-local."
:group 'haskell-doc
:type 'boolean)
(make-variable-buffer-local 'haskell-doc-show-reserved)
(defcustom haskell-doc-show-prelude t
"If non-nil, show a documentation string for prelude functions.
This variable is buffer-local."
:group 'haskell-doc
:type 'boolean)
(make-variable-buffer-local 'haskell-doc-show-prelude)
(defcustom haskell-doc-show-strategy t
"If non-nil, show a documentation string for strategies.
This variable is buffer-local."
:group 'haskell-doc
:type 'boolean)
(make-variable-buffer-local 'haskell-doc-show-strategy)
(defcustom haskell-doc-show-user-defined t
"If non-nil, show a documentation string for user defined ids.
This variable is buffer-local."
:group 'haskell-doc
:type 'boolean)
(make-variable-buffer-local 'haskell-doc-show-user-defined)
(defcustom haskell-doc-chop-off-context t
"If non-nil eliminate the context part in a Haskell type."
:group 'haskell-doc
:type 'boolean)
(defcustom haskell-doc-chop-off-fctname nil
"If non-nil omit the function name and show only the type."
:group 'haskell-doc
:type 'boolean)
(defcustom haskell-doc-use-inf-haskell nil
"If non-nil use inf-haskell.el to get type and kind information."
:group 'haskell-doc
:type 'boolean)
(defvar haskell-doc-search-distance 40 ; distance in characters
"*How far to search when looking for the type declaration of fct under cursor.")
;;@node Variables, Prelude types, Mode Variable, Constants and Variables
;;@subsection Variables
(defvar haskell-doc-idle-delay 0.50
"*Number of seconds of idle time to wait before printing.
If user input arrives before this interval of time has elapsed after the
last input, no documentation will be printed.
If this variable is set to 0, no idle time is required.")
(defvar haskell-doc-argument-case 'identity ; 'upcase
"Case to display argument names of functions, as a symbol.
This has two preferred values: `upcase' or `downcase'.
Actually, any name of a function which takes a string as an argument and
returns another string is acceptable.")
(defvar haskell-doc-mode-message-commands nil
"*Obarray of command names where it is appropriate to print in the echo area.
This is not done for all commands since some print their own
messages in the echo area, and these functions would instantly overwrite
them. But `self-insert-command' as well as most motion commands are good
candidates.
It is probably best to manipulate this data structure with the commands
`haskell-doc-add-command' and `haskell-doc-remove-command'.")
;;(cond ((null haskell-doc-mode-message-commands)
;; ;; If you increase the number of buckets, keep it a prime number.
;; (setq haskell-doc-mode-message-commands (make-vector 31 0))
;; (let ((list '("self-insert-command"
;; "next-" "previous-"
;; "forward-" "backward-"
;; "beginning-of-" "end-of-"
;; "goto-"
;; "recenter"
;; "scroll-"))
;; (syms nil))
;; (while list
;; (setq syms (all-completions (car list) obarray 'fboundp))
;; (setq list (cdr list))
;; (while syms
;; (set (intern (car syms) haskell-doc-mode-message-commands) t)
;; (setq syms (cdr syms)))))))
;; Bookkeeping; the car contains the last symbol read from the buffer.
;; The cdr contains the string last displayed in the echo area, so it can
;; be printed again if necessary without reconsing.
(defvar haskell-doc-last-data '(nil . nil))
(defvar haskell-doc-minor-mode-string
'(haskell-doc-show-global-types " DOC" " Doc")
"*String to display in mode line when Haskell-Doc Mode is enabled.")
;;@node Prelude types, Test membership, Variables, Constants and Variables
;;@subsection Prelude types
;;@cindex haskell-doc-reserved-ids
(defvar haskell-doc-reserved-ids
'(("case" . "case exp of { alts [;] }")
("class" . "class [context =>] simpleclass [where { cbody [;] }]")
("data" . "data [context =>] simpletype = constrs [deriving]")
("default" . "default (type1 , ... , typen)")
("deriving" . "deriving (dclass | (dclass1, ... , dclassn))") ; used with data or newtype
("do" . "do { stmts [;] } stmts -> exp [; stmts] | pat <- exp ; stmts | let decllist ; stmts")
("else" . "if exp then exp else exp")
("if" . "if exp then exp else exp")
("import" . "import [qualified] modid [as modid] [impspec]")
("in" . "let decllist in exp")
("infix" . "infix [digit] ops")
("infixl" . "infixl [digit] ops")
("infixr" . "infixr [digit] ops")
("instance" . "instance [context =>] qtycls inst [where { valdefs [;] }]")
("let" . "let { decl; ...; decl [;] } in exp")
("module" . "module modid [exports] where body")
("newtype" . "newtype [context =>] simpletype = con atype [deriving]")
("of" . "case exp of { alts [;] }")
("then" . "if exp then exp else exp")
("type" . "type simpletype = type")
("where" . "exp where { decl; ...; decl [;] }") ; check that ; see also class, instance, module
("as" . "import [qualified] modid [as modid] [impspec]")
("qualified" . "import [qualified] modid [as modid] [impspec]")
("hiding" . "hiding ( import1 , ... , importn [ , ] )"))
"An alist of reserved identifiers.
Each element is of the form (ID . DOC) where both ID and DOC are strings.
DOC should be a concise single-line string describing the construct in which
the keyword is used.")
(eval-and-compile
(defalias 'haskell-doc-split-string
(if (condition-case ()
(split-string "" nil t)
(wrong-number-of-arguments nil))
'split-string
;; copied from Emacs 22
(lambda (string &optional separators omit-nulls)
(let ((keep-nulls (not (if separators omit-nulls t)))
(rexp (or separators "[ \f\t\n\r\v]+"))
(start 0)
notfirst
(list nil))
(while (and (string-match rexp string
(if (and notfirst
(= start (match-beginning 0))
(< start (length string)))
(1+ start) start))
(< start (length string)))
(setq notfirst t)
(if (or keep-nulls (< start (match-beginning 0)))
(setq list
(cons (substring string start (match-beginning 0))
list)))
(setq start (match-end 0)))
(if (or keep-nulls (< start (length string)))
(setq list
(cons (substring string start)
list)))
(nreverse list))))))
;;@cindex haskell-doc-prelude-types
(defun haskell-doc-extract-types (url)
(with-temp-buffer
(insert-file-contents url)
(goto-char (point-min))
(while (search-forward " " nil t) (replace-match " " t t))
;; First, focus on the actual code, removing the surrounding HTML text.
(goto-char (point-min))
(let ((last (point-min))
(modules nil))
(while (re-search-forward "^module +\\([[:alnum:]]+\\)" nil t)
(let ((module (match-string 1)))
(if (member module modules)
;; The library nodes of the HTML doc contain modules twice:
;; once at the top, with only type declarations, and once at
;; the bottom with an actual sample implementation which may
;; include declaration of non-exported values.
;; We're now at this second occurrence is the implementation
;; which should thus be ignored.
nil
(push module modules)
(delete-region last (point))
(search-forward "</tt>")
;; Some of the blocks of code are split.
(while (looking-at "\\(<[^<>]+>[ \t\n]*\\)*<tt>")
(goto-char (match-end 0))
(search-forward "</tt>"))
(setq last (point)))))
(delete-region last (point-max))
;; Then process the HTML encoding to get back to pure ASCII.
(goto-char (point-min))
(while (search-forward "<br>" nil t) (replace-match "\n" t t))
;; (goto-char (point-min))
;; (while (re-search-forward "<[^<>]+>" nil t) (replace-match "" t t))
(goto-char (point-min))
(while (search-forward ">" nil t) (replace-match ">" t t))
(goto-char (point-min))
(while (search-forward "<" nil t) (replace-match "<" t t))
(goto-char (point-min))
(while (search-forward "&" nil t) (replace-match "&" t t))
(goto-char (point-min))
(if (re-search-forward "&[a-z]+;" nil t)
(error "Unexpected charref %s" (match-string 0)))
;; Remove TABS.
(goto-char (point-min))
(while (search-forward "\t" nil t) (replace-match " " t t))
;; Finally, extract the actual data.
(goto-char (point-min))
(let* ((elems nil)
(space-re "[ \t\n]*\\(?:--.*\n[ \t\n]*\\)*")
(comma-re (concat " *," space-re))
;; A list of identifiers. We have to be careful to weed out
;; entries like "ratPrec = 7 :: Int". Also ignore entries
;; which start with a < since they're actually in the HTML text
;; part. And the list may be spread over several lines, cut
;; after a comma.
(idlist-re
(concat "\\([^< \t\n][^ \t\n]*"
"\\(?:" comma-re "[^ \t\n]+\\)*\\)"))
;; A type. A few types are spread over 2 lines,
;; cut after the "=>", so we have to handle these as well.
(type-re "\\(.*[^\n>]\\(?:>[ \t\n]+.*[^\n>]\\)*\\) *$")
;; A decl of a list of values, possibly indented.
(val-decl-re
(concat "^\\( +\\)?" idlist-re "[ \t\n]*::[ \t\n]*" type-re))
(re (concat
;; 3 possibilities: a class decl, a data decl, or val decl.
;; First, let's match a class decl.
"^class \\(?:.*=>\\)? *\\(.*[^ \t\n]\\)[ \t\n]*where"
;; Or a value decl:
"\\|" val-decl-re
"\\|" ;; Or a data decl. We only handle single-arm
;; datatypes with labels.
"^data +\\([[:alnum:]][[:alnum:] ]*[[:alnum:]]\\)"
" *=.*{\\([^}]+\\)}"
))
(re-class (concat "^[^ \t\n]\\|" re))
curclass)
(while (re-search-forward (if curclass re-class re) nil t)
(cond
;; A class decl.
((match-end 1) (setq curclass (match-string 1)))
;; A value decl.
((match-end 4)
(let ((type (match-string 4))
(vars (match-string 3))
(indented (match-end 2)))
(if (string-match "[ \t\n][ \t\n]+" type)
(setq type (replace-match " " t t type)))
(if (string-match " *\\(--.*\\)?\\'" type)
(setq type (substring type 0 (match-beginning 0))))
(if indented
(if curclass
(if (string-match "\\`\\(.*[^ \t\n]\\) *=> *" type)
(let ((classes (match-string 1 type)))
(setq type (substring type (match-end 0)))
(if (string-match "\\`(.*)\\'" classes)
(setq classes (substring classes 1 -1)))
(setq type (concat "(" curclass ", " classes
") => " type)))
(setq type (concat curclass " => " type)))
;; It's actually not an error: just a type annotation on
;; some local variable.
;; (error "Indentation outside a class in %s: %s"
;; module vars)
nil)
(setq curclass nil))
(dolist (var (haskell-doc-split-string vars comma-re t))
(if (string-match "(.*)" var) (setq var (substring var 1 -1)))
(push (cons var type) elems))))
;; A datatype decl.
((match-end 5)
(setq curclass nil)
(let ((name (match-string 5)))
(save-excursion
(save-restriction
(narrow-to-region (match-beginning 6) (match-end 6))
(goto-char (point-min))
(while (re-search-forward val-decl-re nil t)
(let ((vars (match-string 2))
(type (match-string 3)))
(if (string-match "[ \t\n][ \t\n]+" type)
(setq type (replace-match " " t t type)))
(if (string-match " *\\(--.*\\)?\\'" type)
(setq type (substring type 0 (match-beginning 0))))
(if (string-match ",\\'" type)
(setq type (substring type 0 -1)))
(setq type (concat name " -> " type))
(dolist (var (haskell-doc-split-string vars comma-re t))
(if (string-match "(.*)" var)
(setq var (substring var 1 -1)))
(push (cons var type) elems))))))))
;; The end of a class declaration.
(t (setq curclass nil) (beginning-of-line))))
(cons (car (last modules)) elems)))))
(defun haskell-doc-fetch-lib-urls (base-url)
(with-temp-buffer
(insert-file-contents base-url)
(goto-char (point-min))
(search-forward "Part II: Libraries")
(delete-region (point-min) (point))
(search-forward "</table>")
(delete-region (point) (point-max))
(goto-char (point-min))
(let ((libs (list "standard-prelude.html")))
(while (re-search-forward "<a href=\"\\([^\"]+\\)\">" nil t)
(push (match-string 1) libs))
(mapcar (lambda (s) (expand-file-name s (file-name-directory base-url)))
(nreverse libs)))))
(defun haskell-doc-extract-and-insert-types (url)
"Fetch the types from the online doc and insert them at point.
URL is the URL of the online doc."
(interactive (if current-prefix-arg
(read-file-name "URL: ")
(list "http://www.haskell.org/onlinereport/")))
(let ((urls (haskell-doc-fetch-lib-urls url)))
(dolist (url urls)
(let ((data (haskell-doc-extract-types url)))
(insert ";; " (pop data)) (indent-according-to-mode) (newline)
(dolist (elem (sort data (lambda (x y) (string-lessp (car x) (car y)))))
(prin1 elem (current-buffer))
(indent-according-to-mode) (newline))))))
(defvar haskell-doc-prelude-types
;; This list was auto generated by `haskell-doc-extract-and-insert-types'.
'(
;; Prelude
("!!" . "[a] -> Int -> a")
("$" . "(a -> b) -> a -> b")
("$!" . "(a -> b) -> a -> b")
("&&" . "Bool -> Bool -> Bool")
("*" . "Num a => a -> a -> a")
("**" . "Floating a => a -> a -> a")
("+" . "Num a => a -> a -> a")
("++" . "[a] -> [a] -> [a]")
("-" . "Num a => a -> a -> a")
("." . "(b -> c) -> (a -> b) -> a -> c")
("/" . "Fractional a => a -> a -> a")
("/=" . "Eq a => a -> a -> Bool")
("<" . "Ord a => a -> a -> Bool")
("<=" . "Ord a => a -> a -> Bool")
("=<<" . "Monad m => (a -> m b) -> m a -> m b")
("==" . "Eq a => a -> a -> Bool")
(">" . "Ord a => a -> a -> Bool")
(">=" . "Ord a => a -> a -> Bool")
(">>" . "Monad m => m a -> m b -> m b")
(">>=" . "Monad m => m a -> (a -> m b) -> m b")
("^" . "(Num a, Integral b) => a -> b -> a")
("^^" . "(Fractional a, Integral b) => a -> b -> a")
("abs" . "Num a => a -> a")
("acos" . "Floating a => a -> a")
("acosh" . "Floating a => a -> a")
("all" . "(a -> Bool) -> [a] -> Bool")
("and" . "[Bool] -> Bool")
("any" . "(a -> Bool) -> [a] -> Bool")
("appendFile" . "FilePath -> String -> IO ()")
("asTypeOf" . "a -> a -> a")
("asin" . "Floating a => a -> a")
("asinh" . "Floating a => a -> a")
("atan" . "Floating a => a -> a")
("atan2" . "RealFloat a => a -> a -> a")
("atanh" . "Floating a => a -> a")
("break" . "(a -> Bool) -> [a] -> ([a],[a])")
("catch" . "IO a -> (IOError -> IO a) -> IO a")
("ceiling" . "(RealFrac a, Integral b) => a -> b")
("compare" . "Ord a => a -> a -> Ordering")
("concat" . "[[a]] -> [a]")
("concatMap" . "(a -> [b]) -> [a] -> [b]")
("const" . "a -> b -> a")
("cos" . "Floating a => a -> a")
("cosh" . "Floating a => a -> a")
("curry" . "((a, b) -> c) -> a -> b -> c")
("cycle" . "[a] -> [a]")
("decodeFloat" . "RealFloat a => a -> (Integer,Int)")
("div" . "Integral a => a -> a -> a")
("divMod" . "Integral a => a -> a -> (a,a)")
("drop" . "Int -> [a] -> [a]")
("dropWhile" . "(a -> Bool) -> [a] -> [a]")
("either" . "(a -> c) -> (b -> c) -> Either a b -> c")
("elem" . "(Eq a) => a -> [a] -> Bool")
("encodeFloat" . "RealFloat a => Integer -> Int -> a")
("enumFrom" . "Enum a => a -> [a]")
("enumFromThen" . "Enum a => a -> a -> [a]")
("enumFromThenTo" . "Enum a => a -> a -> a -> [a]")
("enumFromTo" . "Enum a => a -> a -> [a]")
("error" . "String -> a")
("even" . "(Integral a) => a -> Bool")
("exp" . "Floating a => a -> a")
("exponent" . "RealFloat a => a -> Int")
("fail" . "Monad m => String -> m a")
("filter" . "(a -> Bool) -> [a] -> [a]")
("flip" . "(a -> b -> c) -> b -> a -> c")
("floatDigits" . "RealFloat a => a -> Int")
("floatRadix" . "RealFloat a => a -> Integer")
("floatRange" . "RealFloat a => a -> (Int,Int)")
("floor" . "(RealFrac a, Integral b) => a -> b")
("fmap" . "Functor f => (a -> b) -> f a -> f b")
("foldl" . "(a -> b -> a) -> a -> [b] -> a")
("foldl1" . "(a -> a -> a) -> [a] -> a")
("foldr" . "(a -> b -> b) -> b -> [a] -> b")
("foldr1" . "(a -> a -> a) -> [a] -> a")
("fromEnum" . "Enum a => a -> Int")
("fromInteger" . "Num a => Integer -> a")
("fromIntegral" . "(Integral a, Num b) => a -> b")
("fromRational" . "Fractional a => Rational -> a")
("fst" . "(a,b) -> a")
("gcd" . "(Integral a) => a -> a -> a")
("getChar" . "IO Char")
("getContents" . "IO String")
("getLine" . "IO String")
("head" . "[a] -> a")
("id" . "a -> a")
("init" . "[a] -> [a]")
("interact" . "(String -> String) -> IO ()")
("ioError" . "IOError -> IO a")
("isDenormalized" . "RealFloat a => a -> Bool")
("isIEEE" . "RealFloat a => a -> Bool")
("isInfinite" . "RealFloat a => a -> Bool")
("isNaN" . "RealFloat a => a -> Bool")
("isNegativeZero" . "RealFloat a => a -> Bool")
("iterate" . "(a -> a) -> a -> [a]")
("last" . "[a] -> a")
("lcm" . "(Integral a) => a -> a -> a")
("length" . "[a] -> Int")
("lex" . "ReadS String")
("lines" . "String -> [String]")
("log" . "Floating a => a -> a")
("logBase" . "Floating a => a -> a -> a")
("lookup" . "(Eq a) => a -> [(a,b)] -> Maybe b")
("map" . "(a -> b) -> [a] -> [b]")
("mapM" . "Monad m => (a -> m b) -> [a] -> m [b]")
("mapM_" . "Monad m => (a -> m b) -> [a] -> m ()")
("max" . "Ord a => a -> a -> a")
("maxBound" . "Bounded a => a")
("maximum" . "(Ord a) => [a] -> a")
("maybe" . "b -> (a -> b) -> Maybe a -> b")
("min" . "Ord a => a -> a -> a")
("minBound" . "Bounded a => a")
("minimum" . "(Ord a) => [a] -> a")
("mod" . "Integral a => a -> a -> a")
("negate" . "Num a => a -> a")
("not" . "Bool -> Bool")
("notElem" . "(Eq a) => a -> [a] -> Bool")
("null" . "[a] -> Bool")
("numericEnumFrom" . "(Fractional a) => a -> [a]")
("numericEnumFromThen" . "(Fractional a) => a -> a -> [a]")
("numericEnumFromThenTo" . "(Fractional a, Ord a) => a -> a -> a -> [a]")
("numericEnumFromTo" . "(Fractional a, Ord a) => a -> a -> [a]")
("odd" . "(Integral a) => a -> Bool")
("or" . "[Bool] -> Bool")
("otherwise" . "Bool")
("pi" . "Floating a => a")
("pred" . "Enum a => a -> a")
("print" . "Show a => a -> IO ()")
("product" . "(Num a) => [a] -> a")
("properFraction" . "(RealFrac a, Integral b) => a -> (b,a)")
("putChar" . "Char -> IO ()")
("putStr" . "String -> IO ()")
("putStrLn" . "String -> IO ()")
("quot" . "Integral a => a -> a -> a")
("quotRem" . "Integral a => a -> a -> (a,a)")
("read" . "(Read a) => String -> a")
("readFile" . "FilePath -> IO String")
("readIO" . "Read a => String -> IO a")
("readList" . "Read a => ReadS [a]")
("readLn" . "Read a => IO a")
("readParen" . "Bool -> ReadS a -> ReadS a")
("reads" . "(Read a) => ReadS a")
("readsPrec" . "Read a => Int -> ReadS a")
("realToFrac" . "(Real a, Fractional b) => a -> b")
("recip" . "Fractional a => a -> a")
("rem" . "Integral a => a -> a -> a")
("repeat" . "a -> [a]")
("replicate" . "Int -> a -> [a]")
("return" . "Monad m => a -> m a")
("reverse" . "[a] -> [a]")
("round" . "(RealFrac a, Integral b) => a -> b")
("scaleFloat" . "RealFloat a => Int -> a -> a")
("scanl" . "(a -> b -> a) -> a -> [b] -> [a]")
("scanl1" . "(a -> a -> a) -> [a] -> [a]")
("scanr" . "(a -> b -> b) -> b -> [a] -> [b]")
("scanr1" . "(a -> a -> a) -> [a] -> [a]")
("seq" . "a -> b -> b")
("sequence" . "Monad m => [m a] -> m [a]")
("sequence_" . "Monad m => [m a] -> m ()")
("show" . "Show a => a -> String")
("showChar" . "Char -> ShowS")
("showList" . "Show a => [a] -> ShowS")
("showParen" . "Bool -> ShowS -> ShowS")
("showString" . "String -> ShowS")
("shows" . "(Show a) => a -> ShowS")
("showsPrec" . "Show a => Int -> a -> ShowS")
("significand" . "RealFloat a => a -> a")
("signum" . "Num a => a -> a")
("sin" . "Floating a => a -> a")
("sinh" . "Floating a => a -> a")
("snd" . "(a,b) -> b")
("span" . "(a -> Bool) -> [a] -> ([a],[a])")
("splitAt" . "Int -> [a] -> ([a],[a])")
("sqrt" . "Floating a => a -> a")
("subtract" . "(Num a) => a -> a -> a")
("succ" . "Enum a => a -> a")
("sum" . "(Num a) => [a] -> a")
("tail" . "[a] -> [a]")
("take" . "Int -> [a] -> [a]")
("takeWhile" . "(a -> Bool) -> [a] -> [a]")
("tan" . "Floating a => a -> a")
("tanh" . "Floating a => a -> a")
("toEnum" . "Enum a => Int -> a")
("toInteger" . "Integral a => a -> Integer")
("toRational" . "Real a => a -> Rational")
("truncate" . "(RealFrac a, Integral b) => a -> b")
("uncurry" . "(a -> b -> c) -> ((a, b) -> c)")
("undefined" . "a")
("unlines" . "[String] -> String")
("until" . "(a -> Bool) -> (a -> a) -> a -> a")
("unwords" . "[String] -> String")
("unzip" . "[(a,b)] -> ([a],[b])")
("unzip3" . "[(a,b,c)] -> ([a],[b],[c])")
("userError" . "String -> IOError")
("words" . "String -> [String]")
("writeFile" . "FilePath -> String -> IO ()")
("zip" . "[a] -> [b] -> [(a,b)]")
("zip3" . "[a] -> [b] -> [c] -> [(a,b,c)]")
("zipWith" . "(a->b->c) -> [a]->[b]->[c]")
("zipWith3" . "(a->b->c->d) -> [a]->[b]->[c]->[d]")
("||" . "Bool -> Bool -> Bool")
;; Ratio
("%" . "(Integral a) => a -> a -> Ratio a")
("approxRational" . "(RealFrac a) => a -> a -> Rational")
("denominator" . "(Integral a) => Ratio a -> a")
("numerator" . "(Integral a) => Ratio a -> a")
;; Complex
("cis" . "(RealFloat a) => a -> Complex a")
("conjugate" . "(RealFloat a) => Complex a -> Complex a")
("imagPart" . "(RealFloat a) => Complex a -> a")
("magnitude" . "(RealFloat a) => Complex a -> a")
("mkPolar" . "(RealFloat a) => a -> a -> Complex a")
("phase" . "(RealFloat a) => Complex a -> a")
("polar" . "(RealFloat a) => Complex a -> (a,a)")
("realPart" . "(RealFloat a) => Complex a -> a")
;; Numeric
("floatToDigits" . "(RealFloat a) => Integer -> a -> ([Int], Int)")
("fromRat" . "(RealFloat a) => Rational -> a")
("lexDigits" . "ReadS String")
("readDec" . "(Integral a) => ReadS a")
("readFloat" . "(RealFrac a) => ReadS a")
("readHex" . "(Integral a) => ReadS a")
("readInt" . "(Integral a) => a -> (Char -> Bool) -> (Char -> Int) -> ReadS a")
("readOct" . "(Integral a) => ReadS a")
("readSigned" . "(Real a) => ReadS a -> ReadS a")
("showEFloat" . "(RealFloat a) => Maybe Int -> a -> ShowS")
("showFFloat" . "(RealFloat a) => Maybe Int -> a -> ShowS")
("showFloat" . "(RealFloat a) => a -> ShowS")
("showGFloat" . "(RealFloat a) => Maybe Int -> a -> ShowS")
("showHex" . "Integral a => a -> ShowS")
("showInt" . "Integral a => a -> ShowS")
("showIntAtBase" . "Integral a => a -> (Int -> Char) -> a -> ShowS")
("showOct" . "Integral a => a -> ShowS")
("showSigned" . "(Real a) => (a -> ShowS) -> Int -> a -> ShowS")
;; Ix
("inRange" . "Ix a => (a,a) -> a -> Bool")
("index" . "Ix a => (a,a) -> a -> Int")
("range" . "Ix a => (a,a) -> [a]")
("rangeSize" . "Ix a => (a,a) -> Int")
;; Array
("!" . "(Ix a) => Array a b -> a -> b")
("//" . "(Ix a) => Array a b -> [(a,b)] -> Array a b")
("accum" . "(Ix a) => (b -> c -> b) -> Array a b -> [(a,c)]")
("accumArray" . "(Ix a) => (b -> c -> b) -> b -> (a,a) -> [(a,c)]")
("array" . "(Ix a) => (a,a) -> [(a,b)] -> Array a b")