/usr/share/guile-gnome-2/gnome/contrib/texinfo-buffer.scm is in guile-gnome2-gtk 2.16.1-6ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 | ;; guile-lib
;; Copyright (C) 2003,2004 Andy Wingo <wingo at pobox dot com>
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of
;; the License, or (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, contact:
;;
;; Free Software Foundation Voice: +1-617-542-5942
;; 59 Temple Place - Suite 330 Fax: +1-617-542-2652
;; Boston, MA 02111-1307, USA gnu@gnu.org
;;; Commentary:
;;
;;Renders texinfo into a GtkTextBuffer; requires guile-lib to work.
;;
;;; Code:
(define-module (gnome contrib texinfo-buffer)
#:use-module (texinfo)
#:use-module (sxml transform)
#:use-module (sxml simple)
#:use-module (scheme documentation)
#:use-module (oop goops)
#:use-module (gnome gtk)
#:use-module (gnome gtk gdk-event)
#:use-module (gnome gobject)
#:use-module (gnome pango)
#:export (stexi->gtk-text-buffer
stexi-buffer-xref-activated-hook))
;; don't allow the exp to affect the-last-stack
(define-macro (false-if-exception exp)
`(catch #t
(lambda ()
(with-fluids ((the-last-stack (fluid-ref the-last-stack)))
,exp))
(lambda args #f)))
(define url-show
(or
(false-if-exception
(module-ref (resolve-interface '(gnome gnome)) 'gnome-url-show))
(lambda (u x)
(pk "Hmm, implement a non-gnome URL handler..." u))))
;; The two arguments are the node name and the manual name or #f
(define-with-docs stexi-buffer-xref-activated-hook
"A hook run when the user activates a cross-reference. The two
arguments to the functions are the name of the node and the name of the
manual."
(make-hook 2))
(define tag-table (make <gtk-text-tag-table>))
(define tag-prop-alist
;; List the non-inline styles first so inlines get priority
'((center . (#:justification center))
(example . (#:font "Monospace" #:wrap-mode none
#:pixels-below-lines 0 #:pixels-above-lines 0 #:left-margin 20))
(smallexample . (#:font "Monospace" #:wrap-mode none #:scale 0.9
#:pixels-below-lines 0 #:pixels-above-lines 0 #:left-margin 20))
(cartouche . (#:pixels-below-lines 6 #:pixels-above-lines 6 #:pixels-inside-wrap 0
#:left-margin 25 #:right-margin 25 #:background "grey"
#:justification center))
(title . (#:pixels-above-lines 6 #:pixels-below-lines 12 #:scale 1.4399999999 #:weight 700))
(subtitle . (#:pixels-above-lines 0 #:pixels-below-lines 12 #:scale 1.2 #:weight 700))
(author . (#:pixels-above-lines 0 #:pixels-below-lines 12 #:scale 1.2 #:weight 700))
;; Assuming chapters and sections fall at the beginning of a buffer.
;; Not too good of an assumption. Better would be to detect if we're
;; at the start of a buffer, then adjust the tag accordingly.
(chapter . (#:pixels-above-lines 6 #:pixels-below-lines 18 #:scale 1.4399999999 #:weight 700))
(majorheading . (#:pixels-above-lines 6 #:pixels-below-lines 18 #:scale 1.4399999999 #:weight 700))
(chapheading . (#:pixels-above-lines 6 #:pixels-below-lines 18 #:scale 1.4399999999 #:weight 700))
(section . (#:pixels-above-lines 6 #:pixels-below-lines 18 #:scale 1.4399999999 #:weight 700))
(heading . (#:pixels-above-lines 6 #:pixels-below-lines 18 #:scale 1.4399999999 #:weight 700))
(appendix . (#:pixels-above-lines 6 #:pixels-below-lines 18 #:scale 1.4399999999 #:weight 700))
(appendixsec . (#:pixels-above-lines 6 #:pixels-below-lines 18 #:scale 1.4399999999 #:weight 700))
(unnumbered . (#:pixels-above-lines 6 #:pixels-below-lines 18 #:scale 1.4399999999 #:weight 700))
(unnumberedsec . (#:pixels-above-lines 6 #:pixels-below-lines 18 #:scale 1.4399999999 #:weight 700))
(subsection . (#:pixels-above-lines 12 #:pixels-below-lines 6 #:scale 1.2 #:weight 700))
(subheading . (#:pixels-above-lines 12 #:pixels-below-lines 6 #:scale 1.2 #:weight 700))
(subsubsection . (#:pixels-above-lines 6 #:pixels-below-lines 6 #:weight 700))
(subsubheading . (#:pixels-above-lines 6 #:pixels-below-lines 6 #:weight 700))
(appendixsubsec . (#:pixels-above-lines 12 #:pixels-below-lines 6 #:scale 1.2 #:weight 700))
(appendixsubsubsec . (#:pixels-above-lines 6 #:pixels-below-lines 6 #:weight 700))
(unnumberedsubsec . (#:pixels-above-lines 12 #:pixels-below-lines 6 #:scale 1.2 #:weight 700))
(unnumberedsubsubsec . (#:pixels-above-lines 6 #:pixels-below-lines 6 #:weight 700))
(para . (#:pixels-below-lines 6))
(enumerate . (#:pixels-below-lines 6)) ;; FIXME!
(itemize . (#:pixels-below-lines 6)) ;; FIXME!
(table . (#:left-margin 50 #:right-margin 25))
(ftable . (#:left-margin 50 #:right-margin 25))
(vtable . (#:left-margin 50 #:right-margin 25))
(def-header . (#:pixels-below-lines 0 #:indent -100))
(def-body . (#:right-margin 50)) ;; left is handled by the *nest*
(quotation . (#:left-margin 50 #:right-margin 50 #:scale 0.9))
(entry-header . (#:pixels-above-lines 6 #:pixels-below-lines 0))
(entry-body . (#:right-margin 50)) ;; left is handled by the *nest*
(asis . ())
(bold . (#:weight 700))
(item . (#:left-margin 25 #:right-margin 25 #:pixels-below-lines 0))
(itemx . (#:left-margin 25 #:right-margin 25 #:pixels-below-lines 0))
(sample . (#:font "Monospace"))
(samp . (#:font "Monospace"))
(code . (#:font "Monospace"))
(kbd . (#:font "Monospace" #:style oblique))
(key . (#:font "Monospace" #:variant small-caps))
(var . (#:font "Monospace" #:style italic))
(env . (#:font "Monospace"))
(file . (#:font "Monospace"))
(command . (#:font "Monospace"))
(option . (#:font "Monospace"))
(dfn . (#:style italic #:weight 700))
(cite . (#:style italic))
(acro . (#:scale 0.8333333333))
(url . (#:font "Monospace"))
(email . (#:font "Monospace"))
(emph . (#:style italic))
(strong . (#:weight 700))
(sc . (#:variant small-caps))
(small . (#:scale 0.5 #:pixels-below-lines 0)) ;; only used for weird newlines in examples
))
(for-each ;; Make the tags now so the priorities are correct
(lambda (pair)
(let ((tag (apply make <gtk-text-tag> #:name (symbol->string (car pair)) (cdr pair))))
(add tag-table tag)))
tag-prop-alist)
(define (get-tag name)
(lookup tag-table (symbol->string name)))
(define (arg-ref name args)
(assq-ref (cdr args) name))
(define (arg-req name args)
(or (arg-ref name args)
(error "Required argument missing" name args)))
(define (arg-req* names args)
(or (or-map (lambda (name) (arg-ref name args)) names)
(error "Required argument missing" names args)))
(define (identity tag . body)
body)
;; We can't have after-paragraph space, because there are newlines in
;; examples. Hack around it by putting an extra newline at the end.
(define (example tag . body)
`(example ,@body #\newline (small #\newline)))
(define (smallexample tag . body)
`(smallexample ,@body #\newline (small #\newline)))
(define-class <stexi-ref-tag> (<gtk-text-tag>)
(node #:gparam `(,<gparam-boxed> #:boxed-type ,<gboxed-scm>
#:flags (read write)))
(manual #:gparam `(,<gparam-boxed> #:boxed-type ,<gboxed-scm>
#:flags (read write))))
(define-method (initialize (obj <stexi-ref-tag>) initargs)
(next-method)
(set obj 'foreground "blue")
(set obj 'underline 'single)
(connect obj 'event
(lambda (tag object event iter)
(if (eq? (gdk-event:type event) 'button-press)
(run-hook stexi-buffer-xref-activated-hook
(slot-ref obj 'node)
(slot-ref obj 'manual)))
#f)))
(define (ref tag args)
(list (let ((tag (make <stexi-ref-tag>
#:node (car (arg-req 'node args))
#:manual (and=> (arg-ref 'manual args) car))))
(add tag-table tag)
tag)
(case tag
((xref) "See ") ((pxref) "see ") (else ""))
(car (arg-req* '(node section) args))))
(define-class <stexi-uref-tag> (<gtk-text-tag>)
(url #:gparam `(,<gparam-string> #:flags (read write))))
(define-method (initialize (obj <stexi-uref-tag>) initargs)
(next-method)
(set obj 'foreground "blue")
(set obj 'underline 'single)
;; Unfortunately, we can't make the cursor go to a hand when the mouse
;; is over a tag, because the tag has no window. The proper way to do
;; this is to put a GtkLabel in the text flow. The future!
(connect obj 'event
(lambda (tag object event iter)
(if (eq? (gdk-event:type event) 'button-press)
(begin
(format #t "\nshowing ~A in new window\n" (slot-ref obj 'url))
(url-show (slot-ref obj 'url))))
#f)))
(define (uref tag args)
(list (let ((tag (make <stexi-uref-tag>
#:url (car (arg-req 'url args)))))
(add tag-table tag)
tag)
(car (arg-req* '(title url) args))))
(define (node tag args)
`(*mark* ,(string-append "node-" (car (arg-req 'name args)))))
(define (nest . args)
(list '*nest* args))
(define (def tag args . body)
(define (wrap t)
(lambda (x) (list t x)))
(define (compose f . rest)
(cond ((null? rest) f)
(else (let ((g (apply compose rest)))
(lambda (x) (f (g x)))))))
(define (splice/space arg wrapper)
(cond ((arg-ref arg args)
=> (lambda (val) `(,@(map wrapper val) " ")))
(else '())))
`((def-header
,@(splice/space 'data-type (wrap 'code))
,@(splice/space 'class (compose (wrap 'bold) (wrap 'code)))
,@(splice/space 'name (compose (wrap 'bold) (wrap 'code)))
,@(splice/space 'arguments
(compose
(if (memq tag '(deftypeop deftypefn deftypefun))
(compose (wrap 'var) (wrap 'code))
(wrap 'code))
stexi->text-tagged-tree))
#\newline)
(*nest*
,(case tag
((defun) "Function")
((defspec) "Special Form")
((defvar) "Variable")
(else (car (arg-req 'category args))))
#\newline
(def-body ,@body))))
(define *table-formatter* (make-fluid))
(fluid-set! *table-formatter* 'asis) ;; just in case
(define (table tag args . body)
(with-fluids ((*table-formatter* (arg-req 'formatter args)))
(nest body)))
(define (entry tag args . body)
`((entry-header (,(fluid-ref *table-formatter*)
,(stexi->text-tagged-tree (arg-req 'heading args))
#\newline))
(*nest* (entry-body ,@body))))
(define ignore-list
'(page setfilename setchapternewpage iftex ifhtml ifplaintext ifxml sp vskip
menu ignore syncodeindex comment c ifinfo cindex findex vindex tindex
kindex pindex))
(define (default-handler tag . body)
(cond
((assq tag tag-prop-alist)
`(,tag
,@body
,(if (memq (cadr (assq tag texi-command-specs))
'(EOL-TEXT ENVIRON PARAGRAPH ITEM ENTRY))
#\newline
#f)))
((memq tag ignore-list)
#f)
(else
(warn "No handler for" tag)
body)))
;; strategy: first do pre-post-order transformation from stexi to a tree
;; headed with tags indicating which tag should be applied to the text.
;; then display the document.
(define rules
`((% *preorder* . ,(lambda args args))
(texinfo . ,identity)
(example . ,example)
(lisp . ,example)
(verbatim . ,example)
(smallexample . ,smallexample)
(smalllisp . ,smallexample)
(xref . ,ref)
(ref . ,ref)
(pxref . ,ref)
(uref . ,uref)
(node . ,node)
(anchor . ,node)
(table . ,table)
(entry . ,entry)
(enumerate . ,nest)
(itemize . ,nest)
(copyright . ,(lambda args (string #\302 #\251)))
(result . ,(lambda args (string #\342 #\207 #\222)))
(deftp . ,def)
(defcv . ,def)
(defivar . ,def)
(deftypeivar . ,def)
(defop . ,def)
(deftypeop . ,def)
(defmethod . ,def)
(deftypemethod . ,def)
(defopt . ,def)
(defvr . ,def)
(defvar . ,def)
(deftypevr . ,def)
(deftypevar . ,def)
(deffn . ,def)
(deftypefn . ,def)
(defmac . ,def)
(defspec . ,def)
(defun . ,def)
(deftypefun . ,def)
(tie . ,(lambda args " "))
(*text* . ,(lambda (tag x) x))
(*default* . ,default-handler)))
(define (with-tag tag buffer proc . args)
(let ((left (create-mark buffer #f (get-end-iter buffer) #t)))
(apply proc args)
(apply-tag buffer tag
(get-iter-at-mark buffer left) (get-end-iter buffer))
(delete-mark buffer left)))
(define *indent* (make-fluid))
(fluid-set! *indent* 0)
(define (make-nesting-tag)
((lambda (x) (add tag-table x) x)
(make <gtk-text-tag> #:left-margin (fluid-ref *indent*))))
(define (with-nesting buffer proc . args)
(with-fluids ((*indent* (+ (fluid-ref *indent*) 35)))
(apply with-tag (make-nesting-tag) buffer proc args)))
;; Note that errors in this file are caused by inconsistencies produced
;; in the transformation stage, not by problems in the stexi.
(define (fill-buffer buffer tree)
(define (handle-body l)
(for-each (lambda (x) (fill-buffer buffer x)) l))
(cond
((string? tree)
(insert buffer (get-end-iter buffer) tree))
((char? tree)
(insert buffer (get-end-iter buffer) (string tree)))
((or (not tree) (null? tree))) ;; nothing
(else
(cond
((not (pair? tree))
(error "invalid stexi tree" tree))
((symbol? (car tree))
(case (car tree)
((*nest*)
(with-nesting buffer handle-body (cdr tree)))
((*mark*)
(create-mark buffer (cadr tree) (get-end-iter buffer) #t))
((%) #f) ;; do nothing
(else
(with-tag (or (get-tag (car tree)) (error "yikes!" tree))
buffer handle-body (cdr tree)))))
((is-a? (car tree) <gtk-text-tag>)
(with-tag (car tree) buffer handle-body (cdr tree)))
(else
;; maybe the tree transform made a nontagged list
(handle-body tree))))))
(define (stexi->text-tagged-tree stexi)
(pre-post-order stexi rules))
(define (stexi->gtk-text-buffer stexi)
(let ((buffer (make <gtk-text-buffer> #:tag-table tag-table)))
(fill-buffer buffer (stexi->text-tagged-tree stexi))
buffer))
|