]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-markup-commands.scm
* lily/staff-symbol-referencer.cc (get_position): emergency
[lilypond.git] / scm / define-markup-commands.scm
index aa1d61e38ba3a4cc62aefd141626f6230dc710c1..abcb7e33135eb47c529da350096308b9201a3982 100644 (file)
 ;;     syntax, description and example. 
 
 
-(def-markup-command (word paper props str) (string?)
-  "A single word."
-  (interpret-markup paper props str))
-  
+(def-markup-command (stencil paper props stil) (ly:stencil?)
+  "Stencil as markup"
+  stil)
+
+
+(def-markup-command (score paper props score) (ly:score?)
+  (let*
+      ((systems (ly:score-embedded-format score paper))
+       (1st (vector-ref systems 0))
+       (stencil (ly:paper-system-stencil 1st)) )
+
+    (ly:stencil-align-to! stencil Y CENTER)
+    stencil))
+
 (def-markup-command (simple paper props str) (string?)
-  "A simple text-string; @code{\\markup @{ foo @}} is equivalent with
+  "A simple text string; @code{\\markup @{ foo @}} is equivalent with
 @code{\\markup @{ \\simple #\"foo\" @}}."
-    (interpret-markup paper props
-                     (make-line-markup
-                      (map make-word-markup (string-tokenize str)))))
+    (interpret-markup paper props str))
+
+(def-markup-command (encoded-simple paper props sym str) (symbol? string?)
+  "A text string, encoded with encoding @var{sym}. "
+  (Text_item::interpret_string paper
+                              props sym str))
+
+;; TODO: use font recoding.
+;;                   (make-line-markup
+;;                    (map make-word-markup (string-tokenize str)))))
 
 (define-public empty-markup
   (make-simple-markup ""))
                        markups))
         (text-width (apply + (map interval-length
                                   (map (lambda (x)
-                                         (ly:stencil-get-extent x X))
+                                         (ly:stencil-extent x X))
                                        stencils))))
        (word-count (length markups))
-       (word-space (cdr (chain-assoc 'word-space props)))
-       (line-width (cdr (chain-assoc 'linewidth props)))
+       (word-space (chain-assoc-get 'word-space props))
+       (line-width (chain-assoc-get 'linewidth props))
        (fill-space (if (< line-width text-width)
                        word-space
                        (/ (- line-width text-width)
                           (if (= word-count 1) 2 (- word-count 1)))))
        (line-stencils (if (= word-count 1)
                           (map (lambda (x) (interpret-markup paper props x))
-                               (list (make-word-markup "")
-                                     (car markups)
-                                     (make-word-markup "")))
+                               (list (make-simple-markup "")
+                                     (make-stencil-markup (car stencils))
+                                     (make-simple-markup "")))
                                stencils)))
     (stack-stencil-line fill-space line-stencils)))
   
   "Put @var{args} in a horizontal line.  The property @code{word-space}
 determines the space between each markup in @var{args}."
   (stack-stencil-line
-   (cdr (chain-assoc 'word-space props))
+   (chain-assoc-get 'word-space props)
    (map (lambda (m) (interpret-markup paper props m)) args)))
 
 (def-markup-command (combine paper props m1 m2) (markup? markup?)
   "Print two markups on top of each other."
-  (ly:stencil-add
-   (interpret-markup paper props m1)
-   (interpret-markup paper props m2)))
+  (let*
+      ((s1 (interpret-markup paper props m1))
+       (s2 (interpret-markup paper props m2)))
+            
+    (ly:stencil-add s1 s2)))
 
 (def-markup-command (finger paper props arg) (markup?)
   "Set the argument as small numbers."
@@ -80,7 +99,7 @@ determines the space between each markup in @var{args}."
                     arg))
 
 (def-markup-command (fontsize paper props mag arg) (number? markup?)
-  "This sets the relative font size, eg.
+  "This sets the relative font size, e.g.
 @example
 A \\fontsize #2 @{ B C @} D
 @end example
@@ -120,7 +139,7 @@ Use @code{\\fontsize} otherwise."
   "Set font family to @code{number}, which yields the font used for
 time signatures and fingerings.  This font only contains numbers and
 some punctuation. It doesn't have any letters.  "
-  (interpret-markup paper (prepend-alist-chain 'font-family 'number props) arg))
+  (interpret-markup paper (prepend-alist-chain 'font-encoding 'fetaNumber props) arg))
 
 (def-markup-command (roman paper props arg) (markup?)
   "Set font family to @code{roman}."
@@ -159,18 +178,19 @@ some punctuation. It doesn't have any letters.  "
   (interpret-markup paper (prepend-alist-chain 'font-shape 'latin1 props) arg))
 
 (def-markup-command (dynamic paper props arg) (markup?)
-  "Use the dynamic font.  This font only contains s, f, m, z, p, and
-r.  When producing phrases, like ``piu f'', the normal words (like
-``piu'') should be done in a different font.  The recommend font for
-this is bold and italic
-"
+  "Use the dynamic font.  This font only contains @b{s}, @b{f}, @b{m},
+@b{z}, @b{p}, and @b{r}.  When producing phrases, like ``pi@`{u} @b{f}'', the
+normal words (like ``pi@`{u}'') should be done in a different font.  The
+recommend font for this is bold and italic"
   (interpret-markup
-   paper (prepend-alist-chain 'font-family 'dynamic props) arg))
+   paper (prepend-alist-chain 'font-encoding 'fetaDynamic props) arg))
 
 (def-markup-command (italic paper props arg) (markup?)
+  "Use italic @code{font-shape} for @var{arg}. "
   (interpret-markup paper (prepend-alist-chain 'font-shape 'italic props) arg))
 
 (def-markup-command (typewriter paper props arg) (markup?)
+  "Use @code{font-family} typewriter for @var{arg}."
   (interpret-markup
    paper (prepend-alist-chain 'font-family 'typewriter props) arg))
 
@@ -180,44 +200,67 @@ this is bold and italic
    paper (prepend-alist-chain 'font-shape 'upright props) arg))
 
 (def-markup-command (doublesharp paper props) ()
+  "Draw a double sharp symbol."
+
   (interpret-markup paper props (markup #:musicglyph "accidentals-4")))
-(def-markup-command (threeqsharp paper props) ()
+(def-markup-command (sesquisharp paper props) ()
+  "Draw a 3/2 sharp symbol."
   (interpret-markup paper props (markup #:musicglyph "accidentals-3")))
+
 (def-markup-command (sharp paper props) ()
+  "Draw a sharp symbol."
   (interpret-markup paper props (markup #:musicglyph "accidentals-2")))
 (def-markup-command (semisharp paper props) ()
+  "Draw a semi sharp symbol."
   (interpret-markup paper props (markup #:musicglyph "accidentals-1")))
 (def-markup-command (natural paper props) ()
+  "Draw a natural symbol."
+
   (interpret-markup paper props (markup #:musicglyph "accidentals-0")))
 (def-markup-command (semiflat paper props) ()
+  "Draw a semiflat."
   (interpret-markup paper props (markup #:musicglyph "accidentals--1")))
 (def-markup-command (flat paper props) ()
+  "Draw a flat symbol."
+  
   (interpret-markup paper props (markup #:musicglyph "accidentals--2")))
-(def-markup-command (threeqflat paper props) ()
+(def-markup-command (sesquiflat paper props) ()
+  "Draw a 3/2 flat symbol."
+  
   (interpret-markup paper props (markup #:musicglyph "accidentals--3")))
 (def-markup-command (doubleflat paper props) ()
+  "Draw a double flat symbol."
+
   (interpret-markup paper props (markup #:musicglyph "accidentals--4")))
 
 
 (def-markup-command (column paper props args) (markup-list?)
+  "Stack the markups in @var{args} vertically."
   (stack-lines
-   -1 0.0 (cdr (chain-assoc 'baseline-skip props))
+   -1 0.0 (chain-assoc-get 'baseline-skip props)
    (map (lambda (m) (interpret-markup paper props m)) args)))
 
 (def-markup-command (dir-column paper props args) (markup-list?)
   "Make a column of args, going up or down, depending on the setting
-of the #'direction layout property."
-  (let* ((dir (cdr (chain-assoc 'direction props))))
+of the @code{#'direction} layout property."
+  (let* ((dir (chain-assoc-get 'direction props)))
     (stack-lines
      (if (number? dir) dir -1)
      0.0
-     (cdr (chain-assoc 'baseline-skip props))
+      (chain-assoc-get 'baseline-skip props)
      (map (lambda (x) (interpret-markup paper props x)) args))))
 
 (def-markup-command (center-align paper props args) (markup-list?)
+  "Put @code{args} in a centered column. "
   (let* ((mols (map (lambda (x) (interpret-markup paper props x)) args))
          (cmols (map (lambda (x) (ly:stencil-align-to! x X CENTER)) mols)))
-    (stack-lines -1 0.0 (cdr (chain-assoc 'baseline-skip props)) mols)))
+    (stack-lines -1 0.0 (chain-assoc-get 'baseline-skip props) mols)))
+
+(def-markup-command (vcenter paper props arg) (markup?)
+  "Align @code{arg} to its center. "
+  (let* ((mol (interpret-markup paper props arg)))
+    (ly:stencil-align-to! mol Y CENTER)
+    mol))
 
 (def-markup-command (right-align paper props arg) (markup?)
   (let* ((m (interpret-markup paper props arg)))
@@ -225,13 +268,24 @@ of the #'direction layout property."
     m))
 
 (def-markup-command (left-align paper props arg) (markup?)
+  "Align @var{arg} on its left edge. "
+  
   (let* ((m (interpret-markup paper props arg)))
     (ly:stencil-align-to! m X LEFT)
     m))
 
+(def-markup-command (general-align paper props axis dir arg)  (integer? number? markup?)
+  "Align @var{arg} in @var{axis} direction to the @var{dir} side."
+  (let* ((m (interpret-markup paper props arg)))
+
+    (ly:stencil-align-to! m axis dir)
+    m
+  ))
+
 (def-markup-command (halign paper props dir arg) (number? markup?)
-  "Set horizontal alignment. @var{dir} = -1 is left, @var{dir} = 1 is
-right, values in between vary alignment accordingly."
+  "Set horizontal alignment. If @var{dir} is -1, then it is
+left-aligned, while+1 is right. Values in between interpolate alignment
+accordingly."
 
   
   (let* ((m (interpret-markup paper props arg)))
@@ -244,10 +298,7 @@ right, values in between vary alignment accordingly."
 See @usermanref{The Feta font} for  a complete listing of the possible glyphs.
 "
   (ly:find-glyph-by-name
-   (ly:paper-get-font paper (cons '((font-name . ())
-                                    (font-shape . *)
-                                    (font-series . *)
-                                    (font-family . music))
+   (ly:paper-get-font paper (cons '((font-encoding . fetaMusic))
                                   props))
    glyph-name))
 
@@ -285,15 +336,14 @@ and/or @code{extra-offset} properties. "
                               amount Y))
 
 (def-markup-command (fraction paper props arg1 arg2) (markup? markup?)
-  "Make a fraction of two markups.
-
-Syntax: \\fraction MARKUP1 MARKUP2."
+  "Make a fraction of two markups."
+  
   (let* ((m1 (interpret-markup paper props arg1))
          (m2 (interpret-markup paper props arg2)))
     (ly:stencil-align-to! m1 X CENTER)
     (ly:stencil-align-to! m2 X CENTER)    
-    (let* ((x1 (ly:stencil-get-extent m1 X))
-           (x2 (ly:stencil-get-extent m2 X))
+    (let* ((x1 (ly:stencil-extent m1 X))
+           (x2 (ly:stencil-extent m2 X))
            (line (ly:round-filled-box (interval-union x1 x2) '(-0.05 . 0.05) 0.0))
            ;; should stack mols separately, to maintain LINE on baseline
            (stack (stack-lines -1 0.2 0.6 (list m1 line m2))))
@@ -307,9 +357,10 @@ Syntax: \\fraction MARKUP1 MARKUP2."
 ;; TODO: better syntax.
 
 (def-markup-command (note-by-number paper props log dot-count dir) (number? number? number?)
-  "Syntax: \\note-by-number #LOG #DOTS #DIR.  By using fractional values
-for DIR, you can obtain longer or shorter stems."
-  (let* ((font (ly:paper-get-font paper (cons '((font-family .  music)) props)))
+  "Construct a note symbol, with stem.  By using fractional values for
+@var{dir}, you can obtain longer or shorter stems."
+  
+  (let* ((font (ly:paper-get-font paper (cons '((font-encoding . fetaMusic)) props)))
          (stemlen (max 3 (- log 1)))
          (headgl (ly:find-glyph-by-name
                   font
@@ -317,7 +368,7 @@ for DIR, you can obtain longer or shorter stems."
          (stemth 0.13)
          (stemy (* dir stemlen))
          (attachx (if (> dir 0)
-                      (- (cdr (ly:stencil-get-extent headgl X)) stemth)
+                      (- (cdr (ly:stencil-extent headgl X)) stemth)
                       0))
          (attachy (* dir 0.28))
          (stemgl (and (> log 0)
@@ -327,7 +378,7 @@ for DIR, you can obtain longer or shorter stems."
                              (max stemy attachy))
                        (/ stemth 3))))
          (dot (ly:find-glyph-by-name font "dots-dot"))
-         (dotwid (interval-length (ly:stencil-get-extent dot X)))
+         (dotwid (interval-length (ly:stencil-extent dot X)))
          (dots (and (> dot-count 0)
                     (apply ly:stencil-add
                            (map (lambda (x)
@@ -354,7 +405,7 @@ for DIR, you can obtain longer or shorter stems."
                                                   (* 1.5 dotwid)
                                                   0)
                                               ;; huh ? why not necessary?
-                                              ;;(cdr (ly:stencil-get-extent headgl X))
+                                              ;;(cdr (ly:stencil-extent headgl X))
                                               dotwid)
                                            X)
                stemgl)))
@@ -367,7 +418,7 @@ for DIR, you can obtain longer or shorter stems."
     (lambda (z) (inexact->exact (/ (log z) divisor)))))
 
 (define (parse-simple-duration duration-string)
-  "Parse the `duration-string', eg ''4..'' or ''breve.'', and return a (log dots) list."
+  "Parse the `duration-string', e.g. ''4..'' or ''breve.'', and return a (log dots) list."
   (let ((match (regexp-exec (make-regexp "(breve|longa|maxima|[0-9]+)(\\.*)") duration-string)))
     (if (and match (string=? duration-string (match:substring match 0)))
         (let ((len  (match:substring match 1))
@@ -390,10 +441,11 @@ a shortened down stem."
 
 (def-markup-command (normal-size-super paper props arg) (markup?)
   "A superscript which does not use a smaller font."
+  
   (ly:stencil-translate-axis (interpret-markup
                                paper
                                props arg)
-                              (* 0.5 (cdr (chain-assoc 'baseline-skip props)))
+                              (* 0.5  (chain-assoc-get 'baseline-skip props))
                               Y))
 
 (def-markup-command (super paper props arg) (markup?)
@@ -420,7 +472,7 @@ Raising and lowering texts can be done with @code{\\super} and
     paper
     (cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
     arg)
-   (* 0.5 (cdr (chain-assoc 'baseline-skip props)))
+   (* 0.5 (chain-assoc-get 'baseline-skip props))
    Y))
 
 (def-markup-command (translate paper props offset arg) (number-pair? markup?)
@@ -438,29 +490,32 @@ that.
                          offset))
 
 (def-markup-command (sub paper props arg) (markup?)
-  "Syntax: \\sub MARKUP."
+  "Set @var{arg} in subscript."
+  
   (ly:stencil-translate-axis
    (interpret-markup
     paper
     (cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
     arg)
-   (* -0.5 (cdr (chain-assoc 'baseline-skip props)))
+   (* -0.5 (chain-assoc-get 'baseline-skip props))
    Y))
 
 (def-markup-command (normal-size-sub paper props arg) (markup?)
+  "Set @var{arg} in subscript, in a normal font size."
+
   (ly:stencil-translate-axis
    (interpret-markup paper props arg)
-   (* -0.5 (cdr (chain-assoc 'baseline-skip props)))
+   (* -0.5 (chain-assoc-get 'baseline-skip props))
    Y))
 
 (def-markup-command (hbracket paper props arg) (markup?)
-  "Horizontal brackets around @var{arg}."  
+  "Draw horizontal brackets around @var{arg}."  
   (let ((th 0.1) ;; todo: take from GROB.
         (m (interpret-markup paper props arg)))
     (bracketify-stencil m X th (* 2.5 th) th)))
 
 (def-markup-command (bracket paper props arg) (markup?)
-  "Vertical brackets around @var{arg}."  
+  "Draw vertical brackets around @var{arg}."  
   (let ((th 0.1) ;; todo: take from GROB.
         (m (interpret-markup paper props arg)))
     (bracketify-stencil m Y th (* 2.5 th) th)))
@@ -493,7 +548,7 @@ any sort of property supported by @internalsref{font-interface} and
 (def-markup-command (smaller paper props arg) (markup?)
   "Decrease the font size relative to current setting"
   (let* ((fs (chain-assoc-get 'font-size props 0))
-         (entry (cons 'font-size (- fs 1))))
+        (entry (cons 'font-size (- fs 1))))
     (interpret-markup paper (cons (list entry) props) arg)))
 
 
@@ -551,3 +606,89 @@ FIXME: is this working?
  (skipping I), and continues with double letters."
  
    (Text_item::interpret_markup paper props (number->markletter-string num)))
+
+
+
+
+(def-markup-command (bracketed-y-column paper props indices args)
+  (list? markup-list?)
+  "Make a column of the markups in @var{args}, putting brackets around
+the elements marked in @var{indices}, which is a list of numbers."
+
+    (define (sublist l start stop)
+    (take (drop l start)  (- (1+ stop) start)) )
+
+  (define (stencil-list-extent ss axis)
+    (cons
+     (apply min (map (lambda (x) (car (ly:stencil-extent x axis))) ss))
+     (apply max (map (lambda (x) (cdr (ly:stencil-extent x axis))) ss))))
+           
+  (define (stack-stencils stencils bskip last-stencil)
+    (cond
+     ((null? stencils) '())
+     ((not last-stencil)
+      (cons (car stencils)
+           (stack-stencils (cdr stencils) bskip (car stencils))))
+     (else
+      (let*
+         ((orig (car stencils))
+          (dir (chain-assoc-get 'direction  props DOWN))
+          (new (ly:stencil-moved-to-edge last-stencil Y dir
+                                         orig
+                                         0.1 bskip))
+          )
+
+       (cons new (stack-stencils (cdr stencils) bskip new))))
+    ))
+
+  (define (make-brackets stencils indices acc)
+    (if (and stencils
+            (pair? indices)
+            (pair? (cdr indices)))
+       (let*
+           ((encl (sublist stencils (car indices) (cadr indices)))
+            (x-ext (stencil-list-extent encl X))
+            (y-ext (stencil-list-extent encl Y))
+            (thick 0.10)
+            (pad 0.35)
+            (protusion (* 2.5 thick))
+            (lb
+             (ly:stencil-translate-axis 
+              (ly:bracket Y y-ext thick protusion)
+              (- (car x-ext) pad) X))
+            (rb (ly:stencil-translate-axis
+                 (ly:bracket Y y-ext thick (- protusion))
+                 (+ (cdr x-ext) pad) X))
+            )
+
+         (make-brackets
+          stencils (cddr indices)
+          (append
+           (list lb rb)
+            acc)))
+       acc))
+
+  (let*
+      ((stencils
+       (map (lambda (x)
+              (interpret-markup
+               paper
+               props
+               x)) args))
+       (leading
+        (chain-assoc-get 'baseline-skip props))
+       (stacked (stack-stencils stencils 1.25 #f))
+       (brackets (make-brackets stacked indices '()))
+       )
+
+    (apply ly:stencil-add
+          (append stacked brackets)
+          )))
+
+
+            
+
+  
+  
+
+