;;; htmlfontify.el --- htmlize a buffer/source tree with optional hyperlinks
-;; Copyright (C) 2002-2003, 2009-2015 Free Software Foundation, Inc.
+;; Copyright (C) 2002-2003, 2009-2016 Free Software Foundation, Inc.
;; Emacs Lisp Archive Entry
;; Package: htmlfontify
\(defun rtfm-build-source-docs (section srcdir destdir)
(interactive
\"s section[eg- emacs / p4-blame]:\\nD source-dir: \\nD output-dir: \")
- (require 'htmlfontify)
+ (require \\='htmlfontify)
(hfy-load-tags-cache srcdir)
- (let ((hfy-page-header 'rtfm-build-page-header)
- (hfy-page-footer 'rtfm-build-page-footer)
+ (let ((hfy-page-header \\='rtfm-build-page-header)
+ (hfy-page-footer \\='rtfm-build-page-footer)
(rtfm-section section)
(hfy-index-file \"index\"))
(htmlfontify-run-etags srcdir)
:type '(string))
(defcustom hfy-src-doc-link-style "text-decoration: underline;"
- "String to add to the '<style> a' variant of an htmlfontify CSS class."
+ "String to add to the `<style> a' variant of an htmlfontify CSS class."
:group 'htmlfontify
:tag "src-doc-link-style"
:type '(string))
(defcustom hfy-src-doc-link-unstyle " text-decoration: none;"
- "Regex to remove from the <style> a variant of an htmlfontify CSS class."
+ "Regex to remove from the `<style> a' variant of an htmlfontify CSS class."
:group 'htmlfontify
:tag "src-doc-link-unstyle"
:type '(string))
:type '(hook))
(defcustom hfy-default-face-def nil
- "Fallback `defface' specification for the face 'default, used when
+ "Fallback `defface' specification for the face `default', used when
`hfy-display-class' has been set (the normal htmlfontify way of extracting
potentially non-current face information doesn't necessarily work for
-'default).\n
+`default').\n
Example: I customize this to:\n
\((t :background \"black\" :foreground \"white\" :family \"misc-fixed\"))"
:group 'htmlfontify
(defcustom hfy-etags-cmd-alist
hfy-etags-cmd-alist-default
"Alist of possible shell commands that will generate etags output that
-`htmlfontify' can use. '%s' will be replaced by `hfy-etags-bin'."
+`htmlfontify' can use. `%s' will be replaced by `hfy-etags-bin'."
:group 'htmlfontify
:tag "etags-cmd-alist"
:type '(alist :key-type (string) :value-type (string)))
(defcustom hfy-istext-command "file %s | sed -e 's@^[^:]*:[ \t]*@@'"
"Command to run with the name of a file, to see whether it is a text file
-or not. The command should emit a string containing the word 'text' if
-the file is a text file, and a string not containing 'text' otherwise."
+or not. The command should emit a string containing the word `text' if
+the file is a text file, and a string not containing `text' otherwise."
:group 'htmlfontify
:tag "istext-command"
:type '(string))
are running Emacs on a tty or in batch mode, and want htmlfontify to have
access to the face spec you would use if you were connected to an X display.\n
Some valid class specification elements are:\n
- '(class color)
- '(class grayscale)
- '(background dark)
- '(background light)
- '(type x-toolkit)
- '(type tty)
- '(type motif)
- '(type lucid)
+ (class color)
+ (class grayscale)
+ (background dark)
+ (background light)
+ (type x-toolkit)
+ (type tty)
+ (type motif)
+ (type lucid)
Multiple values for a tag may be combined, to indicate that any one or more
of these values in the specification key constitutes a match, eg:\n
-'((class color grayscale) (type tty)) would match any of:\n
- '((class color))
- '((class grayscale))
- '((class color grayscale))
- '((class color foo))
- '((type tty))
- '((type tty) (class color))\n
+((class color grayscale) (type tty)) would match any of:\n
+ ((class color))
+ ((class grayscale))
+ ((class color grayscale))
+ ((class color foo))
+ ((type tty))
+ ((type tty) (class color))\n
and so on."
:type '(alist :key-type (symbol) :value-type (symbol))
:group 'htmlfontify
(background (choice (const :tag "Dark" dark )
(const :tag "Bright" light ))) ))
-(defcustom hfy-optimisations (list 'keep-overlays)
+(defcustom hfy-optimizations (list 'keep-overlays)
"Optimizations to turn on: So far, the following have been implemented:\n
merge-adjacent-tags: If two (or more) span tags are adjacent, identical and
separated by nothing more than whitespace, they will
(const :tag "body-text-only" body-text-only ))
:group 'htmlfontify
:tag "optimizations")
+(define-obsolete-variable-alias 'hfy-optimisations 'hfy-optimizations "25.1")
(defvar hfy-tags-cache nil
"Alist of the form:\n
(defvar hfy-style-assoc 'please-ignore-this-line
"An assoc representing/describing an Emacs face.
Properties may be repeated, in which case later properties should be
-treated as if they were inherited from a 'parent' font.
+treated as if they were inherited from a `parent' font.
\(For some properties, only the first encountered value is of any importance,
for others the values might be cumulative, and for others they might be
cumulative in a complex way.)\n
Some examples:\n
-\(hfy-face-to-style 'default) =>
+\(hfy-face-to-style \\='default) =>
((\"background\" . \"rgb(0, 0, 0)\")
(\"color\" . \"rgb(255, 255, 255)\")
(\"font-style\" . \"normal\")
(\"font-family\" . \"misc-fixed\")
(\"font-size\" . \"13pt\")
(\"text-decoration\" . \"none\"))\n
-\(hfy-face-to-style 'Info-title-3-face) =>
+\(hfy-face-to-style \\='Info-title-3-face) =>
((\"font-weight\" . \"700\")
(\"font-family\" . \"helv\")
(\"font-size\" . \"120%\")
(defvar hfy-facemap-assoc 'please-ignore-this-line
"An assoc of (point . FACE-SYMBOL) or (point . DEFFACE-LIST)
-and (point . 'end) elements, in descending order of point value
+and (point . \\='end) elements, in descending order of point value
\(ie from the file's end to its beginning).\n
The map is in reverse order because inserting a <style> tag (or any other
string) at `point' invalidates the map for all entries with a greater value of
point. By traversing the map from greatest to least point, we still invalidate
the map as we go, but only those points we have already dealt with (and
therefore no longer care about) will be invalid at any time.\n
-'((64820 . end)
+\\='((64820 . end)
(64744 . font-lock-comment-face)
(64736 . end)
(64722 . font-lock-string-face)
(defun hfy-opt (symbol)
"Is option SYMBOL set."
- (memq symbol hfy-optimisations))
+ (memq symbol hfy-optimizations))
(defun hfy-default-header (file style)
"Default value for `hfy-page-header'.
to use, to the best of my understanding).\n
If CLASS is nil, then you just get whatever `face-attr-construct' returns,
ie the current specification in effect for FACE.\n
-*NOTE*: This function forces any face that is not 'default and which has
-no :inherit property to inherit from 'default (this is because 'default
+*NOTE*: This function forces any face that is not `default' and which has
+no :inherit property to inherit from `default' (this is because `default'
is magical in that Emacs's fonts behave as if they inherit implicitly from
-'default, but no such behavior exists in HTML/CSS).\n
+`default', but no such behavior exists in HTML/CSS).\n
See also `hfy-display-class' for details of valid values for CLASS."
(let ((face-spec
(if class
(append
parent
(hfy-face-to-style-i
- (hfy-face-attr-for-class v hfy-display-class)) ))))
+ (hfy-face-attr-for-class v hfy-display-class))))))
(setq this
(if val (case key
(:family (hfy-family val))
(:italic (hfy-slant 'italic))))))
(setq that (hfy-face-to-style-i next))
;;(lwarn t :warning "%S => %S" fn (nconc this that parent))
- (nconc this that parent))) )
+ (nconc this parent that))) )
(defun hfy-size-to-int (spec)
"Convert SPEC, a CSS font-size specifier, to an Emacs :height attribute value.
(nconc r (hfy-size (if x (round n) (* n 1.0)))) ))
(defun hfy-face-resolve-face (fn)
+ "For FN return a face specification.
+FN may be either a face or a face specification. If the latter,
+then the specification is returned unchanged."
(cond
((facep fn)
(hfy-face-attr-for-class fn hfy-display-class))
+ ;; FIXME: is this necessary? Faces can be symbols, but
+ ;; not symbols refering to other symbols?
((and (symbolp fn)
(facep (symbol-value fn)))
- (hfy-face-attr-for-class (symbol-value fn) hfy-display-class))
- (t nil)))
+ (hfy-face-attr-for-class
+ (symbol-value fn) hfy-display-class))
+ (t fn)))
(defun hfy-face-to-style (fn)
(defvar hfy-face-to-css 'hfy-face-to-css-default
"Handler for mapping faces to styles.
-The signature of the handler is of the form \(lambda (FN) ...\).
+The signature of the handler is of the form \(lambda (FN) ...).
FN is a font or `defface' specification (cf
`face-attr-construct'). The handler should return a cons cell of
the form (STYLE-NAME . STYLE-SPEC).
;; -- v
(defun hfy-face-at (p)
"Find face in effect at point P.
-If overlays are to be considered (see `hfy-optimisations') then this may
+If overlays are to be considered (see `hfy-optimizations') then this may
return a `defface' style list of face properties instead of a face symbol."
;;(message "hfy-face-at");;DBUG
;; Fix-me: clean up, remove face-name etc
(defvar hfy-begin-span-handler 'hfy-begin-span
"Handler to begin a span of text.
The signature of the handler is \(lambda (STYLE TEXT-BLOCK
-TEXT-ID TEXT-BEGINS-BLOCK-P) ...\). The handler must insert
+TEXT-ID TEXT-BEGINS-BLOCK-P) ...). The handler must insert
appropriate tags to begin a span of text.
STYLE is the name of the style that begins at point. It is
(defvar hfy-end-span-handler 'hfy-end-span
"Handler to end a span of text.
-The signature of the handler is \(lambda () ...\). The handler
+The signature of the handler is \(lambda () ...). The handler
must insert appropriate tags to end a span of text.
The default handler is `hfy-end-span'.")
It is assumed that STRING has text properties that allow it to be
fontified. This is a simple convenience wrapper around
`htmlfontify-buffer'."
- (let* ((hfy-optimisations-1 (copy-sequence hfy-optimisations))
- (hfy-optimisations (add-to-list 'hfy-optimisations-1
+ (let* ((hfy-optimizations-1 (copy-sequence hfy-optimizations))
+ (hfy-optimizations (add-to-list 'hfy-optimizations-1
'skip-refontification)))
(with-temp-buffer
(insert string)
(eval-and-compile (require 'font-lock))
(if (boundp 'font-lock-cache-position)
(or font-lock-cache-position
- (set 'font-lock-cache-position (make-marker))))
- (if (not noninteractive)
- (progn
- (message "hfy interactive mode (%S %S)" window-system major-mode)
- (when (and font-lock-defaults
- font-lock-mode)
- (font-lock-fontify-region (point-min) (point-max) nil)))
+ (setq font-lock-cache-position (make-marker))))
+ (cond
+ (noninteractive
(message "hfy batch mode (%s:%S)"
(or (buffer-file-name) (buffer-name)) major-mode)
- (when font-lock-defaults
- (font-lock-fontify-buffer)) ))
+ (if (fboundp 'font-lock-ensure)
+ (font-lock-ensure)
+ (when font-lock-defaults
+ (font-lock-fontify-buffer))))
+ ((fboundp #'jit-lock-fontify-now)
+ (message "hfy jit-lock mode (%S %S)" window-system major-mode)
+ (jit-lock-fontify-now))
+ (t
+ (message "hfy interactive mode (%S %S)" window-system major-mode)
+ ;; If jit-lock is not in use, then the buffer is already fontified!
+ ;; (when (and font-lock-defaults
+ ;; font-lock-mode)
+ ;; (font-lock-fontify-region (point-min) (point-max) nil))
+ )))
;;;###autoload
(defun htmlfontify-buffer (&optional srcdir file)
(load file 'NOERROR nil nil) ))
\f
-;;;### (autoloads nil "hfy-cmap" "hfy-cmap.el" "27dc80b0f7187aaf582805a8f887819a")
+;;;### (autoloads nil "hfy-cmap" "hfy-cmap.el" "e644ddae915ddb98c9b2f16ffa5a74b2")
;;; Generated autoloads from hfy-cmap.el
(autoload 'htmlfontify-load-rgb-file "hfy-cmap" "\
(provide 'htmlfontify)
-;; Local Variables:
-;; coding: utf-8
-;; End:
-
;;; htmlfontify.el ends here