1 ;;; htmlfontify.el --- htmlise a buffer/source tree with optional hyperlinks
3 ;; Copyright (C) 2002, 2003, 2009, 2010 Free Software Foundation, Inc.
5 ;; Emacs Lisp Archive Entry
6 ;; Package: htmlfontify
7 ;; Filename: htmlfontify.el
9 ;; Keywords: html, hypermedia, markup, etags
10 ;; Author: Vivek Dasmohapatra <vivek@etla.org>
11 ;; Maintainer: Vivek Dasmohapatra <vivek@etla.org>
12 ;; Created: 2002-01-05
13 ;; Description: htmlise a buffer/source tree with optional hyperlinks
14 ;; URL: http://rtfm.etla.org/emacs/htmlfontify/
15 ;; Compatibility: Emacs23, Emacs22
16 ;; Incompatibility: Emacs19, Emacs20, Emacs21
17 ;; Last Updated: Thu 2009-11-19 01:31:21 +0000
20 ;; This file is part of GNU Emacs.
22 ;; GNU Emacs is free software: you can redistribute it and/or modify
23 ;; it under the terms of the GNU General Public License as published by
24 ;; the Free Software Foundation, either version 3 of the License, or
25 ;; (at your option) any later version.
27 ;; GNU Emacs is distributed in the hope that it will be useful,
28 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
29 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 ;; GNU General Public License for more details.
32 ;; You should have received a copy of the GNU General Public License
33 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
36 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
37 ;; I have made some changes to make it work for Emacs 22. A lot of
38 ;; small bug fixes related to the format of text and overlay
39 ;; properties (which might have changed since the beginning of 2003
40 ;; when this file was originally written).
42 ;; The function `hfy-face-at' currently carries much of the burden of
43 ;; my lacking understanding of the formats mentioned above and should
44 ;; need some knowledgeable help.
46 ;; Another thing that maybe could be fixed is that overlay background
47 ;; colors which are now only seen where there is text (in the XHTML
48 ;; output). A bit of CSS tweaking is necessary there.
50 ;; The face 'default has a value :background "SystemWindow" for the
51 ;; background color. There is no explicit notion that this should be
52 ;; considered transparent, but I have assumed that it could be handled
53 ;; like if it was here. (I am unsure that background and foreground
54 ;; priorities are handled ok, but it looks ok in my tests now.)
56 ;; 2007-12-27 Lennart Borgman
57 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
59 ;; Here's some elisp code to html-pretty-print an Emacs buffer, preserving
60 ;; the Emacs syntax/whatever highlighting. It also knows how to drive etags
61 ;; (exuberant-ctags or Emacs etags) and hyperlink the code according
62 ;; to its (etags') output.
64 ;; NOTE: Currently the hyperlinking code only knows how to drive GNU find
65 ;; and the exuberant and GNU variants of etags : I do not know of any other
66 ;; etags variants, but mechanisms have been provided to allow htmlfontify
67 ;; to be taught how to drive them. As long as your version of find has
68 ;; the -path test and is reasonably sane, you should be fine.
70 ;; A sample of the htmlfontified / hyperlinked output of this module can be
71 ;; found at http://rtfm.etla.org/sql/dbishell/src/ - it's not perfect, but
72 ;; it's a hell of a lot faster and more thorough than I could hope to be
73 ;; doing this by hand.
75 ;; some user / horrified onlooker comments:
76 ;; What? No! There's something deeply wrong here... (R. Shufflebotham)
77 ;; You're a freak. (D. Silverstone)
78 ;; Aren't we giving you enough to do? (J. Busuttil)
79 ;; You're almost as messed up as Lexx is! (N. Graves-Morris)
82 ;; Changes: moved to changelog (CHANGES) file.
85 (eval-when-compile (require 'cl
))
87 ;; (`facep' `face-attr-construct' `x-color-values' `color-values' `face-name')
89 ;; (`defgroup' `defcustom')
91 ;; (`font-lock-fontify-region')
94 (defconst htmlfontify-version
0.21)
96 (defconst hfy-meta-tags
97 (format "<meta name=\"generator\" content=\"emacs %s; htmlfontify %0.2f\" />"
98 emacs-version htmlfontify-version
)
99 "The generator meta tag for this version of htmlfontify.")
101 (defconst htmlfontify-manual
"Htmlfontify Manual"
102 "Copy and convert buffers and files to HTML, adding hyperlinks between files
103 \(driven by etags) if requested.
104 \nInteractive functions:
106 `htmlfontify-run-etags'
107 `htmlfontify-copy-and-link-dir'
108 `htmlfontify-load-rgb-file'
109 `htmlfontify-unload-rgb-file'\n
111 fontify a file you have open: M-x htmlfontify-buffer
112 prepare the etags map for a directory: M-x htmlfontify-run-etags
113 copy a directory, fontifying as you go: M-x htmlfontify-copy-and-link-dir\n
114 The following might be useful when running non-windowed or in batch mode:
115 \(note that they shouldn't be necessary - we have a built in map)\n
116 load an X11 style rgb.txt file: M-x htmlfontify-load-rgb-file
117 unload the current rgb.txt file: M-x htmlfontify-unload-rgb-file\n
118 And here's a programmatic example:\n
119 \(defun rtfm-build-page-header (file style)
120 (format \"#define TEMPLATE red+black.html
122 #include <build/menu-dirlist|>\\n
123 html-css-url := /css/red+black.css
124 title := rtfm.etla.org ( %s / src/%s )
126 head <=STYLESHEET;\\n
129 main-title := rtfm / %s / src/%s\\n
130 main-content <=MAIN_CONTENT;\\n\" rtfm-section file style rtfm-section file))
132 \(defun rtfm-build-page-footer (file) \"\\nMAIN_CONTENT\\n\")
134 \(defun rtfm-build-source-docs (section srcdir destdir)
136 \"s section[eg- emacs / p4-blame]:\\nD source-dir: \\nD output-dir: \")
137 (require 'htmlfontify)
138 (hfy-load-tags-cache srcdir)
139 (let ((hfy-page-header 'rtfm-build-page-header)
140 (hfy-page-footer 'rtfm-build-page-footer)
141 (rtfm-section section)
142 (hfy-index-file \"index\"))
143 (htmlfontify-run-etags srcdir)
144 (htmlfontify-copy-and-link-dir srcdir destdir \".src\" \".html\")))")
146 (defgroup htmlfontify nil
147 "Convert buffers and files to HTML."
149 :link
'(variable-link htmlfontify-manual
)
152 (defcustom hfy-page-header
'hfy-default-header
153 "Function called with two arguments (the filename relative to the top
154 level source directory being etag'd and fontified), and a string containing
155 the <style>...</style> text to embed in the document- the string returned will
156 be used as the header for the htmlfontified version of the source file.\n
157 See also `hfy-page-footer'."
159 ;; FIXME: Why place such a :tag everywhere? Isn't it imposing your
160 ;; own Custom preference on your users? --Stef
164 (defcustom hfy-split-index nil
165 "Whether or not to split the index `hfy-index-file' alphabetically
166 on the first letter of each tag. Useful when the index would otherwise
167 be large and take a long time to render or be difficult to navigate."
172 (defcustom hfy-page-footer
'hfy-default-footer
173 "As `hfy-page-header', but generates the output footer
174 \(and takes only one argument, the filename)."
179 (defcustom hfy-extn
".html"
180 "File extension used for output files."
185 (defcustom hfy-src-doc-link-style
"text-decoration: underline;"
186 "String to add to the '<style> a' variant of an htmlfontify CSS class."
188 :tag
"src-doc-link-style"
191 (defcustom hfy-src-doc-link-unstyle
" text-decoration: none;"
192 "Regex to remove from the <style> a variant of an htmlfontify CSS class."
194 :tag
"src-doc-link-unstyle"
197 (defcustom hfy-link-extn nil
198 "File extension used for href links.
199 Useful where the htmlfontify output files are going to be processed
200 again, with a resulting change in file extension. If nil, then any
201 code using this should fall back to `hfy-extn'."
203 :tag
"link-extension"
204 :type
'(choice string
(const nil
)))
206 (defcustom hfy-link-style-fun
'hfy-link-style-string
207 "Set this to a function, which will be called with one argument
208 \(a \"{ foo: bar; ...}\" CSS style-string) - it should return a copy of
209 its argument, altered so as to make any changes you want made for text which
210 is a hyperlink, in addition to being in the class to which that style would
211 normally be applied."
213 :tag
"link-style-function"
216 (defcustom hfy-index-file
"hfy-index"
217 "Name (sans extension) of the tag definition index file produced during
218 fontification-and-hyperlinking."
223 (defcustom hfy-instance-file
"hfy-instance"
224 "Name (sans extension) of the tag usage index file produced during
225 fontification-and-hyperlinking."
230 (defcustom hfy-html-quote-regex
"\\(<\\|\"\\|&\\|>\\)"
231 "Regex to match (with a single back-reference per match) strings in HTML
232 which should be quoted with `hfy-html-quote' (and `hfy-html-quote-map')
235 :tag
"html-quote-regex"
238 (define-obsolete-variable-alias 'hfy-init-kludge-hooks
'hfy-init-kludge-hook
240 (defcustom hfy-init-kludge-hook
'(hfy-kludge-cperl-mode)
241 "List of functions to call when starting `htmlfontify-buffer' to do any
242 kludging necessary to get highlighting modes to behave as you want, even
243 when not running under a window system."
245 :tag
"init-kludge-hooks"
248 (defcustom hfy-post-html-hooks nil
249 "List of functions to call after creating and filling the HTML buffer.
250 These functions will be called with the html buffer as the current buffer."
252 :tag
"post-html-hooks"
253 :options
'(set-auto-mode)
256 (defcustom hfy-default-face-def nil
257 "Fallback `defface' specification for the face 'default, used when
258 `hfy-display-class' has been set (the normal htmlfontify way of extracting
259 potentially non-current face information doesn't necessarily work for
261 Example: I customize this to:\n
262 \((t :background \"black\" :foreground \"white\" :family \"misc-fixed\"))"
264 :tag
"default-face-definition"
267 (defcustom hfy-etag-regex
(concat ".*"
268 "\x7f" "\\([^\x01\n]+\\)"
269 "\x01" "\\([0-9]+\\)"
271 "\\|" ".*\x7f[0-9]+,[0-9]+$")
272 "Regex used to parse an etags entry: must have 3 subexps, corresponding,
276 3 - The char (point) at which the tag occurs."
281 (defcustom hfy-html-quote-map
'(("\"" """)
285 "Alist of char -> entity mappings used to make the text HTML-safe."
287 :tag
"html-quote-map"
288 :type
'(alist :key-type
(string)))
290 (defconst hfy-e2x-etags-cmd
"for src in `find . -type f`;
294 *.ad[absm]|*.[CFHMSacfhlmpsty]|*.def|*.in[cs]|*.s[as]|*.src|*.cc|\\
295 *.hh|*.[chy]++|*.[ch]pp|*.[chy]xx|*.pdb|*.[ch]s|*.[Cc][Oo][Bb]|\\
296 *.[eh]rl|*.f90|*.for|*.java|*.[cem]l|*.clisp|*.lisp|*.[Ll][Ss][Pp]|\\
297 [Mm]akefile*|*.pas|*.[Pp][LlMm]|*.psw|*.lm|*.pc|*.prolog|*.oak|\\
298 *.p[sy]|*.sch|*.scheme|*.[Ss][Cc][Mm]|*.[Ss][Mm]|*.bib|*.cl[os]|\\
299 *.ltx|*.sty|*.TeX|*.tex|*.texi|*.texinfo|*.txi|*.x[bp]m|*.yy|\\
310 SHEBANG=`head -n1 ${src} | grep '#!' -c`;
311 if [ ${SHEBANG} -eq 1 ];
321 (defconst hfy-etags-cmd-alist-default
322 `(("emacs etags" .
,hfy-e2x-etags-cmd
)
323 ("exuberant ctags" .
"%s -R -f -" )))
325 (defcustom hfy-etags-cmd-alist
326 hfy-etags-cmd-alist-default
327 "Alist of possible shell commands that will generate etags output that
328 `htmlfontify' can use. '%s' will be replaced by `hfy-etags-bin'."
330 :tag
"etags-cmd-alist"
331 :type
'(alist :key-type
(string) :value-type
(string)) ))
333 (defcustom hfy-etags-bin
"etags"
334 "Location of etags binary (we begin by assuming it's in your path).\n
335 Note that if etags is not in your path, you will need to alter the shell
336 commands in `hfy-etags-cmd-alist'."
341 (defcustom hfy-shell-file-name
"/bin/sh"
342 "Shell (bourne or compatible) to invoke for complex shell operations."
344 :tag
"shell-file-name"
347 (defcustom hfy-ignored-properties
'(read-only
350 insert-in-front-hooks
354 "Properties to omit when copying a fontified buffer for HTML transformation."
356 :tag
"ignored-properties"
357 :type
'(repeat symbol
))
359 (defun hfy-which-etags ()
360 "Return a string indicating which flavour of etags we are using."
361 (let ((v (shell-command-to-string (concat hfy-etags-bin
" --version"))))
362 (cond ((string-match "exube" v
) "exuberant ctags")
363 ((string-match "GNU E" v
) "emacs etags" )) ))
365 (defcustom hfy-etags-cmd
366 (eval-and-compile (cdr (assoc (hfy-which-etags) hfy-etags-cmd-alist
)))
367 "The etags equivalent command to run in a source directory to generate a tags
368 file for the whole source tree from there on down. The command should emit
369 the etags output on stdout.\n
370 Two canned commands are provided - they drive Emacs' etags and
371 exuberant-ctags' etags respectively."
374 :type
(eval-and-compile
375 (let ((clist (list '(string))))
376 (dolist (C hfy-etags-cmd-alist
)
377 (push (list 'const
:tag
(car C
) (cdr C
)) clist
))
378 (cons 'choice clist
)) ))
380 (defcustom hfy-istext-command
"file %s | sed -e 's@^[^:]*:[ \t]*@@'"
381 "Command to run with the name of a file, to see whether it is a text file
382 or not. The command should emit a string containing the word 'text' if
383 the file is a text file, and a string not containing 'text' otherwise."
385 :tag
"istext-command"
388 (defcustom hfy-find-cmd
389 "find . -type f \\! -name \\*~ \\! -name \\*.flc \\! -path \\*/CVS/\\*"
390 "Find command used to harvest a list of files to attempt to fontify."
395 (defcustom hfy-display-class nil
396 "Display class to use to determine which display class to use when
397 calculating a face's attributes. This is useful when, for example, you
398 are running Emacs on a tty or in batch mode, and want htmlfontify to have
399 access to the face spec you would use if you were connected to an X display.\n
400 Some valid class specification elements are:\n
409 Multiple values for a tag may be combined, to indicate that any one or more
410 of these values in the specification key constitutes a match, eg:\n
411 '((class color grayscale) (type tty)) would match any of:\n
414 '((class color grayscale))
417 '((type tty) (class color))\n
419 :type
'(alist :key-type
(symbol) :value-type
(symbol))
422 :options
'((type (choice (const :tag
"X11" x-toolkit
)
423 (const :tag
"Terminal" tty
)
424 (const :tag
"Lucid Toolkit" lucid
)
425 (const :tag
"Motif Toolkit" motif
)))
427 (class (choice (const :tag
"Colour" color
)
428 (const :tag
"Greyscale" grayscale
)))
430 (background (choice (const :tag
"Dark" dark
)
431 (const :tag
"Bright" light
))) ))
433 (defcustom hfy-optimisations
(list 'keep-overlays
)
434 "Optimizations to turn on: So far, the following have been implemented:\n
435 merge-adjacent-tags: If two (or more) span tags are adjacent, identical and
436 separated by nothing more than whitespace, they will
437 be merged into one span.
438 zap-comment-links : Suppress hyperlinking of tags found in comments.
439 zap-string-links : Suppress hyperlinking of tags found in strings.
440 div-wrapper : Add <div class=\"default\"> </div> tags around the
442 keep-overlays : More of a bell (or possibly whistle) than an
443 optimization - If on, preserve overlay highlighting
444 (cf ediff or goo-font-lock) as well as basic faces.\n
445 And the following are planned but not yet available:\n
446 kill-context-leak : Suppress hyperlinking between files highlighted by
448 Note: like compiler optimizations, these optimize the _output_ of the code,
449 not the processing of the source itself, and are therefore likely to slow
450 htmlfontify down, at least a little. Except for skip-refontification,
451 which can never slow you down, but may result in incomplete fontification."
452 :type
'(set (const :tag
"merge-adjacent-tags" merge-adjacent-tags
)
453 (const :tag
"zap-comment-links" zap-comment-links
)
454 (const :tag
"zap-string-links" zap-string-links
)
455 (const :tag
"skip-refontification" skip-refontification
)
456 (const :tag
"kill-context-leak" kill-context-leak
)
457 (const :tag
"div-wrapper" div-wrapper
)
458 (const :tag
"keep-overlays" keep-overlays
))
460 :tag
"optimizations")
462 (defvar hfy-tags-cache nil
463 "Alist of the form:\n
464 \((\"/src/dir/0\" . tag-hash0) (\"/src/dir/1\" tag-hash1) ...)\n
465 Each tag hash entry then contains entries of the form:\n
466 \"tag_string\" => ((\"file/name.ext\" line char) ... )\n
467 ie an alist mapping (relative) file paths to line and character offsets.\n
468 See also `hfy-load-tags-cache'.")
470 (defvar hfy-tags-sortl nil
471 "Alist of the form ((\"/src/dir\" . (tag0 tag1 tag2)) ... )\n
472 where the tags are stored in descending order of length.\n
473 See also `hfy-load-tags-cache'.")
475 (defvar hfy-tags-rmap nil
476 "Alist of the form ((\"/src/dir\" . tag-rmap-hash))\n
477 where tag-rmap-hash has entries of the form:
478 \"tag_string\" => ( \"file/name.ext\" line char )
479 Unlike `hfy-tags-cache' these are the locations of occurrences of
480 tagged items, not the locations of their definitions.")
482 (defvar hfy-style-assoc
'please-ignore-this-line
483 "An assoc representing/describing an Emacs face.
484 Properties may be repeated, in which case later properties should be
485 treated as if they were inherited from a 'parent' font.
486 \(For some properties, only the first encountered value is of any importance,
487 for others the values might be cumulative, and for others they might be
488 cumulative in a complex way.)\n
490 \(hfy-face-to-style 'default) =>
491 ((\"background\" . \"rgb(0, 0, 0)\")
492 (\"color\" . \"rgb(255, 255, 255)\")
493 (\"font-style\" . \"normal\")
494 (\"font-weight\" . \"500\")
495 (\"font-stretch\" . \"normal\")
496 (\"font-family\" . \"misc-fixed\")
497 (\"font-size\" . \"13pt\")
498 (\"text-decoration\" . \"none\"))\n
499 \(hfy-face-to-style 'Info-title-3-face) =>
500 ((\"font-weight\" . \"700\")
501 (\"font-family\" . \"helv\")
502 (\"font-size\" . \"120%\")
503 (\"text-decoration\" . \"none\"))\n")
505 (defvar hfy-sheet-assoc
'please-ignore-this-line
506 "An assoc with elements of the form (face-name style-name . style-string):\n
507 '((default \"default\" . \"{background: black; color: white}\")
508 (font-lock-string-face \"string\" . \"{color: rgb(64,224,208)}\"))" )
510 (defvar hfy-facemap-assoc
'please-ignore-this-line
511 "An assoc of (point . FACE-SYMBOL) or (point . DEFFACE-LIST)
512 and (point . 'end) elements, in descending order of point value
513 \(ie from the file's end to its beginning).\n
514 The map is in reverse order because inserting a <style> tag (or any other
515 string) at `point' invalidates the map for all entries with a greater value of
516 point. By traversing the map from greatest to least point, we still invalidate
517 the map as we go, but only those points we have already dealt with (and
518 therefore no longer care about) will be invalid at any time.\n
520 (64744 . font-lock-comment-face)
522 (64722 . font-lock-string-face)
524 (64623 . font-lock-string-face)
526 (64446 . font-lock-keyword-face)
528 (64395 . font-lock-constant-face)
530 (64386 . font-lock-keyword-face)
532 ;; big similar section elided. You get the idea.
533 (4285 . font-lock-constant-face)
535 (4221 . font-lock-comment-face)
537 (4197 . font-lock-constant-face)
539 (1 . font-lock-comment-face))")
541 (defvar hfy-tmpfont-stack nil
542 "An alist of derived fonts resulting from overlays.")
544 (defconst hfy-hex-regex
"[0-9A-Fa-f]")
546 (defconst hfy-triplet-regex
548 "\\(" hfy-hex-regex hfy-hex-regex
"\\)"
549 "\\(" hfy-hex-regex hfy-hex-regex
"\\)"
550 "\\(" hfy-hex-regex hfy-hex-regex
"\\)"))
552 (defun hfy-interq (set-a set-b
)
553 "Return the intersection (using `eq') of two lists SET-A and SET-B."
554 (let ((sa set-a
) (interq nil
) (elt nil
))
558 (if (memq elt set-b
) (setq interq
(cons elt interq
)))) interq
))
560 (defun hfy-colour-vals (colour)
561 "Where COLOUR is a color name or #XXXXXX style triplet, return a
562 list of three (16 bit) rgb values for said color.\n
563 If a window system is unavailable, calls `hfy-fallback-colour-values'."
564 (if (string-match hfy-triplet-regex colour
)
566 (lambda (x) (* (string-to-number (match-string x colour
) 16) 257))
568 ;;(message ">> %s" colour)
570 (if (fboundp 'color-values
)
571 (color-values colour
)
572 ;;(message "[%S]" window-system)
573 (x-color-values colour
))
574 ;; blarg - tty colours are no good - go fetch some X colours:
575 (hfy-fallback-colour-values colour
))))
577 (defvar hfy-cperl-mode-kludged-p nil
)
579 (defun hfy-kludge-cperl-mode ()
580 "CPerl mode does its damndest not to do some of its fontification when not
581 in a windowing system - try to trick it..."
582 (if (not hfy-cperl-mode-kludged-p
)
583 (progn (if (not window-system
)
584 (let ((window-system 'htmlfontify
))
585 (eval-and-compile (require 'cperl-mode
))
586 (setq cperl-syntaxify-by-font-lock t
)))
587 (setq hfy-cperl-mode-kludged-p t
))) )
589 (defun hfy-opt (symbol) "Is option SYMBOL set." (memq symbol hfy-optimisations
))
591 (defun hfy-default-header (file style
)
592 "Default value for `hfy-page-header'.
593 FILE is the name of the file.
594 STYLE is the inline CSS stylesheet (or tag referring to an external sheet)."
595 ;; (format "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\">
596 ;; <html>\n <head>\n <title>%s</title>\n %s\n </head>\n <body>\n" file style))
597 (format "<?xml version=\"1.0\" encoding=\"utf-8\"?>
598 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\"
599 \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">
600 <html xmlns=\"http://www.w3.org/1999/xhtml\">
604 <script type=\"text/javascript\"><!--
605 // this function is needed to work around
606 // a bug in IE related to element attributes
607 function hasClass(obj)
610 if (obj.getAttributeNode(\"class\") != null)
612 result = obj.getAttributeNode(\"class\").value;
619 // the flag we'll use to keep track of
620 // whether the current row is odd or even
623 // if arguments are provided to specify the colors
624 // of the even & odd rows, then use the them;
625 // otherwise use the following defaults:
626 var evenColor = arguments[1] ? arguments[1] : \"#fff\";
627 var oddColor = arguments[2] ? arguments[2] : \"#ddd\";
629 // obtain a reference to the desired table
630 // if no such table exists, abort
631 var table = document.getElementById(id);
632 if (! table) { return; }
634 // by definition, tables can have more than one tbody
635 // element, so we'll have to get the list of child
637 var tbodies = table.getElementsByTagName(\"tbody\");
639 // and iterate through them...
640 for (var h = 0; h < tbodies.length; h++)
642 // find all the <tr> elements...
643 var trs = tbodies[h].getElementsByTagName(\"tr\");
645 // ... and iterate through them
646 for (var i = 0; i < trs.length; i++)
648 // avoid rows that have a class attribute
649 // or backgroundColor style
650 if (! hasClass(trs[i]) &&
651 ! trs[i].style.backgroundColor)
653 // get all the cells in this row...
654 var tds = trs[i].getElementsByTagName(\"td\");
656 // and iterate through them...
657 for (var j = 0; j < tds.length; j++)
661 // avoid cells that have a class attribute
662 // or backgroundColor style
663 if (! hasClass(mytd) &&
664 ! mytd.style.backgroundColor)
666 mytd.style.backgroundColor =
667 even ? evenColor : oddColor;
671 // flip from odd to even, or vice-versa
677 function toggle_invis( name )
682 { var classname = node.id;
684 { var classbase = classname.substr( 0, name.length );
685 if( classbase == name ) { return NodeFilter.FILTER_ACCEPT; } }
686 return NodeFilter.FILTER_SKIP; } };
687 var walker = document.createTreeWalker( document.body ,
688 NodeFilter.SHOW_ELEMENT ,
691 while( walker.nextNode() )
693 var e = walker.currentNode;
694 if( e.style.display == \"none\" ) { e.style.display = \"inline\"; }
695 else { e.style.display = \"none\"; }
700 <body onload=\"stripe('index'); return true;\">\n"
703 (defun hfy-default-footer (file)
704 "Default value for `hfy-page-footer'.
705 FILE is the name of the file being rendered, in case it is needed."
706 "\n </body>\n</html>\n")
708 (defun hfy-link-style-string (style-string)
709 "Replace the end of a CSS style declaration STYLE-STRING with the contents
710 of the variable `hfy-src-doc-link-style', removing text matching the regex
711 `hfy-src-doc-link-unstyle' first, if necessary."
712 ;;(message "hfy-colour-vals");;DBUG
713 (if (string-match hfy-src-doc-link-unstyle style-string
)
714 (setq style-string
(replace-match "" 'fixed-case
'literal style-string
)))
715 (if (and (not (string-match hfy-src-doc-link-style style-string
))
716 (string-match "} *$" style-string
))
717 (concat (replace-match hfy-src-doc-link-style
720 style-string
) " }") style-string
))
722 ;; utility functions - cast emacs style specification values into their
724 (defun hfy-triplet (colour)
725 "Takes a COLOUR name (string) and return a CSS rgb(R, G, B) triplet string.
726 Uses the definition of \"white\" to map the numbers to the 0-255 range, so
727 if you've redefined white, (esp. if you've redefined it to have a triplet
728 member lower than that of the color you are processing) strange things
730 ;;(message "hfy-colour-vals");;DBUG
731 (let ((white (mapcar (lambda (I) (float (1+ I
))) (hfy-colour-vals "white")))
732 (rgb16 (mapcar (lambda (I) (float (1+ I
))) (hfy-colour-vals colour
))))
734 ;;(apply 'format "rgb(%d, %d, %d)"
735 ;; Use #rrggbb instead, it is smaller
736 (apply 'format
"#%02x%02x%02x"
742 (defun hfy-family (family) (list (cons "font-family" family
)))
743 (defun hfy-bgcol (colour) (list (cons "background" (hfy-triplet colour
))))
744 (defun hfy-colour (colour) (list (cons "color" (hfy-triplet colour
))))
745 (defun hfy-width (width) (list (cons "font-stretch" (symbol-name width
))))
747 (defcustom hfy-font-zoom
1.05
748 "Font scaling from Emacs to HTML."
752 (defun hfy-size (height)
753 "Derive a CSS font-size specifier from an Emacs font :height attribute HEIGHT.
754 Does not cope with the case where height is a function to be applied to
755 the height of the underlying font."
758 ;;(t (cons "font-size" ": 1em"))
760 (cons "font-size" (format "%d%%" (* (* hfy-font-zoom height
) 100))))
762 (cons "font-size" (format "%dpt" (/ (* hfy-font-zoom height
) 10 )))) )) )
764 (defun hfy-slant (slant)
765 "Derive a font-style CSS specifier from the Emacs :slant attribute SLANT:
766 CSS does not define the reverse-* styles, so just maps those to the
768 (list (cons "font-style"
769 (or (cdr (assq slant
'((italic .
"italic")
770 (reverse-italic .
"italic" )
771 (oblique .
"oblique")
772 (reverse-oblique .
"oblique"))))
775 (defun hfy-weight (weight)
776 "Derive a font-weight CSS specifier from an Emacs weight spec symbol WEIGHT."
777 (list (cons "font-weight" (cdr (assq weight
'((ultra-bold .
"900")
784 (extra-light .
"200")
785 (ultra-light .
"100")))))))
787 (defun hfy-box-to-border-assoc (spec)
789 (let ((tag (car spec
))
792 (:color
(cons "colour" val
))
793 (:width
(cons "width" val
))
794 (:style
(cons "style" val
)))
795 (hfy-box-to-border-assoc (cddr spec
))))))
797 (defun hfy-box-to-style (spec)
798 (let* ((css (hfy-box-to-border-assoc spec
))
799 (col (cdr (assoc "colour" css
)))
800 (s (cdr (assoc "style" css
))))
802 (if col
(cons "border-color" (cdr (assoc "colour" css
))))
803 (cons "border-width" (format "%dpx" (or (cdr (assoc "width" css
)) 1)))
804 (cons "border-style" (case s
805 (released-button "outset")
806 (pressed-button "inset" )
810 "Derive CSS border-* attributes from the Emacs :box attribute BOX."
813 ((integerp box
) (list (cons "border-width" (format "%dpx" box
))))
814 ((stringp box
) (list (cons "border" (format "solid %s 1px" box
))))
815 ((listp box
) (hfy-box-to-style box
) ))) )
817 (defun hfy-decor (tag val
)
818 "Derive CSS text-decoration specifiers from various Emacs font attributes.
819 TAG is an Emacs font attribute key (eg :underline).
822 ;; FIXME: Why not '("text-decoration" . "underline")? --Stef
824 (:underline
(cons "text-decoration" "underline" ))
825 (:overline
(cons "text-decoration" "overline" ))
826 (:strike-through
(cons "text-decoration" "line-through")))))
828 (defun hfy-invisible (&optional val
)
829 "This text should be invisible.
830 Do something in CSS to make that happen.
831 VAL is ignored here."
832 '(("display" .
"none")))
834 (defun hfy-combined-face-spec (face)
835 "Return a `defface' style alist of possible specifications for FACE.
836 Entries resulting from customization (`custom-set-faces') will take
839 (setq spec
(append (or (get face
'saved-face
) (list))
840 (or (get face
'face-defface-spec
) (list))))
841 (if (and hfy-display-class hfy-default-face-def
(eq face
'default
))
842 (setq spec
(append hfy-default-face-def spec
))) spec
))
844 (defun hfy-face-attr-for-class (face &optional class
)
845 "Return the face attributes for FACE.
846 If CLASS is set, it must be a `defface' alist key [see below],
847 in which case the first face specification returned by `hfy-combined-face-spec'
848 which *doesn't* clash with CLASS is returned.\n
849 \(A specification with a class of t is considered to match any class you
850 specify - this matches Emacs' behavior when deciding on which face attributes
851 to use, to the best of my understanding).\n
852 If CLASS is nil, then you just get get whatever `face-attr-construct' returns,
853 ie the current specification in effect for FACE.\n
854 *NOTE*: This function forces any face that is not 'default and which has
855 no :inherit property to inherit from 'default (this is because 'default
856 is magical in that Emacs' fonts behave as if they inherit implicitly from
857 'default, but no such behavior exists in HTML/CSS).\n
858 See also `hfy-display-class' for details of valid values for CLASS."
861 (let ((face-props (hfy-combined-face-spec face
))
868 (setq face-specn
(car face-props
)
869 face-class
(car face-specn
)
870 face-attrs
(cdr face-specn
)
871 face-props
(cdr face-props
))
872 ;; if the current element CEL of CLASS is t we match
873 ;; if the current face-class is t, we match
874 ;; if the cdr of CEL has a non-nil
875 ;; intersection with the cdr of the first member of
876 ;; the current face-class with the same car as CEL, we match
877 ;; if we actually clash, then we can't match
885 (while (and cbuf
(not next
))
890 val
(if (listp val
) val
(list val
)))
893 (memq face-class
'(t default
))) ;Default match.
894 (setq score
0) (ignore "t match"))
895 ((not (cdr (assq key face-class
))) ;Neither good nor bad.
896 nil
(ignore "non match, non collision"))
897 ((setq x
(hfy-interq val
(cdr (assq key face-class
))))
898 (setq score
(+ score
(length x
)))
899 (ignore "intersection"))
901 (setq next t score -
10) (ignore "collision")) ))
902 (if (> score face-score
)
904 (setq face-match face-attrs
906 (ignore "%d << %S/%S" score face-class class
))
907 (ignore "--- %d ---- (insufficient)" score
)) ))
908 ;; matched ? last attrs : nil
910 (if (listp (car face-match
)) (car face-match
) face-match
)
912 ;; Unfortunately the default face returns a
913 ;; :background. Fortunately we can remove it, but how do we do
914 ;; that in a non-system specific way?
915 (let ((spec (face-attr-construct face
))
917 (if (not (memq :background spec
))
920 (let ((a (nth 0 spec
))
922 (unless (and (eq a
:background
)
924 (string= b
"SystemWindow"))
925 (setq new-spec
(cons a
(cons b new-spec
)))))
926 (setq spec
(cddr spec
)))
928 (if (or (memq :inherit face-spec
) (eq 'default face
))
930 (append face-spec
(list :inherit
'default
)))))
932 ;; construct an assoc of (css-tag-name . css-tag-value) pairs
933 ;; from a face or assoc of face attributes:
936 ;; (mumamo-message-with-face "testing face" 'highlight)
937 ;; (mumamo-message-with-face "testing face" '(:foreground "red" :background "yellow"))
938 ;; (hfy-face-to-style-i '(:inherit default foreground-color "red"))
939 ;; default face=(:stipple nil :background "SystemWindow" :foreground
940 ;; "SystemWindowText" :inverse-video nil :box nil :strike-through
941 ;; nil :overline nil :underline nil :slant normal :weight normal
942 ;; :height 98 :width normal :family "outline-courier new")
943 (defun hfy-face-to-style-i (fn)
944 "The guts of `hfy-face-to-style': FN should be a `defface' font spec,
945 as returned by `face-attr-construct' or `hfy-face-attr-for-class'.
946 Note that this function does not get font-sizes right if they are based
947 on inherited modifiers (via the :inherit) attribute, and any other
948 modifiers that are cumulative if they appear multiple times need to be
949 merged by the user - `hfy-flatten-style' should do this."
950 ;;(message "hfy-face-to-style-i");;DBUG
952 ;; fn's value could be something like
954 ;; ((foreground-color . "blue"))
955 ;; (foreground-color . "blue")
965 (if (eq key
:inherit
)
966 (let ((vs (if (listp val
) val
(list val
))))
967 ;; (let ((x '(a b))) (setq x (append '(c d) x)))
968 ;; (let ((x '(a b))) (setq x (append '(c d) x)))
974 (hfy-face-attr-for-class v hfy-display-class
)) ))))
977 (:family
(hfy-family val
))
978 (:width
(hfy-width val
))
979 (:weight
(hfy-weight val
))
980 (:slant
(hfy-slant val
))
981 (:foreground
(hfy-colour val
))
982 (:background
(hfy-bgcol val
))
984 (:height
(hfy-size val
))
985 (:underline
(hfy-decor key val
))
986 (:overline
(hfy-decor key val
))
987 (:strike-through
(hfy-decor key val
))
988 (:invisible
(hfy-invisible val
))
989 (:bold
(hfy-weight 'bold
))
990 (:italic
(hfy-slant 'italic
))))))
991 (setq that
(hfy-face-to-style-i next
))
992 ;;(lwarn t :warning "%S => %S" fn (nconc this that parent))
993 (nconc this that parent
))) )
995 (defun hfy-size-to-int (spec)
996 "Convert SPEC, a CSS font-size specifier, to an Emacs :height attribute value.
997 Used while merging multiple font-size attributes."
998 ;;(message "hfy-size-to-int");;DBUG
1000 (if (string-match "\\([0-9]+\\)\\(%\\|pt\\)" spec
)
1001 (cond ((string= "%" (match-string 2 spec
))
1002 (/ (string-to-number (match-string 1 spec
)) 100.0))
1003 ((string= "pt" (match-string 2 spec
))
1004 (* (string-to-number (match-string 1 spec
)) 10)))
1005 (string-to-number spec
))) )
1007 ;; size is different, in that in order to get it right at all,
1008 ;; we have to trawl the inheritance path, accumulating modifiers,
1009 ;; _until_ we get to an absolute (pt) specifier, then combine the lot
1010 (defun hfy-flatten-style (style)
1011 "Take STYLE (see `hfy-face-to-style-i', `hfy-face-to-style') and merge
1012 any multiple attributes appropriately. Currently only font-size is merged
1013 down to a single occurrence - others may need special handling, but I
1014 haven't encountered them yet. Returns a `hfy-style-assoc'."
1015 ;;(message "(hfy-flatten-style %S)" style) ;;DBUG
1021 (if (string= (car css
) "font-size")
1023 (when (not x
) (setq m
(nconc m
(hfy-size-to-int (cdr css
)))))
1024 (when (string-match "pt" (cdr css
)) (setq x t
)))
1025 (setq r
(nconc r
(list css
)))))
1026 ;;(message "r: %S" r)
1027 (setq n
(apply '* m
))
1028 (nconc r
(hfy-size (if x
(round n
) (* n
1.0)))) ))
1030 (defun hfy-face-resolve-face (fn)
1033 (hfy-face-attr-for-class fn hfy-display-class
))
1035 (facep (symbol-value fn
)))
1036 ;; Obsolete faces like `font-lock-reference-face' are defined as
1037 ;; aliases for another face.
1038 (hfy-face-attr-for-class (symbol-value fn
) hfy-display-class
))
1042 (defun hfy-face-to-style (fn)
1043 "Take FN, a font or `defface' style font specification,
1044 \(as returned by `face-attr-construct' or `hfy-face-attr-for-class')
1045 and return a `hfy-style-assoc'.\n
1046 See also `hfy-face-to-style-i', `hfy-flatten-style'."
1047 ;;(message "hfy-face-to-style");;DBUG
1048 (let ((face-def (hfy-face-resolve-face fn
))
1051 (setq final-style
(hfy-flatten-style (hfy-face-to-style-i face-def
)))
1052 ;;(message "%S" final-style)
1053 (if (not (assoc "text-decoration" final-style
))
1054 (progn (setq final-style
1055 ;; Fix-me: there is no need for this since
1056 ;; text-decoration is not inherited.
1057 ;; but it's not wrong and if this ever changes it will
1058 ;; be needed, so I think it's better to leave it in? -- v
1059 (nconc final-style
'(("text-decoration".
"none"))))))
1062 ;; strip redundant bits from a name. Technically, this could result in
1063 ;; a collision, but it is pretty unlikely - will fix later...
1064 ;; also handle ephemeral fonts created by overlays, which don't actually
1066 (defun hfy-face-or-def-to-name (fn)
1067 "Render a font symbol or `defface' font spec FN into a name (string)."
1068 ;;(message "generating name for %s" fn)
1069 (if (not (listp fn
))
1071 (let* ((key (format "%s" fn
))
1072 (entry (assoc key hfy-tmpfont-stack
))
1073 (base (cadr (memq :inherit fn
)))
1075 ;;(message "checking for key «%s» in font stack [%d]"
1076 ;; key (if entry 1 0))
1077 (if entry nil
;; noop
1078 (setq tag
(format "%04d" (length hfy-tmpfont-stack
))
1079 entry
(cons key tag
)
1080 hfy-tmpfont-stack
(cons entry hfy-tmpfont-stack
)))
1081 ;;(message " -> name: %s-%s" (or base 'default) tag)
1082 (format "%s-%s" (or base
'default
) tag
)) ))
1084 (defun hfy-css-name (fn)
1085 "Strip the boring bits from a font-name FN and return a CSS style name."
1086 ;;(message "hfy-css-name");;DBUG
1087 (let ((face-name (hfy-face-or-def-to-name fn
)))
1088 (if (or (string-match "font-lock-\\(.*\\)" face-name
)
1089 (string-match "cperl-\\(.*\\)" face-name
)
1090 (string-match "^[Ii]nfo-\\(.*\\)" face-name
))
1092 (setq face-name
(match-string 1 face-name
))
1093 (if (string-match "\\(.*\\)-face$" face-name
)
1094 (setq face-name
(match-string 1 face-name
))) face-name
)
1097 ;; construct an assoc of (stripped-name . "{ css-stuff-here }") pairs
1099 (defun hfy-face-to-css (fn)
1100 "Take FN, a font or `defface' specification (cf `face-attr-construct')
1101 and return a CSS style specification.\n
1102 See also `hfy-face-to-style'."
1103 ;;(message "hfy-face-to-css");;DBUG
1104 (let ((css-list nil
)
1107 ;;(message "(hfy-face-to-style %S)" fn)
1108 (setq css-list
(hfy-face-to-style fn
))
1113 (unless (member (car E
) seen
)
1115 (format " %s: %s; " (car E
) (cdr E
)))))
1117 (cons (hfy-css-name fn
) (format "{%s}" (apply 'concat css-text
)))) )
1119 ;; extract a face from a list of char properties, if there is one:
1120 (defun hfy-p-to-face (props)
1121 "Given PROPS, a list of text properties, return the value of the face
1124 (if (string= (car props
) "face")
1125 (let ((propval (cadr props
)))
1126 (if (and (listp propval
) (not (cdr propval
)))
1129 (hfy-p-to-face (cddr props
)))
1132 (defun hfy-p-to-face-lennart (props)
1133 "Given PROPS, a list of text properties, return the value of the face
1136 (let ((face (plist-get props
'face
))
1137 (font-lock-face (plist-get props
'font-lock-face
))
1138 (button (plist-get props
'button
))
1139 ;;(face-rec (memq 'face props))
1140 ;;(button-rec (memq 'button props)))
1143 (let* ((category (plist-get props
'category
))
1144 (face (when category
(plist-get (symbol-plist category
) 'face
))))
1149 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1150 ;; (defun hfy-get-face-at (pos)
1151 ;; ;; (let ((face (get-char-property-and-overlay pos 'face)))
1152 ;; ;; (when (and face (listp face)) (setq face (car face)))
1153 ;; ;; (unless (listp face)
1155 ;; ;;(get-char-property pos 'face)
1156 ;; ;; Overlays are handled later
1157 ;; (if (or (not show-trailing-whitespace)
1158 ;; (not (get-text-property pos 'hfy-show-trailing-whitespace)))
1159 ;; (get-text-property pos 'face)
1160 ;; (list 'trailing-whitespace (get-text-property pos 'face)))
1163 (defun hfy-prop-invisible-p (prop)
1164 "Is text property PROP an active invisibility property?"
1165 (or (and (eq buffer-invisibility-spec t
) prop
)
1166 (or (memq prop buffer-invisibility-spec
)
1167 (assq prop buffer-invisibility-spec
))))
1169 (defun hfy-find-invisible-ranges ()
1170 "Return a list of (start-point . end-point) cons cells of invisible regions."
1171 (let (invisible p i e s
) ;; return-value pos invisible end start
1173 (setq p
(goto-char (point-min)))
1174 (when (invisible-p p
) (setq s p i t
))
1175 (while (< p
(point-max))
1176 (if i
;; currently invisible
1177 (when (not (invisible-p p
)) ;; but became visible
1180 invisible
(cons (cons s e
) invisible
)))
1181 ;; currently visible:
1182 (when (invisible-p p
) ;; but have become invisible
1184 (setq p
(next-char-property-change p
)))
1185 ;; still invisible at buffer end?
1188 invisible
(cons (cons s e
) invisible
))) ) invisible
))
1190 (defun hfy-invisible-name (point map
)
1191 "Generate a CSS style name for an invisible section of the buffer.
1192 POINT is the point inside the invisible region.
1193 MAP is the invisibility map as returned by `hfy-find-invisible-ranges'."
1194 ;;(message "(hfy-invisible-name %S %S)" point map)
1197 (when (and (>= point
(car range
))
1198 (< point
(cdr range
)))
1199 (setq name
(format "invisible-%S-%S" (car range
) (cdr range
)))))
1202 ;; Fix-me: This function needs some cleanup by someone who understand
1203 ;; all the formats that face properties can have.
1205 ;; overlay handling should be fine. haven't tested multiple stacked overlapping
1206 ;; overlays recently, but the common case of a text property face + an overlay
1207 ;; face produces the correct merged css style (or as close to it as css can get)
1209 (defun hfy-face-at (p)
1210 "Find face in effect at point P.
1211 If overlays are to be considered (see `hfy-optimisations') then this may
1212 return a `defface' style list of face properties instead of a face symbol."
1213 ;;(message "hfy-face-at");;DBUG
1214 ;; Fix-me: clean up, remove face-name etc
1215 ;; not sure why we'd want to remove face-name? -- v
1216 (let ((overlay-data nil
)
1218 ;; restored hfy-p-to-face as it handles faces like (bold) as
1219 ;; well as face like 'bold - hfy-get-face-at doesn't dtrt -- v
1220 (face-name (hfy-p-to-face (text-properties-at p
)))
1221 ;; (face-name (hfy-get-face-at p))
1224 (text-props (text-properties-at p
)))
1225 ;;(message "face-name: %S" face-name)
1226 (when (and face-name
(listp face-name
) (facep (car face-name
)))
1227 ;;(message "face-name is a list %S" face-name)
1228 ;;(setq text-props (cons 'face face-name))
1229 (dolist (f face-name
)
1230 (setq extra-props
(if (listp f
)
1231 ;; for things like (variable-pitch
1232 ;; (:foreground "red"))
1233 (cons f extra-props
)
1234 (cons :inherit
(cons f extra-props
)))))
1235 (setq base-face
(car face-name
)
1237 ;; text-properties-at => (face (:foreground "red" ...))
1238 ;; or => (face (compilation-info underline)) list of faces
1239 ;; overlay-properties
1240 ;; format= (evaporate t face ((foreground-color . "red")))
1242 ;; SO: if we have turned overlays off,
1243 ;; or if there's no overlay data
1244 ;; just bail out and return whatever face data we've accumulated so far
1245 (if (or (not (hfy-opt 'keep-overlays
))
1246 (not (setq overlay-data
(hfy-overlay-props-at p
))))
1248 ;;(message "· %d: %s; %S; %s"
1249 ;; p face-name extra-props text-props)
1250 (or face-name base-face
)) ;; no overlays or extra properties
1251 ;; collect any face data and any overlay data for processing:
1253 (push text-props overlay-data
))
1254 (setq overlay-data
(nreverse overlay-data
))
1255 ;;(message "- %d: %s; %S; %s; %s"
1256 ;; p face-name extra-props text-props overlay-data)
1257 ;; remember the basic face name so we don't keep repeating its specs:
1258 (when face-name
(setq base-face face-name
))
1259 (dolist (P overlay-data
)
1260 (let ((iprops (cadr (memq 'invisible P
)))) ;FIXME: plist-get?
1261 ;;(message "(hfy-prop-invisible-p %S)" iprops)
1262 (when (and iprops
(hfy-prop-invisible-p iprops
))
1264 (cons :invisible
(cons t extra-props
))) ))
1265 (let ((fprops (cadr (or (memq 'face P
)
1266 (memq 'font-lock-face P
)))))
1267 ;;(message "overlay face: %s" fprops)
1268 (if (not (listp fprops
))
1269 (let ((this-face (if (stringp fprops
) (intern fprops
) fprops
)))
1270 (when (not (eq this-face base-face
))
1273 (cons this-face extra-props
))) ))
1275 (if (facep (car fprops
))
1276 (let ((face (car fprops
)))
1277 (when (stringp face
) (setq face
(intern fprops
)))
1282 (setq fprops
(cdr fprops
)))
1285 (if (listp (car fprops
))
1286 (if (nlistp (cdr (car fprops
)))
1289 (setq p
(caar fprops
))
1290 (setq v
(cdar fprops
))
1291 (setq fprops
(cdr fprops
)))
1293 (setq p
(caar fprops
))
1294 (setq v
(cadar fprops
))
1295 (setq fprops
(cdr fprops
)))
1296 (if (listp (cdr fprops
))
1298 ;; (:prop val :prop val ...)
1299 (setq p
(car fprops
))
1300 (setq v
(cadr fprops
))
1301 (setq fprops
(cddr fprops
)))
1302 (if (and (listp fprops
)
1303 (not (listp (cdr fprops
))))
1304 ;;(and (consp x) (cdr (last x)))
1307 (setq p
(car fprops
))
1308 (setq v
(cdr fprops
))
1310 (error "Eh... another format! fprops=%s" fprops
) )))
1312 ;; These are all the properties handled
1313 ;; in `hfy-face-to-style-i'.
1315 ;; Are these translations right?
1316 ;; yes, they are -- v
1322 (underline :underline
)
1323 (overline :overline
)
1324 (strike-through :strike-through
)
1326 (foreground-color :foreground
)
1327 (background-color :background
)
1331 (if (memq p prop-seen
) nil
;; noop
1332 (setq prop-seen
(cons p prop-seen
)
1333 extra-props
(cons p
(cons v extra-props
))))))))))
1334 ;;(message "+ %d: %s; %S" p face-name extra-props)
1336 (if (listp face-name
)
1337 (nconc extra-props face-name
)
1338 (nconc extra-props
(face-attr-construct face-name
)))
1341 (defun hfy-overlay-props-at (p)
1342 "Grab overlay properties at point P.
1343 The plists are returned in descending priority order."
1344 (sort (mapcar #'overlay-properties
(overlays-at p
))
1345 (lambda (A B
) (> (or (cadr (memq 'priority A
)) 0) ;FIXME: plist-get?
1346 (or (cadr (memq 'priority B
)) 0)))))
1348 ;; construct an assoc of (face-name . (css-name . "{ css-style }")) elements:
1349 (defun hfy-compile-stylesheet ()
1350 "Trawl the current buffer, construct and return a `hfy-sheet-assoc'."
1351 ;;(message "hfy-compile-stylesheet");;DBUG
1352 (let ((pt (point-min))
1353 ;; Make the font stack stay:
1354 ;;(hfy-tmpfont-stack nil)
1359 (while (< pt
(point-max))
1360 (if (and (setq fn
(hfy-face-at pt
)) (not (assoc fn style
)))
1361 (push (cons fn
(hfy-face-to-css fn
)) style
))
1362 (setq pt
(next-char-property-change pt
))) )
1363 (push (cons 'default
(hfy-face-to-css 'default
)) style
)))
1365 (defun hfy-fontified-p ()
1366 "`font-lock' doesn't like to say it's been fontified when in batch
1367 mode, but we want to know if we should fontify or raw copy, so in batch
1368 mode we check for non-default face properties. Otherwise we test
1369 variable `font-lock-mode' and variable `font-lock-fontified' for truth."
1370 ;;(message "font-lock-fontified: %S" font-lock-fontified)
1371 ;;(message "noninteractive : %S" noninteractive)
1372 ;;(message "font-lock-mode : %S" font-lock-mode)
1373 (and font-lock-fontified
1375 (let ((pt (point-min))
1379 (while (and (< pt
(point-max)) (not face-name
))
1380 (setq face-name
(hfy-face-at pt
))
1381 (setq pt
(next-char-property-change pt
)))) face-name
)
1384 ;; remember, the map is in reverse point order:
1385 ;; I wrote this while suffering the effects of a cold, and maybe a
1386 ;; mild fever - I think it's correct, but it might be a little warped
1387 ;; as my minfd keeps ... where was I? Oh yes, the bunnies...
1388 (defun hfy-merge-adjacent-spans (face-map)
1389 "Where FACE-MAP is a `hfy-facemap-assoc' for the current buffer,
1390 this function merges adjacent style blocks which are of the same value
1391 and are separated by nothing more interesting than whitespace.\n
1392 <span class=\"foo\">narf</span> <span class=\"foo\">brain</span>\n
1393 \(as interpreted from FACE-MAP) would become:\n
1394 <span class=\"foo\">narf brain</span>\n
1395 Returns a modified copy of FACE-MAP."
1396 (let ((tmp-map face-map
)
1405 ;;(push (car tmp-map) reduced-map)
1406 ;;(push (cadr tmp-map) reduced-map)
1408 (setq first-start
(cadddr tmp-map
)
1409 first-stop
(caddr tmp-map
)
1410 last-start
(cadr tmp-map
)
1411 last-stop
(car tmp-map
)
1413 span-start last-start
1414 span-stop last-stop
)
1415 (while (and (equal (cdr first-start
)
1418 (goto-char (car first-stop
))
1419 (not (re-search-forward "[^ \t\n\r]" (car last-start
) t
))))
1420 (setq map-buf
(cddr map-buf
)
1421 span-start first-start
1422 first-start
(cadddr map-buf
)
1423 first-stop
(caddr map-buf
)
1424 last-start
(cadr map-buf
)
1425 last-stop
(car map-buf
)))
1426 (push span-stop reduced-map
)
1427 (push span-start reduced-map
)
1428 (setq tmp-map
(memq last-start tmp-map
))
1429 (setq tmp-map
(cdr tmp-map
)))
1430 (setq reduced-map
(nreverse reduced-map
))))
1432 ;; remember to generate 'synthetic' </span> entries -
1433 ;; emacs copes by just having a stack of styles in effect
1434 ;; and only using the top one: html has a more simplistic approach -
1435 ;; we have to explicitly end a style, there's no way of temporarily
1436 ;; overriding it w. another one... (afaik)
1437 (defun hfy-compile-face-map ()
1438 ;; no need for special <a> version.
1439 ;; IME hyperlinks don't get underlined, esp when you htmlfontify a whole
1440 ;; source tree, so the <a> version is needed -- v
1441 ;; Fix-me: save table for multi-buffer
1442 "Compile and return a `hfy-facemap-assoc' for the current buffer."
1443 ;;(message "hfy-compile-face-map");;DBUG
1444 (let ((pt (point-min))
1448 (prev-tag nil
)) ;; t if the last tag-point was a span-start
1449 ;; nil if it was a span-stop
1452 (while (< pt
(point-max))
1453 (if (setq fn
(hfy-face-at pt
))
1454 (progn (if prev-tag
(push (cons pt-narrow
'end
) map
))
1455 (push (cons pt-narrow fn
) map
)
1457 (if prev-tag
(push (cons pt-narrow
'end
) map
))
1458 (setq prev-tag nil
))
1459 (setq pt
(next-char-property-change pt
))
1460 (setq pt-narrow
(1+ (- pt
(point-min)))))
1461 (if (and map
(not (eq 'end
(cdar map
))))
1462 (push (cons (- (point-max) (point-min)) 'end
) map
)))
1463 (if (hfy-opt 'merge-adjacent-tags
) (hfy-merge-adjacent-spans map
) map
)))
1465 (defun hfy-buffer ()
1466 "Generate a buffer to hold the HTML output.
1467 The filename of this buffer is derived from the source (current) buffer's
1468 variable `buffer-file-name', if it is set, plus `hfy-extn'.
1469 Otherwise a plausible filename is constructed from `default-directory',
1470 `buffer-name' and `hfy-extn'."
1471 (let* ((name (concat (buffer-name) hfy-extn
))
1472 (src (buffer-file-name))
1473 (buf (get-buffer-create name
)))
1474 (with-current-buffer buf
1475 (setq buffer-file-name
1476 (if src
(concat src hfy-extn
)
1477 (expand-file-name (if (string-match "^.*/\\([^/]*\\)$" name
)
1478 (match-string 1 name
)
1482 (defun hfy-lookup (face style
)
1483 "Get a CSS style name for FACE from STYLE."
1484 (cadr (assoc face style
)))
1486 (defun hfy-link-style (style-string)
1487 "Copy, alter and return a STYLE-STRING to make it suitable for a hyperlink.
1488 Uses `hfy-link-style-fun' to do this."
1489 (if (functionp hfy-link-style-fun
)
1490 (funcall hfy-link-style-fun style-string
)
1493 (defun hfy-sprintf-stylesheet (css file
)
1494 "Return the inline CSS style sheet for FILE as a string."
1495 (let ((stylesheet nil
))
1499 "\n<style type=\"text/css\"><!-- \n"
1500 ;; Fix-me: Add handling of page breaks here + scan for ^L
1501 ;; where appropriate.
1502 (format "body %s\n" (cddr (assq 'default css
)))
1507 "span.%s %s\nspan.%s a %s\n"
1508 (cadr style
) (cddr style
)
1509 (cadr style
) (hfy-link-style (cddr style
))))
1512 (funcall hfy-page-header file stylesheet
)))
1514 ;; tag all the dangerous characters we want to escape
1515 ;; (ie any "<> chars we _didn't_ put there explicitly for css markup)
1516 (defun hfy-html-enkludge-buffer ()
1517 "Mark dangerous [\"<>] characters with the `hfy-quoteme' property.\n
1518 See also `hfy-html-dekludge-buffer'."
1519 ;;(message "hfy-html-enkludge-buffer");;DBUG
1521 (goto-char (point-min))
1522 (while (re-search-forward hfy-html-quote-regex nil t
)
1523 (put-text-property (match-beginning 0) (point) 'hfy-quoteme t
))) )
1525 ;; dangerous char -> &entity;
1526 (defun hfy-html-quote (char-string)
1527 "Map CHAR-STRING to an HTML safe string (entity) if need be."
1528 ;;(message "hfy-html-quote");;DBUG
1529 (or (cadr (assoc char-string hfy-html-quote-map
)) char-string
) )
1531 ;; actually entity-ise dangerous chars.
1532 ;; note that we can't do this until _after_ we have inserted the css
1533 ;; markup, since we use a position-based map to insert this, and if we
1534 ;; enter any other text before we do this, we'd have to track another
1535 ;; map of offsets, which would be tedious...
1536 (defun hfy-html-dekludge-buffer ()
1537 "Transform all dangerous characters marked with the `hfy-quoteme' property
1538 using `hfy-html-quote'.\n
1539 See also `hfy-html-enkludge-buffer'."
1540 ;;(message "hfy-html-dekludge-buffer");;DBUG
1542 (goto-char (point-min))
1543 (while (re-search-forward hfy-html-quote-regex nil t
)
1544 (if (get-text-property (match-beginning 0) 'hfy-quoteme
)
1545 (replace-match (hfy-html-quote (match-string 1))) )) ))
1547 ;; Borrowed from font-lock.el
1548 (defmacro hfy-save-buffer-state
(varlist &rest body
)
1549 "Bind variables according to VARLIST and eval BODY restoring buffer state.
1550 Do not record undo information during evaluation of BODY."
1551 (declare (indent 1) (debug let
))
1552 (let ((modified (make-symbol "modified")))
1553 `(let* ,(append varlist
1554 `((,modified
(buffer-modified-p))
1555 (buffer-undo-list t
)
1556 (inhibit-read-only t
)
1557 (inhibit-point-motion-hooks t
)
1558 (inhibit-modification-hooks t
)
1561 buffer-file-truename
))
1565 (restore-buffer-modified-p nil
)))))
1567 (defun hfy-mark-trailing-whitespace ()
1568 "Tag trailing whitespace with a hfy property if it is currently highlighted."
1569 (when show-trailing-whitespace
1570 (let ((inhibit-read-only t
))
1572 (goto-char (point-min))
1573 (hfy-save-buffer-state nil
1574 (while (re-search-forward "[ \t]+$" nil t
)
1575 (put-text-property (match-beginning 0) (match-end 0)
1576 'hfy-show-trailing-whitespace t
)))))))
1578 (defun hfy-unmark-trailing-whitespace ()
1579 "Undo the effect of `hfy-mark-trailing-whitespace'."
1580 (when show-trailing-whitespace
1581 (hfy-save-buffer-state nil
1582 (remove-text-properties (point-min) (point-max)
1583 '(hfy-show-trailing-whitespace)))))
1585 (defun hfy-fontify-buffer (&optional srcdir file
)
1586 "Implement the guts of `htmlfontify-buffer'.
1587 SRCDIR, if set, is the directory being htmlfontified.
1588 FILE, if set, is the file name."
1589 (if srcdir
(setq srcdir
(directory-file-name srcdir
)))
1590 (let* ( (html-buffer (hfy-buffer))
1595 (orig-ovls (overlays-in (point-min) (point-max)))
1596 (rmin (when mark-active
(region-beginning)))
1597 (rmax (when mark-active
(region-end ))) )
1598 (when (and mark-active
1599 transient-mark-mode
)
1600 (unless (and (= rmin
(point-min))
1601 (= rmax
(point-max)))
1602 (setq rovl
(make-overlay rmin rmax
))
1603 (overlay-put rovl
'priority
1000)
1604 (overlay-put rovl
'face
'region
)))
1605 ;; copy the buffer, including fontification, and switch to it:
1606 (hfy-mark-trailing-whitespace)
1607 (setq css-sheet
(hfy-compile-stylesheet )
1608 css-map
(hfy-compile-face-map )
1609 invis-ranges
(hfy-find-invisible-ranges))
1610 (hfy-unmark-trailing-whitespace)
1612 (delete-overlay rovl
))
1613 (copy-to-buffer html-buffer
(point-min) (point-max))
1614 (set-buffer html-buffer
)
1615 ;; rip out props that could interfere with our htmlisation of the buffer:
1616 (remove-text-properties (point-min) (point-max) hfy-ignored-properties
)
1617 ;; Apply overlay invisible spec
1621 (> (or (cadr (memq 'priority
(overlay-properties A
))) 0)
1622 (or (cadr (memq 'priority
(overlay-properties B
))) 0)))))
1623 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1624 ;; at this point, html-buffer retains the fontification of the parent:
1625 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1626 ;; we don't really need or want text in the html buffer to be invisible, as
1627 ;; that can make it look like we've rendered invalid xhtml when all that's
1628 ;; happened is some tags are in the invisible portions of the buffer:
1629 (setq buffer-invisibility-spec nil
)
1630 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1631 ;; #####################################################################
1632 ;; if we are in etags mode, add properties to mark the anchors and links
1633 (if (and srcdir file
)
1635 (hfy-mark-tag-names srcdir file
) ;; mark anchors
1636 (hfy-mark-tag-hrefs srcdir file
))) ;; mark links
1637 ;; #####################################################################
1638 ;; mark the 'dangerous' characters
1639 ;;(message "marking dangerous characters")
1640 (hfy-html-enkludge-buffer)
1641 ;; trawl the position-based face-map, inserting span tags as we go
1642 ;; note that we cannot change any character positions before this point
1643 ;; or we will invalidate the map:
1644 ;; NB: This also means we have to trawl the map in descending file-offset
1645 ;; order, obviously.
1646 ;; ---------------------------------------------------------------------
1647 ;; Remember, inserting pushes properties to the right, which we don't
1648 ;; actually want to happen for link properties, so we have to flag
1649 ;; them and move them by hand - if you don't, you end up with
1651 ;; <span class="foo"><a href="bar">texta</span><span class="bletch"></a>...
1655 ;; <span class="foo"><a href="bar">texta</a></span><span class="bletch">...
1657 ;; If my analysis of the problem is correct, we can detect link-ness by
1658 ;; either hfy-linkp or hfy-endl properties at the insertion point, but I
1659 ;; think we only need to relocate the hfy-endl property, as the hfy-linkp
1660 ;; property has already served its main purpose by this point.
1661 ;;(message "mapcar over the CSS-MAP")
1662 (message "invis-ranges:\n%S" invis-ranges
)
1663 (dolist (point-face css-map
)
1664 (let ((pt (car point-face
))
1665 (fn (cdr point-face
))
1669 (or (get-text-property pt
'hfy-linkp
)
1670 (get-text-property pt
'hfy-endl
)))
1673 (if (not (and srcdir file
))
1676 (remove-text-properties (point) (1+ (point)) '(hfy-endl nil
))
1677 (put-text-property pt
(1+ pt
) 'hfy-endl t
) ))
1678 ;; if we have invisible blocks, we need to do some extra magic:
1680 (let ((iname (hfy-invisible-name pt invis-ranges
))
1681 (fname (hfy-lookup fn css-sheet
)))
1682 (when (assq pt invis-ranges
)
1684 (format "<span onclick=\"toggle_invis('%s');\">" iname
))
1685 (insert "…</span>"))
1687 (format "<span class=\"%s\" id=\"%s-%d\">" fname iname pt
)))
1688 (insert (format "<span class=\"%s\">" (hfy-lookup fn css-sheet
))))
1689 (if (not move-link
) nil
1690 ;;(message "removing prop2 @ %d" (point))
1691 (if (remove-text-properties (point) (1+ (point)) '(hfy-endl nil
))
1692 (put-text-property pt
(1+ pt
) 'hfy-endl t
))))))
1693 ;; #####################################################################
1695 ;; Maybe just make the text invisible in XHTML?
1696 ;; DONE -- big block of obsolete invisibility code elided here -- v
1697 ;; #####################################################################
1698 ;; (message "checking to see whether we should link...")
1699 (if (and srcdir file
)
1700 (let ((lp 'hfy-link
)
1704 ;; (message " yes we should.")
1705 ;; translate 'hfy-anchor properties to anchors
1706 (setq pt
(point-min))
1707 (while (setq pt
(next-single-property-change pt
'hfy-anchor
))
1708 (if (setq pr
(get-text-property pt
'hfy-anchor
))
1709 (progn (goto-char pt
)
1710 (remove-text-properties pt
(1+ pt
) '(hfy-anchor nil
))
1711 (insert (concat "<a name=\"" pr
"\"></a>")))))
1712 ;; translate alternate 'hfy-link and 'hfy-endl props to opening
1713 ;; and closing links. (this should avoid those spurious closes
1714 ;; we sometimes get by generating only paired tags)
1715 (setq pt
(point-min))
1716 (while (setq pt
(next-single-property-change pt lp
))
1717 (if (not (setq pr
(get-text-property pt lp
))) nil
1719 (remove-text-properties pt
(1+ pt
) (list lp nil
))
1722 (if (setq rr
(get-text-property pt
'hfy-inst
))
1723 (insert (format "<a name=\"%s\"></a>" rr
)))
1724 (insert (format "<a href=\"%s\">" pr
))
1725 (setq lp
'hfy-endl
))
1727 (insert "</a>") (setq lp
'hfy-link
)) ))) ))
1729 ;; #####################################################################
1730 ;; transform the dangerous chars. This changes character positions
1731 ;; since entities have > char length.
1732 ;; note that this deletes the dangerous characters, and therefore
1733 ;; destroys any properties they may contain (such as 'hfy-endl),
1734 ;; so we have to do this after we use said properties:
1735 ;; (message "munging dangerous characters")
1736 (hfy-html-dekludge-buffer)
1737 ;; insert the stylesheet at the top:
1738 (goto-char (point-min))
1739 ;;(message "inserting stylesheet")
1740 (insert (hfy-sprintf-stylesheet css-sheet file
))
1741 (if (hfy-opt 'div-wrapper
) (insert "<div class=\"default\">"))
1743 (goto-char (point-max))
1745 (if (hfy-opt 'div-wrapper
) (insert "</div>"))
1746 ;;(message "inserting footer")
1747 (insert (funcall hfy-page-footer file
))
1748 ;; call any post html-generation hooks:
1749 (run-hooks 'hfy-post-html-hooks
)
1750 ;; return the html buffer
1751 (set-buffer-modified-p nil
)
1754 (defun hfy-force-fontification ()
1755 "Try to force font-locking even when it is optimized away."
1756 (run-hooks 'hfy-init-kludge-hook
)
1757 (eval-and-compile (require 'font-lock
))
1758 (if (boundp 'font-lock-cache-position
)
1759 (or font-lock-cache-position
1760 (set 'font-lock-cache-position
(make-marker))))
1761 (if (not noninteractive
)
1763 (message "hfy interactive mode (%S %S)" window-system major-mode
)
1764 (when (and font-lock-defaults
1766 (font-lock-fontify-region (point-min) (point-max) nil
)))
1767 (message "hfy batch mode (%s:%S)"
1768 (or (buffer-file-name) (buffer-name)) major-mode
)
1769 (when font-lock-defaults
1770 (font-lock-fontify-buffer)) ))
1773 (defun htmlfontify-buffer (&optional srcdir file
)
1774 "Create a new buffer, named for the current buffer + a .html extension,
1775 containing an inline CSS-stylesheet and formatted CSS-markup HTML
1776 that reproduces the look of the current Emacs buffer as closely
1779 Dangerous characters in the existing buffer are turned into HTML
1780 entities, so you should even be able to do HTML-within-HTML
1783 You should, however, note that random control or eight-bit
1784 characters such as ^L (\x0c) or ¤ (\xa4) won't get mapped yet.
1786 If the SRCDIR and FILE arguments are set, lookup etags derived
1787 entries in the `hfy-tags-cache' and add HTML anchors and
1788 hyperlinks as appropriate."
1790 ;; pick up the file name in case we didn't receive it
1792 (progn (setq file
(or (buffer-file-name) (buffer-name)))
1793 (if (string-match "/\\([^/]*\\)$" file
)
1794 (setq file
(match-string 1 file
)))) )
1796 (if (not (hfy-opt 'skip-refontification
))
1797 (save-excursion ;; Keep region
1798 (hfy-force-fontification)))
1799 (if (interactive-p) ;; display the buffer in interactive mode:
1800 (switch-to-buffer (hfy-fontify-buffer srcdir file
))
1801 (hfy-fontify-buffer srcdir file
)))
1803 ;; recursive file listing
1804 (defun hfy-list-files (directory)
1805 "Return a list of files under DIRECTORY.
1806 Strips any leading \"./\" from each filename."
1807 ;;(message "hfy-list-files");;DBUG
1808 ;; FIXME: this changes the dir of the currrent buffer. Is that right??
1810 (mapcar (lambda (F) (if (string-match "^./\\(.*\\)" F
) (match-string 1 F
) F
))
1811 (split-string (shell-command-to-string hfy-find-cmd
))) )
1813 ;; strip the filename off, return a directiry name
1814 ;; not a particularly thorough implementaion, but it will be
1815 ;; fed pretty carefully, so it should be Ok:
1816 (defun hfy-dirname (file)
1817 "Return everything preceding the last \"/\" from a relative filename FILE,
1818 on the assumption that this will produce a relative directory name.
1819 Hardly bombproof, but good enough in the context in which it is being used."
1820 ;;(message "hfy-dirname");;DBUG
1821 (let ((f (directory-file-name file
)))
1822 (and (string-match "^\\(.*\\)/" f
) (match-string 1 f
))))
1824 ;; create a directory, cf mkdir -p
1825 (defun hfy-make-directory (dir)
1826 "Approx. equivalent of mkdir -p DIR."
1827 ;;(message "hfy-make-directory");;DBUG
1828 (if (file-exists-p dir
)
1829 (if (file-directory-p dir
) t
)
1830 (make-directory dir t
)))
1832 (defun hfy-text-p (srcdir file
)
1833 "Is SRCDIR/FILE text? Uses `hfy-istext-command' to determine this."
1834 (let* ((cmd (format hfy-istext-command
(expand-file-name file srcdir
)))
1835 (rsp (shell-command-to-string cmd
)))
1836 (if (string-match "text" rsp
) t nil
)))
1838 ;; open a file, check fontification, if fontified, write a fontified copy
1839 ;; to the destination directory, otherwise just copy the file:
1840 (defun hfy-copy-and-fontify-file (srcdir dstdir file
)
1841 "Open FILE in SRCDIR - if fontified, write a fontified copy to DSTDIR
1842 adding an extension of `hfy-extn'. Fontification is actually done by
1843 `htmlfontify-buffer'. If the buffer is not fontified, just copy it."
1844 ;;(message "hfy-copy-and-fontify-file");;DBUG
1845 (let (;;(fast-lock-minimum-size hfy-fast-lock-save)
1846 ;;(font-lock-support-mode 'fast-lock-mode)
1847 ;;(window-system (or window-system 'htmlfontify))
1852 (with-current-buffer (setq source
(find-file-noselect file
))
1853 ;; FIXME: Shouldn't this use expand-file-name? --Stef
1854 (setq target
(concat dstdir
"/" file
))
1855 (hfy-make-directory (hfy-dirname target
))
1856 (if (not (hfy-opt 'skip-refontification
)) (hfy-force-fontification))
1857 (if (or (hfy-fontified-p) (hfy-text-p srcdir file
))
1858 (progn (setq html
(hfy-fontify-buffer srcdir file
))
1860 (write-file (concat target hfy-extn
))
1862 ;; #o0200 == 128, but emacs20 doesn't know that
1863 (if (and (file-exists-p target
) (not (file-writable-p target
)))
1864 (set-file-modes target
(logior (file-modes target
) 128)))
1865 (copy-file (buffer-file-name source
) target
'overwrite
))
1866 (kill-buffer source
)) ))
1868 ;; list of tags in file in srcdir
1869 (defun hfy-tags-for-file (srcdir file
)
1870 "List of etags tags that have definitions in this FILE.
1871 Looks up the tags cache in `hfy-tags-cache' using SRCDIR as the key."
1872 ;;(message "hfy-tags-for-file");;DBUG
1873 (let ((cache-entry (assoc srcdir hfy-tags-cache
))
1876 (if (setq cache-hash
(cadr cache-entry
))
1880 (setq tag-list
(cons K tag-list
)))) cache-hash
))
1883 ;; mark the tags native to this file for anchors
1884 (defun hfy-mark-tag-names (srcdir file
)
1885 "Mark tags in FILE (lookup SRCDIR in `hfy-tags-cache') with the `hfy-anchor'
1886 property, with a value of \"tag.line-number\"."
1887 ;;(message "(hfy-mark-tag-names %s %s)" srcdir file);;DBUG
1888 (let ((cache-entry (assoc srcdir hfy-tags-cache
))
1890 (if (setq cache-hash
(cadr cache-entry
))
1895 (if (string= file
(car TLIST
))
1896 (let* ((line (cadr TLIST
) )
1897 (chr (caddr TLIST
) )
1898 (link (format "%s.%d" TAG line
) ))
1899 (put-text-property (+ 1 chr
)
1901 'hfy-anchor link
))))
1902 (gethash TAG cache-hash
)))
1903 (hfy-tags-for-file srcdir file
)))))
1905 (defun hfy-relstub (file &optional start
)
1906 "Return a \"../\" stub of the appropriate length for the current source
1907 tree depth, as determined from FILE (a filename).
1908 START is the offset at which to start looking for the / character in FILE."
1909 ;;(message "hfy-relstub");;DBUG
1911 (while (setq start
(string-match "/" file start
))
1912 (setq start
(1+ start
)) (setq c
(concat c
"../"))) c
))
1914 (defun hfy-href-stub (this-file def-files tag
)
1915 "Return an href stub for a tag href in THIS-FILE.
1916 If DEF-FILES (list of files containing definitions for the tag in question)
1917 contains only one entry, the href should link straight to that file.
1918 Otherwise, the link should be to the index file.\n
1919 We are not yet concerned with the file extensions/tag line number and so on at
1921 If `hfy-split-index' is set, and the href wil be to an index file rather than
1922 a source file, append a .X to `hfy-index-file', where X is the uppercased
1923 first character of TAG.\n
1924 See also `hfy-relstub', `hfy-index-file'."
1925 ;;(message "hfy-href-stub");;DBUG
1926 ;; FIXME: Why not use something like
1927 ;; (file-relative-name (if ...) (file-name-directory this-file)) ? --Stef
1929 (hfy-relstub this-file
)
1930 (if (= 1 (length def-files
)) (car def-files
)
1931 (if (not hfy-split-index
) hfy-index-file
1932 (concat hfy-index-file
"." (upcase (substring tag
0 1)))))) )
1934 (defun hfy-href (this-file def-files tag tag-map
)
1935 "Return a relative href to the tag in question, based on\n
1936 THIS-FILE `hfy-link-extn' `hfy-extn' DEF-FILES TAG and TAG-MAP\n
1937 THIS-FILE is the current source file
1938 DEF-FILES is a list of file containing possible link endpoints for TAG
1939 TAG is the tag in question
1940 TAG-MAP is the entry in `hfy-tags-cache'."
1941 ;;(message "hfy-href");;DBUG
1943 (hfy-href-stub this-file def-files tag
)
1944 (or hfy-link-extn hfy-extn
) "#" tag
;;(.src -> .html)
1945 (if (= 1 (length def-files
))
1946 (concat "." (format "%d" (cadr (assoc (car def-files
) tag-map
)))))) )
1948 (defun hfy-word-regex (string)
1949 "Return a regex that matches STRING as the first `match-string', with non
1950 word characters on either side."
1951 ;; FIXME: Should this use [^$[:alnum:]_] instead? --Stef
1952 (concat "[^$A-Za-z_0-9]\\(" (regexp-quote string
) "\\)[^A-Za-z_0-9]"))
1954 ;; mark all tags for hyperlinking, except the tags at
1955 ;; their own points of definition, iyswim:
1956 (defun hfy-mark-tag-hrefs (srcdir file
)
1957 "Mark href start points with the `hfy-link' prop (value: href string).\n
1958 Mark href end points with the `hfy-endl' prop (value t).\n
1959 Avoid overlapping links, and mark links in descending length of
1960 tag name in order to prevent subtags from usurping supertags,
1961 \(eg \"term\" for \"terminal\").
1962 SRCDIR is the directory being \"published\".
1963 FILE is the specific file we are rendering."
1964 ;;(message "hfy-mark-tag-hrefs");;DBUG
1965 (let ((cache-entry (assoc srcdir hfy-tags-cache
))
1966 (list-cache (assoc srcdir hfy-tags-sortl
))
1967 (rmap-cache (assoc srcdir hfy-tags-rmap
))
1968 (no-comment (hfy-opt 'zap-comment-links
))
1969 (no-strings (hfy-opt 'zap-string-links
))
1973 (case-fold-search nil
))
1974 ;; extract the tag mapping hashes (fwd and rev) and the tag list:
1975 (if (and (setq cache-hash
(cadr cache-entry
))
1976 (setq tags-rmap
(cadr rmap-cache
))
1977 (setq tags-list
(cadr list-cache
)))
1984 (case-fold-search nil
)
1991 (tag-regex (hfy-word-regex TAG
))
1992 (tag-map (gethash TAG cache-hash
))
1993 (tag-files (mapcar #'car tag-map
)))
1994 ;; find instances of TAG and do what needs to be done:
1995 (goto-char (point-min))
1996 (while (search-forward TAG nil
'NOERROR
)
1997 (setq tmp-point
(point)
1998 maybe-start
(- (match-beginning 0) 1))
1999 (goto-char maybe-start
)
2000 (if (not (looking-at tag-regex
))
2002 (setq start
(match-beginning 1))
2003 (setq stop
(match-end 1))
2005 (and (or no-comment no-strings
) (hfy-face-at start
)))
2007 (setq face-at
(cadr (memq :inherit face-at
))))
2008 (if (or (text-property-any start
(1+ stop
) 'hfy-linkp t
)
2009 (and no-comment
(eq 'font-lock-comment-face face-at
))
2010 (and no-strings
(eq 'font-lock-string-face face-at
)))
2011 nil
;; already a link, NOOP
2013 ;; set a reverse map entry:
2014 (setq rmap-line
(line-number-at-pos)
2015 rmap-entry
(gethash TAG tags-rmap
)
2016 rnew-elt
(list file rmap-line start
)
2017 rmap-entry
(cons rnew-elt rmap-entry
)
2018 name
(format "%s.%d" TAG rmap-line
))
2019 (put-text-property start
(1+ start
) 'hfy-inst name
)
2020 (puthash TAG rmap-entry tags-rmap
)
2022 ;; mark the link. link to index if the tag has > 1 def
2023 ;; add the line number to the #name if it does not:
2024 (setq href
(hfy-href file tag-files TAG tag-map
))
2025 (put-text-property start
(1+ start
) 'hfy-link href
)
2026 (put-text-property stop
(1+ stop
) 'hfy-endl t
)
2027 (put-text-property start
(1+ stop
) 'hfy-linkp t
)))
2028 (goto-char tmp-point
)) ))
2032 "Return `shell-file-name', or \"/bin/sh\" if it is a non-bourne shell."
2033 (if (string-match "\\<bash\\>\\|\\<sh\\>\\|\\<dash\\>" shell-file-name
)
2035 (or hfy-shell-file-name
"/bin/sh")))
2037 ;; cache the #(tag => file line point) entries for files under srcdir
2038 ;; and cache the descending sorted list of tags in the relevant alist,
2039 ;; also keyed by srcdir:
2040 (defun hfy-load-tags-cache (srcdir)
2041 "Run `hfy-etags-cmd' on SRCDIR, then call `hfy-parse-tags-buffer'."
2042 ;;(message "hfy-load-tags-cache");;DBUG
2043 (let ((etags-buffer (get-buffer-create "*hfy-tags*"))
2044 (etags-command (format hfy-etags-cmd hfy-etags-bin
))
2045 (shell-file-name (hfy-shell)))
2047 (shell-command etags-command etags-buffer
)
2048 (hfy-parse-tags-buffer srcdir etags-buffer
)) )
2050 ;; break this out from `hfy-load-tags-cache' to make the tar file
2051 ;; functionality easier to implement.
2052 ;; ( tar file functionality not merged here because it requires a
2053 ;; hacked copy of etags capable of tagging stdin: if Francesco
2054 ;; Potorti accepts a patch, or otherwise implements stdin tagging,
2055 ;; then I will provide a `htmlfontify-tar-file' defun )
2056 (defun hfy-parse-tags-buffer (srcdir buffer
)
2057 "Parse a BUFFER containing etags formatted output, loading the
2058 `hfy-tags-cache' and `hfy-tags-sortl' entries for SRCDIR."
2059 (let ((cache-entry (assoc srcdir hfy-tags-cache
))
2060 (tlist-cache (assoc srcdir hfy-tags-sortl
))
2061 (trmap-cache (assoc srcdir hfy-tags-rmap
))
2062 (cache-hash nil
) (trmap-hash nil
) (tags-list nil
)
2063 (hash-entry nil
) (tag-string nil
) (tag-line nil
)
2064 (tag-point nil
) (new-entry nil
) (etags-file nil
))
2066 ;; (re)initialise the tag reverse map:
2067 (if trmap-cache
(setq trmap-hash
(cadr trmap-cache
))
2068 (setq trmap-hash
(make-hash-table :test
'equal
))
2069 (setq hfy-tags-rmap
(list (list srcdir trmap-hash
) hfy-tags-rmap
)))
2070 (clrhash trmap-hash
)
2072 ;; (re)initialise the tag cache:
2073 (if cache-entry
(setq cache-hash
(cadr cache-entry
))
2074 (setq cache-hash
(make-hash-table :test
'equal
))
2075 (setq hfy-tags-cache
(list (list srcdir cache-hash
) hfy-tags-cache
)))
2076 (clrhash cache-hash
)
2078 ;; cache the TAG => ((file line point) (file line point) ... ) entries:
2079 (with-current-buffer buffer
2080 (goto-char (point-min))
2082 (while (and (looking-at "^\x0c") (= 0 (forward-line 1)))
2083 ;;(message "^L boundary")
2084 (if (and (looking-at "^\\(.+\\),\\([0-9]+\\)$")
2085 (= 0 (forward-line 1)))
2087 (setq etags-file
(match-string 1))
2088 ;;(message "TAGS for file: %s" etags-file)
2089 (while (and (looking-at hfy-etag-regex
) (= 0 (forward-line 1)))
2090 (setq tag-string
(match-string 1))
2091 (if (= 0 (length tag-string
)) nil
;; noop
2092 (setq tag-line
(round (string-to-number (match-string 2))))
2093 (setq tag-point
(round (string-to-number (match-string 3))))
2094 (setq hash-entry
(gethash tag-string cache-hash
))
2095 (setq new-entry
(list etags-file tag-line tag-point
))
2096 (push new-entry hash-entry
)
2097 ;;(message "HASH-ENTRY %s %S" tag-string new-entry)
2098 (puthash tag-string hash-entry cache-hash
)))) )))
2100 ;; cache a list of tags in descending length order:
2101 (maphash (lambda (K V
) (push K tags-list
)) cache-hash
)
2102 (setq tags-list
(sort tags-list
(lambda (A B
) (< (length B
) (length A
)))))
2104 ;; put the tag list into the cache:
2105 (if tlist-cache
(setcar (cdr tlist-cache
) tags-list
)
2106 (push (list srcdir tags-list
) hfy-tags-sortl
))
2108 ;; return the number of tags found:
2109 (length tags-list
) ))
2111 (defun hfy-prepare-index-i (srcdir dstdir filename
&optional stub map
)
2112 "Prepare a tags index buffer for SRCDIR.
2113 `hfy-tags-cache' must already have an entry for SRCDIR for this to work.
2114 `hfy-page-header', `hfy-page-footer', `hfy-link-extn' and `hfy-extn'
2115 all play a part here.\n
2116 If STUB is set, prepare an (appropriately named) index buffer
2117 specifically for entries beginning with STUB.\n
2118 If MAP is set, use that instead of `hfy-tags-cache'.
2119 FILENAME is the name of the file being indexed.
2120 DSTDIR is the output directory, where files will be written."
2121 ;;(message "hfy-write-index");;DBUG
2122 (let ((cache-entry (assoc srcdir
(or map hfy-tags-cache
)))
2126 (concat filename
(if stub
(concat "." stub
) "") hfy-extn
))
2128 (if (not (and cache-entry
2129 (setq cache-hash
(cadr cache-entry
))
2130 (setq index-buf
(get-buffer-create index-file
))))
2132 (maphash (lambda (K V
) (push K tag-list
)) cache-hash
)
2133 (setq tag-list
(sort tag-list
'string
<))
2134 (set-buffer index-buf
)
2136 (insert (funcall hfy-page-header filename
"<!-- CSS -->"))
2137 (insert "<table class=\"index\">\n")
2139 (dolist (TAG tag-list
)
2140 (let ((tag-started nil
))
2141 (dolist (DEF (gethash TAG cache-hash
))
2142 (if (and stub
(not (string-match (concat "^" stub
) TAG
)))
2143 nil
;; we have a stub and it didn't match: NOOP
2144 (let ((file (car DEF
))
2151 " <td><a href=\"%s%s\">%s</a></td> \n"
2152 " <td><a href=\"%s%s#%s.%d\">%d</a></td>\n"
2154 (if (string= TAG tag-started
) " "
2155 (format "<a name=\"%s\">%s</a>" TAG TAG
))
2156 file
(or hfy-link-extn hfy-extn
) file
2157 file
(or hfy-link-extn hfy-extn
) TAG line line
))
2158 (setq tag-started TAG
))))))
2159 (insert "</table>\n")
2160 (insert (funcall hfy-page-footer filename
))
2161 (and dstdir
(cd dstdir
))
2162 (set-visited-file-name index-file
)
2165 (defun hfy-prepare-index (srcdir dstdir
)
2166 "Return a list of index buffer(s), as determined by `hfy-split-index'.
2167 SRCDIR and DSTDIR are the source and output directories respectively."
2168 (if (not hfy-split-index
)
2169 (list (hfy-prepare-index-i srcdir dstdir hfy-index-file nil
))
2170 (let ((stub-list nil
)
2173 (cache-entry (assoc srcdir hfy-tags-cache
)))
2174 (if (and cache-entry
(setq cache-hash
(cadr cache-entry
)))
2177 (let ((stub (upcase (substring K
0 1))))
2178 (if (member stub stub-list
)
2179 nil
;; seen this already: NOOP
2181 stub-list
(cons stub stub-list
)
2182 index-list
(cons (hfy-prepare-index-i srcdir
2186 index-list
)) ))) cache-hash
) ) index-list
)))
2188 (defun hfy-prepare-tag-map (srcdir dstdir
)
2189 "Prepare the counterpart(s) to the index buffer(s) - a list of buffers
2190 with the same structure, but listing (and linking to) instances of tags
2191 \(as opposed to their definitions).\n
2192 SRCDIR and DSTDIR are the source and output directories respectively.
2193 See also `hfy-prepare-index', `hfy-split-index'."
2194 (if (not hfy-split-index
)
2195 (list (hfy-prepare-index-i srcdir
2200 (let ((stub-list nil
)
2203 (cache-entry (assoc srcdir hfy-tags-rmap
)))
2205 (if (and cache-entry
(setq cache-hash
(cadr cache-entry
)))
2208 (let ((stub (upcase (substring K
0 1))))
2209 (if (member stub stub-list
)
2210 nil
;; seen this already: NOOP
2212 stub-list
(cons stub stub-list
)
2213 index-list
(cons (hfy-prepare-index-i srcdir
2218 index-list
)) ))) cache-hash
) ) index-list
)))
2220 (defun hfy-subtract-maps (srcdir)
2221 "Internal function - strips definitions of tags from the instance map.
2222 SRCDIR is the directory being \"published\".
2223 See also `hfy-tags-cache', `hfy-tags-rmap'."
2224 (let ((new-list nil
)
2228 (fwd-map (cadr (assoc srcdir hfy-tags-cache
)))
2229 (rev-map (cadr (assoc srcdir hfy-tags-rmap
)))
2230 (taglist (cadr (assoc srcdir hfy-tags-sortl
))))
2231 (dolist (TAG taglist
)
2232 (setq def-list
(gethash TAG fwd-map
)
2233 old-list
(gethash TAG rev-map
)
2234 exc-list
(mapcar (lambda (P) (list (car P
) (cadr P
))) def-list
)
2236 (dolist (P old-list
)
2237 (or (member (list (car P
) (cadr P
)) exc-list
)
2239 (puthash TAG new-list rev-map
))))
2241 (defun htmlfontify-run-etags (srcdir)
2242 "Load the etags cache for SRCDIR.
2243 See also `hfy-load-tags-cache'."
2244 (interactive "D source directory: ")
2245 (setq srcdir
(directory-file-name srcdir
))
2246 (hfy-load-tags-cache srcdir
))
2248 ;;(defun hfy-test-read-args (foo bar)
2249 ;; (interactive "D source directory: \nD target directory: ")
2250 ;; (message "foo: %S\nbar: %S" foo bar))
2252 (defun hfy-save-kill-buffers (buffer-list &optional dstdir
)
2253 (dolist (B buffer-list
)
2255 (and dstdir
(file-directory-p dstdir
) (cd dstdir
))
2260 (defun htmlfontify-copy-and-link-dir (srcdir dstdir
&optional f-ext l-ext
)
2261 "Trawl SRCDIR and write fontified-and-hyperlinked output in DSTDIR.
2262 F-EXT and L-EXT specify values for `hfy-extn' and `hfy-link-extn'.\n
2263 You may also want to set `hfy-page-header' and `hfy-page-footer'."
2264 (interactive "D source directory: \nD output directory: ")
2265 ;;(message "htmlfontify-copy-and-link-dir")
2266 (setq srcdir
(directory-file-name srcdir
))
2267 (setq dstdir
(directory-file-name dstdir
))
2268 (let ((source-files "SETME: list of source files, relative to srcdir")
2269 (tr-cache (assoc srcdir hfy-tags-rmap
))
2270 (hfy-extn (or f-ext
".html"))
2271 (hfy-link-extn (or l-ext
".html")))
2272 ;; oops, forgot to load etags for srcdir:
2274 (message "autoload of tags cache")
2275 (hfy-load-tags-cache srcdir
)
2276 (setq tr-cache
(assoc srcdir hfy-tags-rmap
)))
2277 ;; clear out the old cache:
2278 (clrhash (cadr tr-cache
))
2279 (hfy-make-directory dstdir
)
2280 (setq source-files
(hfy-list-files srcdir
))
2281 (dolist (file source-files
)
2282 (hfy-copy-and-fontify-file srcdir dstdir file
))
2283 (hfy-subtract-maps srcdir
)
2284 (hfy-save-kill-buffers (hfy-prepare-index srcdir dstdir
) dstdir
)
2285 (hfy-save-kill-buffers (hfy-prepare-tag-map srcdir dstdir
) dstdir
) ))
2287 ;; name of the init file we want:
2288 (defun hfy-initfile ()
2289 "Return the expected location of the htmlfontify specific init/custom file."
2290 (let* ((file (or (getenv "HFY_INITFILE") ".hfy.el")))
2291 (expand-file-name file
"~") ))
2294 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2295 ;; incomplete as yet : transfer hook settings to hfy init file:
2296 ;; (defalias 'hfy-set-hooks 'custom-set-variables)
2298 ;; (defun hfy-pp-hook (H)
2299 ;; (and (string-match "-hook$" (symbol-name H))
2302 ;; (insert (format "\n '(%S %S)" H (symbol-value H)))
2306 ;; (defun hfy-save-hooks ()
2307 ;; (let ((custom-file (hfy-initfile)))
2308 ;; (custom-save-delete 'hfy-set-hooks)
2309 ;; (let ((standard-output (current-buffer)))
2310 ;; (princ "(hfy-set-hooks\n;;auto-generated, only one copy allowed\n")
2311 ;; (mapatoms 'hfy-pp-hook)
2316 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2318 (defalias 'hfy-init-progn
'progn
)
2320 (defun hfy-save-initvar (sym)
2321 (princ (format "(setq %s\n '" sym
))
2322 (pp (symbol-value sym
))
2325 (defun htmlfontify-save-initfile ()
2326 "Save the htmlfontify settings to the htmlfontify init file."
2328 (let* ((start-pos nil
)
2329 (custom-file (hfy-initfile))
2330 (standard-output (find-file-noselect custom-file
'nowarn
)))
2332 (custom-save-delete 'hfy-init-progn
)
2333 (setq start-pos
(point))
2334 (princ "(hfy-init-progn\n;;auto-generated, only one copy allowed\n")
2335 ;; FIXME: This saving&restoring of global customization
2336 ;; variables can interfere with other customization settings for
2337 ;; those vars (in .emacs or in Customize).
2338 (mapc 'hfy-save-initvar
2339 '(auto-mode-alist interpreter-mode-alist
))
2341 (indent-region start-pos
(point) nil
))
2342 (custom-save-all) ))
2344 (defun htmlfontify-load-initfile ()
2345 "Load the htmlfontify specific init/custom file."
2347 (let ((file (hfy-initfile)))
2348 (load file
'NOERROR nil nil
) ))
2351 ;;;### (autoloads (hfy-fallback-colour-values htmlfontify-load-rgb-file)
2352 ;;;;;; "hfy-cmap" "hfy-cmap.el" "3de2db2d213813bb3afe170ffd66cdde")
2353 ;;; Generated autoloads from hfy-cmap.el
2355 (autoload 'htmlfontify-load-rgb-file
"hfy-cmap" "\
2356 Load an X11 style rgb.txt FILE.
2357 Search `hfy-rgb-load-path' if FILE is not specified.
2358 Loads the variable `hfy-rgb-txt-colour-map', which is used by
2359 `hfy-fallback-colour-values'.
2361 \(fn &optional FILE)" t nil
)
2363 (autoload 'hfy-fallback-colour-values
"hfy-cmap" "\
2364 Use a fallback method for obtaining the rgb values for a color.
2366 \(fn COLOUR-STRING)" nil nil
)
2371 (provide 'htmlfontify
)
2373 ;; arch-tag: 944e5e63-c81d-4baa-a82a-0275f9c30e61
2374 ;;; htmlfontify.el ends here