| blob | 55635cc8c533e57a635b90a7348810c1ccf3baf7 |
1 ;; erlang.el --- Major modes for editing and running Erlang
3 ;; Copyright (C) 1995-1998,2000 Ericsson Telecom AB
4 ;; Copyright (C) 2004 Free Software Foundation, Inc.
5 ;; Author: Anders Lindgren
6 ;; Version: 2.5.2
7 ;; Keywords: erlang, languages, processes
8 ;; Date: 2000-09-11
10 ;; The contents of this file are subject to the Erlang Public License,
11 ;; Version 1.1, (the "License"); you may not use this file except in
12 ;; compliance with the License. You should have received a copy of the
13 ;; Erlang Public License along with this software. If not, it can be
14 ;; retrieved via the world wide web at http://www.erlang.org/.
16 ;; Software distributed under the License is distributed on an "AS IS"
17 ;; basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
18 ;; the License for the specific language governing rights and limitations
19 ;; under the License.
21 ;; The Initial Developer of the Original Code is Ericsson Utvecklings AB.
22 ;; All Rights Reserved.
24 ;; Lars Thorsén's modifications of 2000-06-07 included.
26 ;; The original version of this package was written by Robert Virding.
27 ;;
28 ;; Most skeletons have been written at Ericsson Telecom by
29 ;; magnus@erix.ericsson.se and janne@erix.ericsson.se
31 ;;; Commentary:
33 ;; Introduction:
34 ;; ------------
35 ;;
36 ;; This package provides support for the programming language Erlang.
37 ;; The package provides an editing mode with lots of bells and
38 ;; whistles, compilation support, and it makes it possible for the
39 ;; user to start Erlang shells that run inside Emacs.
40 ;;
41 ;; See the Erlang distribution for full documentation of this package.
43 ;; Installation:
44 ;; ------------
45 ;;
46 ;; Place this file in Emacs load path, byte-compile it, and add the
47 ;; following line to the appropriate init file:
48 ;;
49 ;; (require 'erlang-start)
50 ;;
51 ;; The full documentation contains much more extensive description of
52 ;; the installation procedure.
54 ;; Reporting Bugs:
55 ;; --------------
56 ;;
57 ;; Please send bug reports to the following email address:
58 ;; erlang-bugs@erlang.org
59 ;; or if you have a patch suggestion to:
60 ;; erlang-patches@erlang.org
61 ;; Please state as exactly as possible:
62 ;; - Version number of Erlang Mode (see the menu), Emacs, Erlang,
63 ;; and of any other relevant software.
64 ;; - What the expected result was.
65 ;; - What you did, preferably in a repeatable step-by-step form.
66 ;; - A description of the unexpected result.
67 ;; - Relevant pieces of Erlang code causing the problem.
68 ;; - Personal Emacs customisations, if any.
69 ;;
70 ;; Should the Emacs generate an error, please set the Emacs variable
71 ;; `debug-on-error' to `t'. Repeat the error and enclose the debug
72 ;; information in your bug-report.
73 ;;
74 ;; To set the variable you can use the following command:
75 ;; M-x set-variable RET debug-on-error RET t RET
76 ;;; Code:
78 ;; Variables:
84 "The directory where the Erlang system is installed.
85 The name should not contain the trailing slash.
87 Should this variable be nil, no manual pages will show up in the
91 erlang-menu-skel-items
92 erlang-menu-shell-items
93 erlang-menu-compile-items
94 erlang-menu-man-items
95 erlang-menu-personal-items
96 erlang-menu-version-items)
97 "*List of menu item list to combine to create Erlang mode menu.
99 External programs which temporarily add menu items to the Erlang mode
100 menu may use this variable. Please use the function `add-hook' to add
101 items.
103 Please call the function `erlang-menu-init' after every change to this
120 nil
124 nil
128 nil
131 nil
141 ;("Find Regexp" find-tag-regexp)
145 "Description of menu used in Erlang mode.
147 This variable must be a list. The elements are either nil representing
148 a horizontal line or a list with two or three elements. The first is
149 the name of the menu item, the second is the function to call, or a
150 submenu, on the same same form as ITEMS. The third optional argument
151 is an expression which is evaluated every time the menu is displayed.
152 Should the expression evaluate to nil the menu item is ghosted.
154 Example:
159 nil
169 "Description of the Shell menu used by Erlang mode.
178 "Description of the Compile menu used by Erlang mode.
188 "Description of personal menu items used in Erlang mode.
190 Please see the variable `erlang-menu-base-items' for a description
194 "The menu containing man pages.
196 The format of the menu should be compatible with `erlang-menu-base-items'.
197 This variable is added to the list of Erlang menus stored in
201 "Description of the menu containing the skeleton entries.
205 "*Functions to run when Erlang mode is activated.
207 This hook is used to change the behaviour of Erlang mode. It is
208 normally used by the user to personalise the programming environment.
209 When used in a site init file, it could be used to customise Erlang
210 mode for all users on the system.
212 The functions added to this hook are run every time Erlang mode is
213 started. See also `erlang-load-hook', a hook which is run once,
214 when Erlang mode is loaded into Emacs, and `erlang-shell-mode-hook'
215 which is run every time a new inferior Erlang shell is started.
217 To use a hook, create an Emacs lisp function to perform your actions
218 and add the function to the hook by calling `add-hook'.
220 The following example binds the key sequence C-c C-c to the command
221 `erlang-compile' (normally bound to C-c C-k). The example also
222 activates Font Lock mode to fontify the buffer and adds a menu
223 containing all functions defined in the current buffer.
225 To use the example, copy the following lines to your `~/.emacs' file:
227 (add-hook 'erlang-mode-hook 'my-erlang-mode-hook)
229 (defun my-erlang-mode-hook ()
231 (if window-system
232 (progn
233 (setq font-lock-maximum-decoration t)
234 (font-lock-mode 1)))
235 (if (and window-system (fboundp 'imenu-add-to-menubar))
239 "*Functions to run when Erlang mode is loaded.
241 This hook is used to change the behaviour of Erlang mode. It is
242 normally used by the user to personalise the programming environment.
243 When used in a site init file, it could be used to customize Erlang
244 mode for all users on the system.
246 The difference between this hook and `erlang-mode-hook' and
247 `erlang-shell-mode-hook' is that the functions in this hook
248 is only called once, when the Erlang mode is loaded into Emacs
249 the first time.
251 Natural actions for the functions added to this hook are actions which
252 only should be performed once, and actions which should be performed
253 before starting Erlang mode. For example, a number of variables are
254 used by Erlang mode before `erlang-mode-hook' is run.
256 The following example sets the variable `erlang-root-dir' so that the
257 manual pages can be retrieved (note that you must set the value of
258 `erlang-root-dir' to match the location of Erlang on your system):
260 (add-hook 'erlang-load-hook 'my-erlang-load-hook)
262 (defun my-erlang-load-hook ()
266 "Functions to run when a new Erlang source file is being edited.
268 A useful function is `tempo-template-erlang-normal-header'.
272 "*Non-nil means check that module name and file name agrees when saving.
274 If the value of this variable is the atom `ask', the user is
279 erlang-electric-semicolon
280 erlang-electric-gt)
281 "*List of activated electric commands.
283 The list should contain the electric commands which should be active.
284 Currently, the available electric commands are:
285 `erlang-electric-comma'
286 `erlang-electric-semicolon'
287 `erlang-electric-gt'
288 `erlang-electric-newline'
290 Should the variable be bound to t, all electric commands
291 are activated.
296 "*Set to non-nil to inhibit newline after electric command.
298 This is useful since a lot of people press return after executing an
299 electric command.
301 In order to work, the command must also be in the
302 list `erlang-electric-newline-inhibit-list'.
304 Note that commands in this list are required to set the variable
305 `erlang-electric-newline-inhibit' to nil when the newline shouldn't be
310 erlang-electric-comma
311 erlang-electric-gt)
315 "*Number of blank lines inserted before header, or nil.
317 This variable controls the behaviour of `erlang-electric-semicolon'
318 when a new function header is generated. When nil, no blank line is
319 inserted between the current line and the new header. When bound to a
320 number it represents the number of blank lines which should be
325 erlang-at-keyword-end-p
326 erlang-at-end-of-function-p)
327 "*List of functions controlling `erlang-electric-semicolon'.
328 The functions in this list are called, in order, whenever a semicolon
329 is typed. Each function in the list is called with no arguments,
330 and should return one of the following values:
332 nil -- no determination made, continue checking
333 'stop -- do not create prototype for next line
334 (anything else) -- insert prototype, and stop checking
336 If every function in the list is called with no determination made,
337 then no prototype is inserted.
343 erlang-stop-when-at-guard
344 erlang-next-lines-empty-p
345 erlang-at-keyword-end-p
346 erlang-at-end-of-function-p)
347 "*List of functions controlling `erlang-electric-comma'.
348 The functions in this list are called, in order, whenever a comma
349 is typed. Each function in the list is called with no arguments,
350 and should return one of the following values:
352 nil -- no determination made, continue checking
353 'stop -- do not create prototype for next line
354 (anything else) -- insert prototype, and stop checking
356 If every function in the list is called with no determination made,
357 then no prototype is inserted.
363 erlang-at-end-of-function-p)
364 "*List of functions controlling the arrow aspect of `erlang-electric-gt'.
365 The functions in this list are called, in order, whenever a `>'
366 is typed. Each function in the list is called with no arguments,
367 and should return one of the following values:
369 nil -- no determination made, continue checking
370 'stop -- do not create prototype for next line
371 (anything else) -- insert prototype, and stop checking
373 If every function in the list is called with no determination made,
374 then no prototype is inserted.
380 "*List of functions controlling `erlang-electric-newline'.
382 The electric newline commands indents the next line. Should the
383 current line begin with a comment the comment start is copied to
384 the newly created line.
386 The functions in this list are called, in order, whenever a comma
387 is typed. Each function in the list is called with no arguments,
388 and should return one of the following values:
390 nil -- no determination made, continue checking
391 'stop -- do not create prototype for next line
392 (anything else) -- trigger the electric command.
394 If every function in the list is called with no determination made,
395 then no prototype is inserted. Should the atom t be a member of the
396 list, it is treated as a function triggering the electric command.
401 "*Number of blank lines required to activate an electric command.
403 Actually, this value controls the behaviour of the function
404 `erlang-next-lines-empty-p' which normally is a member of the
405 criteria lists controlling the electric commands. (Please see
406 the variables `erlang-electric-semicolon-criteria' and
407 `erlang-electric-comma-criteria'.)
409 The variable is bound to a threshold value, a number, representing the
410 number of lines which must be empty.
412 Setting this variable to zero, electric commands will always be
413 triggered by `erlang-next-lines-empty-p', unless inhibited by other
414 rules.
416 Should this variable be nil, `erlang-next-lines-empty-p' will never
417 trigger an electric command. The same effect would be reached if the
418 function `erlang-next-lines-empty-p' would be removed from the criteria
419 lists.
421 Note that even if `erlang-next-lines-empty-p' should not trigger an
425 "*Non-nil means that the arguments are cloned when a clause is generated.
427 A new function header can be generated by calls to the function
431 "*When nil, go to the directory containing source file when compiling.
433 This is a workaround for a bug in the `outdir' option of compile. If the
434 outdir is not in the current load path, Erlang doesn't load the object
435 module after it has been compiled.
437 To activate the workaround, place the following in your `~/.emacs' file:
447 "*Indentation of the first argument in a function call.
448 When nil, indent to the column after the `(' of the
452 "*Non-nil means TAB in Erlang mode should always re-indent the current line,
460 "Inhibit the creation of the Erlang Manual Pages menu.
462 The Windows distribution of Erlang does not include man pages, hence
470 "*The man directories displayed in the Erlang menu.
472 Each item in the list should be a list with three elements, the first
473 the name of the menu, the second the directory, and the last a flag.
474 Should the flag the nil, the directory is absolute, should it be non-nil
481 "*Function used to display man page.
483 The function is called with one argument, the name of the file
484 containing the man page. Use this variable when the default
489 "Regexp which should match an Erlang atom.
493 "Number of regexp parenthesis pairs in `erlang-atom-regexp'.
495 This is used to determine parenthesis matches in complex regexps which
499 "Regexp which should match an Erlang variable.
503 "Number of regexp parenthesis pairs in `erlang-variable-regexp'.
505 This is used to determine matches in complex regexps which contains
512 "*Regexp which should match an Erlang file name.
514 This regexp is used when an Erlang module name is extracted from the
515 name of an Erlang source file.
517 The regexp should only match the section of the file name which should
518 be excluded from the module name.
521 The matches all except the extension. This is useful if the Erlang
522 tags system should interpret tags on the form `module:tag' for
534 emacs-major-version
542 emacs-minor-version
552 "Common popup menu for all buffers in Erlang mode.
554 This variable is destructively modified every time the Erlang menu
555 is modified. The effect is that all changes take effect in all
556 buffers in Erlang mode, just like under GNU Emacs.
562 \f
563 ;; Tempo skeleton templates:
566 ;; Font-lock variables
573 "Non-nil when this version of Emacs uses a modern version of Font Lock.
575 This is determined by checking the version of Emacs used, the actual
579 ;; The next few variables define different Erlang font-lock patterns.
580 ;; They could be appended to form a custom font-lock appearance.
581 ;;
582 ;; The function `erlang-font-lock-set-face' could be used to change
583 ;; the face of a pattern.
584 ;;
585 ;; Note that Erlang strings and atoms are highlighted with using
586 ;; syntactic analysis.
628 1
630 'font-lock-reference-face
632 t))
633 "Font lock keyword highlighting words in single quotes in comments.
635 This is not the highlighting of Erlang strings and atoms, which
638 ;; Note: The guard `float' collides with the bif `float'.
648 1
650 'font-lock-reference-face
679 1
688 'font-lock-reference-face
693 'font-lock-reference-face
695 "Font lock keyword highlighting macros.
702 ;; Don't highlight numerical constants.
707 "Font lock keyword highlighting Erlang records.
714 'font-lock-variable-name-face
716 "Font lock keyword highlighting Erlang variables.
717 Must be preceded by `erlang-font-lock-keywords-macros' and `-records'
723 erlang-font-lock-keywords-dollar
724 erlang-font-lock-keywords-arrow
725 erlang-font-lock-keywords-keywords)
726 ;; DocStringOrig: erlang-font-lock-keywords
727 "Font-lock keywords used by Erlang Mode.
729 There exists three levels of Font Lock keywords for Erlang:
730 `erlang-font-lock-keywords-1' - Function headers and reserved keywords.
731 `erlang-font-lock-keywords-2' - Bifs, guards and `single quotes'.
732 `erlang-font-lock-keywords-3' - Variables, macros and records.
734 To use a specific level, please set the variable
735 `font-lock-maximum-decoration' to the appropriate level. Note that the
736 variable must be set before Erlang mode is activated.
738 Example:
744 erlang-font-lock-keywords-attr
745 erlang-font-lock-keywords-quotes
746 erlang-font-lock-keywords-guards
747 erlang-font-lock-keywords-bifs)
748 ;; DocStringCopy: erlang-font-lock-keywords
749 "Font-lock keywords used by Erlang Mode.
751 There exists three levels of Font Lock keywords for Erlang:
752 `erlang-font-lock-keywords-1' - Function headers and reserved keywords.
753 `erlang-font-lock-keywords-2' - Bifs, guards and `single quotes'.
754 `erlang-font-lock-keywords-3' - Variables, macros and records.
756 To use a specific level, please set the variable
757 `font-lock-maximum-decoration' to the appropriate level. Note that the
758 variable must be set before Erlang mode is activated.
760 Example:
766 erlang-font-lock-keywords-macros
767 erlang-font-lock-keywords-records
768 erlang-font-lock-keywords-vars)
769 ;; DocStringCopy: erlang-font-lock-keywords
770 "Font-lock keywords used by Erlang Mode.
772 There exists three levels of Font Lock keywords for Erlang:
773 `erlang-font-lock-keywords-1' - Function headers and reserved keywords.
774 `erlang-font-lock-keywords-2' - Bifs, guards and `single quotes'.
775 `erlang-font-lock-keywords-3' - Variables, macros and records.
777 To use a specific level, please set the variable
778 `font-lock-maximum-decoration' to the appropriate level. Note that the
779 variable must be set before Erlang mode is activated.
781 Example:
786 ;; DocStringCopy: erlang-font-lock-keywords
787 "Font-lock keywords used by Erlang Mode.
789 There exists three levels of Font Lock keywords for Erlang:
790 `erlang-font-lock-keywords-1' - Function headers and reserved keywords.
791 `erlang-font-lock-keywords-2' - Bifs, guards and `single quotes'.
792 `erlang-font-lock-keywords-3' - Variables, macros and records.
794 To use a specific level, please set the variable
795 `font-lock-maximum-decoration' to the appropriate level. Note that the
796 variable must be set before Erlang mode is activated.
798 Example:
803 "Syntax table used by Font Lock mode.
805 The difference between this and the standard Erlang Mode
806 syntax table is that `_' is treated as part of words by
807 this syntax table.
809 Unfortunately, XEmacs hasn't got support for a special Font
810 Lock syntax table. The effect is that `apply' in the atom
813 \f
814 ;;; Avoid errors while compiling this file.
816 ;; `eval-when-compile' is not defined in Emacs 18. We define it as a
817 ;; no-op.
821 ;; These umm...functions are new in Emacs 20. And, yes, until version
822 ;; 19.27 Emacs backquotes were this ugly.
826 "(unless CONDITION BODY...): If CONDITION is false, do BODY, else return nil."
828 nil
833 "(when CONDITION BODY...): If CONDITION is true, do BODY, else return nil."
836 nil))))
840 "Return the character in the current buffer just before POS."
849 ;; Do not warn for unused variables
850 ;; when compiling under XEmacs.
856 \f
858 "Return the current version of Erlang mode."
862 erlang-version))
863 erlang-version)
866 ;;;###autoload
868 "Major mode for editing Erlang source files in Emacs.
869 It knows about syntax and comment, it can indent code, it is capable
870 of fontifying the source file, the TAGS commands are aware of Erlang
871 modules, and the Erlang man pages can be accessed.
874 is activated whenever an Erlang source or header file is loaded into
875 Emacs. To indicate this, the mode line should contain the word
878 The main feature of Erlang mode is indentation, press TAB and the
879 current line will be indented correctly.
881 Comments starting with only one `%' are indented to the column stored
882 in the variable `comment-column'. Comments starting with two `%':s
883 are indented with the same indentation as code. Comments starting
884 with at least three `%':s are indented to the first column.
886 However, Erlang mode contains much more, this is a list of the most
887 useful commands:
888 TAB - Indent the line.
889 C-c C-q - Indent current function.
890 M-; - Create a comment at the end of the line.
891 M-q - Fill a comment, i.e. wrap lines so that they (hopefully)
892 will look better.
893 M-a - Goto the beginning of an Erlang clause.
894 M-C-a - Ditto for function.
895 M-e - Goto the end of an Erlang clause.
896 M-C-e - Ditto for function.
897 M-h - Mark current Erlang clause.
898 M-C-h - Ditto for function.
899 C-c C-z - Start, or switch to, an inferior Erlang shell.
900 C-c C-k - Compile current file.
901 C-x ` - Next error.
902 , - Electric comma.
903 ; - Electric semicolon.
905 Erlang mode check the name of the file against the module name when
906 saving, whenever a mismatch occurs Erlang mode offers to modify the
907 source.
909 The variable `erlang-electric-commands' controls the electric
910 commands. To deactivate all of them, set it to nil.
912 There exists a large number of commands and variables in the Erlang
913 module. Please press `M-x apropos RET erlang RET' to see a complete
914 list. Press `C-h f name-of-function RET' and `C-h v name-of-variable
915 RET'to see the full description of functions and variables,
916 respectively.
918 On entry to this mode the contents of the hook `erlang-mode-hook' is
919 executed.
921 Please see the beginning of the file `erlang.el' for more information
922 and examples of hooks.
924 Other commands:
969 ;; Pseudo bit-syntax: Latin1 double angle quotes as parens.
970 ;;(modify-syntax-entry ?\253 "(?\273" table)
971 ;;(modify-syntax-entry ?\273 ")?\253" table)
980 nil
995 ;;(unless (boundp 'fill-paragraph-function)
1024 ;; Set up electric character functions to work with
1025 ;; delsel/pending-del mode. Also, set up text properties for bit
1026 ;; syntax handling.
1031 erlang-electric-comma
1032 erlang-electric-gt))
1090 ;; Compilation.
1091 ;;
1092 ;; The following code is compatible with the standard package `compilation',
1093 ;; making it possible to go to errors using `erlang-next-error' (or just
1094 ;; `next-error' in Emacs 21).
1095 ;;
1096 ;; The normal `compile' command works of course. For best result, please
1097 ;; execute `make' with the `-w' flag.
1098 ;;
1099 ;; Please see the variables named `compiling-..' above.
1110 ;; Emacs 18, Only one regexp is allowed.
1113 \f
1115 "Initialize Font Lock for Erlang mode."
1120 table)))
1122 erlang-font-lock-syntax-table)
1134 ;; `level' can here be:
1135 ;; A number - The fontification level
1136 ;; nil - Use the default
1137 ;; t - Use maximum
1147 ;; Modern font-locks can handle the above much more elegantly:
1150 erlang-font-lock-keywords-2 erlang-font-lock-keywords-3)
1156 ;; Useful when defining your own keywords.
1158 "Replace the face components in a list of keywords.
1160 The first argument, KS, is a list of keywords. The rest of the
1161 arguments are expressions to replace the face information with. The
1162 first expression replaces the face of the first keyword, the second
1163 expression the second keyword etc.
1165 Should an expression be nil, the face of the corresponding keyword is
1166 not changed.
1168 Should fewer expressions than keywords be given, the last expression
1169 is used for all remaining keywords.
1171 Normally, the expressions are just atoms representing the new face.
1172 They could however be more complex, returning different faces in
1173 different situations.
1175 This function only handles keywords with elements on the forms:
1176 (REGEXP NUMBER FACE)
1177 (REGEXP NUMBER FACE OVERWRITE)
1179 This could be used when defining your own special font-lock setup, e.g:
1181 \(setq my-font-lock-keywords
1182 (append erlang-font-lock-keywords-func
1183 erlang-font-lock-keywords-dollar
1184 (erlang-font-lock-set-face
1185 erlang-font-lock-keywords-macros 'my-neon-green-face)
1186 (erlang-font-lock-set-face
1187 erlang-font-lock-keywords-lc 'my-deep-red 'my-light-red)
1188 erlang-font-lock-keywords-attr))
1190 For a more elaborate example, please see the beginning of the file
1191 `erlang.el'."
1210 ;; DocStringOrig: font-cmd
1211 "Unfontify current buffer."
1217 ;; DocStringCopy: font-cmd
1218 "Fontify current buffer at level 1.
1219 This highlights function headers, reserved keywords, strings and comments."
1228 ;; DocStringCopy: font-cmd
1229 "Fontify current buffer at level 2.
1230 This highlights level 1 features (see `erlang-font-lock-level-1')
1231 plus bifs, guards and `single quotes'."
1240 ;; DocStringCopy: font-cmd
1241 "Fontify current buffer at level 3.
1242 This highlights level 2 features (see `erlang-font-lock-level-2')
1243 plus variables, macros and records."
1250 \f
1252 "Init menus for Erlang mode.
1254 The variable `erlang-menu-items' contain a description of the Erlang
1255 mode menu. Normally, the list contains atoms, representing variables
1256 bound to pieces of the menu.
1258 Personal extensions could be added to `erlang-menu-personal-items'.
1260 This function should be called if any variable describing the
1261 menu configuration is changed."
1266 "Install a menu in Emacs or XEmacs based on an abstract description.
1268 NAME is the name of the menu.
1270 ITEMS is a list. The elements are either nil representing a horizontal
1271 line or a list with two or three elements. The first is the name of
1272 the menu item, the second the function to call, or a submenu, on the
1273 same same form as ITEMS. The third optional element is an expression
1274 which is evaluated every time the menu is displayed. Should the
1275 expression evaluate to nil the menu item is ghosted.
1277 KEYMAP is the keymap to add to menu to. (When using XEmacs, the menu
1278 will only be visible when this menu is the global, the local, or an
1279 activate minor mode keymap.)
1281 If POPUP is non-nil, the menu is bound to the XEmacs `mode-popup-menu'
1282 variable, i.e. it will popup when pressing the right mouse button.
1284 Please see the variable `erlang-menu-base-items'."
1287 ;; We add the menu to the global menubar.
1288 ;;(funcall (symbol-function 'set-buffer-menubar)
1289 ;; (symbol-value 'current-menubar))
1302 "Build a menu for Emacs 19."
1304 name))
1306 id def first second third)
1309 ;; Replace any occurrence of atoms by their value.
1342 "Build a menu for XEmacs."
1344 first second third entry)
1346 ;; Replace any occurrence of atoms by their value.
1366 first second)))
1367 res))))
1370 ;; When adding a menu to a minor-mode keymap under Emacs,
1371 ;; it disappears when the mode is disabled. The expression
1372 ;; generated below imitates this behaviour.
1373 ;; (This could be expressed much clearer using backquotes,
1374 ;; but I don't want to pull in every package.)
1382 keymap
1389 "Substitute functions in menu described by ITEMS.
1391 The menu ITEMS is updated destructively.
1393 ALIST is list of pairs where the car is the old function and cdr the new."
1410 "Add menu ENTRY above menu entry ABOVE in menu ITEMS.
1411 Do nothing if the items already should be in the menu.
1412 Should ABOVE not be in the list, the entry is added at
1413 the bottom of the menu.
1415 The new menu is returned. No guarantee is given that the original
1416 menu is left unchanged.
1418 The equality test is performed by `eq'.
1420 Example: (erlang-menu-add-above 'my-erlang-menu-items
1421 'erlang-menu-man-items)"
1426 "Add menu ENTRY below menu items BELOW in the Erlang menu.
1427 Do nothing if the items already should be in the menu.
1428 Should BELOW not be in the list, items is added at the bottom
1429 of the menu.
1431 The new menu is returned. No guarantee is given that the original
1432 menu is left unchanged.
1434 The equality test is performed by `eq'.
1436 Example:
1438 \(setq erlang-menu-items
1439 (erlang-menu-add-below 'my-erlang-menu-items
1440 'erlang-menu-base-items
1441 erlang-menu-items))"
1443 items ; Return the original menu.
1446 res)
1461 res)))
1464 "Delete ENTRY from menu ITEMS.
1466 The new menu is returned. No guarantee is given that the original
1467 menu is left unchanged."
1469 \f
1470 ;; Man code:
1473 "Add menus containing the manual pages of the Erlang.
1475 The variable `erlang-man-dirs' contains entries describing
1476 the location of the manual pages."
1479 ()
1489 'erlang-menu-version-items
1490 erlang-menu-items))
1495 "Remove the man pages from the Erlang mode."
1502 ;; The man menu is a hierarchal structure, with the manual sections
1503 ;; at the top, described by `erlang-man-dirs'. The next level could
1504 ;; either be the manual pages if not to many, otherwise it is an index
1505 ;; menu whose submenus will contain up to `erlang-man-max-menu-size'
1506 ;; manual pages.
1509 "Create one menu entry per element of DIR-LIST.
1510 The format is described in the documentation of `erlang-man-dirs'."
1512 dir)
1515 ;; Relative to `erlang-root-dir'.
1519 ;; Absolute
1526 menu)))
1528 ;; Should no menus be found, generate a menu item which
1529 ;; will display a help text, when selected.
1536 ;; Should the menu be to long, let's split it into a number of
1537 ;; smaller menus. Warning, this code contains beautiful
1538 ;; destructive operations!
1540 "Create the second level menu from FILELIST.
1542 Should the list be longer than `erlang-man-max-menu-size', a tree of
1543 menus is created."
1548 segment submenu pair)
1558 " -- "
1560 submenu)
1561 menu)))
1566 "Make a leaf menu based on FILELIST."
1568 item)
1578 "Create a menu item containing the name of the man page."
1585 file))))))
1589 "Return files in directory DIR."
1594 "Find manual page for MODULE, defaults to module of function under point.
1595 This function is aware of imported functions."
1601 ""
1604 mod
1605 input))))
1612 file-list)
1628 ;; Warning, the function `erlang-man-function' is a hack!
1629 ;; It links itself into the man code in a non-clean way. I have
1630 ;; chosen to keep it since it provides a very useful functionality
1631 ;; which is not possible to achieve using a clean approach.
1632 ;; / AndersL
1635 "Name of function for last `erlang-man-function' call.
1636 Used for communication between `erlang-man-function' and the
1640 "Find manual page for NAME, where NAME is module:function.
1641 The entry for `function' is displayed.
1643 This function is aware of imported functions."
1650 "Manual entry for `module:func' or `module'%s: "
1652 ""
1657 mod)
1658 input))))
1659 ;; Emacs 18 doesn't provide `man'...
1677 ;; Emacs 19: The man command could possibly start an
1678 ;; asynchronous process, i.e. we must hook ourselves into
1679 ;; the system to be activated when the man-process
1680 ;; terminates.
1682 ()
1694 funcname))))))
1697 ;; Should the defadvice be at the top level, the package `advice' would
1698 ;; be required. Now it is only required when this functionality
1699 ;; is used. (Emacs 19 specific.)
1701 "Patch the function `Man-notify-when-ready' to search for function.
1702 The variable `erlang-man-function-name' is assumed to be bound to
1703 the function name, or to nil.
1705 The reason for patching a function is that under Emacs 19, the man
1706 command is executed asynchronously."
1709 ;; This should never happened since this is only called when
1710 ;; running under Emacs 19.
1716 "Set point at the documentation of the function name in
1717 `erlang-man-function-name' when the man page is displayed."
1724 "Find manual page for function in `erlang-man-function-name' in buffer BUF."
1741 "Display FILE as a `man' file.
1742 This is the default manual page display function.
1743 The variables `erlang-man-display-function' contains the function
1744 to be used."
1745 ;; Emacs 18 doesn't `provide' man.
1756 ;; Emacs 18
1758 process-environment)))
1764 ;; Emacs 19.28 and earlier versions of 19:
1765 ;; The manual-entry command unconditionally prompts
1766 ;; the user :-(
1768 page))))
1773 "Describe why the manual pages weren't found."
1778 In order to find the manual pages, the variable `erlang-root-dir'
1779 should be bound to the name of the directory containing the Erlang
1780 installation. The name should not include the final slash.
1782 Practically, you should add a line on the following form to
1783 your ~/.emacs, or ask your system administrator to add it to
1784 the site init file:
1787 For example:
1790 After installing the line, kill and restart Emacs, or restart Erlang
1792 \f
1793 ;; Indentation code:
1796 "Indent current line as Erlang code.
1797 With argument, indent any additional lines of the same clause
1798 rigidly along with this one."
1801 ;; If arg, always indent this line as Erlang
1802 ;; and shift remaining lines of clause the same amount.
1804 beg end)
1825 "Indent current line as Erlang code.
1826 Return the amount the indentation changed by."
1828 indent beg
1829 shift-amt)
1841 ;; This should never occur here.
1847 nil
1850 ;; If initial point was within line's indentation, position
1851 ;; after the indentation. Else stay at same point in text.
1854 shift-amt))
1858 "Indent region of Erlang code.
1860 This is automagically called by the user level function `indent-region'."
1866 indent-point;; The beginning of the current line
1867 indent;; The indent amount
1868 state)
1873 ;; Parse the Erlang code from the beginning of the clause to
1874 ;; the beginning of the region.
1877 ;; Indent every line in the region
1882 ;; Do not use our stack to help the user to customize
1883 ;; comment indentation.
1886 ;; Don't indent empty lines.
1895 ;; This should never occur here.
1900 nil
1903 ;; Find the next line in the region
1916 "Indent current buffer as Erlang code."
1925 "Indent current Erlang function."
1934 "Indent current Erlang clause."
1944 ;; Would much prefer to make caddr a macro but this clashes.
1949 "Compute appropriate indentation for current line as Erlang code.
1950 Return nil if line starts inside string, t if in a comment."
1963 "Show syntactic information for current line."
1978 "Parse Erlang syntax starting at FROM until TO, with an optional STATE.
1979 Value is list (stack token-start token-type in-what)."
1985 in-what)
1988 ;; Done: Return previous state.
1994 ;; Word constituent: check and handle keywords.
1997 ;; Must pop top icr layer, `after' will push a new
1998 ;; layer next.
2005 ;; Must pop top icr layer, `catch' in try/catch
2006 ;;will push a new layer next.
2012 ;;((looking-at "^of$")
2013 ;; Must pop top icr layer, `of' in try/catch
2014 ;;will push a new layer next.
2015 ;; (progn
2016 ;; (while (and stack (eq (car (car stack)) '->))
2017 ;; (erlang-pop stack))
2018 ;; (if (and stack (memq (car (car stack)) '(icr begin)))
2019 ;; (erlang-pop stack))))
2020 )
2022 ;; Must push a new icr (if/case/receive) layer.
2025 ;; Push a new icr layer if we are defining a `fun'
2026 ;; expression, not when we are refering an existing
2027 ;; function.
2035 ;; In test suites you may want to do something like
2036 ;; ?match(Mem when integer(Mem), mnesia:table_info(Tab,
2037 ;; memory)), and then the following if/case/receive
2038 ;; statement will mess up the indentation by fooling the
2039 ;; erlang mode to think the 'when' in the argument is a
2040 ;; "real" when. The following three clauses will avoid
2041 ;; this problem.
2045 ;; Normal when case
2051 ;; Probably in try-statment, fake "->" to get right
2052 ;; indentation in erlang-calculate-stack-indent. If it
2053 ;; was an ordinary catch without try, these entries will
2054 ;; be popped of the stack at a later ocaccion.
2060 ;;((looking-at "^of$")
2061 ;; (erlang-push (list 'icr token (current-column)) stack)
2062 ;;(erlang-push (list '-> token (current-column)) stack))
2063 )
2065 ;; String: Try to skip over it. (Catch error if not complete.)
2078 ;; Expression prefix e.i. $ or ^ (Note ^ can be in the character
2079 ;; literal $^ or part of string and $ outside of a string denotes
2080 ;; a character literal)
2086 ;; Maybe a character literal, quote the next char to avoid
2087 ;; situations as $" being seen as the begining of a string.
2088 ;; Note the quoting something in the middle of a string is harmless.
2092 ;; Symbol constituent or punctuation
2097 ;; Clause end
2103 ;; Function end
2108 ;; Function head
2119 ;; List-comprehension divider
2124 ;;((looking-at ",$")
2125 ;; Normal catch not try-catch have caused icr
2126 ;; and then incr and faked "->" should be removed
2127 ;; (save-excursion
2128 ;; (back-to-indentation)
2129 ;; (cond ((looking-at "catch[^_a-zA-Z0-9]")
2130 ;; (erlang-pop stack)
2131 ;; (erlang-pop stack))))
2132 ;;(forward-char 1))
2134 ;; Parameter separator
2138 ;; Bit-syntax open paren
2143 ;; Bbit-syntax close paren
2155 ;; Macro
2157 ;; Skip over the ?
2159 )
2161 ;; Other punctuation: Skip over it and any following punctuation
2163 ;; Skip over all characters in the operand.
2166 ;; Other char: Skip over it.
2170 ;; Open parenthesis
2175 ;; Close parenthesis
2183 ;; Normal catch not try-catch might have caused icr
2184 ;; and then incr should be removed and is not an error.
2189 ))
2194 ))
2197 ;; Character quote: Skip it and the quoted char.
2201 ;; Character escape: Skip it and the escape sequence.
2206 ;; Everything else
2212 "From the given last position and state (stack) calculate indentation.
2213 Return nil if inside string, t if in a comment."
2220 ;; Return nil or t.
2224 erlang-indent-guard
2227 ;; Element of list, tuple or part of an expression,
2229 ;; indent to next column.
2233 ;; Line ends with parenthesis.
2235 erlang-argument-indent))
2237 ;; Indent to the same column as the first
2238 ;; argument.
2243 ;; The default indentation is the column of the option
2244 ;; directly following the keyword. (This does not apply to
2245 ;; `case'.) Should no option be on the same line, the
2246 ;; indentation is the indentation of the keyword +
2247 ;; `erlang-indent-level'.
2248 ;;
2249 ;; `after' should be indented to the save level as the
2250 ;; corresponding receive.
2273 )
2274 ;; Real indentation, where operators create extra indentation etc.
2277 ;; Check if there is more code after the '->' on the
2278 ;; same line. If so use this indentation as base, else
2279 ;; use parent indentation + 2 * level as base.
2288 ;; Look at last thing to see how we are to move relative
2289 ;; to the base.
2292 base)
2301 ;; Function application or record.
2303 erlang-argument-indent))
2304 ;; Empty line, or end; treat it as the end of
2305 ;; the block. (Here we have a choice: should
2306 ;; the user be forced to reindent continued
2307 ;; lines, or should the "end" be reindented?)
2314 ;; Avoid treating comments a continued line.
2316 base)
2317 ;; Continued line (e.g. line beginning
2318 ;; with an operator.)
2320 )
2330 ;; receive XYZ or receive
2331 ;; XYZ
2333 erlang-indent-level
2335 erlang-indent-guard))
2336 ;; "when" is followed by code, let's indent to the same
2337 ;; column.
2344 "Find the base column for current stack."
2355 ;; Take parent identation + offset,
2356 ;; else just erlang-indent-level if no parent
2359 offset)
2360 erlang-indent-level))
2365 ;; Does not handle `begin' .. `end'.
2367 "Return the first column of the preceding expression.
2368 This assumes that the preceding expression is either simple
2369 \(i.e. an atom) or parenthesized."
2374 ;; Needed to match the colon in "'foo':'bar'".
2376 col
2383 "Skip over whitespace and comments until limit reached."
2396 stop))
2399 "Are we looking at an Erlang keyword which will increase indentation?"
2404 "Are we looking at an Erlang operator?"
2409 "Compute Erlang comment indentation.
2411 Used both by `indent-for-comment' and the Erlang specific indentation
2412 commands."
2421 comment-column)))))
2422 \f
2423 ;;; Erlang movement commands
2425 ;; All commands below work as movement commands. I.e. if the point is
2426 ;; at the end of the clause, and the command `erlang-end-of-clause' is
2427 ;; executed, the point is moved to the end of the NEXT clause. (This
2428 ;; mimics the behaviour of `end-of-defun'.)
2429 ;;
2430 ;; Personally I would like to rewrite them to be "pure", and add a set
2431 ;; of movement functions, like `erlang-next-clause',
2432 ;; `erlang-previous-clause', and the same for functions.
2433 ;;
2434 ;; The current implementation makes it hopeless to use the functions as
2435 ;; subroutines in more complex commands. /andersl
2438 "Move backward to previous start of clause.
2439 With argument, do this that many times.
2440 Return t unless search stops due to end of buffer."
2444 ;; Step back to the end of the previous line, unless we are at
2445 ;; the beginning of the buffer. The reason for this move is
2446 ;; that the regexp below includes the last character of the
2447 ;; previous line.
2454 ;; The regexp matches a function header that isn't
2455 ;; included in a string.
2460 t)))
2463 "Move to the end of the current clause.
2464 With argument, do this that many times."
2469 ;; Move to the next clause.
2477 nil
2482 "Put mark at end of clause, point at beginning."
2486 ;; Sets the region. In Emacs 19 and XEmacs, we want to activate
2487 ;; the region.
2492 ;; The above function deactivates the mark.
2497 "Move backward to previous start of function.
2498 With positive argument, do this that many times.
2499 With negative argument, search forward.
2501 Return t unless search stops due to end of buffer."
2505 ;; Search backward
2512 ;; Note: "arity" is nil for e.g. "-import", hence
2513 ;; two "-import" clauses are not considered to
2514 ;; be part of the same function.
2518 arity
2523 t)))
2525 ;; Search forward
2529 ;; Step -arg functions forward.
2531 ;; Step one function forward, or stop if the end of
2532 ;; the buffer was reached. Return t if we found the
2533 ;; function.
2539 arity
2543 found))
2549 "Move forward to next end of function.
2551 With argument, do this that many times.
2552 With negative argument go towards the beginning of the buffer."
2556 ;; Forward
2564 nil
2574 ;; Backward
2594 "Put mark at end of function, point at beginning."
2598 ;; Sets the region. In Emacs 19 and XEmacs, we want to activate
2599 ;; the region.
2604 ;; The above function deactivates the mark.
2619 ;; Skip over attribute leader.
2626 \f
2627 ;;; Miscellaneous
2631 If any of the current line is a comment, fill the comment or the
2632 paragraph of it that point is in, preserving the comment's indentation
2633 and initial `%':s."
2636 ;; If has-comment, the appropriate fill-prefix for the comment.
2637 comment-fill-prefix)
2638 ;; Figure out what kind of comment we are looking at.
2642 ;; Find the command prefix.
2647 ;; A line with some code, followed by a comment? Remember that the
2648 ;; % which starts the comment shouldn't be part of a string or
2649 ;; character.
2663 ;; Narrow to include only the comment, and then fill the region.
2666 ;; Find the first line we should include in the region to fill.
2670 ;; We may have gone to far. Go forward again.
2674 ;; Find the beginning of the first line past the region to fill.
2679 ;; Lines with only % on them can be paragraph boundaries.
2687 "Uncomment all commented lines in the region."
2693 "Create additional Erlang clause header.
2695 Parses the source file for the name of the current Erlang function.
2696 Create the header containing the name, A pair of parentheses,
2697 and an arrow. The space between the function name and the
2698 first parenthesis is preserved. The point is placed between
2699 the parentheses."
2710 nil
2721 "Insert, at the point, the argument list of the previous clause.
2723 The mark is set at the beginning of the inserted text, the point
2724 at the end."
2735 \f
2736 ;;; Information retrieval functions.
2739 "Like `buffer-substring-no-properties'.
2740 Although, this function works on all versions of Emacs."
2747 "Return the name of the module as specified by `-module'.
2749 Return nil if file contains no `-module' attribute."
2759 erlang-atom-regexp
2765 nil)
2770 "Extract the module name from a file name.
2772 First, the directory part is removed. Second, the part of the file name
2773 matching `erlang-file-name-extension-regexp' is removed.
2775 Should the match fail, nil is returned.
2777 By modifying `erlang-file-name-extension-regexp' to match files other
2778 than Erlang source files, Erlang specific functions could be applied on
2779 non-Erlang files. Most notably; the support for Erlang modules in the
2780 tags system could be used by files written in other languages."
2783 nil
2787 nil)))
2790 ;; Used by `erlang-get-export' and `erlang-get-import'.
2793 "Parse list of `function/arity' as used by `-import' and `-export'.
2795 Point must be before the opening bracket. When the
2796 function returns the point will be placed after the closing bracket.
2798 The function does not return an error if the list is incorrectly
2799 formatted.
2801 Return list of (function . arity). The order of the returned list
2802 corresponds to the order of the parsed Erlang list."
2825 res))
2829 ;; Test if there are more exported functions.
2834 ;;; Note that `-export' and the open parenthesis must be written on
2835 ;;; the same line.
2838 "Return a list of `(function . arity)' as specified by `-export'."
2848 res)
2853 "Parse an Erlang source file for imported functions.
2855 Return an alist with module name as car part and list of conses containing
2856 function and arity as cdr part."
2881 res)))))))))
2887 "Return name of current function, or nil.
2889 If optional argument is non-nil, everything up to and including
2890 the first `(' is returned.
2892 Normally used in conjunction with `erlang-beginning-of-clause', e.g.:
2893 (save-excursion
2894 (if (not (eobp)) (forward-char 1))
2895 (and (erlang-beginning-of-clause)
2896 (erlang-get-function-name t)))"
2908 Normally used in conjunction with `erlang-beginning-of-clause', e.g.:
2909 (save-excursion
2910 (if (not (eobp)) (forward-char 1))
2911 (and (erlang-beginning-of-clause)
2912 (erlang-get-function-arrow)))"
2919 "Return the number of arguments of function at point, or nil."
2942 res)
2946 "Return arguments of current function, or nil."
2949 nil
2960 "Return the module and function under the point, or nil.
2962 Should no explicit module name be present at the point, the
2963 list of imported functions is searched.
2965 The following could be returned:
2968 nil -- No function name found
2970 In the future the list may contain more elements."
2999 res)))
3002 ;; TODO: Escape single quotes inside the string without
3003 ;; replace-regexp-in-string.
3005 "Return STR, possibly with quotes."
3012 str))
3016 "Return STR without quotes, if present."
3021 str)
3024 \f
3025 ;;; Check module name
3027 ;; The function `write-file', bound to C-x C-w, calls
3028 ;; `set-visited-file-name' which clears the hook. :-(
3029 ;; To make sure that the hook always is present, we advise
3030 ;; `set-visited-file-name'.
3032 "Initialize the functionality to compare file and module names.
3034 Unless we have `before-save-hook', we redefine the function
3035 `set-visited-file-name' since it clears the variable
3036 `local-write-file-hooks'. The original function definition is
3037 stored in `erlang-orig-set-visited-file-name'."
3039 ;; If we have that, `make-local-hook' is obsolete.
3044 activate)
3051 "If the module name doesn't match file name, ask for permission to change.
3053 The variable `erlang-check-module-name' controls the behaviour of this
3054 function. It it is nil, this function does nothing. If it is t, the
3055 source is silently changed. If it is set to the atom `ask', the user
3056 is prompted.
3058 This function is normally placed in the hook `local-write-file-hooks'."
3074 erlang-atom-regexp
3082 ;; Must return nil since it is added to `local-write-file-hook'.
3083 nil)
3085 \f
3086 ;;; Electric functions.
3089 "Insert a semicolon character and possibly a prototype for the next line.
3091 The variable `erlang-electric-semicolon-criteria' states a criterion,
3092 when fulfilled a newline is inserted, the next line is indented and a
3093 prototype for the next line is inserted. Normally the prototype
3095 header is generated.
3097 The variable `erlang-electric-semicolon-insert-blank-lines' controls
3098 the number of blank lines inserted between the current line and new
3099 function header.
3101 Behaves just like the normal semicolon when supplied with a
3102 numerical arg, point is inside string or comment, or when there are
3103 non-whitespace characters following the point on the current line."
3109 erlang-electric-commands)))
3113 erlang-electric-semicolon-criteria)))
3132 erlang-electric-semicolon-insert-blank-lines))))
3137 "Insert a comma character and possibly a new indented line.
3138 The variable `erlang-electric-comma-criteria' states a criterion,
3139 when fulfilled a newline is inserted and the next line is indented.
3141 Behaves just like the normal comma when supplied with a
3142 numerical arg, point is inside string or comment, or when there are
3143 non-whitespace characters following the point on the current line."
3154 erlang-electric-comma-criteria)))
3165 "Insert a less-than sign, and optionally mark it as an open paren."
3171 ;; Was this the second char in bit-syntax open (`<<')?
3178 ;; Then mark the two chars...
3184 ;;...and unmark any subsequent less-than chars.
3192 "Return t if point is immediately after a bit-syntax close parenthesis (`>>')."
3201 "Return true if point is immediately after a function arrow (`->')."
3209 erlang-electric-commands))
3216 "Insert a greater-than sign, and optionally mark it as a close paren."
3223 ;; Did we just write a bit-syntax close (`>>')?
3226 ;; Then mark the two chars...
3233 ;;...and unmark any subsequent greater-than chars.
3240 ;; Did we just write a function arrow (`->')?
3250 ;; Then it's just a plain greater-than.
3252 nil)))
3256 "Insert a '>'-sign and possibly a new indented line.
3258 This command is only `electric' when the `>' is part of an `->' arrow.
3259 The variable `erlang-electric-arrow-criteria' states a sequence of
3260 criteria, which decides when a newline should be inserted and the next
3261 line indented.
3263 It behaves just like the normal greater than sign when supplied with a
3264 numerical arg, point is inside string or comment, or when there are
3265 non-whitespace characters following the point on the current line.
3267 After being split/merged into `erlang-after-arrow' and
3268 `erlang-electric-gt', it is now unused and disabled."
3275 erlang-electric-commands)))
3280 erlang-electric-arrow-criteria)))
3292 "Break line at point and indent, continuing comment if within one.
3293 The variable `erlang-electric-newline-criteria' states a criterion,
3294 when fulfilled a newline is inserted and the next line is indented.
3296 Should the current line begin with a comment, and the variable
3297 `comment-multi-line' be non-nil, a new comment start is inserted.
3299 Should the previous command be another electric command we assume that
3300 the user pressed newline out of old habit, hence we will do nothing."
3303 erlang-electric-newline-inhibit
3309 erlang-electric-commands)))
3311 erlang-electric-newline-criteria)))
3330 "Given a list of criterion functions, test if criteria are fulfilled.
3332 Each element in the criteria list can a function returning nil, t or
3333 the atom `stop'. t means that the criterion is fulfilled, `stop' means
3334 that it isn't fulfilled and that the search should stop,
3335 and nil means continue searching.
3337 Should the list contain the atom t the criterion is assumed to be
3338 fulfilled, unless preceded by a function returning `stop', of course.
3340 Should the argument be the atom t instead of a list, the criterion is
3341 assumed to be trivially true.
3343 Should all functions return nil, the criteria are assumed not to be
3344 fulfilled.
3346 Return t if criteria fulfilled, nil otherwise."
3348 t
3357 t
3358 nil)))))
3362 "Test if point is in string, quoted atom or comment.
3364 Return one of the three atoms `atom', `string', and `comment'.
3365 Should the point be inside none of the above mentioned types of
3366 context, nil is returned."
3382 "Test if point is at end of an Erlang function.
3384 This function is designed to be a member of a criteria list."
3391 "Return `stop' if inside parenthesis list, nil otherwise.
3393 Knows about the list comprehension syntax. When the point is
3394 after `||', `stop' is not returned.
3396 This function is designed to be a member of a criteria list."
3403 'stop
3404 ;; Do not return `stop' when inside a list comprehension
3405 ;; construction. (The point must be after `||').
3409 nil
3412 nil))))
3416 "Return `stop' when at function guards.
3418 This function is designed to be a member of a criteria list."
3426 'stop
3427 nil)))
3431 "Return non-nil if next lines are empty.
3433 The variable `erlang-next-lines-empty-threshold' contains the number
3434 of lines required to be empty.
3436 A line containing only spaces and tabs is considered empty.
3438 This function is designed to be a member of a criteria list."
3447 cont))))
3451 "Test if next readable token is the keyword end.
3453 This function is designed to be a member of a criteria list."
3458 \f
3459 ;; Erlang tags support which is aware of erlang modules.
3460 ;;
3461 ;; Not yet implemented under XEmacs. (Hint: The Emacs 19 etags
3462 ;; package works under XEmacs.)
3471 ;; Variables:
3504 "Install an alternate version of tags, aware of Erlang modules.
3506 After calling this function, the tags functions are aware of
3507 Erlang modules. Tags can be entered on the for `module:tag' as well
3508 as on the old form `tag'.
3510 In the completion list, `module:tag' and `module:' shows up.
3512 Call this function from an appropriate init file, or add it to
3513 Erlang mode hook with the commands:
3514 (add-hook 'erlang-mode-hook 'erlang-tags-init)
3515 (add-hook 'erlang-shell-mode-hook 'erlang-tags-init)
3517 This function only works under Emacs 18 and Emacs 19. Currently, It
3518 is not implemented under XEmacs. (Hint: The Emacs 19 etags module
3519 works under XEmacs.)"
3527 ;; Test on a function available in the Emacs 19 version
3528 ;; of tags but not in the XEmacs version.
3530 ()
3535 ;; Set all keys bound to `find-tag' et.al. in the global map and the
3536 ;; menu to `erlang-find-tag' et.al. in `map'.
3537 ;;
3538 ;; The function `substitute-key-definition' does not work properly
3539 ;; in all version of Emacs.
3542 "Bind tags commands to keymap MAP aware of Erlang modules."
3552 ;; Update the menu.
3557 ;; There exists a variable `find-tag-default-function'. It is not used
3558 ;; since `complete-tag' uses it to get current word under point. In that
3559 ;; situation we don't want the module to be prepended.
3562 "Return the default tag.
3563 Search `-import' list of imported functions.
3564 Single quotes are been stripped away."
3567 nil)
3574 ;; Return `t' since it is used inside `tags-loop-form'.
3575 ;;;###autoload
3577 "Like `find-tag'. Capable of retrieving Erlang modules.
3579 Tags can be given on the forms `tag', `module:', `module:tag'."
3582 t)
3585 ;; Code mainly from `find-tag-other-window' in `etags.el'.
3586 ;;;###autoload
3588 "Like `find-tag-other-window' but aware of Erlang modules."
3592 ;; This is to deal with the case where the tag is found in the
3593 ;; selected window's buffer; without this, point is moved in both
3594 ;; windows. To prevent this, we save the selected window's point
3595 ;; before doing find-tag-noselect, and restore it afterwards.
3602 ;; We have to set this new window's point; it
3603 ;; might already have been displaying a
3604 ;; different portion of tagbuf, in which case
3605 ;; switch-to-buffer-other-window doesn't set
3606 ;; the window's point from the buffer.
3608 window-point)))
3612 "Like `find-tag-other-frame' but aware of Erlang modules."
3620 "Like `find-tag-regexp' but aware of Erlang modules."
3626 'erlang-find-tag-other-window
3628 regexp next-p t))
3631 ;; Just like C-u M-. This could be added to the menu.
3641 ;; Mimics `find-tag-noselect' found in `etags.el', but uses `find-tag' to
3642 ;; be compatible with `tags.el'.
3643 ;;
3644 ;; Handles three cases:
3645 ;; * `module:' Loop over all possible file names. Stop if a file-name
3646 ;; without extension and directory matches the module.
3647 ;;
3648 ;; * `module:tag'
3649 ;; Emacs 19: Replace test functions with functions aware of
3650 ;; Erlang modules. Tricky because the etags system wasn't
3651 ;; built for these kind of operations...
3652 ;;
3653 ;; Emacs 18: We loop over `find-tag' until we find a file
3654 ;; whose module matches the requested module. The
3655 ;; drawback is that a lot of files could be loaded into
3656 ;; Emacs.
3657 ;;
3658 ;; * `tag' Just give it to `find-tag'.
3661 "Like `find-tag-noselect' but aware of Erlang modules."
3666 ;; `tags.el' uses this variable to record how M-, would
3667 ;; know where to restart a tags command.
3674 ;; Only the module name was given. Read all files whose file name
3675 ;; match.
3694 modtagname))))
3707 ;; Method one: Add module-recognising functions to the
3708 ;; list of order functions. However, the tags system
3709 ;; from Emacs 18, and derives thereof (read: XEmacs)
3710 ;; hasn't got this feature.
3715 modtagname next-p regexp-p)
3717 ;; Method two: Call the tags system until a file matching
3718 ;; the module is found. This could result in that many
3719 ;; files are read. (e.g. The tag "foo:file" will take a
3720 ;; while to process.)
3724 file)
3729 ;; Determine the module form the file name. (The
3730 ;; alternative, to check `-module', would make this
3731 ;; code useless for non-Erlang programs.)
3740 ;; Process interactive arguments for erlang-find-tag-*.
3741 ;;
3742 ;; Negative arguments work only for `etags', not `tags'. This is not
3743 ;; a problem since negative arguments means step back into the
3744 ;; history list, a feature not implemented in `tags'.
3753 '-
3754 t))
3758 prompt))
3764 spec)))))
3766 \f
3767 ;; Search tag functions which are aware of Erlang modules. The tactic
3768 ;; is to store new search functions into the local variables of the
3769 ;; TAGS buffers. The variables are restored directly after the
3770 ;; search. The situation is complicated by the fact that new TAGS
3771 ;; files can be loaded during the search.
3772 ;;
3773 ;; This code is Emacs 19 `etags' specific.
3776 "Install our own tag search functions."
3777 ;; Make sure our functions are installed in TAGS files loaded
3778 ;; into Emacs while searching.
3779 ;; ?? tags-table-format-hooks isn't in Emacs 21 or XEmacs etags.
3784 erlang-tags-orig-format-hooks))
3786 ;; Install our functions in the TAGS files already resident.
3799 "Install our tag search functions in current buffer."
3801 ()
3802 ;; Mark this buffer as "installed" and record.
3807 ;; Save the original values.
3817 ;; Install our own functions.
3829 "Remove our own tags search functions."
3831 'tags-table-format-hooks
3832 erlang-tags-orig-format-hooks)
3833 ;; Remove our functions from the TAGS files. (Note that
3834 ;; `tags-table-computed-list' need not be the same list as when
3835 ;; the search was started.)
3847 "Remove our tag search functions from current buffer."
3849 ()
3858 'find-tag-regexp-search-function
3859 erlang-tags-orig-regexp-search-function)))
3863 "Install our functions in all loaded TAGS files.
3865 This function is added to `tags-table-format-hooks' when searching
3866 for a tag on the form `module:tag'."
3868 nil
3870 t))
3874 "Forward search function, aware of Erlang module prefix."
3877 ;; Avoid unintended recursion.
3884 "Forward regexp search function, aware of Erlang module prefix."
3891 tag bound noerror count)))
3894 ;; t if point is at a tag line that matches TAG, containing
3895 ;; module information. Assumes that all other order functions
3896 ;; are stored in `erlang-tags-orig-[regex]-tag-order'.
3915 erlang-tag-match-module-regexp-p)))
3923 \f
3924 ;;; Tags completion, Emacs 19 `etags' specific.
3925 ;;;
3926 ;;; The basic idea is to create a second completion table `erlang-tags-
3927 ;;; completion-table' containing all normal tags plus tags on the form
3928 ;;; `module:tag'.
3932 "Perform tags completion on the text around point.
3933 Completes to the set of names listed in the current tags table.
3935 Should the Erlang tags system be installed this command knows
3936 about Erlang modules."
3957 ;; Based on `tags-complete-tag', but this one uses
3958 ;; `erlang-tags-completion-table' instead of `tags-completion-table'.
3959 ;;
3960 ;; This is the entry-point called by system function `completing-read'.
3963 ;; If we need to ask for the tag table, allow that.
3971 ;; `tags-completion-table' calls itself recursively, make it
3972 ;; call our own wedge instead. Note that the recursive call
3973 ;; is very rare; it only occurs when a tags-file contains
3974 ;; `include'-statements.
3976 "Build completion table. Tags on the form `tag' or `module:tag'."
3984 erlang-tags-orig-completion-table)))
3997 ;; Based on `etags-tags-completion-table'. The difference is that we
3998 ;; add three symbols to the vector, the tag, module: and module:tag.
3999 ;; The module is extracted from the file name of a tag. (This one
4000 ;; only works if we are looking at an `etags' file. However, this is
4001 ;; the only format supported by Emacs, so far.)
4007 ;; This monster regexp matches an etags tag line.
4008 ;; \1 is the string to match;
4009 ;; \2 is not interesting;
4010 ;; \3 is the guessed tag name; XXX guess should be better eg DEFUN
4011 ;; \4 is not interesting;
4012 ;; \5 is the explicitly-specified tag name.
4013 ;; \6 is the line to start searching at;
4014 ;; \7 is the char to start searching at.
4023 "\
4027 nil t))
4029 ;; There is an explicit tag name.
4031 ;; No explicit tag name. Best guess.
4039 ;; Only the first one will be stored in the table.
4041 table))
4042 \f
4043 ;;;
4044 ;;; Prepare for other methods to run an Erlang slave process.
4045 ;;;
4048 "Command to execute start a new Erlang shell.
4050 Change this variable to use your favorite
4054 "Command to execute to display Erlang shell.
4056 Change this variable to use your favorite
4060 "Command to execute to compile current buffer.
4062 Change this variable to use your favorite
4066 "Command to execute to view last compilation.
4068 Change this variable to use your favorite
4072 "Command to execute to go to the next error.
4074 Change this variable to use your favorite Erlang compilation
4078 ;;;###autoload
4080 "Start a new Erlang shell.
4082 The variable `erlang-shell-function' decides which method to use,
4083 default is to start a new Erlang host. It is possible that, in the
4084 future, a new shell on an already running host will be started."
4089 ;;;###autoload (autoload 'run-erlang "erlang" "Start a new Erlang shell." t)
4091 ;; It is customary for Emacs packages to supply a function on this
4092 ;; form, even though it violates the `erlang-*' name convention.
4097 "Display an Erlang shell, or start a new."
4102 ;;;###autoload
4104 "Compile Erlang module in current buffer."
4110 "Display compilation output."
4116 "Display next error message from the latest compilation."
4121 \f
4122 ;;;
4123 ;;; Erlang Shell Mode -- Major mode used for Erlang shells.
4124 ;;;
4126 ;; This mode is designed to be implementation independent,
4127 ;; e.g. it does not assume that we are running an inferior
4128 ;; Erlang, there exists a lot of other possibilities.
4134 ;;(when (boundp 'same-window-buffer-names)
4135 ;; (unless (member "*Python*" same-window-buffer-names)
4136 ;; (push "*Python*" same-window-buffer-names)))
4144 "*User functions to run when an Erlang shell is started.
4146 This hook is used to change the behaviour of Erlang mode. It is
4147 normally used by the user to personalise the programming environment.
4148 When used in a site init file, it could be used to customise Erlang
4149 mode for all users on the system.
4151 The function added to this hook is run every time a new Erlang
4152 shell is started.
4154 See also `erlang-load-hook', a hook which is run once, when Erlang
4155 mode is loaded, and `erlang-mode-hook' which is run every time a new
4164 "Major mode for interacting with an Erlang shell.
4166 We assume that we already are in Comint mode.
4168 The following special commands are available:
4175 nil
4180 ;; This was originally not a marker, but it needs to be, at least
4181 ;; in Emacs 21, and should be backwards-compatible. Otherwise,
4182 ;; would need to test whether compilation-parsing-end is a marker
4183 ;; after requiring `compile'.
4187 ;; Needed when compiling directly from the Erlang shell.
4195 ;; In Emacs 19.30, `add-hook' has got a `local' flag, use it. If
4196 ;; the call fails, just call the normal `add-hook'.
4207 ;; Some older versions of comint don't have an input ring.
4214 ;; At least in Emacs 21, we need to be in `compilation-minor-mode'
4215 ;; for `next-error' to work. We can avoid it clobbering the shell
4216 ;; keys thus.
4222 ;; It would be useful to put keymap properties on the
4223 ;; error lines so that we could use RET and mouse-2
4224 ;; on them directly.
4231 map)))))
4236 "Command bound to `mouse-2' in inferior Erlang buffer.
4237 Selects Comint or Compilation mode command as appropriate."
4247 "Command bound to `RET' in inferior Erlang buffer.
4248 Selects Comint or Compilation mode command as appropriate."
4262 \f
4263 ;;;
4264 ;;; Inferior Erlang -- Run an Erlang shell as a subprocess.
4265 ;;;
4268 "*When nil, `inferior-erlang-display-buffer' use only selected frame.
4272 "The type of Erlang shell to use.
4274 When this variable is set to the atom `oldshell', the old shell is used.
4275 When set to `newshell' the new shell is used. Should the variable be
4276 nil, the default shell is used.
4284 "*The options used when activating the Erlang shell.
4295 "*Number of seconds before `inferior-erlang-wait-prompt' timeouts.
4297 The time specified is waited after every output made by the inferior
4298 Erlang shell. When this variable is t, we assume that we always have
4307 ;;;###autoload
4309 "Run an inferior Erlang.
4311 This is just like running Erlang in a normal shell, except that
4312 an Emacs buffer is used for input and output.
4314 The command line history can be accessed with \\[comint-previous-input] and \\[comint-next-input].
4315 The history is saved between sessions.
4317 Entry to this mode calls the functions in the variables
4318 `comint-mode-hook' and `erlang-shell-mode-hook' with no arguments.
4320 The following commands imitate the usual Unix interrupt and
4321 editing control characters:
4332 inferior-erlang-process-name inferior-erlang-machine
4333 nil opts)))
4341 ;; `rename-buffer' takes only one argument in Emacs 18.
4349 "Switch to an inferior Erlang buffer, possibly starting new process."
4357 "Make the inferior Erlang process visible.
4358 The window is returned.
4360 Should `inferior-erlang-display-buffer-any-frame' be nil the buffer is
4361 displayed in the current frame. Should it be non-nil, and the buffer
4362 already is visible in any other frame, no new window will be created.
4363 Should it be the atom 'raise, the frame containing the window will
4364 be raised.
4366 Should the optional argument SELECT be non-nil, the window is
4367 selected. Should the window be in another frame, that frame is raised.
4369 Note, should the mouse pointer be places outside the raised frame, that
4370 frame will become deselected before the next command."
4375 inferior-erlang-display-buffer-any-frame))
4384 frames-p
4392 win))
4396 "Non-nil when an inferior Erlang is running."
4399 inferior-erlang-buffer
4404 "Return the window containing the inferior Erlang, or nil."
4412 "Wait until the inferior Erlang shell prompt appears."
4414 ()
4425 ()
4429 inferior-erlang-prompt-timeout)
4436 "Send command CMD to the inferior Erlang.
4438 The contents of the current command line (if any) will
4439 be placed at the next prompt.
4441 If optional second argument is non-nil the command is inserted into
4442 the history list.
4444 Return the position after the newly inserted command."
4450 0
4455 ;; Strange things happened if `comint-eol-on-send' is declared
4456 ;; in the `let' expression above, but setq:d here. The
4457 ;; `set-buffer' statement obviously makes the buffer local
4458 ;; instance of `comint-eol-on-send' shadow this one.
4459 ;; I'm considering this a bug in Elisp.
4460 ;;
4461 ;; This was previously cautioned against in the Lisp manual. It
4462 ;; has been sorted out in Emacs 21. -- fx
4466 ;; Adjust all windows whose points are incorrect.
4475 nil t))
4481 "Remove `^H' (delete) and the characters it was supposed to remove."
4497 ;; Basically `comint-strip-ctrl-m', with a few extra checks.
4499 "Strip trailing `^M' characters from the current output group."
4514 "Compile the file in the current buffer.
4516 Should Erlang return `{error, nofile}' it could not load the object
4517 module after completing the compilation. This is due to a bug in the
4518 compile command `c' when using the option `outdir'.
4520 There exists two workarounds for this bug:
4522 1) Place the directory in the Erlang load path.
4524 2) Set the Emacs variable `erlang-compile-use-outdir' to nil.
4525 To do so, place the following line in your `~/.emacs'-file:
4526 (setq erlang-compile-use-outdir nil)"
4535 ;;; (file (file-name-nondirectory (buffer-file-name)))
4537 ;; Hopefully, noone else will ever use these...
4540 end)
4548 "f(%s), {ok, %s} = file:get_cwd(), "
4551 tmpvar2 tmpvar
4552 dir
4553 tmpvar2 noext tmpvar tmpvar tmpvar2))
4554 nil))
4563 ;; `next-error' only accepts buffers with major mode `compilation-mode'
4564 ;; or with the minor mode `compilation-minor-mode' activated.
4565 ;; (To activate the minor mode is out of the question, since it will
4566 ;; ruin the inferior Erlang keymap.)
4567 ;; This is done differently in Emacs 21.
4569 "Just like `next-error'.
4570 Capable of finding error messages in an inferior Erlang buffer."
4574 compilation-last-buffer)))
4592 "Make the inferior Erlang change directory.
4593 The default is to go to the directory of the current buffer."
4604 When called interactively, aligns arrows after function clauses inside
4605 the region.
4607 With a prefix argument, aligns all arrows, not just those in function
4608 clauses.
4610 Example:
4612 sum(L) -> sum(L, 0).
4613 sum([H|T], Sum) -> sum(T, Sum + H);
4614 sum([], Sum) -> Sum.
4616 becomes:
4618 sum(L) -> sum(L, 0).
4619 sum([H|T], Sum) -> sum(T, Sum + H);
4620 sum([], Sum) -> Sum."
4624 ;; the regexp matches function heads. With a prefix, it
4625 ;; matches any arrow.
4630 ;; part of regexp matching directly before the arrow
4632 1
4634 ;; accumulator for positions where arrows are found, ordered
4635 ;; by buffer position (from greatest to smallest)
4637 ;; accumulator for longest distance from start of line to arrow
4639 ;; marker to track the end of the region we're aligning
4642 ;; Pass 1: Find the arrow positions, adjust the whitespace
4643 ;; before each arrow to one space, and find the greatest
4644 ;; indentation level.
4652 ;; Pass 2: Insert extra padding so that all arrow indentation is
4653 ;; equal. This is done last-to-first by buffer position, so that
4654 ;; inserting spaces before one arrow doesn't change the
4655 ;; positions of the next ones.
4661 arrow-positions))))
4664 "Return the column number of the current position in the buffer.
4665 Tab characters are counted by their visual width."
4669 "`add-log-current-defun-function' for Erlang."
4675 ;; Aliases for backward compatibility with older versions of Erlang Mode.
4676 ;;
4677 ;; Unfortuantely, older versions of Emacs doesn't have `defalias' and
4678 ;; `make-obsolete' so we have to define our own `obsolete' function.
4681 "Make the obsolete function SYM refer to the defined function NEWDEF.
4683 Simplified version of a combination `defalias' and `make-obsolete',
4684 it assumes that NEWDEF is loaded."
4705 ;; Fixme: shouldn't redefine `set-visited-file-name' anyhow -- see above.
4714 ;; The end...
4720 ;; Local variables:
4721 ;; coding: iso-8859-1
4722 ;; End:
4724 ;;; erlang.el ends here