| blob | a8313ff6163032e2714867c3f70d2e159e1e4b1b |
1 ;;; lilypond-indent.el --- Auto-indentation for lilypond code
2 ;;;
3 ;;; Heikki Junes <hjunes@cc.hut.fi>
4 ;;; * introduce Lilypond-show-paren-function for Emacs and
5 ;;; Lilypond-paren-highlight for XEmacs
6 ;;; * match two-char slurs '\( ... \)' and '\[ ... \]' separately.
7 ;;; * adopt Emacs' f90-comment-region
9 ;;; Chris Jackson <chris@fluffhouse.org.uk>
10 ;;; some code is taken from ESS (Emacs Speaks Statistics) S-mode by A.J.Rossini <rossini@biostat.washington.edu>
12 ;;; Variables for customising indentation style
14 ;;; TODO:
15 ;;; * currently, in bracket matching one may need a non-bracket
16 ;;; chararacter between the bracket characters, like ( ( ) )
17 ;;; * in syntax-highlighting slurs are not always highlighted the right way
18 ;;; e.g. opening slurs are found found better in "#( ( ) ( ) )" than
19 ;;; opening slurs
20 ;;; * Mouse double-clicks should use LilyPond-scan-sexps for slur matching.
26 "*Extra indentation for open braces.
30 "*Extra indentation for open angled brackets.
34 "*Extra indentation for open square brackets.
38 "*Extra indentation for open scheme parens.
61 "Comment/uncomment every line in the region.
62 Insert LilyPond-comment-region at the beginning of every line in the region
63 or, if already present, remove it."
80 "Return appropriate indentation for current line as lilypond code.
81 In usual case returns an integer: the column to indent to.
82 Returns nil if line starts inside a string"
87 state)
92 ;; (setq containing-sexp (car (cdr state))) is the traditional way for languages
93 ;; with simpler parenthesis delimiters
95 ;; point is in the middle of a string
96 nil)
98 ;; point is in the middle of a block comment
101 ;; Line is at top level - no indent
105 ;; Find previous non-comment character.
108 ;; Now we get the answer.
109 ;; Position following last unclosed open.
112 ;; Is line first statement after an open brace or bracket?
113 ;; If no, find that first statement and indent like it.
116 ;; Skip over comments following open brace.
130 ;; The first following code counts
131 ;; if it is before the line we want to indent.
134 ;; If no previous statement,
135 ;; indent it relative to line brace is on.
136 ;; For open brace in column zero, don't let statement
137 ;; start there too. If LilyPond-indent-level is zero, use
138 ;; LilyPond-brace-offset instead
141 LilyPond-brace-offset)
143 LilyPond-angle-offset)
145 LilyPond-square-offset)
147 LilyPond-scheme-paren-offset)
150 LilyPond-indent-level)
157 "Indent current line as lilypond code.
158 Return the amount the indentation changed by."
160 beg shift-amt
194 ))))
202 ;; If initial point was within line's indentation,
203 ;; position after the indentation.
204 ;; Else stay at same point in text.
207 shift-amt))
211 "Return non-nil if point is inside a line or block comment"
217 ;; point is in the middle of a block comment
224 lastopen
227 ))
231 "Test if point is inside a string or a comment"
241 ;; point is in the middle of a string
242 t )
244 ;; point is in the middle of a block comment
245 t )
247 nil)))))
251 "Move point back to closest non-whitespace character not part of a block comment"
263 "Move point back to the closest non-whitespace character not part of a line comment.
264 Argument LIM limit."
278 "Move point back to closest non-whitespace character not part of a comment"
284 "Return the indentation amount for line inside a block comment."
300 ;; Key: Type of bracket (character).
301 ;; Value: Pair of regexps representing the corresponding open and close bracket
302 ;; () are treated specially (need to indent in Scheme but not in music)
306 ;; a b c->, a b c^> and a b c_> are not close-angle-brackets, they're accents
307 ;; but a b c^-> and a b c^^> are close brackets with tenuto/marcato before them
308 ;; also \> and \< are hairpins
309 ;; duh .. a single '>', as in chords '<< ... >>', was not matched here
311 ;; ligatures '\[ ... \]' are skipped in the following expression
315 ))
325 ))
329 "Returns the open corresponding to the close specified by bracket-type, or vice versa"
334 nil))
338 "Move point to the beginning of the deepest parenthesis pair enclosing point.
340 If the optional argument bracket-type, a character representing a
341 close bracket such as ) or }, is specified, then the parenthesis pairs
342 searched are limited to this type.
344 If the optional argument slur-paren-p is non-nil, then slur
345 parentheses () are considered as matching pairs. Otherwise Scheme
346 parentheses are considered to be matching pairs, but slurs are not.
347 slur-paren-p defaults to nil.
348 "
349 ;;; An user does not call this function directly, or by a key sequence.
350 ;; (interactive)
359 ;; expressional slurs '\( ... \)' are not taken into account
360 (setq regexp-alist (cons '( ?\) . ("\\([^\\]\\([\\][\\]\\)*\\|^\\)(" . "\\([^\\]\\([\\][\\]\\)*\\|^\\))")) regexp-alist)))
366 ;; match concurrent one-char opening and closing slurs
371 ;; anyway do not count open slur, since already level = -1
375 ;; matching char found, go after it and set level = 0
378 ;; browse the code until matching slur is found, or report mismatch
382 ;; dir tells whether to search backward or forward
386 ;; note: in case of two-char bracket only latter is compared
388 ;;; (message "%d" level) (sit-for 0 300)
390 ;; skip over strings and comments
393 ;; count closing brackets
395 ;; slurs may be close to each other, e.g.,
396 ;; a single '>' was not matched .. need to be corrected
402 ;;; (message "%d %c" level match) (sit-for 0 300)
403 ;; hmm..
407 ;; count opening brackets
409 ;;; (message "%d %c" level match) (sit-for 0 300)
410 ;; hmm..
414 ;; jump to the matching slur
418 ;; match the latter char in two-char brackets
420 ;; if the following char is not already a slur
422 ;; match the slur which follows
428 nil))))
432 "Tests if point is inside embedded Scheme code"
433 ;;; An user does not call this function directly, or by a key sequence.
434 ;; (interactive)
455 t
456 nil))))
459 ;;; Largely taken from the 'blink-matching-open' in lisp/simple.el in
460 ;;; the Emacs distribution.
463 "Move cursor momentarily to the beginning of the sexp before
464 point. In lilypond files this is used for closing ), ], } and >, whereas the
465 builtin 'blink-matching-open' is not used. In syntax table, see
466 `lilypond-font-lock.el', all brackets are punctuation characters."
467 ;;; An user does not call this function directly, or by a key sequence.
468 ;; (interactive)
475 ;; Test if a ligature \] or expressional slur \) was encountered
491 ;; < { need to be mutually balanced and nested, so search backwards for both of these bracket types
493 ;; whereas ( ) slurs within music don't, so only need to search for ( )
494 ;; use same mechanism for [ ] slurs
509 "Matches %s"
510 ;; Show what precedes the open in its line, if anything.
516 ;; Show what follows the open in its line, if anything.
523 ;; Otherwise show the previous nonblank line,
524 ;; if there is one.
536 ;; Replace the newline and other whitespace with `...'.
537 "..."
539 ;; There is nothing to show except the char itself.
545 blinkpos
550 "Blink on the matching open paren when a >, ), } or ] is inserted"
554 ;; Refontify buffer if a block-comment-ender '%}' is inserted
558 ;; Match paren if the cursor is not inside string or comment.
569 "This function is redefined to be used in Emacs' show-paren-function and
570 in XEmacs' paren-highlight."