Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

Helper


Classes

class  Attribute
 Class to store the string attributes. More...

struct  KeyEvent
 The class to store a keyboard event. More...

class  Exception
 A base class of all other exception classes. More...

class  IConvert
 A class to convert strings between UCS-4 and local encodings. More...

class  LookupTable
 The base class of lookup table. More...

class  CommonLookupTable
 A common lookup table class. More...

class  ModuleError
class  Module
class  ReferencedObject
 Reference counted base class. More...

class  Pointer
 Smart pointer template class. More...

class  SocketError
class  SocketAddress
class  Socket
class  SocketServer
class  SocketClient
class  SocketTransactionError
class  SocketTransaction
class  ReferencedObject
 Reference counted base class. More...

class  Pointer
 Smart pointer template class. More...


Equality operators

template<typename T1, typename T2> bool scim::operator== (const Pointer< T1 > &t1, const Pointer< T2 > &t2)
template<typename T1, typename T2> bool scim::operator!= (const Pointer< T1 > &t1, const Pointer< T2 > &t2)

C++-style casting functions

template<typename To, typename From> Pointer< To > scim::cast_const (const Pointer< From > &from)
template<typename To, typename From> Pointer< To > scim::cast_dynamic (const Pointer< From > &from)
template<typename To, typename From> Pointer< To > scim::cast_static (const Pointer< From > &from)

Defines

#define SCIM_MAX_BUFSIZE   4096
#define SCIM_LOOKUP_TABLE_MAX_PAGESIZE   16
#define SCIM_PATH_DELIM_STRING   "/"
#define SCIM_PATH_DELIM   '/'
#define RET_ILSEQ   0
#define RET_TOOFEW(n)   (-1-(n))
#define RET_TOOSMALL   -1
#define BAD_WCHAR   ((ucs4_t) 0xfffd)
#define BAD_CHAR   '?'

Typedefs

typedef std::vector< Attribute > scim::AttributeList
 The container to store a set of Attribute objects.

typedef std::vector< KeyEvent > scim::KeyEventList
 The container to store a set of KeyEvent objects.

typedef Slot2< void, SocketServer *,
const Socket & > 
scim::SocketServerSlotSocket
typedef Signal2< void, SocketServer *,
const Socket & > 
scim::SocketServerSignalSocket

Enumerations

enum  scim::AttributeType { scim::SCIM_ATTR_NONE, scim::SCIM_ATTR_UNDERLINE, scim::SCIM_ATTR_HIGHLIGHT, scim::SCIM_ATTR_REVERSE }
 Enum values of the valid attributes. More...

enum  scim::KeyMask {
  scim::SCIM_KEY_NullMask = 0, scim::SCIM_KEY_ShiftMask = (1<<0), scim::SCIM_KEY_LockMask = (1<<1), scim::SCIM_KEY_CapsLockMask = (1<<1),
  scim::SCIM_KEY_ControlMask = (1<<2), scim::SCIM_KEY_AltMask = (1<<3), scim::SCIM_KEY_Mod1Mask = (1<<3), scim::SCIM_KEY_Mod2Mask = (1<<4),
  scim::SCIM_KEY_NumLockMask = (1<<4), scim::SCIM_KEY_Mod3Mask = (1<<5), scim::SCIM_KEY_Mod4Mask = (1<<6), scim::SCIM_KEY_Mod5Mask = (1<<7),
  scim::SCIM_KEY_ScrollLockMask = (1<<7), scim::SCIM_KEY_ReleaseMask = (1<<30)
}
 Enum values of all valid key masks. More...

enum  scim::KeyCode {
  scim::SCIM_KEY_NullKey = 0, scim::SCIM_KEY_Shift_L = 0xFFE1, scim::SCIM_KEY_Shift_R = 0xFFE2, scim::SCIM_KEY_Control_L = 0xFFE3,
  scim::SCIM_KEY_Control_R = 0xFFE4, scim::SCIM_KEY_Caps_Lock = 0xFFE5, scim::SCIM_KEY_Shift_Lock = 0xFFE6, scim::SCIM_KEY_Meta_L = 0xFFE7,
  scim::SCIM_KEY_Meta_R = 0xFFE8, scim::SCIM_KEY_Alt_L = 0xFFE9, scim::SCIM_KEY_Alt_R = 0xFFEA, scim::SCIM_KEY_Super_L = 0xFFEB,
  scim::SCIM_KEY_Super_R = 0xFFEC, scim::SCIM_KEY_Hyper_L = 0xFFED, scim::SCIM_KEY_Hyper_R = 0xFFEE, scim::SCIM_KEY_BackSpace = 0xFF08,
  scim::SCIM_KEY_Tab = 0xFF09, scim::SCIM_KEY_Linefeed = 0xFF0A, scim::SCIM_KEY_Clear = 0xFF0B, scim::SCIM_KEY_Return = 0xFF0D,
  scim::SCIM_KEY_Pause = 0xFF13, scim::SCIM_KEY_Scroll_Lock = 0xFF14, scim::SCIM_KEY_Sys_Req = 0xFF15, scim::SCIM_KEY_Escape = 0xFF1B,
  scim::SCIM_KEY_Delete = 0xFFFF, scim::SCIM_KEY_Multi_key = 0xFF20, scim::SCIM_KEY_Codeinput = 0xFF37, scim::SCIM_KEY_SingleCandidate = 0xFF3C,
  scim::SCIM_KEY_MultipleCandidate = 0xFF3D, scim::SCIM_KEY_PreviousCandidate = 0xFF3E, scim::SCIM_KEY_Kanji = 0xFF21, scim::SCIM_KEY_Muhenkan = 0xFF22,
  scim::SCIM_KEY_Henkan_Mode = 0xFF23, scim::SCIM_KEY_Henkan = 0xFF23, scim::SCIM_KEY_Romaji = 0xFF24, scim::SCIM_KEY_Hiragana = 0xFF25,
  scim::SCIM_KEY_Katakana = 0xFF26, scim::SCIM_KEY_Hiragana_Katakana = 0xFF27, scim::SCIM_KEY_Zenkaku = 0xFF28, scim::SCIM_KEY_Hankaku = 0xFF29,
  scim::SCIM_KEY_Zenkaku_Hankaku = 0xFF2A, scim::SCIM_KEY_Touroku = 0xFF2B, scim::SCIM_KEY_Massyo = 0xFF2C, scim::SCIM_KEY_Kana_Lock = 0xFF2D,
  scim::SCIM_KEY_Kana_Shift = 0xFF2E, scim::SCIM_KEY_Eisu_Shift = 0xFF2F, scim::SCIM_KEY_Eisu_toggle = 0xFF30, scim::SCIM_KEY_Kanji_Bangou = 0xFF37,
  scim::SCIM_KEY_Zen_Koho = 0xFF3D, scim::SCIM_KEY_Mae_Koho = 0xFF3E, scim::SCIM_KEY_Home = 0xFF50, scim::SCIM_KEY_Left = 0xFF51,
  scim::SCIM_KEY_Up = 0xFF52, scim::SCIM_KEY_Right = 0xFF53, scim::SCIM_KEY_Down = 0xFF54, scim::SCIM_KEY_Prior = 0xFF55,
  scim::SCIM_KEY_Page_Up = 0xFF55, scim::SCIM_KEY_Next = 0xFF56, scim::SCIM_KEY_Page_Down = 0xFF56, scim::SCIM_KEY_End = 0xFF57,
  scim::SCIM_KEY_Begin = 0xFF58, scim::SCIM_KEY_Select = 0xFF60, scim::SCIM_KEY_Print = 0xFF61, scim::SCIM_KEY_Execute = 0xFF62,
  scim::SCIM_KEY_Insert = 0xFF63, scim::SCIM_KEY_Undo = 0xFF65, scim::SCIM_KEY_Redo = 0xFF66, scim::SCIM_KEY_Menu = 0xFF67,
  scim::SCIM_KEY_Find = 0xFF68, scim::SCIM_KEY_Cancel = 0xFF69, scim::SCIM_KEY_Help = 0xFF6A, scim::SCIM_KEY_Break = 0xFF6B,
  scim::SCIM_KEY_Mode_switch = 0xFF7E, scim::SCIM_KEY_Num_Lock = 0xFF7F, scim::SCIM_KEY_KP_Space = 0xFF80, scim::SCIM_KEY_KP_Tab = 0xFF89,
  scim::SCIM_KEY_KP_Enter = 0xFF8D, scim::SCIM_KEY_KP_F1 = 0xFF91, scim::SCIM_KEY_KP_F2 = 0xFF92, scim::SCIM_KEY_KP_F3 = 0xFF93,
  scim::SCIM_KEY_KP_F4 = 0xFF94, scim::SCIM_KEY_KP_Home = 0xFF95, scim::SCIM_KEY_KP_Left = 0xFF96, scim::SCIM_KEY_KP_Up = 0xFF97,
  scim::SCIM_KEY_KP_Right = 0xFF98, scim::SCIM_KEY_KP_Down = 0xFF99, scim::SCIM_KEY_KP_Prior = 0xFF9A, scim::SCIM_KEY_KP_Page_Up = 0xFF9A,
  scim::SCIM_KEY_KP_Next = 0xFF9B, scim::SCIM_KEY_KP_Page_Down = 0xFF9B, scim::SCIM_KEY_KP_End = 0xFF9C, scim::SCIM_KEY_KP_Begin = 0xFF9D,
  scim::SCIM_KEY_KP_Insert = 0xFF9E, scim::SCIM_KEY_KP_Delete = 0xFF9F, scim::SCIM_KEY_KP_Equal = 0xFFBD, scim::SCIM_KEY_KP_Multiply = 0xFFAA,
  scim::SCIM_KEY_KP_Add = 0xFFAB, scim::SCIM_KEY_KP_Separator = 0xFFAC, scim::SCIM_KEY_KP_Subtract = 0xFFAD, scim::SCIM_KEY_KP_Decimal = 0xFFAE,
  scim::SCIM_KEY_KP_Divide = 0xFFAF, scim::SCIM_KEY_KP_0 = 0xFFB0, scim::SCIM_KEY_KP_1 = 0xFFB1, scim::SCIM_KEY_KP_2 = 0xFFB2,
  scim::SCIM_KEY_KP_3 = 0xFFB3, scim::SCIM_KEY_KP_4 = 0xFFB4, scim::SCIM_KEY_KP_5 = 0xFFB5, scim::SCIM_KEY_KP_6 = 0xFFB6,
  scim::SCIM_KEY_KP_7 = 0xFFB7, scim::SCIM_KEY_KP_8 = 0xFFB8, scim::SCIM_KEY_KP_9 = 0xFFB9, scim::SCIM_KEY_F1 = 0xFFBE,
  scim::SCIM_KEY_F2 = 0xFFBF, scim::SCIM_KEY_F3 = 0xFFC0, scim::SCIM_KEY_F4 = 0xFFC1, scim::SCIM_KEY_F5 = 0xFFC2,
  scim::SCIM_KEY_F6 = 0xFFC3, scim::SCIM_KEY_F7 = 0xFFC4, scim::SCIM_KEY_F8 = 0xFFC5, scim::SCIM_KEY_F9 = 0xFFC6,
  scim::SCIM_KEY_F10 = 0xFFC7, scim::SCIM_KEY_F11 = 0xFFC8, scim::SCIM_KEY_F12 = 0xFFC9, scim::SCIM_KEY_space = 0x020,
  scim::SCIM_KEY_exclam = 0x021, scim::SCIM_KEY_quotedbl = 0x022, scim::SCIM_KEY_numbersign = 0x023, scim::SCIM_KEY_dollar = 0x024,
  scim::SCIM_KEY_percent = 0x025, scim::SCIM_KEY_ampersand = 0x026, scim::SCIM_KEY_apostrophe = 0x027, scim::SCIM_KEY_quoteright = 0x027,
  scim::SCIM_KEY_parenleft = 0x028, scim::SCIM_KEY_parenright = 0x029, scim::SCIM_KEY_asterisk = 0x02a, scim::SCIM_KEY_plus = 0x02b,
  scim::SCIM_KEY_comma = 0x02c, scim::SCIM_KEY_minus = 0x02d, scim::SCIM_KEY_period = 0x02e, scim::SCIM_KEY_slash = 0x02f,
  scim::SCIM_KEY_0 = 0x030, scim::SCIM_KEY_1 = 0x031, scim::SCIM_KEY_2 = 0x032, scim::SCIM_KEY_3 = 0x033,
  scim::SCIM_KEY_4 = 0x034, scim::SCIM_KEY_5 = 0x035, scim::SCIM_KEY_6 = 0x036, scim::SCIM_KEY_7 = 0x037,
  scim::SCIM_KEY_8 = 0x038, scim::SCIM_KEY_9 = 0x039, scim::SCIM_KEY_colon = 0x03a, scim::SCIM_KEY_semicolon = 0x03b,
  scim::SCIM_KEY_less = 0x03c, scim::SCIM_KEY_equal = 0x03d, scim::SCIM_KEY_greater = 0x03e, scim::SCIM_KEY_question = 0x03f,
  scim::SCIM_KEY_at = 0x040, scim::SCIM_KEY_A = 0x041, scim::SCIM_KEY_B = 0x042, scim::SCIM_KEY_C = 0x043,
  scim::SCIM_KEY_D = 0x044, scim::SCIM_KEY_E = 0x045, scim::SCIM_KEY_F = 0x046, scim::SCIM_KEY_G = 0x047,
  scim::SCIM_KEY_H = 0x048, scim::SCIM_KEY_I = 0x049, scim::SCIM_KEY_J = 0x04a, scim::SCIM_KEY_K = 0x04b,
  scim::SCIM_KEY_L = 0x04c, scim::SCIM_KEY_M = 0x04d, scim::SCIM_KEY_N = 0x04e, scim::SCIM_KEY_O = 0x04f,
  scim::SCIM_KEY_P = 0x050, scim::SCIM_KEY_Q = 0x051, scim::SCIM_KEY_R = 0x052, scim::SCIM_KEY_S = 0x053,
  scim::SCIM_KEY_T = 0x054, scim::SCIM_KEY_U = 0x055, scim::SCIM_KEY_V = 0x056, scim::SCIM_KEY_W = 0x057,
  scim::SCIM_KEY_X = 0x058, scim::SCIM_KEY_Y = 0x059, scim::SCIM_KEY_Z = 0x05a, scim::SCIM_KEY_bracketleft = 0x05b,
  scim::SCIM_KEY_backslash = 0x05c, scim::SCIM_KEY_bracketright = 0x05d, scim::SCIM_KEY_asciicircum = 0x05e, scim::SCIM_KEY_underscore = 0x05f,
  scim::SCIM_KEY_grave = 0x060, scim::SCIM_KEY_a = 0x061, scim::SCIM_KEY_b = 0x062, scim::SCIM_KEY_c = 0x063,
  scim::SCIM_KEY_d = 0x064, scim::SCIM_KEY_e = 0x065, scim::SCIM_KEY_f = 0x066, scim::SCIM_KEY_g = 0x067,
  scim::SCIM_KEY_h = 0x068, scim::SCIM_KEY_i = 0x069, scim::SCIM_KEY_j = 0x06a, scim::SCIM_KEY_k = 0x06b,
  scim::SCIM_KEY_l = 0x06c, scim::SCIM_KEY_m = 0x06d, scim::SCIM_KEY_n = 0x06e, scim::SCIM_KEY_o = 0x06f,
  scim::SCIM_KEY_p = 0x070, scim::SCIM_KEY_q = 0x071, scim::SCIM_KEY_r = 0x072, scim::SCIM_KEY_s = 0x073,
  scim::SCIM_KEY_t = 0x074, scim::SCIM_KEY_u = 0x075, scim::SCIM_KEY_v = 0x076, scim::SCIM_KEY_w = 0x077,
  scim::SCIM_KEY_x = 0x078, scim::SCIM_KEY_y = 0x079, scim::SCIM_KEY_z = 0x07a, scim::SCIM_KEY_braceleft = 0x07b,
  scim::SCIM_KEY_bar = 0x07c, scim::SCIM_KEY_braceright = 0x07d, scim::SCIM_KEY_asciitilde = 0x07e
}
 Enum values of all valid key codes. More...

enum  scim::SocketFamily { scim::SCIM_SOCKET_UNKNOWN, scim::SCIM_SOCKET_LOCAL, scim::SCIM_SOCKET_INET }
enum  scim::SocketTransactionDataType {
  scim::SCIM_TRANS_DATA_UNKNOWN, scim::SCIM_TRANS_DATA_COMMAND, scim::SCIM_TRANS_DATA_RAW, scim::SCIM_TRANS_DATA_UINT32,
  scim::SCIM_TRANS_DATA_STRING, scim::SCIM_TRANS_DATA_WSTRING, scim::SCIM_TRANS_DATA_KEYEVENT, scim::SCIM_TRANS_DATA_ATTRLIST,
  scim::SCIM_TRANS_DATA_LOOKUP_TABLE, scim::SCIM_TRANS_DATA_VECTOR_UINT32, scim::SCIM_TRANS_DATA_VECTOR_STRING, scim::SCIM_TRANS_DATA_VECTOR_WSTRING
}

Functions

bool scim::scim_key_to_string (String &str, const KeyEvent &key)
 Convert a key event to a string.

bool scim::scim_string_to_key (KeyEvent &key, const String &str)
 Convert a string to a KeyEvent.

bool scim::scim_key_list_to_string (String &str, const KeyEventList &keylist)
 Convert a set of KeyEvents to a string.

bool scim::scim_string_to_key_list (KeyEventList &keylist, const String &str)
 Covnert a string to a set of KeyEvents.

int scim::scim_get_module_list (std::vector< String > &mod_list, const String &type="")
int scim::utf8_mbtowc (ucs4_t *pwc, const unsigned char *src, int src_len)
 Convert an utf8 char sequence to ucs4.

int scim::utf8_wctomb (unsigned char *dest, ucs4_t wc, int dest_size)
 Convert an ucs4 code to utf8 char sequence.

WideString scim::utf8_mbstowcs (const String &str)
 Convert an utf8 string to an ucs4 string.

WideString scim::utf8_mbstowcs (const char *str, int len=-1)
 Convert an utf8 string to an ucs4 string.

String scim::utf8_wcstombs (const WideString &wstr)
 Convert an ucs4 string to an utf8 string.

String scim::utf8_wcstombs (const ucs4_t *wstr, int len=-1)
 Convert an ucs4 string to an utf8 string.

ucs4_t scim::utf8_read_wchar (std::istream &is)
 Read a wide char from istream.

std::ostream & scim::utf8_write_wchar (std::ostream &os, ucs4_t wc)
 Write a wide char to ostream.

WideString scim::utf8_read_wstring (std::istream &is, ucs4_t delim=(ucs4_t) '\n', bool rm_delim=true)
 Read a wide string from istream.

std::ostream & scim::utf8_write_wstring (std::ostream &os, const WideString &wstr)
 Write a wide string to ostream.

void scim::scim_uint32tobytes (unsigned char *bytes, uint32 n)
 Convert an uint32 variable into a sequence of bytes.

uint32 scim::scim_bytestouint32 (const unsigned char *bytes)
 Convert a sequence of bytes into an uint32 value.

void scim::scim_uint16tobytes (unsigned char *bytes, uint16 n)
 Convert an uint16 variable into a sequence of bytes.

uint16 scim::scim_bytestouint16 (const unsigned char *bytes)
 Convert a sequence of bytes into an uint16 value.

String scim::scim_validate_locale (const String &locale)
 Test if the locale is valid, and return the good locale name.

String scim::scim_get_locale_encoding (const String &locale)
 Get the encoding for a locale.

String scim::scim_get_current_locale ()
 Get current system locale.

int scim::scim_get_locale_maxlen (const String &locale)
 Get the max length of the multibyte char of a locale.

int scim::scim_split_string_list (std::vector< String > &vec, const String &str, char delim= ',')
 Split string list into a string vector according to the delim char.

String scim::scim_combine_string_list (const std::vector< String > &vec, char delim= ',')
 Combine a string vector into one string list, separated by char delim.

bool scim::scim_is_little_endian ()
 Get machine endian type.

bool scim::scim_if_wchar_ucs4_equal ()
 Test if wchar_t is using UCS4 encoding.

ucs4_t scim::scim_wchar_to_full_width (ucs4_t code)
 Convert a half width unicode char to its full width counterpart.

ucs4_t scim::scim_wchar_to_half_width (ucs4_t code)
 Convert a full width unicode char to its half width counterpart.

String scim::scim_get_home_dir ()
 Get the home dir of current user.

String scim::scim_get_user_name ()
 Get the name of current user.

size_t scim::scim_load_file (const String &filename, char **bufptr)
 Load a file into memory.

bool scim::scim_make_dir (const String &dir)
 Make a directory.


Variables

const int scim::SCIM_TRANS_CMD_UNKNOWN

Detailed Description

The helper classes and functions, including Attribute, IConvert, LookupTable etc.

Define Documentation

#define SCIM_MAX_BUFSIZE   4096
 

Definition at line 41 of file scim_iconv.h.

#define SCIM_LOOKUP_TABLE_MAX_PAGESIZE   16
 

Definition at line 40 of file scim_lookup_table.h.

#define SCIM_PATH_DELIM_STRING   "/"
 

Definition at line 40 of file scim_utility.h.

#define SCIM_PATH_DELIM   '/'
 

Definition at line 41 of file scim_utility.h.

#define RET_ILSEQ   0
 

Definition at line 46 of file scim_utility.h.

#define RET_TOOFEW  )     (-1-(n))
 

Definition at line 48 of file scim_utility.h.

#define RET_TOOSMALL   -1
 

Definition at line 50 of file scim_utility.h.

#define BAD_WCHAR   ((ucs4_t) 0xfffd)
 

Definition at line 52 of file scim_utility.h.

#define BAD_CHAR   '?'
 

Definition at line 53 of file scim_utility.h.


Typedef Documentation

typedef std::vector< Attribute > scim::AttributeList
 

The container to store a set of Attribute objects.

You should use the STL container methods to manipulate its objects.

Definition at line 141 of file scim_attributes.h.

Referenced by scim::ServerInstanceBase::update_aux_string(), scim::ServerInstanceBase::update_preedit_string(), and scim::ServerInstanceBase::update_status_string().

typedef std::vector< KeyEvent > scim::KeyEventList
 

The container to store a set of KeyEvent objects.

You should use the STL container methods to manipulate its objects.

Definition at line 447 of file scim_event.h.

typedef Slot2<void, SocketServer *, const Socket &> scim::SocketServerSlotSocket
 

Definition at line 48 of file scim_socket.h.

typedef Signal2<void, SocketServer *, const Socket &> scim::SocketServerSignalSocket
 

Definition at line 51 of file scim_socket.h.


Enumeration Type Documentation

enum scim::AttributeType
 

Enum values of the valid attributes.

Enumeration values:
SCIM_ATTR_NONE  No attribute.
SCIM_ATTR_UNDERLINE  Draw a line under the text.
SCIM_ATTR_HIGHLIGHT  Draw the text in highlighted color.
SCIM_ATTR_REVERSE  Draw the text in reverse color mode.

Definition at line 51 of file scim_attributes.h.

Referenced by scim::Attribute::get_type().

enum scim::KeyMask
 

Enum values of all valid key masks.

The key masks indicate which modifier keys is pressed down during the keyboard hit.

The special SCIM_KEY_ReleaseMask indicates the key release event.

Enumeration values:
SCIM_KEY_NullMask  Key press event without modifier key.
SCIM_KEY_ShiftMask  The shift key is pressed down
SCIM_KEY_LockMask  The lock key is pressed down
SCIM_KEY_CapsLockMask  The caps lock key is pressed down
SCIM_KEY_ControlMask  The ctrl key is pressed down
SCIM_KEY_AltMask  The alt key is pressed down
SCIM_KEY_Mod1Mask  The mod1 key is pressed down
SCIM_KEY_Mod2Mask  The mod2 key is pressed down
SCIM_KEY_NumLockMask  The num lock key is pressed down
SCIM_KEY_Mod3Mask  The mod3 key is pressed down
SCIM_KEY_Mod4Mask  The mod4 key is pressed down
SCIM_KEY_Mod5Mask  The mod5 key is pressed down
SCIM_KEY_ScrollLockMask  The scroll lock key is pressed down
SCIM_KEY_ReleaseMask  It's a key release event

Definition at line 51 of file scim_event.h.

enum scim::KeyCode
 

Enum values of all valid key codes.

Enumeration values:
SCIM_KEY_NullKey 
SCIM_KEY_Shift_L 
SCIM_KEY_Shift_R 
SCIM_KEY_Control_L 
SCIM_KEY_Control_R 
SCIM_KEY_Caps_Lock 
SCIM_KEY_Shift_Lock 
SCIM_KEY_Meta_L 
SCIM_KEY_Meta_R 
SCIM_KEY_Alt_L 
SCIM_KEY_Alt_R 
SCIM_KEY_Super_L 
SCIM_KEY_Super_R 
SCIM_KEY_Hyper_L 
SCIM_KEY_Hyper_R 
SCIM_KEY_BackSpace 
SCIM_KEY_Tab 
SCIM_KEY_Linefeed 
SCIM_KEY_Clear 
SCIM_KEY_Return 
SCIM_KEY_Pause 
SCIM_KEY_Scroll_Lock 
SCIM_KEY_Sys_Req 
SCIM_KEY_Escape 
SCIM_KEY_Delete 
SCIM_KEY_Multi_key 
SCIM_KEY_Codeinput 
SCIM_KEY_SingleCandidate 
SCIM_KEY_MultipleCandidate 
SCIM_KEY_PreviousCandidate 
SCIM_KEY_Kanji 
SCIM_KEY_Muhenkan 
SCIM_KEY_Henkan_Mode 
SCIM_KEY_Henkan 
SCIM_KEY_Romaji 
SCIM_KEY_Hiragana 
SCIM_KEY_Katakana 
SCIM_KEY_Hiragana_Katakana 
SCIM_KEY_Zenkaku 
SCIM_KEY_Hankaku 
SCIM_KEY_Zenkaku_Hankaku 
SCIM_KEY_Touroku 
SCIM_KEY_Massyo 
SCIM_KEY_Kana_Lock 
SCIM_KEY_Kana_Shift 
SCIM_KEY_Eisu_Shift 
SCIM_KEY_Eisu_toggle 
SCIM_KEY_Kanji_Bangou 
SCIM_KEY_Zen_Koho 
SCIM_KEY_Mae_Koho 
SCIM_KEY_Home 
SCIM_KEY_Left 
SCIM_KEY_Up 
SCIM_KEY_Right 
SCIM_KEY_Down 
SCIM_KEY_Prior 
SCIM_KEY_Page_Up 
SCIM_KEY_Next 
SCIM_KEY_Page_Down 
SCIM_KEY_End 
SCIM_KEY_Begin 
SCIM_KEY_Select 
SCIM_KEY_Print 
SCIM_KEY_Execute 
SCIM_KEY_Insert 
SCIM_KEY_Undo 
SCIM_KEY_Redo 
SCIM_KEY_Menu 
SCIM_KEY_Find 
SCIM_KEY_Cancel 
SCIM_KEY_Help 
SCIM_KEY_Break 
SCIM_KEY_Mode_switch 
SCIM_KEY_Num_Lock 
SCIM_KEY_KP_Space 
SCIM_KEY_KP_Tab 
SCIM_KEY_KP_Enter 
SCIM_KEY_KP_F1 
SCIM_KEY_KP_F2 
SCIM_KEY_KP_F3 
SCIM_KEY_KP_F4 
SCIM_KEY_KP_Home 
SCIM_KEY_KP_Left 
SCIM_KEY_KP_Up 
SCIM_KEY_KP_Right 
SCIM_KEY_KP_Down 
SCIM_KEY_KP_Prior 
SCIM_KEY_KP_Page_Up 
SCIM_KEY_KP_Next 
SCIM_KEY_KP_Page_Down 
SCIM_KEY_KP_End 
SCIM_KEY_KP_Begin 
SCIM_KEY_KP_Insert 
SCIM_KEY_KP_Delete 
SCIM_KEY_KP_Equal 
SCIM_KEY_KP_Multiply 
SCIM_KEY_KP_Add 
SCIM_KEY_KP_Separator 
SCIM_KEY_KP_Subtract 
SCIM_KEY_KP_Decimal 
SCIM_KEY_KP_Divide 
SCIM_KEY_KP_0 
SCIM_KEY_KP_1 
SCIM_KEY_KP_2 
SCIM_KEY_KP_3 
SCIM_KEY_KP_4 
SCIM_KEY_KP_5 
SCIM_KEY_KP_6 
SCIM_KEY_KP_7 
SCIM_KEY_KP_8 
SCIM_KEY_KP_9 
SCIM_KEY_F1 
SCIM_KEY_F2 
SCIM_KEY_F3 
SCIM_KEY_F4 
SCIM_KEY_F5 
SCIM_KEY_F6 
SCIM_KEY_F7 
SCIM_KEY_F8 
SCIM_KEY_F9 
SCIM_KEY_F10 
SCIM_KEY_F11 
SCIM_KEY_F12 
SCIM_KEY_space 
SCIM_KEY_exclam 
SCIM_KEY_quotedbl 
SCIM_KEY_numbersign 
SCIM_KEY_dollar 
SCIM_KEY_percent 
SCIM_KEY_ampersand 
SCIM_KEY_apostrophe 
SCIM_KEY_quoteright 
SCIM_KEY_parenleft 
SCIM_KEY_parenright 
SCIM_KEY_asterisk 
SCIM_KEY_plus 
SCIM_KEY_comma 
SCIM_KEY_minus 
SCIM_KEY_period 
SCIM_KEY_slash 
SCIM_KEY_0 
SCIM_KEY_1 
SCIM_KEY_2 
SCIM_KEY_3 
SCIM_KEY_4 
SCIM_KEY_5 
SCIM_KEY_6 
SCIM_KEY_7 
SCIM_KEY_8 
SCIM_KEY_9 
SCIM_KEY_colon 
SCIM_KEY_semicolon 
SCIM_KEY_less 
SCIM_KEY_equal 
SCIM_KEY_greater 
SCIM_KEY_question 
SCIM_KEY_at 
SCIM_KEY_A 
SCIM_KEY_B 
SCIM_KEY_C 
SCIM_KEY_D 
SCIM_KEY_E 
SCIM_KEY_F 
SCIM_KEY_G 
SCIM_KEY_H 
SCIM_KEY_I 
SCIM_KEY_J 
SCIM_KEY_K 
SCIM_KEY_L 
SCIM_KEY_M 
SCIM_KEY_N 
SCIM_KEY_O 
SCIM_KEY_P 
SCIM_KEY_Q 
SCIM_KEY_R 
SCIM_KEY_S 
SCIM_KEY_T 
SCIM_KEY_U 
SCIM_KEY_V 
SCIM_KEY_W 
SCIM_KEY_X 
SCIM_KEY_Y 
SCIM_KEY_Z 
SCIM_KEY_bracketleft 
SCIM_KEY_backslash 
SCIM_KEY_bracketright 
SCIM_KEY_asciicircum 
SCIM_KEY_underscore 
SCIM_KEY_grave 
SCIM_KEY_a 
SCIM_KEY_b 
SCIM_KEY_c 
SCIM_KEY_d 
SCIM_KEY_e 
SCIM_KEY_f 
SCIM_KEY_g 
SCIM_KEY_h 
SCIM_KEY_i 
SCIM_KEY_j 
SCIM_KEY_k 
SCIM_KEY_l 
SCIM_KEY_m 
SCIM_KEY_n 
SCIM_KEY_o 
SCIM_KEY_p 
SCIM_KEY_q 
SCIM_KEY_r 
SCIM_KEY_s 
SCIM_KEY_t 
SCIM_KEY_u 
SCIM_KEY_v 
SCIM_KEY_w 
SCIM_KEY_x 
SCIM_KEY_y 
SCIM_KEY_z 
SCIM_KEY_braceleft 
SCIM_KEY_bar 
SCIM_KEY_braceright 
SCIM_KEY_asciitilde 

Definition at line 72 of file scim_event.h.

enum scim::SocketFamily
 

The vaild Socket address/protocol family, corresponding to libc PF_LOCAL/AF_LOCAL and PF_INET/AF_INET

Enumeration values:
SCIM_SOCKET_UNKNOWN 
SCIM_SOCKET_LOCAL 
SCIM_SOCKET_INET 

Definition at line 64 of file scim_socket.h.

enum scim::SocketTransactionDataType
 

Signature of all of valid data types can be store into transaction.

Enumeration values:
SCIM_TRANS_DATA_UNKNOWN 
SCIM_TRANS_DATA_COMMAND  Send/Receive command.
SCIM_TRANS_DATA_RAW  Send/Receive raw buffer.
SCIM_TRANS_DATA_UINT32  Send/Receive uint32.
SCIM_TRANS_DATA_STRING  Send/Receive String.
SCIM_TRANS_DATA_WSTRING  Send/Receive WideString.
SCIM_TRANS_DATA_KEYEVENT  Send/Receive KeyEvent.
SCIM_TRANS_DATA_ATTRLIST  Send/Receive AttributeList.
SCIM_TRANS_DATA_LOOKUP_TABLE  Send/Receive LookupTable.
SCIM_TRANS_DATA_VECTOR_UINT32  Send/Receive vector<uint32>.
SCIM_TRANS_DATA_VECTOR_STRING  Send/Receive vector<String>.
SCIM_TRANS_DATA_VECTOR_WSTRING  Send/Receive vector<WideString>.

Definition at line 45 of file scim_socket_transaction.h.


Function Documentation

bool scim_key_to_string String &  str,
const KeyEvent &  key
 

Convert a key event to a string.

Parameters:
str - the result string will be stored here.
key - the KeyEvent to be converted.
Returns:
true if success.

bool scim_string_to_key KeyEvent &  key,
const String &  str
 

Convert a string to a KeyEvent.

Parameters:
key - the result KeyEvent will be stored here.
str - the string to be converted.
Returns:
true if success.

bool scim_key_list_to_string String &  str,
const KeyEventList keylist
 

Convert a set of KeyEvents to a string.

Parameters:
str - the result string will be stored here.
keylist - the keys to be converted.
Returns:
true if success.

bool scim_string_to_key_list KeyEventList keylist,
const String &  str
 

Covnert a string to a set of KeyEvents.

Parameters:
keylist - the result KeyEvents will be stored here.
str - the string to be converted.
Returns:
true if success.

int scim_get_module_list std::vector< String > &  mod_list,
const String &  type = ""
 

template<typename T1, typename T2>
bool operator== const Pointer< T1 > &  t1,
const Pointer< T2 > &  t2
[inline]
 

Compares two Pointers. <

Returns:
true if both Pointers manage to same dumb pointer.

Definition at line 229 of file scim_pointer.h.

template<typename T1, typename T2>
bool operator!= const Pointer< T1 > &  t1,
const Pointer< T2 > &  t2
[inline]
 

Compares two Pointers. <

Returns:
true if both Pointers manage a different dumb pointer.

Definition at line 237 of file scim_pointer.h.

template<typename To, typename From>
Pointer<To> cast_const const Pointer< From > &  from  )  [inline]
 

Removes the const qualifier from a managed const dumb pointer. <

Parameters:
from - a Pointer that manages a const dumb pointer. <
Returns:
a new Pointer that manages the non-const dumb pointer. < <
Calls const_cast on the dumb pointer and returns the non-const < pointer as a new Pointer.

Definition at line 250 of file scim_pointer.h.

template<typename To, typename From>
Pointer<To> cast_dynamic const Pointer< From > &  from  )  [inline]
 

Casts a managed polymophic dumb pointer down or across its inheritance heirarchy. <

Parameters:
from - a Pointer managing a polymophic dumb pointer of type From. <
Returns:
a new Pointer managing the dumb pointer as a base or sibling pointer of type To. < <
Calls dynmaic_cast to safely cast a managed polymophic dumb pointer < of type From to a base, derived or sibling class pointer of type To.

Definition at line 263 of file scim_pointer.h.

template<typename To, typename From>
Pointer<To> cast_static const Pointer< From > &  from  )  [inline]
 

Casts a managed dumb pointer to a pointer to a related type. <

Parameters:
from - a Pointer managing a dumb pointer of type From. <
Returns:
a new Pointer managing the dumb pointer as a pointer of type To. < <
Calls static_cast to cast a dumb pointer of type From to a < pointer of type To.

Definition at line 276 of file scim_pointer.h.

int utf8_mbtowc ucs4_t *  pwc,
const unsigned char *  src,
int  src_len
 

Convert an utf8 char sequence to ucs4.

Parameters:
pwc destination buffer to store the ucs4 code.
src source buffer contains the utf8 char sequence.
src_len the size of source buffer.
Returns:
number of chars in s actually converted.

int utf8_wctomb unsigned char *  dest,
ucs4_t  wc,
int  dest_size
 

Convert an ucs4 code to utf8 char sequence.

Parameters:
dest destination buffer to store utf8 char sequence.
wc the ucs4 code to be converted.
dest_size the size of destination buffer.
Returns:
the number of bytes actually written into dest.

WideString utf8_mbstowcs const String &  str  ) 
 

Convert an utf8 string to an ucs4 string.

Parameters:
str source utf8 string.
Returns:
the destination widestring.

WideString utf8_mbstowcs const char *  str,
int  len = -1
 

Convert an utf8 string to an ucs4 string.

Parameters:
str source utf8 string.
len length of the source string.
Returns:
the destination widestring.

String utf8_wcstombs const WideString &  wstr  ) 
 

Convert an ucs4 string to an utf8 string.

Parameters:
wstr source ucs4 string.
Returns:
the destination utf8 string.

String utf8_wcstombs const ucs4_t *  wstr,
int  len = -1
 

Convert an ucs4 string to an utf8 string.

Parameters:
wstr source ucs4 string.
len length of the source string.
Returns:
the destination utf8 string.

ucs4_t utf8_read_wchar std::istream &  is  ) 
 

Read a wide char from istream.

The content in the istream are actually in utf-8 encoding.

Parameters:
is the stream to be read.
Returns:
if equal to 0 then got the end of the stream or error occurred.

std::ostream& utf8_write_wchar std::ostream &  os,
ucs4_t  wc
 

Write a wide char to ostream.

The content written into the ostream will be converted into utf-8 encoding.

Parameters:
os the stream to be written.
wc the wide char to be written to the stream.
Returns:
the same stream object reference.

WideString utf8_read_wstring std::istream &  is,
ucs4_t  delim = (ucs4_t) '\n',
bool  rm_delim = true
 

Read a wide string from istream.

The content in the istream are actually in utf-8 encoding.

Parameters:
is the stream to be read.
delim the delimiter of the string.
rm_delim if the delim should be removed from the destination string.
Returns:
the wide string read from the given stream.

std::ostream& utf8_write_wstring std::ostream &  os,
const WideString &  wstr
 

Write a wide string to ostream.

The content written into the ostream will be converted into utf-8 encoding.

Parameters:
os the stream to be written.
wstr the wide string to be written into the stream.
Returns:
the same stream object reference.

void scim_uint32tobytes unsigned char *  bytes,
uint32  n
[inline]
 

Convert an uint32 variable into a sequence of bytes.

Parameters:
bytes the buffer to store the result.
n the variable to be converted.

Definition at line 165 of file scim_utility.h.

uint32 scim_bytestouint32 const unsigned char *  bytes  )  [inline]
 

Convert a sequence of bytes into an uint32 value.

Parameters:
bytes the buffer contains the bytes to be converted.
Returns:
the result uint32 value.

Definition at line 180 of file scim_utility.h.

void scim_uint16tobytes unsigned char *  bytes,
uint16  n
[inline]
 

Convert an uint16 variable into a sequence of bytes.

Parameters:
bytes the buffer to store the result.
n the variable to be converted.

Definition at line 195 of file scim_utility.h.

uint16 scim_bytestouint16 const unsigned char *  bytes  )  [inline]
 

Convert a sequence of bytes into an uint16 value.

Parameters:
bytes the buffer contains the bytes to be converted.
Returns:
the result uint16 value.

Definition at line 208 of file scim_utility.h.

String scim_validate_locale const String &  locale  ) 
 

Test if the locale is valid, and return the good locale name.

Parameters:
locale the locale to be tested.
Returns:
If the locale is valid, it's the good locale name, otherwise empty.

String scim_get_locale_encoding const String &  locale  ) 
 

Get the encoding for a locale.

Parameters:
locale the name of the locale.
Returns:
The encoding used by the given locale.

String scim_get_current_locale  ) 
 

Get current system locale.

Returns:
The current system locale.

int scim_get_locale_maxlen const String &  locale  ) 
 

Get the max length of the multibyte char of a locale.

Parameters:
locale the name of the locale.
Returns:
the maxlen of this locale.

int scim_split_string_list std::vector< String > &  vec,
const String &  str,
char  delim = ','
 

Split string list into a string vector according to the delim char.

Parameters:
vec the string vector to store the result.
str the string to be splitted.
delim the delimiter to split the strings.
Returns:
the number of the strings in the result list.

String scim_combine_string_list const std::vector< String > &  vec,
char  delim = ','
 

Combine a string vector into one string list, separated by char delim.

Parameters:
vec the string vector which contains the strings to be combined.
delim the delimiter which should be put between two strings.
Returns:
the result string.

bool scim_is_little_endian  ) 
 

Get machine endian type.

Returns:
1 little endian, 0 big endian

bool scim_if_wchar_ucs4_equal  ) 
 

Test if wchar_t is using UCS4 encoding.

ucs4_t scim_wchar_to_full_width ucs4_t  code  ) 
 

Convert a half width unicode char to its full width counterpart.

ucs4_t scim_wchar_to_half_width ucs4_t  code  ) 
 

Convert a full width unicode char to its half width counterpart.

String scim_get_home_dir  ) 
 

Get the home dir of current user.

String scim_get_user_name  ) 
 

Get the name of current user.

size_t scim_load_file const String &  filename,
char **  bufptr
 

Load a file into memory.

Parameters:
filename the name of the file to be loaded.
bufptr the place to store the newly allocated buffer pointer, if bufptr == NULL then the file is not actually loaded. the pointer *bufptr must be deleted afterwards.
Returns:
the size of the data actually loaded (mostly, it's the file size), zero means load failed.

bool scim_make_dir const String &  dir  ) 
 

Make a directory.

Parameters:
dir the dir path to be created.
Returns:
true if sucess.


Variable Documentation

const int scim::SCIM_TRANS_CMD_UNKNOWN
 

command types used by socket frontend server and config.

Definition at line 66 of file scim_socket_transaction.h.


Generated on Fri May 7 17:27:26 2004 for scim by doxygen 1.3.6