+
+"
+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 molecule (i.e. a formatted, ready to
+print object).
+
+
+
+To add a function,
+
+1. It should be named COMMAND-markup
+
+2. It should have an object property set that describes it's
+signature. This is to allow the parser to figure out how many
+arguments to expect:
+
+ (set-object-property! COMMAND-markup scm0-markup1)
+
+(insert in the list below).
+
+3. The command is now available in markup mode, e.g.
+
+
+ \markup { .... \COMMAND #1 argument ... }
+
+
+BUGS:
+
+At present, markup functions must be defined in this
+file. Implementing user-access for markup functions is an excercise
+for the reader.
+
+
+
+
+" ; "
+
(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))))
+ (xoff (+ space (cdr (ly:molecule-get-extent head X))))
)
- (ly:add-molecule
+ (ly:molecule-add
head
(ly:molecule-translate-axis tail xoff X))
)
(define (combine-molecule-list lst)
(if (null? (cdr lst)) (car lst)
- (ly:add-molecule (car lst) (combine-molecule-list (cdr lst)))
+ (ly:molecule-add (car lst) (combine-molecule-list (cdr lst)))
))
(define-public (combine-markup grob props . rest)
- (ly:add-molecule
+ (ly:molecule-add
(interpret-markup grob props (car rest))
(interpret-markup grob props (cadr rest))))
))
+(define-public (finger-markup grob props . rest)
+ (interpret-markup grob
+ (cons (list '(font-relative-size . -3)
+ '(font-family . number))
+ props)
+ (car rest)))
+
+
(define-public fontsize-markup (set-property-markup 'font-relative-size))
(define-public magnify-markup (set-property-markup 'font-magnification))
(font-markup 'font-series 'bold))
(define-public number-markup
(font-markup 'font-family 'number))
+(define-public roman-markup
+ (font-markup 'font-family 'roman))
(define-public huge-markup
(map (lambda (x) (interpret-markup grob props x)) (car rest)))
)
+(define-public (dir-column-markup grob props . rest)
+ "Make a column of args, going up or down, depending on DIRECTION."
+ (let*
+ (
+ (dir (cdr (chain-assoc 'direction props)))
+ )
+ (stack-lines
+ (if (number? dir) dir -1)
+ 0.0 (cdr (chain-assoc 'baseline-skip props))
+ (map (lambda (x) (interpret-markup grob props x)) (car rest)))
+ ))
+
+(define-public (center-markup grob props . rest)
+ (let*
+ (
+ (mols (map (lambda (x) (interpret-markup grob props x)) (car rest)))
+ (cmols (map (lambda (x) (ly:molecule-align-to! x X CENTER)) mols))
+ )
+
+ (stack-lines
+ -1 0.0 (cdr (chain-assoc 'baseline-skip props))
+ mols)
+ ))
+
(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
(car rest) Y)
)
-(define-public (normal-size-superscript-markup grob props . rest)
+(define-public (normal-size-super-markup grob props . rest)
(ly:molecule-translate-axis (interpret-markup
grob
props (car rest))
Y)
)
+(define-public (normal-size-sub-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 (hbracket-markup grob props . rest)
+ (let*
+ (
+ (th 0.1) ;; todo: take from GROB.
+ (m (interpret-markup grob props (car rest)))
+ )
+
+ (bracketify-molecule m X th (* 2.5 th) th)
+))
+
+(define-public (bracket-markup grob props . rest)
+ (let*
+ (
+ (th 0.1) ;; todo: take from GROB.
+ (m (interpret-markup grob props (car rest)))
+ )
+
+ (bracketify-molecule m Y th (* 2.5 th) th)
+))
+
+
;; todo: fix negative space
(define (hspace-markup grob props . rest)
"Syntax: \\hspace NUMBER."
))
(define-public (override-markup grob props . rest)
- "Tack the 1st args in REST onto PROPS."
+ "Tack the 1st arg in REST onto PROPS, e.g.
+
+\override #'(font-family . married) \"bla\"
+
+"
+
(interpret-markup grob (cons (list (car rest)) props)
(cadr rest)))
+(define-public (smaller-markup grob props . rest)
+ "Syntax: \\smaller MARKUP"
+ (let*
+ (
+ (fs (cdr (chain-assoc 'font-relative-size props)))
+ (entry (cons 'font-relative-size (- fs 1)))
+ )
+ (interpret-markup
+ grob (cons (list entry) props)
+ (car rest))
+ ))
+
+(define-public (bigger-markup grob props . rest)
+ "Syntax: \\bigger MARKUP"
+ (let*
+ (
+ (fs (cdr (chain-assoc 'font-relative-size props)))
+ (entry (cons 'font-relative-size (+ fs 1)))
+ )
+ (interpret-markup
+ grob (cons (list entry) props)
+ (car rest))
+ ))
+
+(define (markup-signature-to-keyword sig)
+ " (A B C) -> a0-b1-c2 "
+
+ (let* ((count 0))
+ (string->symbol (string-join
+
+ (map
+ (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 (markup-function? x)
+ (object-property x 'markup-signature)
+ )
+
+(define (markup-list? arg)
+ (define (markup-list-inner? l)
+ (if (null? l)
+ #t
+ (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?
+ (object-property (car arg) 'markup-signature)
+ (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?
+ (object-property (car arg) 'markup-signature)
+ (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 markup? cheap-markup?)
+
+(define markup-functions-and-signatures
+ (list
+
+ ;; abs size
+ (cons teeny-markup (list markup?))
+ (cons tiny-markup (list markup?))
+ (cons small-markup (list markup?))
+ (cons dynamic-markup (list markup?))
+ (cons large-markup (list markup?))
+
+ (cons huge-markup (list markup?))
+
+ ;; size
+ (cons smaller-markup (list markup?))
+ (cons bigger-markup (list markup?))
+
+ ;;
+ (cons sub-markup (list markup?))
+ (cons normal-size-sub-markup (list markup?))
+
+ (cons super-markup (list markup?))
+ (cons normal-size-super-markup (list markup?))
+
+ (cons finger-markup (list markup?))
+ (cons bold-markup (list markup?))
+ (cons italic-markup (list markup?))
+ (cons roman-markup (list markup?))
+ (cons number-markup (list markup?))
+ (cons hbracket-markup (list markup?))
+ (cons bracket-markup (list markup?))
+
+ (cons column-markup (list markup-list?))
+ (cons dir-column-markup (list markup-list?))
+ (cons center-markup (list markup-list?))
+ (cons line-markup (list markup-list?))
+
+ (cons combine-markup (list markup? markup?))
+ (cons simple-markup (list string?))
+ (cons musicglyph-markup (list scheme?))
+ (cons translate-markup (list number-pair? markup?))
+ (cons override-markup (list pair? markup?))
+ (cons char-markup (list integer?))
+ (cons lookup-markup (list string?))
+
+ (cons hspace-markup (list number?))
+
+ (cons raise-markup (list number? markup?))
+ (cons magnify-markup (list number? markup?))
+ (cons fontsize-markup (list number? markup?))
+ )
+ )
+
+
+(define markup-module (current-module))
+
(map (lambda (x)
(set-object-property! (car x) 'markup-signature (cdr x))
+ (set-object-property! (car x) 'markup-keyword (markup-signature-to-keyword (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)
- ))
+ markup-functions-and-signatures)
+
+(define-public markup-function-list (map car markup-functions-and-signatures))
-(define markup-module (current-module))
+
+;; construct a
+;;
+;; make-FOO-markup function that typechecks its arguments.
+;;
+;; TODO: should construct a message says
+;; Invalid argument 4 : expecting a BLADIBLA, found: (list-ref 4 args)
+;;
+;; right now, you get the entire argument list.
+
+
+(define (make-markup-maker entry)
+ (let*
+ ((foo-markup (car entry))
+ (signature (cons 'list (cdr entry)))
+ (name (symbol->string (procedure-name foo-markup)))
+ (make-name (string-append "make-" name))
+ )
+
+ `(define (,(string->symbol make-name) . args)
+ (let*
+ (
+ (arglen (length args))
+ (siglen (length ,signature))
+ (error-msg
+ (if (and (> 0 siglen) (> 0 arglen))
+ (markup-argument-list-error ,signature args 1)))
+
+ )
+
+ (if (or (not (= arglen siglen)) (< siglen 0) (< 0 arglen))
+ (scm-error 'markup-format ,make-name "Expect ~A arguments for ~A. Found ~A: ~S"
+ (list (length ,signature)
+ ,make-name
+ (length args)
+ args) #f))
+ (if error-msg
+ (scm-error 'markup-format ,make-name "Invalid argument in position ~A\n Expect: ~A\nFound: ~S." error-msg #f)
+
+ (cons ,foo-markup args)
+ )))
+ )
+)
+
+
+
+(define (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)))
+ )
+
+
+ (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)
+ )))
+
+(define (make-markup-maker entry)
+ (let* (
+ (name (symbol->string (procedure-name (car entry))))
+ (make-name (string-append "make-" name))
+ (signature (object-property (car entry) 'markup-signature))
+ )
+
+ `(define-public (,(string->symbol make-name) . args)
+ (make-markup ,(car entry) ,make-name ,(cons 'list signature) args)
+ ))
+ )
+
+(eval
+ (cons 'begin (map make-markup-maker markup-functions-and-signatures))
+ markup-module
+ )
(define-public (lookup-markup-command code)
(let*
)
(if (eq? var #f)
#f
- (cons (variable-ref var) (object-property (variable-ref var) 'markup-signature))
+ (cons (variable-ref var) (object-property (variable-ref var) 'markup-keyword))
)
))
(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))
+ ((t (ly:get-grob-property grob 'text))
)
-
- (apply func (cons grob (cons props args)) )
- ))
-
+ (if (null? t)
+ '()
+ (interpret-markup grob
+ (Font_interface::get_property_alist_chain grob)
+ t
+ ))
+ ))
-(define (new-markup? x)
- (markup-function? (car x))
-)
+(define-public empty-markup `(,simple-markup ""))
-(define (markup-function? x)
- (object-property 'markup-signature? x))
+(define (interpret-markup grob props markup)
+ (if (string? markup)
+ (simple-markup grob props markup)
+ (let*
+ (
+ (func (car markup))
+ (args (cdr markup))
+ )
+
+ (apply func (cons grob (cons props args)) )
+ )))
+
+
+;;;;;;;;;;;;;;;;
+;; 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))
+
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(if #f
+ (define (typecheck-with-error x)
+ (catch
+ 'markup-format
+ (lambda () (markup? x))
+ (lambda (key message arg)
+ (display "\nERROR: markup format error: \n")
+ (display message)
+ (newline)
+ (write arg (current-output-port))
+ )
+ )))
+
+;; test make-foo-markup functions
+(if #f
+ (begin
+ (newline)
+ (newline)
+ (display (make-line-markup (list (make-simple-markup "FOO"))))
+
+ (make-line-markup (make-simple-markup "FOO"))
+ (make-line-markup (make-simple-markup "FOO") (make-simple-markup "foo"))
+ (make-raise-markup "foo" (make-simple-markup "foo"))
+ )
+ )
+;;
+;; test typecheckers. Not wholly useful, because errors are detected
+;; in other places than they're made.
+;;
+(if #f
+ (begin
+
+ ;; To get error messages, see above to install the alternate
+ ;; typecheck routine for markup?.
+
+
+
+ (display (typecheck-with-error `(,simple-markup "foobar")))
+ (display (typecheck-with-error `(,simple-markup "foobar")))
+ (display (typecheck-with-error `(,simple-markup 1)))
+ (display
+ (typecheck-with-error `(,line-markup ((,simple-markup "foobar"))
+ (,simple-markup 1))))
+ (display
+ (typecheck-with-error `(,line-markup (,simple-markup "foobar")
+ (,simple-markup "bla"))))
+
+ ))
projects / lilypond.git / blobdiff