-(define-public (simple-markup grob props . rest)
- (Text_item::text_to_molecule grob props (car rest))
- )
-
-(define-public (stack-molecule-line space molecules)
- (if (pair? molecules)
- (if (pair? (cdr molecules))
- (let* (
- (tail (stack-molecule-line space (cdr molecules)))
- (head (car molecules))
- (xoff (+ space (cdr (ly:get-molecule-extent head X))))
- )
-
- (ly:add-molecule
- head
- (ly:molecule-translate-axis tail xoff X))
- )
- (car molecules))
- '())
- )
-
-(define-public (line-markup grob props . rest)
- (stack-molecule-line
- (cdr (chain-assoc 'word-space props))
- (map (lambda (x) (interpret-markup grob props x)) (car rest)))
- )
-
-(define (combine-molecule-list lst)
- (if (null? (cdr lst)) (car lst)
- (ly:add-molecule (car lst) (combine-molecule-list (cdr lst)))
- ))
-
-(define-public (combine-markup grob props . rest)
- (ly:add-molecule
- (interpret-markup grob props (car rest))
- (interpret-markup grob props (cadr rest))))
+;;;; new-markup.scm --
+;;;;
+;;;; source file of the GNU LilyPond music typesetter
+;;;;
+;;;; (c) 2003--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+
+"
+Internally markup is stored as lists, whose head is a function.
+
+ (FUNCTION ARG1 ARG2 ... )
+
+When the markup is formatted, then FUNCTION is called as follows
+
+ (FUNCTION GROB PROPS ARG1 ARG2 ... )
+
+GROB is the current grob, PROPS is a list of alists, and ARG1.. are
+the rest of the arguments.
+
+The function should return a stencil (i.e. a formatted, ready to
+print object).
+
+
+To add a function, use the def-markup-command utility.
+
+ (def-markup-command (mycommand layout prop arg1 ...) (arg1-type? ...)
+ \"my command usage and description\"
+ ...function body...)
+
+The command is now available in markup mode, e.g.
+
+
+ \\markup { .... \\MYCOMMAND #1 argument ... }
+
+" ; "
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;; markup definer utilities
+;;; `def-markup-command' can be used both for built-in markup
+;;; definitions and user defined markups.
+
+(defmacro-public def-markup-command (command-and-args signature . body)
+ "
+
+* Define a COMMAND-markup function after command-and-args and body,
+register COMMAND-markup and its signature,
+
+* add COMMAND-markup to markup-function-list,
+
+* sets COMMAND-markup markup-signature and markup-keyword object properties,
+
+* define a make-COMMAND-markup function.
+
+Syntax:
+ (def-markup-command (COMMAND layout props arg1 arg2 ...) (arg1-type? arg2-type? ...)
+ \"documentation string\"
+ ...command body...)
+ or:
+ (def-markup-command COMMAND (arg1-type? arg2-type? ...)
+ function)
+"
+ (let* ((command (if (pair? command-and-args) (car command-and-args) command-and-args))
+ (args (if (pair? command-and-args) (cdr command-and-args) '()))
+ (command-name (string->symbol (string-append (symbol->string command) "-markup")))
+ (make-markup-name (string->symbol (string-append "make-" (symbol->string command-name)))))
+ `(begin
+ (define-public ,(if (pair? args)
+ (cons command-name args)
+ command-name)
+ ,@body)
+ (set! (markup-command-signature ,command-name) (list ,@signature))
+ (if (not (member ,command-name markup-function-list))
+ (set! markup-function-list (cons ,command-name markup-function-list)))
+ (define-public (,make-markup-name . args)
+ (let ((sig (list ,@signature)))
+ (make-markup ,command-name ,(symbol->string make-markup-name) sig args))))))
+
+(define-public (make-markup markup-function make-name signature args)
+ " Construct a markup object from MARKUP-FUNCTION and ARGS. Typecheck
+against SIGNATURE, reporting MAKE-NAME as the user-invoked function.
+"
+ (let* ((arglen (length args))
+ (siglen (length signature))
+ (error-msg (if (and (> siglen 0) (> arglen 0))
+ (markup-argument-list-error signature args 1)
+ #f)))
+ (if (or (not (= arglen siglen)) (< siglen 0) (< arglen 0))
+ (scm-error 'markup-format make-name
+ "Expect ~A arguments for ~A. Found ~A: ~S"
+ (list siglen make-name arglen args)
+ #f))
+ (if error-msg
+ (scm-error 'markup-format make-name
+ "Invalid argument in position ~A\nExpect: ~A\nFound: ~S."
+ error-msg #f)
+ (cons markup-function args))))
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;; markup constructors
+;;; lilypond-like syntax for markup construction in scheme.
+
+(use-modules (ice-9 optargs)
+ (ice-9 receive))
+
+(defmacro*-public markup (#:rest body)
+ "The `markup' macro provides a lilypond-like syntax for building markups.
+
+ - #:COMMAND is used instead of \\COMMAND
+ - #:lines ( ... ) is used instead of { ... }
+ - #:center-align ( ... ) is used instead of \\center-align < ... >
+ - etc.
+
+Example:
+ \\markup { foo
+ \\raise #0.2 \\hbracket \\bold bar
+ \\override #'(baseline-skip . 4)
+ \\bracket \\column < baz bazr bla >
+ }
+ <==>
+ (markup \"foo\"
+ #:raise 0.2 #:hbracket #:bold \"bar\"
+ #:override '(baseline-skip . 4)
+ #:bracket #:column (\"baz\" \"bazr\" \"bla\"))
+Use `markup*' in a \\notes block."
-; (combine-molecule-list (map (lambda (x) (interpret-markup grob props x)) (car rest))))
+ (car (compile-all-markup-expressions `(#:line ,body))))
-(define (font-markup qualifier value)
- (lambda (grob props . rest)
- (interpret-markup grob (cons (cons `(,qualifier . ,value) (car props)) (cdr props)) (car rest))
+(defmacro*-public markup* (#:rest body)
+ "Same as `markup', for use in a \\notes block."
+ `(ly:export (markup ,@body)))
- ))
-
-
-(define-public (set-property-markup qualifier)
- (lambda (grob props . rest )
- (interpret-markup grob
- (cons (cons `(,qualifier . ,(car rest))
- (car props)) (cdr props))
- (cadr rest))
- ))
-
-
-(define-public fontsize-markup (set-property-markup 'font-relative-size))
-(define-public magnify-markup (set-property-markup 'font-magnification))
-
-(define-public bold-markup
- (font-markup 'font-series 'bold))
-(define-public number-markup
- (font-markup 'font-family 'number))
-
-
-(define-public huge-markup
- (font-markup 'font-relative-size 2))
-(define-public large-markup
- (font-markup 'font-relative-size 1))
-(define-public small-markup
- (font-markup 'font-relative-size -1))
-(define-public tiny-markup
- (font-markup 'font-relative-size -2))
-(define-public teeny-markup
- (font-markup 'font-relative-size -3))
-(define-public dynamic-markup
- (font-markup 'font-family 'dynamic))
-(define-public italic-markup
- (font-markup 'font-shape 'italic))
-
-
-;; TODO: baseline-skip should come from the font.
-(define-public (column-markup grob props . rest)
- (stack-lines
- -1 0.0 (cdr (chain-assoc 'baseline-skip props))
- (map (lambda (x) (interpret-markup grob props x)) (car rest)))
- )
-
-(define-public (musicglyph-markup grob props . rest)
- (ly:find-glyph-by-name
- (ly:get-font grob (cons '((font-family . music)) props))
- (car rest))
- )
-
-(define-public (lookup-markup grob props . rest)
- "Lookup a glyph by name."
- (ly:find-glyph-by-name
- (ly:get-font grob props)
- (car rest))
- )
-
-(define-public (char-markup grob props . rest)
- "Syntax: \\char NUMBER. "
- (ly:get-glyph (ly:get-font grob props) (car rest))
- )
-
-(define-public (raise-markup grob props . rest)
- "Syntax: \\raise AMOUNT MARKUP. "
- (ly:molecule-translate-axis (interpret-markup
- grob
- props
- (cadr rest))
- (car rest) Y)
- )
-
-(define-public (normal-size-superscript-markup grob props . rest)
- (ly:molecule-translate-axis (interpret-markup
- grob
- props (car rest))
- (* 0.5 (cdr (chain-assoc 'baseline-skip props)))
- Y)
- )
-
-(define-public (super-markup grob props . rest)
- "Syntax: \\super MARKUP. "
- (ly:molecule-translate-axis (interpret-markup
- grob
- (cons '((font-relative-size . -2)) props) (car rest))
- (* 0.5 (cdr (chain-assoc 'baseline-skip props)))
- Y)
- )
-
-(define-public (translate-markup grob props . rest)
- "Syntax: \\translate OFFSET MARKUP. "
- (ly:molecule-translate (interpret-markup grob props (cadr rest))
- (car rest))
-
- )
-
-(define-public (sub-markup grob props . rest)
- "Syntax: \\sub MARKUP."
- (ly:molecule-translate-axis (interpret-markup
- grob
- (cons '((font-relative-size . -2)) props)
- (car rest))
- (* -0.5 (cdr (chain-assoc 'baseline-skip props)))
- Y)
- )
-
-;; todo: fix negative space
-(define (hspace-markup grob props . rest)
- "Syntax: \\hspace NUMBER."
- (let*
- ((amount (car rest)))
- (if (> amount 0)
- (ly:make-molecule "" (cons 0 amount) '(-1 . 1) )
- (ly:make-molecule "" (cons amount amount) '(-1 . 1)))
- ))
-
-(define-public (override-markup grob props . rest)
- "Tack the 1st args in REST onto PROPS."
- (interpret-markup grob (cons (list (car rest)) props)
- (cadr rest)))
-
-(map (lambda (x)
- (set-object-property! (car x) 'markup-signature (cdr x))
- )
- (list
- (cons bold-markup 'markup0)
- (cons teeny-markup 'markup0)
- (cons tiny-markup 'markup0)
- (cons small-markup 'markup0)
- (cons italic-markup 'markup0)
- (cons dynamic-markup 'markup0)
- (cons large-markup 'markup0)
- (cons huge-markup 'markup0)
- (cons sub-markup 'markup0)
- (cons super-markup 'markup0)
- (cons number-markup 'markup0)
- (cons column-markup 'markup-list0)
- (cons line-markup 'markup-list0)
- (cons combine-markup 'markup0-markup1)
- (cons simple-markup 'markup0)
- (cons musicglyph-markup 'scm0)
- (cons translate-markup 'scm0-markup1)
- (cons override-markup 'scm0-markup1)
- (cons lookup-markup 'scm0)
- (cons raise-markup 'scm0-markup1)
- (cons char-markup 'scm0)
- (cons hspace-markup 'scm0)
- (cons magnify-markup 'scm0-markup1)
- (cons fontsize-markup 'scm0-markup1)
- (cons translate-markup 'scm0-markup1)
- ))
-
-(define markup-module (current-module))
+
+(define (compile-all-markup-expressions expr)
+ "Return a list of canonical markups expressions, e.g.:
+ (#:COMMAND1 arg11 arg12 #:COMMAND2 arg21 arg22 arg23)
+ ===>
+ ((make-COMMAND1-markup arg11 arg12)
+ (make-COMMAND2-markup arg21 arg22 arg23) ...)"
+ (do ((rest expr rest)
+ (markps '() markps))
+ ((null? rest) (reverse markps))
+ (receive (m r) (compile-markup-expression rest)
+ (set! markps (cons m markps))
+ (set! rest r))))
+
+(define (keyword->make-markup key)
+ "Transform a keyword, e.g. #:COMMAND, in a make-COMMAND-markup symbol."
+ (string->symbol (string-append "make-" (symbol->string (keyword->symbol key)) "-markup")))
+
+(define (compile-markup-expression expr)
+ "Return two values: the first complete canonical markup expression found in `expr',
+e.g. (make-COMMAND-markup arg1 arg2 ...), and the rest expression."
+ (cond ((and (pair? expr)
+ (keyword? (car expr)))
+ ;; expr === (#:COMMAND arg1 ...)
+ (let* ((command (symbol->string (keyword->symbol (car expr))))
+ (sig (markup-command-signature (car (lookup-markup-command command))))
+ (sig-len (length sig)))
+ (do ((i 0 (1+ i))
+ (args '() args)
+ (rest (cdr expr) rest))
+ ((>= i sig-len)
+ (values (cons (keyword->make-markup (car expr)) (reverse args)) rest))
+ (cond ((eqv? (list-ref sig i) markup-list?)
+ ;; (car rest) is a markup list
+ (set! args (cons `(list ,@(compile-all-markup-expressions (car rest))) args))
+ (set! rest (cdr rest)))
+ (else
+ ;; pick up one arg in `rest'
+ (receive (a r) (compile-markup-arg rest)
+ (set! args (cons a args))
+ (set! rest r)))))))
+ ((and (pair? expr)
+ (pair? (car expr))
+ (keyword? (caar expr)))
+ ;; expr === ((#:COMMAND arg1 ...) ...)
+ (receive (m r) (compile-markup-expression (car expr))
+ (values m (cdr expr))))
+ ((and (pair? expr)
+ (string? (car expr))) ;; expr === ("string" ...)
+ (values `(make-simple-markup ,(car expr)) (cdr expr)))
+ (else
+ ;; expr === (symbol ...) or ((funcall ...) ...)
+ (values (car expr)
+ (cdr expr)))))
+
+(define (compile-all-markup-args expr)
+ "Transform `expr' into markup arguments"
+ (do ((rest expr rest)
+ (args '() args))
+ ((null? rest) (reverse args))
+ (receive (a r) (compile-markup-arg rest)
+ (set! args (cons a args))
+ (set! rest r))))
+
+(define (compile-markup-arg expr)
+ "Return two values: the desired markup argument, and the rest arguments"
+ (cond ((null? expr)
+ ;; no more args
+ (values '() '()))
+ ((keyword? (car expr))
+ ;; expr === (#:COMMAND ...)
+ ;; ==> build and return the whole markup expression
+ (compile-markup-expression expr))
+ ((and (pair? (car expr))
+ (keyword? (caar expr)))
+ ;; expr === ((#:COMMAND ...) ...)
+ ;; ==> build and return the whole markup expression(s)
+ ;; found in (car expr)
+ (receive (markup-expr rest-expr) (compile-markup-expression (car expr))
+ (if (null? rest-expr)
+ (values markup-expr (cdr expr))
+ (values `(list ,markup-expr ,@(compile-all-markup-args rest-expr))
+ (cdr expr)))))
+ ((and (pair? (car expr))
+ (pair? (caar expr)))
+ ;; expr === (((foo ...) ...) ...)
+ (values (cons 'list (compile-all-markup-args (car expr))) (cdr expr)))
+ (else (values (car expr) (cdr expr)))))
+
+;;;;;;;;;;;;;;;
+;;; Debugging utilities: print markup expressions in a friendly fashion
+
+(use-modules (ice-9 format))
+(define (markup->string markup-expr)
+ "Return a string describing, in LilyPond syntax, the given markup expression."
+ (define (proc->command proc)
+ (let ((cmd-markup (symbol->string (procedure-name proc))))
+ (substring cmd-markup 0 (- (string-length cmd-markup)
+ (string-length "-markup")))))
+ (define (arg->string arg)
+ (cond ((and (pair? arg) (pair? (car arg))) ;; markup list
+ (format #f "~{ ~a~}" (map markup->string arg)))
+ ((pair? arg) ;; markup
+ (markup->string arg))
+ ((string? arg) ;; scheme string argument
+ (format #f "#\"~a\"" arg))
+ (else ;; other scheme arg
+ (format #f "#~a" arg))))
+ (let ((cmd (car markup-expr))
+ (args (cdr markup-expr)))
+ (cond ((eqv? cmd simple-markup) ;; a simple string
+ (format #f "\"~a\"" (car args)))
+ ((eqv? cmd line-markup) ;; { ... }
+ (format #f "{~a}" (arg->string (car args))))
+ ((eqv? cmd center-align-markup) ;; \center < ... >
+ (format #f "\\center-align <~a>" (arg->string (car args))))
+ ((eqv? cmd column-markup) ;; \column < ... >
+ (format #f "\\column <~a>" (arg->string (car args))))
+ (else ;; \command ...
+ (format #f "\\~a~{ ~a~} " (proc->command cmd) (map arg->string args))))))
+
+(define-public (display-markup markup-expr)
+ "Print a LilyPond-syntax equivalent for the given markup expression."
+ (display "\\markup ")
+ (display (markup->string markup-expr)))
+
+;;;;;;;;;;;;;;;
+;;; Utilities for storing and accessing markup commands signature
+;;; and keyword.
+;;; Examples:
+;;;
+;;; (set! (markup-command-signature raise-markup) (list number? markup?))
+;;; ==> ((#<primitive-procedure number?> #<procedure markup? (obj)>) . scheme0-markup1)
+;;;
+;;; (markup-command-signature raise-markup)
+;;; ==> (#<primitive-procedure number?> #<procedure markup? (obj)>)
+;;;
+;;; (markup-command-keyword raise-markup) ==> "scheme0-markup1"
+;;;
+
+(define markup-command-signatures (make-hash-table 50))
+
+(define (markup-command-signature-ref markup-command)
+ "Return markup-command's signature, e.g. (number? markup?).
+markup-command may be a procedure."
+ (let ((sig-key (hashq-ref markup-command-signatures
+ markup-command)))
+ (if sig-key (car sig-key) #f)))
+
+(define-public (markup-command-keyword markup-command)
+ "Return markup-command's keyword, e.g. \"scheme0markup1\".
+markup-command may be a procedure."
+ (let ((sig-key (hashq-ref markup-command-signatures
+ markup-command)))
+ (if sig-key (cdr sig-key) #f)))
+
+(define (markup-command-signatureset! markup-command signature)
+ "Set markup-command's signature. markup-command must be a named procedure.
+Also set markup-signature and markup-keyword object properties."
+ (hashq-set! markup-command-signatures
+ markup-command
+ (cons signature (markup-signature-to-keyword signature)))
+ ;; these object properties are still in use somewhere
+ (set-object-property! markup-command 'markup-signature signature)
+ (set-object-property! markup-command 'markup-keyword (markup-signature-to-keyword signature)))
+
+(define-public markup-command-signature
+ (make-procedure-with-setter markup-command-signature-ref markup-command-signatureset!))
+
+(define (markup-symbol-to-proc markup-sym)
+ "Return the markup command procedure which name is `markup-sym', if any."
+ (hash-fold (lambda (key val prev)
+ (or prev
+ (if (eqv? (procedure-name key) markup-sym) key #f)))
+ #f
+ markup-command-signatures))
+
+(define-public markup-function-list '())
+
+(define-public (markup-signature-to-keyword sig)
+ " (A B C) -> a0-b1-c2 "
+ (if (null? sig)
+ 'empty
+ (string->symbol (string-join (map
+ (let* ((count 0))
+ (lambda (func)
+ (set! count (+ count 1))
+ (string-append
+ ;; for reasons I don't get,
+ ;; (case func ((markup?) .. )
+ ;; doesn't work.
+ (cond
+ ((eq? func markup?) "markup")
+ ((eq? func markup-list?) "markup-list")
+ (else "scheme"))
+ (number->string (- count 1)))))
+ sig)
+ "-"))))
(define-public (lookup-markup-command code)
- (let*
- ( (sym (string->symbol (string-append code "-markup")))
- (var (module-local-variable markup-module sym))
- )
- (if (eq? var #f)
- #f
- (cons (variable-ref var) (object-property (variable-ref var) 'markup-signature))
- )
- ))
-
-
-(define-public (brew-new-markup-molecule grob)
- (interpret-markup grob
- (Font_interface::get_property_alist_chain grob)
- (ly:get-grob-property grob 'text)
- )
- )
-
-(define (interpret-markup grob props markup)
- (let*
- (
- (func (car markup))
- (args (cdr markup))
- )
-
- (apply func (cons grob (cons props args)) )
- ))
-
-
-(define (new-markup? x)
- (markup-function? (car x))
-)
+ (let ((proc (markup-symbol-to-proc (string->symbol (string-append code "-markup")))))
+ (and proc (cons proc (markup-command-keyword proc)))))
+
+;;;;;;;;;;;;;;;;;;;;;;
+;;; markup type predicates
(define (markup-function? x)
- (object-property 'markup-signature? x))
+ (not (not (markup-command-signature x))))
+
+(define (markup-list? arg)
+ (define (markup-list-inner? l)
+ (or (null? l)
+ (and (markup? (car l)) (markup-list-inner? (cdr l)))))
+ (and (list? arg) (markup-list-inner? arg)))
+
+(define (markup-argument-list? signature arguments)
+ "Typecheck argument list."
+ (if (and (pair? signature) (pair? arguments))
+ (and ((car signature) (car arguments))
+ (markup-argument-list? (cdr signature) (cdr arguments)))
+ (and (null? signature) (null? arguments))))
+
+
+(define (markup-argument-list-error signature arguments number)
+ "return (ARG-NR TYPE-EXPECTED ARG-FOUND) if an error is detected, or
+#f is no error found.
+"
+ (if (and (pair? signature) (pair? arguments))
+ (if (not ((car signature) (car arguments)))
+ (list number (type-name (car signature)) (car arguments))
+ (markup-argument-list-error (cdr signature) (cdr arguments) (+ 1 number)))
+ #f))
+
+;;
+;; full recursive typecheck.
+;;
+(define (markup-typecheck? arg)
+ (or (string? arg)
+ (and (pair? arg)
+ (markup-function? (car arg))
+ (markup-argument-list? (markup-command-signature (car arg))
+ (cdr arg)))))
+
+;;
+;; typecheck, and throw an error when something amiss.
+;;
+(define (markup-thrower-typecheck arg)
+ (cond ((string? arg) #t)
+ ((not (pair? arg))
+ (throw 'markup-format "Not a pair" arg))
+ ((not (markup-function? (car arg)))
+ (throw 'markup-format "Not a markup function " (car arg)))
+ ((not (markup-argument-list? (markup-command-signature (car arg))
+ (cdr arg)))
+ (throw 'markup-format "Arguments failed typecheck for " arg)))
+ #t)
+
+;;
+;; good enough if you only use make-XXX-markup functions.
+;;
+(define (cheap-markup? x)
+ (or (string? x)
+ (and (pair? x)
+ (markup-function? (car x)))))
+
+;;
+;; replace by markup-thrower-typecheck for more detailed diagnostics.
+;;
+(define-public markup? cheap-markup?)
+
+;; utility
+
+(define (markup-join markups sep)
+ "Return line-markup of MARKUPS, joining them with markup SEP"
+ (if (pair? markups)
+ (make-line-markup (list-insert-separator markups sep))
+ empty-markup))
+
+(define-public brew-new-markup-stencil Text_interface::print)
+(define-public interpret-markup Text_interface::interpret_markup)
+(define-public (prepend-alist-chain key val chain)
+ (cons (acons key val (car chain)) (cdr chain)))
+
+
+
+
+(define-public (stack-stencil-line space stencils)
+ "DOCME"
+ (if (and (pair? stencils)
+ (ly:stencil? (car stencils)))
+
+ (if (and (pair? (cdr stencils))
+ (ly:stencil? (cadr stencils)))
+ (let* ((tail (stack-stencil-line space (cdr stencils)))
+ (head (car stencils))
+ (xoff (+ space (cdr (ly:stencil-extent head X)))))
+ (ly:stencil-add head
+ (ly:stencil-translate-axis tail xoff X)))
+ (car stencils))
+ (ly:make-stencil '() '(0 . 0) '(0 . 0))))
+
+
+
+
+
projects / lilypond.git / blobdiff