newinstance

この関数は、指定されたクラスの新しいインスタンスを生成します。newinstace を使うことは、Max で新しいオブジェクトボックスにオブジェクト名をタイプすることと同じです。違いは、どのパッチャーウィンドウにもオブジェクトボックスは表示されず、パッチコードの接続なしに直接オブジェクトに対してメッセージを送ることができるという点です。メッセージは、型チェックを行ったもの（typedmess を使います）でも、型チェックを行わないもの（getfnファミリのメンバを使います）でも可能です。

newinstance は生成されたオブジェクトへのポインタを返しますが、クラスが存在しない場合やインスタンス生成時に他の種類のエラーが生じた場合には０を返します。この関数は、tables のような既存のオブジェクトを、新しいオブジェクトの中で「プライベート」に利用したい場合に役立ちます。プライベートに定義されたクラスを使っている例として、coll オブジェクトのソースコードを参照して下さい。

typedmess

メッセージセレクタ

typedmess はMax オブジェクト（receiver）にメッセージとアーギュメントを送信します。receiver で指定したオブジェクトがメッセージに応答できない場合、typedmess はその結果を返します。あるいは、Max ウィンドウにエラーメッセージが表示され、0が返されます。メッセージは文字列ではなく、t_symbol でなければならない点に注意して下さい。このため、typedmess に渡す前に、文字列に対して gensym を呼び出さなければなりません。また、typedmess が、クラスのアーギュメントリストで A_CANT と定義される「型指定なしの」メッセージを送信することができない点も覚えておいて下さい。この場合には、代わりに下記の getfnなどを使う必要があります。

例：オブジェクトbang_me に bang メッセージを送る場合

void *bangResult; bangResult = typemess(bang_me,gensym(“bang”),0,0L);

getfn

getfn は、レシーバのメッセージリストによってメッセージセレクタ msg にバインドされたメソッドへのポインタを返します。メソッドが見つからない場合は、Max ウィンドウにエラーメッセージが表示され、０が返されます。

egetfn

egetfn は、レシーバのメッセージリストによってメッセージセレクタ msg にバインドされたメソッドへのポインタを返します。メソッドが見つからない場合は、何も行なわない（do_nothing） 関数へのポインタが返されます。

zgetfn

zgetfn は、レシーバのメッセージリストによってメッセージセレクタ msg にバインドされたメソッドへのポインタを返します。メソッドが見つからない場合は、０を返しますが、Max ウィンドウへのエラーメッセージの表示は行いません。

table_get

これは、table から４０番目の要素を取り出す例です。

long **storage,size,value; if (!table_get(gensym("somename"),&storage,&size)) { if (size > 40) value = *((*storage)+40); }

table_dirty

tableName で与えられた名前をもつtable オブジェクトに対し、table_dirty はそのdirty ビットをセットします。そのため、ユーザは table を閉じようとするとき、それを保存するかどうかを尋ねられます。 tableNameに関連づけられる table がない場合、table_dirty は０以外の値を返します。

edclose

edclose は次の２つのケースで、連携するオブジェクトに送られます。

• ウィンドウの w_scratch ビットがセットされている場合
• ウィンドウが閉じられようとする際、スクリーンに表示される“Save Changes?”アラートで、ユーザが Save をクリックした場合。このケースは、ウィンドウのw_scratch ビットがセットされていない場合です。

バインディング

宣言

このメソッドでは、エディタは編集ウィンドウのテキストをあなたに渡します。ウィンドウのw_scratch ビットがセットされている場合、ウィンドウのテキストがユーザに変更されたかどうかを知りたいと思うかもしれません。テキストエディットオブジェクト t_ed は ext_edit.h で定義されています。次のようなコードを使うと、エディタのウィンドウが持つ dirty ビットをチェックすることができます。（x->m_edit があなたのテキストエディタオブジェクトへのポインタであると仮定します）

if (x->m_edit->e_wind->w_dirty) /* すでに変更されている */

テキストが変更された場合には、edclose メッセージのtext アーギュメントを使って、あなたのオブジェクトの状態を更新することができます。

edclose メッセージを受け取ると、テキストエディタウィンドウは消滅するため、これをあなたのオブジェクトの内部状態に記録しておくことは重要です。テキストエディタを指すオブジェクトのフィールドに、この時点で０をセットするというのは、良いアイディアです。

edsave

バインディング

宣言

テキストエディタウィンドウが保存されようとするとき、オブジェクトはこのメッセージを受け取ります。メソッドは、指定したファイルに、希望するフォーマットで保存することができます。保存せずに、単にテキストにアクセスしたい場合には、この関数から０を返すと、通常のファイル保存手続きが使われます。そうでない場合は０以外の値を返します。

ed_new

この関数は新しいテキスト編集ウィンドウを生成します。テキストエディタが即座に表示されます。assoc はあなたのオブジェクトへのポインタでなければなりません。これによって、非常に重要な edclose メッセージを受け取ることが可能になります。ed_new の結果は、オブジェクト内に保存しておかなければなりません。これには２つの理由があります。第１は、ウィンドウにテキストをセットする場合に ed_settext を呼び出せるようにするため、第２は、あなたのオブジェクトがdblclick メッセージを受信したときにウィンドウを前面に表示するed_vis を呼び出せるようにするためです。

ed_settext

ed_settext はテキスト編集ウィンドウに、textHandle が持つ文字列をセットします。ウィンドウは新しい文テキストを表示するために更新されます。

ed_vis

テキスト編集ウィンドウに標準の動作を実装したい場合には、dblclick メッセージを受け取った後にのみウィンドウが表示されるようにしておきます。テキスト編集ウィンドウは、ed_new によって作られた時に即座に表示されるもので、あなたのオブジェクト生成関数で作られるものではありません。正確には、オブジェクトが生成される際に、エディタを保存するスロットを０で初期化します。そして、オブジェクトのdblclick メソッドで新しいエディタの作成や既存のエディタを前面に表示する必要があるかどうかを判断することができます。

　これは、dblclick メソッドの例です。ここでは、があなたのオブジェクトがテキストエディタを保持しておくフィールドが x->m_edit であると仮定しています。

void myobject_dblclick(Myobject *x) { if (x->m_edit) ed_vis(x->m_edit); else { x->m_edit = ed_new(x); /* ed_settext によって、ここでエディタのテキストをセットします */ } }

expr_new

expr_new は argv の中のアーギュメントから expr オブジェクトを生成し、argv に含まれる全てのexprスタイルのアーギュメントの型（例えば、 $i1など）を、typesが参照する配列の個々のatomの中に返します。 types　には、前もって９個のAtom からなる配列が存在している必要があります。expr_new は、このすべてに値を書き込みます。アーギュメントが存在しない場合には、タイプ A_NOTHING がセットされます。例として、argv が次のようなものを参照していると仮定してください。

expr_eval

expr オブジェクト内の式をargv 内のアーギュメントで評価し、式を評価して得られた値とその型を result にt_atom として返します。result は１つのt_atom へのポインタである必要がありますが、argv は少なくと argc で示された数の Atom を持っていなくてはなりません。上記の expr_new の例のようにアーギュメントの間に「ギャップ（間）」がある場合は、t_atom の型にA_NOTHING を入れておかなければなりません。

preset_int

ユーザが preset を実行した場合、この関数の引数 value の int メッセージが preset オブジェクトからあなたのオブジェクトへ送られます。既存の全てのユーザインターフェイスオブジェクトは、preset が実行された場合、int メッセージを使って内部の状態をリストアします。

preset_set

ユーザが preset を実行した場合、この関数の引数 valueのset メッセージが、preset オブジェクトからあなたのオブジェクトへ送られます。

preset_store

これは、オブジェクトの状態がシンプルなint や set メッセージではリストアできない場合に使われる、一般的な preset 関数です。下記の例では、現在の状態を preset オブジェクトに対して指定する際に求められるフォーマットを示しています。最初に与えるのは、オブジェクト自身です。その次のシンボルはオブジェクトのクラス名です（これは、マクロ ob_sym を使ってオブジェクトから取得することができます。この宣言はext_mess.h にあります）。次に受け取りたいメッセージを指定するシンボルを与えます。（このためのメソッドがクラスで定義されているほうが良いでしょう）、続いてこのメッセージへのアーギュメント（オブジェクトのフィールドの現在の値）を与えます。

この例では、オブジェクトが set メッセージを受け取るよう指定して、preset_store を使っています。ここでは、myvalue という１つのフィールドがあり、これが保存、リストアされるものと仮定しています。

void myobject_preset(myobject *x) { preset_store("ossl",x,ob_sym(x),gensym("set"),x->myvalue); }

この preset が実行されると、オブジェクトは set メッセージを受け取り、そのアーギュメントが myvalue の値になっています。下で述べるように、同じことを preset_int や preset_set を使うことによって、より簡単に行なうことが可能であるという点に注意して下さい。

preset_store に12以上のアイテムを渡さないで下さい。それ以上に大量のデータを preset に保存したい場合は、binbuf_insert を使用して下さい。

次の例では、内部にプリセットデータを集めたbinbuf を設定し、用意しておいたAtomの配列で binbuf_insert を呼び出しています。この例では、オブジェクトの状態は set メッセージによってリストアされるものと仮定しています。

void myobject_preset(myObject *x) { void *preset_buf; /* プリセットを保存するbinbuf */ short atomCount; /* 保存を行なう Atom の数 */ t_atom atomArray[SOMESIZE];/* 保存が行なわれるAtom の配列 */ /* 1.presetの "ヘッダ" 情報の準備 */ SETOBJ(atomArray,x); SETSYM(atomArray+1,ob_sym(x)); SETSYM(atomArray+2,gensym("set")); /** atomArray+3 にオブジェクトの状態を入れ atomCountを設定する*/ /* 2. Binbufを見つける */ preset_buf = gensym("_preset")->s_thing; /* 3. データを保存する */ if (preset_buf) { binbuf_insert(preset_buf,NIL,atomCount,atomArray); } }

evnum_incr

evnum_get

serialno

この関数は、パッチャーファイルが保存される毎にインクリメントされるシリアルナンバを返します。このルーチンは、table や coll のように、同じデータを参照する複数のオブジェクトを持ち、パッチャーファイル内にデータを「埋め込む」ことのできるオブジェクトにとって役に立ちます。オブジェクトを最後に保存したときからシリアルナンバが変わっていなければ、これを探し出してオブジェクトデータの多重コピーを避けることができます。

stringload

この関数は、バイナリまたはテキスト形式のパッチャーファイルを検索し、それを開き、パッチャーファイルとして評価し、パッチャーのためにウィンドウを開いて前面に表示させます。ファイル名の指定を行なうだけで、Max がそのファイルを検索するためにサーチパス内を探します。サーチパスの検索は、現在の「デフォルトボリューム」から始められます。これは、多くの場合、最後にパッチャーファイルを開いたボリュームになります。さらに、File Preferences ダイアログで指定されたフォルダが深さ優先で検索され、最後にMax アプリケーションのあるフォルダが探されます。stringload が０以外の値を返した場合、後で freeobject を使ってパッチャーを閉じるか、または、ユーザ自身にそれを行なわせる必要があります。stringload が０を返した場合、指定された名前のファイルが見つからなかったか、それを開くためのメモリが不足していることを表します。

fileload

fileload は、引数 path にパスID の指定を必要とします。これは、openfile_dialog や locatefile_extended によって返されるものと同じです。ファイルが見つかると、fileload はファイルを開き、それを評価し、ウィンドウを開いて前面に表示させようとします。ロードが成功すると、新しく作られたパッチャーへのポインタを返します。また、ファイルが見つからない場合や、メモリが不足している場合には０を返します。

readtohandle

これは、テキストあるいはデータファイルを読み出すために用いられる低レベルルーチンです。ファイル名とパスID、およびハンドルへのポインタを指定します。ファイルが見つかると、readtohandle はハンドルを作り、ファイル中のすべてのデータをそこに読み込みます。そして、ハンドルを変数 hp に割り当て、データのサイズを size に返します。readtohandle はファイルのオープン、読み込みが成功すると０を返し、エラーが生じた場合は０以外を返します

lowload

この関数は、指定されたファイルをロードし、生成されたオブジェクトへのポインタを返します。通常、lowload はパッチャーファイルを開くために使われ、それがテキストファイルであるかMax バイナリフォーマットであるかを問いません。また、内容が "table" という語で始まるテーブルファイルを開くこともできます。

couldedit が０以外でファイルがパッチャーファイルでない場合は、テキストエディタとなり、lowloadは０を返します。couldedit が０以外の場合、lowloadはユーザにエラーの警告を出し、０を返します。エラーがなければ、返される値はパッチャー、あるいはテーブルへのポインタになります。

connection_client

接続機能によって同時に複数のクライアントにリンクすることを可能にする関数。接続はクライアントオブジェクトの中にある、リンクを目的としたフィールドにポインタを返す事によって行われます。このように、接続ルーチンを利用するためには、クライアントオブジェクトのデータ構造体は、この同じデータ構造体へのリンク用ポインタ変数を持っていなければなりません。下記のtraversal（走査）関数の実例を参照して下さい。

この関数はクライアントを名前で登録します。この名前を持ったサーバが既に存在し、connection_server の呼出しによって既に登録されている場合、connection_client によってクライアントオブジェクトはnewserver メッセージを受け取ります（下記を参照）。あるいは、指定された名前のサーバオブジェクトが connection_server を呼び出したときに、クライアントに newserver メッセージが送られます。

これは、引数 traverse として渡すtraversal（走査）関数の例です。最初にリンクポインタを持ったデータ構造体を示します。

typedef struct myclient { t_object c_ob; struct myclient *c_next; void *c_data; } t_myclient;

traverse（走査）メソッドは次のように宣言されます。

void *myobject_traverse(t_myobject *x, t_myobject ***ptr);

この関数は、ptr をデータ構造体の「次を指す（next to point）」フィールドのアドレスにセットします。そして、このフィールドの現在の内容を返します。上記のような Myclient データ構造体の場合、traverse（走査）メソッドは次のようになるでしょう。

void *myclient_traverse(t_myclient *x, t_myclient ***addr) { *addr = &x->c_next; return (x->c_next); }

connection_server

この関数は、オブジェクト server を名前name で登録します。この名前をつけられたクライアントオブジェクトが既に存在し、そのクラスがサーバオブジェクトと同じ場合、それらに対し、newserver メッセージによってサーバの存在が知らされます。このメソッドは次のように宣言されます。

void myobject_newserver (t_myobject *x, void *server);

このメソッドを使うことによって、クライアントは、オブジェクトへの直接のアクセスが必要な場合、サーバへの参照を保存できます。

connection_server を呼出した後、サーバはすべてのクライアントに connection_send を使ってメッセージを送ることができます。

connection_send

connection_send はシンボル name で関連付けられたオブジェクト server の接続状態を確認し、シンボル massage で指定された型指定なしのメッセージを（arg と共に）、その時点で接続されているクライアントすべてに送信します。サーバは実際にクライアントが存在するかどうかは全くわからないため、すべての場合において connection_send を呼び出さなければなりません。クライアントが存在しない場合、 connection_send は何も行いません（これは問題ありません）。

connection_delete

クライアントやサーバが接続を解除したい場合（通常、オブジェクトのfree 関数の中で） connection_delete を使います（引数 obj として、自分自身を渡します）。接続に使われる名前を name に与えます。connection_delete がサーバから呼び出された場合、接続されているすべてのクライアントは freeserver メッセージを受け取ります。このメッセージは次のように実行されなければなりません。

void myobject_freeserver (t_myobject *x, void *server);

error_subscribe

error_subscribe によって、オブジェクトはメッセージ (error)を受け取ることができるようになります。このメッセージの後には、Max ウィンドウに表示されるエラーメッセージの atom のリストが続きます。

error_subscribe を呼び出す前に、内部のエラー処理ルーチンに error メッセージをバインドしておかなければなりません。

addmess((method)myobject_error, "error", A_GIMME, 0);

エラー処理ルーチンは次のように宣言されなければなりません。

void myobject_error(t_myobject *x, t_symbol *s, 　　　　　　　　　　 short argc, t_atom *argv);

error_unsubscribe

この呼出しの後、myobject はエラーメッセージを受け取らなくなります。

setclock_delay

Clockオブジェクト clk をスケジュールし、カレントタイムより time ユニットだけ後に実行します。scheduler が０、または、setclock オブジェクトを参照していない場合には、内部のミリセカンド・スケジューラが使われます。そうでない場合、clk は setclock オブジェクトのClock のリスト上でスケジュールされます。Clock は clock_new によって作られなければならず、Clockへ渡したものと同じものが、clock_delay に渡されます。

setclock_fdelay

setclock_fdelay は setclock_delay の浮動小数点版です。

setclock_unset

この関数は、Clockオブジェクト clk を setclock オブジェクトの Clock のリストから取り除きます。schetuler が０の場合は内部のミリセカンド・スケジューラから取り除きます。

setclock_gettime

setclockオブジェクトのスケジューラの現在時刻を返します。schedulerが０の場合、setclock_gettime は、内部のミリセカンド・クロックの現在時刻を返す関数gettimeと同じものになります。

setclock_getftime

setclock_getftime は setclock_gettime の浮動小数点版です。

scheduler_new

この呼び出しは、新しく作られたスケジューラへのポインタを返します。

scheduler_set

スケジューラをカレントにすることで、先の時点での関連した呼び出し（clock_delay のような）が適切なスケジューラに作用します。このルーチンは以前カレントであったスケジューラへのポインタを返します。これを保存しておき、ローカルなスケジューリングが完了したときに復元しなければなりません。

scheduler_run

scheduler_settime

scheduler_gettime

event_process

ダイアログボックスのフィルタ処理を実装する場合に、event_process を使う場合があるかもしれません。Max はイベントを処理し、ダイアログボックスを移動させた場合のウィンドウの再描画といった処理を扱うことができます。

event_run

quittask_install

オペレーティングシステムに処理のためのイベントを送る場合に、quicktask_install を使います。

与えられた関数へのポインタと引数によって、quittask をインストールします。ポインタおよび引数はMax の終了時にこの関数に渡されます。

quittask_remove

与えられた関数へのポインタに関連付けられている、インストール済みの quittask を取り除きます。