scm/output-gnome.scm

   1 ;;;; output-gnome.scm -- implement GNOME canvas output
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  2004 Jan Nieuwenhuizen <janneke@gnu.org>
   6
   7 ;;; HIP -- hack in progress
   8 ;;;
   9 ;;; You need:
  10 ;;;
  11 ;;;   * guile-1.6.4 (NOT CVS)
  12 ;;;   * Rotty's g-wrap--tng, possibly Janneke's if you have libffi-3.4.
  13 ;;;
  14 ;;; see also: guile-gtk-general@gnu.org
  15 ;;;
  16 ;;; Try it
  17 ;;;
  18 ;;;   * If using GUILE CVS , then compile LilyPond with GUILE 1.6,
  19 ;;;
  20 ;;;    PATH=/usr/bin/:$PATH ./configure --enable-config=g16  ; make conf=g16
  21 ;;;
  22 ;;;   * Install gnome/gtk development stuff and g-wrap, guile-gnome
  23 ;;;     see buildscripts/guile-gnome.sh
  24 ;;;
  25 ;;;   * Use latin1 encoding for gnome backend, do
  26 ;;;
  27 ;;;       make -C mf conf=g16 clean
  28 ;;;       make -C mf conf=g16 ENCODING_FILE=$(kpsewhich cork.enc)
  29 ;;;       (cd mf/out && mkfontdir)i
  30 ;;;       xset +fp $(pwd)/mf/out
  31 "
  32        make -C mf clean
  33        make -C mf ENCODING_FILE=$(kpsewhich cork.enc)
  34        (cd mf/out && mkfontdir)
  35        xset +fp $(pwd)/mf/out
  36 "
  37 ;;;
  38 ;;;   * Setup environment
  39 "
  40 export GUILE_LOAD_PATH=$HOME/usr/pkg/g-wrap/share/guile/site:$HOME/usr/pkg/g-wrap/share/guile/site/g-wrap:$HOME/usr/pkg/guile-gnome/share/guile
  41 export LD_LIBRARY_PATH=$HOME/usr/pkg/g-wrap/lib:$HOME/usr/pkg/guile-gnome/lib
  42 export XEDITOR='/usr/bin/emacsclient --no-wait +%l:%c %f'
  43 "
  44 ;;;  * For GNOME point-and-click, add
  45 ;;;     #(ly:set-point-and-click 'line-column)
  46 ;;;    to your .ly; just click an object on the canvas.
  47 ;;;
  48 ;;;  * Run lily:
  49 "
  50 lilypond-bin -fgnome input/simple-song.ly
  51 "
  52
  53
  54 ;;; TODO:
  55 ;;;  * pango+feta font (see archives gtk-i18n-list@gnome.org and
  56 ;;;    lilypond-devel)
  57 ;;;    - wait for/help with pango 1.6
  58 ;;;    - convert feta to OpenType (CFF) or TrueType (fontforge?)
  59 ;;;    - hack feta20/feta20.pfa?:
  60 ;;;  * font, canvas, scaling?
  61 ;;;  * implement missing stencil functions
  62 ;;;  * implement missing commands
  63 ;;;  * user-interface, keybindings
  64 ;;;  * cleanups: (too many) global vars
  65 ;;;  * papersize, outputscale from book
  66
  67
  68 "
  69 #!/bin/bash
  70
  71 set -ex
  72
  73 # no CVS guile.
  74 export PATH=/usr/bin/:$PATH
  75
  76 if  [ -d $HOME/usr/pkg/libffi/ ] ; then
  77  export LDFLAGS=-L$HOME/usr/pkg/libffi/lib/
  78  export CPPFLAGS=-I$HOME/usr/pkg/libffi/include
  79 fi
  80
  81 export AUTOMAKE=automake-1.8
  82 export AUTOCONF=autoconf2.50
  83
  84 rm -rf test
  85 mkdir test
  86 cd test
  87
  88 ## 1.  install gnome-devel (Debian/unstable: apt-get install gnome-devel)
  89
  90 ## 2.  *** NOTE: use guile-1.6 for g-wrap and guile-gnome ***
  91 ##### using GUILE CVS g-wrap/guile-gnome is experimental (read: segfaults)
  92 PATH=/usr/bin:$PATH
  93
  94
  95 ## 3.  get g-wrap 2.0
  96 tla register-archive a.rottmann@gmx.at--2004-main http://people.debian.org/~rotty/arch/a.rottmann@gmx.at/2004-main || true
  97
  98 rm -rf g-wrap
  99 ## tla get a.rottmann@gmx.at--2004-main/g-wrap--tng g-wrap
 100 ## pull latest g-wrap from janneke -- this step is probably no longer
 101 ## necessary when you read this
 102 tla register-archive janneke@gnu.org--2004-gnome http://lilypond.org/~janneke/{arch}/2004-gnome || true
 103 tla get janneke@gnu.org--2004-gnome/g-wrap--janneke g-wrap
 104 cd g-wrap
 105
 106 rm -rf $HOME/usr/pkg/g-wrap
 107 sh autogen.sh --noconfigure
 108 mkdir =build
 109 cd =build
 110 ../configure --prefix=$HOME/usr/pkg/g-wrap
 111 make install
 112
 113 # cp srfi-34.scm from CVS head ?  --hwn
 114 (cd $HOME/usr/pkg/g-wrap/share/guile/site
 115  mv srfi-34.scm srfi-34.scm-g-wrap
 116  cp $HOME/usr/pkg/guile/share/guile-1.7/srfi/srfi-34.scm .)
 117
 118 cd ../..
 119
 120 ## 4.  get guile-gnome
 121 tla register-archive guile-gnome-devel@gnu.org--2004 http://people.debian.org/~rotty/arch/guile-gnome-devel@gnu.org/2004/ || true
 122 rm -rf guile-gnome
 123 tla get guile-gnome-devel@gnu.org--2004/dists--dev guile-gnome
 124 cd guile-gnome
 125 tla build-config -r configs/gnu.org/dev
 126 cd src
 127
 128 ## 5.  get the gnome canvas module
 129 tla get guile-gnome-devel@gnu.org--2004/libgnomecanvas--dev libgnomecanvas
 130
 131 ## pull latest defs from janneke -- this step is probably no longer
 132 ## necessary when you read this
 133 ## tla register-archive janneke@gnu.org--2004-gnome http://lilypond.org/~janneke/{arch}/2004-gnome || true
 134 ## rm -rf defs
 135 ## tla get janneke@gnu.org--2004-gnome/defs--janneke defs
 136
 137 rm -rf $HOME/usr/pkg/guile-gnome
 138 sh autogen.sh --noconfigure
 139 mkdir ../=build
 140 cd ../=build
 141
 142 export GUILE_LOAD_PATH=$HOME/usr/pkg/g-wrap/share/guile/site:$GUILE_LOAD_PATH
 143 export LD_LIBRARY_PATH=$HOME/usr/pkg/g-wrap/lib:$LD_LIBRARY_PATH
 144 export PKG_CONFIG_PATH=$HOME/usr/pkg/g-wrap/lib/pkgconfig:$PKG_CONFIG_PATH
 145
 146 ../src/configure --prefix=$HOME/usr/pkg/guile-gnome
 147
 148
 149 # requires 800mb RAM with -O2
 150 (cd gtk/gnome/gw; perl  -i~  -pe 's/-O2//g' Makefile)
 151
 152 G_WRAP_MODULE_DIR=$HOME/usr/pkg/g-wrap/share/guile/site make install
 153
 154 export GUILE_LOAD_PATH=$HOME/usr/pkg/guile-gnome/share/guile:$GUILE_LOAD_PATH
 155 export LD_LIBRARY_PATH=$HOME/usr/pkg/guile-gnome/lib:$LD_LIBRARY_PATH
 156
 157
 158 # simple test
 159 guile -s ../src/libgnomecanvas/examples/canvas.scm
 160
 161
 162 (debug-enable 'backtrace)
 163
 164 (define-module (scm output-gnome))
 165
 166 (define this-module (current-module))
 167
 168 (use-modules
 169  (guile)
 170  (ice-9 regex)
 171  (srfi srfi-13)
 172  (lily)
 173  (gnome gtk)
 174  (gnome gtk gdk-event)
 175  ;; the name of the module will change to canvas rsn
 176  (gnome gw libgnomecanvas))
 177  ;;(gnome gw canvas))
 178
 179 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 180 ;;;; module entry
 181 (define-public (gnome-output-expression expr port)
 182   (display (dispatch expr) port))
 183
 184 (define (dispatch expr)
 185   (if (pair? expr)
 186       (let ((keyword (car expr)))
 187         (cond
 188          ((eq? keyword 'some-func) "")
 189          ;;((eq? keyword 'placebox) (dispatch (cadddr expr)))
 190          (else
 191           (if (module-defined? this-module keyword)
 192               (apply (eval keyword this-module) (cdr expr))
 193               (begin
 194                 (display
 195                  (string-append "undefined: " (symbol->string keyword) "\n"))
 196                 "")))))
 197       expr))
 198
 199 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 200 ;;; Lily output interface --- fix silly names and docme
 201 "
 202  The output interface has functions for
 203   * formatting stencils, and
 204   * output commands
 205
 206  Stencils:
 207  beam
 208  bezier-sandwich
 209  bracket
 210  char
 211  filledbox
 212  text
 213  ...
 214
 215  Commands:
 216  placebox
 217  ...
 218
 219
 220  The Bare minimum interface for \score { \notes c } } should
 221  implement:
 222
 223     INTERFACE-output-expression
 224     char
 225     filledbox
 226     placebox
 227
 228  and should intercept:
 229 "
 230
 231 (define (dummy . foo) #f)
 232
 233 ;; minimal intercept list:
 234 (define output-interface-intercept
 235   '(
 236     no-origin
 237 ))
 238
 239 (map (lambda (x) (module-define! this-module x dummy))
 240      output-interface-intercept)
 241
 242 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 243
 244
 245 ;;; Global vars
 246 (define main-window #f)
 247 (define main-scrolled #f)
 248 (define main-canvas #f)
 249 (define page-number 0)
 250
 251 (define page-stencils #f)
 252 (define output-canvas #f)
 253
 254 (define system-origin '(0 . 0))
 255
 256 ;; UGHr
 257 (define item-locations (make-hash-table 31))
 258 (define location #f)
 259
 260 (define button-height 25)
 261 (define canvas-width 2000)
 262 (define canvas-height 4000)
 263
 264 (define window-width 400)
 265 (define window-height
 266   (inexact->exact (round (* 1.42 window-width))))
 267
 268 (define font-paper #f)
 269
 270 (define pixels-per-unit 2.0)
 271 (define OUTPUT-SCALE 2.83464566929134)
 272 (define output-scale (* OUTPUT-SCALE pixels-per-unit))
 273
 274 ;; helper functions -- sort this out
 275 (define (stderr string . rest)
 276   ;; debugging
 277   (if #f
 278       (begin
 279         (apply format (cons (current-error-port) (cons string rest)))
 280         (force-output (current-error-port)))))
 281
 282 (define (utf8 i)
 283   (cond
 284    ((< i #x80) (make-string 1 (integer->char i)))
 285    ((< i #x800) (list->string
 286                  (map integer->char
 287                       (list (+ #xc0 (quotient i #x40))
 288                             (+ #x80 (modulo i #x40))))))
 289    ((< i #x10000)
 290     (let ((x (quotient i #x1000))
 291           (y (modulo i #x1000)))
 292       (list->string
 293        (map integer->char
 294             (list (+ #xe0 x)
 295                   (+ #x80 (quotient y #x40))
 296                   (+ #x80 (modulo y #x40)))))))
 297    (else FIXME)))
 298
 299 (define (custom-utf8 i)
 300   (if (< i 80)
 301       (utf8 i)
 302       (utf8 (+ #xee00 i))))
 303
 304 ;;; hmm?
 305 (define (draw-rectangle x1 y1 x2 y2 color width-units)
 306   (make <gnome-canvas-rect>
 307     #:parent (root main-canvas) #:x1 x1 #:y1 y1 #:x2 x2 #:y2 y2
 308     #:fill-color color #:width-units width-units))
 309
 310
 311 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 312 ;;;; stencil outputters
 313 ;;;;
 314
 315 (define (char font i)
 316   (text font (utf8 i)))
 317
 318 (define (placebox x y expr)
 319   (stderr "item: ~S\n" expr)
 320   (let ((item expr))
 321     ;;(if item
 322     ;; FIXME ugly hack to skip #unspecified ...
 323     (if (and item (not (eq? item (if #f #f))))
 324         (begin
 325           (move item
 326                 (* output-scale (+ (car system-origin) x))
 327                 (* output-scale (- (car system-origin) y)))
 328           (affine-relative item output-scale 0 0 output-scale 0 0)
 329
 330           (gtype-instance-signal-connect item 'event item-event)
 331           (if location
 332               (hashq-set! item-locations item location))
 333           item)
 334         #f)))
 335
 336 (define (round-filled-box breapth width depth height blot-diameter)
 337   ;; FIXME: no rounded corners on rectangle...
 338   ;; FIXME: blot?
 339   (draw-rectangle (- breapth) depth width (- height) "black" blot-diameter))
 340
 341 (define (pango-font-name font)
 342   (cond
 343    ((equal? (ly:font-name font) "GNU-LilyPond-feta-20")
 344     "lilypond-feta, regular 32")
 345    (else
 346     (ly:font-name font))))
 347
 348 (define (pango-font-size font)
 349   (let* ((designsize (ly:font-design-size font))
 350          (magnification (* (ly:font-magnification font)))
 351          ;;(ops (ly:paper-lookup paper 'outputscale))
 352          ;;(ops (* pixels-per-unit OUTPUT-SCALE))
 353          ;;(ops (* pixels-per-unit pixels-per-unit))
 354          (ops (* (/ 12 20) (* pixels-per-unit pixels-per-unit)))
 355          (scaling (* ops magnification designsize)))
 356     scaling))
 357
 358 (define (text font string)
 359   (stderr "font-name: ~S\n" (ly:font-name font))
 360   ;; TODO s/filename/file-name/
 361   (stderr "font-filename: ~S\n" (ly:font-filename font))
 362
 363   (stderr "pango-font-name: ~S\n" (pango-font-name font))
 364   (stderr "pango-font-size: ~S\n" (pango-font-size font))
 365   (set!
 366    text-items
 367    (cons
 368     (make <gnome-canvas-text>
 369       #:parent (root main-canvas)
 370       #:x 0 #:y 0
 371       #:font (pango-font-name font)
 372       #:size-points (pango-font-size font)
 373       #:size-set #t
 374
 375       ;;apparently no effect :-(
 376       ;;#:scale 1.0
 377       ;;#:scale-set #t
 378
 379       #:fill-color "black"
 380       #:text string
 381       #:anchor 'west)
 382     text-items))
 383   (car text-items))
 384
 385 (define (filledbox a b c d)
 386   (round-filled-box a b c d 0.001))
 387
 388 ;; WTF is this in every backend?
 389 (define (horizontal-line x1 x2 thickness)
 390   ;;(let ((thickness 2))
 391   (filledbox (- x1) (- x2 x1) (* .5 thickness) (* .5 thickness)))
 392
 393 ;; origin -- bad name
 394 (define (define-origin file line col)
 395   ;; ughr, why is this not passed as [part of] stencil object
 396   (set! location (if (procedure? point-and-click)
 397                      ;; duh, only silly string append
 398                      ;; (point-and-click line col file)
 399                      (list line col file)
 400                      #f)))
 401
 402
 403
 404 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 405 ;;;; gnome stuff  --- move to framework-gnome
 406 (define (dump-page number)
 407   (if (or (not page-stencils)
 408           (< number 0)
 409           (>= number (vector-length page-stencils)))
 410       (stderr "No such page: ~S\n" (1+ number))
 411
 412       (let* ((old-canvas main-canvas)
 413              (canvas (new-canvas)))
 414         (set! page-number number)
 415
 416         ;; no destroy method for gnome-canvas-text?
 417         ;;(map destroy (gtk-container-get-children main-canvas))
 418         ;;(map destroy text-items)
 419
 420         ;;Hmm
 421         ;;(set! main-canvas canvas)
 422         (set! text-items '())
 423         (ly:outputter-dump-stencil output-canvas
 424                                    (vector-ref page-stencils page-number))
 425
 426         (if old-canvas (destroy old-canvas))
 427         (add main-scrolled canvas)
 428         (show canvas))))
 429
 430 (define x-editor #f)
 431 (define (get-x-editor)
 432   (if (not x-editor)
 433       (set! x-editor (getenv "XEDITOR")))
 434   x-editor)
 435
 436 (define ifs #f)
 437 (define (get-ifs)
 438   (if (not ifs)
 439       (set! ifs (getenv "IFS")))
 440   (if (not ifs)
 441       (set! ifs "       "))
 442   ifs)
 443
 444 (define (spawn-editor location)
 445   (let* ((line (car location))
 446          (column (cadr location))
 447          (file-name (caddr location))
 448          (template (substring (get-x-editor) 0))
 449
 450          ;; Adhere to %l %c %f?
 451          (command
 452           (regexp-substitute/global
 453            #f "%l" (regexp-substitute/global
 454                     #f "%c"
 455                     (regexp-substitute/global
 456                      #f "%f" template 'pre file-name 'post)
 457                     'pre (number->string column)
 458                     'post)
 459            'pre (number->string line) 'post)))
 460
 461     (stderr "spawning: ~s\n" command)
 462     (if (= (primitive-fork) 0)
 463         (let ((command-list (string-split command #\ )));; (get-ifs))))
 464           (apply execlp command-list)
 465           (primitive-exit)))))
 466
 467 (define location-callback spawn-editor)
 468
 469 (define (item-event item event . data)
 470   (case (gdk-event:type event)
 471     ((enter-notify) (gobject-set-property item 'fill-color "red"))
 472     ((leave-notify) (gobject-set-property item 'fill-color "black"))
 473     ((button-press)
 474      (let ((location (hashq-ref item-locations item #f)))
 475        (if location
 476            (location-callback location)
 477            (stderr "no location\n"))))
 478     ((2button-press) (gobject-set-property item 'fill-color "red")))
 479   #t)
 480
 481 ;; TODO: one list per-page
 482 (define text-items '())
 483 (define (scale-canvas factor)
 484   (set! pixels-per-unit (* pixels-per-unit factor))
 485   (set-pixels-per-unit main-canvas pixels-per-unit)
 486   (for-each
 487    (lambda (x)
 488      (let ((scale (gobject-get-property x 'scale))
 489            (points (gobject-get-property x 'size-points)))
 490        ;;(gobject-set-property x 'scale pixels-per-unit)
 491        (gobject-set-property x 'size-points (* points factor))))
 492      text-items))
 493
 494 (define (key-press-event item event . data)
 495   (let ((keyval (gdk-event-key:keyval event))
 496         (mods (gdk-event-key:modifiers event)))
 497     (cond ((and (or (eq? keyval gdk:q)
 498                     (eq? keyval gdk:w))
 499                 (equal? mods '(control-mask modifier-mask)))
 500            (gtk-main-quit))
 501           ((and #t ;;(null? mods)
 502                 (eq? keyval gdk:plus))
 503            (scale-canvas 2))
 504           ((and #t ;; (null? mods)
 505                 (eq? keyval gdk:minus))
 506            (scale-canvas 0.5))
 507           ((or (eq? keyval gdk:Page-Up)
 508                (eq? keyval gdk:BackSpace))
 509            (dump-page (1- page-number)))
 510           ((or (eq? keyval gdk:Page-Down)
 511                (eq? keyval gdk:space))
 512            (dump-page (1+ page-number))))
 513     #f))
 514
 515 (define (papersize window paper)
 516   (let* ((hsize (ly:output-def-lookup paper 'hsize))
 517          (vsize (ly:output-def-lookup paper 'vsize))
 518          (width (inexact->exact (ceiling (* output-scale hsize))))
 519          (height (inexact->exact (ceiling (* output-scale vsize))))
 520          (max-width (gdk-screen-width))
 521          (max-height (gdk-screen-height))
 522          (scrollbar-size 20))
 523
 524     ;; ughr: panels?
 525     (set! max-height (- max-height 80))
 526
 527     ;; hmm?
 528     ;;(set! OUTPUT-SCALE (ly:bookpaper-outputscale paper))
 529     ;;(set! output-scale (* OUTPUT-SCALE pixels-per-unit))
 530
 531     ;; huh, *2?
 532
 533     (set! window-width (min (+ scrollbar-size (* width 2)) max-width))
 534     (set! window-height (min (+ button-height scrollbar-size (* height 2))
 535                              max-height))
 536
 537     (set! canvas-width width)
 538     (set! canvas-height height)))
 539
 540
 541 (define (new-canvas)
 542   (let* ((canvas (make <gnome-canvas>))
 543          (root (root canvas)))
 544
 545     (set-size-request canvas window-width window-height)
 546     (set-scroll-region canvas 0 0 canvas-width canvas-height)
 547
 548     (set-pixels-per-unit canvas pixels-per-unit)
 549
 550     (set! main-canvas canvas)
 551     (draw-rectangle 0 0 canvas-width canvas-height "white" 0)
 552
 553     canvas))
 554
 555 (define (main outputter bookpaper pages)
 556   (let* ((window (make <gtk-window> #:type 'toplevel))
 557          (button (make <gtk-button> #:label "Exit"))
 558          (next (make <gtk-button> #:label "Next"))
 559          (prev (make <gtk-button> #:label "Previous"))
 560          (vbox (make <gtk-vbox> #:homogeneous #f))
 561          (hbox (make <gtk-hbox> #:homogeneous #f))
 562          (scrolled (make <gtk-scrolled-window>))
 563          (canvas (new-canvas)))
 564
 565     (papersize window bookpaper)
 566     (set-size-request window window-width window-height)
 567
 568     (add window vbox)
 569     (add vbox scrolled)
 570     (add scrolled canvas)
 571
 572     (add vbox hbox)
 573     (set-size-request hbox window-width button-height)
 574     (set-child-packing vbox hbox #f #f 0 'end)
 575
 576     (set-child-packing hbox button #f #f 0 'end)
 577     (set-size-request button (quotient window-width 2) button-height)
 578
 579     (add hbox next)
 580     (add hbox prev)
 581     (add hbox button)
 582
 583     (gtype-instance-signal-connect button 'clicked
 584                                    (lambda (b) (gtk-main-quit)))
 585     (gtype-instance-signal-connect next 'clicked
 586                                    (lambda (b) (dump-page (1+ page-number))))
 587     (gtype-instance-signal-connect prev 'clicked
 588                                    (lambda (b) (dump-page (1- page-number))))
 589
 590     (gtype-instance-signal-connect window 'key-press-event key-press-event)
 591     (show-all window)
 592
 593     ;; HMMM.  Make some class for these vars?
 594     (set! main-window window)
 595     (set! main-scrolled scrolled)
 596     (set! output-canvas outputter)
 597     (set! page-stencils pages)
 598
 599     (dump-page 0)
 600
 601     (gtk-main)))
 602