--- /dev/null
+/* Copyright (C) 2003, 2004, 2005, 2009
+ National Institute of Advanced Industrial Science and Technology (AIST)
+ Registration Number H15PRO112
+ See the end for copying conditions. */
+
+/***en
+
+@page pageexpr Expressions used in the m17n database
+@section expr Expressions used in the m17n database
+
+Both Input Methods and Font Layout Tables have common ways to
+represent basic terms and expressions built up with the terms.
+
+The following defines a schema for the terms and expressions, written
+in RelaxNG. (This schema file can be found at
+m17n-db-xml/MIM/expr.rng and a schema file for Input Method or Font
+Layout Table should include it.)
+
+@verbatim
+<?xml version="1.0" encoding="utf-8"?>
+
+<grammar
+ datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes"
+ xmlns:xi="http://www.w3.org/1999/XML/xinclude"
+ xmlns="http://relaxng.org/ns/structure/1.0"
+ ns="http://www.m17n.org/MIM">
+
+
+<start combine="choice">
+ <ref name="expr"/>
+</start>
+
+<define name="expr">
+ <choice>
+ <ref name="defun"/>
+ <ref name="defmacro"/>
+ <ref name="defvar"/>
+ <ref name="term"/>
+ </choice>
+</define>
+@endverbatim
+
+Expressions in the m17n database are terms, defuns that define
+functions, defmacros that define macros and defvars that define
+variables.
+
+@verbatim
+<define name="term" combine="choice">
+ <choice>
+ <ref name="integer"/>
+ <ref name="string"/>
+ <ref name="symbol"/>
+ <ref name="list"/>
+ <ref name="error"/>
+ <ref name="varref"/>
+ <ref name="funcall"/>
+ </choice>
+</define>
+
+<define name="integer">
+ <element name="integer">
+ <choice>
+ <data type="integer"/>
+ <data type="string"><param name="pattern">\?.</param></data>
+ <data type="string"><param name="pattern">[0#]x[0-9A-F]{1,6}</param></data>
+ </choice>
+ </element>
+</define>
+
+<define name="string">
+ <element name="string"><data type="string"/></element>
+</define>
+
+<define name="symbol">
+ <element name="symbol"><data type="Name"/></element>
+</define>
+
+<define name="list">
+ <element name="list">
+ <zeroOrMore><ref name="term"/></zeroOrMore>
+ </element>
+</define>
+
+<define name="error">
+ <element name="error">
+ <optional><attribute name="ename"><data type="Name"/></attribute></optional>
+ <ref name="string"/>
+ </element>
+</define>
+@endverbatim
+
+Basic terms in the m17n database are integers, strings, symbols,
+lists, variable references and function calls. The schema file for
+Input Method or Font Layout Table may define other kind of terms.
+
+Decimal character codes, hexadecimal character codes, and characters
+represented with special syntax (a question mark followed by the
+character) are also integers.
+
+@verbatim
+<define name="varref">
+ <element name="varref">
+ <attribute name="vname"><data type="Name"/></attribute><empty/>
+ </element>
+</define>
+@endverbatim
+
+A <varref> element refers to the variable whose name is
+specified with the "vname" attribute.
+
+#if EXAMPLE_CODE
+<varref vname="handled-keys">
+#endif
+
+This code referes to the variable "handled-keys".
+
+@verbatim
+<define name="defun">
+ <element name="defun">
+ <attribute name="fname"><data type="ID"/></attribute>
+ <optional>
+ <choice><ref name="args"/></choice>
+ </optional>
+ <zeroOrMore><ref name="term"/></zeroOrMore>
+ </element>
+</define>
+@endverbatim
+
+A <defun> element defines a function whose name is specified
+with the "fname" attribute.
+
+@verbatim
+<define name="args">
+ <element name="args">
+ <zeroOrMore>
+ <element name="fixed">
+ <attribute name="vname"><data type="Name"/></attribute>
+ </element>
+ </zeroOrMore>
+ <zeroOrMore>
+ <element name="optional">
+ <attribute name="vname"><data type="Name"/></attribute>
+ </element>
+ </zeroOrMore>
+ <zeroOrMore>
+ <element name="rest">
+ <attribute name="vname"><data type="Name"/></attribute>
+ </element>
+ </zeroOrMore>
+ </element>
+</define>
+@endverbatim
+
+A <args> element appears as a child element of a <defun>
+or a <defmacro>, and defines its fixed, optional and rest
+arguments.
+
+@verbatim
+<define name="defmacro">
+ <element name="defmacro">
+ <attribute name="fname"><data type="ID"/></attribute>
+ <optional>
+ <choice><ref name="args"/></choice>
+ </optional>
+ <zeroOrMore><ref name="term"/></zeroOrMore>
+ </element>
+</define>
+@endverbatim
+
+A <defmacro> element defines a macro whose name is specified
+with the "fname" attribute. Unlike <defmacro>, <args>
+must be already evaluated when the macro is called.
+
+@verbatim
+<define name="defvar">
+ <element name="defvar">
+ <attribute name="vname"><data type="ID"/></attribute>
+ <optional>
+ <ref name="description"/>
+ </optional>
+ <optional>
+ <choice>
+ <group>
+ <ref name="integer"/>
+ <optional>
+ <element name="possible-value">
+ <oneOrMore>
+ <choice>
+ <ref name="integer"/>
+ <element name="range"><ref name="integer"/><ref name="integer"/></element>
+ </choice>
+ </oneOrMore>
+ </element>
+ </optional>
+ </group>
+ <group>
+ <ref name="string"/>
+ <optional>
+ <element name="possible-value">
+ <oneOrMore>
+ <ref name="string"/>
+ </oneOrMore>
+ </element>
+ </optional>
+ </group>
+ <group>
+ <ref name="symbol"/>
+ <optional>
+ <element name="possible-value">
+ <oneOrMore>
+ <ref name="symbol"/>
+ </oneOrMore>
+ </element>
+ </optional>
+ </group>
+ </choice>
+ </optional>
+ </element>
+</define>
+@endverbatim
+
+Each <defvar> declares one variable. A variable, declared here
+or not, is referred with the attribute "vname". Two variables with
+the same "vname" attribute value cannot be declared.
+
+A <defvar> may have a <integer> a <string> or a
+<symbol> element that specifies its value. All variables are
+implicitly initialized to the integer value zero.
+
+When a <defvar> specifies a value, it may have the
+<possible-value> element that lists the possible values of the
+variable. The type (one of integer, symbol, string) of the possible
+values must be same with that of the specifeid value.
+
+When the type of the specified value is integer,
+<possible-value> may have one or more <range> elements. A
+<range> element specifies a range of integers that the variable
+can have as its value, and can be used mixed with <integer>
+elements. A <range> element has two <integer>s; the first
+one defines the minimum integer value that a variable can take, and
+the second the maximum.
+
+@verbatim
+<define name="description">
+ <element name="description">
+ <choice>
+ <element name="gettext"><text/></element>
+ <text/>
+ </choice>
+ </element>
+</define>
+@endverbatim
+
+A <description> element specifies the description text of its
+parent. The content of the element <gettext> is translated
+according to the current locale by "gettext" (if the translation is
+provided).
+
+<define name="funcall">
+ <choice>
+ <element name="funcall">
+ <attribute name="fname">
+ <data type="IDREF"/>
+ </attribute>
+ <zeroOrMore><ref name="term"/></zeroOrMore>
+ </element>
+ <ref name="predefined"/>
+ </choice>
+</define>
+
+A <funcall> element calls a function or a macro specified by the
+"fname" attribute, defined with a <defun> or a <defmacro>.
+The m17n database has some predefined functions, too.
+
+In function definitions, arguments are often restricted to a certain
+type. For example, arithmetic operations would require integers, not
+strings. The following four elements are defined to represent such
+restrictions.
+
+@verbatim
+<define name="intterm" combine="choice">
+ <choice>
+ <ref name="varref"/>
+ <ref name="integer"/>
+ <ref name="funcall"/>
+ </choice>
+</define>
+@endverbatim
+
+A <intterm> is a term whose value is an integer. That is, if a
+<varref> appears as a <intterm>, its value must be an
+integer and if a <funcall> appears as a <intterm>, it must
+return an integer. The schema file for Input Method or Font Layout
+Table may define other kind of intterms.
+
+@verbatim
+<define name="strterm">
+ <choice>
+ <ref name="varref"/>
+ <ref name="string"/>
+ <ref name="funcall"/>
+ </choice>
+</define>
+
+<define name="symterm">
+ <choice>
+ <ref name="varref"/>
+ <ref name="symbol"/>
+ <ref name="funcall"/>
+ </choice>
+</define>
+
+<define name="listterm">
+ <choice>
+ <ref name="varref"/>
+ <ref name="list"/>
+ <ref name="funcall"/>
+ </choice>
+</define>
+@endverbatim
+
+A <strterm>, <symterm> or <listterm> is a term whose
+value is a string, a symbol or a list respecivelly. That is, if a
+<varref> appears as a <strterm>, its value must be an
+string and if a <funcall> appears as a <symterm>, it must
+return a symbol.
+
+@verbatim
+<define name="predefined">
+ <choice>
+@endverbatim
+
+The m17n database has the following predefined functions.
+
+@verbatim
+ <element name="set"><attribute name="vname"><data type="Name"/></attribute><ref name="term"/></element>
+@endverbatim
+
+This element sets the value of the variable "vname" to the given term.
+The value of this funcall is the value of the term.
+
+#if EXAMPLE_CODE
+<set vname="MAX-COUNT"><integer>4</integer></set>
+#endif
+
+This code sets @c MAX-COUNT to 4.
+
+@verbatim
+ <element name="and"><oneOrMore><ref name="term"/></oneOrMore></element>
+@endverbatim
+
+This element evaluates the given terms one by one until one is
+evaluated to 0. If none is evaluated to 0, the value of this funcall
+is <integer>1</integer>. Otherwise,
+<integer>0</integer>.
+
+@verbatim
+ <element name="or"><oneOrMore><ref name="term"/></oneOrMore></element>
+@endverbatim
+
+This element evaluates the given terms one by one until one is
+evaluated not to 0. If none is evaluated not to 0, the value of this
+funcall is <integer>0</integer>. Otherwise,
+<integer>1</integer>.
+
+@verbatim
+ <element name="not"><ref name="term"/></element>
+@endverbatim
+
+If the given term is <integer>0</integer>, the value of
+this funcall is <integer>1</integer>. Otherwise,
+<integer>0</integer>.
+
+@verbatim
+ <element name="eq"><oneOrMore><ref name="term"/></oneOrMore></element>
+@endverbatim
+
+If the given terms have the same object, the value of this funcall is
+<integer>1</integer>. Otherwise,
+<integer>0</integer>.
+
+@verbatim
+ <element name="noteq"><ref name="term"/><ref name="term"/></element>
+@endverbatim
+
+If the given terms have the same object, the value of this funcall is
+<integer>0</integer>. Otherwise,
+<integer>1</integer>.
+
+@verbatim
+ <element name="equal"><ref name="term"/><ref name="term"/></element>
+@endverbatim
+
+If the first term equals to the second term, the value of this funcall
+is <integer>1</integer>. Otherwise,
+<integer>0</integer>. The equality of terms is defind as
+below: An integer equals to another integer iff they contain the same
+integer value. A string equals to another string iff they contain
+strings of the same characters. A symbol equals to another symbol iff
+they contain the same symbol. A list equals to another list iff they
+are of the same length, and the Nth element of the first list equals
+to the Nth element of the second list.
+
+@verbatim
+ <element name="match"><ref name="term"/><ref name="term"/></element>
+@endverbatim
+
+If the first term matches with second term, the value of this funcall
+is <integer>1</integer>. Otherwise,
+<integer>0</integer>. The match of two terms is defined
+as below: An integer matches with another integer iff they contain the
+same integer value. A string matches with another string iff the
+first string is a valid regular expression matching with the second
+string. A symbol matches with another symbol iff they contain the
+same symbol. A list matches with another list iff the first list is
+no longer than the second, and the Nth element of the first list
+equals to the Nth element of the second list. An error matches with
+another error iif the first eroor's error type is <symbol/> or is the
+same as the second error's error type.
+
+@endverbatim
+ <element name="lt"><ref name="intterm"/><ref name="intterm"/></element>
+ <element name="le"><ref name="intterm"/><ref name="intterm"/></element>
+ <element name="ge"><ref name="intterm"/><ref name="intterm"/></element>
+ <element name="gt"><ref name="intterm"/><ref name="intterm"/></element>
+@endverbatim
+
+These elements take two integer terms and compare them. The value of
+this funcall is <integer>1</integer> when when first
+integer is less than, less than or equal to, equal to, greater than or
+equal to, greater than, and not equal to the second value,
+respectivelly. Otherwise, <integer>0</integer>.
+
+@verbatim
+ <element name="add">
+ <optional><attribute name="vname"/></optional><oneOrMore><ref name="intterm"/></oneOrMore>
+ </element>
+ <element name="sub">
+ <optional><attribute name="vname"/></optional><oneOrMore><ref name="intterm"/></oneOrMore>
+ </element>
+ <element name="mul">
+ <optional><attribute name="vname"/></optional><oneOrMore><ref name="intterm"/></oneOrMore>
+ </element>
+ <element name="div">
+ <optional><attribute name="vname"/></optional><oneOrMore><ref name="intterm"/></oneOrMore>
+ </element>
+@endverbatim
+
+When the attribute "vname" is given, these element adds, subtracts,
+multiplies or divides the value of the variable "vname" by the given
+integer term(s), and the result becomes the value of the variable and
+the funcall. When the attribute is not given, these element adds,
+subtracts, multiplies or divides the first integer term by the rest.
+
+#if EXAMPLE_CODE
+<add vname="C-AFTER-V"><integer>1</integer></add>
+#endif
+
+This code increments @c C-AFTER-V by 1.
+
+@verbatim
+ <element name="mod">
+ <choice><group><attribute name="vname"/><ref name="intterm"/></group>
+ <group><ref name="intterm"/><ref name="intterm"/></group></choice>
+ </element>
+@endverbatim
+
+When the attribute "vname" is given, this element calculates the
+remaindar when the value of the variable "vname" is divided by the
+given integer term, and the result becomes the value of the funcall.
+When the attribute is not given, this element calculates the remaindar
+when the first integer term is divided by the second integer term.
+
+@verbatim
+ <element name="logand">
+ <optional><attribute name="vname"/></optional><oneOrMore><ref name="intterm"/></oneOrMore>
+ </element>
+ <element name="logior">
+ <optional><attribute name="vname"/></optional><oneOrMore><ref name="intterm"/></oneOrMore>
+ </element>
+ <element name="logxor">
+ <optional><attribute name="vname"/></optional><oneOrMore><ref name="intterm"/></oneOrMore>
+ </element>
+@endverbatim
+
+When the attribute "vname" is given, these elements perform "logical
+and", "logcal inclusive or", or "logical exclusive or" of the value of
+the variable "vname" and the given integer term(s). The result
+becomes the value of the funcall. When the attribute is not given,
+these elements perform "logical and", "logcal inclusive or", or
+"logical exclusive or" of the given integer term(s).
+
+@verbatim
+ <element name="lsh">
+ <choice><group><attribute name="vname"/><ref name="intterm"/></group>
+ <group><ref name="intterm"/><ref name="intterm"/></group></choice>
+ </element>
+@endverbatim
+
+When the attribute "vname" is given, this element shifts the bit in
+the value of the variable "vname" to the left by the count specified
+with the given integer term. The result becomes the value of the
+funcall. When not, this element shifts the bit in the first integer
+term to the left by the count specified with the second integer term.
+
+@verbatim
+ <element name="append">
+ <optional><attribute name="vname"/></optional>
+ <oneOrMore><ref name="term"/></oneOrMore>
+ </element>
+@endverbatim
+
+When the attribute "vname" is given, its value must be a list and that
+list is modified destructively by concatinating all the elements of
+the given terms if it is a list, or the element itself if not, in the
+specified order. When no attribute is given, a list is made by
+concatinating all the given terms in the same manner. The resulting
+list becomes the value of the funcall.
+
+@verbatim
+ <element name="concat">
+ <optional><attribute name="vname"/></optional>
+ <oneOrMore><choice><ref name="intterm"/><ref name="strterm"/><ref name="listterm"/></choice></oneOrMore>
+ </element>
+@endverbatim
+
+When the attribute "vname" is given, its value must be a string and
+that string is modified destructively by concatinating all the given
+term(s). If a term is a string term, the string is to be
+concatinated. If a term is a integer term, a string of a character
+whose code is its integer value is to be concatinated. If If a term
+is a list term, its elements must be interger terms and a string
+containing characters whose codes are their integer values is to be
+concatinated.
+
+When no attribute is given, a string is made by concatinating all the
+given term(s) in the same manner. The resulting list becomes the
+value of the funcall.
+
+@endverbatim
+ <element name="length"><choice><ref name="strterm"/><ref name="listterm"/></choice></element>
+@endverbatim
+
+This element counts the length of the given string or list term.
+
+@verbatim
+ <element name="nth">
+ <ref name="intterm"/><choice><ref name="strterm"/><ref name="listterm"/></choice>
+ </element>
+@endverbatim
+
+This element selects the N-th element of the given string or list
+term. N is given as the integer term.
+
+@verbatim
+ <element name="copy"><ref name="listterm"/></element>
+@endverbatim
+
+This element makes a copy of the given string or list term.
+
+@verbatim
+ <element name="ins"><attribute name="vname"/>
+ <ref name="intterm"/><choice><ref name="strterm"/><ref name="listterm"/></choice>
+ </element>
+@endverbatim
+
+This element inserts the given string or list term to the value of the
+variable "vname". The position to insert is given as the integer
+term.
+
+@verbatim
+ <element name="del"><attribute name="vname"/>
+ <ref name="intterm"/><ref name="intterm"/>
+ </element>
+@endverbatim
+
+This element deletes elements at the position between two integer
+terms from the value of the variable "vname".
+
+Elements below are for control structures.
+
+@verbatim
+ <element name="progn"><zeroOrMore><ref name="term"/></zeroOrMore></element>
+@endverbatim
+
+This element evaluates each of the given terms in sequence and returns
+the value of the last term.
+
+@verbatim
+ <element name="if"><ref name="term"/><ref name="term"/><optional><ref name="term"/></optional></element>
+@endverbatim
+
+If the first term is evaluated to be true, this element evaluates the
+second term. If not and if the third term exists, the third term is
+evaluated.
+
+#if EXAMPLE_CODE
+ <if>
+ <lt><varref vname="C"/><integer>0</integer></lt>
+ <progn><shift><symbol>state-init</symbol></shift></progn>
+ </if>
+#endif
+This code performs the <shift> action if the variable @c C is negative.
+
+@verbatim
+ <element name="when"><oneOrMore><ref name="term"/></oneOrMore></element>
+@endverbatim
+
+If the first term is evaluated to be true, this element evaluates the rest.
+
+@verbatim
+ <element name="cond"><oneOrMore><ref name="list"/></oneOrMore></element>
+@endverbatim
+
+This <cond> evaluates the first element of the given lists, one
+by one, and and when it finds the first list whose first element is
+evaluated to be true, other elements in the list are evaluated.
+
+#if EXAMPLE_CODE
+ <cond>
+ <list>
+ <eq><varref vname="level"/><integer>0</integer></eq>
+ <set vname="ret"><integer>1</integer></set>
+ </list>
+ <list>
+ <integer>1</integer>
+ <funcall fname="macro-cp12"/>
+ </list>
+ </cond>
+#endif
+
+This code sets the varialbe "ret" to the integer value 1 when the
+variable "level" has value 0, otherwise, calls "macro-cp12".
+
+@verbatim
+ <element name="loop"><oneOrMore><ref name="term"/></oneOrMore></element>
+@endverbatim
+
+This element repeatedly executes the given terms.
+
+@verbatim
+ <element name="while"><oneOrMore><ref name="term"/></oneOrMore></element>
+@endverbatim
+
+This element evaluate the first term and if true, evaluate the rest.
+This processs repeats until the first term becomes not true.
+
+@verbatim
+ <element name="foreach"><attribute name="vname"/>
+ <choice><ref name="strterm"/><ref name="listterm"/></choice>
+ <oneOrMore><ref name="term"/></oneOrMore>
+ </element>
+@endverbatim
+
+This element repeatedly evaluate terms for each element of the string
+or list term. The attribute "vname" specifies the varialve that the
+current element is assigned to, on each loop.
+
+@verbatim
+ <element name="break"><optional><ref name="term"/></optional></element>
+@endverbatim
+
+This element exits iterators and returns the term if it is given.
+
+@verbatim
+ <element name="return"><optional><ref name="term"/></optional></element>
+@endverbatim
+
+This element exits executions and returns the term if it is given.
+
+@verbatim
+ <element name="catch">
+ <optional><attribute name="vname"><data type="Name"/></attribute></optional>
+ <choice><ref name="symbol"/><ref name="error"/></choice>
+ <oneOrMore><ref name="term"/></oneOrMore>
+ </element>
+@endverbatim
+
+Thie element evalustes the given terms one by one, until a term
+matching with the specified symbol or error is thrown by
+>throw/<. If such an item is thrown, the value of this element
+is >integer<1>/integer<, otherwise
+>integer<0>/integer<. If the attribute "vname" is given,
+its value is set to the last evaluated term. It is the value of
+>throw/< if thrown.
+
+
+@verbatim
+ <element name="throw">
+ <choice>
+ <group><ref name="symbol"/><optional><ref name="term"/></optional></group>
+ <ref name="error"/>
+ </choice>
+ </element>
+@endverbatim
+
+This element throws to the catch for the specified symbol or eroor.
+The value of this element is the term (if any) or the symbol, or the
+error.
+
+@verbatim
+ <element name="quote"><ref name="term"/></element>
+@endverbatim
+
+This element quotes the given term.
+
+@verbatim
+ <element name="eval"><ref name="term"/></element>
+@endverbatim
+
+This element evaluates the given term.
+
+@verbatim
+ <element name="type"><ref name="term"/></element>
+ </choice>
+</define>
+
+@endverbatim
+This element shows the type of the given term. The type is
+one of the followings: <symbol>integer</symbol>, <symbol>string</symbol>,
+<symbol>symbol</symbol>, <symbol>list</symbol>, <symbol>error</symbol>.
+
+
+
@section im-format 文法と意味
以下に RelaxNG で書かれた入力メソッド定義用スキーマを示す。(このスキー
-マファイルは m17n-db-xml/MIM/mim.rng にある。) ドライバはファイルやス
-トリームから定義をロードし、プロパティリストの形式に変換する。
+マファイルは m17n-db-xml/MIMNEW/mimnew.rng にあり、
+基本的な表現や項を定義する m17n-db-xml/MIMNEW/mimnew.rng も利用する。)
@verbatim
xmlns="http://relaxng.org/ns/structure/1.0"
ns="http://www.m17n.org/MIM">
+<include href="expr.rng"/>
+
<start>
<element name="input-method">
<ref name="im-declaration"/>
-
- <optional>
- <element name="description">
- <choice>
- <text/>
- <element name="get-text"><text/> </element>
- </choice>
- </element>
- </optional>
+ <ref name="description">
<optional><element name="title"><data type="string"/></element></optional>
<optional><ref name="variable-list"/></optional>
<optional><ref name="command-list"/></optional>
<optional><ref name="module-list"/></optional>
<optional><ref name="macro-list"/></optional>
+
<optional><ref name="map-list"/></optional>
<optional><ref name="state-list"/></optional>
</element>
入力メソッドのトップレベルノードは <input-method> というタグを持つ。
-<description> エレメントは、<input-method>,
-<variable>, <command> 中に現れることができ、その内容は親要
-素を説明するテキストである。<get-text> エレメントの内容は、現在の
-ロケールに従って "gettext" によって翻訳される(翻訳文が提供されている場
-合)。
+<description> の詳細については @ref expr を参照。
<title> エレメントの内容は、この入力メソッドが有効な時スクリーン
上に表示されるテキストである。
: :
#endif
-<variable-list> はこの入力メソッドで使用される変数を宣言する。
-<command-list> はこの入力メソッドで使用されるコマンドを宣言する。
-<module-list> はこの入力メソッドで使用される外部モジュールを宣言
-する。<macro-list> はこの入力メソッドで使用されるマクロを宣言する。
+<variable-list>, <command-list>, <module-list>,
+<macro-list> は、それぞれこの入力メソッドで使用される変数、コマン
+ド、外部モジュール、マクロを宣言する。入力メソッドは
+<variable-list> で宣言されていない変数も使うことができるが、必要
+なコマンド、外部モジュール、マクロはここで宣言されなければならない。
+
<map-list> はこの入力メソッドで使用されるマップを宣言する。 入力
メソッドがそれ単体で利用されることがなく常に他の入力メソッドに読み込ま
れて用いられる場合には省略できる。<state-list> はこの入力メソッド
独で用いられるものではなく、他の入力メソッドから利用することを想定して
いる。この場合、入力メソッドを特定するために <extra-id> エレメン
トが必須である。<name> エレメントの内容が "nil" でない場合、
-<extra-id> エレメントは任意(optional)である。
+<extra-id> エレメントは省略可能(optional)である。
#if EXAMPLE_CODE
<tags>
</tags>
#endif
-<m17n-version> エレメント(任意)は、この入力メソッドが必要とする
-m17n ライブラリの最小バージョンを指定する。フォーマットは "X.Y.Z" であ
-り、X はメジャーバージョン、 Y はマイナーバージョン、Z はパッチレベルを
-表す。
+省略可能なエレメント <m17n-version> は、この入力メソッドが必要と
+するm17n ライブラリの最小バージョンを指定する。フォーマットは "X.Y.Z"
+であり、X はメジャーバージョン、 Y はマイナーバージョン、Z はパッチレベ
+ルを表す。
@subsection im-setups 入力メソッドの設定
<define name="variable-list">
<element name="variable-list">
- <zeroOrMore>
- <element name="variable">
- <attribute name="id"/>
- <optional>
- <element name="description">
- <choice>
- <text/>
- <element name="get-text"><text/></element>
- </choice>
- </element>
- </optional>
- <optional>
- <element name="value">
- <choice>
- <group>
- <attribute name="type"><value>string</value></attribute>
- <data type="string"/>
- </group>
- <group>
- <attribute name="type"><value>symbol</value></attribute>
- <data type="string"/>
- </group>
- <group>
- <attribute name="type"><value>integer</value></attribute>
- <data type="integer"/>
- </group>
- </choice>
- </element>
- </optional>
-
- <optional>
- <element name="variable-value-candidate">
- <oneOrMore>
- <choice>
- <element name="c-value">
- <choice>
- <group>
- <attribute name="type"><value>string</value></attribute>
- <data type="string"/>
- </group>
- <group>
- <attribute name="type"><value>symbol</value></attribute>
- <data type="string"/>
- </group>
- <group>
- <attribute name="type"><value>integer</value></attribute>
- <data type="integer"/>
- </group>
- </choice>
- </element>
- <element name="c-range">
- <attribute name="from"><data type="integer"/></attribute>
- <attribute name="to"><data type="integer"/></attribute>
- </element>
- </choice></oneOrMore></element>
- </optional>
- </element>
- </zeroOrMore>
+ <oneOrMore>
+ <ref name="defvar"/>
+ </oneOrMore>
</element>
</define>
@endverbatim
<variable-list> はこの入力メソッドで使用される変数を宣言する。
+<defvar> エレメントの詳細については @ref expr を参照。
-変数をデフォルト値に初期化したり、ユーザがカスタマイズしたりする場合に
-は、ここで宣言されなくてはならない。言い替えれば、デフォルト値が必要で
-あったり、可能な値が限定されていたりしない変数は、どこにでも宣言なく現
-れることができる。
+変数をデフォルト値に初期化したり、"global.mix" から継承した変数をユーザ
+がカスタマイズしたりする場合には、ここで宣言しなくてはならない。言い替
+えれば、デフォルト値が必要であったり、可能な値が限定されていたりしない
+変数は、どこにでも宣言なく現れることができる。
この宣言は二通りに利用される。一つめは新しい変数を導入するためであり、
-この場合 <variable> 中の <value> エレメントは省略できない。
-もう一つは "global.mimx" で宣言された変数を継承し、違ったデフォルト値を
-指定したり、この入力メソッド用にカスタマイズ可能にしたりするためである。
-この場合には <value> は省略できる。
-
-各 <variable> は一つの変数を宣言する。変数は、宣言されていないも
-のも含め属性 "id" によって参照される。すべての変数は暗黙のうちに整数値
-0に初期化されている。
-
-M-text である <value> は、<insert> が参照する。シンボルであ
-る <value> は直接参照されず、ライブラリが暗黙的に使用する。
-(e.g. candidates-charset). 整数値である <value> は、
-<set>, <add>, <sub>, <mul>, <div> によっ
-て設定、変更、参照され、<insert>, <select>, <undo>,
-<if>, <cond> に参照される。
-
-<variable-value-candidate> は変数が取り得る値のリストである。
-<c-value> は可能な値の一つを表しており、M-text かシンボルか整数値
-である。
-
-<c-range> は変数が取り得る整数値の範囲を示すものであり、
-<c-value> と併用できる。属性 "from" は変数のとる最小値を、"to" が
-最大値を示す。
+この場合 <defvar> 中で値を指定しなければならない。もう一つは
+"global.mimx" で宣言された変数を継承し、違ったデフォルト値を指定したり、
+この入力メソッド用にカスタマイズ可能にしたりするためである。この場合に
+は値は省略できる。
#if EXAMPLE_CODE
<variable-list>
- <variable id="precomposed">
+ <defvar id="precomposed">
<description>
<get-text>Flag to tell whether or not to generate precomposed characters.
If 1, generate precomposed characters if available (e.g. "ྲྀ"(U+0F76).
If 0, generate only decomposed characters (e.g. "ྲྀ" (U+0FB2 U+0F80).</get-text>
</description>
- <value type="integer">0</value>
- <variable-value-candidate>
- <c-value type="integer">0</c-value>
- <c-value type="integer">1</c-value>
- </variable-value-candidate>
- </variable>
+ <integer>0</value>
+ <possible-value>
+ <integer>0</value>
+ <integer>1</value>
+ </possible-value>
+ </defvar>
</variable-list>
#endif
@verbatim
-<define name="predefined-variable">
- <attribute name="type"><value>predefined</value></attribute>
- <attribute name="id">
- <choice>
- <value>handled-keys</value>
- <value>predefined-surround-text-flag
- <data type="string"><param name="pattern">@.+</param></data>
- </choice>
- </attribute>
-</define>
-
-@endverbatim
-
-Predefined-variable は属性 "type" の値が "predefiend" である変数である。
-属性 "id" の値が "handled-keys" であるとき、変数の値はその時点で処理さ
-れているキーの数である。属性 "id" の値が
-"predefined-surround-text-flag" であるとき、変数の値は -1 か -2 であり、
-それぞれサラウンドテキストがサポートしていること、そうでないことを示す。
-
-#if EXAMPLE_CODE
-<variable-reference id="handled-keys" type="predefined"/>
-#endif
-
-このコードはその時点で処理されているキーの数を参照する。
-@verbatim
-
<define name="command-list">
<element name="command-list">
- <zeroOrMore>
- <element name="command">
- <attribute name="id">
+ <oneOrMore>
+ <element name="defcmd">
+ <attribute name="cname">
<data type="ID"><param name="pattern">command-.*</param></data></attribute>
<optional>
- <element name="description">
- <choice><text/><element name="get-text"><text/></element></choice>
- </element>
+ <ref name="description"/>
</optional>
<zeroOrMore><ref name="keyseq"/></zeroOrMore>
</element>
- </zeroOrMore>
+ </oneOrMore>
</element>
</define>
+<define name="keyseq">
+ <element name="keyseq">
+ <oneOrMore>
+ <choice>
+ <ref name="strterm"/>
+ <ref name="listterm"/>
+ </choice>
+ </oneOrMore>
+ </element>
+</define>
@endverbatim
<command-list> は、この入力メソッドで使用されるコマンドを宣言する。
コマンドをデフォルトキーシーケンスに割り当てたり、ユーザがカスタマイズ
したりする場合には、ここで宣言されなくてはならない。
+各 <defcmd> はコマンドを一つ宣言する。コマンドは属性
+"cname" で参照され、その値は "command-" で始まらなくてはならない。
+<keyseq> は1個以上の listerm か stringterm を含む。
+
<variable-list> 同様、この宣言は二通りに利用される。一つめは新し
-いコマンドを導入するためであり、この場合 <command> 中の
+いコマンドを導入するためであり、この場合 <defcmd> 中の
<keyseq> エレメントは省略できない。もう一つは "global.mimx" で宣
言されたコマンドを継承し、違ったキーバインディングを指定したり、この入
力メソッド用にカスタマイズ可能にしたりするためである。この場合には
<keyseq> は省略可能である。
-各 <command> は一つのコマンドを宣言し、コマンドは属性 "id" によっ
-て参照される。
-
#if EXAMPLE_CODE
- <command-list>
- <command id="command-commit">
+ <command-list>
+ <defcmd cname="command-commit">
<description>
<get-text>Commit
- Commit the preedit text</get-text>
+Commit the preedit text</get-text>
</description>
- <keyseq><key-event>Return</key-event></keyseq>
- <keyseq><key-event>Linefeed</key-event></keyseq>
- </command>
- </command-list>
+ <keyseq><list><symbol>Return</symbol></list></keyseq>
+ <keyseq><list><symbol>Linefeed</symbol></list></keyseq>
+ </defcmd>
+ </command-list>
#endif
@verbatim
-
<define name="module-list">
<element name="module-list">
- <zeroOrMore>
+ <oneOrMore>
<element name="module">
- <attribute name="id">
- <data type="ID"><param name="pattern">module-.*</param></data>
- </attribute>
- <zeroOrMore>
- <element name="function">
- <attribute name="id">
- <data type="ID">
- <param name="pattern">function-.*</param></data>
+ <attribute name="id"><data type="string"/></attribute>
+ <oneOrMore>
+ <element name="defun">
+ <attribute name="fname">
+ <data type="ID"><param name="pattern">.*-function-.*</param></data>
</attribute>
+ <empty/>
</element>
- </zeroOrMore>
+ </oneOrMore>
</element>
- </zeroOrMore>
+ </oneOrMore>
</element>
</define>
-
-@endverbatim
+@endbatim
各 <module> エレメントは一つの外部モジュール (動的ライブラリ)を宣
言し、属性 "id" は外部モジュールの名前を表す。
-<function> エレメントはモジュールによってエクスポートされている関
-数名を示す。
-
-属性 "id" の値が "function-init" であれば、その関数はこの入力メソッド用
-の入力コンテクストが生成される際に、デフォルトの引数 (<call> の節
-参照) のみとともに呼ばれる。 "function-fini" であれば、 入力コンテクス
-トが破壊される際に、デフォルトの引数のみとともに呼ばれる。
+<defun> エレメントはモジュールによってエクスポートされている関数
+名を示す。属性 "fname" の値は、モジュール名, "-function-", 関数名を繋げ
+たものである。属性 "fname" の値が "-init" で終れば、その関数はこの入力
+メソッド用の入力コンテクストが生成される際に、デフォルトの引数 参照) の
+みとともに呼ばれる。 "-fini" で終れば、 入力コンテクストが破壊される際
+に、デフォルトの引数のみとともに呼ばれる。
#if EXAMPLE_CODE
<module-list>
- <module id="module-libmimx-anthy">
- <function id="function-convert"/>
- <function id="function-resize"/>
- <function id="function-change"/>
- <function id="function-commit"/>
- <function id="function-init"/>
- <function id="function-fini"/>
+ <module id="libmimx-anthy">
+ <defun fname="libmimx-anthy-function-convert"/>
+ <defun fname="libmimx-anthy-function-resize"/>
+ <defun fname="libmimx-anthy-function-change"/>
+ <defun fname="libmimx-anthy-function-commit"/>
+ <defun fname="libmimx-anthy-function-init"/>
+ <defun fname="libmimx-anthy-function-fini"/>
</module>
</module-list>
#endif
-このコードは外部モジュール "module-libmimx-anthy" を宣言する。この外部
-モジュール は6つの関数をエクスポートしている。
+このコードは外部モジュール "libmimx-anthy" を宣言する。この外部モジュー
+ル は6つの関数をエクスポートしている。
-@verbatim
+外部モジュールの関数は、<funcall> で呼ぶことができる。関数は、
+NULL かあるいは実行するべき <funcall> を示すリストを返す。
+
+#if EXAMPLE_CODE
+ <funcall fname="libmimx-anthy-function-resize">
+ <symbol>t</symbol>
+ </funcall>
+#endif
+
+このコードはモジュール 'libmimx-anthy' の関数 'resize' を引数
+"t" で呼ぶ。
+@verbatim
<define name="macro-list">
- <element name="macro-list" ns="http://www.m17n.org/MIM">
- <zeroOrMore>
- <element name="macro">
- <attribute name="id">
- <data type="ID"><param name="pattern">macro-.*</param></data>
- </attribute>
- <zeroOrMore><ref name="action"/></zeroOrMore>
- </element>
- </zeroOrMore>
+ <element name="macro-list">
+ <oneOrMore>
+ <ref name="defun"/>
+ </oneOrMore>
</element>
</define>
-
-@endverbatim
+@endbatim
<macro-list> はこの入力メソッドで使用されるマクロを宣言する。
-<macro> エレメントは複数の <action> をまとめてそれに名前を付ける。
-属性 "id" が <macro> の名前であり、この属性によってマクロを参照する。
+<defun> エレメントの詳細については @ref expr を参照。
+
#if EXAMPLE_CODE
<macro-list>
- <macro id="macro-forward">
- <set id="cc3">
- <predefined-nth-previous-or-following-character position="+3"/>
- </set>
- <conditional>
- : : ;; more <action>s
- </macro>
+ <defun fname="macro-delete-preceding-zw">
+ <cond>
+ <list>
+ <logior>
+ <eq><char-at><marker>@-1</marker></char-at><integer>0x200C</integer></eq>
+ <eq><char-at><marker>@-1</marker></char-at><integer>0x200D</integer></eq>
+ </logior>
+ <delete><marker>@-1</marker></delete>
+ <funcall fname="macro-delete-preceding-zw"/>
+ </list>
+ </cond>
+ </defun>
</macro-list>
+
#endif
-このコードはマクロ "macro-forward" を宣言する。
+このコードはマクロ "macro-delete-preceding-zw" を宣言する。
-@verbatim
-<define name="marker">
+@subsection im-terms 入力メソッドの項(term)
+
+m17n データベースには、入力メソッドを記述するための特別な項(term)である
+マーカ、セレクタ、キーシークエンスが定義されている。
+
+@verbatim
+<define name="term" combine="choice">
<choice>
- <ref name="predefined-marker"/>
- <ref name="user-defined-marker"/>
+ <ref name="keyseq"/>
+ <ref name="marker"/>
+ <ref name="selector"/>
</choice>
</define>
-
@endverbatim
-マーカは preediting テキスト中での文字位置を示すシンボルである。
-<mark-current-position> はマーカを特定の位置に設定する。
-<move-to-marker> と <delete-to-marker> はマーカの位置を参照
-する。
+これらの項はmimnew.rngで定義された関数内で用いられる。
@verbatim
-
-<define name="predefined-marker">
- <attribute name="position">
- <choice>
- <data type="string"><param name="pattern">@[0-9]</param>
- </data>
- <value>@first</value>
- <value>@current</value>
- <value>@last</value>
- <value>@previous</value>
- <value>@next</value>
- <value>@previous_candidate_list
- <value>@next_candidate_list
- </choice>
- </attribute>
+<define name="marker">
+ <element name="marker"><data type="string"/></element>
</define>
-
@endverbatim
-predefined-marker は @@ で始まるマーカである。 @@0, @@1, ... , @@9は、
-それぞれ 0番目, 1番目, ... , 9番目の位置を示す。@@first, @@current,
-@@last, @@previous, @@next はそれぞれ最初の、現在の、最後の、直前の、直
-後の位置を示す。@@previous_candidate_list 候補リストが変化する前の位置、
-@@next_candidate_list は候補リストが変化する際の次の位置を示す。
+マーカは preediting バッファ中での文字の位置を示すシンボルである。
+<mark> はマーカを特定の位置に設定する。<move>,
+<char-at>, <delete> はマーカの位置を参照する。
+
+@@ で始まるマーカは特別な意味を持つ。@@0, @@1, ... , @@9は、それぞれ
+preediting バッファ中で 0 番目, 1番目, ... , 9番目の位置を示す。
+@@<, @@=, @@>, @@-, @@+はそれぞれ preediting バッファ中で最初の、
+現在の、最後の、直前の、直後の位置を示す。@@[ は候補リストが変化する前
+の位置、@@] は候補リストが変化する際の次の位置を示す。
+
+@@+N と @@-N (N は正の整数) は N個前あるいは後の位置を示し、preediting
+バッファ内外の文字を指し示すために用いる。preediting バッファ中の前ある
+いは後の文字がN個より少なければ、入力スポットから数えて(N-バッファ中の
+前後の文字数)文字前あるいは後の位置を示す。
+
+これら以外のマーカは @@ で始まってはならない。
#if EXAMPLE_CODE
- <delete-to-marker position="@first"/>
+ <delete><marker>@<<marker></delete>
#endif
このコードは、バッファの最初の位置と現在の位置の間の文字を削除する。
-@verbatim
+#if EXAMPLE_CODE
+ <move><marker>T</marker></move>
+#endif
-<define name="user-defined-marker">
- <attribute name="markerID">
- <data type="string"><param name="pattern">[^@].*</param></data>
- </attribute>
+このコードは、マーカをユーザ定義の位置 T へ移動する。
+
+#if EXAMPLE_CODE
+ <char-at><marker>@-5</marker></char-at>
+#endif
+
+このコードは5文字前の文字を、preediting バッファ中であるかどうかにかか
+わらず、参照する。
+
+@verbatim
+<define name="markerterm">
+ <choice>
+ <ref name="marker"/>
+ <ref name="funcall"/>
+ <ref name="varref"/>
+ </choice>
</define>
+@endverbatim
+
+<markerterm> は、マーカを値としてもつ項である。すなわち、
+<varref> が <markerterm> として現れれば、その値はマーカでな
+くてはならず、 <funcall> が <markerterm> として現れれば、そ
+れはマーカを返さなくてはならない。
+@verbatim
+<define name="selector">
+ <element name="selector">
+ <choice>
+ <value>@first</value>
+ <value>@current</value>
+ <value>@last</value>
+ <value>@previous</value>
+ <value>@next</value>
+ <value>@previous-candidate-change</value>
+ <value>@next-candidate-change</value>
+ </choice>
+ </element>
+</define>
@endverbatim
-User-defined-marker は @@ で始まってはならない。
+セレクタは候補リスト中の位置を示し、<select> エレメント中で用いら
+れる。@@first, @@current, @@last はそれぞれ、最初の、現在の、最後の候補
+を指す。@@previous は前の候補を指す。もし今の候補が今の候補グループ中で
+の最初のものであれば、前の候補グループの最後の候補を指す。@@next は次の
+候補を指す。もし今の候補が今の候補グループ中での最後のものであれば、次
+の候補グループの最初の候補を指す。@@previous_candidate_list と
+@@next_candidate_list は、それぞれ前と後の候補グループ中で、今の候補と
+同じ候補インデックスを持つものを指す。
+
+<select> は内容として整数値をとることもできる。整数 N は、候補リスト中の
+N番目の位置を表す。
#if EXAMPLE_CODE
- <move-to-marker position="T"/>
+ <select><selector>@previous</selector></select>
#endif
-このコードは、マーカをユーザ定義の位置 T へ移動する。
+このコードは直前の候補を選択する。
@verbatim
+<define name="selectorterm">
+ <choice>
+ <ref name="selector"/>
+ <ref name="funcall"/>
+ <ref name="varref"/>
+ </choice>
+</define>
+@endverbatim
+
+<selectorterm> は、セレクタを値としてもつ項である。すなわち、
+<varref> が <selectorterm> として現れれば、その値はセレクタ
+でなくてはならず、 <funcall> が <selectorterm> として現れれ
+ば、それはセレクタを返さなくてはならない。
-<define name="predefined-nth-previous-or-following-character">
- <element name="predefined-nth-previous-or-following-character">
- <attribute name="position">
+@verbatim
+<define name="keyseq">
+ <element name="keyseq">
+ <oneOrMore>
<choice>
- <data type="negativeInteger"/>
- <data type="positiveInteger"/>
+ <ref name="strterm"/>
+ <ref name="listterm"/>
</choice>
- </attribute>
+ </oneOrMore>
</element>
</define>
-
@endverbatim
-<predefined-nth-previous-or-following-character> エレメントは、プ
-リエデットバッファ中の1文字を指定する。
-
-属性 "position" の値が負の整数 -N である場合、
-<predefined-nth-previous-or-following-character> エレメントは、プ
-リエデット中の現在の位置から N 文字前の文字である。もしプリエディット中
-で先行する文字がM (M<N) 文字しかなければ、その値は入力スポットから数え
-て (N-M) 文字前の文字となる。
+<keyseq> エレメント中の <strterm> は、キーボードから生成でき
+る文字で構成される。すなわち通常 ASCII 文字のみを含む。しかし、入力メソッ
+ドがたとえば西ヨーロッパ用キーボードを使うことを想定したものであれば、
+Latin-1 文字を含んでもよい。
-属性 "position" の値が正の整数 N である場合、この変数の値は、プリエデッ
-ト中の現在の位置から N 文字後の文字である。もしプリエディット中で後続す
-る文字がM (M<N) 文字しかなければ、その値は入力スポットから数えて (N-M)
-文字後の文字となる。
+<keyseq> エレメント中の <listterm> の各要素は、有効な文字コー
+ドを値として持つ<intterm> であるか、エレメントの内容は、関数
+minput_event_to_key () の戻り値である<symterm> でなくてはならない。
+X ウィンドウシステムの元では、 @c xev コマンドを用いて値を簡単にチェッ
+クできる。たとえば、 リターンキー、バックスペースキー、キーパッドの0の
+キーなどは、それぞれ@c Return , @c BackSpace , @c KP_0 としてあらわされ
+る。シフト、コントロール、メタ、アルト、スーパー、ハイパーも押されてい
+る場合には、それぞれS- , C- , M- , A- , s- , H- が前にこの順に置かれる。
+したがって "リターンキーをシフトしてメタしてハイパーしたもの" は@c
+(S-M-H-Return) である。"a をシフト" から "z をシフト" までは、単に A か
+ら Z として表されることに注意。したがって、 "a をシフトしてメタしてハイ
+パーしたもの" は @c M-H-A となる。
#if EXAMPLE_CODE
-<predefined-nth-previous-or-following-character position="-1"/>
+<keyseq>
+ <list>
+ <integer>0x6F</integer>
+ <symbol>S-@</symbol>
+ </list>
+</keyseq>
+
+<keyseq><string>ma</string></keyseq>
#endif
-このコードは直前の文字を参照する。
+これらは二つとも正しい入力シークエンスである。
@verbatim
-<define name="predefined-selector">
- <choice>
- <data type="string"><param name="pattern">@[0-9]</param></data>
- <value>@first</value>
- <value>@current</value>
- <value>@last</value>
- <value>@previous</value>
- <value>@next</value>
- <value>@previous_candidate_list</value>
- <value>@next_candidate_list</value>
- </choice>
+<define name="keyseqterm">
+ <choice>
+ <ref name="keyseq"/>
+ <ref name="funcall"/>
+ <ref name="varref"/>
+ </choice>
</define>
-
@endverbatim
-Predefined-selector は候補グループ中での位置を示し、<select> エレ
-メント中で用いられる。@@0, @@1, ... , @@9は、それぞれ 0番目, 1番目,
-... , 9番目の位置を指す。@@first, @@current, @@last はそれぞれ、最初の、
-現在の、最後の候補である。@@previous は前の候補を指す。もし今の候補が今
-の候補グループ中での最初のものであれば、前の候補グループの最後の候補を
-指す。@@next は次の候補を指す。もし今の候補が今の候補グループ中での最後
-のものであれば、次の候補グループの最初の候補を指す。
-@@previous_candidate_list と@@next_candidate_list は、それぞれ前と後の
-候補グループ中で、今の候補と同じ候補インデックスを持つものを指す。
-
-#if EXAMPLE_CODE
-<select selector="@previous"/>
-#endif
+<keyseqterm> は、キーシークエンスを値としてもつ項である。すなわち、
+<varref> が <keyseqterm> として現れれば、その値はキーシーク
+エンスでなくてはならず、 <funcall> が <keyseqterm> として現
+れれば、それはキーシークエンスを返さなくてはならない。
-このコードは前の候補を選択する。
@subsection immap 入力メソッドのマップとルール
@verbatim
<define name="map-list">
- <element name="map-list">
- <zeroOrMore>
+ <element name="map-list">
+ <oneOrMore>
<element name="map">
- <attribute name="id">
+ <attribute name="mname">
<data type="ID"><param name="pattern">map-.*</param></data>
</attribute>
<zeroOrMore>
<ref name="keyseq"/>
<ref name="command-reference"/>
</choice>
- <zeroOrMore><ref name="action"/></zeroOrMore>
+ <zeroOrMore><ref name="funcall"/></zeroOrMore>
</element>
</zeroOrMore>
</element>
- </zeroOrMore>
- </element>
+ </oneOrMore>
+ </element>
</define>
@endverbatim
<map-list> はこの入力メソッドで使用されるマップを宣言する。
<map> エレメントは類似のルールをまとめて名付け、入力メソッドの状
-態遷移を記述を容易にする。属性"id" が <map> の名前を示す。
+態遷移を記述を容易にする。属性"mname" が <map> の名前を示す。
<rule> エレメントが、入力シークエンス<keyseq> (または
-<command>) と入力メソッドドライバが実行する <action>、たと
-えば適当な文字を挿入する<insert> との対応を定義する。
+<command>) と入力メソッドドライバが実行する関数との対応を定義する。
+たとえばあるルールは、特定の入力キーを受け取った際、入力メソッドに適切
+な文字を挿入させる。
#if EXAMPLE_CODE
<map-list>
- <map id="map-consonant">
- <rule><keyseq keys="k"/><insert string="ཀ"/></rule>
- <rule><keyseq keys="kh"/><insert string="ཁ"/></rule>
+ <map mname="map-consonant">
+ <rule><keyseq><string>k</string></keyseq><insert><string>ཀ</string></insert></rule>
+ <rule><keyseq><string>kh</string></keyseq><insert><string>ཁ</string></insert></rule>
: :
- <rule><keyseq keys="a"/><insert string="ཨ"/></rule>
+ <rule><keyseq><string>a</string></keyseq><insert><string>ཨ</string></insert></rule>
</map>
- <map id="map-standard-stack">
+ <map mname="map-standard-stack">
: :
</map>
: :
#endif
@verbatim
-
-<define name="keyseq">
- <element name="keyseq">
- <choice>
- <attribute name="keys"><data type="string"/></attribute>
- <oneOrMore>
- <choice>
- <element name="key-event"><data type="string"/></element>
- <element name="character-code">
- <choice>
- <data type="nonNegativeInteger"><param name="pattern">[0-9]{1,7}</param></data>
- <data type="string"><param name="pattern">[0#]x[0-9A-F]{1,6}</param></data>
- <data type="string"><param name="pattern">\?.</param></data>
- </choice>
- </element>
- </choice>
- </oneOrMore>
- </choice>
- </element>
-</define>
-
-@endverbatim
-
-<keyseq> エレメント中の属性 "keys" の値は、キーボードから生成でき
-る文字で構成される。すなわち通常 ASCII 文字のみを含む。しかし、入力メソッ
-ドがたとえば西ヨーロッパ用キーボードを使うことを想定したものであれば、
-Latin-1 文字を含んでもよい。
-
-<keyevent> エレメントの内容は、関数 minput_event_to_key () の戻り
-値でなくてはならない。X ウィンドウシステムの元では、 @c xev コマンドを
-用いて値を簡単にチェックできる。たとえば、 リターンキー、バックスペース
-キー、キーパッドの0のキーなどは、それぞれ@c Return , @c BackSpace , @c
-KP_0 としてあらわされる。シフト、コントロール、メタ、アルト、スーパー、
-ハイパーも押されている場合には、それぞれS- , C- , M- , A- , s- , H- が
-前にこの順に置かれる。したがって "リターンキーをシフトしてメタしてハイ
-パーしたもの" は@c (S-M-H-Return) である。"a をシフト" から "z をシフト
-" までは、単に A から Z として表されることに注意。したがって、 "a をシ
-フトしてメタしてハイパーしたもの" は @c M-H-A となる。
-
-<character-code> エレメントの内容は、有効な文字コードでなくてはな
-らない。
-
-#if EXAMPLE_CODE
-<keyseq>
- <character-code>0x6F</character-code>
- <key-event>A-z</key-event>
-</keyseq>
-
-<keyseq keys="k"/>
-#endif
-
-これらは二つとも正しい入力シークエンスである。
-
-@verbatim
-
<define name="command-reference">
- <element name="command-reference">
- <attribute name="id"><data type="IDREF"/></attribute>
+ <element name="command">
+ <attribute name="cname"><data type="IDREF"/></attribute>
</element>
</define>
-
@endverbatim
-<command-reference> エレメントは、参照された <command> 中の
-<keyseq> がその位置に現れた場合と同じ効果を持つ。
+<command-reference> エレメントは、同じ"cname"を持つ
+<defcmd> 中の<keyseq> がその位置に現れた場合と同じ効果を持
+つ。
#if EXAMPLE_CODE
-<command-reference id="command-start"/>
+<command-reference cname="command-start"/>
#endif
このコードはコマンド "commad-start" を呼ぶ。
-@verbatim
-
-<define name="action">
- <choice>
- <ref name="insert"/>
- <ref name="delete"/>
- <ref name="select"/>
-
- <element name="show-candidates"><empty/></element>
- <element name="hide-candidates"><empty/></element>
-
- <ref name="move"/>
- <ref name="mark"/>
- <ref name="pushback"/>
-
- <element name="pop"><empty/></element>
-
- <ref name="undo"/>
-
- <element name="commit"> <empty/></element>
- <element name="unhandle"><empty/></element>
-
- <ref name="call"/>
-
- <element name="set"><ref name="set-val"/></element>
- <element name="add"><ref name="set-val"/></element>
- <element name="sub"><ref name="set-val"/></element>
- <element name="mul"><ref name="set-val"/></element>
- <element name="div"><ref name="set-val"/></element>
+@subsection imfuncalls 入力メソッドの関数
- <ref name="if"/>
- <ref name="conditional"/>
-
- <element name="macro-reference">
- <attribute name="id">
- <data type="IDREF"/>
- </attribute>
- </element>
- </choice>
-</define>
+expr.rng 中で定義されているものに加えて、m17n データベースでは入力メソッ
+ドを記述するためにいくつかの関数を用意している。
+@verbatim
+<define name="funcall" combine="choice">
+ <choice>
+ <element name="insert"><choice><ref name="intterm"/><ref name="strterm"/></choice></element>
@endverbatim
-<action>s は <rule>s 中に現れる。
-
-エレメント <show-candidates> は、入力メソッドドライバに現在の位置
-の前にある文字列に付加されている候補リストを示すように指示する。
-
-エレメント <hide-candidates> は、入力メソッドドライバに現在示され
-ている候補リストを隠すように指示する。
+<insert> エレメントは文字または M-text を現在の位置の前に挿入する。
+<insert> の内容が <strterm&glt;であれば、その値は挿入するべき
+M-text である。<intterm&glt;であれば、その値は挿入するべき文字のコー
+ドである。挿入によってマーカの位置は自動的に変更される。
-エレメント <pop> はまだ処理されていない最初のイベントをイベント
-キューから取り出し破棄する。
-
-エレメント <commit> は現在の preediting テキストを明示的にコミッ
-トする。現在の preediting テキストは、入力メソッドドライバが最初の
-<state>に遷移するたびにも、コミットされる。(@ref imstate 参照。)
-
-エレメント <unhandle> は現在の preediting テキストをコミットし、
-最新のキーを未処理として返す。
-
-エレメント <set>, <add>, <sub>, <mul>,
-<div> は変数の値をそれぞれ設定したり、加減乗除したりする。
#if EXAMPLE_CODE
-<set id="MAX-COUNT">
- <int-val>4</int-val>
-</set>
+<insert><string>á</string></insert>
+<insert><integer>225</integer></insert>
+<insert><integer>0x00E1</integer></insert>
#endif
-このコードは変数 @c MAX-COUNT の値を 4 に設定する。
-
-#if EXAMPLE_CODE
-<add id="C-AFTER-V">
- <int-val>1</int-val>
-</add>
-#endif
-
-このコードは変数 @c C-AFTER-V の値を1増やす。
-
-<macro-reference> エレメントは、参照された <macro> 中の
-<action> がその位置に現れた場合と同じ効果を持つ。
+これらのコードはいずれも同じ文字 "á" を挿入する。
@verbatim
-
-<define name="set-val">
- <attribute name="id"/>
- <ref name="expr"/>
-</define>
-
-@endverbatim
-
-属性 "id" の値として指定された変数の値を<expr>に設定し、<expr>の値だけ加減乗除する。
-
-@verbatim
-
-<define name="insert">
- <element name="insert">
- <choice>
- <attribute name="string"><data type="string"/></attribute>
- <attribute name="character">
- <choice>
- <data type="string"><param name="pattern">\?.</param></data>
- <data type="string"><param name="pattern">[0#]x[0-9A-F]{1,6}</param></data>
- <data type="nonNegativeInteger"><param name="pattern">[0-9]{1,7}</param></data>
- </choice>
- </attribute>
- <group>
- <attribute name="character-or-string"><value>variable</value></attribute>
- <ref name="variable-reference"/>
- </group>
-
- <oneOrMore>
- <element name="candidates">
- <data type="string"/>
- </element>
- </oneOrMore>
- <oneOrMore>
- <element name="list-of-candidates">
- <list>
- <zeroOrMore><data type="NMTOKEN"/></zeroOrMore></list>
- </element></oneOrMore>
- </choice>
+ <element name="insert-candidates">
+ <oneOrMore><choice><ref name="listterm"/><ref name="strterm"/></choice></oneOrMore>
</element>
-</define>
-
@endverbatim
-<insert> エレメントは、属性によって指定された文字または M-text を
-現在の位置の前に挿入する。挿入によってマーカの位置は自動的に変更される。
+<insert-candidates> エレメントは、現在の位置の直前に挿入される文
+字や文字列の候補を指定する。
-属性 "string" は挿入する M-text を指定する。属性 "character" は挿入する
-文字のコードを指定する。属性 "character-or-string" の値は変数でなくては
-ならず、その値が正しい文字コードあるいはM-textであれば挿入する。
+内容が <listterm> であれば、リストの各要素が挿入の候補となる文字
+列である。<strterm> であれば、その文字列中の各文字が候補である。
+<insert-candidates> は現在の位置の前に最初の候補を挿入する。挿入
+された文字や文字列には、候補リストと現在選択中の候補を表す情報が付加さ
+れている。
#if EXAMPLE_CODE
-<insert string="á"/>
-<insert character="225"/>
-<insert character="0x00E1"/>
-#endif
-
-これらのコードは同じ文字 "á" を挿入する。
-
-<candidates> エレメントが与えられた時には、その内容中の文字それぞ
-れが挿入される候補である。<insert> は現在の位置の直前に最初の候補
-を挿入する。挿入された文字列には、候補のリストと現在選択されている候補
-を指す情報が付加されている。
+<insert><string>$¢£¥₩</string></insert>
-<list-of-candidates> エレメントが与えられた時には、そのリスト中の
-項目それぞれが挿入される候補である。<insert> は現在の位置の直前に
-最初の候補を挿入する。挿入された文字列には、候補のリストと現在選択され
-ている候補を指す情報が付加されている。
-
-#if EXAMPLE_CODE
-<insert>
- <candidates>$¢£¥₩</candidates>
-</insert>
-
-<insert>
- <list-of-candidates>a ā á ǎ à</list-of-candidates>
-</insert>
+<insert><list>
+ <string>a</string>
+ <string>ā</string>
+ <string>á</string>
+ <string>ǎ</string>
+ <string>à</string>
+</list></insert>
#endif
-これらのコードはそれぞれ $ と a を挿入し、それに全体のリストを関係づける。
+これらのコードはそれぞれ文字 $ と文字列 a を挿入し、それに全体のリスト
+を関連づける。
@verbatim
-
-<define name="delete">
- <choice>
- <element name="delete-to-marker"><ref name="marker"/></element>
- <element name="delete-to-character-position"><data type="integer"/></element>
- <element name="delete-n-characters">
- <attribute name="n"><data type="integer"/></attribute>
- </element>
- </choice>
-</define>
-
+ <element name="delete"><choice><ref name="markerterm"/><ref name="intterm"/></choice></element>
@endverbatim
-文字の削除のためには、3種類の <action> のどれかを用いることがで
-きる。削除によってマーカの位置は自動的に変更される。
-
-<delet-to-marker> エレメントは、現在の位置と指定のマーカの間の文
-字を削除する。
+<markerterm> が与えられれば、このエレメントは、現在の位置と指定の
+マーカの間の文字を削除する。
#if EXAMPLE_CODE
-<delete-to-marker position="@first"/>
+<delete><marker>@-</marker></delete>
#endif
-このコードは属性 "position" で指定されたバッファの最初から現在の位置ま
-での文字を削除する。
+このコードは一つ前の位置から現在の位置までの文字を削除する。
-<delete-to-character-position> エレメントはその内容を文字位置とし
-て、その文字位置と現在の位置の間の文字を削除する。
+<intterm> が与えられれば、それを文字位置として、その文字位置と現
+在の位置の間の文字を削除する。
-#if EXAMPLE_CODE
-<delete-to-character-position>-3</delete-to-character-position>
-#endif
+削除によってマーカの位置は自動的に変更される。
-このコードは3つ前から現在の位置までの文字を削除する。
+@verbatim
+ <element name="select"><choice><ref name="selectorterm"/><ref name="intterm"/></choice></element>
+@endverbatim
-<delete-n-characters> エレメントは、属性"n" の値だけの数の文字を
-削除する。値 N が負であれば、現在の位置より前の N 文字を、正であれば後
-の N 文字を削除する。
+<select> エレメントはまず、現在の位置の直前の文字列が、候補リスト
+が付加されている文字列に属すかどうかを調べる。そうであれば、その文字列
+を <selectorterm> か <intterm> によって指定された候補に入れ
+換える。<intterm> が与えられた場合、その値はリスト中の順番を示す。
#if EXAMPLE_CODE
-<delete-n-characters n="+1"/>
+<select><selector>@first</selector></select>
+<select><integer>0</integer></select>
#endif
-このコードは後の文字1つを削除する。
+これらのコードはいずれもリストの最初の候補を選択する。
@verbatim
-
-<define name="select">
- <element name="select">
- <choice>
- <attribute name="selector">
- <ref name="predefined-selector"/>
- </attribute>
- <attribute name="index">
- <data type="integer"/>
- </attribute>
- <group>
- <attribute name="index"><value>variable</value></attribute>
- <ref name="variable-reference"/>
- </group>
- </choice>
- </element>
-</define>
-
+ <element name="show-candidates"><empty/></element>
@endverbatim
-<select> エレメントはまず、現在の位置の直前の文字が、候補リストが
-付加されている文字列に属すかどうかを調べる。そうであれば、その文字列を
-属性によって指定された候補に入れ換える。属性"selector" の値はいずれかの
-predefined-selector であり、候補リスト中の新しい候補を指定する。属性
-"index" の値はリスト中の順番を示し、その順番の候補が選ばれる。値が
-"variable" であった場合には、参照される変数は整数の値を持たなければなら
-ず、その値の順番の候補が選ばれる。
-
-#if EXAMPLE_CODE
-<select selector="@previous"/>
-<select index="0"/>
-#endif
-
-これらのコードはそれぞれ前の候補と最初の候補を選択する。
+<show-candidates> エレメントは、現在の位置の前にある文字列に付加
+されている候補リストを示すよう入力メソッドドライバに指示する。
@verbatim
+ <element name="hide-candidates"><empty/></element>
+@endverbatim
-<define name="move">
- <choice>
- <element name="move-to-marker"> <ref name="marker"/></element>
- <element name="move-to-character-position"> <data type="integer"/></element>
- </choice>
-</define>
+<hide-candidates> エレメントは、現在示されている候補リストを隠す
+よう入力メソッドドライバに指示する。
+@verbatim
+ <element name="move"><choice><ref name="markerterm"/><ref name="intterm"/></choice></element>
@endverbatim
-この2つの <action>s は現在の位置を移動する。
-<move-to-marker> エレメントは指定されたマーカの位置に現在の位置を
-移動する。<move-to-character-position> エレメントはその内容である
-整数値を文字位置として扱い、そこへ現在の位置を移動する。
+<move> エレメントは現在の位置を移動する。 <markerterm> が
+与えられれば、その位置に移動する。<intterm> が与えられれば、その
+値を文字位置として扱い、そこへ現在の位置を移動する。
-#if EXAMPLE_CODE
-<move-to-marker position="@previous"/>
-<move-to-character-position>0</move-to-character-position>
+#if EXAMPLE_CODE
+<move><marker>@@<</marker></move>
+<move><integer>0</integer></move>
#endif
-これらのコードはそれぞれ直前、最初の位置へ現在の位置を移動する。
+これらのコードはいずれもバッファの最初の位置へ現在の位置を移動する。
@verbatim
-
-<define name="mark">
- <element name="mark-current-position">
- <ref name="user-defined-marker"/>
- </element>
-</define>
-
+ <element name="mark"><ref name="markerterm"/></element>
@endverbatim
-<mark-current-position> エレメントは、指定のマーカを現在の位置に
-設定する。
+<mark> エレメントは、指定のマーカを現在の位置に設定する。
#if EXAMPLE_CODE
-<mark-current-position markerID="M"/>
+<mark><marker>M</marker></mark>
#endif
このコードは現在の位置にマーカ "M" を置く。
-@verbatim
-
-<define name="pushback">
- <choice>
- <element name="pushback-n-events">
- <attribute name="n"><data type="nonNegativeInteger"/></attribute>
- </element>
- <element name="pushback-keyseq"><ref name="keyseq"/></element>
- </choice>
-</define>
+@verbatim
+ <element name="pushback"><choice><ref name="keyseqterm"/><ref name="intterm"/></choice></element>
@endverbatim
-この2つの <action> はキーイベントをイベントキューに差し戻す。
-<pushback-n-events> エレメントは最新のキーイベントを差し戻す。属
-性"n" の値が正の整数ならばそれは差し戻すイベントの数である。0ならばす
-べて差し戻す。<pushback-keyseq> エレメントは、<keyseq;gt; で指
-定されたキーイベントを差し戻す。
+<pushback> エレメントはキーイベントをイベントキューに差し戻す。
+<keyseqterm> が与えられれば、指定されたキーイベントを差し戻す。
+<intterm> が与えられる場合にはその値は負であってはならない。正の
+整数 N であれば N 個のイベントを差し戻す。0ならばすべて差し戻す。
#if EXAMPLE_CODE
-<pushback-keyseq><keyseq keys="b"/></pushback-keyseq>
+<pushback><keyseq>b</keyseq></pushback>
#endif
このコードはキー "b" を戻す。
@verbatim
+ <element name="pop"><empty/></element>
+@endverbatim
-<define name="undo">
- <element name="undo">
- <optional>
- <choice>
- <attribute name="target-of-undo">
- <choice>
- <data type="positiveInteger"/>
- <data type="negativeInteger"/>
- </choice>
- </attribute>
- <ref name="variable-reference"/>
- </choice>
- </optional>
- </element>
-</define>
+<pop> エレメントはまだ処理されていない最初のイベントをイベント
+キューから取り出し破棄する。
+@verbatim
+ <element name="undo"><optional><ref name="intterm"/></optional></element>
@endverbatim
-<undo> エレメントは、属性が無いばあいには、最新の二つのキーイベン
-ト、すなわちこのコマンドによって引き起こされたものとその直前のもの、を
-キャンセルする。
-
-属性 "target-of-undo" が正の整数 NUM ならば、NUM個めから最新のものまで
-を キャンセルする。負の整数ならば最新の(- NUM) 個のイベントをキャンセル
-する。変数参照である場合には、それは0でない整数に帰着されなくてはなら
-ず、その値が上記の場合と同様に取り扱われる。
+<undo> エレメントは、<intterm> が無いばあいには最新の二つの
+キーイベント、すなわちこのコマンドによって引き起こされたものとその直前
+のもの、をキャンセルする。<intterm> が与えられる場合には、その値
+は0であってはならない。値が正の整数 N ならば、N個めから最新のものまで
+を キャンセルする。負の整数 -N ならば、最新の N 個のイベントをキャンセ
+ルする。
#if EXAMPLE_CODE
<undo target-of-undo="-1"/>
このコードは最新のイベントのみをキャンセルする。
@verbatim
-
-<define name="call">
- <element name="call">
- <attribute name="id"><data type="IDREF"/></attribute>
- <element name="function-reference">
- <attribute name="id"><data type="IDREF"/></attribute>
- </element>
- <zeroOrMore>
- <element name="argument">
- <choice>
- <group>
- <attribute name="type"><value>string</value></attribute>
- <data type="string"/>
- </group>
- <group>
- <attribute name="type"><value>integer</value></attribute>
- <choice>
- <data type="string"><param name="pattern">\?.</param></data>
- <data type="string"><param name="pattern">[0#]x[0-9A-F]{1,6}</param></data>
- <data type="nonNegativeInteger"><param name="pattern">[0-9]{1,7}</param></data>
- </choice>
- </group>
- <group>
- <attribute name="type"><value>plist</value></attribute>
- <ref name="plistObject"/>
- </group>
- <group>
- <attribute name="type"><value>symbol</value></attribute>
- <ref name="variable-reference"/>
- </group>
- </choice>
- </element>
- </zeroOrMore>
- </element>
-</define>
-
+ <element name="commit"><empty/></element>
@endverbatim
-<call> エレメントは外部モジュールの関数を呼ぶ。 関数は NULL を返
-すか、または行うべきアクションのリストを表す (#MPlist *) 型の値を返さな
-くてはならない。
-
-属性 "id" の値が外部モジュールを指定する。この値は<module-list>
-エレメント中に現われるものでなくてはならない。.
-<function-reference> エレメントが呼ぶ関数を指定する。これもまた、
-<module-list> エレメント中に現われるものでなくてはならない。.
-
-関数は (#MPlist *) 型の引数とともに呼ばれる。最初の要素のキーは #Mt で
-あり、その値は#MInputContext 型のオブジェクトへのポインタである。第二の
-要素のキーは#Msymbol であり、値は現在の状態名である。<argument>
-エレメントの内容は三つ目以降の要素の値として用いられる。それらの要素の
-キーは属性 "type" の値によって決定する。integer ならば対応するキーは
-#Minteger であり、symbol ならば、対応するキーは #Msymbol、などのように。
-
-#if EXAMPLE_CODE
-<call id="module-libmimx-anthy">
- <function-reference id="function-resize"/>
- <argument type="symbol">
- <variable-reference id="t"/>
- </argument>
-</call>
-#endif
-
-このコードは外部モジュール module-libmimx-anthy の関数 function-resize
-をシンボルである引数 "t" と共に呼ぶ。
+<commit> エレメントは現在の preediting テキストを明示的にコミッ
+トする。現在の preediting テキストは、入力メソッドドライバが最初の
+<state>に遷移するたびにも、コミットされる。(@ref imstate 参照。)
@verbatim
-
-<define name="expr">
- <choice>
- <group>
- <element name="expr">
- <attribute name="operator"><ref name="operator"/></attribute>
- <zeroOrMore><ref name="expr"/></zeroOrMore>
- </element>
- </group>
- <element name="int-val">
- <choice>
- <data type="integer"/>
- <data type="string"><param name="pattern">[0#]x[0-9A-F]{1,6}</param></data>
- <data type="string"><param name="pattern">\?.</param></data>
- </choice>
- </element>
- <ref name="predefined-nth-previous-or-following-character">
- </ref>
- <ref name="variable-reference">
- </ref>
- </choice>
-</define>
-
+ <element name="unhandle"><empty/></element>
@endverbatim
-<expr>ession とは、
- @li 演算子で結ばれた0個以上の <expr>essions
- @li 整数値
- @li 特定の位置の文字
- @li 変数
-である。
-
-#if EXAMPLE_CODE
-<expr operator="=">
- <predefined-nth-previous-or-following-character position="-1"/>
- <int-val>0x0D91</int-val>
-</expr>
-#endif
+<unhandle> エレメントは現在の preediting テキストをコミットし、
+最新のキーを未処理として返す。
-このコード全体が expression であり、2つのexpression (2行目と3行目)
-を含んでいる。
@verbatim
-
-<define name="variable-reference">
- <element name="variable-reference">
- <choice>
- <attribute name="id"/>
- <ref name="predefined-variable"/>
- </choice>
- </element>
-</define>
-
+ <element name="shift"><ref name="symterm"/></element>
+ <element name="shiftback"><empty/></element>
@endverbatim
-<variable-reference> エレメントは、参照された <variable> が
-その位置に現れた場合と同じ効果を持つ。
-
-#if EXAMPLE_CODE
-<variable-reference id="handled-keys" type="predefined"/>
-<variable-reference id="KK"/>
-#endif
+<shift> エレメントは現在のステート (@ref imstate 参照) を与えられ
+た <symterm> で指定されたものに遷移させる。<symterm> の値は
+<state-list> に現れるものでなくてはならない。<shiftback> エ
+レメントは現在のステート を直前のものに遷移させる。
@verbatim
-
-<define name="operator">
- <choice>
- <value>+</value>
- <value>-</value>
- <value>*</value>
- <value>/</value>
- <value>|</value>
- <value>&</value>
- <value>!</value>
- <value>=</value>
- <value><</value>
- <value>></value>
- <value><=</value>
- <value>>=</value>
- </choice>
-</define>
-
+ <element name="char-at"><ref name="markerterm"/></element>
@endverbatim
-これらは <expr>ession 中に現れ得る演算子である。演算子
-@c +, @c -, @c *, @c / は加減乗除を行う。@c |, @c &, @c
-! はそれぞれ OR, AND, NOT 演算子である。@c =, @c <, @c >,
-@c <=, @c >= は引数を二つとりそれらを比較する。
+<char-at> エレメントは、与えられた<markerterm>の位置にある
+preediting テキストか surrounding テキスト中の文字の文字コードである整
+数値<integer>C</integer>を返す。
@verbatim
-
-<define name="if">
- <element name="if">
- <attribute name="condition">
- <choice>
- <value>=</value>
- <value><</value>
- <value>></value>
- <value><=</value>
- <value>>=</value>
- </choice></attribute>
- <ref name="expr"/>
- <ref name="expr"/>
- <element name="if-true-action-list">
- <zeroOrMore><ref name="saction"/></zeroOrMore></element>
- <optional><element name="if-not-true-action-list">
- <zeroOrMore><ref name="saction"/></zeroOrMore></element></optional>
- </element>
-</define>
-
+ <element name="key-count"><empty/></element>
@endverbatim
-<if> エレメントは、2つの<expr> 間の関係が属性 "condition"
-を満たす場合 <if-true-action-list> の内容である <action> を
-実行する。そうでなければ、<if-not-true-action-list> があればその
-内容を実行する。
-
-
-#if EXAMPLE_CODE
-<if condition="<">
- <variable-reference id="C"/><int-val>0</int-val>
- <if-true-action-list><shift-to id="state-init"/></if-true-action-list>
-</if>
-#endif
-
-このコードは変数@c C が負の時、<shift-to> を実行する。
+<key-count> エレメントは、現在処理している文字の数を表す整数値
+<integer>N</integer> を返す。
@verbatim
+ <element name="surrounding-text-flag"><empty/></element>
-<define name="conditional">
- <element name="conditional">
- <zeroOrMore>
- <group>
- <element name="case">
- <ref name="expr"/>
- <zeroOrMore><ref name="saction"/></zeroOrMore>
- </element>
- </group>
- </zeroOrMore>
- </element>
+ </choice>
</define>
-
@endverbatim
-<conditional> エレメントは、各<case>中の<expr>を一つ
-づつ調べ、それが0 でない値をとる最初の<case>中の<saction>を
-実行する。
-
-#if EXAMPLE_CODE
-
-<conditional>
- <case>
- <expr operator="=">
- <predefined-nth-previous-or-following-character position="-2"/>
- <int-val>0x0E24</int-val>
- </expr>
- </case>
- <case>
- <int-val>1</int-val>
- <delete-n-characters n="-1"/>
- : :
- </case>
-</conditional>
-#endif
-
-このコードは、2つ前の文字の文字コードが0x0E24 (Thai character RU)でな
-い限り、二番めの<case> 中のactionを実行する。
-
+<surrounding-text-flag> はsurrounding テキストをサポートしていれ
+ば<integer>1</integer> を、そうでなければ
+<integer>0</integer> を返す。
@subsection imstate 入力メソッドの状態と遷移
@verbatim
+@verbatim
+
<define name="state-list">
<element name="state-list">
<zeroOrMore>
<element name="state">
- <attribute name="id">
+ <attribute name="sname">
<data type="ID"><param name="pattern">state-.*</param></data>
</attribute>
- <optional><element name="state-title-text"><data type="string"/></element></optional>
+ <optional><element name="title"><data type="string"/></element></optional>
<interleave>
<optional>
- <element name="state-hook"><oneOrMore><ref name="saction"/></oneOrMore></element>
+ <element name="state-hook">
+ <oneOrMore><ref name="funcall"/></oneOrMore>
+ </element>
</optional>
<optional>
<element name="catch-all-branch">
- <zeroOrMore><ref name="saction"/></zeroOrMore>
+ <zeroOrMore><ref name="funcall"/></zeroOrMore>
</element>
</optional>
<zeroOrMore>
<element name="branch">
- <attribute name="branch-selecting-map">
+ <attribute name="mname">
<data type="IDREF"/>
</attribute>
- <zeroOrMore><ref name="saction"/></zeroOrMore>
+ <zeroOrMore><ref name="funcall"/></zeroOrMore>
</element>
</zeroOrMore>
</interleave>
@endverbatim
+The input method driver is always in one of the <state>s of an
+<input-method> and may transit to another <state> when
+processing an input. The same input sequence can trigger different
+<funcall>s and produce different results in different
+<state>s.
+
入力メソッドドライバは常に一つの <state> にあり、入力を処理するこ
-とによって別の <state> に遷移することがある。異なる
-<state> では、同じ入力でも異なる<saction> を引き起こし、異
-なる結果を得ることがある。
+とによって別の <state> に遷移することがある。異なる<state>
+では、同じ入力でも異なる<funcall> を呼び、異なる結果を得ることが
+ある。
-属性 "id" が <state> の名前を示す。<state-title-text> エレ
-メントの内容は、入力メソッドがこの状態にある時スクリーン上に表示される
-テキストである。省略されている場合には <title> エレメントの内容が
-用いられる。
+属性 "sname" が <state> の名前を示す。<state> エレメントの
+子要素である <title>エレメントの内容は、入力メソッドがこの状態に
+ある時スクリーン上に表示されるテキストである。省略されている場合には
+<input-method> の子要素である <title> エレメントの内容が用
+いられる。
入力コンテクストが生成された、すなわち入力メソッドが起動された時点では
入力メソッドドライバは<state-list> エレメント中の最初の
<state> にある。
各 <state> は0以上の <branch>を持つ。各<branch> は
-<map-list> 中の各 <map> に対応する。 属性
-"branch-selecting-map" の値が<map> の属性 "id" の値を示す。入力シー
-クエンスがある<map> 中の <rule> の <keyseq> (or
-<command-reference>) 部分に合致すると、対応する <branch> を
-選択し、その <rule> の <action> に続いてその
-<branch> の<saction> を実行し、入力メソッドドライバはその
-<state> の初期状態に戻る。
-
-入力メソッドドライバが最初の <state> の初期状態になる度に、
+<map-list> 中の各 <map> のうち、属性"mname" の値が
+<branch> の属性 "mname" の値と同じであるものに対応している。入力
+シークエンスがある<map> 中の <rule> の <keyseq> (また
+は<command-reference>) 部分に合致すると、対応する <branch>
+が選択される。入力メソッドドライバはまずその <rule> の
+<funcall> を、次いでその <branch> の <funcall> を実行
+し、その後その <state> の初期状態に戻る。
+
+入力メソッドドライバは、最初の <state> の初期状態になる度に
preeditバッファ中の全ての文字をコミットし、preeditバッファを空にする。
(<commit> エレメントが指定されていなくても。)
<state-hook> エレメント (省略可能) は、入力メソッドドライバがこの
-<state> に遷移した時点で実行される<sactions> を指定する。
+<state> に遷移した時点で実行される<funcall> を指定する。
入力メソッドの入力コンテクストを生成した時点で、入力メソッドは
<state-list> の最初の <state> に遷移するため、その
-<state> の <state-hook> 中の <saction> が実行される。
+<state> の <state-hook> 中の <funcall> が実行される。
入力シークエンスが、その時点の <state> のいずれの <branch>
にも合致しない場合には、
@li <catch-all-branch> エレメントが存在すれば、
- <catch-all-branch>中の<saction>を実行する。
+ <catch-all-branch>中の<funcall>を実行する。
@li <catch-all-branch> がなければ、
入力メソッドは初期状態に遷移する。
#if EXAMPLE_CODE
-<state-list>
- <state id="state-init">
- <branch branch-selecting-map="map-consonant">
- <move-to-marker position="@first"/>
- : :
- </branch>
- <branch branch-selecting-map="map-misc"/>
- <branch branch-selecting-map="map-join">
- <shift-to id="state-join"/>
- </branch>
- </state>
- <state id="state-join">
- <branch branch-selecting-map="map-consonant">
- <move-to-marker position="@first"/>
- : :
- <shift-to id="state-init"/>
- </branch>
- <catch-all-branch>
- <shift-to id="state-init"/>
- </catch-all-branch>
- </state>
-</state-list>
+ <state-list>
+ <state sname="state-init">
+ <branch mname="map-consonant">
+ <shift><symbol>state-second</symbol></shift>
+ </branch>
+ <branch mname="map-independent"/>
+ </state>
+ <state sname="state-second">
+ <branch mname="map-underscore">
+ <shift><symbol>state-init</symbol></shift>
+ </branch>
+ <branch mname="map-dependent">
+ <shift><symbol>state-init</symbol></shift>
+ </branch>
+ <branch mname="map-ry"/>
+ </state>
+ </state-list>
#endif
このコードはある入力メソッドでの状態遷移を定義している。この入力メソッ
-ドでの<state>は、"state-init" と "state-join" の2つである。
-"state-init" には3つの <branch> があり、それぞれ
-"map-consonant", "map-misc", "map-join" に属す入力シークエンスが与えら
-れた場合に選ばれる。"map-join"の <branch> が選ばれた場合には、
-<shift-to> エレメントによって "state-join" への遷移が起こる。
-"state-join"には、"map-consonant" に属す入力シークエンスのための
-<branch> とそれ以外の全ての入力を処理する
-<catch-all-branch>があり、双方とも最後は "state-init" への遷移を
-実行する。
-
-@verbatim
-
-<define name="saction">
- <choice>
- <element name="shift-to"><attribute name="id"><data type="IDREF"/></attribute></element>
- <element name="shift-back"><empty/></element>
- <ref name="action"/>
- </choice>
-</define>
-
-@endverbatim
-
-<saction> (state-action) は <action> であるか状態遷移である。
-
-<shift-to> エレメントは現在の状態を属性 "id" の値で指示されたもの
-に遷移させる。属性の値は<state-list> に現れるものでなくてはならな
-い。<shift-back> エレメントは、現在の状態を一つ前のものに遷移さ
-せる。
-
-@subsection implist Plist
-
-<call> エレメントで用いられる plistObject は以下のように定義されている。
-
-@verbatim
-
- <define name="plistObject">
- <element name="pListObject">
- <choice>
- <ref name="array"/>
- <ref name="dict"/>
- <group>
- <attribute name="type"><value>string</value></attribute>
- <data type="string"/>
- </group>
- <group>
- <attribute name="type"><value>symbol</value></attribute>
- <ref name="variable-reference"/>
- </group>
- <group>
- <attribute name="type"><value>integer</value></attribute>
- <choice>
- <data type="string"><param name="pattern">\?.</param></data>
- <data type="string"><param name="pattern">[0#]x[0-9A-F]{1,6}</param></data>
- <data type="nonNegativeInteger"><param name="pattern">[0-9]{1,7}</param></data>
- </choice>
- </group>
- </choice>
- </element>
- </define>
-
-
- <!-- Collections -->
- <define name="array">
- <element name="array">
- <zeroOrMore>
- <ref name="plistObject"/>
- </zeroOrMore>
- </element>
- </define>
-
- <define name="dict">
- <element name="dict">
- <zeroOrMore>
- <element name="dict-item">
- <attribute name="key"/>
- <ref name="plistObject"/>
- </element>
- </zeroOrMore>
- </element>
- </define>
-@endverbatim
+ドでの<state>は、"state-init" と "state-second" の2つである。
+"state-init" には2つの <branch> があり、それぞれ"map-consonant",
+"map-independent" に対応する。"map-consonant" に属す入力シークエンスが
+与えられると、それに対応する <rule> 中の <funcall>s を実行
+した後"state-second" へ遷移する。"state-second"には、3つの
+<branch> があり、それらのうち2つはとそれ以外の全ての入力を処理す
+る最後に "state-init" への遷移を実行する。
@verbatim
</grammar>
@endverbatim
+
入力メソッド定義用の RelaxNG スキーマは、</grammar> で終わる。
@section im-seealso SEE ALSO