X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lilypond-mode.el;h=e06325f8b730dee7d38e4bc5f4252d04435552d9;hb=7d973dae7d92d5b4374c8702730cea6038f5f6e8;hp=5f570c77fd06d1743d234fc7e5d3828623c45619;hpb=6ccdc33b67af16bed0b445d54c880941bb6c4596;p=lilypond.git diff --git a/lilypond-mode.el b/lilypond-mode.el index 5f570c77fd..e06325f8b7 100644 --- a/lilypond-mode.el +++ b/lilypond-mode.el @@ -2,35 +2,138 @@ ;;; lilypond-mode.el --- Major mode for editing GNU LilyPond music scores ;;; ;;; source file of the GNU LilyPond music typesetter +;;; +;;; (c) 1999--2003 Jan Nieuwenhuizen ;;; -;;; (c) 1999, 2000 Jan Nieuwenhuizen +;;; Changed 2001--2003 Heikki Junes +;;; * Add PS-compilation, PS-viewing and MIDI-play (29th Aug 2001) +;;; * Keyboard shortcuts (12th Sep 2001) +;;; * Inserting tags, inspired on sgml-mode (11th Oct 2001) +;;; * Autocompletion & Info (23rd Nov 2002) +;;; +;;; Changed 2002 Carlos Betancourt +;;; * Added spanish-note-replacements ;;; Inspired on auctex - -(load-library "lilypond-font-lock") +;;; Look lilypond-init.el or Documentation/topdocs/INSTALL.texi +;;; for installing instructions. (require 'easymenu) (require 'compile) -(defconst LilyPond-version "1.3.103" +(defconst LilyPond-version "1.7.24" "`LilyPond-mode' version number.") -(defconst LilyPond-help-address "bug-gnu-music@gnu.org" +(defconst LilyPond-help-address "bug-lilypond@gnu.org" "Address accepting submission of bug reports.") (defvar LilyPond-mode-hook nil "*Hook called by `LilyPond-mode'.") +(defvar LilyPond-region-file-prefix "emacs-lily" + "File prefix for commands on buffer or region.") + +;; FIXME: find ``\score'' in buffers / make settable? +(defun LilyPond-master-file () + ;; duh + (buffer-file-name)) + +(defvar LilyPond-kick-xdvi nil + "If true, no simultaneous xdvi's are started, but reload signal is sent.") + +(defvar LilyPond-command-history nil + "Command history list.") + (defvar LilyPond-regexp-alist '(("\\([a-zA-Z]?:?[^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]" 1 2)) "Regexp used to match LilyPond errors. See `compilation-error-regexp-alist'.") +(defvar LilyPond-imenu nil + "A flag to tell whether LilyPond-imenu is turned on.") +(make-variable-buffer-local 'LilyPond-imenu) + (defcustom LilyPond-include-path ".:/tmp" "* LilyPond include path." :type 'string :group 'LilyPond) +(defun LilyPond-words-filename () + "The file containing LilyPond \keywords \Identifiers and ReservedWords. +Finds file lilypond-words from load-path." + (let ((fn nil) + (lp load-path) + (words-file "lilypond.words")) + (while (and (> (length lp) 0) (not fn)) + (setq fn (concat (car lp) "/" words-file)) + (if (not (file-readable-p fn)) + (progn (setq fn nil) (setq lp (cdr lp))))) + (if (not fn) + (progn (message "Warning: `lilypond.words' not found in `load-path'. See `lilypond-init.el'.") + (sit-for 5 0))) + fn)) + +(defun LilyPond-add-dictionary-word (x) + "Contains all words: \keywords \Identifiers and ReservedWords." + (nconc '(("" . 1)) x)) + +;; creates dictionary if empty +(if (and (eq (length (LilyPond-add-dictionary-word ())) 1) + (not (eq (LilyPond-words-filename) nil))) + (progn + (setq b (find-file-noselect (LilyPond-words-filename) t t)) + (setq m (set-marker (make-marker) 1 (get-buffer b))) + (setq i 1) + (while (> (buffer-size b) (marker-position m)) + (setq i (+ i 1)) + (setq copy (copy-alist (list (eval (symbol-name (read m)))))) + (setcdr copy i) + (LilyPond-add-dictionary-word (list copy))) + (kill-buffer b))) + +(defconst LilyPond-keywords + (let ((wordlist ()) + (co (all-completions "" (LilyPond-add-dictionary-word ())))) + (progn + (while (> (length co) 0) + (if (> (length (car co)) 1) + (if (and (string-equal "\\" (substring (car co) 0 1)) + (string-equal (downcase (car co)) (car co))) + (add-to-list 'wordlist (car co)))) + (setq co (cdr co))) + (if (eq (length wordlist) 0) + (setq wordlist '("\\score"))) ; add \keywords to lilypond.words + wordlist)) + "LilyPond \\keywords") + +(defconst LilyPond-identifiers + (let ((wordlist ()) + (co (all-completions "" (LilyPond-add-dictionary-word ())))) + (progn + (while (> (length co) 0) + (if (> (length (car co)) 1) + (if (and (string-equal "\\" (substring (car co) 0 1)) + (not (string-equal (downcase (car co)) (car co)))) + (add-to-list 'wordlist (car co)))) + (setq co (cdr co))) + (if (eq (length wordlist) 0) + (setq wordlist '("\\voiceOne"))) ; add \Identifiers to lilypond.words + wordlist)) + "LilyPond \\Identifiers") + +(defconst LilyPond-reserved-words + (let ((wordlist ()) + (co (all-completions "" (LilyPond-add-dictionary-word ())))) + (progn + (while (> (length co) 0) + (if (> (length (car co)) 0) + (if (not (string-equal "\\" (substring (car co) 0 1))) + (add-to-list 'wordlist (car co)))) + (setq co (cdr co))) + (if (eq (length wordlist) 0) + (setq wordlist '("Staff"))) ; add ReservedWords to lilypond.words + wordlist)) + "LilyPond ReservedWords") (defun LilyPond-check-files (derived originals extensions) "Check that DERIVED is newer than any of the ORIGINALS. @@ -64,26 +167,67 @@ in LilyPond-include-path." found)) (defun LilyPond-running () - (let ((process (get-process "lilypond"))) - (and process - (eq (process-status process) 'run)))) - -(defun LilyPond-kill-job () - "Kill the currently running LilyPond job." + "Check the currently running LilyPond compiling jobs." + (let ((process-names (list "lilypond" "tex" "2dvi" "2ps" "2midi" + "book" "latex")) + (running nil)) + (while (setq process-name (pop process-names)) + (setq process (get-process process-name)) + (if (and process + (eq (process-status process) 'run)) + (push process-name running))) + running)) ; return the running jobs + +(defun LilyPond-midi-running () + "Check the currently running Midi processes." + (let ((process-names (list "midi" "midiall")) + (running nil)) + (while (setq process-name (pop process-names)) + (setq process (get-process process-name)) + (if (and process + (eq (process-status process) 'run)) + (push process-name running))) + running)) ; return the running jobs + +(defun LilyPond-kill-jobs () + "Kill the currently running LilyPond compiling jobs." (interactive) - ;; What bout TeX, Xdvi? - (quit-process (get-process "lilypond") t)) + (let ((process-names (LilyPond-running)) + (killed nil)) + (while (setq process-name (pop process-names)) + (quit-process (get-process process-name) t) + (push process-name killed)) + killed)) ; return the killed jobs + +(defun LilyPond-kill-midi () + "Kill the currently running midi processes." + (let ((process-names (LilyPond-midi-running)) + (killed nil)) + (while (setq process-name (pop process-names)) + (quit-process (get-process process-name) t) + (push process-name killed)) + killed)) ; return the killed jobs ;; URG, should only run LilyPond-compile for LilyPond ;; not for tex,xdvi (ly2dvi?) (defun LilyPond-compile-file (command name) ;; We maybe should know what we run here (Lily, ly2dvi, tex) ;; and adjust our error-matching regex ? - (compile-internal command "No more errors" name )) + (compile-internal + (if (eq LilyPond-command-current 'LilyPond-command-master) + command + ;; use temporary directory for Commands on Buffer/Region + ;; hm.. the directory is set twice, first to default-dir + (concat "cd " (LilyPond-temp-directory) "; " command)) + "No more errors" name)) ;; do we still need this, now that we're using compile-internal? (defun LilyPond-save-buffer () - (if (buffer-modified-p) (save-buffer))) + "Save buffer and set default command for compiling." + (interactive) + (if (buffer-modified-p) + (progn (save-buffer) + (setq LilyPond-command-default "LilyPond")))) ;;; return (dir base ext) (defun split-file-name (name) @@ -99,7 +243,11 @@ in LilyPond-include-path." ;; Should check whether in command-alist? -(defvar LilyPond-command-default "LilyPond") +(defcustom LilyPond-command-default "LilyPond" + "Default command. Must identify a member of LilyPond-command-alist." + + :group 'LilyPond + :type 'string) ;;;(make-variable-buffer-local 'LilyPond-command-last) (defvar LilyPond-command-current 'LilyPond-command-master) @@ -110,18 +258,117 @@ in LilyPond-include-path." ;; variable instead of quering the user. (defvar LilyPond-command-force nil) +(defcustom LilyPond-xdvi-command "xdvi" + "Command used to display DVI files." + + :group 'LilyPond + :type 'string) + +(defcustom LilyPond-gv-command "gv -watch" + "Command used to display PS files." + + :group 'LilyPond + :type 'string) + +(defcustom LilyPond-midi-command "timidity" + "Command used to play MIDI files." + + :group 'LilyPond + :type 'string) + +(defcustom LilyPond-all-midi-command "timidity -ia" + "Command used to play MIDI files." + + :group 'LilyPond + :type 'string) + +(defun LilyPond-command-current-midi () + "Play midi corresponding to the current document." + (interactive) + (LilyPond-command (LilyPond-command-menu "Midi") 'LilyPond-master-file)) + +(defun LilyPond-command-all-midi () + "Play midi corresponding to the current document." + (interactive) + (LilyPond-command (LilyPond-command-menu "MidiAll") 'LilyPond-master-file)) + +(defun count-rexp (start end rexp) + "Print number of found regular expressions in the region." + (interactive "r") + (save-excursion + (save-restriction + (narrow-to-region start end) + (goto-char (point-min)) + (count-matches rexp)))) + +(defun count-midi-words () + "Check number of midi-scores before the curser." + (if (eq LilyPond-command-current 'LilyPond-command-region) + (count-rexp (mark t) (point) "\\\\midi") + (count-rexp (point-min) (point-max) "\\\\midi"))) + +(defun count-midi-words-backwards () + "Check number of midi-scores before the curser." + (if (eq LilyPond-command-current 'LilyPond-command-region) + (count-rexp (mark t) (point) "\\\\midi") + (count-rexp (point-min) (point) "\\\\midi"))) + +(defun LilyPond-string-current-midi () + "Check the midi file of the following midi-score in the current document." + (let ((fnameprefix (if (eq LilyPond-command-current 'LilyPond-command-master) + (substring (LilyPond-master-file) 0 -3); suppose ".ly" + LilyPond-region-file-prefix)) + (allcount (string-to-number (substring (count-midi-words) 0 -12))) + (count (string-to-number (substring (count-midi-words-backwards) 0 -12)))) + (concat fnameprefix + (if (and (> allcount 1) (> count 0)) ; not first score + (if (eq count allcount) ; last score + (concat "-" (number-to-string (+ count -1))) + (concat "-" (number-to-string count)))) + ".midi"))) + +(defun LilyPond-string-all-midi () + "Return the midi files of the current document in ascending order." + (let ((fnameprefix (if (eq LilyPond-command-current 'LilyPond-command-master) + (substring (LilyPond-master-file) 0 -3); suppose ".ly" + LilyPond-region-file-prefix)) + (allcount (string-to-number (substring (count-midi-words) 0 -12)))) + (concat (if (> allcount 0) ; at least one midi-score + (concat fnameprefix ".midi ")) + (if (> allcount 1) ; more than one midi-score + (concat fnameprefix "-[1-9].midi ")) + (if (> allcount 9) ; etc. + (concat fnameprefix "-[1-9][0-9].midi")) + (if (> allcount 99) ; not first score + (concat fnameprefix "-[1-9][0-9][0-9].midi"))))) ;; This is the major configuration variable. (defcustom LilyPond-command-alist - '( - ("LilyPond" . ("lilypond %s" . "TeX")) + ;; Should expand this to include possible keyboard shortcuts which + ;; could then be mapped to define-key and menu. + `( + ("LilyPond" . ("lilypond %s" . "LaTeX")) ("TeX" . ("tex '\\nonstopmode\\input %t'" . "View")) - + + ("2Dvi" . ("ly2dvi %s" . "View")) + ("2PS" . ("ly2dvi -P %s" . "ViewPS")) + ("2Midi" . ("lilypond -m %s" . "View")) + + ("Book" . ("lilypond-book %x" . "LaTeX")) + ("LaTeX" . ("latex '\\nonstopmode\\input %l'" . "View")) + ;; point-n-click (arg: exits upop USR1) ("SmartView" . ("xdvi %d" . "LilyPond")) - + ;; refreshes when kicked USR1 - ("View" . ("xdvik %d" . "LilyPond")) + ("View" . (,(concat LilyPond-xdvi-command " %d") . "LilyPond")) + ("ViewPS" . (,(concat LilyPond-gv-command " %p") . "LilyPond")) + + ;; The following are refreshed in LilyPond-command: + ;; - current-midi depends on cursor position and + ("Midi" . (,(concat LilyPond-midi-command " " (LilyPond-string-current-midi)) . "LilyPond" )) ; + ;; - all-midi depends on number of midi-score. + ("MidiAll" . (,(concat LilyPond-all-midi-command " " (LilyPond-string-all-midi)) . "LilyPond")) ) "AList of commands to execute on the current document. @@ -133,21 +380,17 @@ success. The expansion is done using the information found in LilyPond-expand-list. " :group 'LilyPond - :type '(repeat (group (string :tag "Name") + :type '(repeat (cons :tag "Command Item" + (string :tag "Key") + (cons :tag "How" (string :tag "Command") - (choice :tag "How" - :value LilyPond-run-command - (function-item LilyPond-run-command) - (function-item LilyPond-run-LilyPond) - (function :tag "Other")) - (boolean :tag "Prompt") - (sexp :format "End\n")))) + (string :tag "Next Key"))))) ;; drop this? -(defcustom LilyPond-file-extensions '(".ly" ".sly" ".fly") - "*File extensions used by manually generated TeX files." +(defcustom LilyPond-file-extension ".ly" + "*File extension used in LilyPond sources." :group 'LilyPond - :type '(repeat (string :format "%v"))) + :type 'string) (defcustom LilyPond-expand-alist @@ -156,20 +399,21 @@ LilyPond-expand-list. ("%t" . ".tex") ("%d" . ".dvi") ("%p" . ".ps") + ("%l" . ".tex") + ("%x" . ".tely") + ("%m" . ".midi") ) "Alist of expansion strings for LilyPond command names." :group 'LilyPond - :type '(repeat (group (string :tag "Key") - (sexp :tag "Expander") - (repeat :inline t - :tag "Arguments" - (sexp :format "%v"))))) + :type '(repeat (cons :tag "Alist item" + (string :tag "Symbol") + (string :tag "Expansion")))) (defcustom LilyPond-command-Show "View" "*The default command to show (view or print) a LilyPond file. -Must be the car of an entry in LilyPond-command-alist." +Must be the car of an entry in `LilyPond-command-alist'." :group 'LilyPond :type 'string) (make-variable-buffer-local 'LilyPond-command-Show) @@ -196,20 +440,26 @@ Must be the car of an entry in LilyPond-command-alist." (defun LilyPond-command-query (name) "Query the user for what LilyPond command to use." - (let* ((default (cond ((if (string-equal name "emacs-lily") + (let* ((default (cond ((if (string-equal name LilyPond-region-file-prefix) (LilyPond-check-files (concat name ".tex") (list name) - LilyPond-file-extensions) - ;; FIXME - (LilyPond-save-buffer) + (list LilyPond-file-extension)) + (if (verify-visited-file-modtime (current-buffer)) + (if (buffer-modified-p) + (if (y-or-n-p "Save buffer before next command? ") + (LilyPond-save-buffer))) + (if (y-or-n-p "The command will be invoked to an already saved buffer. Revert it? ") + (revert-buffer t t))) ;;"LilyPond" LilyPond-command-default)) (t LilyPond-command-default))) + + (completion-ignore-case t) (answer (or LilyPond-command-force (completing-read (concat "Command: (default " default ") ") - LilyPond-command-alist nil t)))) + LilyPond-command-alist nil t nil 'LilyPond-command-history)))) ;; If the answer is "LilyPond" it will not be expanded to "LilyPond" (let ((answer (car-safe (assoc answer LilyPond-command-alist)))) @@ -218,43 +468,82 @@ Must be the car of an entry in LilyPond-command-alist." answer default)))) - -;; FIXME: find ``\score'' in buffers / make settable? -(defun LilyPond-master-file () - ;; duh - (buffer-file-name)) - (defun LilyPond-command-master () "Run command on the current document." (interactive) + (LilyPond-command-select-master) (LilyPond-command (LilyPond-command-query (LilyPond-master-file)) 'LilyPond-master-file)) +(defun LilyPond-command-lilypond () + "Run lilypond for the current document." + (interactive) + (LilyPond-command (LilyPond-command-menu "LilyPond") 'LilyPond-master-file) +) + +(defun LilyPond-command-formatdvi () + "Format the dvi output of the current document." + (interactive) + (LilyPond-command (LilyPond-command-menu "2Dvi") 'LilyPond-master-file) +) + +(defun LilyPond-command-formatps () + "Format the ps output of the current document." + (interactive) + (LilyPond-command (LilyPond-command-menu "2PS") 'LilyPond-master-file) +) + +(defun LilyPond-command-formatmidi () + "Format the midi output of the current document." + (interactive) + (LilyPond-command (LilyPond-command-menu "2Midi") 'LilyPond-master-file) +) + +(defun LilyPond-command-smartview () + "View the dvi output of current document." + (interactive) + (LilyPond-command (LilyPond-command-menu "SmartView") 'LilyPond-master-file) +) + +(defun LilyPond-command-view () + "View the dvi output of current document." + (interactive) + (LilyPond-command (LilyPond-command-menu "View") 'LilyPond-master-file) +) + +(defun LilyPond-command-viewps () + "View the ps output of current document." + (interactive) + (LilyPond-command (LilyPond-command-menu "ViewPS") 'LilyPond-master-file) +) + +;; FIXME, this is broken (defun LilyPond-region-file (begin end) (let ( - ;; (dir "/tmp/") - ;; urg - (dir "./") - (base "emacs-lily") - ;; Hmm - (ext (if (string-match "^[\\]score" (buffer-substring begin end)) - ".ly" - (if (< 50 (abs (- begin end))) - ".fly" - ".sly")))) + ;; (dir "./") + (dir (LilyPond-temp-directory)) + (base LilyPond-region-file-prefix) + (ext LilyPond-file-extension)) (concat dir base ext))) +;;; Commands on Region work if there is an appropriate '\score'. (defun LilyPond-command-region (begin end) "Run LilyPond on the current region." (interactive "r") + (if (or (> begin (point-min)) (< end (point-max))) + (LilyPond-command-select-region)) (write-region begin end (LilyPond-region-file begin end) nil 'nomsg) (LilyPond-command (LilyPond-command-query (LilyPond-region-file begin end)) - '(lambda () (LilyPond-region-file begin end)))) + '(lambda () (LilyPond-region-file begin end))) + ;; Region may deactivate even if buffer was intact, reactivate? + ;; Currently, also deactived regions are used. + ) (defun LilyPond-command-buffer () "Run LilyPond on buffer." (interactive) + (LilyPond-command-select-buffer) (LilyPond-command-region (point-min) (point-max))) (defun LilyPond-command-expand (string file) @@ -276,6 +565,16 @@ Must be the car of an entry in LilyPond-command-alist." file)) string))) +(defun LilyPond-shell-process (name buffer command) + (let ((old (current-buffer))) + (switch-to-buffer-other-window buffer) + ;; If we empty the buffer don't see messages scroll by. + ;; (erase-buffer) + + (start-process-shell-command name buffer command) + (switch-to-buffer-other-window old))) + + (defun LilyPond-command (name file) "Run command NAME on the file you get by calling FILE. @@ -288,27 +587,69 @@ command." (let ((entry (assoc name LilyPond-command-alist))) (if entry (let ((command (LilyPond-command-expand (cadr entry) - (apply file nil)))) - (let* ( - (buffer-xdvi (get-buffer "*view*")) - (process-xdvi (if buffer-xdvi (get-buffer-process buffer-xdvi) nil))) - (if (and process-xdvi - (string-equal name "View")) - ;; Don't open new xdvi window, but force redisplay - ;; We could make this an option. - (signal-process (process-id process-xdvi) 'SIGUSR1) - (progn - (setq LilyPond-command-default name) - (LilyPond-compile-file command name)))))))) + (apply file nil))) + (jobs nil) + (job-string "no jobs")) + (if (member name (list "View" "ViewPS")) + ;; is USR1 a right signal for viewps? + (let ((buffer-xdvi (get-buffer-create (concat "*" name "*")))) + (if LilyPond-kick-xdvi + (let ((process-xdvi (get-buffer-process buffer-xdvi))) + (if process-xdvi + (signal-process (process-id process-xdvi) 'SIGUSR1) + (LilyPond-shell-process name buffer-xdvi command))) + (LilyPond-shell-process name buffer-xdvi command))) + (progn + (if (string-equal name "Midi") + (progn + (setq command (concat LilyPond-midi-command " " (LilyPond-string-current-midi))) + (if (LilyPond-kill-midi) + (setq job-string nil)))) ; either stop or start playing + (if (string-equal name "MidiAll") + (progn + (setq command (concat LilyPond-all-midi-command " " (LilyPond-string-all-midi))) + (LilyPond-kill-midi))) ; stop and start playing + (if (and (member name (list "Midi" "MidiAll")) job-string) + (if (file-newer-than-file-p + (LilyPond-master-file) + (concat (substring (LilyPond-master-file) 0 -3) ".midi")) + (if (y-or-n-p "Midi older than source. Reformat midi?") + (progn + (LilyPond-command-formatmidi) + (while (LilyPond-running) + (message "Starts playing midi once it is built.") + (sit-for 0 100)))))) + (if (member name (list "LilyPond" "TeX" "2Midi" "2PS" "2Dvi" + "Book" "LaTeX")) + (if (setq jobs (LilyPond-running)) + (progn + (setq job-string "Process") ; could also suggest compiling after process has ended + (while jobs + (setq job-string (concat job-string " \"" (pop jobs) "\""))) + (setq job-string (concat job-string " is already running; kill it to proceed ")) + (if (y-or-n-p job-string) + (progn + (setq job-string "no jobs") + (LilyPond-kill-jobs) + (while (LilyPond-running) + (sit-for 0 100))) + (setq job-string nil))))) + + (setq LilyPond-command-default name) + (if (string-equal job-string "no jobs") + (LilyPond-compile-file command name)))))))) -;; XEmacs stuff -;; Sadly we need this for a macro in Emacs 19. -(eval-when-compile - ;; Imenu isn't used in XEmacs, so just ignore load errors. - (condition-case () - (require 'imenu) - (error nil))) +(defun LilyPond-mark-active () + "Check if there is an active mark." + (and transient-mark-mode + (if (string-match "XEmacs\\|Lucid" emacs-version) (mark) mark-active))) +(defun LilyPond-temp-directory () + "Temporary file directory for Commands on Region." + (interactive) + (if (string-match "XEmacs\\|Lucid" emacs-version) + (concat (temp-directory) "/") + temporary-file-directory)) ;;; Keymap @@ -324,14 +665,277 @@ command." (if LilyPond-mode-map () (setq LilyPond-mode-map (make-sparse-keymap)) - (define-key LilyPond-mode-map "\C-c\C-c" 'LilyPond-command-master) + ;; Put keys to Lilypond-command-alist and fetch them from there somehow. + (define-key LilyPond-mode-map "\C-c\C-l" 'LilyPond-command-lilypond) (define-key LilyPond-mode-map "\C-c\C-r" 'LilyPond-command-region) (define-key LilyPond-mode-map "\C-c\C-b" 'LilyPond-command-buffer) - (define-key LilyPond-mode-map "\C-c\C-k" 'LilyPond-kill-job) + (define-key LilyPond-mode-map "\C-c\C-k" 'LilyPond-kill-jobs) + (define-key LilyPond-mode-map "\C-c\C-c" 'LilyPond-command-master) + (define-key LilyPond-mode-map "\C-cm" 'LilyPond-command-formatmidi) + (define-key LilyPond-mode-map "\C-c\C-d" 'LilyPond-command-formatdvi) + (define-key LilyPond-mode-map "\C-c\C-f" 'LilyPond-command-formatps) + (define-key LilyPond-mode-map "\C-c\C-s" 'LilyPond-command-smartview) + (define-key LilyPond-mode-map "\C-c\C-v" 'LilyPond-command-view) + (define-key LilyPond-mode-map "\C-c\C-p" 'LilyPond-command-viewps) + (define-key LilyPond-mode-map [(control c) return] 'LilyPond-command-current-midi) + (define-key LilyPond-mode-map [(control c) (control return)] 'LilyPond-command-all-midi) + (define-key LilyPond-mode-map "\C-x\C-s" 'LilyPond-save-buffer) + (define-key LilyPond-mode-map "\C-cf" 'font-lock-fontify-buffer) + (define-key LilyPond-mode-map "\C-ci" 'LilyPond-quick-note-insert) + (define-key LilyPond-mode-map "\C-cn" 'LilyPond-insert-tag-notes) + (define-key LilyPond-mode-map "\C-cs" 'LilyPond-insert-tag-score) + (define-key LilyPond-mode-map "\C-c;" 'LilyPond-comment-region) + (define-key LilyPond-mode-map ")" 'LilyPond-electric-close-paren) + (define-key LilyPond-mode-map ">" 'LilyPond-electric-close-paren) + (define-key LilyPond-mode-map "}" 'LilyPond-electric-close-paren) + (define-key LilyPond-mode-map "]" 'LilyPond-electric-close-paren) + (define-key LilyPond-mode-map "\C-c\C-x" 'LilyPond-mode-context-set-syntax-table) ; try it + (if (string-match "XEmacs\\|Lucid" emacs-version) + (define-key LilyPond-mode-map [iso-left-tab] 'LilyPond-autocompletion) + (define-key LilyPond-mode-map [iso-lefttab] 'LilyPond-autocompletion)) + (define-key LilyPond-mode-map "\C-c\t" 'LilyPond-info-index-search) ) ;;; Menu Support +(defun LilyPond-quick-note-insert() + "Insert notes with fewer key strokes by using a simple keyboard piano." + (interactive) + (setq dutch-notes + '(("k" "a") ("l" "b") ("a" "c") ("s" "d") + ("d" "e") ("f" "f") ("j" "g") ("r" "r"))) + (setq dutch-note-ends '("eses" "es" "" "is" "isis")) + (setq dutch-note-replacements '("" "")) + (setq finnish-note-replacements + '(("eeses" "eses") ("ees" "es") ("aeses" "asas") ("aes" "as") ("b" "h") + ("beses" "heses") ("bes" "b") ("bis" "his") ("bisis" "hisis"))) + ; add more translations of the note names + (setq spanish-note-replacements + '(("c" "do") ("d" "re") ("e" "mi") ("f" "fa") ("g" "sol") ("a" "la") ("b +" "si") + ("cis" "dos") ("cisis" "doss") ("ces" "dob") ("ceses" "dobb") + ("dis" "res") ("disis" "ress") ("des" "reb") ("deses" "rebb") + ("eis" "mis") ("eisis" "miss") ("ees" "mib") ("eeses" "mibb") + ("fis" "fas") ("fisis" "fass") ("fes" "fab") ("feses" "fabb") + ("gis" "sols") ("gisis" "solss") ("ges" "solb") ("geses" "solbb") + ("ais" "las") ("aisis" "lass") ("aes" "lab") ("aeses" "labb") + ("bis" "sis") ("bisis" "siss") ("bes" "sib") ("beses" "sibb"))) + (setq other-keys "(<~>)}|") + (setq accid 0) (setq octav 0) (setq durat "") (setq dots 0) + + (message "Press h for help.") (sit-for 0 750) + + (setq note-replacements dutch-note-replacements) + (setq xkey 0) (setq xinitpoint (point)) + (< xinitpoint (point)) + (while (not (= xkey 27)) ; esc to quit + (message (format " a[]s[]d f[]j[]k[]l r with %4s%-4s%3s%-4s ie ,' 12345678 . 0 /%sb\\b\\n Esc" + (nth (+ accid 2) dutch-note-ends) + (make-string (abs octav) (if (> octav 0) ?' ?,)) + durat + (if (string= durat "") "" (make-string dots ?.)) + other-keys)) + (setq xkey (read-char-exclusive)) + (setq x (char-to-string xkey)) + (setq note (cdr (assoc x dutch-notes))) + (cond + ((string= x "q") (progn (setq xkey 27))) ; quit + ((= xkey 13) (progn (insert "\n") (LilyPond-indent-line))) ; return + ((or (= xkey 127) ; backspace is recognized as a char only in Emacs + (string= x "b")) ; so, we need to define an another char for XEmacs + (progn (narrow-to-region xinitpoint (point)) + (backward-kill-word 1) + (widen))) + ((and (string< x "9") (string< "0" x)) + (progn (setq durat (int-to-string (expt 2 (- (string-to-int x) 1)))) + (setq dots 0))) + ((string= x " ") (insert " ")) + ((string= x "/") (progn (insert "\\times ") + (message "Insert a number for the denominator (\"x/\")") + (while (not (and (string< x "9") (string< "0" x))) + (setq x (char-to-string (read-char-exclusive)))) + (insert (format "%s/" x)) (setq x "/") + (message "Insert a number for the numerator (\"/y\")") + (while (not (and (string< x "9") (string< "0" x))) + (setq x (char-to-string (read-char-exclusive)))) + (insert (format "%s { " x)))) + ((string= x "0") (progn (setq accid 0) (setq octav 0) + (setq durat "") (setq dots 0))) + ((string= x "i") (setq accid (if (= accid 2) 0 (max (+ accid 1) 1)))) + ((string= x "e") (setq accid (if (= accid -2) 0 (min (+ accid -1) -1)))) + ((string= x "'") (setq octav (if (= octav 4) 0 (max (+ octav 1) 1)))) + ((string= x ",") (setq octav (if (= octav -4) 0 (min (+ octav -1) -1)))) + ((string= x ".") (setq dots (if (= dots 4) 0 (+ dots 1)))) + ((not (null (member x (split-string other-keys "")))) + (insert (format "%s " x))) + ((not (null note)) + (progn + (setq note + (format "%s%s" (car note) (if (string= "r" (car note)) "" + (nth (+ accid 2) dutch-note-ends)))) + (setq notetwo (car (cdr (assoc note note-replacements)))) + (if (not (null notetwo)) (setq note notetwo)) + (insert + (format "%s%s%s%s " + note + (if (string= "r" note) "" + (make-string (abs octav) (if (> octav 0) ?' ?,))) + durat + (if (string= durat "") "" (make-string dots ?.)))) + (setq accid 0) (setq octav 0) (setq durat "") (setq dots 0))) + ((string= x "t") (progn (setq note-replacements dutch-note-replacements) + (message "Selected Dutch notes") + (sit-for 0 750))) + ((string= x "n") (progn (setq note-replacements finnish-note-replacements) + (message "Selected Finnish/Deutsch notes") + (sit-for 0 750))) + ; add more translations of the note names + ((string= x "p") (progn (setq note-replacements spanish-note-replacements) + (message "Selected Spanish notes") + (sit-for 0 750))) + ((string= x "h") + (progn (message "Insert notes with fewer key strokes. For example \"i,5.f\" produces \"fis,32. \".") (sit-for 5 0) + (message "Add also \"a ~ a\"-ties, \"a ( ) b\"-slurs and \"< a b >\"-chords.") (sit-for 5 0) + (message "There are Du(t)ch, Fin(n)ish/Deutsch (hit 'n') and S(p)anish note names.") (sit-for 5 0) + (message "(B)ackspace deletes last note, Ret starts a new indented line and Esc (q)uits.") (sit-for 5 0) + (message "Insert note triplets \"\\times 2/3 { a b } \" by typing \"/23ab}\".") (sit-for 5 0) + (message "This mode is experimental. Use normal mode to add further details.") (sit-for 5 0))) + (t (progn (message "Quick notes mode. Press Esc or q to quit.") (sit-for 0 500))))) + (message "Normal editing mode.")) + +(defun LilyPond-pre-word-search () + "Fetch the alphabetic characters and \\ in front of the cursor." + (let ((pre "") + (prelen 0) + (ch (char-before (- (point) 0)))) + (while (and ch (or (and (>= ch 65) (<= ch 90)) ; not bolp, A-Z + (and (>= ch 97) (<= ch 122)) ; a-z + (= ch 92))) ; \\ + (setq pre (concat (char-to-string ch) pre)) + (setq prelen (+ prelen 1)) + (setq ch (char-before (- (point) prelen)))) + pre)) + +(defun LilyPond-post-word-search () + "Fetch the alphabetic characters behind the cursor." + (let ((post "") + (postlen 0) + (ch (char-after (+ (point) 0)))) + (while (and ch (or (and (>= ch 65) (<= ch 90)) ; not eolp, A-Z + (and (>= ch 97) (<= ch 122)))) ; a-z + (setq post (concat post (char-to-string ch))) + (setq postlen (+ postlen 1)) + (setq ch (char-after (+ (point) postlen)))) + post)) + +(defun LilyPond-autocompletion () + "Show completions in mini-buffer for the given word." + (interactive) + (let ((pre (LilyPond-pre-word-search)) + (post (LilyPond-post-word-search)) + (compsstr "")) + ;; insert try-completion and show all-completions + (if (> (length pre) 0) + (progn + (setq trycomp (try-completion pre (LilyPond-add-dictionary-word ()))) + (if (char-or-string-p trycomp) + (if (string-equal (concat pre post) trycomp) + (goto-char (+ (point) (length post))) + (progn + (delete-region (point) (+ (point) (length post))) + (insert (substring trycomp (length pre) nil)))) + (progn + (delete-region (point) (+ (point) (length post))) + (font-lock-fontify-buffer))) ; only inserting fontifies + + (setq complist (all-completions pre (LilyPond-add-dictionary-word ()))) + (while (> (length complist) 0) + (setq compsstr (concat compsstr "\"" (car complist) "\" ")) + (setq complist (cdr complist))) + (message compsstr) + (sit-for 0 100))))) + +(defun LilyPond-info () + "Launch Info for lilypond." + (interactive) + (info "lilypond")) + +(defun LilyPond-music-glossary-info () + "Launch Info for music-glossary." + (interactive) + (info "music-glossary")) + +(defun LilyPond-internals-info () + "Launch Info for lilypond-internals." + (interactive) + (info "lilypond-internals")) + +(defun LilyPond-info-index-search () + "In `*info*'-buffer, launch `info lilypond --index-search word-under-cursor'" + (interactive) + (let ((str (concat (LilyPond-pre-word-search) (LilyPond-post-word-search)))) + (if (and (> (length str) 0) + (string-equal (substring str 0 1) "\\")) + (setq str (substring str 1 nil))) + (LilyPond-info) + (Info-index str))) + +(defun LilyPond-insert-string (pre) + "Insert text to the buffer." + (insert pre) + (length pre)) + +(defun LilyPond-insert-between (text pre post) + "Insert text to the buffer if non-empty string is given." + (let ((str (read-string text))) + (if (string-equal str "") + 0 + (progn (setq pre_str_post (concat pre str post)) + (insert pre_str_post) + (length pre_str_post))))) + +(defun LilyPond-insert-tag-notes () + "LilyPond notes tag." + (interactive) + (setq begin (if (LilyPond-mark-active) + (mark-marker) (point-marker))) + (setq end (point-marker)) + (goto-char begin) + (setq l1 (LilyPond-insert-string "\\notes ")) + (setq l2 (LilyPond-insert-between "Relative (e.g. c'): " "\\relative " " ")) + (if (eq l2 0) + (setq l2 (LilyPond-insert-between "Transpose (e.g. c c'): " "\\transpose " " "))) + (setq l3 (LilyPond-insert-string "{ ")) + (goto-char (+ end l1 l2 l3)) + (LilyPond-insert-string " }") + (goto-char (+ end l1 l2 l3))) + +(defun LilyPond-insert-tag-score () + "LilyPond score tag." + (interactive) + (setq begin (if (LilyPond-mark-active) + (mark-marker) (point-marker))) + (setq end (point-marker)) + (goto-char begin) + (setq l1 (LilyPond-insert-string "\\score {\n ")) ; keep track of lengths + (goto-char (+ end l1)) + (LilyPond-insert-string "\n \\paper { }\n") + (setq l2 (if (y-or-n-p "Insert \"\\header\" field? ") + (+ (LilyPond-insert-string " \\header {") + (LilyPond-insert-between "Title: " "\n title = \"" "\"") + (LilyPond-insert-between "Subtitle: " "\n subtitle = \"" "\"") + (LilyPond-insert-between "Piece: " "\n piece = \"" "\"") + (LilyPond-insert-between "Opus: " "\n opus = \"" "\"") + (LilyPond-insert-string "\n }\n")) + 0)) + (setq l3 (if (y-or-n-p "Insert \"\\midi\" field? ") + (+ (LilyPond-insert-string " \\midi {") + (LilyPond-insert-between "Tempo: (e.g. 4=60) " " \\tempo " "") + (LilyPond-insert-string " }\n")) + 0)) + (setq l4 (LilyPond-insert-string "}\n")) + (goto-char (+ end l1))) + (defun LilyPond-command-menu-entry (entry) ;; Return LilyPond-command-alist ENTRY as a menu item. (let ((name (car entry))) @@ -346,9 +950,9 @@ command." (vector name (list 'LilyPond-command-menu name) t))))) -(easy-menu-define LilyPond-mode-menu - LilyPond-mode-map - "Menu used in LilyPond mode." +(easy-menu-define LilyPond-command-menu + LilyPond-mode-map + "Menu used in LilyPond mode." (append '("Command") '(("Command on" [ "Master File" LilyPond-command-select-master @@ -360,11 +964,59 @@ command." [ "Region" LilyPond-command-select-region :keys "C-c C-r" :style radio :selected (eq LilyPond-command-current 'LilyPond-command-region) ])) - (let ((file 'LilyPond-command-on-current)) - (mapcar 'LilyPond-command-menu-entry LilyPond-command-alist)))) - - -(defconst LilyPond-imenu-generic-re "^\\([a-zA-Z_][a-zA-Z0-9_]*\\) *=" +;;; (let ((file 'LilyPond-command-on-current)) +;;; (mapcar 'LilyPond-command-menu-entry LilyPond-command-alist)) +;;; Some kind of mapping which includes :keys might be more elegant +;;; Put keys to Lilypond-command-alist and fetch them from there somehow. + '([ "LilyPond" LilyPond-command-lilypond t]) + '([ "TeX" (LilyPond-command (LilyPond-command-menu "TeX") 'LilyPond-master-file) ]) + '([ "2Dvi" LilyPond-command-formatdvi t]) + '([ "2PS" LilyPond-command-formatps t]) + '([ "2Midi" LilyPond-command-formatmidi t]) + '([ "Book" (LilyPond-command (LilyPond-command-menu "Book") 'LilyPond-master-file) ]) + '([ "LaTeX" (LilyPond-command (LilyPond-command-menu "LaTeX") 'LilyPond-master-file) ]) + '([ "Kill jobs" LilyPond-kill-jobs t]) + '("-----") + '([ "SmartView" LilyPond-command-smartview t]) + '([ "View" LilyPond-command-view t]) + '([ "ViewPS" LilyPond-command-viewps t]) + '("-----") + '([ "Midi (toggle)" LilyPond-command-current-midi t]) + '([ "Midi all" LilyPond-command-all-midi t]) + )) + +;;; LilyPond-mode-menu should not be interactive, via "M-x LilyPond-" +(easy-menu-define LilyPond-mode-menu + LilyPond-mode-map + "Menu used in LilyPond mode." + (append '("LilyPond") + '(("Insert" + [ "\\notes..." LilyPond-insert-tag-notes t] + [ "\\score..." LilyPond-insert-tag-score t] + ["Quick Notes" LilyPond-quick-note-insert t] + ["Autocompletion" LilyPond-autocompletion t] + )) + '(("Miscellaneous" + ["(Un)comment Region" LilyPond-comment-region t] + ["Refontify buffer" font-lock-fontify-buffer t] + ["Add index menu" LilyPond-add-imenu-menu] + ["LilyPond Paren Mode" + (if (not (string-match "XEmacs\\|Lucid" emacs-version)) + (LilyPond-show-paren-mode (not LilyPond-show-paren-mode)) + (LilyPond-paren-set-mode (if (not paren-mode) 'paren -1))) + :style toggle :selected + (if (not (string-match "XEmacs\\|Lucid" emacs-version)) + LilyPond-show-paren-mode paren-mode)] + )) + '(("Info" + ["LilyPond" LilyPond-info t] + ["LilyPond index-search" LilyPond-info-index-search t] + ["Music Glossary" LilyPond-music-glossary-info t] + ["LilyPond internals" LilyPond-internals-info t] + )) + )) + +(defconst LilyPond-imenu-generic-re "^\\([a-zA-Z]+\\) *=" "Regexp matching Identifier definitions.") (defvar LilyPond-imenu-generic-expression @@ -384,15 +1036,43 @@ command." (defun LilyPond-command-select-region () (interactive) (message "Next command will be on the region") - (setq LilyPond-command-current 'LilPond-command-region)) + (setq LilyPond-command-current 'LilyPond-command-region)) (defun LilyPond-command-menu (name) ;; Execute LilyPond-command-alist NAME from a menu. (let ((LilyPond-command-force name)) - (funcall LilyPond-command-current))) + (if (eq LilyPond-command-current 'LilyPond-command-region) + (if (eq (mark t) nil) + (progn (message "The mark is not set now") (sit-for 0 500)) + (progn (if (not (not (LilyPond-mark-active))) + (progn (message "Region is not active, using region between inactive mark and current point.") (sit-for 0 500))) + (LilyPond-command-region (mark t) (point)))) + (funcall LilyPond-command-current)))) + +(defun LilyPond-add-imenu-menu () + (interactive) + "Add an imenu menu to the menubar." + (if (not LilyPond-imenu) + (progn + (imenu-add-to-menubar "Index") + (redraw-frame (selected-frame)) + (setq LilyPond-imenu t)) + (message "%s" "LilyPond-imenu already exists."))) +(put 'LilyPond-add-imenu-menu 'menu-enable '(not LilyPond-imenu)) (defun LilyPond-mode () - "Major mode for editing LilyPond music files." + "Major mode for editing LilyPond music files. + +This mode knows about LilyPond keywords and line comments, not about +indentation or block comments. It features easy compilation, error +finding and viewing of a LilyPond source buffer or region. + +COMMANDS +\\{LilyPond-mode-map} +VARIABLES + +LilyPond-command-alist\t\talist from name to command +LilyPond-xdvi-command\t\tcommand to display dvi files -- bit superfluous" (interactive) ;; set up local variables (kill-all-local-variables) @@ -400,6 +1080,15 @@ command." (make-local-variable 'font-lock-defaults) (setq font-lock-defaults '(LilyPond-font-lock-keywords)) + ;; string and comments are fontified explicitly + (make-local-variable 'font-lock-keywords-only) + (setq font-lock-keywords-only t) + + ;; Multi-line font-locking needs Emacs 21.1 or newer. + ;; For older versions there is hotkey "C-c f". + (make-local-variable 'font-lock-multiline) + (setq font-lock-multiline t) + (make-local-variable 'paragraph-separate) (setq paragraph-separate "^[ \t]*$") @@ -413,7 +1102,7 @@ command." (setq comment-start-skip "%{? *") (make-local-variable 'comment-end) - (setq comment-end "\n") + (setq comment-end "") (make-local-variable 'block-comment-start) (setq block-comment-start "%{") @@ -422,19 +1111,47 @@ command." (setq block-comment-end "%}") (make-local-variable 'indent-line-function) - (setq indent-line-function 'indent-relative-maybe) - - (set-syntax-table LilyPond-mode-syntax-table) + (setq indent-line-function 'LilyPond-indent-line) + + (LilyPond-mode-set-syntax-table '(?\< ?\> ?\{ ?\})) (setq major-mode 'LilyPond-mode) (setq mode-name "LilyPond") (setq local-abbrev-table LilyPond-mode-abbrev-table) (use-local-map LilyPond-mode-map) + ;; In XEmacs imenu was synched up with: FSF 20.4 (make-local-variable 'imenu-generic-expression) (setq imenu-generic-expression LilyPond-imenu-generic-expression) - (imenu-add-to-menubar "Index") - - ;; run the mode hook. LilyPond-mode-hook use is deprecated + ;; (imenu-add-to-menubar "Index") ; see LilyPond-add-imenu-menu + + ;; In XEmacs one needs to use 'easy-menu-add'. + (if (string-match "XEmacs\\|Lucid" emacs-version) + (progn + (easy-menu-add LilyPond-mode-menu) + (easy-menu-add LilyPond-command-menu))) + + ;; Use Command on Region even for inactive mark (region). + (if (string-match "XEmacs\\|Lucid" emacs-version) + (setq zmacs-regions nil) + (setq mark-even-if-inactive t)) + + ;; In Emacs blink-...-on-screen needs to be declared. + (if (not (string-match "XEmacs\\|Lucid" emacs-version)) + (progn +;; Commented-out: there may be several idle-timers +;; (make-local-variable 'show-paren-mode) +;; (show-paren-mode nil) +;; (make-local-variable 'LilyPond-show-paren-mode) +;; (LilyPond-show-paren-mode t) + ) + (progn +;; Commented-out: show-paren-command-hook should not be deleted from post-command-hook +;; (make-local-variable 'paren-mode) ; used in LilyPond-paren-set-mode +;; (paren-set-mode -1) ; disable default hook +;; (LilyPond-paren-set-mode 'paren) ; define buffer-local hook + )) + + ;; run the mode hook. LilyPond-mode-hook use is deprecated (run-hooks 'LilyPond-mode-hook)) (defun LilyPond-version () @@ -442,6 +1159,9 @@ command." (interactive) (message "Using `LilyPond-mode' version %s" LilyPond-version)) +(load-library "lilypond-font-lock") +(load-library "lilypond-indent") + (provide 'lilypond-mode) ;;; lilypond-mode.el ends here