00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
#ifndef __SCIM_SOCKET_TRANSACTION_H
00033
#define __SCIM_SOCKET_TRANSACTION_H
00034
00035
namespace scim {
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045 enum SocketTransactionDataType
00046 {
00047 SCIM_TRANS_DATA_UNKNOWN,
00048 SCIM_TRANS_DATA_COMMAND,
00049 SCIM_TRANS_DATA_RAW,
00050 SCIM_TRANS_DATA_UINT32,
00051 SCIM_TRANS_DATA_STRING,
00052 SCIM_TRANS_DATA_WSTRING,
00053 SCIM_TRANS_DATA_KEYEVENT,
00054 SCIM_TRANS_DATA_ATTRIBUTE_LIST,
00055 SCIM_TRANS_DATA_LOOKUP_TABLE,
00056 SCIM_TRANS_DATA_PROPERTY,
00057 SCIM_TRANS_DATA_PROPERTY_LIST,
00058 SCIM_TRANS_DATA_VECTOR_UINT32,
00059 SCIM_TRANS_DATA_VECTOR_STRING,
00060 SCIM_TRANS_DATA_VECTOR_WSTRING
00061 };
00062
00063
00064
00065
00066
00067
00068 const int SCIM_TRANS_CMD_UNKNOWN = 0;
00069
00070 const int SCIM_TRANS_CMD_REQUEST = 1;
00071 const int SCIM_TRANS_CMD_REPLY = 2;
00072 const int SCIM_TRANS_CMD_OK = 3;
00073 const int SCIM_TRANS_CMD_FAIL = 4;
00074
00075 const int SCIM_TRANS_CMD_OPEN_CONNECTION = 5;
00076 const int SCIM_TRANS_CMD_CLOSE_CONNECTION = 6;
00077
00078 const int SCIM_TRANS_CMD_LOAD_FILE = 7;
00079 const int SCIM_TRANS_CMD_EXIT = 99;
00080
00081 const int SCIM_TRANS_CMD_PROCESS_KEY_EVENT = 100;
00082 const int SCIM_TRANS_CMD_MOVE_PREEDIT_CARET = 101;
00083 const int SCIM_TRANS_CMD_SELECT_CANDIDATE = 102;
00084 const int SCIM_TRANS_CMD_UPDATE_LOOKUP_TABLE_PAGE_SIZE = 103;
00085 const int SCIM_TRANS_CMD_LOOKUP_TABLE_PAGE_UP = 104;
00086 const int SCIM_TRANS_CMD_LOOKUP_TABLE_PAGE_DOWN = 105;
00087 const int SCIM_TRANS_CMD_RESET = 106;
00088 const int SCIM_TRANS_CMD_FOCUS_IN = 107;
00089 const int SCIM_TRANS_CMD_FOCUS_OUT = 108;
00090 const int SCIM_TRANS_CMD_TRIGGER_PROPERTY = 109;
00091
00092 const int SCIM_TRANS_CMD_SHOW_PREEDIT_STRING = 110;
00093 const int SCIM_TRANS_CMD_SHOW_AUX_STRING = 111;
00094 const int SCIM_TRANS_CMD_SHOW_LOOKUP_TABLE = 112;
00095 const int SCIM_TRANS_CMD_HIDE_PREEDIT_STRING = 113;
00096 const int SCIM_TRANS_CMD_HIDE_AUX_STRING = 114;
00097 const int SCIM_TRANS_CMD_HIDE_LOOKUP_TABLE = 115;
00098 const int SCIM_TRANS_CMD_UPDATE_PREEDIT_CARET = 116;
00099 const int SCIM_TRANS_CMD_UPDATE_PREEDIT_STRING = 117;
00100 const int SCIM_TRANS_CMD_UPDATE_AUX_STRING = 118;
00101 const int SCIM_TRANS_CMD_UPDATE_LOOKUP_TABLE = 119;
00102 const int SCIM_TRANS_CMD_COMMIT_STRING = 120;
00103 const int SCIM_TRANS_CMD_FORWARD_KEY_EVENT = 121;
00104 const int SCIM_TRANS_CMD_REGISTER_PROPERTIES = 122;
00105 const int SCIM_TRANS_CMD_UPDATE_PROPERTY = 123;
00106
00107 const int SCIM_TRANS_CMD_NEW_INSTANCE = 200;
00108 const int SCIM_TRANS_CMD_DELETE_INSTANCE = 201;
00109 const int SCIM_TRANS_CMD_DELETE_ALL_INSTANCES = 202;
00110
00111 const int SCIM_TRANS_CMD_GET_FACTORY_LIST = 203;
00112 const int SCIM_TRANS_CMD_GET_FACTORY_NAME = 204;
00113 const int SCIM_TRANS_CMD_GET_FACTORY_AUTHORS = 205;
00114 const int SCIM_TRANS_CMD_GET_FACTORY_CREDITS = 206;
00115 const int SCIM_TRANS_CMD_GET_FACTORY_HELP = 207;
00116 const int SCIM_TRANS_CMD_GET_FACTORY_LOCALES = 208;
00117 const int SCIM_TRANS_CMD_GET_FACTORY_ICON_FILE = 209;
00118 const int SCIM_TRANS_CMD_GET_FACTORY_LANGUAGE = 210;
00119
00120 const int SCIM_TRANS_CMD_FLUSH_CONFIG = 300;
00121 const int SCIM_TRANS_CMD_ERASE_CONFIG = 301;
00122 const int SCIM_TRANS_CMD_GET_CONFIG_STRING = 302;
00123 const int SCIM_TRANS_CMD_SET_CONFIG_STRING = 303;
00124 const int SCIM_TRANS_CMD_GET_CONFIG_INT = 304;
00125 const int SCIM_TRANS_CMD_SET_CONFIG_INT = 305;
00126 const int SCIM_TRANS_CMD_GET_CONFIG_BOOL = 306;
00127 const int SCIM_TRANS_CMD_SET_CONFIG_BOOL = 307;
00128 const int SCIM_TRANS_CMD_GET_CONFIG_DOUBLE = 308;
00129 const int SCIM_TRANS_CMD_SET_CONFIG_DOUBLE = 309;
00130 const int SCIM_TRANS_CMD_GET_CONFIG_VECTOR_STRING = 310;
00131 const int SCIM_TRANS_CMD_SET_CONFIG_VECTOR_STRING = 311;
00132 const int SCIM_TRANS_CMD_GET_CONFIG_VECTOR_INT = 312;
00133 const int SCIM_TRANS_CMD_SET_CONFIG_VECTOR_INT = 313;
00134 const int SCIM_TRANS_CMD_RELOAD_CONFIG = 314;
00135
00136 const int SCIM_TRANS_CMD_PANEL_COMMAND_START = 500;
00137 const int SCIM_TRANS_CMD_PANEL_COMMAND_END = 599;
00138
00139 const int SCIM_TRANS_CMD_USER_DEFINED = 10000;
00140
00141
00142
00143
00144
00145
00146
00147
00148
00149
00150
00151 class SocketTransactionError:
public Exception
00152 {
00153
public:
00154 SocketTransactionError (
const String& what_arg)
00155 :
Exception (
String(
"scim::SocketTransaction: ") + what_arg) { }
00156 };
00157
00158
00159
00160
00161
00162 class SocketTransaction
00163 {
00164
class SocketTransactionImpl;
00165
00166 SocketTransactionImpl * m_impl;
00167
00168
SocketTransaction (
const SocketTransaction &);
00169
const SocketTransaction & operator = (
const SocketTransaction &);
00170
00171
public:
00172
00173
00174
00175
00176
00177
SocketTransaction (size_t bufsize = 512);
00178
00179
00180
00181
00182
~SocketTransaction ();
00183
00184
00185
00186
00187
00188
00189
bool valid ()
const;
00190
00191
00192
00193
00194
00195
00196
00197
00198
00199
00200
00201
00202
00203
bool write_to_socket (
const Socket &socket,
uint32 signature = 0)
const;
00204
00205
00206
00207
00208
00209
00210
00211
00212
00213
bool read_from_socket (
const Socket &socket,
int timeout = -1);
00214
00215
00216
00217
00218
00219
00220
void put_command (
int cmd);
00221
00222
00223
00224
00225
void put_data (
uint32 val);
00226
00227
00228
00229
00230
void put_data (
const String &str);
00231
00232
00233
00234
00235
void put_data (
const WideString &str);
00236
00237
00238
00239
00240
void put_data (
const KeyEvent &key);
00241
00242
00243
00244
00245
void put_data (
const AttributeList &attrs);
00246
00247
00248
00249
00250
void put_data (
const Property &property);
00251
00252
00253
00254
00255
void put_data (
const PropertyList &properties);
00256
00257
00258
00259
00260
void put_data (
const LookupTable &table);
00261
00262
00263
00264
00265
void put_data (
const std::vector<uint32> &vec);
00266
00267
00268
00269
00270
void put_data (
const std::vector<String> &vec);
00271
00272
00273
00274
00275
void put_data (
const std::vector<WideString> &vec);
00276
00277
00278
00279
00280
void put_data (
const char *raw, size_t bufsize);
00281
00282
00283
00284
00285
00286
00287
SocketTransactionDataType get_data_type ()
const;
00288
00289
00290
00291
00292
bool get_command (
int &cmd);
00293
00294
00295
00296
00297
bool get_data (
uint32 &val);
00298
00299
00300
00301
00302
bool get_data (
String &str);
00303
00304
00305
00306
00307
bool get_data (
WideString &str);
00308
00309
00310
00311
00312
bool get_data (
KeyEvent &key);
00313
00314
00315
00316
00317
bool get_data (
AttributeList &attrs);
00318
00319
00320
00321
00322
bool get_data (
Property &property);
00323
00324
00325
00326
00327
bool get_data (
PropertyList &properties);
00328
00329
00330
00331
00332
bool get_data (
CommonLookupTable &table);
00333
00334
00335
00336
00337
bool get_data (std::vector<uint32> &vec);
00338
00339
00340
00341
00342
bool get_data (std::vector<String> &vec);
00343
00344
00345
00346
00347
bool get_data (std::vector<WideString> &vec);
00348
00349
00350
00351
00352
00353
00354
00355
bool get_data (
char **raw, size_t &bufsize);
00356
00357
00358
00359
00360
bool skip_data ();
00361
00362
00363
00364
00365
void rewind_read_pos ();
00366
00367
00368
00369
00370
void clear ();
00371 };
00372
00373
00374
00375
00376
00377
00378
00379
00380
00381
00382
00383
00384
00385
00386
00387
00388
00389
00390
00391
00392
00393
00394
00395
00396
00397
00398
00399
bool scim_socket_trans_open_connection (
uint32 &key,
00400
const String &client_type,
00401
const String &server_type,
00402
const Socket &socket,
00403
int timeout = -1);
00404
00405
00406
00407
00408
00409
00410
00411
00412
00413
00414
00415
00416
00417
00418
00419
00420
00421
00422
00423
00424
00425
00426
00427
00428
00429
String scim_socket_trans_accept_connection (
uint32 &key,
00430
const String &server_types,
00431
const String &client_types,
00432
const Socket &socket,
00433
int timeout = -1);
00434
00435
00436 }
00437
00438
#endif //__SCIM_SOCKET_TRANSACTION_H
00439
00440
00441
00442
00443