=================================================================== RCS file: /home/cvs/OpenXM/doc/OpenXM-specs/library.tex,v retrieving revision 1.1 retrieving revision 1.2 diff -u -p -r1.1 -r1.2 --- OpenXM/doc/OpenXM-specs/library.tex 2000/01/20 08:52:46 1.1 +++ OpenXM/doc/OpenXM-specs/library.tex 2000/01/24 00:57:11 1.2 @@ -1,4 +1,4 @@ -%% $OpenXM$ +%% $OpenXM: OpenXM/doc/OpenXM-specs/library.tex,v 1.1.1.1 2000/01/20 08:52:46 noro Exp $ /*&jp \section{ OX サーバに対する C ライブラリインタフェース } @@ -24,18 +24,21 @@ CMO should be in the binary encoded form to call these \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 network byte order will be used. + If type is equal to 1, the little endian order will be used. In case of error, -1 will be returned. */ /*&jp + この関数はライブラリインタフェースの初期化を行う. OX サーバ xxx へ int32 を送るための byte order を type で指定する. - ライブラリではあるが, - type = 0 で, network byte order を使用できないといけない?? + type = 0 の場合 network byte order が設定される. + type = 1 の場合 little endian order が設定される. 失敗した場合, -1 を戻す. */ @@ -43,22 +46,21 @@ CMO should be in the binary encoded form to call these \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 +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 @@ -98,24 +100,30 @@ Return the size of the CMO at the top of the stack. */ /*&jp stack の一番上にある CMO のサイズを byte で戻す. -( ライブラリ版特有 ) */ -/*&C - \smallbreak \begin{verbatim} -ox_push_cmd(), ox_execute_string() +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 +({\tt OX\_COMMAND},int32 cmd) をサーバに送る. +*/ + +\begin{verbatim} +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 * +These function requests a server to execute a string {\tt s}. +{\tt s} should be acceptable by the parser of the server. */ /*&jp -については, Asir クライアントと同じインタフェース. -数は int32 で, 文字列は char * で. +文字列 {\tt s} をサーバに実行させる. {\tt s} はサーバのパーザ +が受理可能なものでなければならない. */