;;; lilypond-indent.el --- Auto-indentation for lilypond code
;;;
;;; Heikki Junes <hjunes@cc.hut.fi>
-;;; show-paren-function was taken and then modified from FSF Emacs paren.el
+;;; * redefine Emacs' show-paren-function and XEmacs' paren-highlight
+;;; * match two-char slurs '\( ... \)' and '\[ ... \]' separately.
+;;; * adopt Emacs' f90-comment-region
;;; Chris Jackson <chris@fluffhouse.org.uk>
;;; some code is taken from ESS (Emacs Speaks Statistics) S-mode by A.J.Rossini <rossini@biostat.washington.edu>
;;; Variables for customising indentation style
;;; TODO:
-;;; * fontify emulate show-paren-mode also in XEmacs
-;;; * currently, brackets may need a non-bracket char between ( ( ) )
+;;; * currently, in bracket matching one may need a non-bracket
+;;; chararacter between the bracket characters, like ( ( ) )
+;;; * in syntax-highlighting slurs are not always highlighted the right way
+;;; e.g. opening slurs are found found better in "#( ( ) ( ) )" than
+;;; opening slurs
+;;; * is locality of show-paren-function and paren-highlight possible?
(defcustom LilyPond-indent-level 4
"*Indentation of lilypond statements with respect to containing block.")
Compares with other text in same context.")
(defcustom LilyPond-angle-offset 0
- "*Extra indentation for open angled brackets .
+ "*Extra indentation for open angled brackets.
Compares with other text in same context.")
(defcustom LilyPond-square-offset 0
- "*Extra indentation for open square brackets .
+ "*Extra indentation for open square brackets.
Compares with other text in same context.")
(defcustom LilyPond-scheme-paren-offset 0
- "*Extra indentation for open scheme parens .
+ "*Extra indentation for open scheme parens.
Compares with other text in same context.")
(defcustom LilyPond-close-brace-offset 0
(defcustom LilyPond-fancy-comments t
"*Non-nil means distiguish between %, %%, and %%% for indentation.")
+(defcustom LilyPond-comment-region "%%$"
+ "*String inserted by \\[LilyPond-comment-region]\
+ at start of each line in region.")
+
+(defun LilyPond-comment-region (beg-region end-region)
+ "Comment/uncomment every line in the region.
+Insert LilyPond-comment-region at the beginning of every line in the region
+or, if already present, remove it."
+ (interactive "*r")
+ (let ((end (make-marker)))
+ (set-marker end end-region)
+ (goto-char beg-region)
+ (beginning-of-line)
+ (if (looking-at (regexp-quote LilyPond-comment-region))
+ (delete-region (point) (match-end 0))
+ (insert LilyPond-comment-region))
+ (while (and (zerop (forward-line 1))
+ (< (point) (marker-position end)))
+ (if (looking-at (regexp-quote LilyPond-comment-region))
+ (delete-region (point) (match-end 0))
+ (insert LilyPond-comment-region)))
+ (set-marker end nil)))
(defun LilyPond-calculate-indent ()
"Return appropriate indentation for current line as lilypond code.
(let ((indent-point (point))
(case-fold-search nil)
state)
- (setq containing-sexp (save-excursion (LilyPond-beginning-of-containing-sexp)))
+ (setq containing-sexp (save-excursion (LilyPond-scan-containing-sexp)))
(beginning-of-defun)
(while (< (point) indent-point)
(setq state (parse-partial-sexp (point) indent-point 0)))
(current-indentation)))))))))
-
(defun LilyPond-indent-line ()
"Indent current line as lilypond code.
Return the amount the indentation changed by."
"
;;; An user does not call this function directly, or by a key sequence.
;; (interactive)
- (let ( (level (if (/= dir 1) 1 -1))
+ (let ( (level (if (not (eq dir 1)) 1 -1))
(regexp-alist LilyPond-parens-regexp-alist)
(oldpos (point))
- (assoc-bracket-type (if (/= dir 1) bracket-type (LilyPond-matching-paren bracket-type))))
+ (assoc-bracket-type (if (not (eq dir 1)) bracket-type (LilyPond-matching-paren bracket-type))))
+
(if (LilyPond-inside-scheme-p)
(setq paren-regexp "(\\|)")
(if slur-paren-p
(setq paren-regexp (concat (car paren-regexp) "\\|" (cdr paren-regexp))))
(setq paren-regexp (concat (mapconcat 'car (mapcar 'cdr regexp-alist) "\\|") "\\|"
(mapconcat 'cdr (mapcar 'cdr regexp-alist) "\\|")))))
+ ;; match concurrent one-char opening and closing slurs
(if (and (eq dir 1)
- (memq (char-after oldpos) '(?[ ?{)))
- (forward-char 1))
- (while (and (if (/= dir 1)
+ (not (sequencep bracket-type))
+ (eq (char-syntax (char-after oldpos)) ?\()
+ (not (eq (char-after oldpos) ?<)))
+ ;; anyway do not count open slur, since already level = -1
+ (progn (forward-char 1)
+ (if (eq (following-char)
+ (LilyPond-matching-paren (char-after oldpos)))
+ ;; matching char found, go after it and set level = 0
+ (progn (forward-char 1)
+ (setq level 0)))))
+ ;; browse the code until matching slur is found, or report mismatch
+ (while (and (if (not (eq dir 1))
(> level 0)
(< level 0))
- (if (/= dir 1)
+ ;; dir tells whether to search backward or forward
+ (if (not (eq dir 1))
(re-search-backward paren-regexp nil t)
(re-search-forward paren-regexp nil t))
+ ;; note: in case of two-char bracket only latter is compared
(setq match (char-before (match-end 0))))
;;; (message "%d" level) (sit-for 0 300)
- (if (not (save-excursion (goto-char (match-end 0))
+ (if (not (save-excursion (goto-char (match-end 0))
+ ;; skip over strings and comments
(LilyPond-inside-string-or-comment-p)))
(if (memq match '(?} ?> ?] ?\)))
+ ;; count closing brackets
(progn (setq level (1+ level))
- ;; single '<' was not matched .. need to correct
- (if (and (eq dir 1) (eq (char-after (match-end 0)) ?>))
+ ;; slurs may be close to each other, e.g.,
+ ;; a single '>' was not matched .. need to be corrected
+ (if (and (eq dir 1) (eq (char-after (match-end 0)) match))
(if (/= level 0)
(progn
(setq level (1+ level))
(forward-char 1))))
;;; (message "%d %c" level match) (sit-for 0 300)
+ ;; hmm..
(if (and (= match ?>)
(looking-at ".\\s-+>\\|\\({\\|}\\|<\\|>\\|(\\|)\\|[][]\\)>"))
(forward-char 1)))
+ ;; count opening brackets
(progn (setq level (1- level))
;;; (message "%d %c" level match) (sit-for 0 300)
+ ;; hmm..
(if (and (= match ?<)
(looking-at ".\\s-+<\\|\\({\\|}\\|<\\|>\\|(\\|)\\|[][]\\)<"))
(forward-char 1))))))
;; jump to the matching slur
- (if (/= dir 1)
+ (if (not (eq dir 1))
(progn
(if (sequencep bracket-type)
+ ;; match the latter char in two-char brackets
(if (looking-at "..[][)(]") (forward-char 1)))
- (if (looking-at ".[][><)(]") (forward-char 1)))
+ ;; if the following char is not already a slur
+ (if (and (not (looking-at "[)(]"))
+ ;; match the slur which follows
+ (looking-at ".[][><)(]")) (forward-char 1)))
(backward-char 1))
(if (= level 0)
(point)
`lilypond-font-lock.el', all brackets are punctuation characters."
;;; An user does not call this function directly, or by a key sequence.
;; (interactive)
- (let ( (dir (if (eq dir 1) 1 -1))
- (oldpos (point))
+ (let ( (oldpos (point))
(level 0)
(mismatch) )
- ;; Test if a ligature \] or expressional slur \) was encountered
(if (not (or (equal this-command 'LilyPond-electric-close-paren)
(eq dir 1)))
(goto-char (setq oldpos (- oldpos 1))))
+ ;; Test if a ligature \] or expressional slur \) was encountered
(setq bracket-type (char-after (point)))
(setq char-before-bracket-type nil)
(if (memq bracket-type '(?] ?\) ?[ ?\())
(if (not (equal this-command 'LilyPond-electric-close-paren))
(goto-char (setq oldpos (+ oldpos 1)))
(goto-char oldpos))
- (if (/= dir 1)
+ (if (not (eq dir 1))
blinkpos
(+ blinkpos 1))))
(interactive)
(let ((oldpos (point)))
(self-insert-command 1)
- (if (and blink-matching-paren
- (not (LilyPond-inside-string-or-comment-p))
- (save-excursion (re-search-backward
- (concat (mapconcat 'cdr (mapcar 'cdr LilyPond-parens-regexp-alist) "\\|") "\\|)") nil t)
- (eq oldpos (1- (match-end 0)))))
- (progn (backward-char 1)
- (LilyPond-blink-matching-paren)
- (forward-char 1)))))
-
+ ;; Refontify buffer if a block-comment-ender '%}' is inserted
+ (if (and (eq (char-before (point)) ?})
+ (eq (char-before (- (point) 1)) ?%))
+ (font-lock-fontify-buffer)
+ ;; Match paren if the cursor is not inside string or comment.
+ (if (and blink-matching-paren
+ (not (LilyPond-inside-string-or-comment-p))
+ (save-excursion (re-search-backward
+ (concat (mapconcat 'cdr (mapcar 'cdr LilyPond-parens-regexp-alist) "\\|") "\\|)") nil t)
+ (eq oldpos (1- (match-end 0)))))
+ (progn (backward-char 1)
+ (LilyPond-blink-matching-paren)
+ (forward-char 1))))))
+
+(defun LilyPond-scan-sexps (pos dir)
+ "This function is redefined to be used in Emacs' show-paren-function and
+in XEmacs' paren-highlight."
+ (LilyPond-blink-matching-paren dir))
+
+;;; REDEFINITIONS: in future make show-paren-mode and paren-highlight local?
+
+;;; From Emacs' paren.el, with minimal changes (see "LilyPond"-lines)
;; Find the place to show, if there is one,
;; and show it until input arrives.
-(defun LilyPond-show-paren-function ()
+; (defun show-paren-function ()
+
+
+;; don't redefine emacs functions. It breaks other modes.
+
+(defun LilyPond-show-paren-function () ; make show-paren-function local ??
(if show-paren-mode
- (let (pos (dir nil) mismatch face (oldpos (point)))
- (cond ((memq (preceding-char) '(?\) ?\] ?} ?>))
+ (let (pos dir mismatch face (oldpos (point)))
+ (cond ((eq (char-syntax (preceding-char)) ?\))
(setq dir -1))
- ((memq (following-char) '(?\( ?\[ ?{ ?<))
+ ((eq (char-syntax (following-char)) ?\()
(setq dir 1)))
;;
;; Find the other end of the sexp.
- ;;
- ;; try first only one direction
- (when (and dir;(= dir -1)
+ (when (and dir
(not (LilyPond-inside-string-or-comment-p)))
(save-excursion
(save-restriction
;; Scan across one sexp within that range.
;; Errors or nil mean there is a mismatch.
(condition-case ()
- (setq pos (LilyPond-blink-matching-paren dir))
+ (setq pos (LilyPond-scan-sexps (point) dir))
(error (setq pos t mismatch t)))
;; If found a "matching" paren, see if it is the right
;; kind of paren to match the one we started at.
(when (integerp pos)
(let ((beg (min pos oldpos)) (end (max pos oldpos)))
- (when (/= (char-after beg) ?\$)
+ (when (/= (char-syntax (char-after beg)) ?\$)
(setq mismatch
(not (eq (char-before end)
;; This can give nil.
- (LilyPond-matching-paren (char-after beg)))))))))))
+ (matching-paren (char-after beg)))))))))))
;;
;; Highlight the other end of the sexp, or unhighlight if none.
(if (not pos)
(and show-paren-overlay-1
(delete-overlay show-paren-overlay-1))))
-;; Comment the following line to disable show-paren-function
-;; Currently, works only in Emacs, should tune for XEmacs
-(if (not (string-match "XEmacs\\|Lucid" emacs-version))
- (defun show-paren-function () (LilyPond-show-paren-function))
- )
+;;; From XEmacs' paren.el, with minimal changes (see "LilyPond"-lines)
+;; Find the place to show, if there is one,
+;; and show it until input arrives.
+(if (string-match "XEmacs\\|Lucid" emacs-version)
+ (paren-set-mode 'paren)) ; works if this is set here (, right place?)
+;(defun paren-highlight ()
+(defun LilyPond-paren-highlight () ; make paren-highlight local ??
+ "This highlights matching parentheses.
+
+See the variables:
+ paren-message-offscreen use modeline when matching paren is offscreen?
+ paren-ding-unmatched make noise when passing over mismatched parens?
+ paren-mode 'blink-paren, 'paren, or 'sexp
+ blink-matching-paren-distance maximum distance to search for parens.
+
+and the following faces:
+ paren-match, paren-mismatch, paren-blink-off"
+
+ ;; I suppose I could check here to see if a keyboard macro is executing,
+ ;; but I did a quick empirical check and couldn't tell that there was any
+ ;; difference in performance
+
+ (let ((oldpos (point))
+ (pface nil) ; face for paren...nil kills the overlay
+ (dir (and paren-mode
+ (not (input-pending-p))
+ (not executing-kbd-macro)
+ (cond ((eq (char-syntax (preceding-char)) ?\))
+ -1)
+ ((eq (char-syntax (following-char)) ?\()
+ 1))))
+ pos mismatch)
+
+ (save-excursion
+ (if (or (not dir)
+ (LilyPond-inside-string-or-comment-p)
+ (not (save-restriction
+ ;; Determine the range within which to look for a match.
+ (if blink-matching-paren-distance
+ (narrow-to-region
+ (max (point-min)
+ (- (point) blink-matching-paren-distance))
+ (min (point-max)
+ (+ (point) blink-matching-paren-distance))))
+
+ ;; Scan across one sexp within that range.
+ (condition-case nil
+ (setq pos (LilyPond-scan-sexps (point) dir))
+ ;; NOTE - if blink-matching-paren-distance is set,
+ ;; then we can have spurious unmatched parens.
+ (error (paren-maybe-ding)
+ nil)))))
+
+ ;; do nothing if we didn't find a matching paren...
+ nil
+
+ ;; See if the "matching" paren is the right kind of paren
+ ;; to match the one we started at.
+ (let ((beg (min pos oldpos)) (end (max pos oldpos)))
+ (setq mismatch
+ (and (/= (char-syntax (char-after beg)) ?\\)
+ (/= (char-syntax (char-after beg)) ?\$)
+ ;; XEmacs change
+ (matching-paren (char-after beg))
+ (/= (char-after (1- end))
+ (matching-paren (char-after beg)))))
+ (if (eq paren-mode 'sexp)
+ (setq paren-extent (make-extent beg end))))
+ (and mismatch
+ (paren-maybe-ding))
+ (setq pface (if mismatch
+ 'paren-mismatch
+ 'paren-match))
+ (and (memq paren-mode '(blink-paren paren))
+ (setq paren-extent (make-extent (- pos dir) pos)))
+
+ (if (and paren-message-offscreen
+ (eq dir -1)
+ (not (current-message))
+ (not (window-minibuffer-p (selected-window)))
+ (not (pos-visible-in-window-safe pos)))
+ (paren-describe-match pos mismatch))
+
+ ;; put the right face on the extent
+ (cond (pface
+ (set-extent-face paren-extent pface)
+ (set-extent-priority paren-extent 100) ; want this to be high
+ (and (eq paren-mode 'blink-paren)
+ (setq paren-blink-on-face pface
+ paren-n-blinks 0
+ paren-timeout-id
+ (and paren-blink-interval
+ (add-timeout paren-blink-interval
+ 'paren-blink-timeout
+ nil
+ paren-blink-interval))))))
+ ))))
projects / lilypond.git / blobdiff