1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
;;; index.scm -- Document indices. -*- coding: iso-8859-1 -*-
;;;
;;; Copyright 2005, 2006, 2008, 2009, 2015, 2018 Ludovic Court�s <ludo@gnu.org>
;;; Copyright 2003, 2004 Manuel Serrano
;;;
;;;
;;; This file is part of Skribilo.
;;;
;;; Skribilo 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 3 of the License, or
;;; (at your option) any later version.
;;;
;;; Skribilo 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 Skribilo. If not, see <http://www.gnu.org/licenses/>.
(define-module (skribilo index)
:use-module (skribilo utils syntax)
:use-module (skribilo lib)
:use-module (skribilo ast)
:autoload (srfi srfi-34) (raise)
:use-module (srfi srfi-35)
:use-module (srfi srfi-39)
;; XXX: The use of `mark' here introduces a cross-dependency between
;; `index' and `package base'. Thus, we require that each of these two
;; modules autoloads the other one.
:autoload (skribilo package base) (mark)
:autoload (skribilo location) (location?)
:export (index? make-index-table *index-table*
default-index resolve-the-index))
(skribilo-module-syntax)
;;; Author: Manuel Serrano
;;; Commentary:
;;;
;;; A library of functions dealing with the creation of indices in
;;; documents.
;;;
;;; Code:
;;; The contents of the file below are (almost) unchanged compared to Skribe
;;; 1.2d's `index.scm' file found in the `common' directory.
;*---------------------------------------------------------------------*/
;* index? ... */
;*---------------------------------------------------------------------*/
(define (index? obj)
(hash-table? obj))
;*---------------------------------------------------------------------*/
;* *index-table* ... */
;*---------------------------------------------------------------------*/
(define *index-table* (make-parameter #f))
;*---------------------------------------------------------------------*/
;* make-index-table ... */
;*---------------------------------------------------------------------*/
(define (make-index-table ident)
(make-hash-table))
;*---------------------------------------------------------------------*/
;* default-index ... */
;*---------------------------------------------------------------------*/
(define (default-index)
(if (not (*index-table*))
(*index-table* (make-index-table "default-index")))
(*index-table*))
;*---------------------------------------------------------------------*/
;* resolve-the-index ... */
;*---------------------------------------------------------------------*/
(define (resolve-the-index loc i c indexes split char-offset header-limit col)
;; fetch the descriminating index name letter
(define (index-ref n)
(let ((name (markup-option n 'name)))
(if (>= char-offset (string-length name))
(let ((loc (if (location? loc)
(format #f "~a:~a:~a: "
(location-file loc)
(location-line loc)
(location-column loc))
""))
(msg (format
#f (G_ "the-index: char offset '~A' out of bounds~%")
char-offset)))
(raise (condition (&message
(condition-message (string-append loc msg))))))
(string-ref name char-offset))))
;; sort a bucket of entries (the entries in a bucket share there name)
(define (sort-entries-bucket ie)
(sort ie
(lambda (i1 i2)
(or (not (markup-option i1 :note))
(markup-option i2 :note)))))
;; accumulate all the entries starting with the same letter
(define (letter-references refs)
(let ((letter (index-ref (car (car refs)))))
(let loop ((refs refs)
(acc '()))
(if (or (null? refs)
(not (char-ci=? letter (index-ref (car (car refs))))))
(values (char-upcase letter) acc refs)
(loop (cdr refs) (cons (car refs) acc))))))
;; merge the buckets that comes from different index tables
(define (merge-buckets buckets)
(if (null? buckets)
'()
(let loop ((buckets buckets)
(res '()))
(cond
((null? (cdr buckets))
(reverse! (cons (car buckets) res)))
((string=? (markup-option (car (car buckets)) 'name)
(markup-option (car (cadr buckets)) 'name))
;; we merge
(loop (cons (append (car buckets) (cadr buckets))
(cddr buckets))
res))
(else
(loop (cdr buckets)
(cons (car buckets) res)))))))
(let* ((entries (apply append (map (lambda (t)
(hash-map->list
(lambda (key val) val) t))
indexes)))
(sorted (map sort-entries-bucket
(merge-buckets
(sort entries
(lambda (e1 e2)
(string-ci<?
(markup-option (car e1) 'name)
(markup-option (car e2) 'name))))))))
(if (and (not split) (< (apply + (map length sorted)) header-limit))
(new markup
(markup '&the-index)
(loc loc)
(ident i)
(class c)
(options `((:column ,col)))
(body sorted))
(let loop ((refs sorted)
(lrefs '())
(body '()))
(if (null? refs)
(new markup
(markup '&the-index)
(loc loc)
(ident i)
(class c)
(options `((:column ,col)
(header ,(new markup
(markup '&the-index-header)
(loc loc)
(body (reverse! lrefs))))))
(body (reverse! body)))
(call-with-values
(lambda () (letter-references refs))
(lambda (l lr next-refs)
(let* ((s (string l))
(m (mark (symbol->string (gensym s)) :text s))
(h (new handle (loc loc) (ast m)))
(r (ref :handle h :text s)))
(ast-loc-set! m loc)
(ast-loc-set! r loc)
(loop next-refs
(cons r lrefs)
(append lr (cons m body)))))))))))
;;; index.scm ends here
|
