Character(3m17n)

NAME
m17nCharacter - Character: Character objects and API for them.

  Variables: Keys of character properties
Key for script.

These symbols are used as keys of character properties.

The symbol Mscript has the name 'script' and is used as the key of a character property. The value of such a property is a symbol representing the script to which the character belongs.

Each symbol that represents a script has one of the names listed in the Unicode Technical Report #24.
MSymbol Mscript
MSymbol Mname
Key for character name.
MSymbol Mcategory
Key for general category.
MSymbol Mcombining_class
Key for canonical combining class.
MSymbol Mbidi_category
Key for bidi category.
MSymbol Msimple_case_folding
Key for corresponding single lowercase character.
MSymbol Mcomplicated_case_folding
Key for corresponding multiple lowercase characters.

  Defines
#define MCHAR_MAX
Maximum character code.

  Functions
MSymbol mchar_define_property (const char *name, MSymbol type)
Define a character property.
void * mchar_get_prop (int c, MSymbol key)
Get the value of a character property.
int mchar_put_prop (int c, MSymbol key, void *val)
Set the value of a character property.
MCharTable * mchar_get_prop_table (MSymbol key, MSymbol *type)
Get the char-table for a character property.

Detailed Description

Character objects and API for them.

The m17n library represents a character by a character code (an integer). The minimum character code is 0. The maximum character code is defined by the macro MCHAR_MAX. It is assured that MCHAR_MAX is not smaller than 0x3FFFFF (22 bits).

Characters 0 to 0x10FFFF are equivalent to the Unicode characters of the same code values.

A character can have zero or more properties called character properties. A character property consists of a key and a value, where key is a symbol and value is anything that can be cast to (void *). 'The character property that belongs to character C and whose key is K' may be shortened to 'the K property of C'.

Define Documentation

  #define MCHAR_MAX

Maximum character code.

The macro MCHAR_MAX gives the maximum character code.

Variable Documentation

  MSymbol Mbidi_category

Key for bidi category.

The symbol Mbidi_category has the name 'bidi-category' and is used as the key of a character property. The value of such a property is a symbol that represents the bidirectional category of the character.

Each symbol that represents a bidirectional category has one of the names listed as types of Bidirectional Category in Unicode.

  MSymbol Mcategory

Key for general category.

The symbol Mcategory has the name 'category' and is used as the key of a character property. The value of such a property is a symbol representing the general category of the character.

Each symbol that represents a general category has one of the names listed as abbreviations for General Category in Unicode.

  MSymbol Mcombining_class

Key for canonical combining class.

The symbol Mcombining_class has the name 'combining-class' and is used as the key of a character property. The value of such a property is an integer that represents the canonical combining class of the character.

The meaning of each integer that represents a canonical combining class is identical to the one defined in Unicode.

  MSymbol Mcomplicated_case_folding

Key for corresponding multiple lowercase characters.

The symbol Mcomplicated_case_folding has the name 'complicated-case-folding' and is used as the key of a character property. The value of such a property is the corresponding M-text that contains a sequence of lowercase characters to be used for comparing M-texts ignoring case.

  MSymbol Mname

Key for character name.

The symbol Mname has the name 'name' and is used as the key of a character property. The value of such a property is a C-string representing the name of the character.

  MSymbol Msimple_case_folding

Key for corresponding single lowercase character.

The symbol Msimple_case_folding has the name 'simple-case-folding' and is used as the key of a character property. The value of such a property is the corresponding single lowercase character that is used when comparing M-texts ignoring cases.

If a character requires a complicated comparison (i.e. cannot be compared by simply mapping to another single character), the value of such a property is 0xFFFF. In this case, the character has another property whose key is Mcomplicated_case_folding.

COPYRIGHT
Copyright (C) 2001 Information-technology Promotion Agency (IPA)
Copyright (C) 2001-2008 National Institute of Advanced Industrial Science and Technology (AIST)
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License <http://www.gnu.org/licenses/fdl.html>.