scm/framework-gnome.scm

   1 ;;;; framework-gnome.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  2004 Jan Nieuwenhuizen <janneke@gnu.org>
   6
   7 ;;;; See output-gnome.scm for usage information.
   8
   9
  10 (define-module (scm framework-gnome))
  11
  12 (use-modules (guile) (oop goops) (lily))
  13
  14 (use-modules
  15  (srfi srfi-2)
  16  (ice-9 regex)
  17  (gnome gtk)
  18  (gnome gtk gdk-event)
  19  (gnome gw canvas))
  20
  21
  22 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  23 ;;; Wrappers from guile-gnome TLA
  24 ;;; guile-gnome-devel@gnu.org--2004
  25 ;;; http://arch.gna.org/guile-gnome/archive-2004
  26 ;;;
  27 ;;; janneke@gnu.org--2004-gnome
  28 ;;; http://lilypond.org/~janneke/{arch}/2004-gnome
  29 ;;;
  30 (if (not (defined? 'gdk-event-motion:x))
  31     (define (gdk-event-motion:x event)
  32       (let ((vector (gdk-event->vector event)))
  33         (case (gdk-event:type event)
  34           ((motion-notify)
  35            (vector-ref vector 4))
  36           (else
  37            (gruntime-error "Event not of the proper type: ~A" event))))))
  38
  39 (if (not (defined? 'gdk-event-motion:y))
  40     (define (gdk-event-motion:y event)
  41       (let ((vector (gdk-event->vector event)))
  42         (case (gdk-event:type event)
  43           ((motion-notify)
  44            (vector-ref vector 5))
  45           (else
  46            (gruntime-error "Event not of the proper type: ~A" event))))))
  47
  48 ; (if (not (defined? 'gdk-event-motion:x-root))
  49 ;     (define (gdk-event-motion:x-root event)
  50 ;       (let ((vector (gdk-event->vector event)))
  51 ;       (case (gdk-event:type event)
  52 ;         ((motion-notify)
  53 ;          (vector-ref vector 9))
  54 ;         (else
  55 ;          (gruntime-error "Event not of the proper type: ~A" event))))))
  56
  57 ; (if (not (defined? 'gdk-event-motion:y-root))
  58 ;     (define (gdk-event-motion:y-root event)
  59 ;       (let ((vector (gdk-event->vector event)))
  60 ;       (case (gdk-event:type event)
  61 ;         ((motion-notify)
  62 ;          (vector-ref vector 10))
  63 ;         (else
  64 ;          (gruntime-error "Event not of the proper type: ~A" event))))))
  65
  66 (if (not (defined? 'gdk-event-button:modifiers))
  67     (define (gdk-event-button:modifiers event)
  68       (let ((vector (gdk-event->vector event)))
  69         (case (gdk-event:type event)
  70           ((button-press button-release)
  71            ;; We have to do some hackery here, because there are bitmasks
  72            ;; used by XKB that we don't know about.
  73            (gflags->symbol-list
  74             (make <gdk-modifier-type>
  75               #:value (logand #x1fff (vector-ref vector 6)))))
  76           (else
  77            (gruntime-error "Event not of the proper type: ~A" event))))))
  78 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  79
  80 (define-public (output-framework outputter book scopes fields basename)
  81   (gnome-main book basename))
  82
  83 (define SCROLLBAR-SIZE 20)
  84 (define BUTTON-HEIGHT 25)
  85 (define PANELS-HEIGHT 80)
  86
  87 (define PIXELS-PER-UNIT 2)
  88 (define OUTPUT-SCALE (* 2.5 PIXELS-PER-UNIT))
  89 (define-public output-scale OUTPUT-SCALE)
  90
  91 (define (stderr string . rest)
  92   (apply format (cons (current-error-port) (cons string rest)))
  93   (force-output (current-error-port)))
  94
  95 (define (debugf string . rest)
  96   (if #f
  97       (stderr (cons string rest))))
  98
  99 (define-class <gnome-outputter> ()
 100   (name #:init-value "untitled" #:init-keyword #:name #:accessor name)
 101
 102   ;; FIXME
 103   (dragging #:init-value #f #:accessor dragging)
 104   (drag-origin #:init-value #f #:accessor drag-origin)
 105   (drag-location #:init-value #f #:accessor drag-location)
 106
 107   (page-stencils ;;#:init-value '#()
 108    #:init-keyword #:page-stencils #:accessor page-stencils)
 109   (window #:init-value (make <gtk-window> #:type 'toplevel) #:accessor window)
 110   (scrolled #:init-value (make <gtk-scrolled-window>) #:accessor scrolled)
 111   (canvas #:init-value #f #:accessor canvas)
 112   (page-number #:init-value 0 #:accessor page-number)
 113   (pixels-per-unit #:init-value PIXELS-PER-UNIT #:accessor pixels-per-unit)
 114   (text-items #:init-value '() #:accessor text-items)
 115   (grob #:init-value #f #:accessor grob)
 116   (item-grobs #:init-value (make-hash-table 31) #:accessor item-grobs)
 117   (grob-tweaks #:init-value (make-hash-table 31) #:accessor grob-tweaks)
 118   (window-width #:init-keyword #:window-width #:accessor window-width)
 119   (window-height #:init-keyword #:window-height #:accessor window-height)
 120   (canvas-width #:init-keyword #:canvas-width #:accessor canvas-width)
 121   (canvas-height #:init-keyword #:canvas-height #:accessor canvas-height))
 122
 123 (define-method (initialize (go <gnome-outputter>))
 124   (let* ((save (make <gtk-button> #:label "Save"))
 125          (exit (make <gtk-button> #:label "Exit"))
 126          (next (make <gtk-button> #:label "Next"))
 127          (prev (make <gtk-button> #:label "Previous"))
 128          (vbox (make <gtk-vbox> #:homogeneous #f))
 129          (hbox (make <gtk-hbox> #:homogeneous #f)))
 130
 131     (set-size-request (window go) (window-width go) (window-height go))
 132
 133     (set-size-request (scrolled go) (window-width go) (- (window-height go)
 134                                                          BUTTON-HEIGHT
 135                                                          SCROLLBAR-SIZE))
 136
 137     (new-canvas go)
 138
 139     (add (window go) vbox)
 140     (add vbox (scrolled go))
 141
 142     (add (scrolled go) (canvas go))
 143
 144     ;; buttons
 145     (add vbox hbox)
 146     (set-size-request hbox (window-width go) BUTTON-HEIGHT)
 147
 148     ;; hmm?  These are broken when using <gnome-outputter>.
 149     ;;(set-child-packing vbox hbox #f #f 0 'end)
 150     ;;(set-child-packing hbox button #f #f 0 'end)
 151
 152     (set-size-request exit (quotient (window-width go) 2) BUTTON-HEIGHT)
 153
 154
 155     (add hbox next)
 156     (add hbox prev)
 157     (add hbox save)
 158     (add hbox exit)
 159
 160     ;; signals
 161     (connect exit 'clicked (lambda (b) (gtk-main-quit)))
 162     (connect save 'clicked (lambda (b) (save-tweaks go)))
 163     (connect next 'clicked (lambda (b) (dump-page go (1+ (page-number go)))))
 164     (connect prev 'clicked (lambda (b) (dump-page go (1- (page-number go)))))
 165     (connect (window go) 'key-press-event
 166              (lambda (w e) (key-press-event go w e)))
 167
 168     (show-all (window go))))
 169
 170
 171 (define (gnome-main book name)
 172   (let* ((paper (ly:paper-book-paper book))
 173          (hsize (ly:output-def-lookup paper 'hsize))
 174          (vsize (ly:output-def-lookup paper 'vsize))
 175          (page-width (inexact->exact (ceiling (* OUTPUT-SCALE hsize))))
 176          (page-height (inexact->exact (ceiling (* OUTPUT-SCALE vsize))))
 177          ;;(page-width (inexact->exact (ceiling hsize)))
 178          ;;(page-height (inexact->exact (ceiling vsize)))
 179
 180          (screen-width (gdk-screen-width))
 181          (screen-height (gdk-screen-height))
 182          (desktop-height (- screen-height PANELS-HEIGHT))
 183
 184          (go (make <gnome-outputter>
 185                #:name name
 186                #:page-stencils (list->vector (ly:paper-book-pages book))
 187                #:canvas-width page-width
 188                #:canvas-height page-height
 189                #:window-width
 190                ;; huh, *2 -- pixels-per-unit?
 191                (min (+ SCROLLBAR-SIZE (* page-width 2)) screen-width)
 192                #:window-height
 193                (min (+ BUTTON-HEIGHT SCROLLBAR-SIZE (* page-height 2))
 194                     desktop-height))))
 195
 196     ;; ugh.  The GOOPS doc promises this is called automagically.
 197     ;; possibly a goops 1.6.4 problem
 198     (initialize go)
 199
 200     (map ly:pango-add-afm-decoder
 201          '("lilypond-feta"
 202            "lilypond-braces"
 203            "lilypond-dyn"
 204            "lilypond-parmesan"))
 205
 206     (dump-page go 0)
 207
 208     (gtk-main)))
 209
 210 (define (dump-page go number)
 211   (if (or (not (page-stencils go))
 212           (< number 0)
 213           (>= number (vector-length (page-stencils go))))
 214       (stderr "No such page: ~S\n" (1+ number))
 215
 216       (let ((old-canvas (canvas go)))
 217         (new-canvas go)
 218         (set! (page-number go) number)
 219
 220         ;; no destroy method for gnome-canvas-text yet.
 221         ;;(map destroy (gtk-container-get-children main-canvas))
 222         ;;(map destroy text-items)
 223
 224         (set! (text-items go) '())
 225         (debugf "page-stencil ~S: ~S\n"
 226                 (page-number go)
 227                 (vector-ref (page-stencils go) (page-number go)))
 228
 229         (ly:interpret-stencil-expression
 230          ;; ;;(vector-ref (page-stencils go) (page-number go))
 231          (ly:stencil-expr (vector-ref (page-stencils go) (page-number go)))
 232          gnome-output-expression go '(0 . 0))
 233
 234         (if old-canvas (destroy old-canvas))
 235         (add (scrolled go) (canvas go))
 236         (show (canvas go)))))
 237
 238 (define x-editor #f)
 239 (define (get-x-editor)
 240   (if (not x-editor)
 241       (set! x-editor (getenv "XEDITOR")))
 242   x-editor)
 243
 244 (define ifs #f)
 245 (define (get-ifs)
 246   (if (not ifs)
 247       (set! ifs (getenv "IFS")))
 248   (if (not ifs)
 249       (set! ifs "       "))
 250   ifs)
 251
 252 (define (spawn-editor location)
 253   (let* ((file-name (car location))
 254          (line (cadr location))
 255          (column (caddr location))
 256          (template (substring (get-x-editor) 0))
 257
 258          ;; Adhere to %l %c %f?
 259          (command
 260           (regexp-substitute/global
 261            #f "%l" (regexp-substitute/global
 262                     #f "%c"
 263                     (regexp-substitute/global
 264                      #f "%f" template 'pre file-name 'post)
 265                     'pre (number->string column)
 266                     'post)
 267            'pre (number->string line) 'post)))
 268
 269     (debugf "spawning: ~s\n" command)
 270     (if (= (primitive-fork) 0)
 271         (let ((command-list (string-split command #\ )));; (get-ifs))))
 272           (apply execlp command-list)
 273           (primitive-exit)))))
 274
 275 (define location-callback spawn-editor)
 276
 277 (define (get-location grob)
 278   (and-let* ((p? (procedure? point-and-click))
 279              (g grob)
 280              (cause (ly:grob-property grob 'cause))
 281              (music-origin (if (ly:music? cause)
 282                                (ly:music-property cause 'origin)
 283                                ;; How come #<unspecied> [and '()]
 284                                ;; are #t? :-(
 285                                #f)))
 286             (if (ly:input-location? music-origin)
 287                 (ly:input-location music-origin)
 288                 #f)))
 289
 290 (define-method (tweak (go <gnome-outputter>) item offset)
 291   (let* ((grob (hashq-ref (item-grobs go) item #f))
 292          (extra-offset (ly:grob-property grob 'extra-offset))
 293          (origin (if (null? extra-offset) '(0 . 0)
 294                      (cons (car extra-offset)
 295                            (- 0 (cdr extra-offset))))))
 296     (if grob (hashq-set! (grob-tweaks go) grob
 297                          (cons
 298                           'extra-offset
 299                           (list
 300                            (cons (+ (car origin) (car offset))
 301                                  (- 0 (+ (cdr origin) (cdr offset))))))))))
 302
 303 ;; FIXME: this only saves new tweaks, old tweaks are lost.
 304 (define-method (save-tweaks (go <gnome-outputter>))
 305   (let ((tweaks (hash-fold
 306                  (lambda (key value seed)
 307                    (cons (cons (ly:grob-id key) value) seed))
 308                  '() (grob-tweaks go))))
 309     (if (not (null? tweaks))
 310         (let ((file (open-file (string-append (name go) ".twy") "w")))
 311           (format file ";;; TWEAKS \n'~S\n" tweaks)))))
 312
 313 ;;;(define (item-event go grob item event)
 314 (define (item-event go item event)
 315   ;;(stderr "EVENT: ~S\n" event)
 316   ;;(stderr "TYPE: ~S\n" (gdk-event:type event))
 317   (case (gdk-event:type event)
 318     ((enter-notify) (gobject-set-property item 'fill-color "red"))
 319     ((leave-notify) (gobject-set-property item 'fill-color "black"))
 320     ((motion-notify) (if (ly:grob? (dragging go))
 321                          (let ((x (gdk-event-motion:x event))
 322                                (y (gdk-event-motion:y event))
 323                                (s output-scale)
 324                                (r (drag-location go)))
 325                            ;;(stderr "MOVED AT: ~S ~S\n" x y)
 326                            (move item (/ (- x (car r)) s) (/ (- y (cdr r)) s))
 327                            (set! (drag-location go) (cons x y)))))
 328     ((button-release) (if (ly:grob? (dragging go))
 329                           (let ((x (gdk-event-button:x event))
 330                                 (y (gdk-event-button:y event))
 331                                 (s output-scale)
 332                                 (o (drag-origin go))
 333                                 (r (drag-location go)))
 334                             (move item (/ (- x (car r)) s) (/ (- y (cdr r)) s))
 335                             (set! (drag-location go) #f)
 336                             (set! (drag-origin go) #f)
 337                             (stderr "RELEASE at: ~S ~S\n" x y)
 338                             (set! (dragging go) #f)
 339                             (tweak go item (cons (/ (- x (car o)) s)
 340                                                  (/ (- y (cdr o)) s))))))
 341     ((button-press)
 342      (let ((button (gdk-event-button:button event)))
 343        (cond
 344         ((= button 1)
 345          (if (null? (gdk-event-button:modifiers event))
 346              (let ((x (gdk-event-button:x event))
 347                    (y (gdk-event-button:y event)))
 348                (stderr "CLICK at: ~S ~S\n" x y)
 349                (set! (dragging go) (hashq-ref (item-grobs go) item #f))
 350                (set! (drag-origin go) (cons x y))
 351                (set! (drag-location go) (cons x y)))
 352              (begin
 353                (stderr "CLICK WITH MODIFIERS: ~S\n"
 354                        (gdk-event-button:modifiers event))
 355
 356                ;; some modifier, do jump to source
 357                (and-let* ((grob (hashq-ref (item-grobs go) item #f))
 358                           (location (get-location grob)))
 359                          (location-callback location)))))
 360         ((= button 2)
 361          (and-let*
 362           ((grob (hashq-ref (item-grobs go) item #f)))
 363
 364           (let ((properties (ly:grob-properties grob))
 365                 (basic-properties (ly:grob-basic-properties grob))
 366                 (id (ly:grob-id grob))
 367                 (x (inexact->exact (gdk-event-button:x-root event)))
 368                 (y (inexact->exact (gdk-event-button:y-root event))))
 369
 370             (debugf "GROB: ~S\n" grob)
 371             (debugf "PROPERTIES: ~S\n" properties)
 372             (debugf "BASIC PROPERTIES: ~S\n" basic-properties)
 373
 374             ;; FIXME: dialog iso window?
 375             ;; http://www.gtk.org/tutorial/sec-textentries.html
 376             (let ((window (make <gtk-window>))
 377                   (vbox (make <gtk-vbox>))
 378                   (button (make <gtk-button> #:label "Ok")))
 379
 380               (add window vbox)
 381               (connect button 'clicked (lambda (b) (destroy window)))
 382
 383               (for-each
 384                (lambda (x)
 385                  (let ((button (make <gtk-button>
 386                                  #:xalign 0.0
 387                                  #:label
 388                                  (string-append
 389                                   (symbol->string (car x))
 390                                   ": "
 391                                   (format #f "~S" (cdr x))))))
 392                    (set-size-request button 150 BUTTON-HEIGHT)
 393                    (add vbox button)))
 394                (cons (list id) properties))
 395               (add vbox button)
 396
 397               ;; FIXME: how to do window placement?
 398               ;; - no effect:
 399               (move window x y)
 400               (show-all window)
 401               ;; - shows actual movement:
 402               (move window x y)
 403               )))))))
 404
 405     ((2button-press) (gobject-set-property item 'fill-color "green"))
 406     ((key-press)
 407      (let ((keyval (gdk-event-key:keyval event))
 408            (mods (gdk-event-key:modifiers event))
 409            (step (quotient (pixels-per-unit go) 2)))
 410        (cond ((and (null? mods)
 411                    (eq? keyval gdk:Up))
 412               (tweak go item (cons 0 (- 0 step))))
 413              ((and (null? mods)
 414                    (eq? keyval gdk:Down))
 415               (tweak go item (cons 0 step)))
 416              ((and (null? mods)
 417                    (eq? keyval gdk:Left))
 418               (tweak go item (cons (- 0 step) 0)))
 419              ((and (null? mods)
 420                    (eq? keyval gdk:Right))
 421               (tweak go item (cons step 0)))))))
 422   #t)
 423
 424 (define (scale-canvas go factor)
 425   (set! (pixels-per-unit go) (* (pixels-per-unit go) factor))
 426   (set-pixels-per-unit (canvas go) (pixels-per-unit go))
 427   (for-each
 428    (lambda (x)
 429      (let ((scale (gobject-get-property x 'scale))
 430            (points (gobject-get-property x 'size-points)))
 431        ;;(gobject-set-property x 'scale pixels-per-unit)
 432        (gobject-set-property x 'size-points (* points factor))))
 433      (text-items go)))
 434
 435 (define (key-press-event go item event)
 436   (let ((keyval (gdk-event-key:keyval event))
 437         (mods (gdk-event-key:modifiers event)))
 438     (cond ((and (or (eq? keyval gdk:q)
 439                     (eq? keyval gdk:w))
 440                 (equal? mods '(control-mask modifier-mask)))
 441            (gtk-main-quit))
 442           ((and #t ;;(null? mods)
 443                 (eq? keyval gdk:plus))
 444            (scale-canvas go 2))
 445           ((and #t ;; (null? mods)
 446                 (eq? keyval gdk:minus))
 447            (scale-canvas go 0.5))
 448           ((or (eq? keyval gdk:Page-Up)
 449                (eq? keyval gdk:BackSpace))
 450            (dump-page go (1- (page-number go))))
 451           ((or (eq? keyval gdk:Page-Down)
 452                (eq? keyval gdk:space))
 453            (dump-page go (1+ (page-number go)))))
 454     #f))
 455
 456 (define (new-canvas go)
 457   (set! (canvas go) (make <gnome-canvas>))
 458   (set-size-request (canvas go) (window-width go) (window-height go))
 459   (set-scroll-region (canvas go) 0 0 (canvas-width go) (canvas-height go))
 460   (set-pixels-per-unit (canvas go) (pixels-per-unit go))
 461   (make <gnome-canvas-rect>
 462     #:parent (root (canvas go))
 463     #:x2 (canvas-width go) #:y2 (canvas-height go)
 464     #:fill-color "white"))
 465
 466 (define output-gnome-module #f)
 467 (define (get-output-gnome-module go)
 468   (if (not output-gnome-module)
 469       (let ((m  (resolve-module '(scm output-gnome))))
 470         (module-define! m 'canvas-root (lambda () (root (canvas go))))
 471         (module-define! m 'output-scale output-scale)
 472         (set! output-gnome-module m)))
 473   output-gnome-module)
 474
 475 (define-public (gnome-output-expression go expr)
 476   (let* ((m (get-output-gnome-module go))
 477          (result (eval expr m)))
 478     (cond
 479      ((ly:grob? result) (set! (grob go) result))
 480      ((is-a? result <gnome-canvas-item>)
 481
 482       ;; AAARGH; grobs happen after stencils
 483       ;; (connect result 'event (lambda (w e) (item-event go (grob go) w e)))
 484       (connect result 'event (lambda (w e) (item-event go w e)))
 485       (if (grob go)
 486           (hashq-set! (item-grobs go) result (grob go)))
 487       (set! (grob go) #f)
 488
 489       (if (is-a? result <gnome-canvas-text>)
 490           (set! (text-items go) (cons result (text-items go))))))))