| blob | bc04ed5a387dba3db8fb44c9d11f6aa3718db04c |
1 ;;; lilypond-indent.el --- Auto-indentation for lilypond code
2 ;;;
3 ;;; Heikki Junes <hjunes@cc.hut.fi>
4 ;;; * ond-char paren matching is handled by context dependent syntax tables
5 ;;; * match two-char slurs '\( ... \)' and '\[ ... \]' separately.
6 ;;; * adopt Emacs' f90-comment-region
8 ;;; Chris Jackson <chris@fluffhouse.org.uk>
9 ;;; some code is taken from ESS (Emacs Speaks Statistics) S-mode by A.J.Rossini <rossini@biostat.washington.edu>
11 ;;; Variables for customising indentation style
13 ;;; TODO:
14 ;;; * currently, in bracket matching one may need a non-bracket
15 ;;; chararacter between the bracket characters, like ( ( ) )
18 "*Indentation of lilypond statements with respect to containing block."
23 "*Extra indentation for open braces.
24 Compares with other text in same context."
29 "*Extra indentation for open angled brackets.
30 Compares with other text in same context."
35 "*Extra indentation for open square brackets.
36 Compares with other text in same context."
41 "*Extra indentation for open scheme parens.
42 Compares with other text in same context."
47 "*Extra indentation for closing braces."
52 "*Extra indentation for closing angle brackets."
57 "*Extra indentation for closing square brackets."
62 "*Extra indentation for closing scheme parens."
67 "*Non-nil means distiguish between %, %%, and %%% for indentation."
73 at start of each line in region."
78 "Comment/uncomment every line in the region.
79 Insert LilyPond-comment-region at the beginning of every line in the region
80 or, if already present, remove it."
97 "Return appropriate indentation for current line as lilypond code.
98 In usual case returns an integer: the column to indent to.
99 Returns nil if line starts inside a string"
104 state)
109 ;; (setq containing-sexp (car (cdr state))) is the traditional way for languages
110 ;; with simpler parenthesis delimiters
112 ;; point is in the middle of a string
113 nil)
115 ;; point is in the middle of a block comment
118 ;; Line is at top level - no indent
122 ;; Find previous non-comment character.
125 ;; Now we get the answer.
126 ;; Position following last unclosed open.
129 ;; Is line first statement after an open brace or bracket?
130 ;; If no, find that first statement and indent like it.
133 ;; Skip over comments following open brace.
147 ;; The first following code counts
148 ;; if it is before the line we want to indent.
151 ;; If no previous statement,
152 ;; indent it relative to line brace is on.
153 ;; For open brace in column zero, don't let statement
154 ;; start there too. If LilyPond-indent-level is zero, use
155 ;; LilyPond-brace-offset instead
158 LilyPond-brace-offset)
160 LilyPond-angle-offset)
162 LilyPond-square-offset)
164 LilyPond-scheme-paren-offset)
167 LilyPond-indent-level)
174 "Indent current line as lilypond code.
175 Return the amount the indentation changed by."
177 beg shift-amt
211 ))))
219 ;; If initial point was within line's indentation,
220 ;; position after the indentation.
221 ;; Else stay at same point in text.
224 shift-amt))
228 "Return non-nil if point is inside a line or block comment"
234 ;; point is in the middle of a block comment
241 lastopen
244 ))
248 "Test if point is inside a string or a comment"
258 ;; point is in the middle of a string
259 t )
261 ;; point is in the middle of a block comment
262 t )
264 nil)))))
268 "Move point back to closest non-whitespace character not part of a block comment"
280 "Move point back to the closest non-whitespace character not part of a line comment.
281 Argument LIM limit."
295 "Move point back to closest non-whitespace character not part of a comment"
301 "Return the indentation amount for line inside a block comment."
317 ;; Key: Type of bracket (character).
318 ;; Value: Pair of regexps representing the corresponding open and close bracket
319 ;; () are treated specially (need to indent in Scheme but not in music)
323 ;; a b c->, a b c^> and a b c_> are not close-angle-brackets, they're accents
324 ;; but a b c^-> and a b c^^> are close brackets with tenuto/marcato before them
325 ;; also \> and \< are hairpins
326 ;; duh .. a single '>', as in chords '<< ... >>', was not matched here
328 ;; ligatures '\[ ... \]' are skipped in the following expression
332 ))
342 ))
346 "Returns the open corresponding to the close specified by bracket-type, or vice versa"
351 nil))
355 "Move point to the beginning of the deepest parenthesis pair enclosing point.
357 If the optional argument bracket-type, a character representing a
358 close bracket such as ) or }, is specified, then the parenthesis pairs
359 searched are limited to this type.
361 If the optional argument slur-paren-p is non-nil, then slur
362 parentheses () are considered as matching pairs. Otherwise Scheme
363 parentheses are considered to be matching pairs, but slurs are not.
364 slur-paren-p defaults to nil.
365 "
366 ;;; An user does not call this function directly, or by a key sequence.
367 ;; (interactive)
376 ;; expressional slurs '\( ... \)' are not taken into account
377 (setq regexp-alist (cons '( ?\) . ("\\([^\\]\\([\\][\\]\\)*\\|^\\)(" . "\\([^\\]\\([\\][\\]\\)*\\|^\\))")) regexp-alist)))
383 ;; match concurrent one-char opening and closing slurs
388 ;; anyway do not count open slur, since already level = -1
392 ;; matching char found, go after it and set level = 0
395 ;; browse the code until matching slur is found, or report mismatch
399 ;; dir tells whether to search backward or forward
403 ;; note: in case of two-char bracket only latter is compared
405 ;;; (message "%d" level) (sit-for 0 300)
407 ;; skip over strings and comments
410 ;; count closing brackets
412 ;; slurs may be close to each other, e.g.,
413 ;; a single '>' was not matched .. need to be corrected
419 ;;; (message "%d %c" level match) (sit-for 0 300)
420 ;; hmm..
424 ;; count opening brackets
426 ;;; (message "%d %c" level match) (sit-for 0 300)
427 ;; hmm..
431 ;; jump to the matching slur
435 ;; match the latter char in two-char brackets
437 ;; if the following char is not already a slur
439 ;; match the slur which follows
445 nil))))
449 "Tests if point is inside embedded Scheme code"
450 ;;; An user does not call this function directly, or by a key sequence.
451 ;; (interactive)
472 t
473 nil))))
476 ;;; Largely taken from the 'blink-matching-open' in lisp/simple.el in
477 ;;; the Emacs distribution.
480 "Move cursor momentarily to the beginning of the sexp before
481 point. In lilypond files this is used for closing ), ], } and >, whereas the
482 builtin 'blink-matching-open' is not used. In syntax table, see
483 `lilypond-font-lock.el', all brackets are punctuation characters."
484 ;;; An user does not call this function directly, or by a key sequence.
485 ;; (interactive)
492 ;; Test if a ligature \] or expressional slur \) was encountered
508 ;; < { need to be mutually balanced and nested, so search backwards for both of these bracket types
510 ;; whereas ( ) slurs within music don't, so only need to search for ( )
511 ;; use same mechanism for [ ] slurs
526 "Matches %s"
527 ;; Show what precedes the open in its line, if anything.
533 ;; Show what follows the open in its line, if anything.
540 ;; Otherwise show the previous nonblank line,
541 ;; if there is one.
553 ;; Replace the newline and other whitespace with `...'.
554 "..."
556 ;; There is nothing to show except the char itself.
562 blinkpos
567 "Blink on the matching open paren when a >, ), } or ] is inserted"
571 ;; Refontify buffer if a block-comment-ender '%}' is inserted
575 ;; Match paren if the cursor is not inside string or comment.
586 "This function is redefined to be used in Emacs' show-paren-function and
587 in XEmacs' paren-highlight."