scm/markup.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 2003--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   4 ;;;;
   5 ;;;; LilyPond is free software: you can redistribute it and/or modify
   6 ;;;; it under the terms of the GNU General Public License as published by
   7 ;;;; the Free Software Foundation, either version 3 of the License, or
   8 ;;;; (at your option) any later version.
   9 ;;;;
  10 ;;;; LilyPond is distributed in the hope that it will be useful,
  11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 ;;;; GNU General Public License for more details.
  14 ;;;;
  15 ;;;; You should have received a copy of the GNU General Public License
  16 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 (defmacro*-public markup (#:rest body)
  19   "The `markup' macro provides a lilypond-like syntax for building markups.
  20
  21  - #:COMMAND is used instead of \\COMMAND
  22  - #:line ( ... ) is used instead of \\line { ... }
  23  - etc.
  24
  25 Example:
  26   \\markup { foo
  27             \\raise #0.2 \\hbracket \\bold bar
  28             \\override #'(baseline-skip . 4)
  29             \\bracket \\column { baz bazr bla }
  30   }
  31          <==>
  32   (markup \"foo\"
  33           #:raise 0.2 #:hbracket #:bold \"bar\"
  34           #:override '(baseline-skip . 4)
  35           #:bracket #:column (\"baz\" \"bazr\" \"bla\"))"
  36
  37   (car (compile-all-markup-expressions `(#:line ,body))))
  38
  39 ;; utility
  40
  41 (define (markup-join markups sep)
  42   "Return line-markup of MARKUPS, joining them with markup SEP"
  43   (if (pair? markups)
  44       (make-line-markup (list-insert-separator markups sep))
  45       empty-markup))
  46
  47
  48 (define-public interpret-markup ly:text-interface::interpret-markup)
  49
  50 (define-public (interpret-markup-list layout props markup-list)
  51   ;; This relies on the markup list returned by a markup list command
  52   ;; to be modifiable
  53   (reverse!
  54    (fold
  55     (lambda (m prev)
  56       (if (markup-command-list? m)
  57           (reverse! (apply (car m) layout props (cdr m)) prev)
  58           (cons (interpret-markup layout props m) prev)))
  59     '()
  60     markup-list)))
  61
  62 (define-public (prepend-alist-chain key val chain)
  63   (cons (acons key val (car chain)) (cdr chain)))
  64
  65 (define-public (stack-stencil-line space stencils)
  66   "Adjoin a list of @var{stencils} along the X axis, leaving
  67 @var{space} between the end of each stencil and the beginning of the
  68 following stencil.  Stencils with empty Y extent are not given
  69 @var{space} before them and don't avoid overlapping other stencils."
  70   (stack-stencils X RIGHT space (filter ly:stencil? stencils)))
  71
  72 ;;; convert a full markup object to an approximate pure string representation
  73
  74 (define-public (markup->string m . argscopes)
  75   (let* ((scopes (if (pair? argscopes) (car argscopes) '())))
  76     ;; markup commands with one markup argument, formatting ignored
  77     (define markups-first-argument '(list
  78                                      bold-markup box-markup caps-markup dynamic-markup finger-markup
  79                                      fontCaps-markup huge-markup italic-markup large-markup larger-markup
  80                                      medium-markup normal-size-sub-markup normal-size-super-markup
  81                                      normal-text-markup normalsize-markup number-markup roman-markup
  82                                      sans-markup simple-markup small-markup smallCaps-markup smaller-markup
  83                                      sub-markup super-markup teeny-markup text-markup tiny-markup
  84                                      typewriter-markup underline-markup upright-markup bracket-markup
  85                                      circle-markup hbracket-markup parenthesize-markup rounded-box-markup
  86
  87                                      center-align-markup center-column-markup column-markup dir-column-markup
  88                                      fill-line-markup justify-markup justify-string-markup left-align-markup
  89                                      left-column-markup line-markup right-align-markup right-column-markup
  90                                      vcenter-markup wordwrap-markup wordwrap-string-markup ))
  91
  92     ;; markup commands with markup as second argument, first argument
  93     ;; specifies some formatting and is ignored
  94     (define markups-second-argument '(list
  95                                       abs-fontsize-markup fontsize-markup magnify-markup lower-markup
  96                                       pad-around-markup pad-markup-markup pad-x-markup raise-markup
  97                                       halign-markup hcenter-in-markup rotate-markup translate-markup
  98                                       translate-scaled-markup with-url-markup scale-markup ))
  99
 100     ;; helper functions to handle string cons like string lists
 101     (define (markup-cons->string-cons c scopes)
 102       (if (not (pair? c)) (markup->string c scopes)
 103           (cons (markup->string (car c) scopes) (markup-cons->string-cons (cdr c) scopes))))
 104     (define (string-cons-join c)
 105       (if (not (pair? c)) c
 106           (string-join (list (car c) (string-cons-join (cdr c))) "")))
 107
 108     (cond
 109      ((string? m) m)
 110      ((null? m) "")
 111      ((not (pair? m)) "")
 112
 113      ;; handle \concat (string-join without spaces)
 114      ((and (pair? m) (equal? (car m) concat-markup))
 115       (string-cons-join (markup-cons->string-cons (cadr m) scopes)) )
 116
 117      ;; markup functions with the markup as first arg
 118      ((member (car m) (primitive-eval markups-first-argument))
 119       (markup->string (cadr m) scopes))
 120
 121      ;; markup functions with markup as second arg
 122      ((member (car m) (primitive-eval markups-second-argument))
 123       (markup->string (cddr m) scopes))
 124
 125      ;; fromproperty-markup reads property values from the header block:
 126      ((equal? (car m) fromproperty-markup)
 127       (let* ((varname (symbol->string (cadr m)))
 128              ;; cut off the header: prefix from the variable name:
 129              (newvarname (if (string-prefix? "header:" varname) (substring varname 7) varname))
 130              (var (string->symbol newvarname))
 131              (mod (make-module 1)))
 132         ;; Prevent loops by temporarily clearing the variable we have just looked up
 133         (module-define! mod var "")
 134         (markup->string (ly:modules-lookup scopes var) (cons mod scopes))))
 135
 136      ;; ignore all other markup functions
 137      ((markup-function? (car m)) "")
 138
 139      ;; handle markup lists
 140      ((list? m)
 141       (string-join (map (lambda (mm) (markup->string mm scopes)) m) " "))
 142
 143      (else "ERROR, unable to extract string from markup"))))