Source

mule-base / mule-util.el

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
;;; mule-util.el --- Utility functions for multilingual environment (mule)

;; Copyright (C) 1995 Free Software Foundation, Inc.
;; Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
;; Copyright (C) 1997 MORIOKA Tomohiko

;; Keywords: mule, multilingual

;; This file is part of XEmacs.

;; XEmacs 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.

;; XEmacs 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 XEmacs; see the file COPYING.  If not, write to the Free
;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
;; 02111-1307, USA.

;;; Code:

;;; String manipulations while paying attention to multibyte
;;; characters.

;; That code is pointless in XEmacs/Mule, since our multibyte
;; representation doesn't leak to Lisp.

;;; Following functions are defined in obsolete.el of kernel.

;; ;;;###autoload
;; (defun string-to-sequence (string type)
;;   "Convert STRING to a sequence of TYPE which contains characters in STRING.
;; TYPE should be `list' or `vector'."
;;   (let ((len (length string))
;;         (i 0)
;;         val)
;;     (cond ((eq type 'list)
;;            (setq val (make-list len 0))
;;            (let ((l val))
;;              (while (< i len)
;;                (setcar l (aref string i))
;;                (setq l (cdr l) i (1+ i)))))
;;           ((eq type 'vector)
;;            (setq val (make-vector len 0))
;;            (while (< i len)
;;              (aset val i (aref string i))
;;              (setq i (1+ i))))
;;           (t
;;            (error "Invalid type: %s" type)))
;;     val))

;; string-to-sequence, string-to-list, string-to-vector, store-substring,
;; truncate-string-to-width

;; ;;;###autoload
;; (defsubst string-to-list (string)
;;   "Return a list of characters in STRING."
;;   (string-to-sequence string 'list))

;; ;;;###autoload
;; (defsubst string-to-vector (string)
;;   "Return a vector of characters in STRING."
;;   (string-to-sequence string 'vector))

;;;###autoload
(defun store-substring (string idx obj)
  "Embed OBJ (string or character) at index IDX of STRING."
  (if (characterp obj)
      (aset string idx obj)
    (let ((len1 (length obj))
	  (len2 (length string))
	  (i 0))
      (while (< i len1)
	(aset string (+ idx i) (aref obj i))
	(setq i (1+ i)))))
  string)

;;;###autoload
(defun truncate-string-to-width (str end-column &optional start-column padding)
  "Truncate string STR to end at column END-COLUMN.
The optional 2nd arg START-COLUMN, if non-nil, specifies
the starting column; that means to return the characters occupying
columns START-COLUMN ... END-COLUMN of STR.

The optional 3rd arg PADDING, if non-nil, specifies a padding character
to add at the end of the result if STR doesn't reach column END-COLUMN,
or if END-COLUMN comes in the middle of a character in STR.
PADDING is also added at the beginning of the result
if column START-COLUMN appears in the middle of a character in STR.

If PADDING is nil, no padding is added in these cases, so
the resulting string may be narrower than END-COLUMN."
  (or start-column
      (setq start-column 0))
  (let ((len (length str))
	(idx 0)
	(column 0)
	(head-padding "") (tail-padding "")
	ch last-column last-idx from-idx)
    (condition-case nil
	(while (< column start-column)
	  (setq ch (aref str idx)
		column (+ column (char-width ch))
		idx (1+ idx)))
      (args-out-of-range (setq idx len)))
    (if (< column start-column)
	(if padding (make-string end-column padding) "")
      (if (and padding (> column start-column))
	  (setq head-padding (make-string (- column start-column) padding)))
      (setq from-idx idx)
      (if (< end-column column)
	  (setq idx from-idx)
	(condition-case nil
	    (while (< column end-column)
	      (setq last-column column
		    last-idx idx
		    ch (aref str idx)
		    column (+ column (char-width ch))
		    idx (1+ idx)))
	  (args-out-of-range (setq idx len)))
	(if (> column end-column)
	    (setq column last-column idx last-idx))
	(if (and padding (< column end-column))
	    (setq tail-padding (make-string (- end-column column) padding))))
      (setq str (substring str from-idx idx))
      (if padding
	  (concat head-padding str tail-padding)
	str))))

;;; For backward compatibility ...
;;;###autoload
(defalias 'truncate-string 'truncate-string-to-width)
(make-obsolete 'truncate-string 'truncate-string-to-width)

;;; Nested alist handler.  Nested alist is alist whose elements are
;;; also nested alist.

;; [Was defsubst]
;;;###autoload
(defun nested-alist-p (obj)
  "Return t if OBJ is a nested alist.

Nested alist is a list of the form (ENTRY . BRANCHES), where ENTRY is
any Lisp object, and BRANCHES is a list of cons cells of the form
(KEY-ELEMENT . NESTED-ALIST).

You can use a nested alist to store any Lisp object (ENTRY) for a key
sequence KEYSEQ, where KEYSEQ is a sequence of KEY-ELEMENT.  KEYSEQ
can be a string, a vector, or a list."
  (and obj (listp obj) (listp (cdr obj))))

;;;###autoload
(defun set-nested-alist (keyseq entry alist &optional len branches)
  "Set ENTRY for KEYSEQ in a nested alist ALIST.
Optional 4th arg LEN non-nil means the first LEN elements in KEYSEQ
 is considered.
Optional argument BRANCHES if non-nil is branches for a keyseq
longer than KEYSEQ.
See the documentation of `nested-alist-p' for more detail."
  (or (nested-alist-p alist)
      (error "Invalid argument %s" alist))
  (let ((islist (listp keyseq))
	(len (or len (length keyseq)))
	(i 0)
	key-elt slot)
    (while (< i len)
      (if (null (nested-alist-p alist))
	  (error "Keyseq %s is too long for this nested alist" keyseq))
      (setq key-elt (if islist (nth i keyseq) (aref keyseq i)))
      (setq slot (assoc key-elt (cdr alist)))
      (if (null slot)
	  (progn
	    (setq slot (cons key-elt (list t)))
	    (setcdr alist (cons slot (cdr alist)))))
      (setq alist (cdr slot))
      (setq i (1+ i)))
    (setcar alist entry)
    (if branches
	(if (cdr alist)
	    (error "Can't set branches for keyseq %s" keyseq)
	  (setcdr alist branches)))))

;;;###autoload
(defun lookup-nested-alist (keyseq alist &optional len start nil-for-too-long)
  "Look up key sequence KEYSEQ in nested alist ALIST.  Return the definition.
Optional 1st argument LEN specifies the length of KEYSEQ.
Optional 2nd argument START specifies index of the starting key.
The returned value is normally a nested alist of which
car part is the entry for KEYSEQ.
If ALIST is not deep enough for KEYSEQ, return number which is
 how many key elements at the front of KEYSEQ it takes
 to reach a leaf in ALIST.
Optional 3rd argument NIL-FOR-TOO-LONG non-nil means return nil
 even if ALIST is not deep enough."
  (or (nested-alist-p alist)
      (error "invalid argument %s" alist))
  (or len
      (setq len (length keyseq)))
  (let ((i (or start 0)))
    (if (catch 'lookup-nested-alist-tag
	  (if (listp keyseq)
	      (while (< i len)
		(if (setq alist (cdr (assoc (nth i keyseq) (cdr alist))))
		    (setq i (1+ i))
		  (throw 'lookup-nested-alist-tag t))))
	  (while (< i len)
	    (if (setq alist (cdr (assoc (aref keyseq i) (cdr alist))))
		(setq i (1+ i))
	      (throw 'lookup-nested-alist-tag t))))
	;; KEYSEQ is too long.
	(if nil-for-too-long nil i)
      alist)))

;; Coding system related functions.

;;;###autoload
(define-obsolete-function-alias
  'set-coding-system-alist 'modify-coding-system-alist)

(defvar eol-mnemonic-undecided ":")
(defvar eol-mnemonic-lf "(LF)")
(defvar eol-mnemonic-crlf "(CRLF)")
(defvar eol-mnemonic-cr "(CR)")

;;;###autoload
(defun coding-system-eol-type-mnemonic (coding-system)
  "Return the string indicating end-of-line format of CODING-SYSTEM."
  (let* ((eol-type (coding-system-eol-type coding-system))
	 (val (symbol-value
	       (intern (format "eol-mnemonic-%s"
			       (or eol-type
				   "undecided"))))))
    (if (stringp val)
	val
      (char-to-string val))))

;;; Following functions are defined in coding.el of kernel

;; ;;;###autoload
;; (defun coding-system-post-read-conversion (coding-system)
;;   "Return the value of CODING-SYSTEM's post-read-conversion property."
;;   (coding-system-get coding-system 'post-read-conversion))

;; ;;;###autoload
;; (defun coding-system-pre-write-conversion (coding-system)
;;   "Return the value of CODING-SYSTEM's pre-write-conversion property."
;;   (coding-system-get coding-system 'pre-write-conversion))

;;; Following functions are not implemented yet.

;; ;;;###autoload
;; (defun coding-system-translation-table-for-decode (coding-system)
;;   "Return the value of CODING-SYSTEM's translation-table-for-decode property."
;;   (coding-system-get coding-system 'translation-table-for-decode))

;; ;;;###autoload
;; (defun coding-system-translation-table-for-encode (coding-system)
;;   "Return the value of CODING-SYSTEM's translation-table-for-encode property."
;;   (coding-system-get coding-system 'translation-table-for-encode))

;; ;;;###autoload
;; (defun coding-system-equal (coding-system-1 coding-system-2)
;;   "Return t if and only if CODING-SYSTEM-1 and CODING-SYSTEM-2 are identical.
;; Two coding systems are identical if two symbols are equal
;; or one is an alias of the other."
;;   (or (eq coding-system-1 coding-system-2)
;;       (and (equal (coding-system-spec coding-system-1)
;;                   (coding-system-spec coding-system-2))
;;            (let ((eol-type-1 (coding-system-eol-type coding-system-1))
;;                  (eol-type-2 (coding-system-eol-type coding-system-2)))
;;              (or (eq eol-type-1 eol-type-2)
;;                  (and (vectorp eol-type-1) (vectorp eol-type-2)))))))

;;;###autoload
(defsubst detect-coding-with-priority (from to priority-list)
  "Detect a coding system of the text between FROM and TO with PRIORITY-LIST.
PRIORITY-LIST is an alist of coding categories vs the corresponding
coding systems ordered by priority."
  (let* ((orig-category-list (coding-priority-list))
	 (orig-category-systems (mapcar (function coding-category-system)
					orig-category-list)))
    (unwind-protect
	(let ((prio-list priority-list)
	      categories x)
	  (while prio-list
	    (setq x (car prio-list))
	    (unless (memq (car x) categories)
	      (set-coding-category-system (car x) (cdr x))
	      (setq categories (cons (car x) categories)))
	    (setq prio-list (cdr prio-list)))
	  (set-coding-priority-list (nreverse categories))
	  (detect-coding-region from to))
      ;; We must restore...
      (set-coding-priority-list orig-category-list)
      (while orig-category-list
	(set-coding-category-system (car orig-category-list)
				    (car orig-category-systems))
	(setq orig-category-list (cdr orig-category-list)
	      orig-category-systems (cdr orig-category-systems))))))

;;;###autoload
(defun detect-coding-with-language-environment (from to lang-env)
  "Detect a coding system of the text between FROM and TO with LANG-ENV.
The detection takes into account the coding system priorities for the
language environment LANG-ENV."
  (let ((coding-priority (get-language-info lang-env 'coding-priority)))
    (if coding-priority
	(detect-coding-with-priority
	 from to
	 (mapcar (function (lambda (x)
			     (cons (coding-system-category x) x)))
		 coding-priority))
      (detect-coding-region from to))))


;;; Composite character manipulations.

;; ;;;###autoload
;; (defun compose-region (start end &optional buffer)
;;   "Compose characters in the current region into one composite character.
;; From a Lisp program, pass two arguments, START to END.
;; The composite character replaces the composed characters.
;; BUFFER defaults to the current buffer if omitted."
;;   (interactive "r")
;;   (save-excursion
;;     (let ((str (buffer-substring start end)))
;;       (goto-char start)
;;       (insert (compose-string str))
;;       (delete-char (- end start)))))

;; ;;;###autoload
;; (defun decompose-region (start end &optional buffer)
;;   "Decompose any composite characters in the current region.
;; From a Lisp program, pass two arguments, START to END.
;; This converts each composite character into one or more characters,
;; the individual characters out of which the composite character was formed.
;; Non-composite characters are left as-is.  BUFFER defaults to the current
;; buffer if omitted."
;;   (interactive "r")
;;   (let ((buf (current-buffer))
;;         (cmpchar-head (char-to-string leading-code-composition)))
;;     (with-temp-buffer
;;       (insert-buffer-substring buf start end)
;;       (set-buffer-multibyte nil)
;;       (goto-char (point-min))
;;       (while (search-forward cmpchar-head nil t)
;;         (if (looking-at "[\240-\377][\240-\377][\240-\377][\240-\377]+")
;;             (let* ((from (1- (point)))
;;                    (to (match-end 0))
;;                    (str (string-as-multibyte (buffer-substring from to))))
;;               (if (cmpcharp (string-to-char str))
;;                   (progn
;;                     (delete-region from to)
;;                     (insert (string-as-unibyte (decompose-string str))))
;;                 (goto-char to)))))
;;       (set-buffer-multibyte t)
;;       (let ((tempbuf (current-buffer)))
;;         (save-excursion
;;           (set-buffer buf)
;;           (goto-char start)
;;           (delete-region start end)
;;           (insert-buffer-substring tempbuf))))))

;; ;;;###autoload
;; (defun decompose-string (string)
;;   "Decompose all composite characters in STRING."
;;   (let ((len (length string))
;;         (idx 0)
;;         (i 0)
;;         (str-list nil)
;;         ch)
;;     (while (< idx len)
;;       (setq ch (aref string idx))
;;       (if (>= ch min-composite-char)
;;           (progn
;;             (if (> idx i)
;;                 (setq str-list (cons (substring string i idx) str-list)))
;;             (setq str-list (cons (decompose-composite-char ch) str-list))
;;             (setq i (1+ idx))))
;;       (setq idx (1+ idx)))
;;     (if (not str-list)
;;         (copy-sequence string)
;;       (if (> idx i)
;;           (setq str-list (cons (substring string i idx) str-list)))
;;       (apply 'concat (nreverse str-list)))))

;; ;;;###autoload
;; (defconst reference-point-alist
;;   '((tl . 0) (tc . 1) (tr . 2)
;;     (ml . 3) (mc . 4) (mr . 5)
;;     (bl . 6) (bc . 7) (br . 8)
;;     (top-left . 0) (top-center . 1) (top-right . 2)
;;     (mid-left . 3) (mid-center . 4) (mid-right . 5)
;;     (bottom-left . 6) (bottom-center . 7) (bottom-right . 8)
;;     (0 . 0) (1 . 1) (2 . 2)
;;     (3 . 3) (4 . 4) (5 . 5)
;;     (6 . 6) (7 . 7) (8 . 8))
;;   "Alist of reference point symbols vs reference point codes.
;; Meanings of reference point codes are as follows:
;; 
;;     0----1----2 <-- ascent      0:tl or top-left
;;     |         |                 1:tc or top-center
;;     |         |                 2:tr or top-right
;;     |         |                 3:ml or mid-left
;;     |    4 <--+---- center      4:mc or mid-center
;;     |         |                 5:mr or mid-right
;; --- 3         5 <-- baseline    6:bl or bottom-left
;;     |         |                 7:bc or bottom-center
;;     6----7----8 <-- descent     8:br or bottom-right
;; 
;; Reference point symbols are to be used to specify composition rule of
;; the form \(GLOBAL-REF-POINT . NEW-REF-POINT), where GLOBAL-REF-POINT
;; is a reference point in the overall glyphs already composed, and
;; NEW-REF-POINT is a reference point in the new glyph to be added.
;; 
;; For instance, if GLOBAL-REF-POINT is 8 and NEW-REF-POINT is 1, the
;; overall glyph is updated as follows:
;; 
;;     +-------+--+ <--- new ascent
;;     |       |  |
;;     | global|  |
;;     | glyph |  |
;; --- |       |  | <--- baseline (doesn't change)
;;     +----+--+--+
;;     |    | new |
;;     |    |glyph|
;;     +----+-----+ <--- new descent
;; ")

;; Return a string for char CH to be embedded in multibyte form of
;; composite character.
;; ;;;###autoload
;; (defun compose-chars-component (ch)
;;   (if (< ch 128)
;;       (format "\240%c" (+ ch 128))
;;     (let ((str (string-as-unibyte (char-to-string ch))))
;;       (if (cmpcharp ch)
;;           (if (= (aref str 1) ?\xFF)
;;               (error "Can't compose a rule-based composition character")
;;             (substring str (if (= (aref str 1) ?\xFF) 2 1)))
;;         (aset str 0 (+ (aref str 0) ?\x20))
;;         str))))

;; ;; Return a string for composition rule RULE to be embedded in
;; ;; multibyte form of composite character.
;; (defsubst compose-chars-rule (rule)
;;   (char-to-string (+ ?\xA0
;;                      (* (cdr (assq (car rule) reference-point-alist)) 9)
;;                      (cdr (assq (cdr rule) reference-point-alist)))))

;; ;;;###autoload
;; (defun compose-chars (first-component &rest args)
;;   "Return one char string composed from the arguments.
;; For relative composition, each argument should be a non-composition character
;; or a relative-composition character.
;; For rule-based composition, Nth (where N is odd) argument should be
;; a non-composition character or a rule-based-composition character,
;; and Mth (where M is even) argument should be a composition rule.
;; A composition rule has the form \(GLOBAL-REF-POINT . NEW-REF-POINT).
;; See the documentation of `reference-point-alist' for more detail."
;;   (if (= (length args) 0)
;;       (char-to-string first-component)
;;     (let* ((with-rule (consp (car args)))
;;            (str (if (cmpcharp first-component)
;;                     (string-as-unibyte (char-to-string first-component))
;;                   (if with-rule
;;                       (concat (vector leading-code-composition ?\xFF)
;;                               (compose-chars-component first-component))
;;                     (concat (char-to-string leading-code-composition)
;;                             (compose-chars-component first-component))))))
;;       (if (and (cmpcharp first-component)
;;                (eq with-rule (/= (aref str 1) ?\xFF)))
;;           (error "%s-compostion-character is not allowed in %s composition: %c"
;;                  (if with-rule "relative" "rule-based")
;;                  (if with-rule "rule-based" "relative")
;;                  first-component))
;;       (while args
;;         (if with-rule
;;             (setq str (concat str (compose-chars-rule (car args)))
;;                   args (cdr args)))
;;         (if (cmpcharp (car args))
;;             (let ((cmp-str (string-as-unibyte (char-to-string (car args)))))
;;               (if (eq with-rule (/= (aref cmp-str 1) ?\xFF))
;;                   (error "%s-compostion-character is not allowed in %s composition: %c"
;;                          (if with-rule "relative" "rule-based")
;;                          (if with-rule "rule-based" "relative")
;;                          (car args)))
;;               (setq str (concat str (substring cmp-str
;;                                                (if with-rule 2 1)))))
;;           (setq str (concat str (compose-chars-component (car args)))))
;;         (setq args (cdr args)))
;;       (string-as-multibyte str))))

;; ;;;###autoload
;; (defun decompose-composite-char (char &optional type with-composition-rule)
;;   "Convert composite character CHAR to a sequence of the components.
;; Optional 1st arg TYPE specifies the type of sequence returned.
;; It should be `string' (default), `list', or `vector'.
;; Optional 2nd arg WITH-COMPOSITION-RULE non-nil means the returned
;; sequence contains embedded composition rules if any.  In this case, the
;; order of elements in the sequence is the same as arguments for
;; `compose-chars' to create CHAR.
;; If TYPE is omitted or is `string', composition rules are omitted
;; even if WITH-COMPOSITION-RULE is t."
;;   (or type
;;       (setq type 'string))
;;   (let* ((len (composite-char-component-count char))
;;          (i (1- len))
;;          l)
;;     (setq with-composition-rule (and with-composition-rule
;;                                     (not (eq type 'string))
;;                                     (composite-char-composition-rule-p char)))
;;     (while (> i 0)
;;       (setq l (cons (composite-char-component char i) l))
;;       (if  with-composition-rule
;;           (let ((rule (- (composite-char-composition-rule char i) ?\xA0)))
;;             (setq l (cons (cons (/ rule 9) (% rule 9)) l))))
;;       (setq i (1- i)))
;;     (setq l (cons (composite-char-component char 0) l))
;;     (cond ((eq type 'string)
;;            (apply 'string l))
;;           ((eq type 'list)
;;            l)
;;           (t                            ; i.e. TYPE is vector
;;            (vconcat l)))))

;;; mule-util.el ends here