MakeHPI/hspdll/hspdll_hs - HSP開発wiki

hinekure.net が http://hspdev-wiki.net/ から自動クローリングした結果を表示しています。画像やリソースなどのリンクが切れています。予めご了承ください。

MakeHPI/hspdll/hspdll_hs - HSP開発wiki

OFFICIAL/関連

TUTORIAL

HSP基礎講座

TOPICS

ETC

EDIT

REFERENCE

LOG

お知らせ

お知らせ

HSP Web-Ring

前<-ランダム->次

最新の40件

2013-11-28

外部リンク

2013-11-25

2013-11-24

RecentDeleted

2013-11-23

ソフト開発

2013-11-14

HSPのフォームデザインソフト

2013-11-13

2013-11-10

TUT/calc

2013-11-06

ネタ収集BOX/1

2013-10-23

INIファイル操作モジュール

2013-10-21

String/矩形

2013-10-20

小ワザのその他

2013-10-15

実行結果図鑑

2013-10-12

ソフト開発/HSPLet3拡張ライブラリ/Tips

2013-10-06

Module/hspdb(SQLite版)

2013-09-15

小ワザ/モーダルダイアログ

2013-08-28

2013-08-26

Web Browserを作ろう

2013-08-15

2013-08-06

2013-08-05

ネットワークFPSを作ろう！！

2013-08-02

半透明ウインドウ

2013-07-05

小ワザ/ストップウォッチ

2013-07-02

2013-06-29

2013-06-28

Math/2次Bスプライン関数

2013-06-27

小ワザ/アクション/基本動作

2013-06-25

ＩＭＥの制御

2013-06-14

eller

2013-06-01

Math/平面回転

2013-05-29

衝突判定

2013-05-28

雑談

total: 1370
today: 1
yesterday: 1
now: 1

hspdll.hs †

hspdll.hsの修正用ページです。
元のページ

データ量が大きいので001～003まで1000行ずつで分けています。

001 †

+

001

Everything is expanded.

Everything is shortened.

;--------------------------------------------------
; HSP ヘルプ ソースファイル (hs 形式)
; hs ファイルの書式については、HS_BIBLE.txt を参照してください。
 
;--------------------------------------------------
; この hs ファイルのデフォルトのフィールド値を設定
 
%dll
; プラグイン/モジュール名 を記入
hspdll
%ver
; バージョン を記入
 
%date
; 日付 を記入
2009/01/18
%author
; 著作者 を記入
 
%url
; 関連 URL を記入
 
%note
; 備考 (補足情報等) を記入
 
%type
; タイプ を記入
dll/hpi
 
%port
; 対応環境 を記入
HSP3
%portinfo
; 移植のヒント を記入
 
%index
code_getdi
; 見出し を記入
整数値を取得します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( int defval )
int defval：整数値
%inst
; 解説文 を記入
int code_getdi( int defval );
 
整数値を取得します。パラメーターが省略された場合は、defvalを
デフォルトの値として返します。
実数(double)の場合は、整数に変換されたものを取得します。
それ以外の型はエラーになります。
 
%sample
; サンプルスクリプト を記入
 //	パラメータ１～３を取得するサンプル
    static void test1( void )
    {
        int p1,p2,p3;
        p1=code_getdi(0);	// パラメータ1:整数
        p2=code_getdi(0);	// パラメータ2:整数
        p3=code_getdi(0);	// パラメータ3:整数
    }
 
%href
; 関連項目 を記入
code_geti
 
%group
; グループ を記入
パラメーターの取得
 
%index
code_geti
; 見出し を記入
整数値を取得します。（デフォルト値なし）
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( void )
 
%inst
; 解説文 を記入
int code_geti( void );
 
code_getdiと同じですが、デフォルト値はありません。
パラメーターが省略された場合はエラーとなります。
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
code_getdi
 
%group
; グループ を記入
パラメーターの取得
 
 
 
%index
code_getdd
; 見出し を記入
実数値を取得します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( double defstr )
double defstr：実数値
%inst
; 解説文 を記入
double code_getdd( double defstr );
 
実数値を取得します。パラメーターが省略された場合は、defvalを
デフォルトの値として返します。
整数(int)の場合は、実数に変換されたものを取得します。
それ以外の型はエラーになります。
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
code_getd
 
%group
; グループ を記入
パラメーターの取得
 
 
%index
code_getd
; 見出し を記入
実数値を取得します。（デフォルト値なし）
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( void )
 
%inst
; 解説文 を記入
double code_getd( void );
 
code_getddと同じですが、デフォルト値はありません。
パラメーターが省略された場合はエラーとなります。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
code_getdd
%group
; グループ を記入
パラメーターの取得
 
 
%index
*code_getds
; 見出し を記入
文字列のポインタを取得。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( char *defstr )
char *defstr：文字列のポインタ
%inst
; 解説文 を記入
char *code_getds( char *defstr );
 
文字列のポインタを取得します。パラメーターが省略された場合は、
defstrをデフォルトとして返します。
文字列以外の型はエラーになります。
ここで得られたポインタは、次にパラメーターを取得するまでしか
有効ではありません。文字列の取得以降に、別なパラメーター
(文字列だけでなく整数値や実数値も含む)を取得した場合には、
文字データが破壊されますので、必ずパラメーター取得側で保存
するようにしてください。
また、文字列の取得は非常に長いデータが返ってくることも
ありますので、コピーする場合には必要な長さだけに制限するか、
文字列サイズが収まるだけのメモリを確保するようにしてください。
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
*code_gets
 
%group
; グループ を記入
パラメーターの取得
 
 
%index
*code_gets
; 見出し を記入
文字列のポインタを取得。（デフォルト値なし）
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( void )
 
%inst
; 解説文 を記入
char *code_gets( void );
 
code_getdsと同じですが、デフォルト値はありません。
パラメーターが省略された場合はエラーとなります。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
*code_getds
 
%group
; グループ を記入
パラメーターの取得
 
 
%index
*code_getlb
; 見出し を記入
ラベルが示すスクリプト上のポインタを取得。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( void )
 
%inst
; 解説文 を記入
unsigned short *code_getlb( void );
 
ラベルが示すスクリプト上のポインタを取得します。
ここで取得したラベルは、ジャンプ先やサブルーチンコールの
対象として扱うことができます。
ラベル以外が指定された場合はエラーになります。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
パラメーターの取得
 
 
%index
code_getva
; 見出し を記入
変数のPValポインタと、APTRのポインタを取得
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( PVal **pval )
PVal **pval：変数
%inst
; 解説文 を記入
APTR code_getva( PVal **pval );
 
パラメーターとして指定された変数のPValポインタと、APTRの
ポインタを取得します。
変数以外が指定された場合はエラーになります。
APTRポインタは、配列要素の値、
PValポインタは、変数の情報が格納されている情報への
ポインタとなります。
取得した変数の型は、PVal->flagで調べることができます。
取得した変数に代入を行なう場合には、code_setvを使用します。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
パラメーターの取得
 
 
%index
code_setva
; 見出し を記入
APTRとPValのポインタをもとに、変数に値を代入します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( PVal *pval, APTR aptr, int type, void *ptr )
PVal *pval：PVal構造体へのポインタ
APTR aptr：
int type：パラメーターの型
void *ptr：値が格納されている変数へのポインタ
%inst
; 解説文 を記入
void code_setva( PVal *pval, APTR aptr, int type, void *ptr );
 
APTRとPValのポインタをもとに、変数に値を代入します。
typeに代入する値の型(HSPVAR_FLAG_*)を、ptrに値が格納されている
ポインタを指定します。
変数に格納されている型が、代入される型と違う場合には、
代入される型に初期化されてから代入されます。
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
HSPVAR_FLAG_*
*HspFunc_getproc
 
%group
; グループ を記入
パラメーターの取得
 
 
%index
code_getprm
; 見出し を記入
パラメーターを１つ取得します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( void )
 
%inst
; 解説文 を記入
int code_getprm( void );
 
パラメーターを１つ取得します。
パラメーターの型は問いません。この関数の戻り値により、取得の
状況を確認することができます。戻り値は以下のいずれかになります。
 
#define PARAM_OK 0        // 正常に取得した
#define PARAM_SPLIT -1        // 正常に取得した(*)
#define PARAM_END -2        // 文末だった
#define PARAM_DEFAULT -3    // 省略されていた
#define PARAM_ENDSPLIT -4    // ')'だった
 
(*)PARAM_SPLITは、PARAM_OKと同様の意味ですが、次に取るパラメーターは
   PARAM_ENDSPLIT(カッコの終了)であることを示しています。
   PARAM_SPLITは、カッコ内のパラメーターを取得した場合以外では
   返されません。また、最後のパラメーターが省略値(PARAM_DEFAULT)
   の場合は、次のパラメーターを取得した場合には、PARAM_SPLITを返さずに
   PARAM_ENDSPLITが来るので注意してください。
 
PARAM_OK、PARAM_SPLITが返った場合には、変数mpvalがパラメーターの
内容を示す変数として作成されます。
(それ以外の戻り値では、mpvalは無効になります。)
実際には、「mpval->pt」がパラメーターの値が格納されているポインタ、
「mpval->flag」がパラメーターの型(HSPVAR_FLAG_*)になります。
(パラメーターとして変数が指定されていた場合でも、mpvalは変数そのものを
示すポインタとはなりません。mpvalは常に、結果の値が代入されたテンポラリ
の変数となります)
 
PARAM_DEFAULTが返った場合には、パラメーターが省略されていることを
示します。
取得すべきパラメーターが無い場合は、PARAM_ENDまたは、PARAM_ENDSPLITが
返ります。PARAM_ENDSPLITは、カッコ内のパラメーターが終了したことを
示す値になります。
 
 
■code_getprmの注意点
 
型の不定なパラメーターを取得するためのcode_getprm関数では、
一時的なパラメーター保管を行なうmpval変数を介して行なわれます。
mpvalは、スクリプトで指定されている変数のPValポインタ
(code_getvaで取得されるPValポインタ)とは異なるので注意してください。
また、mpvalポインタはシステムが管理しているため、値の修正や、
型の変更など、構造体の内容が変更される処理は避けて下さい。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
HSPVAR_FLAG_*
 
%group
; グループ を記入
パラメーターの取得
 
 
%index
*code_getv
; 見出し を記入
HSPEXINFO内に用意されたver2.61互換の$202規約呼び出し用の関数
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( void )
 
%inst
; 解説文 を記入
void *code_getv( void );
 
HSPEXINFO内に用意されたver2.61互換の$202規約呼び出し用の関数です。
$202規約呼び出しでは、PValポインタを取得するために、mpvalポインタを
参照します。code_getv関数は、mpvalポインタを更新して、取得された
変数のポインタを示します。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
パラメーターの取得
 
 
%index
code_next
; 見出し を記入
中間コードを取得
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( void )
 
%inst
; 解説文 を記入
void code_next( void );
 
次の中間コードを取得します。
取得されたパラメーターは、*type、*valに反映されます。
*typeは、「TYPE_*」の値が、*valは内容を示す値になります。
この命令は、通常パラメーター取得で使用する必要はありません。
独自に、中間コードを読み取って処理を行なうような特殊な場面でのみ
使用してください。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
パラメーターの取得
 
 
 
 
%index
*getbmscr
; 見出し を記入
widで指定したウインドゥIDの情報を返します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( int wid )
int wid：
%inst
; 解説文 を記入
void *getbmscr( int wid );
 
widで指定したウインドゥIDの情報を返します。
HSP3の標準GUIを使用している場合は、BMSCR構造体へのポインタになります。
BMSCR構造体についての詳細は、別項を参照してください。
また、現在の操作先ウインドゥIDは、active_windowマクロによって取得する
ことができます。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
getobj
; 見出し を記入
widで指定したウインドゥIDに配置されている、idで指定された番号のオブジェクト情報を取得します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( int wid, int id, void *inf )
int wid, int id, void *inf：
%inst
; 解説文 を記入
int getobj( int wid, int id, void *inf );
 
widで指定したウインドゥIDに配置されている、idで指定された番号の
オブジェクト情報を取得します。
取得されたデータは、infで指定されたポインタにコピーされます。
HSP3の標準GUIを使用している場合は、infにはHSPOBJINFO構造体の内容が
コピーされることになります。
HSPOBJINFO構造体については、オブジェクト情報についての項目を参照
してください。
返値は、正常に終了した場合は0に、それ以外の値はエラーを示します。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
setobj
; 見出し を記入
widで指定したウインドゥIDに配置されている、idで指定された番号のオブジェクト情報を設定します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( int wid, int id, void *inf )
int wid, int id, void *inf：
%inst
; 解説文 を記入
int setobj( int wid, int id, void *inf );
 
widで指定したウインドゥIDに配置されている、idで指定された番号の
オブジェクト情報を設定します。
infで指定されたポインタから内部データにコピーされます。
HSP3の標準GUIを使用している場合は、infにはHSPOBJINFO構造体の内容が
コピーされることになります。
HSPOBJINFO構造体については、オブジェクト情報についての項目を参照
してください。
返値は、正常に終了した場合は0に、それ以外の値はエラーを示します。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
addobj
; 見出し を記入
widで指定したウインドゥIDに、新しいオブジェクトIDを生成して返します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( int wid )
int wid：
%inst
; 解説文 を記入
int addobj( int wid );
 
widで指定したウインドゥIDに、新しいオブジェクトIDを生成して返します。
プラグイン側で、独自のオブジェクトを生成する場合に使用します。
この関数でオブジェクトIDを生成したら、必ずsetobjで正しい情報を設定
するようにしてください。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
*HspFunc_getproc
; 見出し を記入
typeで指定された型(HSPVAR_FLAG_*)を処理するためのHspVarProc構造体ポインタ
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( int type )
int type：変数の型（HSPVAR_FLAG_*）
%inst
; 解説文 を記入
HspVarProc *HspFunc_getproc( int type );
 
typeで指定された型(HSPVAR_FLAG_*)を処理するためのHspVarProc構造体
ポインタを返します。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
HSPVAR_FLAG_*
code_setva
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
*seekproc
; 見出し を記入
nameで指定された型を処理するためのHspVarProc構造体ポインタを返します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( char *name )
char *name：
%inst
; 解説文 を記入
HspVarProc *seekproc( char *name );
 
nameで指定された型を処理するためのHspVarProc構造体ポインタを返します。
nameは、それぞれの型で設定されている型名(int,str,double等)を文字列で
指定します。これにより、プラグイン等で拡張された型も含めて、処理を
行なうための情報を取得、設定することができます。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
*hspexpand
; 見出し を記入
確保済みのメモリをより大きなサイズで再確保
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( char *ptr, int size )
char *ptr：
int size：
 
%inst
; 解説文 を記入
char *hspexpand( char *ptr, int size );
 
hspexpandは、既に確保済みのメモリをより大きなサイズで再確保します。
いままで保持されていた内容は変更されません。
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
*hspmalloc
hspfree
 
%group
; グループ を記入
内部情報の取得と設定
 
%index
hspfree
; 見出し を記入
メモリの確保と解放
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( void *ptr )
void *ptr：
%inst
; 解説文 を記入
void hspfree( void *ptr );
 
hspmallocと、hspfreeはHSP内部で管理するメモリマネージャーを経由して
メモリの確保と解放を行ないます。(malloc/freeと同様の使い方です。)
hspmallocと、hspfreeは少ないサイズ(64byte)であれば非常に高速に動作
します。また、HSP終了時にすべてのメモリは自動的に解放されます。
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
*hspmalloc
*hspexpand
 
%group
; グループ を記入
内部情報の取得と設定
 
%index
*hspmalloc
; 見出し を記入
メモリの確保と解放
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( int size )
int size：
%inst
; 解説文 を記入
void *hspmalloc( int size );
 
hspmallocと、hspfreeはHSP内部で管理するメモリマネージャーを経由して
メモリの確保と解放を行ないます。(malloc/freeと同様の使い方です。)
hspmallocと、hspfreeは少ないサイズ(64byte)であれば非常に高速に動作
します。また、HSP終了時にすべてのメモリは自動的に解放されます。
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
hspfree
*hspexpand
 
%group
; グループ を記入
内部情報の取得と設定
 
 
 
 
 
 
 
 
 
 
%index
code_event
; 見出し を記入
HSP内部イベントを発生させます。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( int event, int prm1, int prm2, void *prm3 )
int event, int prm1, int prm2, void *prm3：
%inst
; 解説文 を記入
int code_event( int event, int prm1, int prm2, void *prm3 );
 
HSP内部イベントを発生させます。
詳しくは、HSPイベントについてを参照してください。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
puterror
; 見出し を記入
HSPのエラーを発生させます。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( HSPERROR err )
HSPERROR err：
%inst
; 解説文 を記入
void puterror( HSPERROR err );
 
HSPのエラーを発生させます。
errに指定するエラーコードは、hsp3plugin.hで定義されています。
この関数は実行された後、戻ってきませんので注意してください。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
*addirq
; 見出し を記入
割り込み要因を追加します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( void )
 
%inst
; 解説文 を記入
IRQDAT *addirq( void );
 
割り込み要因を追加します。
oncmdと同様にWindowsのウインドゥメッセージに対する割り込みを独自に
追加することができます。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
registvar
; 見出し を記入
ストレージコアファンクション(HspVarProc)を登録します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( int flag, HSPVAR_COREFUNC func )
int flag, HSPVAR_COREFUNC func：
%inst
; 解説文 を記入
void registvar( int flag, HSPVAR_COREFUNC func );
 
ストレージコアファンクション(HspVarProc)を登録します。
flagには、既存のタイプIDか新規ID(-1)を指定し、
funcに初期化関数(HSPVAR_COREFUNC)のアドレスを渡して下さい。
ストレージコアファンクションの登録は、必ずHSP3TypeFunctionの初期化時に
行なう必要があります。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
code_setpc
; 見出し を記入
pcで指定したラベルへジャンプ(goto)を行ないます。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( unsigned short *pc )
unsigned short *pc：
%inst
; 解説文 を記入
void code_setpc( unsigned short *pc );
 
pcで指定したラベルへジャンプ(goto)を行ないます。
ラベルは、code_getlbで取得された値を使用します。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
code_call
; 見出し を記入
pcで指定したラベルへサブルーチンコール(gosub)を行ないます。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( unsigned short *pc )
unsigned short *pc：
%inst
; 解説文 を記入
void code_call( unsigned short *pc );
 
pcで指定したラベルへサブルーチンコール(gosub)を行ないます。
ラベルは、code_getlbで取得された値を使用します。
 
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
(*HspFunc_dim)
; 見出し を記入
変数を指定した配列要素で初期化
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( PVal *pval, int flag, int len0, int len1, int len2, int len3, int len4 )
PVal *pval    ：変数
int flag    ：初期化する型
int len0    ：１要素が可変サイズの場合の初期サイズ
int len1～4    ：各次元の最大数
%inst
; 解説文 を記入
void (*HspFunc_dim)( PVal *pval, int flag, int len0, int len1, int len2, int len3, int len4 );
 
pvalで指定した変数を指定した配列要素で初期化します。
dim命令と同様の動作になります。
len1～len4が各次元の最大数になります。使用しない次元は0になります。
len0は、１要素が可変サイズの場合の初期サイズを指定します。
(「sdim a,256」の256にあたる数値です。)
flagで初期化する型を指定します。
 
初期化する型はHSPVAR_FLAG_*の項を参照。
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
HSPVAR_FLAG_*
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
(*HspFunc_array)
; 見出し を記入
指定した配列要素を指したpvalを作成するために使用します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( PVal *pval, int offset )
PVal *pval, int offset：
%inst
; 解説文 を記入
void (*HspFunc_array)( PVal *pval, int offset );
 
指定した配列要素を指したpvalを作成するために使用します。
以下の手順で、各次元の要素を任意に設定することが可能です。
 
     HspVarCoreReset( pval );// 配列ポインタをリセットする
     HspFunc_array( pval, 0 );// 1次元目
     HspFunc_array( pval, 0 );// 2次元目
     HspFunc_array( pval, 0 );// 3次元目
     HspFunc_array( pval, 0 );// 4次元目
 
HspFunc_arrayによって作成されたPvalは、pval->offsetに配列要素に
アクセスするためのオフセット値(APTR)が設定されます。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
(*HspFunc_redim)
; 見出し を記入
指定した変数の配列を拡張します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 PVal *pval, int lenid, int len )
PVal *pval, int lenid, int len：
%inst
; 解説文 を記入
void (*HspFunc_redim)( PVal *pval, int lenid, int len );
 
指定した変数の配列を拡張します。
pval変数の、指定した次元数lenid(1～4)に対してlenの大きさに拡張します。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定

002 †

+

002

Everything is expanded.

Everything is shortened.

%index
*(*HspFunc_varname)
; 見出し を記入
指定したIDの変数名を取得します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( int id )
int id：
%inst
; 解説文 を記入
char *(*HspFunc_varname)( int id );
 
指定したIDの変数名を取得します。
IDは、0から始まり変数IDの最大個数(HSPHED構造体のmax_valメンバ)が有効です。
この関数は、HSPオブジェクトに変数名情報が格納されている場合にのみ
取得することができます。それ以外の場合は、常に「""」が返されます。
(変数名情報は、#cmpopt命令により設定することが可能です。)
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
(*HspFunc_seekvar)
; 見出し を記入
指定した変数名を持つ変数IDを取得します。
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( const char *name )
const char *name：
%inst
; 解説文 を記入
int (*HspFunc_seekvar)( const char *name );
 
指定した変数名を持つ変数IDを取得します。
IDは、0から始まり変数IDの最大個数(HSPHED構造体のmax_valメンバ)を持っています。
該当する変数名がなかった場合は、-1を返します。
この関数は、HSPオブジェクトに変数名情報が格納されている場合にのみ
取得することができます。それ以外の場合は、常に-1が返されます。
(変数名情報は、#cmpopt命令により設定することが可能です。)
 
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
内部情報の取得と設定
 
 
%index
hsp3sdk_init
; 見出し を記入
SDK初期化
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( HSP3TYPEINFO *info )
HSP3TYPEINFO *info：
%inst
; 解説文 を記入
SDK初期化
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
system data
%index
bms_send
; 見出し を記入
ウインドゥ画面の更新
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
( BMSCR *bm, int x, int y, int sx, int sy )
BMSCR *bm：
int x：
int y：
int sx：
int sy：
%inst
; 解説文 を記入
ウインドゥ画面の更新
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
system data
%index
PVAL構造体
; 見出し を記入
PVAL構造体
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
PVal構造体は、変数に保存されるデータを示すための情報が含まれています。
hspvar_core.hに以下のように定義されています。
 
//	PVAL 構造体
//
typedef struct
{
 //  Memory Data 構造体 (2.5 互換)
 //
 short   flag;       // 変数の型
 short   mode;       // 変数のモード (0=normal/1=clone/2=alloced)
 int     len[5];     // 配列のサイズ (dim)
 int     size;       // 変数が確保したメモリ全体のサイズ
 char    *pt;        // 実際の変数の内容が記憶されているメモリへのポインタ
 
 //  Memory Data 構造体 (3.0 互換)
 //
 void    *master;    // データのためのマスターポインター
 short   autoresize; // 自動配列拡大フラグ
 short   arraycnt;   // 配列セット数
 int     offset;     // 配列データのオフセット
 int     arraymul;   // 複数の値の配列
} PVal;
 
----------------------------------------
 
先頭部分のフィールドは、HSP2.5以降のPVAL2構造体と完全な互換性があります。
HSP3.0から拡張されたフィールドによって、多くの機能が拡張されています。
PVal構造体に関わる処理はすべて、ストレージコアファンクションを介して
行なうため、直接それぞれのフィールドを操作することはまれです。
それぞれのフィールド詳細は以下の通りです。
 
--------------------
 
short    flag;		// type of val
 
変数の型が格納されています。
以下のいずれか、または拡張されたVarTypeの値になります。
 
    #define HSPVAR_FLAG_STR 2    // SJIS文字列(str)
    #define HSPVAR_FLAG_DOUBLE 3    // 64bit実数(double)
    #define HSPVAR_FLAG_INT 4    // 32bit整数(int)
 
--------------------
 
short    mode;		// mode (0=normal/1=clone/2=alloced)
 
変数が作成されたモードが格納されています。
以下のいずれかの値になります。
 
    #define HSPVAR_MODE_NONE -1    // 無効
    #define HSPVAR_MODE_MALLOC 1    // 通常確保されたメモリ
    #define HSPVAR_MODE_CLONE 2    // クローン変数
 
--------------------
 
int    len[5];		// length of array 4byte align (dim)
 
配列のサイズについての情報が格納されています。
dim p1,p2,p3,p4とした場合に、p1がlen[1]に、p2がlen[2]に、
p3がlen[3]に、p4がlen[4]の値となり保持されています。
 
--------------------
 
int        size;		// size of Val
 
変数が確保したメモリ全体のサイズが格納されています。
 
--------------------
 
char    *pt;		// ptr to Val
 
実際の変数の内容が記憶されているメモリへのポインタです。
通常は、配列変数であれば、ここで指定されたアドレスから連続的な
空間が配列のために確保されています。
文字列など一部の型では、違っている場合もあるため、必ず
変数が保持する値の操作は、ストレージコアファンクションを介して
行なうようにしてください。
 
--------------------
 
short    autoresize;	// Auto Array Expand Flag
short    arraycnt;	// Array Set Count
int    offset;		// Array Data Offset
int    arraymul;	// Array Multiple Value 
void    *master;	// Master pointer for data
 
以上のフィールドは、ストレージコアファンクション側が任意に
利用することができます。主に、可変長配列に関する情報が格納されて
います。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
APTR型
HspVarProc構造体
%group
; グループ を記入
構造体
%index
APTR型
; 見出し を記入
配列要素
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
■配列変数の取得と設定
 
変数名を取得するcode_getvaにより、配列要素も同時に取得されます。
基本的に変数名は、PValポインタとして、配列要素は、APTRの値として
取得されます。
APTRの値が0の場合は、配列要素が指定されていないことを示しています。
APTRは配列要素のインデックスを示しています。
上限は、すべての次元を1次元に直した上での最大インデックス値になります。
1次元配列であれば、APTRの0,1,2…がそのまま配列要素と同じだと
考えて問題ありません。
 
 
code_getvaで取得されるAPTRは範囲チェックされているので、
通常の使用ではプラグイン側で範囲チェックを行なう必要はありません。
 
もし、プラグイン側で任意に配列要素を設定したい場合には、
HspFunc_array関数を使用します。
 
次のような形で要素指定を行なうことが可能です。
(APTRの値=pval->offsetの値です)
 
    HspVarCoreReset( pval );// 配列ポインタをリセットする
    HspFunc_array( pval, 0 );// 1次元目
    HspFunc_array( pval, 0 );// 2次元目
    HspFunc_array( pval, 0 );// 3次元目
    HspFunc_array( pval, 0 );// 4次元目
 
また、配列の拡張はHspFunc_redim関数で行なうことが可能です。
 
    void (*HspFunc_redim)( PVal *pval, int lenid, int len );
 
この関数では、指定した変数の配列を拡張します。
pval変数の、指定した次元数lenid(1～4)に対してlenの大きさに拡張します。
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
PVAL構造体
HspVarProc構造体
%group
; グループ を記入
構造体
%index
HspVarProc構造体
; 見出し を記入
ストレージコアファンクション
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
 
HspVarProc構造体は、変数に格納されるタイプごとの情報を格納するための
ものです。この構造体に設定されたcorefunc(ストレージコアファンクション)
によって、新しい型を管理することができるようになります。
hspvar_core.hに以下のように定義されています。
 
//		command execute core function
//
typedef struct
{
    //	データフィールド
    //
    short flag;		// 型タイプ値 (親アプリケーションで設定されます)
    short aftertype;	// 演算後のタイプ値
    short version;		// 型タイプランタイムバージョン(0x100 = 1.0)
    unsigned short support;	// サポート状況フラグ(HSPVAR_SUPPORT_*)
    short basesize;		// １つのデータが使用するサイズ(byte) / 可変長の時は-1
    short opt;		// (未使用)
 
    char *vartype_name;	// 型タイプ名文字列へのポインタ
    char *user;		// ユーザーデータ(未使用)
 
    //	システム参照・型変換用
    //
    void *(*Cnv)( void *buffer, int flag );
    void *(*CnvCustom)( void *buffer, int flag );
    PDAT *(*GetPtr)( PVal *pval );
 
    void *(*ArrayObjectRead)( PVal *pval, int *mptype );	// 配列要素の指定 (連想配列/読み出し)
    void (*ArrayObject)( PVal *pval );			// 配列要素の指定 (連想配列/書き込み準備)
    void (*ObjectWrite)( PVal *pval, void *data, int type );// HSPVAR_SUPPORT_NOCONVERT指定時の代入
    void (*ObjectMethod)( PVal *pval );			// 変数に対するメソッドの指定
 
    void (*Alloc)( PVal *pval, PVal *pval2 );		// 変数メモリを確保する
    void (*Free)( PVal *pval );				// 変数メモリを解放する
 
    int (*GetSize)( void *pdat );				// 要素が使用するメモリサイズを返す(可変長のため)
 
    //	変数バッファ(バイナリ)のポインタとサイズを返す
    //	(要素が可変長(str)の場合は該当する１配列バイナリのみ)
    //	(要素が固定長(int,double)の場合は全配列バイナリ)
    //	(サイズはメモリ確保サイズを返す)
    void *(*GetBlockSize)( PVal *pval, PDAT *pdat, int *size );
 
    //	バイナリデータ用にメモリブロックを確保する
    //	(要素が可変長(str)の場合にブロックサイズを強制的に確保する)
    //	(固定長の場合は何もしない)
    void (*AllocBlock)( PVal *pval, PDAT *pdat, int size );
 
    //	代入用関数(型の一致が保障されます)
    //
    void (*Set)( PVal *pval, PDAT *pdat, void *in );
 
    //	演算用関数(型の一致が保障されます)
    //
    void (*AddI)( PDAT *pval, void *val );
    void (*SubI)( PDAT *pval, void *val );
    void (*MulI)( PDAT *pval, void *val );
    void (*DivI)( PDAT *pval, void *val );
    void (*ModI)( PDAT *pval, void *val );
 
    void (*AndI)( PDAT *pval, void *val );
    void (*OrI)( PDAT *pval, void *val );
    void (*XorI)( PDAT *pval, void *val );
 
    void (*EqI)( PDAT *pval, void *val );
    void (*NeI)( PDAT *pval, void *val );
    void (*GtI)( PDAT *pval, void *val );
    void (*LtI)( PDAT *pval, void *val );
    void (*GtEqI)( PDAT *pval, void *val );
    void (*LtEqI)( PDAT *pval, void *val );
 
    void (*RrI)( PDAT *pval, void *val );
    void (*LrI)( PDAT *pval, void *val );
} HspVarProc;
 
----------------------------------------
[個別解説]
--------------------
 
short flag;		// 型タイプ値 (親アプリケーションで設定されます)
 
型ごとに割り振られたID番号が設定されています。
HSPVAR_FLAG_INT等も型タイプ値を示しています。
タイプ値は、PVal構造体のflagフィールドに設定されます。
 
--------------------
 
short aftertype;	// 演算後のタイプ値
 
演算後にタイプが変更される演算子を持つ場合は、このフィールドで
演算後のタイプ値をシステムに通知します。
 
--------------------
 
short version;		// 型タイプランタイムバージョン(0x100 = 1.0)
unsigned short support;	// サポート状況フラグ(HSPVAR_SUPPORT_*)
short basesize;		// １つのデータが使用するサイズ(byte) / 可変長の時は-1
short opt;		// (未使用)
char *vartype_name;	// 型タイプ名文字列へのポインタ
char *user;		// ユーザーデータ(未使用)
 
ストレージコアファンクションの初期化時に型の持つ情報を設定する
必要があります。これらの情報をもとに、内部動作が決定されます。
supportは、以下の中から複数の内容を選択して設定します。
 
HSPVAR_SUPPORT_STORAGE        // 固定長ストレージサポート
HSPVAR_SUPPORT_FLEXSTORAGE    // 可変長ストレージサポート
HSPVAR_SUPPORT_FIXEDARRAY    // 配列サポート
HSPVAR_SUPPORT_FLEXARRAY    // 可変長配列サポート
HSPVAR_SUPPORT_ARRAYOBJ        // 連想配列サポート
HSPVAR_SUPPORT_FLEXSIZE        // 要素ごとのデータが可変長
HSPVAR_SUPPORT_CLONE        // クローン動作
HSPVAR_SUPPORT_USER1        // ユーザーフラグ1
HSPVAR_SUPPORT_USER2        // ユーザーフラグ2
 
変数初期化時に、PVal構造体のsupportフィールドに内容がコピーされます。
vartype_nameは、型を名前で識別するための情報です。
英小文字で設定しておく必要があり、他の型と名前が重複しないように
配慮する必要があります。
 
ユーザーデータ及びユーザーフラグは、ストレージコアファンクション側が
自由に使用できるフラグ情報です。
 
 
--------------------
 
PDAT *(*GetPtr)( PVal *pval );
 
PValが示すデータの実態がある先頭ポインタを返します。
(PDAT*は、実態データのポインタを示しています。)
配列変数をサポートしている場合は、オフセット情報(PVal->offset)を
もとにデータの実態ポインタを求める必要があります。
 
 
--------------------
 
void *(*ArrayObjectRead)( PVal *pval, int *mptype );// 配列要素の指定 (連想配列/読み出し)
void (*ArrayObject)( PVal *pval );	// 配列要素の指定 (連想配列/書き込み準備)
void (*ObjectWrite)( PVal *pval, void *data, int type );	// HSPVAR_SUPPORT_NOCONVERT指定時の代入
void (*ObjectMethod)( PVal *pval );	// 変数に対するメソッドの指定
 
型が連想配列サポートをしている時(HSPVAR_SUPPORT_ARRAYOBJ)に、
配列指定のために呼び出されます。
HSP3コアは、変数名の次にある中間コードをパースする段階で、この
関数を呼び出します。ArrayObject、ArrayObjectRead関数は、適切に中間コードを
パースして値を戻してやる必要があります。
ArrayObjectは、変数代入やパラメーターの変数指定時に配列指定がされている
時に呼び出されます。システムは、ArrayObjectで配列内容をチェックした後、
代入が行なわれる場合には、ObjectWriteを呼び出します。
ObjectWrite関数は、配列要素に従って適切な値を変数に代入する必要があります。
 
ArrayObjectReadは、変数の内容参照が行なわれる時に呼び出されます。
この時、戻す値の型タイプ(HSPVAR_FLAG_*)を(*mptype)に代入し、
データの実態ポインタを返値として渡します。
戻す値の型タイプが自分自身の型でいい場合は、(*mptype)はそのままで構いません。
中間コードのパースについては、命令や関数と同様にHSPEXINFO構造体にある
関数を利用して値を取得することが可能です。
ObjectMethod関数は、mcall命令によりメソッド呼び出しが行なわれた時に実行
されるものです。それぞれの型に固有の実行機構を用意することができます。
 
 
--------------------
 
void *(*Cnv)( void *buffer, int flag );
 
flagでリクエストされた型から、自分の型への変換を行なうための
関数になります。flagでリクエストされるのは、組み込み型となる
HSPVAR_FLAG_INT、HSPVAR_FLAG_DOUBLE、HSPVAR_FLAG_STRだけで
それ以外はHSPVAR_ERROR_TYPEMISSのエラーを発生させて構いません。
bufferは、リクエストされた型を持つデータのポインタとなります。
これを変換したものを、返値として戻す必要があります。
bufferの内容は、変更しないでください。
 
 
--------------------
 
void *(*CnvCustom)( void *buffer, int flag );
 
自分の型からflagでリクエストされた型への変換を行なうための
関数になります。flagでリクエストされるのは、組み込み型となる
HSPVAR_FLAG_INT、HSPVAR_FLAG_DOUBLE、HSPVAR_FLAG_STRだけで
それ以外はHSPVAR_ERROR_TYPEMISSのエラーを発生させて構いません。
bufferは、リクエストされた型を持つデータのポインタとなります。
これを変換したものを、返値として戻す必要があります。
bufferの内容は、変更しないでください。
この関数は、組み込み型の値に対して新規に作成された型の演算を
行なおうとした時に型変換のために呼び出されます。
 
 
--------------------
 
void (*Copy)( void *in, void *out );
 
型のサイズに合わせてinの内容をoutにコピーします。
 
 
--------------------
 
void (*Alloc)( PVal *pval, PVal *pval2 );		// 変数メモリを確保する
 
pval変数が必要とするサイズを確保し初期化を行ないます。
pval2がNULLの場合は、新規データになります。
pval2が指定されている場合は、pval2の内容を継承して再確保を
行なうことを示しています。この場合、pval2のsize、ptをもとに
内容をコピーするようにしてください。また、ptの解放も同時に
行なう必要があります。
 
例:
    if ( pval2 != NULL ) {
        memcpy( pt, pval->pt, pval->size );
        free( pval->pt );
    }
 
 
--------------------
 
void (*Free)( PVal *pval );				// 変数メモリを解放する
 
pvalが確保しているメモリを解放します。
多くの場合、HSP3コアが自動的に呼び出しを行ないます。
 
 
--------------------
 
int (*GetSize)( void *pdat );	// 要素が使用するメモリサイズを返す(可変長のため)
 
pdatが示す内容のサイズ(バイト数)を返します。
この関数は、１要素のデータサイズが可変長(basesizeが-1)の時に
呼び出されます。通常は、basesizeと同じサイズを戻しておいて
下さい。
 
 
--------------------
 
void *(*GetBlockSize)( PVal *pval, PDAT *pdat, int *size );
 
変数バッファ(バイナリ)のポインタとサイズを返します。
要素が可変長の場合は該当する１配列のバイナリのみが対象となり、
要素が固定長(int,double等)の場合は全配列バイナリを返します。
また、(*size)にメモリ確保サイズを返します。
 
 
--------------------
 
void (*AllocBlock)( PVal *pval, PDAT *pdat, int size );
 
バイナリデータ用にメモリブロックを確保します。
要素が可変長(str等)の場合にブロックサイズを強制的に確保する際に
使用されます。通常、固定長の場合は何もしなくて構いません。
 
--------------------
 
void (*Set)( PVal *pval, PDAT *pdat, void *in );	// 代入
void (*AddI)( PDAT *pdat, void *val );	// 演算子 +
void (*SubI)( PDAT *pdat, void *val );	// 演算子 -
void (*MulI)( PDAT *pdat, void *val );	// 演算子 *
void (*DivI)( PDAT *pdat, void *val );	// 演算子 /
void (*ModI)( PDAT *pdat, void *val );	// 演算子 \
 
void (*AndI)( PDAT *pdat, void *val );	// 演算子 &
void (*OrI)( PDAT *pdat, void *val );	// 演算子 |
void (*XorI)( PDAT *pdat, void *val );	// 演算子 ^
 
void (*EqI)( PDAT *pdat, void *val );	// 演算子 =
void (*NeI)( PDAT *pdat, void *val );	// 演算子 !=
void (*GtI)( PDAT *pdat, void *val );	// 演算子 <
void (*LtI)( PDAT *pdat, void *val );	// 演算子 >
void (*GtEqI)( PDAT *pdat, void *val );	// 演算子 <=
void (*LtEqI)( PDAT *pdat, void *val );	// 演算子 >=
 
void (*RrI)( PDAT *pdat, void *val );	// 演算子 >>
void (*LrI)( PDAT *pdat, void *val );	// 演算子 <<
 
それぞれの演算子に対応した演算用関数です。
PDATで渡されるデータは、自分との型の一致が保障されます。
演算用関数は、pdatとvalの演算結果をpdatに返します。
 
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
PVAL構造体
APTR型
HSPVAR_FLAG_*
 
%group
; グループ を記入
構造体
%index
HSPEXINFO構造体
; 見出し を記入
HSP内部情報データ
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
パラメーターの取得方法は、HSP2.6のSDKで採用された$202タイプで
使用されていたHSPEXINFO構造体と互換性があります。
HSP3でも同様に、HSPEXINFO構造体を使用しており、以下のような内容に
なっています。
 
 
typedef struct HSPEXINFO
{
//		HSP内部情報データ (2.6)
//
short ver;		// バージョンコード
short min;		// マイナーバージョン
//
int *er;		// 未使用
char *pstr;		// 文字列バッファ（メイン）
char *stmp;		// 文字列バッファ（サブ）
PVal **mpval;		// マスターPVAL
//
int *actscr;		// アクティブウインドウID
int *nptype;		// 次のパラメータタイプ
int *npval;		// 次のパラメータ値
int *strsize;		// StrSizeバッファ
char *refstr;		// RefStrバッファ
//
void *(*HspFunc_prm_getv)( void );
int (*HspFunc_prm_geti)( void );
int (*HspFunc_prm_getdi)( const int defval );
char *(*HspFunc_prm_gets)( void );
char *(*HspFunc_prm_getds)( const char *defstr );
int (*HspFunc_val_realloc)( PVal *pv, int size, int mode );
int (*HspFunc_fread)( char *fname, void *readmem, int rlen, int seekofs );
int (*HspFunc_fsize)( char *fname );
void *(*HspFunc_getbmscr)( int wid );
int (*HspFunc_getobj)( int wid, int id, void *inf );
int (*HspFunc_setobj)( int wid, int id, const void *inf );
 
//		HSP内部情報データ (3.0)
//
int *npexflg;	// 次のパラメータExFlg
void *hspctx;	// HSP コンテキストポインタ
 
//		改良データ (3.0)
//
int (*HspFunc_addobj)( int wid );
void (*HspFunc_puterror)( HSPERROR error );
HspVarProc *(*HspFunc_getproc)( int type );
HspVarProc *(*HspFunc_seekproc)( const char *name );
 
void (*HspFunc_prm_next)( void );
int (*HspFunc_prm_get)( void );
double (*HspFunc_prm_getd)( void );
double (*HspFunc_prm_getdd)( double defval );
unsigned short *(*HspFunc_prm_getlb)( void );
PVal *(*HspFunc_prm_getpval)( void );
APTR (*HspFunc_prm_getva)( PVal **pval );
void (*HspFunc_prm_setva)( PVal *pval, APTR aptr, int type, const void *ptr );
char *(*HspFunc_malloc)( int size );
void (*HspFunc_free)( void *ptr );
char *(*HspFunc_expand)( char *ptr, int size );
IRQDAT *(*HspFunc_addirq)( void );
int (*HspFunc_hspevent)( int event, int prm1, int prm2, void *prm3 );
void (*HspFunc_registvar)( int flag, HSPVAR_COREFUNC func );
void (*HspFunc_setpc)( const unsigned short *pc );
void (*HspFunc_call)( const unsigned short *pc );
void (*HspFunc_mref)( PVal *pval, int prm );
 
void (*HspFunc_dim)( PVal *pval, int flag, int len0, int len1, int len2, int len3, int len4 );
void (*HspFunc_redim)( PVal *pval, int lenid, int len );
void (*HspFunc_array)( PVal *pval, int offset );
 
//		改良データ (3.1)
//
char *(*HspFunc_varname)( int id );
int (*HspFunc_seekvar)( const char *name );
 
} HSPEXINFO;
 
 
HSP2.6から拡張されたり、削除されたフィールドもありますが、
パラメーターの取得など多くの点で同様の内容になっています。
HSPEXINFO構造体は、hsp3plugin.hの中でexinfoという名前で定義されています。
プラグインの中で、「exinfo->HspFunc_prm_geti();」のように記述しても
問題ありません。この項で説明してきた関数(code_geti)は、exinfoから該当する
関数を呼び出すためのマクロになっているだけです。
過去に作成したHSP2.6用のプラグインを3.0用に移植する場合には、この点に
留意すればある程度作業が軽減されると思います。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
構造体
%index
HSPCTX構造体
; 見出し を記入
基本的な動作に関する情報
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
 
 
HSPCTX構造体は、HSPの基本的な動作に関する情報を格納しています。
プラグインからもctxという名前で参照することが可能です。
 
typedef struct HSPCTX
{
//	HSP Context
//
HSPHED *hsphed;				// HSPのオブジェクトファイルのヘッダー
unsigned short *mcs;			// 現在のコードセグメントのポインタ
unsigned short *mem_mcs;		// コードセグメントのポインタ
char *mem_mds;				// データセグメントのポインタ
unsigned char *mem_di;			// デバッグ情報のポインタ
int *mem_ot;				// オブジェクトの一時セグメントのポインタ
 
IRQDAT *mem_irq;			// IRQをデータのポインタ
int irqmax;				// IRQのデータ数
int iparam;				// IRQの情報data1
int wparam;				// IRQの情報data2
int lparam;				// IRQの情報data3
 
PVal *mem_var;				// 変数ストレージインデックス
HSPEXINFO30 exinfo;			// HSP関数データ(3.0)
int runmode;				// HSP実行モード
int waitcount;				// waitのためのカウンター
int waitbase;				// wait sleep base
int waittick;				// next tick for await
int lasttick;				// previous tick
int sublev;				// subroutine level
LOOPDAT mem_loop[HSP3_REPEAT_MAX];	// ループ情報を繰り返す
int looplev;				// ループレベルを繰り返す
HSPERROR err;				// エラーコード
int hspstat;				// HSPの状態
int stat;				// システム変数 'stat'
int strsize;				// システム変数 'strsize'
char *refstr;				// RefStr バッファ
char *fnbuffer;				// ファイル名のバッファ
void *instance;				// インスタンスハンドル(windows)
int intwnd_id;				// ウィンドウID (割り込み)
PVal *note_pval;			// MemNote pval
APTR note_aptr;				// MemNote aptr
PVal *notep_pval;			// MemNote pval (前回)
APTR notep_aptr;			// MemNote aptr (前回)
char *stmp;				// 文字列の一時的なバッファ
 
void *prmstack;				// 現在のパラメータスタック領域
LIBDAT *mem_linfo;			// ライブラリ情報
STRUCTPRM *mem_minfo;			// パラメータ情報
STRUCTDAT *mem_finfo;			// 関数/構造体情報
int retval_level;			// サブルーチンレベル（戻りコード）
int endcode;				// 最終結果コード
void (*msgfunc) (HSPCTX *);		// メッセージコールバック処理
void *wnd_parent;			// 親ウィンドウハンドル
double refdval;				// システム変数 'refdval'
char *cmdline;				// コマンドライン引数
 
HSPEXINFO *exinfo2;			// 	HSP関数データ(3.1)
 
} HSPCTX;
 
----------------------------------------
 
以下は、各フィールドの詳細です。
 
--------------------
 
HSPHED *hsphed;			// HSP object file header
 
HSPオブジェクトファイル(axファイル)のヘッダポインタを格納します。
 
--------------------
 
unsigned short *mcs;		// current code segment ptr
unsigned short *mem_mcs;	// code segment ptr
 
実行中のコード位置と、中間コードが格納されているポインタを格納します。
 
--------------------
 
char *mem_mds;			// data segment ptr
 
各種データが保存されている領域(data segment)ポインタを格納します。
 
--------------------
 
unsigned char *mem_di;		// Debug info ptr
 
デバッグ情報が保存されている領域(Debug info)ポインタを格納します。
 
--------------------
 
int *mem_ot;			// object temp segment ptr
 
ラベル情報が保存されている領域(OT segment)ポインタを格納します。
 
--------------------
 
IRQDAT *mem_irq;		// IRQ data ptr
int irqmax;			// IRQ data count
 
HSP内部の割り込み要因(IRQDAT)の情報を格納します。
irqmaxには、格納されているIRQDATの数が入ります。
 
--------------------
 
int iparam;			// IRQ Info data1
int wparam;			// IRQ Info data2
int lparam;			// IRQ Info data3
 
システム変数iparam,wparam,lparamの内容を保持します。
 
--------------------
 
PVal *mem_var;			// var storage index
 
グローバル変数の情報が保存されているポインタを格納します。
 
--------------------
 
HSPEXINFO30 exinfo;		// HSP function data
 
HSPEXINFO30構造体を格納しています。
このデータは、HSP3.0互換のために用意されているもので、
通常は、exinfo2メンバを参照してHSPEXINFO構造体を利用してください。
 
--------------------
 
int runmode;			// HSP execute mode
 
実行モードを格納します。
 
--------------------
 
int waitcount;			// counter for wait
 
wait/await命令のカウンタを格納します。
 
--------------------
 
int waitbase;			// wait sleep base
 
await命令のSleep時間単位を格納します。
 
--------------------
 
int waittick;			// next tick for await
int lasttick;			// previous tick
 
await命令での次回tickと、前回のtick数を格納します。
 
--------------------
 
int sublev;			// subroutine level
 
サブルーチンのネスト数を格納します。
 
--------------------
 
LOOPDAT mem_loop[HSP3_REPEAT_MAX];	// repeat loop info
int looplev;			// repeat loop level
 
repeat～loop命令で使用する情報を格納します。
 
--------------------
 
HSPERROR err;			// error code
 
エラー発生時のエラーコードを格納します。
 
--------------------
 
int hspstat;			// HSP status
 
システム変数hspstatの内容を格納します。
 
--------------------
 
int stat;			// sysvar 'stat'
 
システム変数statの内容を格納します。
 
--------------------
 
int strsize;			// sysvar 'strsize'
 
システム変数strsizeの内容を格納します。
 
--------------------
 
char *refstr;			// RefStr Buffer
 
システム変数refstrの内容を格納します。
 
--------------------
 
void *instance;			// Instance Handle (windows)
 
Windowsのインスタンスハンドルを格納します。
 
--------------------
 
char *fnbuffer;			// buffer for FILENAME
 
割り込み時に使用されるファイル名の一次記憶バッファのポインタ。
 
--------------------
 
void *intwnd_save;		// Window Handle (interrupt)
 
Windowsメッセージが送られたウインドゥのハンドルを保存しています。
 
--------------------
 
PVal *note_pval;		// MemNote pval
APTR note_aptr;			// MemNote aptr
 
メモリノートパッド命令(notesel)で選択されている変数の情報を保存しています。
 
--------------------
 
PVal *notep_pval;		// MemNote pval (previous)
APTR notep_aptr;		// MemNote aptr (previous)
 
notesel命令で選択される前の情報を保存しています。
 
--------------------
 
char *stmp;			// String temporary buffer
 
関数の戻り値や、命令解釈時の文字列一時退避に使用できる領域です。
strbuf(sb～)系のライブラリで扱うことができる文字列ポインタです。
 
--------------------
 
void *prmstack;			// Current parameter stack area
 
サブルーチンやユーザー定義命令内で参照されるスタックパラメーターを格納します。
スタックパラメーターには、複数の情報が多重に保存されています。
 
--------------------
 
LIBDAT *mem_linfo;		// Library info
 
外部DLLやCOMなどの情報を管理するLIBDAT構造体のポインタを格納します。
 
--------------------
 
STRUCTPRM *mem_minfo;		// Parameter info
 
外部DLLやCOMなどの引数情報を管理するSTRUCTPRM構造体のポインタを格納します。
 
--------------------
 
STRUCTDAT *mem_finfo;		// Function/Struct info
 
モジュール変数やユーザー定義命令パラメーターの情報を管理するSTRUCTDAT構造体の
ポインタを格納します。
 
--------------------
 
int retval_level;		// subroutine level (return code)
割り込み発生時のサブルーチンネストレベルを格納します。
この値は、システムが管理しています。
 
--------------------
 
int endcode;			// End result code
 
スクリプト終了時にシステムに渡されるレザルトコードを格納します。
 
--------------------
 
void (*msgfunc) (HSPCTX *);	// Message Callback Proc.
 
ウィンドウメッセージを処理する関数のポインタを格納します。
 
--------------------
 
void *wnd_parent;		// Parent Window Handle
 
HSPウィンドウ生成時に渡される親ウィンドウ情報が格納されます。
 
--------------------
 
double refdval;			// sysvar 'refdval'
 
システム変数refdvalの内容を格納します。
 
--------------------
 
char *cmdline;			// Command Line Parameters
 
コマンドラインパラメーターを格納します。
 
--------------------
 
HSPEXINFO *exinfo2;		// HSP function data(3.1)
 
HSPEXINFO構造体へのポインタを格納します。
このメンバは、HSP3.1以降のみ利用可能です。
 
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
LIBDAT構造体
 
%group
; グループ を記入
構造体

003 †

+

003

Everything is expanded.

Everything is shortened.

%index
HSPHED構造体
; 見出し を記入
HSPヘッダ情報
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
 
HSPHED構造体は、HSPファイルオブジェクトに含まれている情報をまとめて
いるもので、HSPCTX構造体のhsphedから参照することができます。
HSPHED構造体は、hsp3struct.hに以下のように定義されています。
 
typedef struct HSPHED
{
//		HSP3.0 	ヘッダ構造体
//
 
char    h1;			// magic code1
char    h2;			// magic code2
char    h3;			// magic code3
char    h4;			// magic code4
int        version;	// バージョン番号の情報
int        max_val;	// VALオブジェクトの最大数
int        allsize;	// 全ファイルのサイズ
 
int        pt_cs;		// コードセグメントへのポインタ
int        max_cs;		// CSのサイズ
int        pt_ds;		// データセグメントへのポインタ
int        max_ds;		// DSの大きさ
 
int        pt_ot;		// オブジェクトTempへのポインタ
int        max_ot;		// OTの大きさ
int        pt_dinfo;	// デバッグ情報のポインタ
int        max_dinfo;	// ディの大きさ
 
int        pt_linfo;	// LibInfo （ 2.3 ）へのポインタ
int        max_linfo;	// LibInfo （ 2.3 ）の大きさ
int        pt_finfo;	// FuncInfo （ 2.3 ）へのポインタ
int        max_finfo;	// FuncInfo （ 2.3 ）の大きさ
 
int        pt_minfo;	// ModInfo （ 2.5 ）へのポインタ
int        max_minfo;	// ModInfo （ 2.5 ）の大きさ
int        pt_finfo2;	// FuncInfo2 （ 2.5 ）へのポインタ
int        max_finfo2;	// FuncInfo2 （ 2.5 ）の大きさ
 
int        pt_hpidat;	// HPIDAT （ 3.0 ）へのポインタ
int        max_hpi;	// HPIDAT （ 3.0 ）の大きさ
int        bootoption;	// 起動オプション
int        runtime;	// ランタイムの名前をのポインタ
 
} HSPHED;
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
構造体
 
%index
BMSCR構造体
; 見出し を記入
ウインドゥに関する情報
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
 
BMSCR構造体は、ウインドゥに関する情報をすべて含んでいます。
ウインドゥのサイズから、HWNDハンドルやデバイスコンテキストの情報など
ウインドゥに関するほとんどの情報を得ることができます。
 
BMSCR構造体は、HSP2.61までのSDKで使用されていた同名の構造体と
多くの部分で互換性があります。
BMSCR構造体を参照して動作するプログラムは、そのままHSP3のBMSCR構造体
でも使用することができます。互換が維持できない部分については、
名前が変更されているか、フィールドが削除されています。
また、HSP3から追加されている項目もいくつか存在します。
 
HSP2からの大きな変更点は、オブジェクトの情報を示すフィールドが
HSPOBJINFO構造体ベースになっているところです。
オブジェクトの情報については、getobj/setobjを使用するようにして下さい。
 
typedef struct BMSCR
{
    //
    //		ウィンドウデータ構造体
    //
    int        flag;		// フラグを使用
    int        sx;		// Xサイズ
    int        sy;		// Yサイズ
    int        palmode;	// palmode
    HDC        hdc;		// HDCバッファ
    BYTE    *pBit;			// ビットマップポインタ
    BITMAPINFOHEADER *pbi;		// infoheader
    HBITMAP    dib;			// ビットマップハンドル（DIB）
    HBITMAP    old;			// ビットマップハンドル（OLD）
    RGBQUAD *pal;			// パレットテーブル
    HPALETTE hpal;			// パレットハンドル
    HPALETTE holdpal;		// パレットハンドル（old）
    int        pals;		// パレットのエントリ
    HWND    hwnd;			// ウィンドウハンドル
    HINSTANCE hInst;		// プログラムのインスタンス
    int        infsize;	// *pbi allocメモリサイズ
    int        bmpsize;	// *pBit allocメモリサイズ
 
    //			ウィンドウオブジェクトの設定
    //
    int        type;		// 設定タイプ
    int        wid;		// ウィンドウID
    short    fl_dispw;		// 表示ウィンドウのフラグ
    short    fl_udraw;		// ウィンドウの描画を更新
    int        wx,wy,wchg;	// 実際のウィンドウサイズのx 、 y
    int        viewx,viewy;	// バッファの表示点のx 、 y
    int        lx,ly;		// バッファの表示サイズのx 、 y
    int        cx,cy;		// オブジェクトのカーソルのx 、 y
    int        ox,oy,py;	// オブジェクトのサイズのx 、 y 、py
    int        texty;		// テキストY軸サイズ
    int        gx,gy,gmode;	// gcopyサイズ
    HBRUSH    hbr;			// ブラシハンドル
    HPEN    hpn;			// ペンハンドル
    HFONT    hfont;			// 文字ハンドル
    HFONT    holdfon;		// 文字ハンドル（old）
    COLORREF color;			// テキストの色コード
    int        textspeed;	// 遅いテキストの速度
    int        cx2,cy2;	// 遅いテキストのカーソルのx 、 y
    int        tex,tey;	// 遅いテキスト限界のx 、 y
    char    *prtmes;		// 遅いメッセージのポインタ
    int        focflg;		// フォーカスフラグを設定
    int        objmode;	// オブジェクトのモードを設定
    LOGFONT    logfont;		// 論理フォント
    int        style;		// 余分なウィンドウスタイル
    int        gfrate;		// ハーフトーンのコピー率
    int        tabmove;	// オブジェクトをTabで移動するモード
    int        sx2;		// 実際のビットマップのXサイズ
    SIZE    printsize;		// print,mes の範囲サイズ
 
    //		クラスに左右されるデータ
    //
    int        objstyle;		// オブジェクトスタイル
    HSPOBJINFO *mem_obj;			// ウィンドウオブジェクト
    int objmax;				// objの最大数
    int objlimit;				// objの上限数
    short savepos[BMSCR_SAVEPOS_MAX];	// 保存位置
    void *master_hspwnd;			// hspwnd親クラス
} BMSCR;
 
----------------------------------------
 
各フィールドの詳細は、以下の通りです。
 
--------------------
 
int        flag;			// used flag
 
BMSCRが管理する画面が使用されているかどうかのフラグです。
 
    #define BMSCR_FLAG_NOUSE    0
    #define BMSCR_FLAG_INUSE    1
 
のいずれかが設定されています。
 
--------------------
 
int        sx;			// X-size
int        sy;			// Y-size
int        sx2;			// actual bitmap X size
int        palmode;		// palmode
 
画面を初期化したサイズが格納されています。
sx,syはX,Y方向のドット数になります。
sx2は、横方向のビットマップサイズ(ドット数ではありません)を
バイト単位で格納します。
palmodeは以下のいずれかが設定されています。
 
    #define BMSCR_PALMODE_FULLCOLOR    0
    #define BMSCR_PALMODE_PALETTECOLOR    1
 
--------------------
 
HDC        hdc;			// buffer HDC
 
画面のデバイスコンテキストが格納されています。
このハンドルを使ってGDIファンクションで画面に描画することが可能です。
注意しなければならないのは、これはメモリ上のビットマップへの
デバイスコンテキストだということです。ここに描画をしても、実際の
ウインドゥ画面上では何の変化も起こりません。実際のウインドゥ画面に
変更を反映させるためには、HSPのredraw命令などを使用して再描画を
行なうか、GetDC命令で実際のウインドゥへのデバイスコンテキストを
取得して描画する必要があります。
 
--------------------
 
BYTE    *pBit;				// bitmap pointer
 
画面のビットマップデータが格納されているメモリの先頭アドレスです。
このポインタを使って直接、画面にデータを書き込むことが可能です。
メモリにデータを直接書き込み場合は、色々な注意が必要です。詳しくは、
「ビットマップ画面への直接書き込み」を参照してください。
 
--------------------
 
BITMAPINFOHEADER *pbi;	// infoheader
HBITMAP    dib;		// bitmap handle(DIB)
HBITMAP    old;		// bitmap handle(OLD)
 
画面データを管理するビットマップについての情報です。
oldメンバは、ワークに使用しているだけなので特に決まった値は格納され
ません。
 
--------------------
 
RGBQUAD *pal;		// palette table
HPALETTE hpal;		// palette handle
HPALETTE holdpal;	// palette handle (old)
int        pals;	// palette entries
 
画面に適用されているパレットの情報です。
holdpalメンバは、ワークに使用しているだけなので特に決まった値は格納
されません。パレットの変更はなるべくHSP側の命令で行なうようにして、
このメンバは参照だけにとどめておいてください。
 
--------------------
 
HWND    hwnd;		// window handle
 
画面の描画先にあたるウインドゥのハンドルです。
 
--------------------
 
HANDLE    hInst;		// Instance of program
 
ウインドゥを管理するプログラムためのインスタンスです。
 
--------------------
 
int        infsize;	// *pbi alloc memory size
int        bmpsize;	// *pBit alloc memory size
 
画面データ初期化時のメモリ使用量を示すワークです。
 
--------------------
 
int        type;		// setting type
 
画面の属性を示します。
数値の示す内容は以下の通りです。
 
    #define HSPWND_TYPE_NONE 0
    #define HSPWND_TYPE_BUFFER 1
    #define HSPWND_TYPE_MAIN 2
    #define HSPWND_TYPE_BGSCR 3
 
--------------------
 
int        wid;		// window ID
 
ウインドゥIDを示します。
 
--------------------
 
short    fl_dispw;		// display window flag
short    fl_udraw;		// update draw window
 
画面がウインドゥとして表示されているかどうか、
画面の更新が必要かどうかを示すフラグです。
 
--------------------
 
int        wx,wy,wchg;	// actual window size x,y
int        viewx,viewy;	// buffer view point x,y
int        lx,ly;		// buffer view size x,y
 
スクロールバーによってスクロールが可能なウインドゥでの、
表示ウインドゥサイズ、画面内から転送する元座標、転送する範囲
などを示します。
 
--------------------
 
int        cx,cy;		// object cursor x,y
 
カレントポジションを示します。
 
--------------------
 
int        ox,oy,py;	// object size x,y,py
 
objsize命令で指定したオブジェクトの大きさを示します。
pyメンバは、カレントポジションをY方向へ増加する際のドット数になり
ます。
 
--------------------
 
int        texty;		// text Y-axis size
 
現在選択されている文字フォントのY方向のサイズを示します。
 
--------------------
 
int        gx,gy,gmode;	// gcopy size
int        gfrate;		// halftone copy rate
 
gmode命令で指定した画面コピー時のサイズとモードを示します。
gfrateは、半透明による画像コピー時のレートが格納されます。
 
--------------------
 
HBRUSH    hbr;			// BRUSH handle
HPEN    hpn;			// PEN handle
 
color命令で指定した色によるブラシとペンを示すオブジェクトの
ハンドルです。
 
--------------------
 
HFONT    hfont;			// FONT handle
HFONT    holdfon;		// FONT handle (old)
 
font命令で指定したフォントのオブジェクトハンドルです。
holdfonはワーク用で特に決まった値は持ちません。
 
--------------------
 
COLORREF color;			// text color code
 
color命令で指定した色データを示します。
 
--------------------
 
int        textspeed;	// slow text speed
 
text命令で指定したテキストの表示スピードを示します。
 
--------------------
 
int        cx2,cy2;	// slow text cursor x,y
int        tex,tey;	// slow text limit x,y
char    *prtmes;		// slow message ptr
 
ゆっくりと文字列を表示するためのワークです。
 
--------------------
 
int        focflg;		// focus set flag
 
focflgは、初期フォーカスを合わせるための一時フラグに使用されます。
この値は、内部で使用するだけなので変更しないで下さい。
 
--------------------
 
int        objmode;	// object set mode
LOGFONT    logfont;		// logical font
 
objmodeは、objmode命令で設定されているモードが格納されます。
logfontは選択された論理フォント構造体が格納されます。
 
--------------------
 
int        style;		// extra window style
 
ウインドゥ固有のスタイル(screen命令で設定)が格納されます。
 
--------------------
 
int        tabmove;	// object TAB move mode
 
tabmodeは、[TAB]キーによるオブジェクトフォーカス移動を行なうかどうかのフラグが格納されます。
 
--------------------
 
SIZE    printsize;		// print,mes extent size
 
printsizeは、mes、print命令により表示されたメッセージの矩形範囲が格納されます。
(ginfo命令で取得可能)
 
--------------------
 
int        objstyle;	// objects style
 
オブジェクトに適用されるスタイルを格納します。
 
--------------------
 
HSPOBJINFO *mem_obj;		// Window objects
int objmax;			// Max number of obj
int objlimit;			// Limit number of obj
 
mem_objは、オブジェクト情報(HSPOBJINFO)が格納されているポインタを
格納しています。この場所から、objmaxの数だけデータが連続して格納されて
います。また、objmaxの値がobjlimitに達すると、警告が表示されます。
オブジェクトの数自体に上限はありませんが、警告を発するための数が
設定されています。
 
--------------------
 
short savepos[BMSCR_SAVEPOS_MAX];	// saved position
 
マウスポインタの座標などの情報が保存されています。
 
--------------------
 
void *master_hspwnd;		// Parent hspwnd class
 
BMSCR構造体を管理するクラスへのポインタが格納されています。
通常、このポインタはプラグインからは使われません。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
構造体
 
 
%index
HSPOBJINFO構造体
; 見出し を記入
オブジェクト情報
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
 
HSP3から、オブジェクトの情報はHSPOBJINFO構造体をもとに管理される
形に変更されました。これにより、今まで限られた数までしかウインドゥ上に
配置できなかった制限をなくし、またプラグインなど後から別なユーザーが
新しいタイプのオブジェクトを追加できるようになっています。
オブジェクトは、ウインドゥが持つ情報として汎用的に使用することが
できるようになっています。たとえば、プラグインにより新しい形状のボタン
を配置したり、標準でサポートされていないコントロールを配置するような
ことが可能になっています。
HSPOBJINFO構造体は、以下のような内容を持っています。
 
typedef struct HSPOBJINFO
{
    //		Object Info (3.0)
    //
    short    owmode;		// objectのmode
    short    option;		// objectのoption(未使用・内部オブジェクトは0)
    void    *bm;		// objectが配置されているBMSCR構造体のポインタ
    HWND    hCld;		// objectのhandle
    int    owid;		// objectのValue(汎用)
    int    owsize;		// objectの使用サイズ(汎用)
 
    HSP3VARSET varset;	// objectから設定される変数の情報
 
    //		callback function
    void    (*func_notice)( struct HSPOBJINFO *, int );
    void    (*func_objprm)( struct HSPOBJINFO *, int, void * );
    void    (*func_delete)( struct HSPOBJINFO * );
 
} HSPOBJINFO;
 
----------------------------------------
 
HSPOBJINFO構造体は、プラグインから取得、設定することが可能です。
各フィールドの詳細は、以下の通りです。
 
--------------------
 
short    owmode;		// objectのmode
 
オブジェクトのモードを格納します。
以下のいずれかが値として格納されています。
 
    #define HSPOBJ_NONE 0        // 無効
    #define HSPOBJ_TAB_ENABLE 1    // TABフォーカス移動可能
    #define HSPOBJ_TAB_DISABLE 2    // TABフォーカス移動不可能
    #define HSPOBJ_TAB_SKIP 3    // TABフォーカスをスキップ
 
--------------------
 
void    *bm;
 
配置されているBMSCR構造体のポインタが格納されています。
 
--------------------
 
HWND    hCld;		// objectのhandle
 
配置されているオブジェクトのウインドゥハンドルが格納されています。
 
--------------------
 
short    option;		// objectのoption(未使用・内部オブジェクトは0)
int        owid;		// objectのValue(汎用)
int        owsize;		// objectの使用サイズ(汎用)
HSP3VARSET varset;	// objectから設定される変数の情報
 
オブジェクトの処理ルーチンで汎用的に使用できるフィールドです。
varsetは、主にオブジェクトの内容とともに、変数の内容を変更する
場合の変数情報を格納するために使用します。
 
--------------------
 
void    (*func_notice)( HSPOBJINFO *, int );
void    (*func_objprm)( HSPOBJINFO *, int, void * );
void    (*func_delete)( HSPOBJINFO * );
 
オブジェクトの処理ルーチンをコールバック関数として格納します。
func_deleteは、オブジェクトが破棄される時に呼び出される関数になります。
生成したオブジェクトは、必ずここで削除するようにしてください。
func_noticeは、ウインドゥメッセージの通知があった時に呼び出される
関数になります。intパラメーターには、wParamの内容が渡されます。
func_noticeコールバックを発生させるためには、HSPのウインドゥに
WM_COMMANDメッセージを送るようなコントロールを配置しなければ
なりません。また、WM_COMMANDメッセージに付随するコードとして、
(MESSAGE_HSPOBJ+オブジェクトのID)を設定しておく必要があります。
func_objprmは、objprm命令からオブジェクトに直接値が送られた時の
処理を行なう関数を指定します。引数のintはパラメーター型(HSPVAR_FLAG_*)を
void *は、パラメーターのポインタを示します。
これらのコールバック関数とともに、HSPOBJINFO構造体を設定することで
独自のオブジェクトを自由に拡張していくことが可能です。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
構造体
 
%index
LIBDAT構造体
; 見出し を記入
ライブラリ情報
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
LIBDAT構造体は以下のように定義されています。
 
typedef struct LIBDAT {
    int    flag;		// initalize フラグ
    int    nameidx;	// 	関数名のインデックス (DS)
                // インターフェイス IID ( Com オブジェクト )
    void    *hlib;		// ライブラリ ハンドル
    int    clsid;		// CLSID (DS) ( Com オブジェクト )
} LIBDAT;
 
----------------------------------------
 
 
LIBDAT構造体は、#uselib、#usecom等に対応した情報が含まれています。
それぞれの情報は、flagメンバによって情報の種類が決まります。
 
--------------------
 
flagの値は、以下のいずれかになります。
 
    #define LIBDAT_FLAG_NONE 0    // 無効
    #define LIBDAT_FLAG_DLL 1    // DLL(未インポート)
    #define LIBDAT_FLAG_DLLINIT 2    // DLL(インポート済)
    #define LIBDAT_FLAG_MODULE 3    // モジュール変数
    #define LIBDAT_FLAG_COMOBJ 4    // 定義済みCOMオブジェクト
 
--------------------
 
nameidxには、ライブラリ(DLL)名またはインターフェースIIDを示すDSインデックス
が格納されます。DSインデックスは、mem_mds(data segment)内のインデックスを
示します。( &hspctx->mem_mds[DSインデックス] で実際のポインタを取得する
ことができます。 )
 
--------------------
 
hlibは、インポートされたDLLのハンドルが格納されます。
 
--------------------
 
clsidは、COMオブジェクト定義時のクラスIDを示すDSインデックスが格納されます。
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
HSPCTX構造体
 
%group
; グループ を記入
構造体
 
 
%index
STRUCTPRM構造体
; 見出し を記入
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
STRUCTPRM構造体は以下のように定義されています。
 
typedef struct STRUCTPRM {
    short    mptype;		// パラメータの型
    short    subid;		// 構造体のインデックス
    int    offset;		// 先頭からのオフセット
} STRUCTPRM;
 
----------------------------------------
 
mptypeは、MPTYPE_*を参照。
 
subidには、通常自分自身のID(パラメーター情報インデックス)が格納
されています。
ただし、特殊なタイプでは以下の値が格納されます。
 
    #define STRUCTPRM_SUBID_STACK -1 // スタック内のローカル変数
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
MPTYPE_*
 
%group
; グループ を記入
構造体
 
%index
STRUCTDAT構造体
; 見出し を記入
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
 
STRUCTDAT構造体は以下のように定義されています。
 
typedef struct STRUCTDAT {
    short    index;		// ベースLIBDATインデックス
    short    subid;		// 構造体のインデックス
    int    prmindex;	// STRUCTPRMインデックス（ MINFO ）
    int    prmmax;		// STRUCTPRMの数
    int    nameidx;	// 名前インデックス（ DS ）
    int    size;		// 構造体のサイズ（スタック）
    int    otindex;	// OTインデックス（モジュール） /クリーンアップフラグ（ DLL ）
    void    *proc;		// プロセスのアドレス
} STRUCTDAT;
 
----------------------------------------
 
STRUCTDATは、スクリプトによって定義された１つのユーザー定義命令
(#deffunc、#func、#comfunc)に関する情報が含まれています。
 
--------------------
indexは、対応するライブラリ情報インデックスを示します。
(indexが示すLIBDAT構造体が関連していることになります。)
 
--------------------
subidは、ファンクション情報(自分自身)のインデックスIDが格納されます。
(「&hspctx->mem_finfo[インデックスID]」のインデックスになります。)
ただし、特殊なタイプでは以下の値が格納されます。
 
    #define STRUCTPRM_SUBID_DLL -3        // 外部DLL定義命令
    #define STRUCTPRM_SUBID_DLLINIT -4    // 外部DLL定義命令(*)
    #define STRUCTPRM_SUBID_OLDDLL -5    // 外部DLL定義命令
    #define STRUCTPRM_SUBID_OLDDLLINIT -6    // 外部DLL定義命令(*)
    #define STRUCTPRM_SUBID_COMOBJ -7    // COM呼び出し命令
 
    STRUCTPRM_SUBID_OLDDLL、STRUCTPRM_SUBID_OLDDLLINITは、
    レガシー命令(2.x互換)できることを示しています。
    (*)INITが付加されているものは、インポート済みであることを
       示しています。
 
実際のパラメーターに関する情報が、prmindexで示されるパラメーター情報に
格納されています。パラメーター情報は、「&hspctx->mem_minfo[prmindex]」
によって取得されるSTRUCTPRM構造体に記録されています。
 
--------------------
prmmaxは、パラメーター情報の数を示しています。たとえば、prmmaxが３の
場合は、「prmindex、prmindex+1、prmindex+2」の合計３つのパラメーターを
このファンクション情報が保持していることを示しています。つまり、
prmindexからprmmaxの個数だけ情報があることになります。
 
--------------------
nameidxは、ファンクション情報の名称文字列(またはファンクション名)を
示すDSインデックスが格納されます。
 
--------------------
sizeには、パラメーターが使用するメモリ上のサイズ(バイト数)が格納されます。
 
--------------------
procには、外部DLL定義命令時にインポートされた関数アドレスが格納されます。
 
--------------------
otindexは、情報のタイプによって内容が分かれます。
 
    ユーザー定義命令時        : OTインデックス(ラベル情報)
    外部DLL定義命令時         : クリーンアップ命令フラグ(0～1)
    COMオブジェクト定義命令時 : インポートID(序数)
    モジュール変数情報時      : 0(なし)
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
構造体
%index
active_window
; 見出し を記入
現在の操作先ウインドゥID？
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
*exinfo->actscr
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
未分類
 
%index
code_getpval
; 見出し を記入
???
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
exinfo->HspFunc_prm_getpval
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
未分類
 
 
 
 
%index
getproc
; 見出し を記入
???
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
exinfo->HspFunc_getproc
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
未分類
 
 
 
 
 
 
%index
stat
; 見出し を記入
システム変数？
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
ctx->stat
システム変数
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
 
%group
; グループ を記入
未分類
 
 
 
%index
HSPVAR_FLAG_*
; 見出し を記入
値の型
 
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
定数
 
値の型
HSPVAR_FLAG_NONE    ：？
HSPVAR_FLAG_LABEL    ：ラベル型
HSPVAR_FLAG_STR        ：SJIS文字列(str)
HSPVAR_FLAG_DOUBLE    ：64bit実数(double)
HSPVAR_FLAG_INT        ：32bit整数(int)
HSPVAR_FLAG_STRUCT    ：モジュール変数型
HSPVAR_FLAG_COMSTRUCT    ：？？？型
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
*HspFunc_getproc
code_setva
code_getprm
HspVarProc構造体
(*HspFunc_dim)
 
%group
; グループ を記入
定数
 
%index
TYPE_*
; 見出し を記入
command type
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
定数
 
用途不明。
サンプル（hpi3sample）では HSPVAR_FLAG_* であるべき箇所で使用されていますが、マニュアルの記載がありません。
 
TYPE_MARK    ：
TYPE_VAR    ：
TYPE_STRING    ：SJIS文字列(str)
TYPE_DNUM    ：64bit実数(double)
TYPE_INUM    ：32bit整数(int)
TYPE_STRUCT    ：モジュール変数型
TYPE_XLABEL    ：
TYPE_LABEL    ：
TYPE_INTCMD    ：
TYPE_EXTCMD    ：
TYPE_EXTSYSVAR    ：
TYPE_CMPCMD    ：
TYPE_MODCMD    ：
TYPE_INTFUNC    ：
TYPE_SYSVAR    ：
TYPE_PROGCMD    ：
TYPE_DLLFUNC    ：
TYPE_DLLCTRL    ：
TYPE_USERDEF    ：
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
HSPVAR_FLAG_*
 
%group
; グループ を記入
定数
 
 
%index
MPTYPE_*
; 見出し を記入
マルチパラメータタイプ
%prm
; パラメータリスト を記入
; パラメータ説明文 を記入
 
%inst
; 解説文 を記入
定数
 
mptypeは、パラメーターの型を示す値が格納されます。
パラメーターの型は、通常以下の値となります。
 
// マルチパラメータタイプ
#define MPTYPE_NONE 0
#define MPTYPE_VAR 1        // 変数
#define MPTYPE_STRING 2        // 文字列
#define MPTYPE_DNUM 3        // 実数(64bit浮動小数)
#define MPTYPE_INUM 4        // 整数
#define MPTYPE_STRUCT 5        // モジュール変数型
#define MPTYPE_LABEL 7        // ラベル型
 
#define MPTYPE_LOCALVAR -1    // ローカル変数
#define MPTYPE_ARRAYVAR -2    // 配列変数
#define MPTYPE_SINGLEVAR -3    // 変数そのもの(配列なし)
#define MPTYPE_FLOAT -4        // 32bit浮動小数
#define MPTYPE_STRUCTTAG -5    // モジュール変数型タグ
#define MPTYPE_LOCALSTRING -6    // ローカル文字列
#define MPTYPE_MODULEVAR -7    // モジュール変数名
#define MPTYPE_PPVAL -8        // PVALへのポインタ
#define MPTYPE_PBMSCR -9    // BMSCRへのポインタ
#define MPTYPE_PVARPTR -10    // 変数情報へのポインタ
#define MPTYPE_IMODULEVAR -11    // モジュール変数名
 
#define MPTYPE_IOBJECTVAR -12    // COMオブジェクト型
#define MPTYPE_LOCALWSTR -13    // ローカル文字列(Unicode)
#define MPTYPE_FLEXSPTR -14    // sptr
#define MPTYPE_FLEXWPTR -15    // wptr
#define MPTYPE_PTR_REFSTR -16    // refstrへのポインタ
 
#define MPTYPE_PTR_EXINFO -17    //
#define MPTYPE_PTR_DPMINFO -18    //
#define MPTYPE_NULLPTR -19    //
#define MPTYPE_TMODULEVAR -20    //
 
 
 
%sample
; サンプルスクリプト を記入
 
%href
; 関連項目 を記入
STRUCTPRM構造体
 
%group
; グループ を記入
定数

コメント †