OpenXM/src/ox_toolkit/README - diff

Return to README CVS log

Up to [local] / OpenXM / src / ox_toolkit

Diff for /OpenXM/src/ox_toolkit/README between version 1.7 and 1.11

version 1.7, 2000/01/14 10:23:34

version 1.11, 2000/10/10 05:23:19

Line 1

# Author: 小原功任 @ 金沢大学理学部計算科学教室

# URI: http://omega.s.kanazawa-u.ac.jp/ohara/

# $OpenXM: OpenXM/src/ox_toolkit/README,v 1.6 1999/12/22 11:29:15 ohara Exp $

# $OpenXM: OpenXM/src/ox_toolkit/README,v 1.10 2000/03/10 12:24:38 ohara Exp $

/*&ja ox_toolkit ユーザガイド

Line 25 In order to use libox.a, you need to include the follo

/*&common

#include <oxtag.h>

#include <ox_toolkit.h>

#include <ox.h>

#include <parse.h>

/*&ja

Line 42 In order to use libox.a, you need to include the follo

Line 40 In order to use libox.a, you need to include the follo

1. Types

1.1 CMO (Common Math Object)

The following structures are defined in ox.h:

The following structures are defined in ox_toolkit.h:

/*&common

Line 82 class.

Line 80 class.

/*&en

1.2 OX objects

The following structures are defined in ox.h:

The following structures are defined in ox_toolkit.h:

/*&common

Line 131 new_cmo_error2(cmo* ob);

Line 129 new_cmo_error2(cmo* ob);

/*&ja

3. 高水準 API

2.5 コネクション

OXFILE は OpenXM での通信路を表現するクラスである。このクラスのオブジェ

クトを明示的には生成しないこと。必ずコンストラクタを利用しなければなら

ない。これはクライアントとサーバで接続時の手順が異なることに由来する。

バイトオーダに関連した処理はこのクラスのメソッドで実現される。このクラ

スのメソッドとして次のものが用意されている。

2.5.1 コンストラクタ

OXFILE *oxf_connect_active(char *hostname, short port);

OXFILE *oxf_connect_passive(int listened);

OXFILE *oxf_open(int fd);

2.5.2 認証に関連したメソッド

int oxf_confirm_client(OXFILE *oxfp, char *passwd);

int oxf_confirm_server(OXFILE *oxfp, char *passwd);

void oxf_determine_byteorder_client(OXFILE *oxfp);

void oxf_determine_byteorder_server(OXFILE *oxfp);

void oxf_setopt(OXFILE *oxfp, int mode);

2.5.3 その他のメソッド

int oxf_read(void *buffer, size_t size, size_t num, OXFILE *oxfp);

int oxf_write(void *buffer, size_t size, size_t num, OXFILE *oxfp);

void oxf_flush(OXFILE *oxfp);

void oxf_close(OXFILE *oxfp);

/*&ja

3. 高水準 API(この記述は古いので使わないこと)

高水準 API は「OpenXM クライアント」から利用することを前提に設計されている。

3.1 通信の開始

Line 151 ox_start() or to call ox_start_insecure_nonreverse().

Line 177 ox_start() or to call ox_start_insecure_nonreverse().

/*&common

ox_file_t ox_start(char* host, char* prog1, char* prog2);

OXFILE *ox_start(char* host, char* prog1, char* prog2);

ox_file_t ox_start_insecure_nonreverse(char* host, short portControl, short portStream);

OXFILE *ox_start_insecure_nonreverse(char* host, short portControl, short portStream);

/*&ja

Line 195 ox_close() or to call ox_shutdown().

Line 221 ox_close() or to call ox_shutdown().

/*&common

void ox_close(ox_file_t sv);

void ox_close(OXFILE *sv);

void ox_shutdown(ox_file_t sv);

void ox_shutdown(OXFILE *sv);

/*&ja

Line 213 void ox_shutdown(ox_file_t sv);

Line 239 void ox_shutdown(ox_file_t sv);

/*&common

void ox_push_cmd(ox_file_t sv, int sm_code);

void ox_push_cmd(OXFILE *sv, int sm_code);

/*&ja

Line 222 void ox_push_cmd(ox_file_t sv, int sm_code);

Line 248 void ox_push_cmd(ox_file_t sv, int sm_code);

/*&en

ox_push_cmd() sends an operation code to an OpenXM stack machine.

See OpenXM/src/ox_toolkit/oxtag.h for a list of operation codes.

See OpenXM/include/ox_toolkit_tags.h for a list of operation codes.

/*&ja

Line 233 See OpenXM/src/ox_toolkit/oxtag.h for a list of operat

Line 259 See OpenXM/src/ox_toolkit/oxtag.h for a list of operat

/*&common

void ox_push_cmo(ox_file_t sv, cmo *c);

void ox_push_cmo(OXFILE *sv, cmo *c);

cmo* ox_pop_cmo(ox_file_t sv);

cmo* ox_pop_cmo(OXFILE *sv);

char* ox_popString(ox_file_t sv);

char* ox_popString(OXFILE *sv);

/*&ja

Line 251 ox_push_cmo は cmo を送信、ox_pop_cmo は cmo を受信す�

Line 277 ox_push_cmo は cmo を送信、ox_pop_cmo は cmo を受信す�

/*&common

int ox_pops(ox_file_t sv, int num);

int ox_pops(OXFILE *sv, int num);

/*&ja

Line 263 int ox_pops(ox_file_t sv, int num);

Line 289 int ox_pops(ox_file_t sv, int num);

/*&common

int ox_flush(ox_file_t sv);

int ox_flush(OXFILE *sv);

/*&ja

Line 275 int ox_flush(ox_file_t sv);

Line 301 int ox_flush(ox_file_t sv);

/*&common

void ox_reset(ox_file_t sv);

void ox_reset(OXFILE *sv);

/*&ja

Line 287 void ox_reset(ox_file_t sv);

Line 313 void ox_reset(ox_file_t sv);

/*&common

void ox_execute_string(ox_file_t sv, char* str);

void ox_execute_string(OXFILE *sv, char* str);

/*&ja

Line 299 void ox_execute_string(ox_file_t sv, char* str);

Line 325 void ox_execute_string(ox_file_t sv, char* str);

/*&common

int ox_cmo_rpc(ox_file_t sv, char *function, int argc, cmo *argv[]);

int ox_cmo_rpc(OXFILE *sv, char *function, int argc, cmo *argv[]);

/*&ja

Line 311 function(argv[1], ...) を計算し、結果をスタックに積む�

Line 337 function(argv[1], ...) を計算し、結果をスタックに積む�

/*&common

cmo_mathcap* ox_mathcap(ox_file_t sv);

cmo_mathcap* ox_mathcap(OXFILE *sv);

/*&ja

Line 424 receive_ox_tag() reads a tag and a serial number of an

Line 450 receive_ox_tag() reads a tag and a serial number of an

/*&common

4.6

4.6 Sending OX messages.

/*&common

Line 434 void send_ox_command(int fd, int sm_command);

Line 460 void send_ox_command(int fd, int sm_command);

/*&ja

ox メッセージを送信する。

OX メッセージを送信する。

/*&ja

Line 442 ox メッセージを送信する。

Line 468 ox メッセージを送信する。

5. OX expression パーサ

/*&en

5. Parser for OX expressions

/*&ja

OpenXM C library には文字列表現された

OpenXM C library には文字列表現された OX expression および CMO

OX expression および CMO expression から、

expression から、ox 構造体または cmo 構造体を生成するためのパーサが付

ox 構造体または cmo 構造体を生成するためのパーサが付属している。

属している。ここではこのパーサについて説明する。

/*&en

We have a parser which generate an OX object or a CMO from a string

encoded OX/CMO expression. In this section, we explain the parser.

/*&en

ここではこのパーサについて説明する。

5.1 Setting an option

/*&ja

5.1 オプション

/*&common

int setflag_parse(int flag);

/*&ja

setflag_parse(PFLAG_ADDREV) によって、CMO の短縮表現を許す。

/*&en

We set an option for the parser. If we call

setflag_parse(PFLAG_ADDREV), then the parser admits external

expressios.

/*&en

5.2 Initializing

/*&ja

5.2 初期化

/*&common

int init_parser(char *str);

/*&ja

パーサが処理すべき文字列をセットする。

/*&en

We give the parser an OX/CMO expression, that is, a Lisp style string.

/*&en

5.3 Getting an object

/*&ja

5.3 結果を得る

/*&common

cmo *parse();

Line 474 cmo *parse();

Line 539 cmo *parse();

Lisp 表現による OX expression, CMO expression の構文解析器。あらかじめ

設定された文字列を解析して ox 構造体、あるいは cmo 構造体を生成する。

/*&en

The parser returns an OX/CMO object. If the given string is illegal,

then the parser returns NULL.

/*&ja

7. 付属プログラムについて

Line 512 bconv

Line 581 bconv

A byte code encoder. It shows a byte stream which corresponds to an

OX expression.

/*&common

ox_Xsample

Line 520 ox_Xsample

Line 590 ox_Xsample

GUI 表示する OpenXM サーバのサンプル。

/*&ja

8. 付録

8.1 ox.c における関数の命名規則

(1) receive_cmo 関数はCMOタグとデータ本体を受信する. この関数は CMOタ

グの値が事前に分からないときに使用する. 返り値として、cmo へのポインタ

を返す.

(2) receive_cmo_X 関数は, CMOタグを親の関数で受信してから呼び出される

関数で、データ本体のみを受信し、cmo_X へのポインタを返す. しかも、関

数内部で new_cmo_X 関数を呼び出す.

(3) send_cmo 関数はCMOタグとデータ本体を送信する.

(4) send_cmo_X 関数はCMOタグを親の関数で送信してから呼び出される関数で、

データ本体のみを送信する.

(5) ただし receive_ox_tag を除いて, receive_ox_X 関数は作らない.

receive_cmo を利用する.

(6) send_ox_X 関数は OX タグを含めて送信する.

(7) ox_X 関数は一連の送受信を含むより抽象的な操作を表現する. ox_X 関

数は、第一引数として、ox_file_t型の変数 sv をとる.

(8) Y_cmo 関数と Y_cmo_X 関数の関係は次の通り:

まず Y_cmo 関数で cmo のタグを処理し、タグを除いた残りの部分をY_cmo_X

関数が処理する. cmo の内部に cmo_Z へのポインタがあるときには、その種

類によらずに Y_cmo 関数を呼び出す.

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