diff --git a/Makefile b/Makefile index c759075..b8cd9b2 100644 --- a/Makefile +++ b/Makefile @@ -4,12 +4,13 @@ default: build +tangle: + +doc: + build: dune build -doc: - dune build @doc - test: dune runtest -f diff --git a/bin/build_doc.sh b/bin/build_doc.sh new file mode 100755 index 0000000..0552af5 --- /dev/null +++ b/bin/build_doc.sh @@ -0,0 +1,27 @@ +#!/bin/bash +# Usage: $0 [DIR] + +if [[ -z $1 ]] ; then + echo "Usage: $0 [DIR]" + exit -1 +fi + + +if [[ $(basename $PWD) != "QCaml" ]] ; then + echo "This script needs to be run in the QCaml directory" + exit -1 +fi + +DIR=${1%/} + +rm -f docs/${DIR}.org +for i in ${DIR}/README.org ${DIR}/[a-z]*.org +do + cat $i >> docs/${DIR}.org +done + +CONFIG="--load docs/htmlize.el --load docs/config.el" + +emacs --batch $CONFIG docs/${DIR}.org -f org-html-export-to-html + + diff --git a/common/README.org b/common/README.org index a23fe4b..4a103a8 100644 --- a/common/README.org +++ b/common/README.org @@ -1,13 +1,10 @@ #+TITLE: Common +#+SETUPFILE: https://fniessen.github.io/org-html-themes/org/theme-readtheorg.setup -[[elisp:(org-babel-tangle)]] This directory contains many utility functions used by all the other directories. -- [[./angular_momentum.org][Angular Momentum]] -- [[./bitstring.org][Bit string]] - -* Dune files +* Dune files :noexport: :PROPERTIES: :dune: lib/dune :dune-test: test/dune @@ -52,6 +49,7 @@ This directory contains many utility functions used by all the other directories qcaml.common ) #+end_src + *** Extra C files The ~math_functions~ file contains small C snippets to add missing diff --git a/common/angular_momentum.org b/common/angular_momentum.org index 0f5a5bc..45ef463 100644 --- a/common/angular_momentum.org +++ b/common/angular_momentum.org @@ -1,4 +1,4 @@ -#+begin_src elisp tangle: no :results none +#+begin_src elisp tangle: no :results none :exports none (setq pwd (file-name-directory buffer-file-name)) (setq name (file-name-nondirectory (substring buffer-file-name 0 -4))) (setq lib (concat pwd "lib/")) @@ -7,17 +7,15 @@ (setq ml (concat lib name ".ml")) (setq test-ml (concat testdir name ".ml")) (org-babel-tangle) -#+end_src +#+end_src * Angular Momentum :PROPERTIES: - :ml: lib/angular_momentum.ml - :mli: lib/angular_momentum.mli :header-args: :noweb yes :comments both :END: - Azimuthal quantum number, repsesented as $s,p,d,...$. + Azimuthal quantum number, repsesented as \( s,p,d,\dots \) . ** Type @@ -43,7 +41,7 @@ type kind = The ~kind~ is used to build shells, shell doublets, triplets or quartets, use in the two-electron operators. - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none <> open Powers #+end_src @@ -65,7 +63,7 @@ Angular_momentum.of_char 'p' -> Angular_momentum.P val of_char : char -> t #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let of_char = function | 's' | 'S' -> S | 'p' | 'P' -> P | 'd' | 'D' -> D | 'f' | 'F' -> F @@ -89,7 +87,7 @@ Angular_momentum.(to_string D) -> "D" val to_string : t -> string #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let to_string = function | S -> "S" | P -> "P" | D -> "D" | F -> "F" @@ -112,7 +110,7 @@ Angular_momentum.(to_char D) -> 'D' val to_char : t -> char #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let to_char = function | S -> 'S' | P -> 'P' | D -> 'D' | F -> 'F' @@ -135,7 +133,7 @@ Angular_momentum.(to_char D) -> 2 val to_int : t -> int #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let to_int = function | S -> 0 | P -> 1 | D -> 2 | F -> 3 @@ -158,7 +156,7 @@ Angular_momentum.of_int 3 -> Angular_momentum.F val of_int : int -> t #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let of_int = function | 0 -> S | 1 -> P | 2 -> D | 3 -> F @@ -185,7 +183,7 @@ Angular_momentum.n_functions D -> 6 val n_functions : t -> int #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let n_functions a = let a = to_int a @@ -221,7 +219,7 @@ let n_functions a = val zkey_array : kind -> Zkey.t array #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let zkey_array_memo : (kind, Zkey.t array) Hashtbl.t = Hashtbl.create 13 @@ -307,7 +305,7 @@ val ( + ) : t -> t -> t val ( - ) : t -> t -> t #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let ( + ) a b = of_int ( (to_int a) + (to_int b) ) @@ -325,7 +323,7 @@ val pp_string : Format.formatter -> t -> unit val pp_int : Format.formatter -> t -> unit #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let pp_string ppf x = Format.fprintf ppf "@[%s@]" (to_string x) diff --git a/common/bitstring.org b/common/bitstring.org index 0ac187a..3a5ffb8 100644 --- a/common/bitstring.org +++ b/common/bitstring.org @@ -1,4 +1,4 @@ -#+begin_src elisp tangle: no :results none +#+begin_src elisp tangle: no :results none :exports none (setq pwd (file-name-directory buffer-file-name)) (setq name (file-name-nondirectory (substring buffer-file-name 0 -4))) (setq lib (concat pwd "lib/")) @@ -7,13 +7,10 @@ (setq ml (concat lib name ".ml")) (setq test-ml (concat testdir name ".ml")) (org-babel-tangle) -#+end_src +#+end_src * Bit string :PROPERTIES: - :ml: lib/bitstring.ml - :mli: lib/bitstring.mli - :test-ml: test/bitstring.ml :header-args: :noweb yes :comments both :END: @@ -23,10 +20,10 @@ When more than 63 bits are required, the =zarith= library is used to consider the bit string as a multi-precision integer. - -** Single-integer implementation - #+begin_src ocaml :tangle (eval ml) +** Single-integer implementation :noexport: + + #+begin_src ocaml :tangle (eval ml) :exports none module One = struct let of_int x = @@ -38,9 +35,9 @@ module One = struct let shift_left x i = x lsl i let shift_right x i = x lsr i let shift_left_one i = 1 lsl i - let testbit x i = ( (x lsr i) land 1 ) = 1 + let testbit x i = ( (x lsr i) land 1 ) = 1 let logor a b = a lor b - let neg a = - a + let neg a = - a let logxor a b = a lxor b let logand a b = a land b let lognot a = lnot a @@ -49,31 +46,31 @@ module One = struct let popcount = function | 0 -> 0 - | r -> Util.popcnt (Int64.of_int r) + | r -> Util.popcnt (Int64.of_int r) - let trailing_zeros r = - Util.trailz (Int64.of_int r) + let trailing_zeros r = + Util.trailz (Int64.of_int r) let hamdist a b = a lxor b - |> popcount + |> popcount - let pp ppf s = - Format.fprintf ppf "@[@[%a@]@]" (Util.pp_bitstring 64) + let pp ppf s = + Format.fprintf ppf "@[@[%a@]@]" (Util.pp_bitstring 64) (Z.of_int s) end #+end_src -** Zarith implementation +** Zarith implementation :noexport: - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none module Many = struct let of_z x = x let zero = Z.zero let is_zero x = x = Z.zero - let shift_left = Z.shift_left + let shift_left = Z.shift_left let shift_right = Z.shift_right let shift_left_one i = Z.shift_left Z.one i let testbit = Z.testbit @@ -88,10 +85,10 @@ module Many = struct let hamdist = Z.hamdist let numbits i = max (Z.numbits i) 64 - let popcount z = + let popcount z = if z = Z.zero then 0 else Z.popcount z - let pp ppf s = + let pp ppf s = Format.fprintf ppf "@[@[%a@]@]" (Util.pp_bitstring (Z.numbits s)) s end @@ -103,13 +100,13 @@ end type t #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none type t = | One of int | Many of Z.t #+end_src -** Tests header +** Tests header :noexport: #+begin_src ocaml :tangle (eval test-ml) open Common.Bitstring @@ -120,51 +117,52 @@ let test_all () = let z = Z.shift_left (Z.of_int x) 64 in let many_x = of_z z in #+end_src + ** General implementation - + *** ~of_int~ - + Creates a bit string from an ~int~. #+begin_src ocaml :tangle (eval mli) val of_int : int -> t #+end_src - - #+begin_src ocaml :tangle (eval ml) + + #+begin_src ocaml :tangle (eval ml) :exports none let of_int x = One (One.of_int x) #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none Alcotest.(check bool) "of_x" true (one_x = (of_int x)); #+end_src *** ~of_z~ - + Creates a bit string from an ~Z.t~ multi-precision integer. #+begin_src ocaml :tangle (eval mli) val of_z : Z.t -> t #+end_src - - #+begin_src ocaml :tangle (eval ml) + + #+begin_src ocaml :tangle (eval ml) :exports none let of_z x = if Z.numbits x < 64 then One (Z.to_int x) else Many (Many.of_z x) #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none Alcotest.(check bool) "of_z" true (one_x = (of_z (Z.of_int x))); #+end_src *** ~zero~ ~zero n~ creates a zero bit string with ~n~ bits. - + #+begin_src ocaml :tangle (eval mli) val zero : int -> t #+end_src - - #+begin_src ocaml :tangle (eval ml) + + #+begin_src ocaml :tangle (eval ml) :exports none let zero = function | n when n < 64 -> One (One.zero) | _ -> Many (Many.zero) @@ -173,12 +171,12 @@ let zero = function *** ~numbits~ Returns the number of bits used to represent the bit string. - + #+begin_src ocaml :tangle (eval mli) val numbits : t -> int #+end_src - - #+begin_src ocaml :tangle (eval ml) + + #+begin_src ocaml :tangle (eval ml) :exports none let numbits = function | One x -> One.numbits x | Many x -> Many.numbits x @@ -187,12 +185,12 @@ let numbits = function *** ~is_zero~ True if all the bits of the bit string are zero. - + #+begin_src ocaml :tangle (eval mli) val is_zero : t -> bool #+end_src - - #+begin_src ocaml :tangle (eval ml) + + #+begin_src ocaml :tangle (eval ml) :exports none let is_zero = function | One x -> One.is_zero x | Many x -> Many.is_zero x @@ -210,7 +208,7 @@ neg (of_int x) = neg (of_int (-x)) val neg : t -> t #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let neg = function | One x -> One (One.neg x) | Many x -> Many (Many.neg x) @@ -220,18 +218,18 @@ let neg = function ~shift_left t n~ returns a new bit strings with all the bits shifted ~n~ positions to the left. - + #+begin_src ocaml :tangle (eval mli) val shift_left : t -> int -> t #+end_src - - #+begin_src ocaml :tangle (eval ml) + + #+begin_src ocaml :tangle (eval ml) :exports none let shift_left x i = match x with | One x -> One (One.shift_left x i) | Many x -> Many (Many.shift_left x i) #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none Alcotest.(check bool) "shift_left1" true (of_int (x lsl 3) = shift_left one_x 3); Alcotest.(check bool) "shift_left2" true (of_z (Z.shift_left z 3) = shift_left many_x 3); Alcotest.(check bool) "shift_left3" true (of_z (Z.shift_left z 100) = shift_left many_x 100); @@ -241,18 +239,18 @@ let shift_left x i = match x with ~shift_right t n~ returns a new bit strings with all the bits shifted ~n~ positions to the right. - + #+begin_src ocaml :tangle (eval mli) val shift_right : t -> int -> t #+end_src - - #+begin_src ocaml :tangle (eval ml) + + #+begin_src ocaml :tangle (eval ml) :exports none let shift_right x i = match x with | One x -> One (One.shift_right x i) | Many x -> Many (Many.shift_right x i) #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none Alcotest.(check bool) "shift_right1" true (of_int (x lsr 3) = shift_right one_x 3); Alcotest.(check bool) "shift_right2" true (of_z (Z.shift_right z 3) = shift_right many_x 3); #+end_src @@ -263,19 +261,19 @@ let shift_right x i = match x with bit set to one. It is equivalent as shifting ~1~ by ~n~ bits to the left. ~size~ is the total number of bits of the bit string. - + #+begin_src ocaml :tangle (eval mli) val shift_left_one : int -> int -> t #+end_src - - #+begin_src ocaml :tangle (eval ml) + + #+begin_src ocaml :tangle (eval ml) :exports none let shift_left_one = function | n when n < 64 -> fun i -> One (One.shift_left_one i) | _ -> fun i -> Many (Many.shift_left_one i) #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none Alcotest.(check bool) "shift_left_one1" true (of_int (1 lsl 3) = shift_left_one 4 3); Alcotest.(check bool) "shift_left_one2" true (of_z (Z.shift_left Z.one 200) = shift_left_one 300 200); #+end_src @@ -284,18 +282,18 @@ let shift_left_one = function ~testbit t n~ is true if the ~n~-th bit of the bit string ~t~ is set to ~1~. - + #+begin_src ocaml :tangle (eval mli) val testbit : t -> int -> bool #+end_src - - #+begin_src ocaml :tangle (eval ml) + + #+begin_src ocaml :tangle (eval ml) :exports none let testbit = function | One x -> One.testbit x | Many x -> Many.testbit x #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none Alcotest.(check bool) "testbit1" true (testbit (of_int 8) 3); Alcotest.(check bool) "testbit2" false (testbit (of_int 8) 2); Alcotest.(check bool) "testbit3" false (testbit (of_int 8) 4); @@ -312,15 +310,15 @@ let testbit = function val logor : t -> t -> t #+end_src - #+begin_src ocaml :tangle (eval ml) -let logor a b = + #+begin_src ocaml :tangle (eval ml) :exports none +let logor a b = match a,b with | One a, One b -> One (One.logor a b) | Many a, Many b -> Many (Many.logor a b) | _ -> invalid_arg "Bitstring.logor" #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none Alcotest.(check bool) "logor1" true (of_int (1 lor 2) = logor (of_int 1) (of_int 2)); Alcotest.(check bool) "logor2" true (of_z (Z.of_int (1 lor 2)) = logor (of_z Z.one) (of_z (Z.of_int 2))); #+end_src @@ -333,8 +331,8 @@ let logor a b = val logxor : t -> t -> t #+end_src - #+begin_src ocaml :tangle (eval ml) -let logxor a b = + #+begin_src ocaml :tangle (eval ml) :exports none +let logxor a b = match a,b with | One a, One b -> One (One.logxor a b) | Many a, Many b -> Many (Many.logxor a b) @@ -342,7 +340,7 @@ let logxor a b = #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none Alcotest.(check bool) "logxor1" true (of_int (1 lxor 2) = logxor (of_int 1) (of_int 2)); Alcotest.(check bool) "logxor2" true (of_z (Z.of_int (1 lxor 2)) = logxor (of_z Z.one) (of_z (Z.of_int 2))); #+end_src @@ -355,8 +353,8 @@ let logxor a b = val logand : t -> t -> t #+end_src - #+begin_src ocaml :tangle (eval ml) -let logand a b = + #+begin_src ocaml :tangle (eval ml) :exports none +let logand a b = match a,b with | One a, One b -> One (One.logand a b) | Many a, Many b -> Many (Many.logand a b) @@ -364,7 +362,7 @@ let logand a b = #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none Alcotest.(check bool) "logand1" true (of_int (1 land 3) = logand (of_int 1) (of_int 3)); Alcotest.(check bool) "logand2" true (of_z (Z.of_int (1 land 3)) = logand (of_z Z.one) (of_z (Z.of_int 3))); #+end_src @@ -374,10 +372,10 @@ let logand a b = Bitwise logical negation. #+begin_src ocaml :tangle (eval mli) -val lognot : t -> t +val lognot : t -> t #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let lognot = function | One x -> One (One.lognot x) | Many x -> Many (Many.lognot x) @@ -395,7 +393,7 @@ minus_one (of_int 10) = of_int 9 val minus_one : t -> t #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let minus_one = function | One x -> One (One.minus_one x) | Many x -> Many (Many.minus_one x) @@ -413,7 +411,7 @@ plus_one (of_int 10) = of_int 11 val plus_one : t -> t #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let plus_one = function | One x -> One (One.plus_one x) | Many x -> Many (Many.plus_one x) @@ -422,12 +420,12 @@ let plus_one = function *** ~trailing_zeros~ Returns the number of trailing zeros in the bit string. - + #+begin_src ocaml :tangle (eval mli) val trailing_zeros : t -> int #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let trailing_zeros = function | One x -> One.trailing_zeros x | Many x -> Many.trailing_zeros x @@ -437,12 +435,12 @@ let trailing_zeros = function Returns the Hamming distance, i.e. the number of bits differing between two bit strings. - + #+begin_src ocaml :tangle (eval mli) val hamdist : t -> t -> int #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let hamdist a b = match a, b with | One a, One b -> One.hamdist a b | Many a, Many b -> Many.hamdist a b @@ -452,33 +450,33 @@ let hamdist a b = match a, b with *** ~popcount~ Returns the number of bits set to one in the bit string. - + #+begin_src ocaml :tangle (eval mli) val popcount : t -> int #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let popcount = function | One x -> One.popcount x | Many x -> Many.popcount x #+end_src - + *** ~to_list~ Converts a bit string into a list of integers indicating the positions where the bits are set to ~1~. The first value for the position is not ~0~ but ~1~. - + #+begin_example Bitstring.to_list (of_int 5);; - : int list = [1; 3] #+end_example #+begin_src ocaml :tangle (eval mli) -val to_list : ?accu:(int list) -> t -> int list +val to_list : ?accu:(int list) -> t -> int list #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let rec to_list ?(accu=[]) = function | t when (is_zero t) -> List.rev accu | t -> let newlist = @@ -488,7 +486,7 @@ let rec to_list ?(accu=[]) = function |> (to_list [@tailcall]) ~accu:newlist #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none Alcotest.(check bool) "to_list" true ([ 1 ; 3 ; 4 ; 6 ] = (to_list (of_int 45))); #+end_src @@ -497,7 +495,7 @@ let rec to_list ?(accu=[]) = function ~permutations m n~ generates the list of all possible ~n~-bit strings with ~m~ bits set to ~1~. Algorithm adapted from [[https://graphics.stanford.edu/~seander/bithacks.html#NextBitPermutation][Bit twiddling hacks]]. - + #+begin_example Bitstring.permutations 2 4 |> List.map (fun x -> Format.asprintf "%a" Bitstring.pp x) ;; @@ -509,13 +507,13 @@ Bitstring.permutations 2 4 "-+-+------------------------------------------------------------"; "--++------------------------------------------------------------"] #+end_example - + #+begin_src ocaml :tangle (eval mli) val permutations : int -> int -> t list #+end_src - #+begin_src ocaml :tangle (eval ml) -let permutations m n = + #+begin_src ocaml :tangle (eval ml) :exports none +let permutations m n = let rec aux k u rest = if k=1 then @@ -534,7 +532,7 @@ let permutations m n = aux (Util.binom n m) (minus_one (shift_left_one n m)) [] #+end_src - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none check "permutations" (permutations 2 4 = List.map of_int [ 3 ; 5 ; 6 ; 9 ; 10 ; 12 ]); @@ -542,25 +540,22 @@ check "permutations" ** Printers - Printers can print as a string (~pp_string~) or as an integer (~pp_int~). - #+begin_src ocaml :tangle (eval mli) val pp : Format.formatter -> t -> unit #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let pp ppf = function | One x -> One.pp ppf x | Many x -> Many.pp ppf x #+end_src -** Tests +** Tests :noexport: - #+begin_src ocaml :tangle (eval test-ml) + #+begin_src ocaml :tangle (eval test-ml) :exports none () - + let tests = [ "all", `Quick, test_all; ] #+end_src - diff --git a/common/charge.org b/common/charge.org index a4fee91..555606f 100644 --- a/common/charge.org +++ b/common/charge.org @@ -1,4 +1,4 @@ -#+begin_src elisp tangle: no :results none +#+begin_src elisp tangle: no :results none :exports none (setq pwd (file-name-directory buffer-file-name)) (setq name (file-name-nondirectory (substring buffer-file-name 0 -4))) (setq lib (concat pwd "lib/")) @@ -23,7 +23,7 @@ type t #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none type t = float #+end_src @@ -36,7 +36,7 @@ val of_float : float -> t val to_float : t -> float #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none external of_float : float -> t = "%identity" external to_float : t -> float = "%identity" #+end_src @@ -48,7 +48,7 @@ val of_int : int -> t val to_int : t -> int #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let of_int = float_of_int let to_int = int_of_float #+end_src @@ -60,7 +60,7 @@ val of_string: string -> t val to_string: t -> string #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let of_string = float_of_string let to_string x = @@ -81,7 +81,7 @@ val ( * ) : t -> float -> t val ( / ) : t -> float -> t #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let gen_op op = fun a b -> op (to_float a) (to_float b) @@ -99,7 +99,7 @@ let ( / ) = gen_op ( /. ) val pp : Format.formatter -> t -> unit #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let pp ppf x = Format.fprintf ppf "@[+%s@]" (to_string x) #+end_src diff --git a/common/command_line.org b/common/command_line.org index 5564026..3438eb4 100644 --- a/common/command_line.org +++ b/common/command_line.org @@ -1,4 +1,4 @@ -#+begin_src elisp tangle: no :results none +#+begin_src elisp tangle: no :results none :exports none (setq pwd (file-name-directory buffer-file-name)) (setq name (file-name-nondirectory (substring buffer-file-name 0 -4))) (setq lib (concat pwd "lib/")) @@ -7,7 +7,7 @@ (setq ml (concat lib name ".ml")) (setq test-ml (concat testdir name ".ml")) (org-babel-tangle) -#+end_src +#+end_src * Command line :PROPERTIES: @@ -32,14 +32,14 @@ begin { short='b' ; long="basis" ; opt=Mandatory; arg=With_arg ""; doc="Name of the file containing the basis set"; } ; - + { short='m' ; long="multiplicity" ; opt=Optional; arg=With_arg ""; doc="Spin multiplicity (2S+1). Default is singlet"; } ; ] end; #+end_src - + Then, define what to do with the arguments: #+begin_src ocaml :tangle no let c = @@ -58,7 +58,7 @@ let multiplicity = | Some n -> int_of_string n in #+end_src - + ** Type - Short option: in the command line, a dash with a single character @@ -70,12 +70,12 @@ in - Some options require an argument (~ls --ignore="*.ml"~ ), some don't (~ls -l~) and for some arguments the argument is optional (~git --log[=]~) - + #+NAME:type #+begin_src ocaml :tangle (eval mli) type short_opt = char -type long_opt = string -type optional = Mandatory | Optional +type long_opt = string +type optional = Mandatory | Optional type documentation = string type argument = With_arg of string | Without_arg | With_opt_arg of string @@ -89,7 +89,7 @@ type description = { #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none <> #+end_src @@ -98,13 +98,13 @@ type description = { All the options are stored in the hash table ~dict~ where the key is the long option and the value is a value of type ~description~. - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let header_doc = ref "" let description_doc = ref "" let footer_doc = ref "" let anon_args_ref = ref [] let specs = ref [] -let dict = Hashtbl.create 67 +let dict = Hashtbl.create 67 #+end_src Functions to set the header, footer and main description of the @@ -115,28 +115,28 @@ val set_header_doc : string -> unit val set_description_doc : string -> unit val set_footer_doc : string -> unit #+end_src - - #+begin_src ocaml :tangle (eval ml) + + #+begin_src ocaml :tangle (eval ml) :exports none let set_header_doc s = header_doc := s let set_description_doc s = description_doc := s let set_footer_doc s = footer_doc := s #+end_src - + Function to create an anonymous argument: #+begin_src ocaml :tangle (eval mli) val anonymous : long_opt -> optional -> documentation -> description #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let anonymous name opt doc = { short=' ' ; long=name; opt; doc; arg=Without_arg; } #+end_src -** Text formatting functions +** Text formatting functions :noexport: Function to print some text such that it fits on the screen - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let output_text t = Format.printf "@["; begin @@ -147,7 +147,7 @@ let output_text t = |> List.iter (fun y -> Format.printf "@[%s@]@ " y) ; Format.printf "@]" | t -> - List.iter (fun x -> + List.iter (fun x -> Format.printf "@["; Str.split (Str.regexp " ") x |> List.iter (fun y -> Format.printf "@[%s@]@ " y) ; @@ -156,7 +156,7 @@ let output_text t = end; Format.printf "@]" #+end_src - + Function to build the short description of the command-line arguments, such as @@ -164,7 +164,7 @@ let output_text t = my_program -b [-h] [-u ] -x [--] #+end_example - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let output_short x = match x.short, x.opt, x.arg with | ' ', Mandatory, _ -> Format.printf "@[%s@]" x.long @@ -176,16 +176,16 @@ let output_short x = | _ , Mandatory, With_opt_arg arg -> Format.printf "@[-%c [%s]@]" x.short arg | _ , Optional , With_opt_arg arg -> Format.printf "@[[-%c [%s]]@]" x.short arg #+end_src - + Function to build the long description of the command-line arguments, such as #+begin_example -x --xyz= Name of the file containing the nuclear - coordinates in xyz format + coordinates in xyz format #+end_example - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let output_long max_width x = let arg = match x.short, x.arg with @@ -209,7 +209,7 @@ let output_long max_width x = #+end_src ** Query functions - + *** ~anon_args~ Returns the list of anonymous arguments @@ -218,7 +218,7 @@ let output_long max_width x = val anon_args : unit -> string list #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let anon_args () = !anon_args_ref #+end_src @@ -226,7 +226,7 @@ let anon_args () = !anon_args_ref Prints the documentation of the program. - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let help () = (* Print the header *) @@ -246,7 +246,7 @@ let help () = (* Find column lengths *) let max_width = - List.map (fun x -> + List.map (fun x -> ( match x.arg with | Without_arg -> String.length x.long | With_arg arg -> String.length x.long + String.length arg @@ -302,7 +302,7 @@ let help () = val get : long_opt -> string option #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let get x = try Some (Hashtbl.find dict x) with Not_found -> None @@ -316,10 +316,10 @@ let get x = val get_bool : long_opt -> bool #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let get_bool x = Hashtbl.mem dict x #+end_src - + ** Specification Gives the specifications of the current program as a list of @@ -329,7 +329,7 @@ let get_bool x = Hashtbl.mem dict x val set_specs : description list -> unit #+end_src - #+begin_src ocaml :tangle (eval ml) + #+begin_src ocaml :tangle (eval ml) :exports none let set_specs specs_in = specs := { short = 'h' ; long = "help" ; @@ -359,7 +359,7 @@ let set_specs specs_in = (* Check that all mandatory arguments are set *) List.filter (fun x -> x.short <> ' ' && x.opt = Mandatory) !specs - |> List.iter (fun x -> + |> List.iter (fun x -> match get x.long with | Some _ -> () | None -> failwith ("Error: --"^x.long^" option is missing.") diff --git a/common/lib/bitstring.ml b/common/lib/bitstring.ml index 40720b6..929c985 100644 --- a/common/lib/bitstring.ml +++ b/common/lib/bitstring.ml @@ -1,4 +1,4 @@ -(* Single-integer implementation *) +(* Single-integer implementation :noexport: *) (* [[file:../bitstring.org::*Single-integer implementation][Single-integer implementation:1]] *) @@ -13,9 +13,9 @@ module One = struct let shift_left x i = x lsl i let shift_right x i = x lsr i let shift_left_one i = 1 lsl i - let testbit x i = ( (x lsr i) land 1 ) = 1 + let testbit x i = ( (x lsr i) land 1 ) = 1 let logor a b = a lor b - let neg a = - a + let neg a = - a let logxor a b = a lxor b let logand a b = a land b let lognot a = lnot a @@ -24,23 +24,23 @@ module One = struct let popcount = function | 0 -> 0 - | r -> Util.popcnt (Int64.of_int r) + | r -> Util.popcnt (Int64.of_int r) - let trailing_zeros r = - Util.trailz (Int64.of_int r) + let trailing_zeros r = + Util.trailz (Int64.of_int r) let hamdist a b = a lxor b - |> popcount + |> popcount - let pp ppf s = - Format.fprintf ppf "@[@[%a@]@]" (Util.pp_bitstring 64) + let pp ppf s = + Format.fprintf ppf "@[@[%a@]@]" (Util.pp_bitstring 64) (Z.of_int s) end (* Single-integer implementation:1 ends here *) -(* Zarith implementation *) +(* Zarith implementation :noexport: *) (* [[file:../bitstring.org::*Zarith implementation][Zarith implementation:1]] *) @@ -49,7 +49,7 @@ module Many = struct let of_z x = x let zero = Z.zero let is_zero x = x = Z.zero - let shift_left = Z.shift_left + let shift_left = Z.shift_left let shift_right = Z.shift_right let shift_left_one i = Z.shift_left Z.one i let testbit = Z.testbit @@ -64,10 +64,10 @@ module Many = struct let hamdist = Z.hamdist let numbits i = max (Z.numbits i) 64 - let popcount z = + let popcount z = if z = Z.zero then 0 else Z.popcount z - let pp ppf s = + let pp ppf s = Format.fprintf ppf "@[@[%a@]@]" (Util.pp_bitstring (Z.numbits s)) s end @@ -138,7 +138,7 @@ let testbit = function (* ~testbit~:2 ends here *) (* [[file:../bitstring.org::*~logor~][~logor~:2]] *) -let logor a b = +let logor a b = match a,b with | One a, One b -> One (One.logor a b) | Many a, Many b -> Many (Many.logor a b) @@ -146,7 +146,7 @@ let logor a b = (* ~logor~:2 ends here *) (* [[file:../bitstring.org::*~logxor~][~logxor~:2]] *) -let logxor a b = +let logxor a b = match a,b with | One a, One b -> One (One.logxor a b) | Many a, Many b -> Many (Many.logxor a b) @@ -154,7 +154,7 @@ let logxor a b = (* ~logxor~:2 ends here *) (* [[file:../bitstring.org::*~logand~][~logand~:2]] *) -let logand a b = +let logand a b = match a,b with | One a, One b -> One (One.logand a b) | Many a, Many b -> Many (Many.logand a b) @@ -209,7 +209,7 @@ let rec to_list ?(accu=[]) = function (* ~to_list~:2 ends here *) (* [[file:../bitstring.org::*~permutations~][~permutations~:2]] *) -let permutations m n = +let permutations m n = let rec aux k u rest = if k=1 then diff --git a/common/lib/bitstring.mli b/common/lib/bitstring.mli index f4f238d..9d7708b 100644 --- a/common/lib/bitstring.mli +++ b/common/lib/bitstring.mli @@ -6,7 +6,7 @@ type t (* Type:1 ends here *) (* ~of_int~ - * + * * Creates a bit string from an ~int~. *) @@ -15,7 +15,7 @@ val of_int : int -> t (* ~of_int~:1 ends here *) (* ~of_z~ - * + * * Creates a bit string from an ~Z.t~ multi-precision integer. *) @@ -26,7 +26,7 @@ val of_z : Z.t -> t (* ~zero~ * * ~zero n~ creates a zero bit string with ~n~ bits. *) - + (* [[file:../bitstring.org::*~zero~][~zero~:1]] *) val zero : int -> t @@ -35,7 +35,7 @@ val zero : int -> t (* ~numbits~ * * Returns the number of bits used to represent the bit string. *) - + (* [[file:../bitstring.org::*~numbits~][~numbits~:1]] *) val numbits : t -> int @@ -44,7 +44,7 @@ val numbits : t -> int (* ~is_zero~ * * True if all the bits of the bit string are zero. *) - + (* [[file:../bitstring.org::*~is_zero~][~is_zero~:1]] *) val is_zero : t -> bool @@ -67,7 +67,7 @@ val neg : t -> t * * ~shift_left t n~ returns a new bit strings with all the bits * shifted ~n~ positions to the left. *) - + (* [[file:../bitstring.org::*~shift_left~][~shift_left~:1]] *) val shift_left : t -> int -> t @@ -77,7 +77,7 @@ val shift_left : t -> int -> t * * ~shift_right t n~ returns a new bit strings with all the bits * shifted ~n~ positions to the right. *) - + (* [[file:../bitstring.org::*~shift_right~][~shift_right~:1]] *) val shift_right : t -> int -> t @@ -89,7 +89,7 @@ val shift_right : t -> int -> t * bit set to one. * It is equivalent as shifting ~1~ by ~n~ bits to the left. * ~size~ is the total number of bits of the bit string. *) - + (* [[file:../bitstring.org::*~shift_left_one~][~shift_left_one~:1]] *) val shift_left_one : int -> int -> t @@ -99,7 +99,7 @@ val shift_left_one : int -> int -> t * * ~testbit t n~ is true if the ~n~-th bit of the bit string ~t~ is * set to ~1~. *) - + (* [[file:../bitstring.org::*~testbit~][~testbit~:1]] *) val testbit : t -> int -> bool @@ -170,7 +170,7 @@ val plus_one : t -> t (* ~trailing_zeros~ * * Returns the number of trailing zeros in the bit string. *) - + (* [[file:../bitstring.org::*~trailing_zeros~][~trailing_zeros~:1]] *) val trailing_zeros : t -> int @@ -180,7 +180,7 @@ val trailing_zeros : t -> int * * Returns the Hamming distance, i.e. the number of bits differing * between two bit strings. *) - + (* [[file:../bitstring.org::*~hamdist~][~hamdist~:1]] *) val hamdist : t -> t -> int @@ -189,7 +189,7 @@ val hamdist : t -> t -> int (* ~popcount~ * * Returns the number of bits set to one in the bit string. *) - + (* [[file:../bitstring.org::*~popcount~][~popcount~:1]] *) val popcount : t -> int @@ -200,7 +200,7 @@ val popcount : t -> int * Converts a bit string into a list of integers indicating the * positions where the bits are set to ~1~. The first value for the * position is not ~0~ but ~1~. - * + * * #+begin_example * Bitstring.to_list (of_int 5);; * - : int list = [1; 3] @@ -216,7 +216,7 @@ val to_list : ?accu:(int list) -> t -> int list * ~permutations m n~ generates the list of all possible ~n~-bit * strings with ~m~ bits set to ~1~. * Algorithm adapted from [[https://graphics.stanford.edu/~seander/bithacks.html#NextBitPermutation][Bit twiddling hacks]]. - * + * * #+begin_example * Bitstring.permutations 2 4 * |> List.map (fun x -> Format.asprintf "%a" Bitstring.pp x) ;; @@ -228,15 +228,13 @@ val to_list : ?accu:(int list) -> t -> int list * "-+-+------------------------------------------------------------"; * "--++------------------------------------------------------------"] * #+end_example *) - + (* [[file:../bitstring.org::*~permutations~][~permutations~:1]] *) val permutations : int -> int -> t list (* ~permutations~:1 ends here *) -(* Printers - * - * Printers can print as a string (~pp_string~) or as an integer (~pp_int~). *) +(* Printers *) (* [[file:../bitstring.org::*Printers][Printers:1]] *) diff --git a/common/lib/command_line.ml b/common/lib/command_line.ml index 72c629f..a031cfe 100644 --- a/common/lib/command_line.ml +++ b/common/lib/command_line.ml @@ -1,7 +1,7 @@ (* [[file:../command_line.org::*Type][Type:2]] *) type short_opt = char -type long_opt = string -type optional = Mandatory | Optional +type long_opt = string +type optional = Mandatory | Optional type documentation = string type argument = With_arg of string | Without_arg | With_opt_arg of string @@ -55,7 +55,7 @@ let output_text t = |> List.iter (fun y -> Format.printf "@[%s@]@ " y) ; Format.printf "@]" | t -> - List.iter (fun x -> + List.iter (fun x -> Format.printf "@["; Str.split (Str.regexp " ") x |> List.iter (fun y -> Format.printf "@[%s@]@ " y) ; @@ -66,7 +66,7 @@ let output_text t = (* Text formatting functions:1 ends here *) - + (* Function to build the short description of the command-line * arguments, such as @@ -95,7 +95,7 @@ let output_short x = * arguments, such as * #+begin_example * -x --xyz= Name of the file containing the nuclear - * coordinates in xyz format + * coordinates in xyz format * #+end_example *) @@ -151,7 +151,7 @@ let help () = (* Find column lengths *) let max_width = - List.map (fun x -> + List.map (fun x -> ( match x.arg with | Without_arg -> String.length x.long | With_arg arg -> String.length x.long + String.length arg @@ -239,7 +239,7 @@ let set_specs specs_in = (* Check that all mandatory arguments are set *) List.filter (fun x -> x.short <> ' ' && x.opt = Mandatory) !specs - |> List.iter (fun x -> + |> List.iter (fun x -> match get x.long with | Some _ -> () | None -> failwith ("Error: --"^x.long^" option is missing.") diff --git a/common/lib/command_line.mli b/common/lib/command_line.mli index 626a66d..09058bb 100644 --- a/common/lib/command_line.mli +++ b/common/lib/command_line.mli @@ -9,13 +9,13 @@ * - Some options require an argument (~ls --ignore="*.ml"~ ), some * don't (~ls -l~) and for some arguments the argument is optional * (~git --log[=]~) - * + * * #+NAME:type *) (* [[file:../command_line.org::type][type]] *) type short_opt = char -type long_opt = string -type optional = Mandatory | Optional +type long_opt = string +type optional = Mandatory | Optional type documentation = string type argument = With_arg of string | Without_arg | With_opt_arg of string diff --git a/common/test/bitstring.ml b/common/test/bitstring.ml index f2d70b0..39b2931 100644 --- a/common/test/bitstring.ml +++ b/common/test/bitstring.ml @@ -1,4 +1,4 @@ -(* Tests header *) +(* Tests header :noexport: *) (* [[file:../bitstring.org::*Tests header][Tests header:1]] *) @@ -69,12 +69,12 @@ check "permutations" [ 3 ; 5 ; 6 ; 9 ; 10 ; 12 ]); (* ~permutations~:3 ends here *) -(* Tests *) +(* Tests :noexport: *) (* [[file:../bitstring.org::*Tests][Tests:1]] *) () - + let tests = [ "all", `Quick, test_all; ] diff --git a/docs/config.el b/docs/config.el new file mode 100755 index 0000000..84c9a19 --- /dev/null +++ b/docs/config.el @@ -0,0 +1,74 @@ +;; Thanks to Tobias's answer on Emacs Stack Exchange: +;; https://emacs.stackexchange.com/questions/38437/org-mode-batch-export-missing-syntax-highlighting + +(package-initialize) +(require 'htmlize) +(require 'font-lock) +(require 'subr-x) ;; for `when-let' + +(unless (boundp 'maximal-integer) + (defconst maximal-integer (lsh -1 -1) + "Maximal integer value representable natively in emacs lisp.")) + +(defun face-spec-default (spec) + "Get list containing at most the default entry of face SPEC. +Return nil if SPEC has no default entry." + (let* ((first (car-safe spec)) + (display (car-safe first))) + (when (eq display 'default) + (list (car-safe spec))))) + +(defun face-spec-min-color (display-atts) + "Get min-color entry of DISPLAY-ATTS pair from face spec." + (let* ((display (car-safe display-atts))) + (or (car-safe (cdr (assoc 'min-colors display))) + maximal-integer))) + +(defun face-spec-highest-color (spec) + "Search face SPEC for highest color. +That means the DISPLAY entry of SPEC +with class 'color and highest min-color value." + (let ((color-list (cl-remove-if-not + (lambda (display-atts) + (when-let ((display (car-safe display-atts)) + (class (and (listp display) + (assoc 'class display))) + (background (assoc 'background display))) + (and (member 'light (cdr background)) + (member 'color (cdr class))))) + spec))) + (cl-reduce (lambda (display-atts1 display-atts2) + (if (> (face-spec-min-color display-atts1) + (face-spec-min-color display-atts2)) + display-atts1 + display-atts2)) + (cdr color-list) + :initial-value (car color-list)))) + +(defun face-spec-t (spec) + "Search face SPEC for fall back." + (cl-find-if (lambda (display-atts) + (eq (car-safe display-atts) t)) + spec)) + +(defun my-face-attribute (face attribute &optional frame inherit) + "Get FACE ATTRIBUTE from `face-user-default-spec' and not from `face-attribute'." + (let* ((face-spec (face-user-default-spec face)) + (display-attr (or (face-spec-highest-color face-spec) + (face-spec-t face-spec))) + (attr (cdr display-attr)) + (val (or (plist-get attr attribute) (car-safe (cdr (assoc attribute attr)))))) + ;; (message "attribute: %S" attribute) ;; for debugging + (when (and (null (eq attribute :inherit)) + (null val)) + (let ((inherited-face (my-face-attribute face :inherit))) + (when (and inherited-face + (null (eq inherited-face 'unspecified))) + (setq val (my-face-attribute inherited-face attribute))))) + (or val 'unspecified))) + +(advice-add 'face-attribute :override #'my-face-attribute) + +(setq ml "ml") +(setq mli "mli") +(setq test-ml "test-ml") diff --git a/docs/htmlize.el b/docs/htmlize.el new file mode 100644 index 0000000..f5c6d8a --- /dev/null +++ b/docs/htmlize.el @@ -0,0 +1,1882 @@ +;;; htmlize.el --- Convert buffer text and decorations to HTML. -*- lexical-binding: t -*- + +;; Copyright (C) 1997-2003,2005,2006,2009,2011,2012,2014,2017,2018 Hrvoje Niksic + +;; Author: Hrvoje Niksic +;; Homepage: https://github.com/hniksic/emacs-htmlize +;; Keywords: hypermedia, extensions +;; Version: 1.56 + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation; either version 2, or (at your option) +;; any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program; see the file COPYING. If not, write to the +;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, +;; Boston, MA 02111-1307, USA. + +;;; Commentary: + +;; This package converts the buffer text and the associated +;; decorations to HTML. Mail to to discuss +;; features and additions. All suggestions are more than welcome. + +;; To use it, just switch to the buffer you want HTML-ized and type +;; `M-x htmlize-buffer'. You will be switched to a new buffer that +;; contains the resulting HTML code. You can edit and inspect this +;; buffer, or you can just save it with C-x C-w. `M-x htmlize-file' +;; will find a file, fontify it, and save the HTML version in +;; FILE.html, without any additional intervention. `M-x +;; htmlize-many-files' allows you to htmlize any number of files in +;; the same manner. `M-x htmlize-many-files-dired' does the same for +;; files marked in a dired buffer. + +;; htmlize supports three types of HTML output, selected by setting +;; `htmlize-output-type': `css', `inline-css', and `font'. In `css' +;; mode, htmlize uses cascading style sheets to specify colors; it +;; generates classes that correspond to Emacs faces and uses ... to color parts of text. In this mode, the +;; produced HTML is valid under the 4.01 strict DTD, as confirmed by +;; the W3C validator. `inline-css' is like `css', except the CSS is +;; put directly in the STYLE attribute of the SPAN element, making it +;; possible to paste the generated HTML into existing HTML documents. +;; In `font' mode, htmlize uses ... to +;; colorize HTML, which is not standard-compliant, but works better in +;; older browsers. `css' mode is the default. + +;; You can also use htmlize from your Emacs Lisp code. When called +;; non-interactively, `htmlize-buffer' and `htmlize-region' will +;; return the resulting HTML buffer, but will not change current +;; buffer or move the point. htmlize will do its best to work on +;; non-windowing Emacs sessions but the result will be limited to +;; colors supported by the terminal. + +;; htmlize aims for compatibility with older Emacs versions. Please +;; let me know if it doesn't work on the version of GNU Emacs that you +;; are using. The package relies on the presence of CL extensions; +;; please don't try to remove that dependency. I see no practical +;; problems with using the full power of the CL extensions, except +;; that one might learn to like them too much. + +;; The latest version is available at: +;; +;; +;; +;; + +;; Thanks go to the many people who have sent reports and contributed +;; comments, suggestions, and fixes. They include Ron Gut, Bob +;; Weiner, Toni Drabik, Peter Breton, Ville Skytta, Thomas Vogels, +;; Juri Linkov, Maciek Pasternacki, and many others. + +;; User quotes: "You sir, are a sick, sick, _sick_ person. :)" +;; -- Bill Perry, author of Emacs/W3 + + +;;; Code: + +(require 'cl-lib) +(eval-when-compile + (defvar font-lock-auto-fontify) + (defvar font-lock-support-mode) + (defvar global-font-lock-mode)) + +(defconst htmlize-version "1.56") + +(defgroup htmlize nil + "Convert buffer text and faces to HTML." + :group 'hypermedia) + +(defcustom htmlize-head-tags "" + "Additional tags to insert within HEAD of the generated document." + :type 'string + :group 'htmlize) + +(defcustom htmlize-output-type 'css + "Output type of generated HTML, one of `css', `inline-css', or `font'. +When set to `css' (the default), htmlize will generate a style sheet +with description of faces, and use it in the HTML document, specifying +the faces in the actual text with . + +When set to `inline-css', the style will be generated as above, but +placed directly in the STYLE attribute of the span ELEMENT: . This makes it easier to paste the resulting HTML to +other documents. + +When set to `font', the properties will be set using layout tags +, , , , and . + +`css' output is normally preferred, but `font' is still useful for +supporting old, pre-CSS browsers, and both `inline-css' and `font' for +easier embedding of colorized text in foreign HTML documents (no style +sheet to carry around)." + :type '(choice (const css) (const inline-css) (const font)) + :group 'htmlize) + +(defcustom htmlize-use-images t + "Whether htmlize generates `img' for images attached to buffer contents." + :type 'boolean + :group 'htmlize) + +(defcustom htmlize-force-inline-images nil + "Non-nil means generate all images inline using data URLs. +Normally htmlize converts image descriptors with :file properties to +relative URIs, and those with :data properties to data URIs. With this +flag set, the images specified as a file name are loaded into memory and +embedded in the HTML as data URIs." + :type 'boolean + :group 'htmlize) + +(defcustom htmlize-max-alt-text 100 + "Maximum size of text to use as ALT text in images. + +Normally when htmlize encounters text covered by the `display' property +that specifies an image, it generates an `alt' attribute containing the +original text. If the text is larger than `htmlize-max-alt-text' characters, +this will not be done." + :type 'integer + :group 'htmlize) + +(defcustom htmlize-transform-image 'htmlize-default-transform-image + "Function called to modify the image descriptor. + +The function is called with the image descriptor found in the buffer and +the text the image is supposed to replace. It should return a (possibly +different) image descriptor property list or a replacement string to use +instead of of the original buffer text. + +Returning nil is the same as returning the original text." + :type 'boolean + :group 'htmlize) + +(defcustom htmlize-generate-hyperlinks t + "Non-nil means auto-generate the links from URLs and mail addresses in buffer. + +This is on by default; set it to nil if you don't want htmlize to +autogenerate such links. Note that this option only turns off automatic +search for contents that looks like URLs and converting them to links. +It has no effect on whether htmlize respects the `htmlize-link' property." + :type 'boolean + :group 'htmlize) + +(defcustom htmlize-hyperlink-style " + a { + color: inherit; + background-color: inherit; + font: inherit; + text-decoration: inherit; + } + a:hover { + text-decoration: underline; + } +" + "The CSS style used for hyperlinks when in CSS mode." + :type 'string + :group 'htmlize) + +(defcustom htmlize-replace-form-feeds t + "Non-nil means replace form feeds in source code with HTML separators. +Form feeds are the ^L characters at line beginnings that are sometimes +used to separate sections of source code. If this variable is set to +`t', form feed characters are replaced with the
separator. If this +is a string, it specifies the replacement to use. Note that 
 is
+temporarily closed before the separator is inserted, so the default
+replacement is effectively \"
\".  If you specify
+another replacement, don't forget to close and reopen the 
 if you
+want the output to remain valid HTML.
+
+If you need more elaborate processing, set this to nil and use
+htmlize-after-hook."
+  :type 'boolean
+  :group 'htmlize)
+
+(defcustom htmlize-html-charset nil
+  "The charset declared by the resulting HTML documents.
+When non-nil, causes htmlize to insert the following in the HEAD section
+of the generated HTML:
+
+  
+
+where CHARSET is the value you've set for htmlize-html-charset.  Valid
+charsets are defined by MIME and include strings like \"iso-8859-1\",
+\"iso-8859-15\", \"utf-8\", etc.
+
+If you are using non-Latin-1 charsets, you might need to set this for
+your documents to render correctly.  Also, the W3C validator requires
+submitted HTML documents to declare a charset.  So if you care about
+validation, you can use this to prevent the validator from bitching.
+
+Needless to say, if you set this, you should actually make sure that
+the buffer is in the encoding you're claiming it is in.  (This is
+normally achieved by using the correct file coding system for the
+buffer.)  If you don't understand what that means, you should probably
+leave this option in its default setting."
+  :type '(choice (const :tag "Unset" nil)
+		 string)
+  :group 'htmlize)
+
+(defcustom htmlize-convert-nonascii-to-entities t
+  "Whether non-ASCII characters should be converted to HTML entities.
+
+When this is non-nil, characters with codes in the 128-255 range will be
+considered Latin 1 and rewritten as \"&#CODE;\".  Characters with codes
+above 255 will be converted to \"&#UCS;\", where UCS denotes the Unicode
+code point of the character.  If the code point cannot be determined,
+the character will be copied unchanged, as would be the case if the
+option were nil.
+
+When the option is nil, the non-ASCII characters are copied to HTML
+without modification.  In that case, the web server and/or the browser
+must be set to understand the encoding that was used when saving the
+buffer.  (You might also want to specify it by setting
+`htmlize-html-charset'.)
+
+Note that in an HTML entity \"&#CODE;\", CODE is always a UCS code point,
+which has nothing to do with the charset the page is in.  For example,
+\"©\" *always* refers to the copyright symbol, regardless of charset
+specified by the META tag or the charset sent by the HTTP server.  In
+other words, \"©\" is exactly equivalent to \"©\".
+
+For most people htmlize will work fine with this option left at the
+default setting; don't change it unless you know what you're doing."
+  :type 'sexp
+  :group 'htmlize)
+
+(defcustom htmlize-ignore-face-size 'absolute
+  "Whether face size should be ignored when generating HTML.
+If this is nil, face sizes are used.  If set to t, sizes are ignored
+If set to `absolute', only absolute size specifications are ignored.
+Please note that font sizes only work with CSS-based output types."
+  :type '(choice (const :tag "Don't ignore" nil)
+		 (const :tag "Ignore all" t)
+		 (const :tag "Ignore absolute" absolute))
+  :group 'htmlize)
+
+(defcustom htmlize-css-name-prefix ""
+  "The prefix used for CSS names.
+The CSS names that htmlize generates from face names are often too
+generic for CSS files; for example, `font-lock-type-face' is transformed
+to `type'.  Use this variable to add a prefix to the generated names.
+The string \"htmlize-\" is an example of a reasonable prefix."
+  :type 'string
+  :group 'htmlize)
+
+(defcustom htmlize-use-rgb-txt t
+  "Whether `rgb.txt' should be used to convert color names to RGB.
+
+This conversion means determining, for instance, that the color
+\"IndianRed\" corresponds to the (205, 92, 92) RGB triple.  `rgb.txt'
+is the X color database that maps hundreds of color names to such RGB
+triples.  When this variable is non-nil, `htmlize' uses `rgb.txt' to
+look up color names.
+
+If this variable is nil, htmlize queries Emacs for RGB components of
+colors using `color-instance-rgb-components' and `color-values'.
+This can yield incorrect results on non-true-color displays.
+
+If the `rgb.txt' file is not found (which will be the case if you're
+running Emacs on non-X11 systems), this option is ignored."
+  :type 'boolean
+  :group 'htmlize)
+
+(defvar htmlize-face-overrides nil
+  "Overrides for face definitions.
+
+Normally face definitions are taken from Emacs settings for fonts
+in the current frame.  For faces present in this plist, the
+definitions will be used instead.  Keys in the plist are symbols
+naming the face and values are the overriding definitions.  For
+example:
+
+  (setq htmlize-face-overrides
+        '(font-lock-warning-face \"black\"
+          font-lock-function-name-face \"red\"
+          font-lock-comment-face \"blue\"
+          default (:foreground \"dark-green\" :background \"yellow\")))
+
+This variable can be also be `let' bound when running `htmlize-buffer'.")
+
+(defcustom htmlize-untabify t
+  "Non-nil means untabify buffer contents during htmlization."
+  :type 'boolean
+  :group 'htmlize)
+
+(defcustom htmlize-html-major-mode nil
+  "The mode the newly created HTML buffer will be put in.
+Set this to nil if you prefer the default (fundamental) mode."
+  :type '(radio (const :tag "No mode (fundamental)" nil)
+		 (function-item html-mode)
+		 (function :tag "User-defined major mode"))
+  :group 'htmlize)
+
+(defcustom htmlize-pre-style nil
+  "When non-nil, `
' tags will be decorated with style
+information in `font' and `inline-css' modes. This allows a
+consistent background for captures of regions."
+  :type 'boolean
+  :group 'htmlize)
+
+(defvar htmlize-before-hook nil
+  "Hook run before htmlizing a buffer.
+The hook functions are run in the source buffer (not the resulting HTML
+buffer).")
+
+(defvar htmlize-after-hook nil
+  "Hook run after htmlizing a buffer.
+Unlike `htmlize-before-hook', these functions are run in the generated
+HTML buffer.  You may use them to modify the outlook of the final HTML
+output.")
+
+(defvar htmlize-file-hook nil
+  "Hook run by `htmlize-file' after htmlizing a file, but before saving it.")
+
+(defvar htmlize-buffer-places)
+
+;;; Some cross-Emacs compatibility.
+
+;; We need a function that efficiently finds the next change of a
+;; property regardless of whether the change occurred because of a
+;; text property or an extent/overlay.
+(defun htmlize-next-change (pos prop &optional limit)
+  (if prop
+      (next-single-char-property-change pos prop nil limit)
+    (next-char-property-change pos limit)))
+
+(defun htmlize-overlay-faces-at (pos)
+  (delq nil (mapcar (lambda (o) (overlay-get o 'face)) (overlays-at pos))))
+
+(defun htmlize-next-face-change (pos &optional limit)
+  ;; (htmlize-next-change pos 'face limit) would skip over entire
+  ;; overlays that specify the `face' property, even when they
+  ;; contain smaller text properties that also specify `face'.
+  ;; Emacs display engine merges those faces, and so must we.
+  (or limit
+      (setq limit (point-max)))
+  (let ((next-prop (next-single-property-change pos 'face nil limit))
+        (overlay-faces (htmlize-overlay-faces-at pos)))
+    (while (progn
+             (setq pos (next-overlay-change pos))
+             (and (< pos next-prop)
+                  (equal overlay-faces (htmlize-overlay-faces-at pos)))))
+    (setq pos (min pos next-prop))
+    ;; Additionally, we include the entire region that specifies the
+    ;; `display' property.
+    (when (get-char-property pos 'display)
+      (setq pos (next-single-char-property-change pos 'display nil limit)))
+    pos))
+
+(defmacro htmlize-lexlet (&rest letforms)
+  (declare (indent 1) (debug let))
+  (if (and (boundp 'lexical-binding)
+           lexical-binding)
+      `(let ,@letforms)
+    ;; cl extensions have a macro implementing lexical let
+    `(lexical-let ,@letforms)))
+
+
+;;; Transformation of buffer text: HTML escapes, untabification, etc.
+
+(defvar htmlize-basic-character-table
+  ;; Map characters in the 0-127 range to either one-character strings
+  ;; or to numeric entities.
+  (let ((table (make-vector 128 ?\0)))
+    ;; Map characters in the 32-126 range to themselves, others to
+    ;; &#CODE entities;
+    (dotimes (i 128)
+      (setf (aref table i) (if (and (>= i 32) (<= i 126))
+			       (char-to-string i)
+			     (format "&#%d;" i))))
+    ;; Set exceptions manually.
+    (setf
+     ;; Don't escape newline, carriage return, and TAB.
+     (aref table ?\n) "\n"
+     (aref table ?\r) "\r"
+     (aref table ?\t) "\t"
+     ;; Escape &, <, and >.
+     (aref table ?&) "&"
+     (aref table ?<) "<"
+     (aref table ?>) ">"
+     ;; Not escaping '"' buys us a measurable speedup.  It's only
+     ;; necessary to quote it for strings used in attribute values,
+     ;; which htmlize doesn't typically do.
+     ;(aref table ?\") """
+     )
+    table))
+
+;; A cache of HTML representation of non-ASCII characters.  Depending
+;; on the setting of `htmlize-convert-nonascii-to-entities', this maps
+;; non-ASCII characters to either "&#;" or "" (mapconcat's
+;; mapper must always return strings).  It's only filled as characters
+;; are encountered, so that in a buffer with e.g. French text, it will
+;; only ever contain French accented characters as keys.  It's cleared
+;; on each entry to htmlize-buffer-1 to allow modifications of
+;; `htmlize-convert-nonascii-to-entities' to take effect.
+(defvar htmlize-extended-character-cache (make-hash-table :test 'eq))
+
+(defun htmlize-protect-string (string)
+  "HTML-protect string, escaping HTML metacharacters and I18N chars."
+  ;; Only protecting strings that actually contain unsafe or non-ASCII
+  ;; chars removes a lot of unnecessary funcalls and consing.
+  (if (not (string-match "[^\r\n\t -%'-;=?-~]" string))
+      string
+    (mapconcat (lambda (char)
+		 (cond
+		  ((< char 128)
+		   ;; ASCII: use htmlize-basic-character-table.
+		   (aref htmlize-basic-character-table char))
+		  ((gethash char htmlize-extended-character-cache)
+		   ;; We've already seen this char; return the cached
+		   ;; string.
+		   )
+		  ((not htmlize-convert-nonascii-to-entities)
+		   ;; If conversion to entities is not desired, always
+		   ;; copy the char literally.
+		   (setf (gethash char htmlize-extended-character-cache)
+			 (char-to-string char)))
+		  ((< char 256)
+		   ;; Latin 1: no need to call encode-char.
+		   (setf (gethash char htmlize-extended-character-cache)
+			 (format "&#%d;" char)))
+		  ((encode-char char 'ucs)
+                   ;; Must check if encode-char works for CHAR;
+                   ;; it fails for Arabic and possibly elsewhere.
+		   (setf (gethash char htmlize-extended-character-cache)
+			 (format "&#%d;" (encode-char char 'ucs))))
+		  (t
+		   ;; encode-char doesn't work for this char.  Copy it
+		   ;; unchanged and hope for the best.
+		   (setf (gethash char htmlize-extended-character-cache)
+			 (char-to-string char)))))
+	       string "")))
+
+(defun htmlize-attr-escape (string)
+  ;; Like htmlize-protect-string, but also escapes double-quoted
+  ;; strings to make it usable in attribute values.
+  (setq string (htmlize-protect-string string))
+  (if (not (string-match "\"" string))
+      string
+    (mapconcat (lambda (char)
+                 (if (eql char ?\")
+                     """
+                   (char-to-string char)))
+               string "")))
+
+(defsubst htmlize-concat (list)
+  (if (and (consp list) (null (cdr list)))
+      ;; Don't create a new string in the common case where the list only
+      ;; consists of one element.
+      (car list)
+    (apply #'concat list)))
+
+(defun htmlize-format-link (linkprops text)
+  (let ((uri (if (stringp linkprops)
+                 linkprops
+               (plist-get linkprops :uri)))
+        (escaped-text (htmlize-protect-string text)))
+    (if uri
+        (format "%s" (htmlize-attr-escape uri) escaped-text)
+      escaped-text)))
+
+(defun htmlize-escape-or-link (string)
+  ;; Escape STRING and/or add hyperlinks.  STRING comes from a
+  ;; `display' property.
+  (let ((pos 0) (end (length string)) outlist)
+    (while (< pos end)
+      (let* ((link (get-char-property pos 'htmlize-link string))
+             (next-link-change (next-single-property-change
+                                pos 'htmlize-link string end))
+             (chunk (substring string pos next-link-change)))
+        (push
+         (cond (link
+                (htmlize-format-link link chunk))
+               ((get-char-property 0 'htmlize-literal chunk)
+                chunk)
+               (t
+                (htmlize-protect-string chunk)))
+         outlist)
+        (setq pos next-link-change)))
+    (htmlize-concat (nreverse outlist))))
+
+(defun htmlize-display-prop-to-html (display text)
+  (let (desc)
+    (cond ((stringp display)
+           ;; Emacs ignores recursive display properties.
+           (htmlize-escape-or-link display))
+          ((not (eq (car-safe display) 'image))
+           (htmlize-protect-string text))
+          ((null (setq desc (funcall htmlize-transform-image
+                                     (cdr display) text)))
+           (htmlize-escape-or-link text))
+          ((stringp desc)
+           (htmlize-escape-or-link desc))
+          (t
+           (htmlize-generate-image desc text)))))
+
+(defun htmlize-string-to-html (string)
+  ;; Convert the string to HTML, including images attached as
+  ;; `display' property and links as `htmlize-link' property.  In a
+  ;; string without images or links, this is equivalent to
+  ;; `htmlize-protect-string'.
+  (let ((pos 0) (end (length string)) outlist)
+    (while (< pos end)
+      (let* ((display (get-char-property pos 'display string))
+             (next-display-change (next-single-property-change
+                                   pos 'display string end))
+             (chunk (substring string pos next-display-change)))
+        (push
+         (if display
+             (htmlize-display-prop-to-html display chunk)
+           (htmlize-escape-or-link chunk))
+         outlist)
+        (setq pos next-display-change)))
+    (htmlize-concat (nreverse outlist))))
+
+(defun htmlize-default-transform-image (imgprops _text)
+  "Default transformation of image descriptor to something usable in HTML.
+
+If `htmlize-use-images' is nil, the function always returns nil, meaning
+use original text.  Otherwise, it tries to find the image for images that
+specify a file name.  If `htmlize-force-inline-images' is non-nil, it also
+converts the :file attribute to :data and returns the modified property
+list."
+  (when htmlize-use-images
+    (when (plist-get imgprops :file)
+      (let ((location (plist-get (cdr (find-image (list imgprops))) :file)))
+        (when location
+          (setq imgprops (plist-put (cl-copy-list imgprops) :file location)))))
+    (if htmlize-force-inline-images
+        (let ((location (plist-get imgprops :file))
+              data)
+          (when location
+            (with-temp-buffer
+              (condition-case nil
+                  (progn
+                    (insert-file-contents-literally location)
+                    (setq data (buffer-string)))
+                (error nil))))
+          ;; if successful, return the new plist, otherwise return
+          ;; nil, which will use the original text
+          (and data
+               (plist-put (plist-put imgprops :file nil)
+                          :data data)))
+      imgprops)))
+
+(defun htmlize-alt-text (_imgprops origtext)
+  (and (/= (length origtext) 0)
+       (<= (length origtext) htmlize-max-alt-text)
+       (not (string-match "[\0-\x1f]" origtext))
+       origtext))
+
+(defun htmlize-generate-image (imgprops origtext)
+  (let* ((alt-text (htmlize-alt-text imgprops origtext))
+         (alt-attr (if alt-text
+                       (format " alt=\"%s\"" (htmlize-attr-escape alt-text))
+                     "")))
+    (cond ((plist-get imgprops :file)
+           ;; Try to find the image in image-load-path
+           (let* ((found-props (cdr (find-image (list imgprops))))
+                  (file (or (plist-get found-props :file)
+                            (plist-get imgprops :file))))
+             (format ""
+                     (htmlize-attr-escape (file-relative-name file))
+                     alt-attr)))
+          ((plist-get imgprops :data)
+           (format ""
+                   (or (plist-get imgprops :type) "")
+                   (base64-encode-string (plist-get imgprops :data))
+                   alt-attr)))))
+
+(defconst htmlize-ellipsis "...")
+(put-text-property 0 (length htmlize-ellipsis) 'htmlize-ellipsis t htmlize-ellipsis)
+
+(defun htmlize-match-inv-spec (inv)
+  (cl-member inv buffer-invisibility-spec
+             :key (lambda (i)
+                    (if (symbolp i) i (car i)))))
+
+(defun htmlize-decode-invisibility-spec (invisible)
+  ;; Return t, nil, or `ellipsis', depending on how invisible text should be inserted.
+
+  (if (not (listp buffer-invisibility-spec))
+      ;; If buffer-invisibility-spec is not a list, then all
+      ;; characters with non-nil `invisible' property are visible.
+      (not invisible)
+
+    ;; Otherwise, the value of a non-nil `invisible' property can be:
+    ;; 1. a symbol -- make the text invisible if it matches
+    ;;    buffer-invisibility-spec.
+    ;; 2. a list of symbols -- make the text invisible if
+    ;;    any symbol in the list matches
+    ;;    buffer-invisibility-spec.
+    ;; If the match of buffer-invisibility-spec has a non-nil
+    ;; CDR, replace the invisible text with an ellipsis.
+    (let ((match (if (symbolp invisible)
+                     (htmlize-match-inv-spec invisible)
+                   (cl-some #'htmlize-match-inv-spec invisible))))
+      (cond ((null match) t)
+            ((cdr-safe (car match)) 'ellipsis)
+            (t nil)))))
+
+(defun htmlize-add-before-after-strings (beg end text)
+  ;; Find overlays specifying before-string and after-string in [beg,
+  ;; pos).  If any are found, splice them into TEXT and return the new
+  ;; text.
+  (let (additions)
+    (dolist (overlay (overlays-in beg end))
+      (let ((before (overlay-get overlay 'before-string))
+            (after (overlay-get overlay 'after-string)))
+        (when after
+          (push (cons (- (overlay-end overlay) beg)
+                      after)
+                additions))
+        (when before
+          (push (cons (- (overlay-start overlay) beg)
+                      before)
+                additions))))
+    (if additions
+        (let ((textlist nil)
+              (strpos 0))
+          (dolist (add (cl-stable-sort additions #'< :key #'car))
+            (let ((addpos (car add))
+                  (addtext (cdr add)))
+              (push (substring text strpos addpos) textlist)
+              (push addtext textlist)
+              (setq strpos addpos)))
+          (push (substring text strpos) textlist)
+          (apply #'concat (nreverse textlist)))
+      text)))
+
+(defun htmlize-copy-prop (prop beg end string)
+  ;; Copy the specified property from the specified region of the
+  ;; buffer to the target string.  We cannot rely on Emacs to copy the
+  ;; property because we want to handle properties coming from both
+  ;; text properties and overlays.
+  (let ((pos beg))
+    (while (< pos end)
+      (let ((value (get-char-property pos prop))
+            (next-change (htmlize-next-change pos prop end)))
+        (when value
+          (put-text-property (- pos beg) (- next-change beg)
+                             prop value string))
+        (setq pos next-change)))))
+
+(defun htmlize-get-text-with-display (beg end)
+  ;; Like buffer-substring-no-properties, except it copies the
+  ;; `display' property from the buffer, if found.
+  (let ((text (buffer-substring-no-properties beg end)))
+    (htmlize-copy-prop 'display beg end text)
+    (htmlize-copy-prop 'htmlize-link beg end text)
+    (setq text (htmlize-add-before-after-strings beg end text))
+    text))
+
+(defun htmlize-buffer-substring-no-invisible (beg end)
+  ;; Like buffer-substring-no-properties, but don't copy invisible
+  ;; parts of the region.  Where buffer-substring-no-properties
+  ;; mandates an ellipsis to be shown, htmlize-ellipsis is inserted.
+  (let ((pos beg)
+	visible-list invisible show last-show next-change)
+    ;; Iterate over the changes in the `invisible' property and filter
+    ;; out the portions where it's non-nil, i.e. where the text is
+    ;; invisible.
+    (while (< pos end)
+      (setq invisible (get-char-property pos 'invisible)
+	    next-change (htmlize-next-change pos 'invisible end)
+            show (htmlize-decode-invisibility-spec invisible))
+      (cond ((eq show t)
+	     (push (htmlize-get-text-with-display pos next-change)
+                   visible-list))
+            ((and (eq show 'ellipsis)
+                  (not (eq last-show 'ellipsis))
+                  ;; Conflate successive ellipses.
+                  (push htmlize-ellipsis visible-list))))
+      (setq pos next-change last-show show))
+    (htmlize-concat (nreverse visible-list))))
+
+(defun htmlize-trim-ellipsis (text)
+  ;; Remove htmlize-ellipses ("...") from the beginning of TEXT if it
+  ;; starts with it.  It checks for the special property of the
+  ;; ellipsis so it doesn't work on ordinary text that begins with
+  ;; "...".
+  (if (get-text-property 0 'htmlize-ellipsis text)
+      (substring text (length htmlize-ellipsis))
+    text))
+
+(defconst htmlize-tab-spaces
+  ;; A table of strings with spaces.  (aref htmlize-tab-spaces 5) is
+  ;; like (make-string 5 ?\ ), except it doesn't cons.
+  (let ((v (make-vector 32 nil)))
+    (dotimes (i (length v))
+      (setf (aref v i) (make-string i ?\ )))
+    v))
+
+(defun htmlize-untabify-string (text start-column)
+  "Untabify TEXT, assuming it starts at START-COLUMN."
+  (let ((column start-column)
+	(last-match 0)
+	(chunk-start 0)
+	chunks match-pos tab-size)
+    (while (string-match "[\t\n]" text last-match)
+      (setq match-pos (match-beginning 0))
+      (cond ((eq (aref text match-pos) ?\t)
+	     ;; Encountered a tab: create a chunk of text followed by
+	     ;; the expanded tab.
+	     (push (substring text chunk-start match-pos) chunks)
+	     ;; Increase COLUMN by the length of the text we've
+	     ;; skipped since last tab or newline.  (Encountering
+	     ;; newline resets it.)
+	     (cl-incf column (- match-pos last-match))
+	     ;; Calculate tab size based on tab-width and COLUMN.
+	     (setq tab-size (- tab-width (% column tab-width)))
+	     ;; Expand the tab, carefully recreating the `display'
+	     ;; property if one was on the TAB.
+             (let ((display (get-text-property match-pos 'display text))
+                   (expanded-tab (aref htmlize-tab-spaces tab-size)))
+               (when display
+                 (put-text-property 0 tab-size 'display display expanded-tab))
+               (push expanded-tab chunks))
+	     (cl-incf column tab-size)
+	     (setq chunk-start (1+ match-pos)))
+	    (t
+	     ;; Reset COLUMN at beginning of line.
+	     (setq column 0)))
+      (setq last-match (1+ match-pos)))
+    ;; If no chunks have been allocated, it means there have been no
+    ;; tabs to expand.  Return TEXT unmodified.
+    (if (null chunks)
+	text
+      (when (< chunk-start (length text))
+	;; Push the remaining chunk.
+	(push (substring text chunk-start) chunks))
+      ;; Generate the output from the available chunks.
+      (htmlize-concat (nreverse chunks)))))
+
+(defun htmlize-extract-text (beg end trailing-ellipsis)
+  ;; Extract buffer text, sans the invisible parts.  Then
+  ;; untabify it and escape the HTML metacharacters.
+  (let ((text (htmlize-buffer-substring-no-invisible beg end)))
+    (when trailing-ellipsis
+      (setq text (htmlize-trim-ellipsis text)))
+    ;; If TEXT ends up empty, don't change trailing-ellipsis.
+    (when (> (length text) 0)
+      (setq trailing-ellipsis
+            (get-text-property (1- (length text))
+                               'htmlize-ellipsis text)))
+    (when htmlize-untabify
+      (setq text (htmlize-untabify-string text (current-column))))
+    (setq text (htmlize-string-to-html text))
+    (cl-values text trailing-ellipsis)))
+
+(defun htmlize-despam-address (string)
+  "Replace every occurrence of '@' in STRING with %40.
+This is used to protect mailto links without modifying their meaning."
+  ;; Suggested by Ville Skytta.
+  (while (string-match "@" string)
+    (setq string (replace-match "%40" nil t string)))
+  string)
+
+(defun htmlize-make-tmp-overlay (beg end props)
+  (let ((overlay (make-overlay beg end)))
+    (overlay-put overlay 'htmlize-tmp-overlay t)
+    (while props
+      (overlay-put overlay (pop props) (pop props)))
+    overlay))
+
+(defun htmlize-delete-tmp-overlays ()
+  (dolist (overlay (overlays-in (point-min) (point-max)))
+    (when (overlay-get overlay 'htmlize-tmp-overlay)
+      (delete-overlay overlay))))
+
+(defun htmlize-make-link-overlay (beg end uri)
+  (htmlize-make-tmp-overlay beg end `(htmlize-link (:uri ,uri))))
+
+(defun htmlize-create-auto-links ()
+  "Add `htmlize-link' property to all mailto links in the buffer."
+  (save-excursion
+    (goto-char (point-min))
+    (while (re-search-forward
+            "<\\(\\(mailto:\\)?\\([-=+_.a-zA-Z0-9]+@[-_.a-zA-Z0-9]+\\)\\)>"
+            nil t)
+      (let* ((address (match-string 3))
+             (beg (match-beginning 0)) (end (match-end 0))
+             (uri (concat "mailto:" (htmlize-despam-address address))))
+        (htmlize-make-link-overlay beg end uri)))
+    (goto-char (point-min))
+    (while (re-search-forward "<\\(\\(URL:\\)?\\([a-zA-Z]+://[^;]+\\)\\)>"
+                              nil t)
+      (htmlize-make-link-overlay
+       (match-beginning 0) (match-end 0) (match-string 3)))))
+
+;; Tests for htmlize-create-auto-links:
+
+;; 
+;; 
+;; 
+;; 
+;; 
+;; 
+
+(defun htmlize-shadow-form-feeds ()
+  (let ((s "\n
"))
+    (put-text-property 0 (length s) 'htmlize-literal t s)
+    (let ((disp `(display ,s)))
+      (while (re-search-forward "\n\^L" nil t)
+        (let* ((beg (match-beginning 0))
+               (end (match-end 0))
+               (form-feed-pos (1+ beg))
+               ;; don't process ^L if invisible or covered by `display'
+               (show (and (htmlize-decode-invisibility-spec
+                           (get-char-property form-feed-pos 'invisible))
+                          (not (get-char-property form-feed-pos 'display)))))
+          (when show
+            (htmlize-make-tmp-overlay beg end disp)))))))
+
+(defun htmlize-defang-local-variables ()
+  ;; Juri Linkov reports that an HTML-ized "Local variables" can lead
+  ;; visiting the HTML to fail with "Local variables list is not
+  ;; properly terminated".  He suggested changing the phrase to
+  ;; syntactically equivalent HTML that Emacs doesn't recognize.
+  (goto-char (point-min))
+  (while (search-forward "Local Variables:" nil t)
+    (replace-match "Local Variables:" nil t)))
+  
+
+;;; Color handling.
+
+(defvar htmlize-x-library-search-path
+  `(,data-directory
+    "/etc/X11/rgb.txt"
+    "/usr/share/X11/rgb.txt"
+    ;; the remainder of this list really belongs in a museum
+    "/usr/X11R6/lib/X11/"
+    "/usr/X11R5/lib/X11/"
+    "/usr/lib/X11R6/X11/"
+    "/usr/lib/X11R5/X11/"
+    "/usr/local/X11R6/lib/X11/"
+    "/usr/local/X11R5/lib/X11/"
+    "/usr/local/lib/X11R6/X11/"
+    "/usr/local/lib/X11R5/X11/"
+    "/usr/X11/lib/X11/"
+    "/usr/lib/X11/"
+    "/usr/local/lib/X11/"
+    "/usr/X386/lib/X11/"
+    "/usr/x386/lib/X11/"
+    "/usr/XFree86/lib/X11/"
+    "/usr/unsupported/lib/X11/"
+    "/usr/athena/lib/X11/"
+    "/usr/local/x11r5/lib/X11/"
+    "/usr/lpp/Xamples/lib/X11/"
+    "/usr/openwin/lib/X11/"
+    "/usr/openwin/share/lib/X11/"))
+
+(defun htmlize-get-color-rgb-hash (&optional rgb-file)
+  "Return a hash table mapping X color names to RGB values.
+The keys in the hash table are X11 color names, and the values are the
+#rrggbb RGB specifications, extracted from `rgb.txt'.
+
+If RGB-FILE is nil, the function will try hard to find a suitable file
+in the system directories.
+
+If no rgb.txt file is found, return nil."
+  (let ((rgb-file (or rgb-file (locate-file
+				"rgb.txt"
+				htmlize-x-library-search-path)))
+	(hash nil))
+    (when rgb-file
+      (with-temp-buffer
+	(insert-file-contents rgb-file)
+	(setq hash (make-hash-table :test 'equal))
+	(while (not (eobp))
+	  (cond ((looking-at "^\\s-*\\([!#]\\|$\\)")
+		 ;; Skip comments and empty lines.
+		 )
+		((looking-at
+		  "[ \t]*\\([0-9]+\\)[ \t]+\\([0-9]+\\)[ \t]+\\([0-9]+\\)[ \t]+\\(.*\\)")
+		 (setf (gethash (downcase (match-string 4)) hash)
+		       (format "#%02x%02x%02x"
+			       (string-to-number (match-string 1))
+			       (string-to-number (match-string 2))
+			       (string-to-number (match-string 3)))))
+		(t
+		 (error
+		  "Unrecognized line in %s: %s"
+		  rgb-file
+		  (buffer-substring (point) (progn (end-of-line) (point))))))
+	  (forward-line 1))))
+    hash))
+
+;; Compile the RGB map when loaded.  On systems where rgb.txt is
+;; missing, the value of the variable will be nil, and rgb.txt will
+;; not be used.
+(defvar htmlize-color-rgb-hash (htmlize-get-color-rgb-hash))
+
+;;; Face handling.
+
+(defun htmlize-face-color-internal (face fg)
+  ;; Used only under GNU Emacs.  Return the color of FACE, but don't
+  ;; return "unspecified-fg" or "unspecified-bg".  If the face is
+  ;; `default' and the color is unspecified, look up the color in
+  ;; frame parameters.
+  (let* ((function (if fg #'face-foreground #'face-background))
+	 (color (funcall function face nil t)))
+    (when (and (eq face 'default) (null color))
+      (setq color (cdr (assq (if fg 'foreground-color 'background-color)
+			     (frame-parameters)))))
+    (when (or (eq color 'unspecified)
+	      (equal color "unspecified-fg")
+	      (equal color "unspecified-bg"))
+      (setq color nil))
+    (when (and (eq face 'default)
+	       (null color))
+      ;; Assuming black on white doesn't seem right, but I can't think
+      ;; of anything better to do.
+      (setq color (if fg "black" "white")))
+    color))
+
+(defun htmlize-face-foreground (face)
+  ;; Return the name of the foreground color of FACE.  If FACE does
+  ;; not specify a foreground color, return nil.
+  (htmlize-face-color-internal face t))
+
+(defun htmlize-face-background (face)
+  ;; Return the name of the background color of FACE.  If FACE does
+  ;; not specify a background color, return nil.
+  ;; GNU Emacs.
+  (htmlize-face-color-internal face nil))
+
+;; Convert COLOR to the #RRGGBB string.  If COLOR is already in that
+;; format, it's left unchanged.
+
+(defun htmlize-color-to-rgb (color)
+  (let ((rgb-string nil))
+    (cond ((null color)
+	   ;; Ignore nil COLOR because it means that the face is not
+	   ;; specifying any color.  Hence (htmlize-color-to-rgb nil)
+	   ;; returns nil.
+	   )
+	  ((string-match "\\`#" color)
+	   ;; The color is already in #rrggbb format.
+	   (setq rgb-string color))
+	  ((and htmlize-use-rgb-txt
+		htmlize-color-rgb-hash)
+	   ;; Use of rgb.txt is requested, and it's available on the
+	   ;; system.  Use it.
+	   (setq rgb-string (gethash (downcase color) htmlize-color-rgb-hash)))
+	  (t
+	   ;; We're getting the RGB components from Emacs.
+	   (let ((rgb (mapcar (lambda (arg)
+                                (/ arg 256))
+                              (color-values color))))
+	     (when rgb
+	       (setq rgb-string (apply #'format "#%02x%02x%02x" rgb))))))
+    ;; If RGB-STRING is still nil, it means the color cannot be found,
+    ;; for whatever reason.  In that case just punt and return COLOR.
+    ;; Most browsers support a decent set of color names anyway.
+    (or rgb-string color)))
+
+;; We store the face properties we care about into an
+;; `htmlize-fstruct' type.  That way we only have to analyze face
+;; properties, which can be time consuming, once per each face.  The
+;; mapping between Emacs faces and htmlize-fstructs is established by
+;; htmlize-make-face-map.  The name "fstruct" refers to variables of
+;; type `htmlize-fstruct', while the term "face" is reserved for Emacs
+;; faces.
+
+(cl-defstruct htmlize-fstruct
+  foreground				; foreground color, #rrggbb
+  background				; background color, #rrggbb
+  size					; size
+  boldp					; whether face is bold
+  italicp				; whether face is italic
+  underlinep				; whether face is underlined
+  overlinep				; whether face is overlined
+  strikep				; whether face is struck through
+  css-name				; CSS name of face
+  )
+
+(defun htmlize-face-set-from-keyword-attr (fstruct attr value)
+  ;; For ATTR and VALUE, set the equivalent value in FSTRUCT.
+  (cl-case attr
+    (:foreground
+     (setf (htmlize-fstruct-foreground fstruct) (htmlize-color-to-rgb value)))
+    (:background
+     (setf (htmlize-fstruct-background fstruct) (htmlize-color-to-rgb value)))
+    (:height
+     (setf (htmlize-fstruct-size fstruct) value))
+    (:weight
+     (when (string-match (symbol-name value) "bold")
+       (setf (htmlize-fstruct-boldp fstruct) t)))
+    (:slant
+     (setf (htmlize-fstruct-italicp fstruct) (or (eq value 'italic)
+						 (eq value 'oblique))))
+    (:bold
+     (setf (htmlize-fstruct-boldp fstruct) value))
+    (:italic
+     (setf (htmlize-fstruct-italicp fstruct) value))
+    (:underline
+     (setf (htmlize-fstruct-underlinep fstruct) value))
+    (:overline
+     (setf (htmlize-fstruct-overlinep fstruct) value))
+    (:strike-through
+     (setf (htmlize-fstruct-strikep fstruct) value))))
+
+(defun htmlize-face-size (face)
+  ;; The size (height) of FACE, taking inheritance into account.
+  ;; Only works in Emacs 21 and later.
+  (let* ((face-list (list face))
+         (head face-list)
+         (tail face-list))
+    (while head
+      (let ((inherit (face-attribute (car head) :inherit)))
+        (cond ((listp inherit)
+               (setcdr tail (cl-copy-list inherit))
+               (setq tail (last tail)))
+              ((eq inherit 'unspecified))
+              (t
+               (setcdr tail (list inherit))
+               (setq tail (cdr tail)))))
+      (pop head))
+    (let ((size-list
+           (cl-loop
+            for f in face-list
+            for h = (face-attribute f :height)
+            collect (if (eq h 'unspecified) nil h))))
+      (cl-reduce 'htmlize-merge-size (cons nil size-list)))))
+
+(defun htmlize-face-css-name (face)
+  ;; Generate the css-name property for the given face.  Emacs places
+  ;; no restrictions on the names of symbols that represent faces --
+  ;; any characters may be in the name, even control chars.  We try
+  ;; hard to beat the face name into shape, both esthetically and
+  ;; according to CSS1 specs.
+  (let ((name (downcase (symbol-name face))))
+    (when (string-match "\\`font-lock-" name)
+      ;; font-lock-FOO-face -> FOO.
+      (setq name (replace-match "" t t name)))
+    (when (string-match "-face\\'" name)
+      ;; Drop the redundant "-face" suffix.
+      (setq name (replace-match "" t t name)))
+    (while (string-match "[^-a-zA-Z0-9]" name)
+      ;; Drop the non-alphanumerics.
+      (setq name (replace-match "X" t t name)))
+    (when (string-match "\\`[-0-9]" name)
+      ;; CSS identifiers may not start with a digit.
+      (setq name (concat "X" name)))
+    ;; After these transformations, the face could come out empty.
+    (when (equal name "")
+      (setq name "face"))
+    ;; Apply the prefix.
+    (concat htmlize-css-name-prefix name)))
+
+(defun htmlize-face-to-fstruct-1 (face)
+  "Convert Emacs face FACE to fstruct, internal."
+  (let ((fstruct (make-htmlize-fstruct
+		  :foreground (htmlize-color-to-rgb
+			       (htmlize-face-foreground face))
+		  :background (htmlize-color-to-rgb
+			       (htmlize-face-background face)))))
+    ;; GNU Emacs
+    (dolist (attr '(:weight :slant :underline :overline :strike-through))
+      (let ((value (face-attribute face attr nil t)))
+        (when (and value (not (eq value 'unspecified)))
+          (htmlize-face-set-from-keyword-attr fstruct attr value))))
+    (let ((size (htmlize-face-size face)))
+      (unless (eql size 1.0)            ; ignore non-spec
+        (setf (htmlize-fstruct-size fstruct) size)))
+    (setf (htmlize-fstruct-css-name fstruct) (htmlize-face-css-name face))
+    fstruct))
+
+(defun htmlize-face-to-fstruct (face)
+  (let* ((face-list (or (and (symbolp face)
+                             (cdr (assq face face-remapping-alist)))
+                        (list face)))
+         (fstruct (htmlize-merge-faces
+                   (mapcar (lambda (face)
+                             (if (symbolp face)
+                                 (or (htmlize-get-override-fstruct face)
+                                     (htmlize-face-to-fstruct-1 face))
+                               (htmlize-attrlist-to-fstruct face)))
+                           (nreverse face-list)))))
+    (when (symbolp face)
+      (setf (htmlize-fstruct-css-name fstruct) (htmlize-face-css-name face)))
+    fstruct))
+
+(defmacro htmlize-copy-attr-if-set (attr-list dest source)
+  ;; Generate code with the following pattern:
+  ;; (progn
+  ;;   (when (htmlize-fstruct-ATTR source)
+  ;;     (setf (htmlize-fstruct-ATTR dest) (htmlize-fstruct-ATTR source)))
+  ;;   ...)
+  ;; for the given list of boolean attributes.
+  (cons 'progn
+	(cl-loop for attr in attr-list
+	         for attr-sym = (intern (format "htmlize-fstruct-%s" attr))
+	         collect `(when (,attr-sym ,source)
+                            (setf (,attr-sym ,dest) (,attr-sym ,source))))))
+
+(defun htmlize-merge-size (merged next)
+  ;; Calculate the size of the merge of MERGED and NEXT.
+  (cond ((null merged)     next)
+	((integerp next)   next)
+	((null next)       merged)
+	((floatp merged)   (* merged next))
+	((integerp merged) (round (* merged next)))))
+
+(defun htmlize-merge-two-faces (merged next)
+  (htmlize-copy-attr-if-set
+   (foreground background boldp italicp underlinep overlinep strikep)
+   merged next)
+  (setf (htmlize-fstruct-size merged)
+	(htmlize-merge-size (htmlize-fstruct-size merged)
+			    (htmlize-fstruct-size next)))
+  merged)
+
+(defun htmlize-merge-faces (fstruct-list)
+  (cond ((null fstruct-list)
+	 ;; Nothing to do, return a dummy face.
+	 (make-htmlize-fstruct))
+	((null (cdr fstruct-list))
+	 ;; Optimize for the common case of a single face, simply
+	 ;; return it.
+	 (car fstruct-list))
+	(t
+	 (cl-reduce #'htmlize-merge-two-faces
+		    (cons (make-htmlize-fstruct) fstruct-list)))))
+
+;; GNU Emacs 20+ supports attribute lists in `face' properties.  For
+;; example, you can use `(:foreground "red" :weight bold)' as an
+;; overlay's "face", or you can even use a list of such lists, etc.
+;; We call those "attrlists".
+;;
+;; htmlize supports attrlist by converting them to fstructs, the same
+;; as with regular faces.
+
+(defun htmlize-attrlist-to-fstruct (attrlist &optional name)
+  ;; Like htmlize-face-to-fstruct, but accepts an ATTRLIST as input.
+  (let ((fstruct (make-htmlize-fstruct)))
+    (cond ((eq (car attrlist) 'foreground-color)
+	   ;; ATTRLIST is (foreground-color . COLOR)
+	   (setf (htmlize-fstruct-foreground fstruct)
+		 (htmlize-color-to-rgb (cdr attrlist))))
+	  ((eq (car attrlist) 'background-color)
+	   ;; ATTRLIST is (background-color . COLOR)
+	   (setf (htmlize-fstruct-background fstruct)
+		 (htmlize-color-to-rgb (cdr attrlist))))
+	  (t
+	   ;; ATTRLIST is a plist.
+	   (while attrlist
+	     (let ((attr (pop attrlist))
+		   (value (pop attrlist)))
+	       (when (and value (not (eq value 'unspecified)))
+		 (htmlize-face-set-from-keyword-attr fstruct attr value))))))
+    (setf (htmlize-fstruct-css-name fstruct) (or name "custom"))
+    fstruct))
+
+(defun htmlize-decode-face-prop (prop)
+  "Turn face property PROP into a list of face-like objects."
+  ;; PROP can be a symbol naming a face, a string naming such a
+  ;; symbol, a cons (foreground-color . COLOR) or (background-color
+  ;; COLOR), a property list (:attr1 val1 :attr2 val2 ...), or a list
+  ;; of any of those.
+  ;;
+  ;; (htmlize-decode-face-prop 'face) -> (face)
+  ;; (htmlize-decode-face-prop '(face1 face2)) -> (face1 face2)
+  ;; (htmlize-decode-face-prop '(:attr "val")) -> ((:attr "val"))
+  ;; (htmlize-decode-face-prop '((:attr "val") face (foreground-color "red")))
+  ;;   -> ((:attr "val") face (foreground-color "red"))
+  ;;
+  ;; Unrecognized atoms or non-face symbols/strings are silently
+  ;; stripped away.
+  (cond ((null prop)
+         nil)
+        ((symbolp prop)
+         (and (facep prop)
+              (list prop)))
+        ((stringp prop)
+         (and (facep (intern-soft prop))
+              (list prop)))
+        ((atom prop)
+         nil)
+        ((and (symbolp (car prop))
+              (eq ?: (aref (symbol-name (car prop)) 0)))
+         (list prop))
+        ((or (eq (car prop) 'foreground-color)
+             (eq (car prop) 'background-color))
+         (list prop))
+        (t
+         (apply #'nconc (mapcar #'htmlize-decode-face-prop prop)))))
+
+(defun htmlize-get-override-fstruct (face)
+  (let* ((raw-def (plist-get htmlize-face-overrides face))
+         (def (cond ((stringp raw-def) (list :foreground raw-def))
+                    ((listp raw-def) raw-def)
+                    (t
+                     (error (format (concat "face override must be an "
+                                            "attribute list or string, got %s")
+                                    raw-def))))))
+    (and def
+         (htmlize-attrlist-to-fstruct def (symbol-name face)))))
+
+(defun htmlize-make-face-map (faces)
+  ;; Return a hash table mapping Emacs faces to htmlize's fstructs.
+  ;; The keys are either face symbols or attrlists, so the test
+  ;; function must be `equal'.
+  (let ((face-map (make-hash-table :test 'equal))
+	css-names)
+    (dolist (face faces)
+      (unless (gethash face face-map)
+	;; Haven't seen FACE yet; convert it to an fstruct and cache
+	;; it.
+	(let ((fstruct (htmlize-face-to-fstruct face)))
+	  (setf (gethash face face-map) fstruct)
+	  (let* ((css-name (htmlize-fstruct-css-name fstruct))
+		 (new-name css-name)
+		 (i 0))
+	    ;; Uniquify the face's css-name by using NAME-1, NAME-2,
+	    ;; etc.
+	    (while (member new-name css-names)
+	      (setq new-name (format "%s-%s" css-name (cl-incf i))))
+	    (unless (equal new-name css-name)
+	      (setf (htmlize-fstruct-css-name fstruct) new-name))
+	    (push new-name css-names)))))
+    face-map))
+
+(defun htmlize-unstringify-face (face)
+  "If FACE is a string, return it interned, otherwise return it unchanged."
+  (if (stringp face)
+      (intern face)
+    face))
+
+(defun htmlize-faces-in-buffer ()
+  "Return a list of faces used in the current buffer.
+This is the set of faces specified by the `face' text property and by buffer
+overlays that specify `face'."
+  (let (faces)
+    ;; Faces used by text properties.
+    (let ((pos (point-min)) face-prop next)
+      (while (< pos (point-max))
+        (setq face-prop (get-text-property pos 'face)
+              next (or (next-single-property-change pos 'face) (point-max)))
+        (setq faces (cl-nunion (htmlize-decode-face-prop face-prop)
+                               faces :test 'equal))
+        (setq pos next)))
+    ;; Faces used by overlays.
+    (dolist (overlay (overlays-in (point-min) (point-max)))
+      (let ((face-prop (overlay-get overlay 'face)))
+        (setq faces (cl-nunion (htmlize-decode-face-prop face-prop)
+                               faces :test 'equal))))
+    faces))
+
+(if (>= emacs-major-version 25)
+    (defun htmlize-sorted-overlays-at (pos)
+      (overlays-at pos t))
+
+  (defun htmlize-sorted-overlays-at (pos)
+    ;; Like OVERLAYS-AT with the SORTED argument, for older Emacsen.
+    (let ((overlays (overlays-at pos)))
+      (setq overlays (cl-sort overlays #'<
+                              :key (lambda (o)
+                                     (- (overlay-end o) (overlay-start o)))))
+      (setq overlays
+            (cl-stable-sort overlays #'<
+                            :key (lambda (o)
+                                   (let ((prio (overlay-get o 'priority)))
+                                     (if (numberp prio) prio 0)))))
+      (nreverse overlays))))
+
+
+;; htmlize-faces-at-point returns the faces in use at point.  The
+;; faces are sorted by increasing priority, i.e. the last face takes
+;; precedence.
+;;
+;; This returns all the faces in the `face' property and all the faces
+;; in the overlays at point.
+
+(defun htmlize-faces-at-point ()
+  (let (all-faces)
+    ;; Faces from text properties.
+    (let ((face-prop (get-text-property (point) 'face)))
+      ;; we need to reverse the `face' prop because we want
+      ;; more specific faces to come later
+      (setq all-faces (nreverse (htmlize-decode-face-prop face-prop))))
+    ;; Faces from overlays.
+    (let ((overlays
+           ;; Collect overlays at point that specify `face'.
+           (cl-delete-if-not (lambda (o)
+                               (overlay-get o 'face))
+                             (nreverse (htmlize-sorted-overlays-at (point)))))
+          list face-prop)
+      (dolist (overlay overlays)
+        (setq face-prop (overlay-get overlay 'face)
+              list (nconc (htmlize-decode-face-prop face-prop) list)))
+      ;; Under "Merging Faces" the manual explicitly states
+      ;; that faces specified by overlays take precedence over
+      ;; faces specified by text properties.
+      (setq all-faces (nconc all-faces list)))
+    all-faces))
+
+;; htmlize supports generating HTML in several flavors, some of which
+;; use CSS, and others the  element.  We take an OO approach and
+;; define "methods" that indirect to the functions that depend on
+;; `htmlize-output-type'.  The currently used methods are `doctype',
+;; `insert-head', `body-tag', `pre-tag', and `text-markup'.  Not all
+;; output types define all methods.
+;;
+;; Methods are called either with (htmlize-method METHOD ARGS...) 
+;; special form, or by accessing the function with
+;; (htmlize-method-function 'METHOD) and calling (funcall FUNCTION).
+;; The latter form is useful in tight loops because `htmlize-method'
+;; conses.
+
+(defmacro htmlize-method (method &rest args)
+  ;; Expand to (htmlize-TYPE-METHOD ...ARGS...).  TYPE is the value of
+  ;; `htmlize-output-type' at run time.
+  `(funcall (htmlize-method-function ',method) ,@args))
+
+(defun htmlize-method-function (method)
+  ;; Return METHOD's function definition for the current output type.
+  ;; The returned object can be safely funcalled.
+  (let ((sym (intern (format "htmlize-%s-%s" htmlize-output-type method))))
+    (indirect-function (if (fboundp sym)
+			   sym
+			 (let ((default (intern (concat "htmlize-default-"
+							(symbol-name method)))))
+			   (if (fboundp default)
+			       default
+			     'ignore))))))
+
+(defvar htmlize-memoization-table (make-hash-table :test 'equal))
+
+(defmacro htmlize-memoize (key generator)
+  "Return the value of GENERATOR, memoized as KEY.
+That means that GENERATOR will be evaluated and returned the first time
+it's called with the same value of KEY.  All other times, the cached
+\(memoized) value will be returned."
+  (let ((value (cl-gensym)))
+    `(let ((,value (gethash ,key htmlize-memoization-table)))
+       (unless ,value
+	 (setq ,value ,generator)
+	 (setf (gethash ,key htmlize-memoization-table) ,value))
+       ,value)))
+
+;;; Default methods.
+
+(defun htmlize-default-doctype ()
+  nil					; no doc-string
+  ;; Note that the `font' output is technically invalid under this DTD
+  ;; because the DTD doesn't allow embedding  in 
.
+  ""
+  )
+
+(defun htmlize-default-body-tag (face-map)
+  nil					; no doc-string
+  face-map ; shut up the byte-compiler
+  "")
+
+(defun htmlize-default-pre-tag (face-map)
+  nil					; no doc-string
+  face-map ; shut up the byte-compiler
+  "
")
+
+
+;;; CSS based output support.
+
+;; Internal function; not a method.
+(defun htmlize-css-specs (fstruct)
+  (let (result)
+    (when (htmlize-fstruct-foreground fstruct)
+      (push (format "color: %s;" (htmlize-fstruct-foreground fstruct))
+	    result))
+    (when (htmlize-fstruct-background fstruct)
+      (push (format "background-color: %s;"
+		    (htmlize-fstruct-background fstruct))
+	    result))
+    (let ((size (htmlize-fstruct-size fstruct)))
+      (when (and size (not (eq htmlize-ignore-face-size t)))
+	(cond ((floatp size)
+	       (push (format "font-size: %d%%;" (* 100 size)) result))
+	      ((not (eq htmlize-ignore-face-size 'absolute))
+	       (push (format "font-size: %spt;" (/ size 10.0)) result)))))
+    (when (htmlize-fstruct-boldp fstruct)
+      (push "font-weight: bold;" result))
+    (when (htmlize-fstruct-italicp fstruct)
+      (push "font-style: italic;" result))
+    (when (htmlize-fstruct-underlinep fstruct)
+      (push "text-decoration: underline;" result))
+    (when (htmlize-fstruct-overlinep fstruct)
+      (push "text-decoration: overline;" result))
+    (when (htmlize-fstruct-strikep fstruct)
+      (push "text-decoration: line-through;" result))
+    (nreverse result)))
+
+(defun htmlize-css-insert-head (buffer-faces face-map)
+  (insert "    \n"))
+
+(defun htmlize-css-text-markup (fstruct-list buffer)
+  ;; Open the markup needed to insert text colored with FACES into
+  ;; BUFFER.  Return the function that closes the markup.
+
+  ;; In CSS mode, this is easy: just nest the text in one  tag for each face in FSTRUCT-LIST.
+  (dolist (fstruct fstruct-list)
+    (princ "" buffer))
+  (htmlize-lexlet ((fstruct-list fstruct-list) (buffer buffer))
+    (lambda ()
+      (dolist (fstruct fstruct-list)
+        (ignore fstruct)                ; shut up the byte-compiler
+        (princ "" buffer)))))
+
+;; `inline-css' output support.
+
+(defun htmlize-inline-css-body-tag (face-map)
+  (format ""
+	  (mapconcat #'identity (htmlize-css-specs (gethash 'default face-map))
+		     " ")))
+
+(defun htmlize-inline-css-pre-tag (face-map)
+  (if htmlize-pre-style
+      (format "
"
+              (mapconcat #'identity (htmlize-css-specs (gethash 'default face-map))
+                         " "))
+    (format "
")))
+
+(defun htmlize-inline-css-text-markup (fstruct-list buffer)
+  (let* ((merged (htmlize-merge-faces fstruct-list))
+	 (style (htmlize-memoize
+		 merged
+		 (let ((specs (htmlize-css-specs merged)))
+		   (and specs
+			(mapconcat #'identity (htmlize-css-specs merged) " "))))))
+    (when style
+      (princ "" buffer))
+    (htmlize-lexlet ((style style) (buffer buffer))
+      (lambda ()
+        (when style
+          (princ "" buffer))))))
+
+;;; `font' tag based output support.
+
+(defun htmlize-font-body-tag (face-map)
+  (let ((fstruct (gethash 'default face-map)))
+    (format ""
+	    (htmlize-fstruct-foreground fstruct)
+	    (htmlize-fstruct-background fstruct))))
+
+(defun htmlize-font-pre-tag (face-map)
+  (if htmlize-pre-style
+      (let ((fstruct (gethash 'default face-map)))
+        (format "
"
+                (htmlize-fstruct-foreground fstruct)
+                (htmlize-fstruct-background fstruct)))
+    (format "
")))
+       
+(defun htmlize-font-text-markup (fstruct-list buffer)
+  ;; In `font' mode, we use the traditional HTML means of altering
+  ;; presentation:  tag for colors,  for bold,  for
+  ;; underline, and  for strike-through.
+  (let* ((merged (htmlize-merge-faces fstruct-list))
+	 (markup (htmlize-memoize
+		  merged
+		  (cons (concat
+			 (and (htmlize-fstruct-foreground merged)
+			      (format "" (htmlize-fstruct-foreground merged)))
+			 (and (htmlize-fstruct-boldp merged)      "")
+			 (and (htmlize-fstruct-italicp merged)    "")
+			 (and (htmlize-fstruct-underlinep merged) "")
+			 (and (htmlize-fstruct-strikep merged)    ""))
+			(concat
+			 (and (htmlize-fstruct-strikep merged)    "")
+			 (and (htmlize-fstruct-underlinep merged) "")
+			 (and (htmlize-fstruct-italicp merged)    "")
+			 (and (htmlize-fstruct-boldp merged)      "")
+			 (and (htmlize-fstruct-foreground merged) ""))))))
+    (princ (car markup) buffer)
+    (htmlize-lexlet ((markup markup) (buffer buffer))
+      (lambda ()
+        (princ (cdr markup) buffer)))))
+
+(defun htmlize-buffer-1 ()
+  ;; Internal function; don't call it from outside this file.  Htmlize
+  ;; current buffer, writing the resulting HTML to a new buffer, and
+  ;; return it.  Unlike htmlize-buffer, this doesn't change current
+  ;; buffer or use switch-to-buffer.
+  (save-excursion
+    ;; Protect against the hook changing the current buffer.
+    (save-excursion
+      (run-hooks 'htmlize-before-hook))
+    ;; Convince font-lock support modes to fontify the entire buffer
+    ;; in advance.
+    (htmlize-ensure-fontified)
+    (clrhash htmlize-extended-character-cache)
+    (clrhash htmlize-memoization-table)
+    ;; It's important that the new buffer inherits default-directory
+    ;; from the current buffer.
+    (let ((htmlbuf (generate-new-buffer (if (buffer-file-name)
+                                            (htmlize-make-file-name
+                                             (file-name-nondirectory
+                                              (buffer-file-name)))
+                                          "*html*")))
+          (completed nil))
+      (unwind-protect
+          (let* ((buffer-faces (htmlize-faces-in-buffer))
+                 (face-map (htmlize-make-face-map (cl-adjoin 'default buffer-faces)))
+                 (places (cl-gensym))
+                 (title (if (buffer-file-name)
+                            (file-name-nondirectory (buffer-file-name))
+                          (buffer-name))))
+            (when htmlize-generate-hyperlinks
+              (htmlize-create-auto-links))
+            (when htmlize-replace-form-feeds
+              (htmlize-shadow-form-feeds))
+
+            ;; Initialize HTMLBUF and insert the HTML prolog.
+            (with-current-buffer htmlbuf
+              (buffer-disable-undo)
+              (insert (htmlize-method doctype) ?\n
+                      (format "\n"
+                              htmlize-version htmlize-output-type)
+                      "\n  ")
+              (put places 'head-start (point-marker))
+              (insert "\n"
+                      "    " (htmlize-protect-string title) "\n"
+                      (if htmlize-html-charset
+                          (format (concat "    \n")
+                                  htmlize-html-charset)
+                        "")
+                      htmlize-head-tags)
+              (htmlize-method insert-head buffer-faces face-map)
+              (insert "  ")
+              (put places 'head-end (point-marker))
+              (insert "\n  ")
+              (put places 'body-start (point-marker))
+              (insert (htmlize-method body-tag face-map)
+                      "\n    ")
+              (put places 'content-start (point-marker))
+              (insert (htmlize-method pre-tag face-map) "\n"))
+            (let ((text-markup
+                   ;; Get the inserter method, so we can funcall it inside
+                   ;; the loop.  Not calling `htmlize-method' in the loop
+                   ;; body yields a measurable speed increase.
+                   (htmlize-method-function 'text-markup))
+                  ;; Declare variables used in loop body outside the loop
+                  ;; because it's faster to establish `let' bindings only
+                  ;; once.
+                  next-change text face-list trailing-ellipsis
+                  fstruct-list last-fstruct-list
+                  (close-markup (lambda ())))
+              ;; This loop traverses and reads the source buffer, appending
+              ;; the resulting HTML to HTMLBUF.  This method is fast
+              ;; because: 1) it doesn't require examining the text
+              ;; properties char by char (htmlize-next-face-change is used
+              ;; to move between runs with the same face), and 2) it doesn't
+              ;; require frequent buffer switches, which are slow because
+              ;; they rebind all buffer-local vars.
+              (goto-char (point-min))
+              (while (not (eobp))
+                (setq next-change (htmlize-next-face-change (point)))
+                ;; Get faces in use between (point) and NEXT-CHANGE, and
+                ;; convert them to fstructs.
+                (setq face-list (htmlize-faces-at-point)
+                      fstruct-list (delq nil (mapcar (lambda (f)
+                                                       (gethash f face-map))
+                                                     face-list)))
+                (cl-multiple-value-setq (text trailing-ellipsis)
+                  (htmlize-extract-text (point) next-change trailing-ellipsis))
+                ;; Don't bother writing anything if there's no text (this
+                ;; happens in invisible regions).
+                (when (> (length text) 0)
+                  ;; Open the new markup if necessary and insert the text.
+                  (when (not (cl-equalp fstruct-list last-fstruct-list))
+                    (funcall close-markup)
+                    (setq last-fstruct-list fstruct-list
+                          close-markup (funcall text-markup fstruct-list htmlbuf)))
+                  (princ text htmlbuf))
+                (goto-char next-change))
+
+              ;; We've gone through the buffer; close the markup from
+              ;; the last run, if any.
+              (funcall close-markup))
+
+            ;; Insert the epilog and post-process the buffer.
+            (with-current-buffer htmlbuf
+              (insert "
")
+              (put places 'content-end (point-marker))
+              (insert "\n  ")
+              (put places 'body-end (point-marker))
+              (insert "\n\n")
+              (htmlize-defang-local-variables)
+              (goto-char (point-min))
+              (when htmlize-html-major-mode
+                ;; What sucks about this is that the minor modes, most notably
+                ;; font-lock-mode, won't be initialized.  Oh well.
+                (funcall htmlize-html-major-mode))
+              (set (make-local-variable 'htmlize-buffer-places)
+                   (symbol-plist places))
+              (run-hooks 'htmlize-after-hook)
+              (buffer-enable-undo))
+            (setq completed t)
+            htmlbuf)
+
+        (when (not completed)
+          (kill-buffer htmlbuf))
+        (htmlize-delete-tmp-overlays)))))
+
+;; Utility functions.
+
+(defmacro htmlize-with-fontify-message (&rest body)
+  ;; When forcing fontification of large buffers in
+  ;; htmlize-ensure-fontified, inform the user that he is waiting for
+  ;; font-lock, not for htmlize to finish.
+  `(progn
+     (if (> (buffer-size) 65536)
+	 (message "Forcing fontification of %s..."
+		  (buffer-name (current-buffer))))
+     ,@body
+     (if (> (buffer-size) 65536)
+	 (message "Forcing fontification of %s...done"
+		  (buffer-name (current-buffer))))))
+
+(defun htmlize-ensure-fontified ()
+  ;; If font-lock is being used, ensure that the "support" modes
+  ;; actually fontify the buffer.  If font-lock is not in use, we
+  ;; don't care because, except in htmlize-file, we don't force
+  ;; font-lock on the user.
+  (when font-lock-mode
+    ;; In part taken from ps-print-ensure-fontified in GNU Emacs 21.
+    (when (and (boundp 'jit-lock-mode)
+               (symbol-value 'jit-lock-mode))
+      (htmlize-with-fontify-message
+       (jit-lock-fontify-now (point-min) (point-max))))
+
+    (if (fboundp 'font-lock-ensure)
+        (font-lock-ensure)
+      ;; Emacs prior to 25.1
+      (with-no-warnings
+        (font-lock-mode 1)
+        (font-lock-fontify-buffer)))))
+
+
+;;;###autoload
+(defun htmlize-buffer (&optional buffer)
+  "Convert BUFFER to HTML, preserving colors and decorations.
+
+The generated HTML is available in a new buffer, which is returned.
+When invoked interactively, the new buffer is selected in the current
+window.  The title of the generated document will be set to the buffer's
+file name or, if that's not available, to the buffer's name.
+
+Note that htmlize doesn't fontify your buffers, it only uses the
+decorations that are already present.  If you don't set up font-lock or
+something else to fontify your buffers, the resulting HTML will be
+plain.  Likewise, if you don't like the choice of colors, fix the mode
+that created them, or simply alter the faces it uses."
+  (interactive)
+  (let ((htmlbuf (with-current-buffer (or buffer (current-buffer))
+		   (htmlize-buffer-1))))
+    (when (interactive-p)
+      (switch-to-buffer htmlbuf))
+    htmlbuf))
+
+;;;###autoload
+(defun htmlize-region (beg end)
+  "Convert the region to HTML, preserving colors and decorations.
+See `htmlize-buffer' for details."
+  (interactive "r")
+  ;; Don't let zmacs region highlighting end up in HTML.
+  (when (fboundp 'zmacs-deactivate-region)
+    (zmacs-deactivate-region))
+  (let ((htmlbuf (save-restriction
+		   (narrow-to-region beg end)
+		   (htmlize-buffer-1))))
+    (when (interactive-p)
+      (switch-to-buffer htmlbuf))
+    htmlbuf))
+
+(defun htmlize-region-for-paste (beg end)
+  "Htmlize the region and return just the HTML as a string.
+This forces the `inline-css' style and only returns the HTML body,
+but without the BODY tag.  This should make it useful for inserting
+the text to another HTML buffer."
+  (let* ((htmlize-output-type 'inline-css)
+	 (htmlbuf (htmlize-region beg end)))
+    (unwind-protect
+	(with-current-buffer htmlbuf
+	  (buffer-substring (plist-get htmlize-buffer-places 'content-start)
+			    (plist-get htmlize-buffer-places 'content-end)))
+      (kill-buffer htmlbuf))))
+
+(defun htmlize-region-save-screenshot (beg end)
+  "Save the htmlized (see `htmlize-region-for-paste') region in
+the kill ring. Uses `inline-css', with style information in
+`
' tags, so that the rendering of the marked up text
+approximates the buffer as closely as possible."
+  (interactive "r")
+  (let ((htmlize-pre-style t))
+    (kill-new (htmlize-region-for-paste beg end)))
+  (deactivate-mark))
+
+(defun htmlize-make-file-name (file)
+  "Make an HTML file name from FILE.
+
+In its default implementation, this simply appends `.html' to FILE.
+This function is called by htmlize to create the buffer file name, and
+by `htmlize-file' to create the target file name.
+
+More elaborate transformations are conceivable, such as changing FILE's
+extension to `.html' (\"file.c\" -> \"file.html\").  If you want them,
+overload this function to do it and htmlize will comply."
+  (concat file ".html"))
+
+;; Older implementation of htmlize-make-file-name that changes FILE's
+;; extension to ".html".
+;(defun htmlize-make-file-name (file)
+;  (let ((extension (file-name-extension file))
+;	(sans-extension (file-name-sans-extension file)))
+;    (if (or (equal extension "html")
+;	    (equal extension "htm")
+;	    (equal sans-extension ""))
+;	(concat file ".html")
+;      (concat sans-extension ".html"))))
+
+;;;###autoload
+(defun htmlize-file (file &optional target)
+  "Load FILE, fontify it, convert it to HTML, and save the result.
+
+Contents of FILE are inserted into a temporary buffer, whose major mode
+is set with `normal-mode' as appropriate for the file type.  The buffer
+is subsequently fontified with `font-lock' and converted to HTML.  Note
+that, unlike `htmlize-buffer', this function explicitly turns on
+font-lock.  If a form of highlighting other than font-lock is desired,
+please use `htmlize-buffer' directly on buffers so highlighted.
+
+Buffers currently visiting FILE are unaffected by this function.  The
+function does not change current buffer or move the point.
+
+If TARGET is specified and names a directory, the resulting file will be
+saved there instead of to FILE's directory.  If TARGET is specified and
+does not name a directory, it will be used as output file name."
+  (interactive (list (read-file-name
+		      "HTML-ize file: "
+		      nil nil nil (and (buffer-file-name)
+				       (file-name-nondirectory
+					(buffer-file-name))))))
+  (let ((output-file (if (and target (not (file-directory-p target)))
+			 target
+		       (expand-file-name
+			(htmlize-make-file-name (file-name-nondirectory file))
+			(or target (file-name-directory file)))))
+	;; Try to prevent `find-file-noselect' from triggering
+	;; font-lock because we'll fontify explicitly below.
+	(font-lock-mode nil)
+	(font-lock-auto-fontify nil)
+	(global-font-lock-mode nil)
+	;; Ignore the size limit for the purposes of htmlization.
+	(font-lock-maximum-size nil))
+    (with-temp-buffer
+      ;; Insert FILE into the temporary buffer.
+      (insert-file-contents file)
+      ;; Set the file name so normal-mode and htmlize-buffer-1 pick it
+      ;; up.  Restore it afterwards so with-temp-buffer's kill-buffer
+      ;; doesn't complain about killing a modified buffer.
+      (let ((buffer-file-name file))
+	;; Set the major mode for the sake of font-lock.
+	(normal-mode)
+	;; htmlize the buffer and save the HTML.
+	(with-current-buffer (htmlize-buffer-1)
+	  (unwind-protect
+	      (progn
+		(run-hooks 'htmlize-file-hook)
+		(write-region (point-min) (point-max) output-file))
+	    (kill-buffer (current-buffer)))))))
+  ;; I haven't decided on a useful return value yet, so just return
+  ;; nil.
+  nil)
+
+;;;###autoload
+(defun htmlize-many-files (files &optional target-directory)
+  "Convert FILES to HTML and save the corresponding HTML versions.
+
+FILES should be a list of file names to convert.  This function calls
+`htmlize-file' on each file; see that function for details.  When
+invoked interactively, you are prompted for a list of files to convert,
+terminated with RET.
+
+If TARGET-DIRECTORY is specified, the HTML files will be saved to that
+directory.  Normally, each HTML file is saved to the directory of the
+corresponding source file."
+  (interactive
+   (list
+    (let (list file)
+      ;; Use empty string as DEFAULT because setting DEFAULT to nil
+      ;; defaults to the directory name, which is not what we want.
+      (while (not (equal (setq file (read-file-name
+				     "HTML-ize file (RET to finish): "
+				     (and list (file-name-directory
+						(car list)))
+				     "" t))
+			 ""))
+	(push file list))
+      (nreverse list))))
+  ;; Verify that TARGET-DIRECTORY is indeed a directory.  If it's a
+  ;; file, htmlize-file will use it as target, and that doesn't make
+  ;; sense.
+  (and target-directory
+       (not (file-directory-p target-directory))
+       (error "target-directory must name a directory: %s" target-directory))
+  (dolist (file files)
+    (htmlize-file file target-directory)))
+
+;;;###autoload
+(defun htmlize-many-files-dired (arg &optional target-directory)
+  "HTMLize dired-marked files."
+  (interactive "P")
+  (htmlize-many-files (dired-get-marked-files nil arg) target-directory))
+
+(provide 'htmlize)
+
+;; Local Variables:
+;; byte-compile-warnings: (not unresolved obsolete)
+;; End:
+
+;;; htmlize.el ends here