scm/lily.scm

   1 ;;;; lily.scm -- toplevel Scheme stuff
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
   6 ;;;; Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8
   9 (define (define-scheme-options)
  10   (for-each (lambda (x)
  11               (ly:add-option (car x) (cadr x) (caddr x)))
  12
  13             `((point-and-click #t "use point & click")
  14               (paper-size "a4" "the default paper size")
  15               (midi-debug #f "generate human readable MIDI")
  16               (internal-type-checking #f "check every property assignment for types")
  17               (parse-protect #t    "continue when finding errors in inline
  18 scheme are caught in the parser. If off, halt
  19 on errors, and print a stack trace.")
  20               (profile-property-accesses #f "keep statistics of get_property() calls.")
  21               (old-relative #f
  22                             "relative for simultaneous music works
  23 similar to chord syntax")
  24               (object-keys #f
  25                            "experimental mechanism for remembering tweaks")
  26               (resolution 101 "resolution for generating bitmaps")
  27               (anti-alias-factor 1 "render at higher resolution and scale down result\nto prevent jaggies in PNG")
  28               (preview-include-book-title #t "include book-titles in preview images.")
  29               (gs-font-load #f
  30                             "load fonts via Ghostscript.")
  31               (gui #f "running from gui; redirect stderr to log file")
  32               (delete-intermediate-files #f
  33                                          "delete unusable PostScript files")
  34               (verbose ,(ly:command-line-verbose?) "value for the --verbose flag")
  35               (ttf-verbosity 0
  36                            "how much verbosity for TTF font embedding?")
  37               (debug-gc #f
  38                         "dump GC protection info"))))
  39
  40 ;; FIXME: stray statement
  41 (define-scheme-options)
  42
  43 (if (defined? 'set-debug-cell-accesses!)
  44     (set-debug-cell-accesses! #f))
  45
  46 ;(set-debug-cell-accesses! 1000)
  47
  48 (use-modules (ice-9 regex)
  49              (ice-9 safe)
  50              (ice-9 optargs)
  51              (oop goops)
  52              (srfi srfi-1)
  53              (srfi srfi-13)
  54              (srfi srfi-14))
  55
  56
  57 ;; my display
  58 (define-public (myd k v) (display k) (display ": ") (display v) (display ", "))
  59
  60 (define-public (print . args)
  61   (apply format (cons (current-output-port) args)))
  62
  63
  64 ;;; General settings
  65 ;;; debugging evaluator is slower.  This should
  66 ;;; have a more sensible default.
  67
  68 (if (ly:get-option 'verbose)
  69     (begin
  70       (debug-enable 'debug)
  71       (debug-enable 'backtrace)
  72       (read-enable 'positions)))
  73
  74 (define-public tex-backend?
  75   (member (ly:output-backend) '("texstr" "tex")))
  76
  77 (define-public parser #f)
  78
  79 (define-public (lilypond-version)
  80   (string-join
  81    (map (lambda (x) (if (symbol? x)
  82                         (symbol->string x)
  83                         (number->string x)))
  84         (ly:version))
  85    "."))
  86
  87
  88
  89 ;; cpp hack to get useful error message
  90 (define ifdef "First run this through cpp.")
  91 (define ifndef "First run this through cpp.")
  92
  93 ;; gettext wrapper for guile < 1.7.2
  94 (if (defined? 'gettext)
  95     (define-public _ gettext)
  96     (define-public _ ly:gettext))
  97
  98 (define-public (ly:load x)
  99   (let* ((file-name (%search-load-path x)))
 100     (if (ly:get-option 'verbose)
 101         (ly:progress "[~A" file-name))
 102     (primitive-load file-name)
 103     (if (ly:get-option 'verbose)
 104         (ly:progress "]"))))
 105
 106 (define-public TEX_STRING_HASHLIMIT 10000000)
 107
 108 ;; Cygwin
 109 ;; #(CYGWIN_NT-5.1 Hostname 1.5.12(0.116/4/2) 2004-11-10 08:34 i686)
 110 ;;
 111 ;; Debian
 112 ;; #(Linux hostname 2.4.27-1-686 #1 Fri Sep 3 06:28:00 UTC 2004 i686)
 113 ;;
 114 ;; Mingw
 115 ;; #(Windows XP HOSTNAME build 2600 5.01 Service Pack 1 i686)
 116 ;;
 117
 118 ;; ugh, code dup.
 119 (define-public PLATFORM
 120   (string->symbol
 121    (string-downcase
 122     (car (string-tokenize (vector-ref (uname) 0) char-set:letter)))))
 123
 124 (define-public DOS
 125   (let ((platform (string-tokenize
 126                    (vector-ref (uname) 0) char-set:letter+digit)))
 127     (if (null? (cdr platform)) #f
 128         (member (string-downcase (cadr platform)) '("95" "98" "me")))))
 129
 130 (case PLATFORM
 131   ((windows)
 132    (define native-getcwd getcwd)
 133    (define (slashify x)
 134      (if (string-index x #\\)
 135          x
 136          (string-regexp-substitute
 137           "//*" "/"
 138           (string-regexp-substitute "\\\\" "/" x))))
 139    ;; FIXME: this prints a warning.
 140   (define-public (ly-getcwd)
 141      (slashify (native-getcwd))))
 142   (else (define-public ly-getcwd getcwd)))
 143
 144 (define-public (is-absolute? file-name)
 145   (let ((file-name-length (string-length file-name)))
 146     (if (= file-name-length 0)
 147         #f
 148         (or (eq? (string-ref file-name 0) #\/)
 149             (and (eq? PLATFORM 'windows)
 150                  (> file-name-length 2)
 151                  (eq? (string-ref file-name 1) #\:)
 152                  (eq? (string-ref file-name 2) #\/))))))
 153
 154 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 155
 156 (define (type-check-list location signature arguments)
 157   "Typecheck a list of arguments against a list of type
 158 predicates. Print a message at LOCATION if any predicate failed."
 159   (define (recursion-helper signature arguments count)
 160     (define (helper pred? arg count)
 161       (if (not (pred? arg))
 162
 163           (begin
 164             (ly:input-message
 165              location
 166              (format
 167               #f (_ "wrong type for argument ~a.  Expecting ~a, found ~s")
 168               count (type-name pred?) arg))
 169             #f)
 170           #t))
 171
 172     (if (null? signature)
 173         #t
 174         (and (helper (car signature) (car arguments) count)
 175              (recursion-helper (cdr signature) (cdr arguments) (1+ count)))))
 176   (recursion-helper signature arguments 1))
 177
 178 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 179 ;;  output
 180
 181
 182 ;;(define-public (output-framework) (write "hello\n"))
 183
 184 (define output-tex-module
 185   (make-module 1021 (list (resolve-interface '(scm output-tex)))))
 186 (define output-ps-module
 187   (make-module 1021 (list (resolve-interface '(scm output-ps)))))
 188
 189 (define-public (ps-output-expression expr port)
 190   (display (eval expr output-ps-module) port))
 191
 192 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 193 ;; Safe definitions utility
 194 (define safe-objects (list))
 195
 196 (define-macro (define-safe-public arglist . body)
 197   "Define a variable, export it, and mark it as safe, ie usable in LilyPond safe mode.
 198 The syntax is the same as `define*-public'."
 199   (define (get-symbol arg)
 200     (if (pair? arg)
 201         (get-symbol (car arg))
 202         arg))
 203   (let ((safe-symbol (get-symbol arglist)))
 204     `(begin
 205        (define*-public ,arglist
 206          ,@body)
 207        (set! safe-objects (cons (cons ',safe-symbol ,safe-symbol)
 208                                 safe-objects))
 209        ,safe-symbol)))
 210
 211
 212 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 213 ;; other files.
 214
 215 (for-each ly:load
 216           ;; load-from-path
 217           '("lily-library.scm"
 218             "file-cache.scm"
 219             "define-music-types.scm"
 220             "output-lib.scm"
 221             "c++.scm"
 222             "chord-ignatzek-names.scm"
 223             "chord-entry.scm"
 224             "chord-generic-names.scm"
 225             "stencil.scm"
 226             "markup.scm"
 227             "music-functions.scm"
 228             "part-combiner.scm"
 229             "autochange.scm"
 230             "define-music-properties.scm"
 231             "auto-beam.scm"
 232             "chord-name.scm"
 233
 234             "parser-ly-from-scheme.scm"
 235
 236             "define-context-properties.scm"
 237             "translation-functions.scm"
 238             "script.scm"
 239             "midi.scm"
 240             "layout-beam.scm"
 241             "parser-clef.scm"
 242             "layout-slur.scm"
 243             "font.scm"
 244             "encoding.scm"
 245
 246             "fret-diagrams.scm"
 247             "define-markup-commands.scm"
 248             "define-grob-properties.scm"
 249             "define-grobs.scm"
 250             "define-grob-interfaces.scm"
 251             "define-stencil-commands.scm"
 252             "layout-page-layout.scm"
 253             "titling.scm"
 254
 255             "paper.scm"
 256             "backend-library.scm"
 257             "x11-color.scm"
 258
 259             ;; must be after everything has been defined
 260             "safe-lily.scm"))
 261
 262
 263 (set! type-p-name-alist
 264       `(
 265         (,boolean-or-symbol? . "boolean or symbol")
 266         (,boolean? . "boolean")
 267         (,char? . "char")
 268         (,grob-list? . "list of grobs")
 269         (,hash-table? . "hash table")
 270         (,input-port? . "input port")
 271         (,integer? . "integer")
 272         (,list? . "list")
 273         (,ly:context? . "context")
 274         (,ly:dimension? . "dimension, in staff space")
 275         (,ly:dir? . "direction")
 276         (,ly:duration? . "duration")
 277         (,ly:grob? . "layout object")
 278         (,ly:input-location? . "input location")
 279         (,ly:moment? . "moment")
 280         (,ly:music? . "music")
 281         (,ly:pitch? . "pitch")
 282         (,ly:translator? . "translator")
 283         (,ly:font-metric? . "font metric")
 284         (,ly:simple-closure? . "simple closure")
 285         (,markup-list? . "list of markups")
 286         (,markup? . "markup")
 287         (,ly:music-list? . "list of music")
 288         (,number-or-grob? . "number or grob")
 289         (,number-or-string? . "number or string")
 290         (,number-pair? . "pair of numbers")
 291         (,number? . "number")
 292         (,output-port? . "output port")
 293         (,pair? . "pair")
 294         (,procedure? . "procedure")
 295         (,scheme? . "any type")
 296         (,string? . "string")
 297         (,symbol? . "symbol")
 298         (,vector? . "vector")))
 299
 300
 301 ;; debug mem leaks
 302
 303 (define gc-protect-stat-count 0)
 304 (define-public (dump-gc-protects)
 305   (set! gc-protect-stat-count (1+ gc-protect-stat-count))
 306   (let* ((protects (sort
 307                     (hash-table->alist (ly:protects))
 308                     (lambda (a b)
 309                       (< (object-address (car a))
 310                          (object-address (car b))))))
 311
 312          (out-file-name (string-append
 313                          "gcstat-" (number->string gc-protect-stat-count)
 314                          ".scm"))
 315          (outfile    (open-file  out-file-name  "w")))
 316
 317     (display (format "Dumping gc protected objs to ~a...\n" out-file-name))
 318     (display
 319      (map (lambda (y)
 320             (let ((x (car y))
 321                   (c (cdr y)))
 322
 323               (string-append
 324                (string-join
 325                 (map object->string (list (object-address x) c x))
 326                 " ")
 327                "\n")))
 328
 329           (filter
 330            (lambda (x)
 331              (not (symbol? (car x))))
 332            protects))
 333      outfile)
 334
 335 ;    (display (ly:smob-protects))
 336     (newline outfile)
 337     (if (defined? 'gc-live-object-stats)
 338         (let* ((stats #f))
 339           (display "Live object statistics: GC'ing\n")
 340           (gc)
 341           (gc)
 342
 343           (set! stats (gc-live-object-stats))
 344           (display "Dumping live object statistics.\n")
 345
 346           (for-each
 347            (lambda (x)
 348              (format outfile "~a: ~a\n" (car x) (cdr x)))
 349            (sort (gc-live-object-stats)
 350                  (lambda (x y)
 351                    (string<? (car x) (car y)))))))))
 352
 353 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 354 (define-public (lilypond-main files)
 355   "Entry point for LilyPond."
 356
 357   (define (no-files-handler)
 358     (ly:usage)
 359     (exit 2))
 360
 361   (if (ly:get-option 'gui)
 362       (gui-main files))
 363
 364   (if (null? files)
 365       (no-files-handler))
 366
 367   (let ((failed (lilypond-all files)))
 368     (if (pair? failed)
 369         (begin
 370           (ly:error (_ "failed files: ~S") (string-join failed))
 371           (exit 1))
 372         (begin
 373           ;; HACK: be sure to exit with single newline
 374           (ly:message "")
 375           (exit 0)))))
 376
 377 (define-public (lilypond-all files)
 378
 379   (let* ((failed '())
 380          (handler (lambda (key failed-file)
 381                     (set! failed (append (list failed-file) failed)))))
 382
 383     (for-each
 384      (lambda (x)
 385        (lilypond-file handler x)
 386        (ly:clear-anonymous-modules)
 387        (if (ly:get-option 'debug-gc)
 388            (dump-gc-protects)))
 389
 390      files)
 391     failed))
 392
 393 (define (lilypond-file handler file-name)
 394   (catch 'ly-file-failed
 395          (lambda () (ly:parse-file file-name))
 396          (lambda (x . args) (handler x file-name))))
 397
 398 (use-modules (scm editor))
 399
 400 (define-public (gui-main files)
 401   (if (null? files)
 402       (gui-no-files-handler))
 403   (let* ((base (basename (car files) ".ly"))
 404          (log-name (string-append base ".log")))
 405     (if (not (ly:get-option 'gui))
 406         (ly:message (_ "Redirecting output to ~a...") log-name))
 407     (ly:stderr-redirect log-name "w")
 408     (ly:message "# -*-compilation-*-")
 409
 410     (let ((failed (lilypond-all files)))
 411       (if (pair? failed)
 412           (begin
 413             ;; ugh
 414             (ly:stderr-redirect "foo" "r")
 415             (system (get-editor-command log-name 0 0 0))
 416             (ly:error (_ "failed files: ~S") (string-join failed))
 417             ;; not reached?
 418             (exit 1))
 419           (exit 0)))))
 420
 421 (define (gui-no-files-handler)
 422   (let* ((ly (string-append (ly:effective-prefix) "/ly/"))
 423          ;; FIXME: soft-code, localize
 424          (welcome-ly (string-append ly "Welcome_to_LilyPond.ly"))
 425          (cmd (get-editor-command welcome-ly 0 0 0)))
 426     (ly:message (_ "Invoking `~a'...") cmd)
 427     (system cmd)
 428     (exit 1)))