;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; Copyright (C) 2006--2011 Erik Sandberg <mandolaerik@gmail.com>
+;;;; Copyright (C) 2006--2015 Erik Sandberg <mandolaerik@gmail.com>
;;;;
;;;; LilyPond is free software: you can redistribute it and/or modify
;;;; it under the terms of the GNU General Public License as published by
;;;; You should have received a copy of the GNU General Public License
;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
-;; TODO: use separate module for syntax
-;; constructors. Also create wrapper around the constructor?
-(defmacro define-ly-syntax (args . body)
- `(define-public ,args ,(cons 'begin body)))
-
-;; A ly-syntax constructor takes two extra parameters, parser and
-;; location. These are mainly used for reporting errors and
-;; warnings. This function is a syntactic sugar which uses the
-;; location arg to set the origin of the returned music object; this
-;; behaviour is usually desired
-(defmacro define-ly-syntax-loc (args . body)
- `(define-public ,args
- (let ((m ,(cons 'begin body)))
- (set! (ly:music-property m 'origin) ,(third args))
- m)))
-;; Like define-ly-syntax-loc, but adds parser and location
-;; parameters. Useful for simple constructors that don't need to
-;; report errors.
-(defmacro define-ly-syntax-simple (args . body)
- `(define-public ,(cons* (car args)
- 'parser
- 'location
- (cdr args))
- (let ((m ,(cons 'begin body)))
- (set! (ly:music-property m 'origin) location)
- m)))
+(define-module (scm ly-syntax-constructors)
+ #:use-module (lily)
+ #:use-module (srfi srfi-1)
+ #:use-module (scm display-lily))
+
+(define-public (music-function-call-error fun m)
+ (let* ((sigcar (car (ly:music-function-signature fun)))
+ (pred? (if (pair? sigcar) (car sigcar) sigcar)))
+ (ly:parser-error
+ (format #f (_ "~a function cannot return ~a")
+ (type-name pred?)
+ (value->lily-string m))
+ (*location*))
+ (and (pair? sigcar)
+ (if (ly:music? (cdr sigcar))
+ (ly:music-deep-copy (cdr sigcar) (*location*))
+ (cdr sigcar)))))
;; Music function: Apply function and check return value.
-(define-ly-syntax (music-function parser loc pred fun args)
- (let ((m (apply fun parser loc args)))
- (if (ly:music? m)
- (set! (ly:music-property m 'origin) loc))
- (if (pred m)
- m
- (cond ((eq? pred ly:music?)
- (ly:parser-error parser (_ "Music syntax function must return Music object") loc)
- (make-music 'Music 'origin loc))
- (else
- (ly:parser-error parser
- (format #f (_ "Scheme function must return ~a object") (type-name pred))
- loc)
- #f)))))
-
-(define-ly-syntax-simple (void-music)
- (make-music 'Music))
-
-(define-ly-syntax-simple (sequential-music mlist)
- (make-sequential-music mlist))
-
-(define-ly-syntax-simple (simultaneous-music mlist)
- (make-simultaneous-music mlist))
-
-(define-ly-syntax-simple (event-chord mlist)
- (make-music 'EventChord
- 'elements mlist))
-
-(define-ly-syntax-simple (unrelativable-music mus)
- (make-music 'UnrelativableMusic
- 'element mus))
-
-(define-ly-syntax-simple (context-change type id)
- (make-music 'ContextChange
- 'change-to-type type
- 'change-to-id id))
-
-(define-ly-syntax-simple (voice-separator)
- (make-music 'VoiceSeparator))
-
-(define-ly-syntax-simple (bar-check)
- (make-music 'BarCheck))
-
-(define-ly-syntax-simple (time-scaled-music fraction music)
- (make-music 'TimeScaledMusic
- 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
- 'numerator (car fraction)
- 'denominator (cdr fraction)))
-
-(define-ly-syntax (tempo parser location text . rest)
+;; args are in reverse order.
+;;
+;; If args is not a proper list, an error has been flagged earlier
+;; and no fallback value had been available. In this case,
+;; we don't call the function but rather return the general
+;; fallback.
+(define-public (music-function fun args)
+ (let* ((sigcar (car (ly:music-function-signature fun)))
+ (pred? (if (pair? sigcar) (car sigcar) sigcar))
+ (good (list? args))
+ (m (and good (apply (ly:music-function-extract fun) (reverse! args)))))
+ (if good
+ (if (pred? m)
+ (if (ly:music? m) (ly:set-origin! m) m)
+ (music-function-call-error fun m))
+ (and (pair? sigcar)
+ (if (ly:music? (cdr sigcar))
+ (ly:music-deep-copy (cdr sigcar) (*location*))
+ (cdr sigcar))))))
+
+(define-public (argument-error n pred arg)
+ (ly:parser-error
+ (format #f
+ (_ "wrong type for argument ~a. Expecting ~a, found ~s")
+ n (type-name pred) (music->make-music arg))
+ (*location*)))
+
+;; Used for chaining several music functions together. `final'
+;; contains the last argument and still needs typechecking.
+(define (music-function-chain call final)
+ (let* ((fun (car call))
+ (siglast (last (ly:music-function-signature fun)))
+ (pred? (if (pair? siglast) (car siglast) siglast)))
+ (if (pred? final)
+ (music-function fun (cons final (cdr call)))
+ (begin
+ (argument-error (length call) pred? final)
+ ;; call music function just for the error return value
+ (music-function fun #f)))))
+
+(define-public (partial-music-function call-list)
+ (let* ((good (every list? call-list))
+ (sig (ly:music-function-signature (caar call-list))))
+ (and good
+ (ly:make-music-function
+ (cons (car sig) (list-tail sig (length (car call-list))))
+ (lambda rest
+ ;; Every time we use music-function, it destructively
+ ;; reverses its list of arguments. Changing the calling
+ ;; convention would be non-trivial since we do error
+ ;; propagation to the reversed argument list by making it
+ ;; a non-proper list. So we just create a fresh copy of
+ ;; all argument lists for each call. We also want to
+ ;; avoid reusing any music expressions without copying and
+ ;; want to let them point to the location of the music
+ ;; function call rather than its definition.
+ (let ((call-list (ly:music-deep-copy call-list (*location*))))
+ (fold music-function-chain
+ (music-function (caar call-list)
+ (reverse! rest (cdar call-list)))
+ (cdr call-list))))))))
+
+(define-public (void-music)
+ (ly:set-origin! (make-music 'Music)))
+
+(define-public (sequential-music mlist)
+ (ly:set-origin! (make-sequential-music mlist)))
+
+(define-public (simultaneous-music mlist)
+ (ly:set-origin! (make-simultaneous-music mlist)))
+
+(define-public (event-chord mlist)
+ (ly:set-origin! (make-music 'EventChord
+ 'elements mlist)))
+
+(define-public (unrelativable-music mus)
+ (ly:set-origin! (make-music 'UnrelativableMusic
+ 'element mus)))
+
+(define-public (context-change type id)
+ (ly:set-origin! (make-music 'ContextChange
+ 'change-to-type type
+ 'change-to-id id)))
+
+(define-public (tempo text . rest)
(let* ((unit (and (pair? rest)
- (car rest)))
- (count (and unit
- (cadr rest)))
- (range-tempo? (pair? count))
- (tempo-change (make-music 'TempoChangeEvent
- 'origin location
- 'text text
- 'tempo-unit unit
- 'metronome-count count))
- (tempo-set
- (and unit
- (context-spec-music
- (make-property-set 'tempoWholesPerMinute
- (ly:moment-mul
- (ly:make-moment
- (if range-tempo?
- (round (/ (+ (car count) (cdr count))
- 2))
- count)
- 1)
- (ly:duration-length unit)))
- 'Score))))
+ (car rest)))
+ (count (and unit
+ (cadr rest)))
+ (range-tempo? (pair? count))
+ (tempo-change (ly:set-origin! (make-music 'TempoChangeEvent
+ 'text text
+ 'tempo-unit unit
+ 'metronome-count count)))
+ (tempo-set
+ (and unit
+ (context-spec-music
+ (make-property-set 'tempoWholesPerMinute
+ (ly:moment-mul
+ (ly:make-moment
+ (if range-tempo?
+ (round (/ (+ (car count) (cdr count))
+ 2))
+ count)
+ 1)
+ (ly:duration-length unit)))
+ 'Score))))
(if tempo-set
- (make-sequential-music (list tempo-change tempo-set))
- tempo-change)))
+ (make-sequential-music (list tempo-change tempo-set))
+ tempo-change)))
-(define-ly-syntax-simple (repeat type num body alts)
- (make-repeat type num body alts))
+(define-public (repeat type num body alts)
+ (ly:set-origin! (make-repeat type num body alts)))
(define (script-to-mmrest-text music)
"Extract @code{'direction} and @code{'text} from @var{music}, and transform
into a @code{MultiMeasureTextEvent}."
- (if (memq 'script-event (ly:music-property music 'types))
- (let* ((location (ly:music-property music 'origin))
- (dir (ly:music-property music 'direction))
- (tags (ly:music-property music 'tags))
- (p (make-music 'MultiMeasureTextEvent
- 'origin location
- 'tags tags
- 'text (ly:music-property music 'text))))
- (if (ly:dir? dir)
- (set! (ly:music-property p 'direction) dir))
- p)
+ (if (music-is-of-type? music 'script-event)
+ (make-music 'MultiMeasureTextEvent music)
music))
-(define-ly-syntax (multi-measure-rest parser location duration articulations)
- (make-music 'MultiMeasureRestMusic
- 'articulations (map script-to-mmrest-text articulations)
- 'duration duration
- 'origin location))
-
-(define-ly-syntax (repetition-chord parser location previous-chord repetition-function duration articulations)
- (make-music 'RepeatedChord
- 'original-chord previous-chord
- 'element (repetition-function previous-chord location duration articulations)
- 'origin location))
-
-(define-ly-syntax-simple (context-specification type id mus ops create-new)
- (let* ((type-sym (if (symbol? type) type (string->symbol type)))
- (csm (context-spec-music mus type-sym id)))
+(define-public (multi-measure-rest duration articulations)
+ (ly:set-origin! (make-music 'MultiMeasureRestMusic
+ 'articulations (map script-to-mmrest-text articulations)
+ 'duration duration)))
+
+(define-public (repetition-chord duration articulations)
+ (ly:set-origin! (make-music 'EventChord
+ 'duration duration
+ 'elements articulations)))
+
+(define-public (context-specification type id ops create-new mus)
+ (let ((csm (context-spec-music mus type id)))
(set! (ly:music-property csm 'property-operations) ops)
(if create-new (set! (ly:music-property csm 'create-new) #t))
- csm))
-
-(define-ly-syntax (property-operation parser location once ctx music-type symbol . args)
- (let* ((props (case music-type
- ((PropertySet) (list 'value (car args)))
- ((PropertyUnset) '())
- ((OverrideProperty) (list 'grob-value (car args)
- 'grob-property-path (if (list? (cadr args))
- (cadr args)
- (cdr args))
- 'pop-first #t))
- ((RevertProperty)
- (if (list? (car args))
- (list 'grob-property-path (car args))
- (list 'grob-property-path args)))
- (else (ly:error (_ "Invalid property operation ~a") music-type))))
- (oprops (if once (cons* 'once once props) props))
- (m (apply make-music music-type
- 'symbol symbol
- 'origin location
- oprops)))
- (make-music 'ContextSpeccedMusic
- 'element m
- 'context-type ctx
- 'origin location)))
-
-;; TODO: It seems that this function rarely returns anything useful.
-(define (get-first-context-id type mus)
- "Find the name of a ContextSpeccedMusic with given type"
+ (ly:set-origin! csm)))
+
+(define-public (composed-markup-list commands markups)
+ ;; `markups' being a list of markups, eg (markup1 markup2 markup3),
+ ;; and `commands' a list of commands with their scheme arguments, in reverse order,
+ ;; eg: ((italic) (raise 4) (bold)), maps the commands on each markup argument, eg:
+ ;; ((bold (raise 4 (italic markup1)))
+ ;; (bold (raise 4 (italic markup2)))
+ ;; (bold (raise 4 (italic markup3))))
+
+ (define (compose arg)
+ (fold
+ (lambda (cmd prev) (append cmd (list prev)))
+ arg
+ commands))
+ (let loop ((markups markups) (completed '()))
+ (cond ((null? markups) (reverse! completed))
+ ((markup? (car markups))
+ (loop (cdr markups)
+ (cons (compose (car markups)) completed)))
+ (else
+ (call-with-values
+ (lambda () (break! markup? markups))
+ (lambda (complex rest)
+ (loop rest
+ (reverse!
+ (make-map-markup-commands-markup-list
+ compose complex) completed))))))))
+
+(define-public (partial-markup commands)
+ ;; Like composed-markup-list, except that the result is a single
+ ;; markup command that can be applied to one markup
+ (define (compose rest)
+ (fold
+ (lambda (cmd prev) (append cmd (list prev)))
+ (append (car commands) rest)
+ (cdr commands)))
+ (let ((chain (lambda (layout props . rest)
+ (interpret-markup layout props (compose rest)))))
+ (set! (markup-command-signature chain)
+ (list-tail
+ (markup-command-signature (caar commands))
+ (length (cdar commands))))
+ chain))
+
+(define-public (property-set context property value)
+ (ly:set-origin! (context-spec-music
+ (ly:set-origin!
+ (make-music 'PropertySet
+ 'symbol property
+ 'value value))
+ context)))
+
+(define-public (property-unset context property)
+ (ly:set-origin! (context-spec-music
+ (ly:set-origin!
+ (make-music 'PropertyUnset
+ 'symbol property))
+ context)))
+
+(define-public (property-override context path value)
+ (ly:set-origin! (context-spec-music
+ (ly:set-origin!
+ (make-music 'OverrideProperty
+ 'symbol (car path)
+ 'grob-property-path (cdr path)
+ 'grob-value value
+ 'pop-first #t))
+ context)))
+
+(define-public (property-revert context path)
+ (ly:set-origin! (context-spec-music
+ (ly:set-origin!
+ (make-music 'RevertProperty
+ 'symbol (car path)
+ 'grob-property-path (cdr path)))
+ context)))
+
+;; The signature here is slightly fishy since the "fallback return
+;; value" is not actually music but #f. This used to be (void-music)
+;; but triggered "Parsed object should be dead" warnings for music
+;; objects outside of the current parser session/module. The called
+;; functions always deliver music and are used from the parser in a
+;; manner where only the last argument is provided from outside the
+;; parser, and its predicate "scheme?" is always true. So the
+;; fallback value will never get used and its improper type is no
+;; issue.
+(define-public property-override-function
+ (ly:make-music-function
+ (list (cons ly:music? #f) symbol? symbol-list? scheme?)
+ property-override))
+
+(define-public property-set-function
+ (ly:make-music-function
+ (list (cons ly:music? #f) symbol? symbol? scheme?)
+ property-set))
+
+(define (get-first-context-id! mus)
+ "Find the name of a ContextSpeccedMusic, possibly naming it"
(let ((id (ly:music-property mus 'context-id)))
- (if (and (eq? (ly:music-property mus 'type) 'ContextSpeccedMusic)
- (eq? (ly:music-property mus 'context-type) type)
- (string? id)
- (not (string-null? id)))
- id
- '())))
-
-(define unique-counter -1)
-(define (get-next-unique-voice-name)
- (set! unique-counter (1+ unique-counter))
- (call-with-output-string (lambda (p) (format p "uniqueContext~s" unique-counter))))
-
-(define (lyric-combine-music sync music loc)
+ (if (eq? (ly:music-property mus 'name) 'ContextSpeccedMusic)
+ (if (and (string? id)
+ (not (string-null? id)))
+ id
+ ;; We may reliably give a new context a unique name, but
+ ;; not an existing one
+ (if (ly:music-property mus 'create-new #f)
+ (let ((id (get-next-unique-voice-name)))
+ (set! (ly:music-property mus 'context-id) id)
+ id)
+ '()))
+ '())))
+
+(define-public (lyric-event text duration)
+ (ly:set-origin! (make-lyric-event text duration)))
+
+(define-public (lyric-combine sync sync-type music)
;; CompletizeExtenderEvent is added following the last lyric in MUSIC
;; to signal to the Extender_engraver that any pending extender should
;; be completed if the lyrics end before the associated voice.
(append! (ly:music-property music 'elements)
- (list (make-music 'CompletizeExtenderEvent)))
- (make-music 'LyricCombineMusic
- 'element music
- 'associated-context sync
- 'origin loc))
-
-(define-ly-syntax (lyric-combine parser location voice music)
- (lyric-combine-music voice music location))
-
-(define-ly-syntax (add-lyrics parser location music addlyrics-list)
- (let* ((existing-voice-name (get-first-context-id 'Voice music))
- (voice-name (if (string? existing-voice-name)
- existing-voice-name
- (get-next-unique-voice-name)))
- (voice (if (string? existing-voice-name)
- (music)
- (make-music 'ContextSpeccedMusic
- 'element music
- 'context-type 'Voice
- 'context-id voice-name
- 'origin (ly:music-property music 'origin))))
- (lyricstos (map (lambda (mus)
- (let* ((loc (ly:music-property mus 'origin))
- (lyr (lyric-combine-music voice-name mus loc)))
- (make-music 'ContextSpeccedMusic
- 'create-new #t
- 'context-type 'Lyrics
- 'element lyr
- 'origin loc)))
- addlyrics-list)))
- (make-simultaneous-music (cons voice lyricstos))))
+ (list (make-music 'CompletizeExtenderEvent)))
+ (ly:set-origin!
+ (make-music 'LyricCombineMusic
+ 'element music
+ 'associated-context sync
+ 'associated-context-type sync-type)))
-(define-ly-syntax (make-mark-set parser location label)
- "Make the music for the \\mark command."
- (let* ((set (and (integer? label)
- (context-spec-music (make-property-set 'rehearsalMark label)
- 'Score)))
- (ev (make-music 'MarkEvent
- 'origin location)))
-
- (if set
- (make-sequential-music (list set ev))
- (begin
- (set! (ly:music-property ev 'label) label)
- ev))))
+(define-public (add-lyrics music addlyrics-list)
+ (let* ((existing-voice-name (get-first-context-id! music))
+ (voice-name (if (string? existing-voice-name)
+ existing-voice-name
+ (get-next-unique-voice-name)))
+ (voice (if (string? existing-voice-name)
+ music
+ (make-music 'ContextSpeccedMusic
+ 'element music
+ 'context-type 'Voice
+ 'context-id voice-name
+ 'origin (ly:music-property music 'origin))))
+ (voice-type (ly:music-property voice 'context-type))
+ (lyricstos (map
+ (lambda (mus+mods)
+ (with-location
+ (ly:music-property (car mus+mods) 'origin)
+ (ly:set-origin! (make-music 'ContextSpeccedMusic
+ 'create-new #t
+ 'context-type 'Lyrics
+ 'property-operations (cdr mus+mods)
+ 'element
+ (lyric-combine
+ voice-name voice-type
+ (car mus+mods))))))
+ addlyrics-list)))
+ (make-simultaneous-music (cons voice lyricstos))))
projects / lilypond.git / blobdiff