(ids-parse-string): Add DOC-string.
[chise/ids.git] / ids.el
1 ;;; ids.el --- Parser and utility for Ideographic Description Sequence.
2
3 ;; Copyright (C) 2001,2002 MORIOKA Tomohiko
4
5 ;; Author: MORIOKA Tomohiko <tomo@kanji.zinbun.kyoto-u.ac.jp>
6 ;; Keywords: IDS, IDC, Ideographs, UCS, Unicode
7
8 ;; This file is a part of Tomoyo-Tools.
9
10 ;; This program is free software; you can redistribute it and/or
11 ;; modify it under the terms of the GNU General Public License as
12 ;; published by the Free Software Foundation; either version 2, or (at
13 ;; your option) any later version.
14
15 ;; This program is distributed in the hope that it will be useful, but
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 ;; General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with this program; see the file COPYING.  If not, write to
22 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;; Ideographic Description Sequence (IDS) is defined in ISO/IEC
28 ;; 10646-1:2000 Annex F.
29
30 ;;; Code:
31
32 (defun ids-parse-terminal (string)
33   (if (>= (length string) 1)
34       (let* ((chr (aref string 0))
35              (ucs (get-char-attribute chr 'ucs))
36              big5)
37         (unless (and ucs (<= #x2FF0 ucs)(<= ucs #x2FFF))
38           (if (and ucs (<= #xE000 ucs)(<= ucs #xF8FF)
39                    (setq big5 (get-char-attribute chr 'chinese-big5)))
40               (setq chr (decode-char 'chinese-big5-cdp big5)))
41           (cons chr
42                 (substring string 1))))))
43
44 (defun ids-parse-op-2 (string)
45   (if (>= (length string) 1)
46       (let* ((chr (aref string 0))
47              (ucs (get-char-attribute chr 'ucs)))
48         (if (or (eq ucs #x2FF0)
49                 (eq ucs #x2FF1)
50                 (and (<= #x2FF4 ucs)(<= ucs #x2FFB)))
51             (cons chr
52                   (substring string 1))))))
53
54 (defun ids-parse-op-3 (string)
55   (if (>= (length string) 1)
56       (let ((chr (aref string 0)))
57         (if (memq chr '(?\u2FF2 ?\u2FF3))
58             (cons chr
59                   (substring string 1))))))
60
61 (defun ids-parse-component (string)
62   (let ((ret (ids-parse-element string))
63         rret)
64     (when ret
65       (if (and (listp (car ret))
66                (setq rret (ideographic-structure-find-char
67                            (cdr (assq 'ideographic-structure (car ret))))))
68           (cons rret (cdr ret))
69         ret))))
70
71 (defun ids-parse-element (string)
72   (let (ret op arg1 arg2 arg3)
73     (cond ((ids-parse-terminal string))
74           ((setq ret (ids-parse-op-2 string))
75            (setq op (car ret))
76            (when (setq ret (ids-parse-component (cdr ret)))
77              (setq arg1 (car ret))
78              (when (setq ret (ids-parse-component (cdr ret)))
79                (setq arg2 (car ret))
80                (cons (list (list 'ideographic-structure op arg1 arg2))
81                      (cdr ret)))))
82           ((setq ret (ids-parse-op-3 string))
83            (setq op (car ret))
84            (when (setq ret (ids-parse-component (cdr ret)))
85              (setq arg1 (car ret))
86              (when (setq ret (ids-parse-component (cdr ret)))
87                (setq arg2 (car ret))
88                (when (setq ret (ids-parse-component (cdr ret)))
89                  (setq arg3 (car ret))
90                  (cons (list (list 'ideographic-structure op arg1 arg2 arg3))
91                        (cdr ret)))))))))
92
93 ;;;###autoload
94 (defun ids-parse-string (ids-string)
95   "Parse IDS-STRING and return the result."
96   (let ((ret (ids-parse-element ids-string)))
97     (if (= (length (cdr ret)) 0)
98         (car ret))))
99
100 (defun ids-format-unit (ids-char)
101   (let (ret)
102     (cond ((characterp ids-char)
103            (char-to-string ids-char))
104           ((integerp ids-char)
105            (char-to-string (decode-char 'ucs ids-char)))
106           ((setq ret (find-char ids-char))
107            (char-to-string ret))
108           ((setq ret (assq 'ideographic-structure ids-char))
109            (ids-format-list (cdr ret))))))
110
111 ;;;###autoload
112 (defun ids-format-list (ids-list)
113   "Format ideographic-structure IDS-LIST as an IDS-string."
114   (mapconcat (lambda (cell)
115                (ids-format-unit
116                 (if (char-ref-p cell)
117                     (plist-get cell :char)
118                   cell)))
119              ids-list ""))
120                      
121
122 ;;; @ End.
123 ;;;
124
125 (provide 'ids)
126
127 ;;; ids.el ends here