[BACK]Return to stackmachine.tex CVS log [TXT][DIR] Up to [local] / OpenXM / doc / OpenXM-specs

Annotation of OpenXM/doc/OpenXM-specs/stackmachine.tex, Revision 1.4

1.1       noro        1: //&jp \section{ OX スタックマシン }
1.4     ! noro        2: //&eg \section{ OX stack machine }
        !             3: \label{sec:stackmachine}
1.1       noro        4: /*&jp
                      5: この節では, OX スタックマシン operator の説明
                      6: (TCP/IP ソケット上での標準 encoding 法 を用いる),
                      7: および, サンプルサーバとリンクする場合または
                      8: open XM ライブラリとしてリンクして使用する場合の
                      9: ための C の関数の仕様を説明する.
                     10:
                     11: 説明の前に, OX サーバスタックマシンの動作の原則を
                     12: 説明しておく.
                     13: サーバスタックマシンは,
                     14: {\tt SM\_pop*} 系のスタックマシンコマンドがこないかぎり,
                     15: 自発的にメッセージを送信することはない.
                     16: この原則に基づいて分散計算のプログラミングをおこなう.
                     17: イベントドリブンなプログラム法とはちがうことに
                     18: 注意しよう.
1.2       noro       19: */
1.1       noro       20:
1.2       noro       21: /*&eg
                     22: In this section we describe the OX stack machine operators.  In
                     23: the descriptions OX messages are represented by th standard encoding
                     24: scheme on TCP/IP sockets.  In principle, an OX stack machine never
                     25: sends data to the output stream unless it receives {\tt SM\_pop*}
                     26: commands.  Note that the programming style should be different from
                     27: that for event-driven programming.
                     28: */
1.1       noro       29:
1.2       noro       30: //&jp \subsection{サーバスタックマシン }
                     31: //&eg \subsection{Server stack machine}
1.1       noro       32:
1.2       noro       33: /*&jp
1.1       noro       34: サンプルサーバである {\tt oxserver00.c}
                     35: は以下の仕様の C の関数を用意して,
                     36: {\tt nullstackmachine.c } を置き換えれば一応動作するはずである.
1.2       noro       37: */
                     38: /*&eg
                     39: {\tt oxserver00.c} is implemented as a sample server.
                     40: If you want to implement you own server,
                     41: write the following functions and use them instead of
1.4     ! noro       42: those in {\tt nullstackmachine.c}.
1.2       noro       43: */
1.1       noro       44:
1.4     ! noro       45: //&jp \subsubsection{サーバスタックマシンのグループ SMobject/Primitive に属するオペレータ}
        !            46: //&eg \subsubsection{Operators in the group SMobject/Primitive}
1.1       noro       47:
1.2       noro       48: /*&jp
1.1       noro       49: \noindent
1.2       noro       50: サーバスタックマシンは最低で1本のスタック
                     51: \begin{verbatim}
                     52: Object xxx_OperandStack[SIZE];
                     53: \end{verbatim}
                     54: をもつ.  ここで, {\tt Object} はそのシステム固有の Object 型で構わない.
                     55: CMObject は各サーバ固有のローカルオブジェクトに変換してスタックへプッ
                     56: シュしてよい.  ただし変換, 逆変換を合成したものは恒等写像であることが
                     57: のぞましい.  CMObject をどのように (local) Object に変換するか, Object
                     58: が受け付けるメッセージの定義は,各システムが独自にきめて文書化しておく
                     59: ものとする.  つまりすべてのメッセージは, private である.  たとえば,
                     60: {\tt add } のような基本的な メッセージにたいしても, OX スタックマシン
                     61: はなにもきめていない.  将来的には open math \cite{openmath} のように
                     62: CMObject に対する最大公約数的なメッセージの仕様をcontent dictionary
                     63: (CD) の形で定義したい.
                     64:
                     65: 以下, \verb+ xxx_ + は誤解の恐れがないときは省略する.
                     66: \verb+ xxx_ + は local サーバシステムに固有の識別子である.
                     67: {\tt Asir} の場合は \verb+ Asir_ + を用いる.  {\tt kan/sm1} の場合は
                     68: \verb+ Sm1_ + を用いる.  関数名, タグ名は長いので省略形を用いてもよい.
                     69:
                     70: 以下では次のようにパケットを記述する.  各フィールドは,
                     71: \fbox{データ型 \quad  データ} なる形式
                     72: で書く.  たとえば, {\tt int32 OX\_DATA} は 32 bit network byte order
                     73: の数字 {\tt OX\_DATA}という意味である.  ``イタリックで書かれているフィー
                     74: ルドは,定義が別のところでなされているか解釈に誤解のないような自然言語
                     75: で説明されている object を表す.''  たとえば, {\it String commandName}
                     76: は, String データ型の local object {\it commandName} を意味する.  (サー
                     77: バスタックマシン上の object は, CMO 形式の objectとは限らないことに注
                     78: 意.  CMO 形式で書いてあっても, それはサーバスタックマシンのlocal 形式
                     79: でスタック上にあると解釈して下さい.)
1.1       noro       80:
1.4     ! noro       81: すべてのサーバスタックマシンは以下の操作を実装していないといけない.
        !            82: 各操作に対し, その前後におけるスタックの状態を示す. 図において,
        !            83: 右端のオブジェクトがスタックのトップに対応する.
1.2       noro       84: */
1.1       noro       85:
1.2       noro       86: /*&eg
1.1       noro       87: \noindent
1.2       noro       88: Any OX stack machine has at least one stack.
1.1       noro       89: \begin{verbatim}
                     90: Object xxx_OperandStack[SIZE];
                     91: \end{verbatim}
1.2       noro       92: Here {\tt Object} may be local to the system {\tt xxx} wrapped by the stack
                     93: machine.
1.4     ! noro       94: That is, the server may translate CMObjects into its local
        !            95: objects and push them onto the stack.  It is preferable that
1.2       noro       96: the composition of such a translation and its inverse is equal to the
1.4     ! noro       97: identity map. The translation scheme is called the {\it phrase book} of the
1.2       noro       98: server and it should be documented for each stack machine.  In OpenXM,
1.4     ! noro       99: any message is private to a connection.  In future we will provide a content
1.2       noro      100: dictionary (CD; see OpenMath \cite{openmath}) for basic specifications
                    101: of CMObjects.
                    102:
                    103: In the following, \verb+ xxx_ + may be omitted if no confusion occurs.
                    104: As the names of functions and tags are long, one may use abbreviated
1.4     ! noro      105: names.  Message packets are represented as follows.
        !           106:
        !           107: Each field is shown as \fbox{data type \quad data}.  For example {\tt
        !           108: int32 OX\_DATA} denotes a number {\tt OX\_DATA} which is represented
        !           109: by a 32 bit integer with the network byte order.  If a field is
        !           110: displayed by italic characters, it should be defined elsewhere or its
        !           111: meaning should be clear.  For example {\it String commandName} denotes
        !           112: a local object {\it commandName} whose data type is String.  Note that
        !           113: an object on the stack may have a local data type even if it is
        !           114: represented as CMO.
1.1       noro      115:
1.2       noro      116: Any server stack machine has to implement the following operations.
1.4     ! noro      117: For each operation we show the states of the stack before and after
        !           118: the operation. In the figures the rightmost object corresponds to the
        !           119: top of the stack. Only the modified part of the stack are shown.
1.2       noro      120: */
1.1       noro      121:
                    122: \begin{enumerate}
1.2       noro      123: \item
                    124: /*&jp
1.4     ! noro      125: CMObject/Primitive の CMO データのうち必須のもの, {\tt CMO\_ERROR2}, {\tt
1.2       noro      126: CMO\_NULL}, {\tt CMO\_INT32}, {\tt CMO\_STRING}, {\tt CMO\_LIST}がおく
                    127: られて来た場合それをスタックに push する.  たとえば, {\tt CMO\_NULL}
                    128: あるいは {\tt CMO\_String} の場合次のようになる.
                    129: */
                    130: /*&eg
1.4     ! noro      131: Any server should accept CMObjects in the group CMObject/Primitive.
1.2       noro      132: The server pushes such data onto the stack.
                    133: The following examples show the states of the stack after receiving
                    134: {\tt CMO\_NULL} or {\tt CMO\_String} respectively.
                    135: */
1.1       noro      136:
1.2       noro      137: Request:
1.1       noro      138: \begin{tabular}{|c|c|}  \hline
                    139: {\tt int32 OX\_DATA} & {\tt int32 CMO\_NULL} \\
                    140: \hline
                    141: \end{tabular}
1.2       noro      142:
                    143: Stack after the request:
1.1       noro      144: \begin{tabular}{|c|}  \hline
                    145: {\it NULL} \\
                    146: \hline
                    147: \end{tabular}
                    148:
1.4     ! noro      149: Output:  none.
1.2       noro      150:
1.4     ! noro      151: Request:\\
1.1       noro      152: \begin{tabular}{|c|c|c|c|c|c|}  \hline
                    153: {\tt int32 OX\_DATA} & {\tt int32 CMO\_String} &{\tt int32} {\rm size}
                    154: &{\tt byte} {\rm s1} & $\cdots$ &{\tt byte} {\rm ssize}\\
                    155: \hline
                    156: \end{tabular}
1.2       noro      157:
                    158: Stack after the request:
1.1       noro      159: \begin{tabular}{|c|}  \hline
                    160: {\it String s} \\
                    161: \hline
                    162: \end{tabular}
                    163:
1.4     ! noro      164: Output:  none.
1.2       noro      165:
                    166: //&jp CMO データの受け取りに失敗した時のみ  \\
1.4     ! noro      167: //&eg If the server fails to receive a CMO data,\\
1.1       noro      168: \begin{tabular}{|c|c|c|}  \hline
                    169: {\tt int32 OX\_DATA} & {\tt int32 CMO\_ERROR2} & {\it CMObject} ob\\
                    170: \hline
                    171: \end{tabular}
                    172: \\
1.2       noro      173: /*&jp
1.1       noro      174: をスタックへ push する.
                    175: 現在のところ, ob には, \\
                    176: \centerline{
                    177: [{\sl Integer32} OX パケット番号, {\sl Integer32} エラー番号,
                    178: {\sl CMObject} optional 情報]
                    179: }
                    180: なるリストを入れる (CMO 形式でかいてあるが, これはサーバ独自の形式でよい.
                    181: CMO として送出されるときこのような形式でないといけないという意味である.)
1.2       noro      182: */
                    183: /*&eg
                    184: is pushed onto the stack.
                    185: Currently ob is a list\\
                    186: \centerline{
                    187: [{\sl Integer32} OX serial number, {\sl Integer32} error code,
                    188: {\sl CMObject} optional information]
                    189: }
                    190: */
1.1       noro      191:
                    192: \item
                    193: \begin{verbatim}
1.2       noro      194: SM_mathcap
1.1       noro      195: \end{verbatim}
1.2       noro      196: /*&jp
                    197: このサーバの mathcap をもどす (termcap のまね).  サーバのタイプ, サー
                    198: バスタックマシンの能力を知ることができる.  C 言語で実装する場合は,
1.4     ! noro      199: mathcap の構造体をシステム毎にきめるものとし,この関数はその構造体への
        !           200: ポインタを戻す.  (open sm1 では {\tt struct mathcap} を用いている.
1.2       noro      201: */
                    202: /*&eg
1.3       noro      203: It requests a server to push the mathcap of the server.
1.2       noro      204: The mathcap is similar to the termcap. One can know the server type
                    205: and the capability of the server from the mathcap.
                    206: */
1.1       noro      207: @plugin/mathcap.h)
1.2       noro      208:
                    209: Request:
1.1       noro      210: \begin{tabular}{|c|c|}  \hline
                    211: {\tt int32 OX\_COMMAND} & {\tt int32 SM\_mathcap}  \\
                    212: \hline
                    213: \end{tabular}
1.2       noro      214:
1.3       noro      215: Stack after the request:
1.1       noro      216: \begin{tabular}{|c|c|}  \hline
                    217: {\tt int32 OX\_DATA} & {\sl Mathcap}  mathCapOb \\
                    218: \hline
                    219: \end{tabular}
                    220:
1.4     ! noro      221: Output: none.
1.3       noro      222:
1.1       noro      223: \item
                    224: \begin{verbatim}
1.4     ! noro      225: SM_setMathcap
1.1       noro      226: \end{verbatim}
1.2       noro      227: /*&jp
                    228: 受け取った Mathcap {\tt m} を自分のシステムに設定して, 相手側が理解不
1.4     ! noro      229: 能な CMO をおくらないようにする.  C 言語で実装する場合は, mathcap の構
1.2       noro      230: 造体をシステム毎にきめるものとし,この関数はその構造体へのポインタを引
1.4     ! noro      231: 数とする.  (open sm1 では {\tt struct mathcap} を用いている.
1.2       noro      232: */
                    233: /*&eg
1.3       noro      234: It requests a server to register the peer's mathcap {\tt m} in the server.
1.2       noro      235: The server can avoid to send OX messages unknown to its peer.
                    236: */
1.1       noro      237: @plugin/mathcap.h)
1.2       noro      238:
                    239: Request:
1.1       noro      240: \begin{tabular}{|c|c|}  \hline
                    241: {\tt int32 OX\_DATA} & {\sl Mathcap} m  \\ \hline
1.4     ! noro      242: {\tt int32 OX\_COMMAND} & {\tt int32 SM\_setMathcap}  \\
1.1       noro      243: \hline
                    244: \end{tabular}
1.2       noro      245:
1.4     ! noro      246: Output:  none.
1.2       noro      247: /*&jp
                    248: \noindent
1.1       noro      249: 注意: mathcap は一般にクライアント主体で設定する.
                    250: クライアントがサーバに {\tt SM\_mathcap} をおくり,
                    251: サーバ側の mathcap を得る.
                    252: それを, クライアントはそのサーバに付随した mathcap として
                    253: 設定する.
                    254: 次に, クライアントはサーバに自分の mathcap を
1.4     ! noro      255: {\tt SM\_setMathcap} でおくり, 自分の mathcap を設定させる.
1.2       noro      256: */
                    257: /*&eg
                    258: \noindent
                    259: Remark: In general the exchange of mathcaps is triggered by a client.
                    260: A client sends {\tt SM\_mathcap} to a server and obtains the server's
                    261: mathcap. Then the client registers the mathcap. Finally the client
1.4     ! noro      262: sends its own mathcap by {\tt SM\_setMathcap} and the server
1.2       noro      263: registers it.
                    264: */
1.1       noro      265:
                    266: \item
                    267: \begin{verbatim}
1.2       noro      268: SM_executeStringByLocalParser
1.1       noro      269: \end{verbatim}
1.2       noro      270: /*&jp
1.3       noro      271: 文字列 {\tt s} を stack から pop し,
                    272: その文字列をシステム固有の文法(サーバスタックマシンの組み込みローカ
                    273: ル言語)にしたがったコマンドとして実行する.  コマンドの実行の結
1.2       noro      274: 果の最後に戻り値があるときは, {\tt OperandStack} に戻り値を push する.
1.3       noro      275: OpenXM では, 現在のところ関数名の標準化はおこなっていない.
1.2       noro      276: この関数および {\tt popString} の機能を実現すれば, 最低限の open XM の
                    277: サーバになれる.  実装では, まずこの二つの関数の機能を実現すべきである.
                    278: */
                    279: /*&eg
1.3       noro      280: It requests a server to pop a character string {\tt s}, to
                    281: parse it by the local parser of the stack machine,  and
1.4     ! noro      282: to interpret by the local interpreter.
        !           283: If the execution produces a Output, it is pushed onto
1.2       noro      284: {\tt OperandStack}.
1.4     ! noro      285: If an error has occurred,  Error2 Object is pushed onto the stack.
1.2       noro      286: OpenXM does not provide standard function names.
                    287: If this operation and {\tt SM\_popString} is implemented, the stack machine
1.4     ! noro      288: is ready to be used as an OX server.
1.2       noro      289: */
                    290:
                    291: Stack before the request:
1.1       noro      292: \\
                    293: \begin{tabular}{|c|}  \hline
                    294: {\it String commandString} \\
                    295: \hline
                    296: \end{tabular}
1.2       noro      297:
                    298: Request:
1.1       noro      299: \begin{tabular}{|c|c|}  \hline
                    300: {\tt int32 OX\_COMMAND}& {\tt int32 SM\_executeStringByLocalParser} \\
                    301: \hline
                    302: \end{tabular}
1.2       noro      303:
1.4     ! noro      304: Output:  none.
1.2       noro      305: /*&jp
                    306: \noindent
                    307: 参考: \  実行前のスタックのデータは,
1.4     ! noro      308: {\it String commandString} なる local stack machine の object としてス
1.2       noro      309: タック上にあるが, TCP/IP の通信路では, 次のようなデータがまずながれて
1.1       noro      310: {\it commandName} がスタックに push される:
1.2       noro      311: */
                    312: /*&eg
                    313: \noindent
                    314: Remark: Before this request, one has to push {\it String commandString}
                    315: onto the stack. It is done by sending the following OX data message.
                    316: */
1.1       noro      317: \begin{tabular}{|c|c|c|}  \hline
                    318: {\tt int32 OX\_DATA} & {\tt int32 CMO\_string} & {\it size and the string commandString} \\
                    319: \hline
                    320: \end{tabular}
                    321:
                    322: \item
                    323: \begin{verbatim}
1.2       noro      324: SM_executeStringByLocalParserInBatchMode
1.1       noro      325: \end{verbatim}
1.2       noro      326: /*&jp
                    327: スタックに副作用がない(スタックにたいしてなんの操作もしない)ことを除き
                    328: 上とまったく同じ関数である.  エラーの時のみ, Error2 Object をスタック
                    329: へプッシュする.
                    330: */
                    331: /*&eg
                    332: This is the same request as {\tt SM\_executeStringByLocalParser}
                    333: except that it does not modify the stack. It pushes an Error2 Object
1.4     ! noro      334: if an error has occurred.
1.2       noro      335: */
1.1       noro      336: \item
                    337: \begin{verbatim}
1.2       noro      338: SM_popString
                    339: \end{verbatim}
                    340: /*&jp
                    341: {\tt OperandStack} より Object を pop し, それを xxx の出力規則にしたがい文
                    342: 字列型に変換して送信する.  スタックが空のときは, {\tt (char *)NULL} を戻す.
1.3       noro      343: 文字列は TCP/IP stream へ CMO のデー
1.2       noro      344: タとして送信する.  エラーの場合は {\tt CMO\_ERROR2} を戻すべきである.
                    345: */
                    346: /*&eg
1.3       noro      347: It requests a server to pop an object from {\tt OperandStack},
1.2       noro      348: to convert it into a character string according to the output format
                    349: of the local system, and to send the character string via TCP/IP stream.
                    350: {\tt (char *)NULL} is returned when the stack is empty.
                    351: The returned strings is sent as a CMO string data.
1.4     ! noro      352: {\tt CMO\_ERROR2} should be returned if an error has occurred.
1.2       noro      353: */
                    354:
                    355: Stack before the request:
1.1       noro      356: \begin{tabular}{|c|}  \hline
                    357: {\it Object} \\
                    358: \hline
                    359: \end{tabular}
1.2       noro      360:
                    361: Request:
1.1       noro      362: \begin{tabular}{|c|c|}  \hline
                    363: {\tt int32 OX\_COMMAND} & {\tt int32 SM\_popString} \\
                    364: \hline
                    365: \end{tabular}
1.2       noro      366:
1.4     ! noro      367: Output:
1.1       noro      368: \begin{tabular}{|c|c|c|}  \hline
                    369: {\tt int32 OX\_DATA} & {\tt int32 CMO\_STRING} & {\it size and the string s} \\
                    370: \hline
                    371: \end{tabular}
                    372:
                    373: \item
                    374: \begin{verbatim}
1.2       noro      375: SM_getsp
1.1       noro      376: \end{verbatim}
1.2       noro      377: /*&jp
                    378: 現在のスタックポインタの位置をもどす.  スタート時点での位置は 0 であり,
                    379: object が push されたばあい, 1 づつ増えるものとする.
                    380: */
                    381: /*&eg
1.3       noro      382: It requests a server to push the current stack pointer onto the stack.
1.2       noro      383: The stack pointer is represented by a non-negative integer.
                    384: Its initial value is 0 and a push operation increments the
                    385: stack pointer by 1.
                    386: */
                    387:
                    388: Stack before the request:
1.1       noro      389: \begin{tabular}{|c|}  \hline
                    390: {\it Object} \\
                    391: \hline
                    392: \end{tabular}
1.2       noro      393:
                    394: Request:
1.1       noro      395: \begin{tabular}{|c|c|}  \hline
                    396: {\tt int32 OX\_COMMAND} & {\tt int32 SM\_getsp} \\
                    397: \hline
                    398: \end{tabular}
1.2       noro      399:
1.3       noro      400: Stack after the request:
1.1       noro      401: \begin{tabular}{|c|c|c|}  \hline
                    402: {\tt int32 OX\_DATA} & {\tt int32 CMO\_INT32} & {\it stack pointer value} \\
                    403: \hline
                    404: \end{tabular}
                    405:
1.4     ! noro      406: Output:  none.
1.3       noro      407:
1.1       noro      408: \item
                    409: \begin{verbatim}
1.2       noro      410: SM_dupErrors
1.1       noro      411: \end{verbatim}
1.2       noro      412: /*&jp
                    413: スタック上のエラーオブジェクトをリストにして戻す.  スタック自体は変化
                    414: させない.
                    415: */
                    416: /*&eg
1.3       noro      417: It requests a server to push a list object containing all error objects on the stack.
1.2       noro      418: */
                    419:
                    420: Request:
1.1       noro      421: \begin{tabular}{|c|c|}  \hline
                    422: {\tt int32 OX\_COMMAND} & {\tt int32 SM\_dupErrors} \\
                    423: \hline
                    424: \end{tabular}
1.2       noro      425:
1.3       noro      426: Stack after the request:
1.1       noro      427: \begin{tabular}{|c|c|c|}  \hline
                    428: {\tt int32 OX\_DATA} & {\sl CMObject} \ a list of errors\\
                    429: \hline
                    430: \end{tabular}
1.3       noro      431:
1.4     ! noro      432: Output: none.
1.1       noro      433: \end{enumerate}
                    434:
                    435: \medbreak
                    436: \noindent
1.2       noro      437: /*&jp
1.1       noro      438: {\bf 例}: \
                    439: mathcap の問い合わせに対して, {\tt ox\_sm1} は次のように答える.
1.2       noro      440: */
                    441: /*&eg
                    442: {\bf Example}: \
                    443: {\tt ox\_sm1} returns the following data as its mathcap.
                    444: */
1.4     ! noro      445: %%Prog: [(cmoMathcap)] extension ::
1.1       noro      446: \begin{verbatim}
                    447: Class.mathcap
                    448:  [ [199909080 , $Ox_system=ox_sm1.plain$ , $Version=2.990911$ ,
                    449:     $HOSTTYPE=i386$ ]  ,
                    450:    [262 , 263 , 264 , 265 , 266 , 268 , 269 , 272 , 273 , 275 , 276 ]  ,
                    451:    [[514] , [2130706434 , 1 , 2 , 4 , 5 , 17 , 19 , 20 , 22 , 23 , 24 ,
                    452:              25 , 26 , 30 , 31 , 60 , 61 , 27 , 33 , 40 , 34 ]]]
                    453: \end{verbatim}
                    454:
1.2       noro      455: /*&jp
                    456: mathcap は 3つの要素をもつリストである.  まづ, 最初の要素を見よう.
1.4     ! noro      457: Ox\_system は openXM システム名である.  読み込むライブラリがちがって
1.2       noro      458: いて, 関数名(または シンボル)の意味がちがうときはこの名前もかえる. た
                    459: とえば, open math の basic content dictionary 対応の関数定義マクロを読
1.4     ! noro      460: みこんだ sm1 は, ox\_sm1\_basicCD なる名前にする.  HOSTTYPE 値は, CPU
1.2       noro      461: の種類をあらわしunix では環境変数\verb+$HOSTTYPE+ の値である.  2 番目
                    462: の要素は 利用可能な SM コマンドをあつめたリストである.  3 番目のリスト
                    463: は, 処理可能な数学データの形式, およびCMOの場合なら処理可能なCMOのタグ
                    464: のリストが続く.  上の例では, 514 は {\tt OX\_DATA} をあらわし, 数学デー
                    465: タのフォマットは(サイズ情報なしの) CMO であることを示す.
                    466: */
                    467: /*&eg
                    468: A mathcap has three components. The first one contains informations
                    469: to identify the system and hosts on which the application runs.
1.4     ! noro      470: In the above example, {\tt Ox\_system} denotes the system name.
        !           471: {\tt HOSTTYPE} represents the OS type and taken from \verb+$HOSTTYPE+
1.2       noro      472: enviroment variable.
                    473: The second component consists of avaiable SM commands.
                    474: The third component is a list of pairs. Each pair consists
                    475: of an OX message tag and the available message tags.
                    476: Again in the above example, 514 is the value of {\tt OX\_DATA}
                    477: and it indicates that the server accepts CMO (without size information)
                    478: as mathematical data messages. In this case the subsequent
                    479: list represents available CMO tags.
                    480: */
1.1       noro      481:
                    482: \medbreak
                    483: \noindent
1.2       noro      484: //&jp {\bf 例}: \
                    485: //&eg {\bf Example}: \
1.1       noro      486: %%Prog: (ox.sm1) run  sm1connectr  [(oxWatch) ox.ccc] extension
                    487: %%Prog: ox.ccc (122345; ) oxsubmit ;
1.2       noro      488: //&jp {\tt message\_body} の実例をあげる.   シリアル番号部は除いてある.
1.3       noro      489: //&eg We show examples of {\tt message\_body}. Serial numbers are omitted.
1.1       noro      490: \begin{enumerate}
                    491: \item  {\tt executeStringByLocalParser("12345 ;");}
1.2       noro      492: /*&jp
                    493: は次のようなパケットに変換される. 各数字は 16進1バイトをあらわす.
                    494: {\tt xx(yy)} のなかの {\tt (yy)} は対応するアスキーコードをあわらす.
                    495: */
                    496: /*&eg
1.3       noro      497: is converted into the following packet. Each number denotes
                    498: one byte in hexadecimal representation.
                    499: {\tt (yy)} in {\tt xx(yy)} represents the corresponding ASCII code.
1.2       noro      500: */
1.1       noro      501: \begin{verbatim}
                    502: 0   0   2   2   0   0   0   4   0   0   0   7
                    503: 31(1)  32(2)  33(3)  34(4)  35(5)  20  3b(;)
                    504: 0   0   2   1   0   0   1   c
                    505: \end{verbatim}
1.2       noro      506: /*&jp
1.3       noro      507: それぞれのデータの意味は次のとおりである.
                    508: */
                    509: /*&eg
                    510: Each data has the following meaning.
1.2       noro      511: */
1.1       noro      512:
                    513: \begin{verbatim}
                    514: 0   0   2   2  (OX_DATA) 0   0   0   4  (CMO_STRING)
                    515: 0   0   0   7  (size)
                    516: 31(1)  32(2)  33(3)  34(4)  35(5)  20  3b(;)   (data)
                    517: 0   0   2   1  (OX_COMMAND)
                    518: 0   0   1   c  (SM_executeStringByLocalParser)
                    519: \end{verbatim}
1.2       noro      520: //&jp これを OXexpression で表記すると次のようになる.
1.3       noro      521: //&eg This is expressed by OXexpression as follows.
1.1       noro      522: \begin{center}
                    523: (OX\_DATA, (CMO\_STRING, 7, "12345 ;"))
                    524: \end{center}
                    525: \begin{center}
                    526: (OX\_COMMAND, (SM\_executeStringByLocalParser))
                    527: \end{center}
                    528:
1.2       noro      529: //&jp \item  {\tt popString()}  を要請するメッセージ:
1.3       noro      530: //&eg \item  A message which requests {\tt SM\_popString}:
1.1       noro      531: \begin{verbatim}
                    532: 0   0   2   1  (OX_COMMAND)
                    533: 0   0   1   7  (SM_popString)
                    534: \end{verbatim}
1.3       noro      535: //&jp OXexpression では
                    536: //&eg In OXexpression it is represented as
1.1       noro      537: (OX\_COMMAND, (SM\_popString)).
                    538:
                    539: \noindent
1.2       noro      540: //&jp これにたいして次の返答メッセージがくる.
1.3       noro      541: //&eg The server returns the following reply message:
1.1       noro      542: \begin{verbatim}
                    543: 0   0   2   2   (OX_DATA)
                    544: 0   0   0   4   (CMO_STRING) 0   0   0   5  (size)
                    545: 31(1)  32(2)  33(3)  34(4)  35(5)
                    546: \end{verbatim}
1.2       noro      547: //&jp OXexpression でかくと,
1.3       noro      548: //&eg In OXexpression it is represented as
1.1       noro      549: (OX\_DATA, (CMO\_STRING, 7, "12345 ;")).
                    550: \end{enumerate}
                    551:
1.4     ! noro      552: //&jp \subsubsection{グループ SMobject/Basic に属するオペレータ}
        !           553: //&eg \subsubsection{Operators in the group SMobject/Basic}
1.1       noro      554:
                    555: \begin{enumerate}
                    556: \item
                    557: \begin{verbatim}
1.3       noro      558: SM_pops
1.1       noro      559: \end{verbatim}
1.2       noro      560: /*&jp
1.4     ! noro      561: operand stack より, {\it n} 個の元 ({\it obj1, obj2, $\ldots$, objn}
1.2       noro      562: を pop して捨てる.
                    563: */
                    564: /*&eg
1.3       noro      565: It requests a server to pop {\it n} and to discard elements {\it obj1, obj2,
                    566: $\ldots$, objn}) from the stack.
1.2       noro      567: */
                    568:
1.4     ! noro      569: //&jp Stack before the request: \\
        !           570: //&eg Stack before the request: \\
1.1       noro      571: \begin{tabular}{|c|c|c|c|c|}  \hline
1.4     ! noro      572: {\it obj1} & {\it  obj2}  & $\cdots$ & {\it objn}  &{\it Integer32 n} \\
1.1       noro      573: \hline
                    574: \end{tabular}
1.2       noro      575:
                    576: Request:
1.1       noro      577: \begin{tabular}{|c|c|}  \hline
                    578: {\tt int32 OX\_COMMAND} & {\tt int32 SM\_pops } \\
                    579: \hline
                    580: \end{tabular}
1.2       noro      581:
1.4     ! noro      582: Output:  none.
1.1       noro      583:
                    584:
                    585: \item
                    586: \begin{verbatim}
1.3       noro      587: int SM_setName
1.1       noro      588: \end{verbatim}
1.2       noro      589: /*&jp
                    590: {\tt OperandStack} より {\it name} を pop し, つぎに{\tt OperandStack}
                    591: より {\it obj} を pop し, それを現在の名前空間で変数 {\it name} に
                    592: bind する.  正常終了なら 0 を, 異常終了なら -1 をもどす.  TCP/IP によ
                    593: る通信では, 異常終了の時のみ, {\tt CMO\_ERROR2} をstack へ push する.
                    594: */
                    595: /*&eg
1.3       noro      596: It requests a server to pop {\it name}, to pop {\it obj}, and to
1.4     ! noro      597: bind {\it obj} to a variable {\it name} in the current name space
        !           598: of the server.
        !           599: If an error has occurred {\tt CMO\_ERROR2} is pushed onto the stack.
1.2       noro      600: */
1.4     ! noro      601: //&jp Stack before the request:
        !           602: //&eg Stack before the request:
1.1       noro      603: \begin{tabular}{|c|c|}  \hline
                    604: {\it obj} & {\it String name}  \\
                    605: \hline
                    606: \end{tabular}
1.2       noro      607:
                    608: Request:
1.1       noro      609: \begin{tabular}{|c|c|}  \hline
                    610: {\tt int32 OX\_COMMAND} & {\tt int32 SM\_setName} \\
                    611: \hline
                    612: \end{tabular}
1.2       noro      613:
1.4     ! noro      614: Output: none.
1.1       noro      615:
                    616: \item
                    617: \begin{verbatim}
1.3       noro      618: SM_evalName
1.1       noro      619: \end{verbatim}
1.3       noro      620:
1.2       noro      621: /*&jp
                    622: 現在の名前空間で変数 {\it name} を評価する.  評価の結果 {\it
1.4     ! noro      623: OutputObj} をスタックへ戻す.  関数自体は正常終了なら 0 を, 異常終了な
1.2       noro      624: ら -1 をもどす.  TCP/IP の場合, 異常終了の場合のみ {\tt CMO\_ERROR2}
                    625: を stack へ push する.
                    626: */
1.3       noro      627:
1.2       noro      628: /*&eg
1.3       noro      629: It requests a server to pop {\it name} and to evaluate a variable
1.4     ! noro      630: {\it name} in the current name space. The Output of the evaluation
        !           631: {\it OutputObj} is pushed to the stack.
        !           632: If an error has occurred {\tt CMO\_ERROR2} is pushed to the stack.
1.2       noro      633: */
                    634:
1.4     ! noro      635: //&jp Stack before the request:
        !           636: //&eg Stack before the request:
1.1       noro      637: \begin{tabular}{|c|}  \hline
                    638: {\it String name}  \\
                    639: \hline
                    640: \end{tabular}
1.2       noro      641:
                    642: Request:
1.1       noro      643: \begin{tabular}{|c|c|}  \hline
                    644: {\tt int32 OX\_COMMAND} & {\tt int32 SM\_evalName} \\
                    645: \hline
                    646: \end{tabular}
1.2       noro      647:
1.4     ! noro      648: //&jp Stack after the request:
        !           649: //&eg Stack after the request:
1.1       noro      650: \begin{tabular}{|c|}  \hline
1.4     ! noro      651: {\it OutputObj} \\
1.1       noro      652: \hline
                    653: \end{tabular}
1.2       noro      654:
1.4     ! noro      655: Output:  none.
1.1       noro      656:
                    657: \item
                    658: \begin{verbatim}
1.3       noro      659: SM_executeFunction
1.1       noro      660: \end{verbatim}
1.2       noro      661: /*&jp
                    662: スタックより {\it n} 個のデータを pop して, サーバのローカル関数{\it
                    663: s} を実行する.  エラーのときのみ {\tt CMO\_ERROR2} を stack へ push す
                    664: る.
                    665: */
                    666: /*&eg
1.3       noro      667: It requests a server to pop {\it s} as a function name,
                    668: to pop {\it n} as the number of arguments and to execute
                    669: a local function {\it s} with {\it n} arguments popped from
                    670: the stack.
1.4     ! noro      671: If an error has occurred {\tt CMO\_ERROR2} is pushed to the stack.
1.2       noro      672: */
                    673:
1.4     ! noro      674: //&jp Stack before the request: \\
        !           675: //&eg Stack before the request: \\
1.1       noro      676: \begin{tabular}{|c|c|c|c|c|}  \hline
                    677: {\it objn} & $\cdots$ & {\it obj1} & {\it INT32 n} & {\it String s} \\
                    678: \hline
                    679: \end{tabular}
1.2       noro      680:
                    681: Request:
1.1       noro      682: \begin{tabular}{|c|c|}  \hline
                    683: {\tt int32 OX\_COMMAND} & {\tt int32 SM\_executeFunction}  \\
                    684: \hline
                    685: \end{tabular}
                    686:
1.2       noro      687: //&jp Stack after the request: 関数実行の結果.
1.4     ! noro      688: //&eg Stack after the request: The Output of the execution.
1.1       noro      689:
1.4     ! noro      690: Output: none.
1.1       noro      691:
                    692: \item
                    693: \begin{verbatim}
1.3       noro      694: SM_popSerializedLocalObject
1.1       noro      695: \end{verbatim}
1.3       noro      696:
1.2       noro      697: /*&jp
1.3       noro      698: スタックより pop した object を local 形式で serialization して
                    699: OX message として stream へ出力する. OX message tag としては,
                    700: local 形式に対応したものが定義されていることが必要である.
                    701: この関数はおもに, homogeneous な分散システムで用いる.
1.2       noro      702: */
                    703: /*&eg
1.3       noro      704: It requests a sever to pop an object, to convert it into a
                    705: serialized form according to a local serialization scheme, and
                    706: to send it to the stream as an OX message.
                    707: An OX message tag corresponding to
                    708: the local data format must be sent prior to the serialized data
                    709: itself.
                    710: This operation is used mainly on homogeneous distributed systems.
1.2       noro      711: */
1.1       noro      712:
                    713: \item
                    714: \begin{verbatim}
1.3       noro      715: SM_popCMO
1.1       noro      716: \end{verbatim}
                    717:
1.2       noro      718: /*&jp
1.3       noro      719: {\tt OperandStack} より object を pop し CMO 形式の serialized object を
                    720: stream へ header {\tt OX\_DATA} をつけてながす.
1.2       noro      721: */
                    722: /*&eg
1.3       noro      723: It requests a server to pop an object from the stack, to convert
                    724: it into a serialized form according to the standard CMO encoding scheme,
                    725: and to send it to the stream with the {\tt OX\_DATA} header.
1.2       noro      726: */
                    727:
                    728: Request:
1.1       noro      729: \begin{tabular}{|c|c|}  \hline
                    730: {\tt int32 OX\_COMMAND} & {\tt int32 OX\_popCMO}  \\
                    731: \hline
                    732: \end{tabular}
1.2       noro      733:
1.4     ! noro      734: Output:
1.1       noro      735: \begin{tabular}{|c|c|}  \hline
                    736: {\tt int32 OX\_DATA} &   {\it Serialized CMO} \\
                    737: \hline
                    738: \end{tabular}
                    739:
                    740: \end{enumerate}
                    741:

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>