LilyPond-Ruby 0.0.2.1 → 0.1.2

data/lib/lilypond/builder.rb

@@ -0,0 +1,161 @@
+require_relative "../lilypond-ruby.rb"
+
+# The LilyPond class provides an interface for generating LilyPond notation.
+class LilyPond
+  # The Builder class is responsible for building LilyPond notation.
+  class Builder
+    # Creates a new LilyPond Builder object.
+    def initialize
+      @buffer = "\\version \"#{LilyPond.version_number}\"\n"
+      @indent_level = 0
+    end
+
+    # Returns the current indentation level.
+    #
+    # @return [String] the current indentation level in spaces
+    def indent
+      " " * @indent_level * 2
+    end
+
+    # Generates a block of LilyPond notation.
+    #
+    # @param name [String] the name of the block
+    # @param parallel [Boolean] whether the block should be parallel
+    # @param options [Hash] the options for the block
+    # @yield the block content
+    def block(name = nil, parallel = false, options = {})
+      @buffer << "#{indent}"
+      @buffer << "\\#{name} " unless name == nil
+      if options.any?
+        @buffer << "\\with { \n"
+        @indent_level +=1
+        options.each do |key, value|
+          @buffer << "#{indent}#{key.to_s.camelize_lower} = #"
+          @buffer << (value.class.name == "String" ? "\"#{value}\"" : "#{value}")
+          @buffer << "\n"
+        end
+        @indent_level -=1
+        @buffer << "#{indent}} "
+      end
+      @buffer << "#{parallel ? "<<" : "{" }"
+      if block_given?
+        @buffer << "\n"
+        @indent_level += 1
+        yield
+        @indent_level -= 1
+        @buffer << "#{indent}#{parallel ? ">>" : "}" }\n"
+      else
+        @buffer << "#{parallel ? ">>" : "}" }\n"
+      end
+    end
+
+    # Defines the content for a LilyPond variable.
+    #
+    # @param variable_name [String] the name of the variable
+    # @param lyricmode [Boolean] whether the variable should be in lyric mode
+    # @yield the variable content
+    def define_content(variable_name = nil, lyricmode = false)
+      @buffer << "#{indent}"
+      @buffer << "#{variable_name} = " unless variable_name.nil?
+      @buffer << "\\lyricmode " if lyricmode
+      @buffer << "{\n"
+      @indent_level += 1
+      yield
+      @indent_level -= 1
+      @buffer << "}\n"
+    end
+
+    # Uses the content of a LilyPond variable.
+    #
+    # @param variable_name [String] the name of the variable to use
+    def use_content(variable_name)
+      @buffer << "#{indent}\\#{variable_name}\n"
+    end
+
+    # Appends a string of LilyPond notation to the buffer.
+    #
+    # @param string [String] the LilyPond notation to append
+    def append(string)
+      @buffer << "#{indent}#{string}\n"
+    end
+
+    # Returns the current buffer as a string of LilyPond notation.
+    #
+    # @return [String] the LilyPond notation buffer
+    def to_s
+      @buffer
+    end
+
+    class << self
+      # Generates a sample LilyPond notation.
+      #
+      # @return [LilyPond::Builder] the LilyPond notation builder
+      def sample
+        parallel = true
+        options = {
+          :midi_maximum_volume => 0.4,
+          :instrument_name     => "Piano"
+        }
+        ly = LilyPond::Builder.new
+
+        ly.append "%% MUSIC %%"
+        ly.define_content("global") do |global|
+          ly.append "\\numericTimeSignature"
+          ly.append "\\time 4/4"
+          ly.append "s1 * 4 |"
+          ly.append "\\bar \"|.\""
+        end #global
+        ly.define_content("sopranoMusic") do |sopranoMusic|
+          ly.append "c'4 d'4 e'4 f'4 |"
+          ly.append "c'4 d'4 e'4 f'4 |"
+          ly.append "c'4 d'4 e'4 f'4 |"
+          ly.append "c'4 d'4 e'4 f'4 |"
+        end #sopranoMusic
+        ly.append "%% LYRICS %%"
+        ly.define_content("sopranoLyrics", true) do |sopranoLyrics|
+          ly.append "do re me fa"
+          ly.append "do re me fa"
+          ly.append "do re me fa"
+          ly.append "do re me fa"
+        end #sopranoLyrics
+        ly.append "%% BOOKS %%"
+        ly.block("book") do |book|
+          ly.block("score") do |score|
+            ly.block(nil, parallel) do |score_content|
+              ly.block("new Staff", parallel, options) do |staff|
+                ly.block("new Voice", parallel) do |voice|
+                  ly.use_content("global")
+                  ly.use_content("sopranoMusic")
+                end #voice
+                ly.block("new Lyrics") do |lyrics|
+                  ly.use_content("sopranoLyrics")
+                end #lyrics
+              end #staff
+            end #score_content
+            ly.block("midi")
+            ly.block("layout")
+          end #score
+        end #book
+
+        return ly
+      end #sample()
+
+    end #self
+  end #Builder
+end #LilyPond
+
+# Adds a `camelize_lower` method to the String class.
+class String
+  # Converts an underscored string to camel case, except the first word remains downcase.
+  #
+  # Examples
+  #
+  #   "my_foo".camelize_lower #=> "myFoo"
+  #
+  # @return [String] the camelized string
+  def camelize_lower
+    self.split('_').map.with_index do |word, i|
+      i == 0 ? word.downcase : word.capitalize
+    end.join('')
+  end
+end

data/lib/lilypond-ruby.rb

@@ -1,11 +1,13 @@
 require "open3"
+require "lilypond/builder"
+require "guile"
 
 class LilyPond
-  LYPATH = File.expand_path("../../bin/lilypond", __FILE__)
+  LILYPOND_PATH = File.expand_path("../../bin/lilypond", __FILE__)
   class << self
 
     def version
-      output, error, status = Open3.capture3(LYPATH, "--version")
+      output, error, status = Open3.capture3(LILYPOND_PATH, "--version")
       if status.success?
         puts output
       else
@@ -13,8 +15,20 @@ class LilyPond
       end
     end
 
+    def version_number
+      output, error, status = Open3.capture3(LILYPOND_PATH, "--version")
+      if status.success?
+        return output.match(/GNU LilyPond (\d+\.\d+\.\d+)/)[1]
+      else
+        return "#{error}"
+      end
+    end
+
     def generate_pdf_with_lilypond(file_name, lilypond_code)
-      Open3.popen3(LYPATH, '--pdf', file_name) do |stdin, stdout, stderr, wait_thr|
+      tempfile = Tempfile.new(file_name)
+      tempfile.write(lilypond_code)
+      tempfile.close
+      Open3.popen3(LILYPOND_PATH, "--pdf", tempfile.path) do |stdin, stdout, stderr, wait_thr|
         # Write the Lilypond code to stdin
         stdin.write(lilypond_code)
         stdin.close
@@ -42,6 +56,7 @@ class LilyPond
           break
         end
       end
+      File.delete(tempfile.path)
     end
 
   end # end self

data/share/emacs/site-lisp/lilypond-font-lock.el

@@ -0,0 +1,208 @@
+;;;; lilypond-font-lock.el --- syntax coloring for LilyPond mode
+;;;;
+;;;; This file is part of LilyPond, the GNU music typesetter.
+;;;;
+;;;; Copyright (C) 1997--2022 Han-Wen Nienhuys <hanwen@xs4all.nl>,
+;;;;               2001--2006 Heikki Junes <hjunes@cc.hut.fi>
+;;;;
+;;;; LilyPond is free software: you can redistribute it and/or modify
+;;;; it under the terms of the GNU General Public License as published by
+;;;; the Free Software Foundation, either version 3 of the License, or
+;;;; (at your option) any later version.
+;;;;
+;;;; LilyPond is distributed in the hope that it will be useful,
+;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;;; GNU General Public License for more details.
+;;;;
+;;;; You should have received a copy of the GNU General Public License
+;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
+;;
+;; Author: 2001-2006: Heikki Junes
+;;  * Emacs-mode: new keywords, reserved words, identifiers, notenames, 
+;;    some dynamics and brackets are font-lock-keywords
+;;  * context-dependent syntax-tables
+;; Author: 1997: Han-Wen Nienhuys
+;; Author: 1995-1996 Barry A. Warsaw
+;;         1992-1994 Tim Peters
+;; Created:       Feb 1992
+;; Version:       2.9.29
+;; Last Modified: 11NOV2006
+;; Keywords: lilypond languages music notation
+
+;; This started out as a cannabalised version of python-mode.el, by hwn
+;; For changes see the LilyPond ChangeLog
+;;
+
+;; TODO:
+;;   - handle lexer modes (\header, \melodic) etc.
+
+(defconst LilyPond-font-lock-keywords
+  (let* ((kwregex (mapconcat (lambda (x) (concat "\\" x))  LilyPond-keywords "\\|"))
+	 (iregex (mapconcat (lambda (x) (concat "\\" x))  LilyPond-identifiers "\\|"))
+	 (ncrwregex (mapconcat (lambda (x) (concat "" x))  LilyPond-non-capitalized-reserved-words "\\|"))
+	 (rwregex (mapconcat (lambda (x) (concat "" x))  LilyPond-Capitalized-Reserved-Words "\\|"))
+	 (duration "\\([ \t]*\\(128\\|6?4\\|3?2\\|16?\\|8\\)[.]*\\([ \t]*[*][ \t]*[0-9]+\\(/[1-9][0-9]*\\)?\\)?\\)") 
+	 (longduration "\\([ \t]*\\(\\\\\\(longa\\|breve\\|maxima\\)\\)[.]*\\([ \t]*[*][ \t]*[0-9]+\\(/[1-9][0-9]*\\)?\\)?\\)") 
+)
+
+    (list 
+;; Fonts in use (from GNU Emacs Lisp Reference Manual, elisp.ps):
+;; font-lock- (c)omment / (s)tring / (k)eyword / (b)uiltin / (f)unction-name / 
+;;            (v)ariable-name / (t)ype / co(n)stant / (w)arning -face
+
+;; The order below is designed so that proofreading would be possible.
+
+;; Fontify...
+;; ... (f) identifiers and (k) keywords.
+;; ... (n) user defined indetifiers
+;; ... (v) the right and the left side of '='-marks.
+;; ... (v) reserved words, e.g., FiguredBass.
+;; ... (t) notes and rests
+;; "on top", ... (s) lyrics-mode
+;; "on top", ... (w) horizontal grouping
+;; "on top", ... (f) vertical grouping
+;; "on top", ... (b) expressional grouping
+;; "on top", ... (s) (multiline-)scheme; urgh. one should count the slurs
+;; "on top", ... (s) strings
+;; "on top", ... (c) (multiline-)comments
+
+;; One should note 'font-lock-multiline' has been possible since Emacs 21.1.
+;; See, e.g., text in "http://emacs.kldp.org/emacs-21.1/etc/NEWS".
+
+;; ... identifiers (defined above, see iregex)
+      (cons (concat "\\(\\([_^-]?\\(" iregex "\\)\\)+\\)\\($\\|[] \t(~{}>\\\\_()^*-]\\)") '(1 font-lock-function-name-face))
+
+;; ... keywords (defined above, see kwregex)
+      (cons (concat "\\(\\([_^-]?\\(" kwregex "\\)\\)+\\)\\($\\|[] \t(~{}>\\\\_()^*-]\\)") '(1 font-lock-keyword-face))
+
+;; ... user defined identifiers, roughly  \[a-zA-Z]+ with single - or _ in between.
+      '("\\([_^-]?\\\\\\([a-zA-Z[:nonascii:]]\\(?:[-_]?[a-zA-Z[:nonascii:]]\\)*\\)\\)" 1 font-lock-constant-face)
+
+;; ... the left side of '=' -mark
+      '("\\([_a-zA-Z.0-9-]+\\)[ \t]*=[ \t]*" 1 font-lock-variable-name-face)
+
+;; ... the right side of '=' -mark
+      '("[ \t]*=[ \t]*\\([_a-zA-Z.0-9-]+\\)" 1 font-lock-variable-name-face)
+
+;; ... reserved words (defined above, see rwregex)
+      (cons (concat "\\(" rwregex "\\)") 'font-lock-variable-name-face)
+
+;; ... note or rest with (an accidental and) a duration, e.g., b,?16.*3/4
+      (cons (concat "\\(^\\|[ <\{[/~(!)\t\\\|]\\)\\(\\(\\(" ncrwregex "\\)[,']*[?!]?\\|[srR]\\)" duration "?\\)") '(2 font-lock-type-face))
+
+;; "on top", ... notes and rests with a long duration
+      (cons (concat "\\(^\\|[ <\{[/~(!)\t\\\|]\\)\\(\\(\\(" ncrwregex "\\)[,']*[?!]?\\|[srR]\\)" longduration "\\)") '(2 font-lock-type-face t))
+
+;; "on top", ... lyrics-mode: fontify everything between '<'...'>' or '{'...'}'
+;            URGH, does not know anything about inner brackets.
+;            Multiple lines may need refontifying (C-c f).
+      '("\\(\\\\lyrics[^{<]*\\)\\({[^}]*\\|<[^>]*\\)" 2 font-lock-string-face t)
+
+;; "on top", ... horizontal grouping, also as postfix syntax '-*':
+;;               - brackets '{[]}'
+;;               - ties '~'
+;;               - ligatures \[, \]
+      '("\\(-?[][~}{]\\|\\\\[][]\\)" 0 font-lock-reference-face t)
+
+;; "on top", ... vertical grouping:
+;;               - '<>'-chord brackets with '\\'-voice sep., not marcato '->'
+;;               - '<< a b >>8' -chords
+      (cons (concat "\\(\\(-.\\)+\\|[^-^_]\\)\\([<>]+\\(" duration "\\|" longduration "\\)?\\|\\\\\\\\\\)") '(3 font-lock-function-name-face t))
+
+;; "on top", ... expressional grouping, also as postfix syntax '-*':
+;;               - slurs ( ), \( \), [-^_][()]
+;;               - hairpins \<, \>, \! 
+      '("\\(-?\\\\[(<!>)]\\|[-^_]?[()]\\)" 0 font-lock-builtin-face t)
+
+;; "on top", ... (multiline-)scheme: try find slurs up to 7th
+      '("[_^-]?#\\(#[ft]\\|-?[0-9.]+\\|\"[^\"]*\"\\|['`]?[a-zA-Z:-]+\\|['`]?([^()]*\\(([^()]*\\(([^()]*\\(([^()]*\\(([^()]*\\(([^()]*\\(([^)]*)[^()]*\\)*)[^()]*\\)*)[^()]*\\)*)[^()]*\\)*)[^()]*\\)*)[^()]*\\)*[^)]*)\\)" 0 font-lock-string-face t)
+
+;; "on top", ... strings, match also unending strings at eof:
+;;               if '\n' was not found, it must be '$' which is eof (?).
+      '("\\([_^-]?\"\\([^\"\\\\]\\|\\\\.\\|\\\\\n\\)*\\(\"\\|$\\)\\)" 0 font-lock-string-face t)
+
+;; "on top", ... (multiline-)comments
+      '("\\(%\\({[^%]*%\\(}\\|\\([^}][^%]*%\\)+}\\)\\|.*\\)\\)" 0 font-lock-comment-face t)
+
+      )
+    )
+  "Additional expressions to fontify in LilyPond mode.")
+
+;; define a mode-specific abbrev table for those who use such things
+(defvar LilyPond-mode-abbrev-table nil
+  "Abbrev table in use in `LilyPond-mode' buffers.")
+
+(define-abbrev-table 'LilyPond-mode-abbrev-table nil)
+
+(defvar LilyPond-mode-syntax-table nil
+  "Syntax table used in `LilyPond-mode' buffers.")
+
+(defun LilyPond-mode-set-syntax-table (&optional not-punct)
+  "Change syntax table according to the argument `not-punct' which contains characters which are given a context dependent non-punctuation syntax: parentheses may be set to parenthesis syntax and characters `-', `^' and `_' may be set to escape syntax."
+  (if (not not-punct) (setq not-punct '()))
+  (setq LilyPond-mode-syntax-table (make-syntax-table))
+  (let ((defaults 	  
+	  '(
+	    ;; NOTE: Emacs knows only "13"-style (used), XEmacs knows also "1b3b", etc.
+	    ( ?\% . "< 13" )   ; comment starter, 1st char in block-comments
+	    ( ?\n . ">")       ; newline: comment ender
+	    ( ?\r . ">")       ; formfeed: comment ender
+	    ( ?\\ . "\\" )     ; escape characters (as '\n' in strings)
+	    ( ?\" . "\"" )     ; string quote characters
+	    ;; word constituents (e.g., belonging to a note)
+	    ( ?\' . "w") ( ?\, . "w") ; transposing octaves
+	    ;; punctuation characters (separate symbols from another)
+	    ( ?\$ . "." ) ( ?\& . "." )
+	    ( ?\* . "." ) ( ?\+ . "." ) ( ?\/ . "." )  ( ?\= . "." )
+	    ( ?\| . "." )      ; bar line
+	    )))
+    ;; all the paren characters are now handled by lily-specific indenting/matching code in lilypond-indent.el
+    (if (or (memq ?\{ not-punct) (memq ?\} not-punct))
+	(setq defaults (cons '( ?\{ . "(} 2" ) (cons '( ?\} . "){ 4" ) defaults))) ; begin and end of a block-comment
+      (setq defaults (cons '( ?\{ . ". 2" ) (cons '( ?\} . ". 4" ) defaults))))    ; begin and end of a block-comment
+    (if (or (memq ?\[ not-punct) (memq ?\] not-punct))
+	(setq defaults (cons '( ?\[ . "(]" ) (cons '( ?\] . ")[" ) defaults)))
+      (setq defaults (cons '( ?\[ . "." ) (cons '( ?\] . "." ) defaults))))
+    (if (or (memq ?\< not-punct) (memq ?\> not-punct))
+	(setq defaults (cons '( ?\< . "(>" ) (cons '( ?\> . ")<" ) defaults)))
+      (setq defaults (cons '( ?\< . "." ) (cons '( ?\> . "." ) defaults))))
+    (if (or (memq ?\( not-punct) (memq ?\) not-punct))
+	(setq defaults (cons '( ?\( . "()" ) (cons '( ?\) . ")(" ) defaults)))
+      (setq defaults (cons '( ?\( . "." ) (cons '( ?\) . "." ) defaults))))
+    ;; In LilyPond the following chars serve as escape chars, e.g., c^> d-) e_( , 
+    ;; but they may be set to punctuation chars, since inside strings they should not act as escape chars
+    (setq defaults (cons (if (memq ?- not-punct) '( ?\- . "\\" ) '( ?\- . "." ) ) defaults))
+    (setq defaults (cons (if (memq ?^ not-punct) '( ?^ . "\\" ) '( ?^ . "." ) ) defaults))
+    (setq defaults (cons (if (memq ?\_ not-punct) '( ?\_ . "\\" ) '( ?\_ . "." ) ) defaults))
+    (mapcar (function
+	     (lambda (x) (modify-syntax-entry
+			  (car x) (cdr x) LilyPond-mode-syntax-table)))
+	    defaults)
+    (set-syntax-table LilyPond-mode-syntax-table)))
+
+(defun LilyPond-mode-context-set-syntax-table ()
+  "Change syntax table according to current context."
+  (interactive)
+  ;; default syntax table sets parentheses to punctuation characters
+  (LilyPond-mode-set-syntax-table) 
+  ;; find current context
+  (setq context (parse-partial-sexp (point-min) (point)))
+  (cond ((nth 3 context)) ; inside string
+	((nth 4 context)) ; inside a comment
+	((eq (char-syntax (or (char-before (point)) 0)) ?\\)) ; found escape-char
+	((and (eq (char-syntax (or (char-before (- (point) 1)) 0)) ?\\)
+	      (memq (char-before (point)) '( ?\) ?\] )))) ; found escape-char
+	((memq (char-before (point)) '( ?\) ))
+	 (LilyPond-mode-set-syntax-table '( ?\( ?\) )))
+	((memq (char-before (point)) '( ?\] ))
+	 (LilyPond-mode-set-syntax-table '( ?\[ ?\] )))
+	((memq (char-before (point)) '( ?\> ?\} ))
+	 (LilyPond-mode-set-syntax-table '( ?\< ?\> ?\{ ?\} ?\^ ?\- ?\_ )))
+	((memq (char-after (point)) '( ?\( ))
+	 (LilyPond-mode-set-syntax-table '( ?\( ?\) )))
+	((memq (char-after (point)) '( ?\[ ))
+	 (LilyPond-mode-set-syntax-table '( ?\[ ?\] )))
+	((memq (char-after (point)) '( ?\< ?\{ ))
+	 (LilyPond-mode-set-syntax-table '( ?\< ?\> ?\{ ?\} ?\^ ?\- ?\_ )))
+	))