]> git.donarmstrong.com Git - lilypond.git/blobdiff - lilypond-mode.el
''
[lilypond.git] / lilypond-mode.el
index 8250db03feef90e3293f1d16a9c6fdae34f52ba8..c4e4bb96a134bbb0557835bfff132bb88142912d 100644 (file)
@@ -3,25 +3,43 @@
 ;;;
 ;;; source file of the GNU LilyPond music typesetter
 ;;; 
-;;; (c) 1999, 2000 Jan Nieuwenhuizen <janneke@gnu.org>
+;;; (c) 1999--2001 Jan Nieuwenhuizen <janneke@gnu.org>
+;;; 
+;;; Changed 2001 Heikki Junes <heikki.junes@hut.fi>
+;;;    * 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)
 
 ;;; Inspired on auctex
 
+;;;
+;;; Add this to your ~/.emacs or ~/.emacs.el
+;;;     (load-library "lilypond-mode.el")
+;;;     (setq auto-mode-alist
+;;;      (append '(("\\.ly$" . LilyPond-mode) auto-mode-alist)))
+;;; 
 
-(load-file "lilypond-font-lock.el")
+(load-library "lilypond-font-lock")
+(load-library "lilypond-indent")
 
 (require 'easymenu)
 (require 'compile)
 
-(defconst LilyPond-version "1.3.103"
+(defconst LilyPond-version "1.5.28"
   "`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-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'.")
@@ -68,6 +86,11 @@ in LilyPond-include-path."
   (and process
        (eq (process-status process) 'run))))
 
+(defun Midi-running ()
+  (let ((process (get-process "midi")))
+  (and process
+       (eq (process-status process) 'run))))
+
 (defun LilyPond-kill-job ()
   "Kill the currently running LilyPond job."
   (interactive)
@@ -99,7 +122,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 +137,52 @@ in LilyPond-include-path."
 ;; variable instead of quering the user. 
 (defvar LilyPond-command-force nil)
 
+(defcustom LilyPond-xdvi-command "xdvik"
+  "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-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)
 
 ;; This is the major configuration variable.
 (defcustom LilyPond-command-alist
-  '(
+  `(
     ("LilyPond" . ("lilypond %s" . "TeX"))
     ("TeX" . ("tex '\\nonstopmode\\input %t'" . "View"))
-    
+
+    ("2Dvi" . ("ly2dvi %s" . "View"))
+    ("2PS" . ("ly2dvi -P %s" . "View"))
+    ("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"))
+
+    ("Midi" . (,(concat LilyPond-midi-command " %m") . "LilyPond"))
     )
 
   "AList of commands to execute on the current document.
@@ -133,15 +194,11 @@ 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")
@@ -156,20 +213,21 @@ LilyPond-expand-list.
     ("%t" . ".tex")
     ("%d" . ".dvi")
     ("%p" . ".ps")
+    ("%l" . ".latex")
+    ("%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)
@@ -205,11 +263,13 @@ Must be the car of an entry in LilyPond-command-alist."
                           ;;"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))))
@@ -230,6 +290,86 @@ Must be the car of an entry in LilyPond-command-alist."
   (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-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)
+)
+
+(defun LilyPond-command-midi ()
+  "Play midi corresponding to the current document."
+  (interactive)
+  (LilyPond-command (LilyPond-command-menu "Midi") '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 ()
+  "Print number of scores before the curser."
+  (interactive)
+  (count-rexp (point-min) (point-max) "\\\\midi"))
+(defun count-midi-words-backwards ()
+  "Print number of scores before the curser."
+  (interactive)
+  (count-rexp (point-min) (point) "\\\\midi"))
+(defun LilyPond-command-next-midi ()
+  "Play next midi score of the current document."
+  (interactive)
+  (if (Midi-running)
+      (quit-process (get-process "midi") t)
+    (LilyPond-compile-file 
+     (let ((fname (LilyPond-master-file))
+          (allcount (string-to-number (substring (count-midi-words) 0 -12)))
+          (count (string-to-number (substring (count-midi-words-backwards) 0 -12))))
+       (concat  LilyPond-midi-command " "
+               (substring fname 0 -3) ; suppose ".ly"
+               (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"))
+     "Midi")))
+
+;; FIXME, this is broken
 (defun LilyPond-region-file (begin end)
   (let (
        ;; (dir "/tmp/")
@@ -276,6 +416,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.
 
@@ -289,17 +439,17 @@ command."
     (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))))))))
+         (if (string-equal name "View")
+             (let ((buffer-xdvi (get-buffer-create "*view*")))
+               (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
+             (setq LilyPond-command-default name)
+             (LilyPond-compile-file command name)))))))
          
 ;; XEmacs stuff
 ;; Sadly we need this for a macro in Emacs 19.
@@ -324,14 +474,55 @@ command."
 (if LilyPond-mode-map
     ()
   (setq LilyPond-mode-map (make-sparse-keymap))
-  (define-key LilyPond-mode-map "\C-c\C-c" 'LilyPond-command-master)
+  (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-c" 'LilyPond-command-master)
+  (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 "\C-c\C-m" 'LilyPond-command-next-midi)
+  (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;" '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)
   )
 
 ;;; Menu Support
 
+(define-skeleton LilyPond-insert-tag-notes
+  "LilyPond notes tag."
+  nil
+;  (if (bolp) nil ?\n)
+  "\\notes"
+  (if (y-or-n-p "Set \"\\relative\" attribute? ")
+      (concat " \\relative " (skeleton-read "Relative: " "" str)))
+  " { " _ " }")
+
+(define-skeleton LilyPond-insert-tag-score
+  "LilyPond score tag."
+  nil
+  (if (bolp) nil ?\n)
+  "\\score {\n"
+  "   " _ "\n"
+  "   \\paper {  }\n"
+  (if (y-or-n-p "Insert \"\\header\" field? ")
+      (concat "   \\header {\n      " 
+             (skeleton-read "Piece: " "piece = " str) "\n"
+             (if (y-or-n-p "Insert \"opus\" field? ")
+                 (concat "      " (skeleton-read "Opus: " "opus = " str) "\n"))
+             "   }\n"))
+  (if (y-or-n-p "Insert \"\\midi\" field? ")
+      (concat "   \\midi { " 
+             (skeleton-read "Midi: " "\\tempo 4 = " str)  
+             " }\n"))
+  "}\n")
+
 (defun LilyPond-command-menu-entry (entry)
   ;; Return LilyPond-command-alist ENTRY as a menu item.
   (let ((name (car entry)))
@@ -360,9 +551,26 @@ 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))))
-
+         '(("Insert"
+            [ "\\notes..."  LilyPond-insert-tag-notes
+              :keys "C-c n" ]
+            [ "\\score..."  LilyPond-insert-tag-score
+              :keys "C-c s" ]
+            ))
+;        (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
+         '([ "LilyPond" (LilyPond-command (LilyPond-command-menu "LilyPond") 'LilyPond-master-file) :keys "C-c C-l"])
+         '([ "TeX" (LilyPond-command (LilyPond-command-menu "TeX") 'LilyPond-master-file) ])
+         '([ "2Dvi" (LilyPond-command (LilyPond-command-menu "2Dvi") 'LilyPond-master-file) :keys "C-c C-d"])
+         '([ "2PS" (LilyPond-command (LilyPond-command-menu "2PS") 'LilyPond-master-file) :keys "C-c C-f"])
+         '([ "Book" (LilyPond-command (LilyPond-command-menu "Book") 'LilyPond-master-file) ])
+         '([ "LaTeX" (LilyPond-command (LilyPond-command-menu "LaTeX") 'LilyPond-master-file) ])
+         '([ "SmartView" (LilyPond-command (LilyPond-command-menu "SmartView") 'LilyPond-master-file) :keys "C-c C-s"])
+         '([ "View" (LilyPond-command (LilyPond-command-menu "View") 'LilyPond-master-file) :keys "C-c C-v"])
+         '([ "ViewPS" (LilyPond-command (LilyPond-command-menu "ViewPS") 'LilyPond-master-file) :keys "C-c C-p"])
+         '([ "Midi (off)" (LilyPond-command-next-midi) :keys "C-c C-m"])
+         ))
 
 (defconst LilyPond-imenu-generic-re "^\\([a-zA-Z_][a-zA-Z0-9_]*\\) *="
   "Regexp matching Identifier definitions.")
@@ -384,7 +592,7 @@ 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.
@@ -392,7 +600,18 @@ command."
     (funcall LilyPond-command-current)))
 
 (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)
@@ -413,7 +632,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,8 +641,8 @@ command."
   (setq block-comment-end   "%}")
 
   (make-local-variable 'indent-line-function)
-  (setq indent-line-function 'indent-relative-maybe)
+  (setq indent-line-function 'LilyPond-indent-line)
+
     (set-syntax-table LilyPond-mode-syntax-table)
   (setq major-mode 'LilyPond-mode)
   (setq mode-name "LilyPond")
@@ -442,6 +661,6 @@ command."
   (interactive)
   (message "Using `LilyPond-mode' version %s" LilyPond-version))
 
-(provide 'LilyPond-mode)
-;;; LilyPond-mode.el ends here
+(provide 'lilypond-mode)
+;;; lilypond-mode.el ends here