* NEWS: Add paragraphs for CEDET and EIEIO.

[gnu-emacs] / lisp / composite.el

diff --git a/lisp/composite.el b/lisp/composite.el
index ce7ea95800b9cc039f6d8ca51ba110efee135239..4832848cb90eeb46ef670241c0be7e28ae469808 100644 (file)
--- a/lisp/composite.el
+++ b/lisp/composite.el
@@ -1,13 +1,14 @@
 ;;; composite.el --- support character composition
 
 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
 ;;; composite.el --- support character composition
 
 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,

-;;   2008, 2009
+;;   2008, 2009, 2010, 2011

 ;;   National Institute of Advanced Industrial Science and Technology (AIST)
 ;;   Registration Number H14PRO021
 
 ;; Author: Kenichi HANDA <handa@etl.go.jp>
 ;; (according to ack.texi)
 ;; Keywords: mule, multilingual, character composition
 ;;   National Institute of Advanced Industrial Science and Technology (AIST)
 ;;   Registration Number H14PRO021
 
 ;; Author: Kenichi HANDA <handa@etl.go.jp>
 ;; (according to ack.texi)
 ;; Keywords: mule, multilingual, character composition

+;; Package: emacs

 
 ;; This file is part of GNU Emacs.
 
 
 ;; This file is part of GNU Emacs.
 


@@ -44,7 +45,7 @@
 A glyph reference point symbol is to be used to specify a composition
 rule in COMPONENTS argument to such functions as `compose-region'.
 
 A glyph reference point symbol is to be used to specify a composition
 rule in COMPONENTS argument to such functions as `compose-region'.
 

-Meanings of glyph reference point codes are as follows:
+The meaning of glyph reference point codes is as follows:

 
     0----1----2 <---- ascent   0:tl or top-left
     |         |                        1:tc or top-center
 
     0----1----2 <---- ascent   0:tl or top-left
     |         |                        1:tc or top-center


@@ -77,7 +78,7 @@ follows (the point `*' corresponds to both reference points):
     +----+-----+ <--- new descent
 
 A composition rule may have the form \(GLOBAL-REF-POINT
     +----+-----+ <--- new descent
 
 A composition rule may have the form \(GLOBAL-REF-POINT

-NEW-REF-POINT XOFF YOFF), where XOFF and YOFF specifies how much
+NEW-REF-POINT XOFF YOFF), where XOFF and YOFF specify how much

 to shift NEW-REF-POINT from GLOBAL-REF-POINT.  In this case, XOFF
 and YOFF are integers in the range -100..100 representing the
 shifting percentage against the font size.")
 to shift NEW-REF-POINT from GLOBAL-REF-POINT.  In this case, XOFF
 and YOFF are integers in the range -100..100 representing the
 shifting percentage against the font size.")


@@ -210,9 +211,9 @@ of the text in the region.
 
 If it is a string, the elements are alternate characters.  In
 this case, TAB element has a special meaning.  If the first
 
 If it is a string, the elements are alternate characters.  In
 this case, TAB element has a special meaning.  If the first

-characer is TAB, the glyphs are displayed with left padding space
+character is TAB, the glyphs are displayed with left padding space

 so that no pixel overlaps with the previous column.  If the last
 so that no pixel overlaps with the previous column.  If the last

-character is TAB, the glyphs are displayed with rigth padding
+character is TAB, the glyphs are displayed with right padding

 space so that no pixel overlaps with the following column.
 
 If it is a vector or list, it is a sequence of alternate characters and
 space so that no pixel overlaps with the following column.
 
 If it is a vector or list, it is a sequence of alternate characters and


@@ -222,7 +223,7 @@ elements with previously composed N glyphs.
 
 A composition rule is a cons of global and new glyph reference point
 symbols.  See the documentation of `reference-point-alist' for more
 
 A composition rule is a cons of global and new glyph reference point
 symbols.  See the documentation of `reference-point-alist' for more

-detail.
+details.

 
 Optional 4th argument MODIFICATION-FUNC is a function to call to
 adjust the composition when it gets invalid because of a change of
 
 Optional 4th argument MODIFICATION-FUNC is a function to call to
 adjust the composition when it gets invalid because of a change of


@@ -286,9 +287,7 @@ A composition rule is a cons of glyph reference points of the form
   (let (str components)
     (if (consp (car (cdr args)))
        ;; Rule-base composition.
   (let (str components)
     (if (consp (car (cdr args)))
        ;; Rule-base composition.

-       (let ((len (length args))
-             (tail (encode-composition-components args 'nocopy)))
-
+       (let ((tail (encode-composition-components args 'nocopy)))

          (while tail
            (setq str (cons (car tail) str))
            (setq tail (nthcdr 2 tail)))
          (while tail
            (setq str (cons (car tail) str))
            (setq tail (nthcdr 2 tail)))


@@ -299,16 +298,16 @@ A composition rule is a cons of glyph reference points of the form
     (compose-string-internal str 0 (length str) components)))
 
 (defun find-composition (pos &optional limit string detail-p)
     (compose-string-internal str 0 (length str) components)))
 
 (defun find-composition (pos &optional limit string detail-p)

-  "Return information about a composition at or nearest to buffer position POS.
+  "Return information about a composition at or near buffer position POS.

 
 If the character at POS has `composition' property, the value is a list
 
 If the character at POS has `composition' property, the value is a list

-of FROM, TO, and VALID-P.
+\(FROM TO VALID-P).

 
 FROM and TO specify the range of text that has the same `composition'
 property, VALID-P is t if this composition is valid, and nil if not.
 
 If there's no composition at POS, and the optional 2nd argument LIMIT
 
 FROM and TO specify the range of text that has the same `composition'
 property, VALID-P is t if this composition is valid, and nil if not.
 
 If there's no composition at POS, and the optional 2nd argument LIMIT

-is non-nil, search for a composition toward LIMIT.
+is non-nil, search for a composition toward the position given by LIMIT.

 
 If no composition is found, return nil.
 
 
 If no composition is found, return nil.
 


@@ -316,8 +315,9 @@ Optional 3rd argument STRING, if non-nil, is a string to look for a
 composition in; nil means the current buffer.
 
 If a valid composition is found and the optional 4th argument DETAIL-P
 composition in; nil means the current buffer.
 
 If a valid composition is found and the optional 4th argument DETAIL-P

-is non-nil, the return value is a list of FROM, TO, COMPONENTS,
-RELATIVE-P, MOD-FUNC, and WIDTH.
+is non-nil, the return value is a list of the form
+
+   (FROM TO COMPONENTS RELATIVE-P MOD-FUNC WIDTH)

 
 COMPONENTS is a vector of integers, the meaning depends on RELATIVE-P.
 
 
 COMPONENTS is a vector of integers, the meaning depends on RELATIVE-P.
 


@@ -331,12 +331,12 @@ MOD-FUNC is a modification function of the composition.
 
 WIDTH is a number of columns the composition occupies on the screen.
 
 
 WIDTH is a number of columns the composition occupies on the screen.
 

-When Automatic Compostion mode is on, this function also finds a
+When Automatic Composition mode is on, this function also finds a

 chunk of text that is automatically composed.  If such a chunk is
 found closer to POS than the position that has `composition'
 chunk of text that is automatically composed.  If such a chunk is
 found closer to POS than the position that has `composition'

-property, the value is a list of FROM, TO, and a glyph gstring
-the specify how the chunk is composed.  See the function
-`composition-get-gstring' for the format of the glyph string."
+property, the value is a list of FROM, TO, and a glyph-string
+that specifies how the chunk is to be composed.  See the function
+`composition-get-gstring' for the format of the glyph-string."

   (let ((result (find-composition-internal pos limit string detail-p)))
     (if (and detail-p (> (length result) 3) (nth 2 result) (not (nth 3 result)))
        ;; This is a valid rule-base composition.
   (let ((result (find-composition-internal pos limit string detail-p)))
     (if (and detail-p (> (length result) 3) (nth 2 result) (not (nth 3 result)))
        ;; This is a valid rule-base composition.


@@ -409,27 +409,6 @@ after a sequence of character events."
 \f
 ;;; Automatic character composition.
 
 \f
 ;;; Automatic character composition.
 

-;; Copied from font-lock.el.
-(eval-when-compile
-  ;; Borrowed from lazy-lock.el.
-  ;; We use this to preserve or protect things when modifying text properties.
-  (defmacro save-buffer-state (varlist &rest body)
-    "Bind variables according to VARLIST and eval BODY restoring buffer state."
-    `(let* ,(append varlist
-                   '((modified (buffer-modified-p)) (buffer-undo-list t)
-                     (inhibit-read-only t) (inhibit-point-motion-hooks t)
-                     (inhibit-modification-hooks t)
-                     deactivate-mark buffer-file-name buffer-file-truename))
-       ,@body
-       (unless modified
-        (restore-buffer-modified-p nil))))
-  ;; Fixme: This makes bootstrapping fail with this error.
-  ;;   Symbol's function definition is void: eval-defun
-  ;;(def-edebug-spec save-buffer-state let)
-  )
-
-(put 'save-buffer-state 'lisp-indent-function 1)
-

 ;; These macros must match with C macros LGSTRING_XXX and LGLYPH_XXX in font.h
 (defsubst lgstring-header (gstring) (aref gstring 0))
 (defsubst lgstring-set-header (gstring header) (aset gstring 0 header))
 ;; These macros must match with C macros LGSTRING_XXX and LGLYPH_XXX in font.h
 (defsubst lgstring-header (gstring) (aref gstring 0))
 (defsubst lgstring-set-header (gstring header) (aset gstring 0 header))


@@ -465,8 +444,8 @@ after a sequence of character events."
 
 (defun lgstring-insert-glyph (gstring idx glyph)
   (let ((nglyphs (lgstring-glyph-len gstring))
 
 (defun lgstring-insert-glyph (gstring idx glyph)
   (let ((nglyphs (lgstring-glyph-len gstring))

-       (i idx) g)
-    (while (and (< i nglyphs) (setq g (lgstring-glyph gstring i)))
+       (i idx))
+    (while (and (< i nglyphs) (lgstring-glyph gstring i))

       (setq i (1+ i)))
     (if (= i nglyphs)
        (setq gstring (vconcat gstring (vector glyph)))
       (setq i (1+ i)))
     (if (= i nglyphs)
        (setq gstring (vconcat gstring (vector glyph)))


@@ -480,8 +459,7 @@ after a sequence of character events."
 
 (defun compose-glyph-string (gstring from to)
   (let ((glyph (lgstring-glyph gstring from))
 
 (defun compose-glyph-string (gstring from to)
   (let ((glyph (lgstring-glyph gstring from))

-       from-pos to-pos
-       ascent descent lbearing rbearing)
+       from-pos to-pos)

     (setq from-pos (lglyph-from glyph)
          to-pos (lglyph-to (lgstring-glyph gstring (1- to))))
     (lglyph-set-from-to glyph from-pos to-pos)
     (setq from-pos (lglyph-from glyph)
          to-pos (lglyph-to (lgstring-glyph gstring (1- to))))
     (lglyph-set-from-to glyph from-pos to-pos)


@@ -499,7 +477,7 @@ after a sequence of character events."
   (let ((font-object (lgstring-font gstring))
        (glyph (lgstring-glyph gstring from))
        from-pos to-pos
   (let ((font-object (lgstring-font gstring))
        (glyph (lgstring-glyph gstring from))
        from-pos to-pos

-       ascent descent lbearing rbearing)
+       ascent descent)

     (if gap
        (setq gap (floor (* (font-get font-object :size) gap)))
       (setq gap 0))
     (if gap
        (setq gap (floor (* (font-get font-object :size) gap)))
       (setq gap 0))


@@ -514,7 +492,7 @@ after a sequence of character events."
       (lglyph-set-from-to glyph from-pos to-pos)
       (let ((this-ascent (lglyph-ascent glyph))
            (this-descent (lglyph-descent glyph))
       (lglyph-set-from-to glyph from-pos to-pos)
       (let ((this-ascent (lglyph-ascent glyph))
            (this-descent (lglyph-descent glyph))

-           xoff yoff wadjust)
+           xoff yoff)

        (setq xoff (if (<= (lglyph-rbearing glyph) 0) 0
                     (- (lglyph-width glyph))))
        (if (> this-ascent 0)
        (setq xoff (if (<= (lglyph-rbearing glyph) 0) 0
                     (- (lglyph-width glyph))))
        (if (> this-ascent 0)


@@ -531,24 +509,23 @@ after a sequence of character events."
 
 (defun compose-gstring-for-graphic (gstring)
   "Compose glyph-string GSTRING for graphic display.
 
 (defun compose-gstring-for-graphic (gstring)
   "Compose glyph-string GSTRING for graphic display.

-Non-spacing characters are composed with the preceding base
+Combining characters are composed with the preceding base

 character.  If the preceding character is not a base character,
 character.  If the preceding character is not a base character,

-each non-spacing character is composed as a spacing character by
+each combining character is composed as a spacing character by

 a padding space before and/or after the character.
 
 a padding space before and/or after the character.
 

-All non-spacing characters has this function in
+All non-spacing characters have this function in

 `composition-function-table' unless overwritten."
 `composition-function-table' unless overwritten."

-  (let* ((header (lgstring-header gstring))
-        (nchars (lgstring-char-len gstring))
-        (nglyphs (lgstring-glyph-len gstring))
-        (glyph (lgstring-glyph gstring 0)))
+  (let ((nchars (lgstring-char-len gstring))
+        (nglyphs (lgstring-glyph-len gstring))
+        (glyph (lgstring-glyph gstring 0)))

     (cond
      ;; A non-spacing character not following a proper base character.
      ((= nchars 1)
       (let ((lbearing (lglyph-lbearing glyph))
            (rbearing (lglyph-rbearing glyph))
            (width (lglyph-width glyph))
     (cond
      ;; A non-spacing character not following a proper base character.
      ((= nchars 1)
       (let ((lbearing (lglyph-lbearing glyph))
            (rbearing (lglyph-rbearing glyph))
            (width (lglyph-width glyph))

-           xoff wadjust)
+           xoff)

        (if (< lbearing 0)
            (setq xoff (- lbearing))
          (setq xoff 0 lbearing 0))
        (if (< lbearing 0)
            (setq xoff (- lbearing))
          (setq xoff 0 lbearing 0))


@@ -578,8 +555,7 @@ All non-spacing characters has this function in
                 (rbearing (lglyph-rbearing glyph))
                 (lbearing (lglyph-lbearing glyph))
                 (center (/ (+ lbearing rbearing) 2))
                 (rbearing (lglyph-rbearing glyph))
                 (lbearing (lglyph-lbearing glyph))
                 (center (/ (+ lbearing rbearing) 2))

-                (gap (round (* (font-get (lgstring-font gstring) :size) 0.1)))
-                xoff yoff)
+                (gap (round (* (font-get (lgstring-font gstring) :size) 0.1))))

            (dotimes (i nchars)
              (setq glyph (lgstring-glyph gstring i))
              (when (> i 0)
            (dotimes (i nchars)
              (setq glyph (lgstring-glyph gstring i))
              (when (> i 0)


@@ -659,28 +635,26 @@ All non-spacing characters has this function in
             [nil 0 compose-gstring-for-graphic])))
   (map-char-table
    #'(lambda (key val)
             [nil 0 compose-gstring-for-graphic])))
   (map-char-table
    #'(lambda (key val)

-       (if (= val 0)
+       (if (memq val '(Mn Mc Me))

           (set-char-table-range composition-function-table key elt)))
           (set-char-table-range composition-function-table key elt)))

-   char-width-table))
+   unicode-category-table))

 
 (defun compose-gstring-for-terminal (gstring)
   "Compose glyph string GSTRING for terminal display.
 Non-spacing characters are composed with the preceding base
 character.  If the preceding character is not a base character,
 each non-spacing character is composed as a spacing character by
 
 (defun compose-gstring-for-terminal (gstring)
   "Compose glyph string GSTRING for terminal display.
 Non-spacing characters are composed with the preceding base
 character.  If the preceding character is not a base character,
 each non-spacing character is composed as a spacing character by

-a prepending a space before it."
-  (let* ((header (lgstring-header gstring))
-        (nchars (lgstring-char-len gstring))
-        (nglyphs (lgstring-glyph-len gstring))
-        (i 0)
-        (coding (lgstring-font gstring))
-        glyph)
+prepending a space before it."
+  (let ((nglyphs (lgstring-glyph-len gstring))
+        (i 0)
+        (coding (lgstring-font gstring))
+        glyph)

     (while (and (< i nglyphs)
                (setq glyph (lgstring-glyph gstring i)))
       (if (not (char-charset (lglyph-char glyph) coding))
          (progn
            ;; As the terminal doesn't support this glyph, return a
     (while (and (< i nglyphs)
                (setq glyph (lgstring-glyph gstring i)))
       (if (not (char-charset (lglyph-char glyph) coding))
          (progn
            ;; As the terminal doesn't support this glyph, return a

-           ;; gstring in which each glyph is its own graphme-cluster
+           ;; gstring in which each glyph is its own grapheme-cluster

            ;; of width 1..
            (setq i 0)
            (while (and (< i nglyphs)
            ;; of width 1..
            (setq i 0)
            (while (and (< i nglyphs)


@@ -744,63 +718,42 @@ This function is the default value of `auto-composition-function' (which see)."
          (setq func 'compose-gstring-for-terminal))
       (funcall func gstring))))
 
          (setq func 'compose-gstring-for-terminal))
       (funcall func gstring))))
 

+(put 'auto-composition-mode 'permanent-local t)
+

 (make-variable-buffer-local 'auto-composition-function)
 (make-variable-buffer-local 'auto-composition-function)

+(setq-default auto-composition-function 'auto-compose-chars)

 
 ;;;###autoload
 (define-minor-mode auto-composition-mode
   "Toggle Auto Composition mode.
 
 ;;;###autoload
 (define-minor-mode auto-composition-mode
   "Toggle Auto Composition mode.

-With ARG, turn Auto Composition mode off if and only if ARG is a non-positive
-number; if ARG is nil, toggle Auto Composition mode; anything else turns Auto
-Composition on.
+With a prefix argument ARG, enable Auto Composition mode if ARG
+is positive, and disable it otherwise.  If called from Lisp,
+enable the mode if ARG is omitted or nil.

 
 

-When Auto Composition is enabled, text characters are automatically composed
-by functions registered in `composition-function-table' (which see).
+When Auto Composition mode is enabled, text characters are
+automatically composed by functions registered in
+`composition-function-table'.

 
 You can use `global-auto-composition-mode' to turn on
 Auto Composition mode in all buffers (this is the default)."
 
 You can use `global-auto-composition-mode' to turn on
 Auto Composition mode in all buffers (this is the default)."

-  nil nil nil
-  (if noninteractive
-      (setq auto-composition-mode nil))
-  (cond (auto-composition-mode
-        (setq auto-composition-function 'auto-compose-chars))
-       (t
-        (setq auto-composition-function nil))))
-
-(defun turn-on-auto-composition-if-enabled ()
-  (if enable-multibyte-characters
-      (auto-composition-mode 1)))
+  ;; It's defined in C, this stops the d-m-m macro defining it again.
+  :variable auto-composition-mode)
+;; It's not defined with DEFVAR_PER_BUFFER though.
+(make-variable-buffer-local 'auto-composition-mode)

 
 ;;;###autoload
 
 ;;;###autoload

-(define-global-minor-mode global-auto-composition-mode
-  auto-composition-mode turn-on-auto-composition-if-enabled
-  ;; This :extra-args' appears to be the result of a naive copy&paste
-  ;; from global-font-lock-mode.
-  ;; :extra-args (dummy)
-  :initialize 'custom-initialize-delay
-  :init-value (not noninteractive)
-  :group 'auto-composition
-  :version "23.1")
-
-(defalias 'toggle-auto-composition 'auto-composition-mode)
+(define-minor-mode global-auto-composition-mode
+  "Toggle Auto Composition mode in all buffers.
+With a prefix argument ARG, enable it if ARG is positive, and
+disable it otherwise.  If called from Lisp, enable it if ARG is
+omitted or nil.

 
 

-\f
-;; The following codes are only for backward compatibility with Emacs
-;; 20.4 and earlier.
+For more information on Auto Composition mode, see
+`auto-composition-mode' ."
+  :variable (default-value 'auto-composition-mode))

 
 

-(defun decompose-composite-char (char &optional type with-composition-rule)
-  "Convert CHAR to string.
-
-If optional 2nd arg TYPE is non-nil, it is `string', `list', or
-`vector'.  In this case, CHAR is converted to string, list of CHAR, or
-vector of CHAR respectively.
-Optional 3rd arg WITH-COMPOSITION-RULE is ignored."
-  (cond ((or (null type) (eq type 'string)) (char-to-string char))
-       ((eq type 'list) (list char))
-       (t (vector char))))
-
-(make-obsolete 'decompose-composite-char 'char-to-string "21.1")
+(defalias 'toggle-auto-composition 'auto-composition-mode)

 
 \f
 
 
 \f
 

-;; arch-tag: ee703d77-1723-45d4-a31f-e9f0f867aa33

 ;;; composite.el ends here
 ;;; composite.el ends here