=================================================================== RCS file: /home/cvs/OpenXM/doc/OpenXM-specs/library.tex,v retrieving revision 1.1 retrieving revision 1.7 diff -u -p -r1.1 -r1.7 --- OpenXM/doc/OpenXM-specs/library.tex 2000/01/20 08:52:46 1.1 +++ OpenXM/doc/OpenXM-specs/library.tex 2020/03/14 01:21:56 1.7 @@ -1,64 +1,66 @@ -%% $OpenXM$ +%% $OpenXM: OpenXM/doc/OpenXM-specs/library.tex,v 1.6 2002/01/20 09:26:22 takayama Exp $ /*&jp -\section{ OX サーバに対する C ライブラリインタフェース } +\section{ OX 泣若絲障 C ゃゃ潟帥с若 } -一部のOX サーバでは C のライブラリとしてリンクして使用するもできる. -ライブラリとして使用するための C の関数は -Asir の OX サーバ用クライアント関数に似たインタフェースを持つ. +筝OX 泣若с C ゃ潟篏睡с. +ゃ篏睡 C ∽違 +Asir OX 泣若ゃ≪潟∽違篌若ゃ潟帥с若鴻. -ライブラリ関数には, CMO を binary encoding して渡す. -ライブラリ関数からは, CMO が binary encoded form で戻る. +ゃ∽違, CMO binary encoding 羝<. +ゃ∽違, CMO binary encoded form ф祉. */ /*&eg \section{ OX servers as a C library} In some OX servers, one can use the OX server as a C library. -The interface functions of the C library -are similar to Asir OX client functions such as -\verb+ ox_push_cmo() +, \verb+ ox_pop_cmo() +. +The API to the C library +is similar to Asir OX client API such as +{\tt ox\_push\_cmo()}, {\tt ox\_pop\_cmo()}. -CMO should be in the binary encoded form to call these functions. +CMO should be converted into the binary encoded form to call these functions. */ /*&C \medbreak \begin{verbatim} - int xxx_ox_byte_order(int type) + int xxx_ox_init(int type) \end{verbatim} */ /*&eg - Specify the byte order to send int32 to the OX server xxx. - When type = 0, the network byte order will be used. + This function initializes the library interface. + {\tt type} specifies the byte order to send int32 to the OX server xxx. + If type is equal to 0, the native byte order will be used. + If type is equal to 1, the network byte order will be used. In case of error, -1 will be returned. */ /*&jp - OX サーバ xxx へ int32 を送るための byte order を type で指定する. - ライブラリではあるが, - type = 0 で, network byte order を使用できないといけない?? - 失敗した場合, -1 を戻す. + ∽違ゃゃ潟帥с若鴻茵. + OX 泣若 xxx int32 byte order type ф絎. + type = 0 翫 native byte order 荐絎. + type = 1 翫 network byte order 荐絎. + 紊掩翫, -1 祉. */ /*&C \smallskip \begin{verbatim} - void xxx_ox_push_cmo(void *cmo, int size) + void xxx_ox_push_cmo(void *cmo) \end{verbatim} */ /*&eg -Push the binary encoded CMO {\tt cmo} of the size {\tt size} -onto the stack of the OX server xxx. +Push the binary encoded CMO {\tt cmo} onto the stack of the OX server xxx. */ /*&jp -Binary encoded された CMO (サイズは size) を, OX サーバ xxx -の stack に push する. +Binary encoded CMO , OX 泣若 xxx + stack push . */ /*&C \smallskip \begin{verbatim} - int xxx_ox_pop_cmo(void *cmo, int limit) + int xxx_ox_pop_cmo(void cmo, int limit) \end{verbatim} */ /*&eg @@ -70,12 +72,12 @@ If the size exceeds the {\tt limit}, -1 will be return and the CMO is not popped and will not be written to {\tt cmo}. */ /*&jp -Binary encoded された CMO (サイズは size) を, OX サーバより -pop して, cmo に書き込む. -戻り値は CMO のサイズを byte で戻す. -Stack underflow の場合の戻り値は 0 である. -ただし, limit より大きいサイズの CMO は書き込まれない. -この場合, 戻り値は -1 となる. +Binary encoded CMO (泣ゃ冴 size) , OX 泣若 +pop , cmo 吾莨若. +祉ゃ CMO 泣ゃ冴 byte ф祉. +Stack underflow 翫祉ゃ 0 с. +, limit 紊с泣ゃ冴 CMO 吾莨若障. +翫, 祉ゃ -1 . */ /*&C @@ -88,34 +90,44 @@ Stack underflow の場合の戻り値は 0 である. /*&eg Return the size of the CMO at the top of the stack. */ +/*&jp +stack 筝筝 CMO 泣ゃ冴 byte ф祉. +*/ -/*&C - -\smallskip +\smallbreak \begin{verbatim} - int xxx_ox_peek_cmo_size() + void xxx_ox_push_cmd(int cmd) \end{verbatim} +/*&eg +This function sends a stack machine command +({\tt OX\_COMMAND},int32 cmd) to a server. */ /*&jp -stack の一番上にある CMO のサイズを byte で戻す. -( ライブラリ版特有 ) +({\tt OX\_COMMAND},int32 cmd) 泣若. */ -/*&C - -\smallbreak \begin{verbatim} -ox_push_cmd(), ox_execute_string() + void xxx_ox_execute_string(char *s) \end{verbatim} -*/ /*&eg -These functions have the same specification with those -in Asir client functions. See Asir document. -Numbers should be given in int 32 and strings should be given -by char * +This function requests a server to execute a command expressed by +a string {\tt s}. +{\tt s} should be acceptable by the parser of the server. */ /*&jp -については, Asir クライアントと同じインタフェース. -数は int32 で, 文字列は char * で. +絖 {\tt s} 泣若絎茵. {\tt s} 泣若若 +純с違. +*/ + +//&C + +/*&jp +ゃ≪若泣潟純若鴻 {\tt OpenXM/doc/oxlib} +. +*/ + +/*&eg +Sample source codes to use the library mode interface can be found in +{\tt OpenXM/doc/oxlib}. */