hspcl.txt

doclib\hspcl.txt » Plain Format

------------------------------------------------------------------------------
Hot Soup Processor CL ver2.61                       HSP : Hot Soup Processor  
ホットスーププロセッサ                copyright 1997-2004 (c) onion software  
------------------------------------------------------------------------------

・はじめに

このドキュメントは、Hot Soup Processor CL ver2.61について解説したものです。
Hot Soup Processor CLは、GUIやマルチメディア機能を排除したコンソール上での
入出力のみを行なうことができるバージョンです。
Hot Soup Processor CLは、win32コンソールアプリケーションです。
Windows 9x,Me,NT,2000,XPのコマンドプロンプト上で動作させることができます。
Hot Soup Processor CLの文法、詳しい操作方法については、
通常版のHot Soup Processor ver2.61マニュアルドキュメントを参照下さい。


・主な用途

Hot Soup Processor CLは、以下のような場面で使うことができます。

	・バッチファイルの代用として単純処理を行なう
	・WindowsベースのWEBサーバー上でのCGI実行する
	・メモリやCPUの負担をより軽くしてHSPスクリプトを実行する


・簡単な実行方法

Hot Soup Processor ver2.61以降に付属しているスクリプトエディタの、「HSP」
メニューにある「コンソールモード」のチェックによって、Hot Soup Processorと、
Hot Soup Processor CLを切り替えることが可能です。
「コンソールモード」がチェック(ON)になっている時に、Hot Soup Processor CLが
使用されます。
sample\hspclディレクトリにあるサンプルで実行を確認することができます。

コンソールモード時の動作は、通常のHSPスクリプトエディタとほとんど変わりありませんが、
hspcli.batを経由してコンパイルされたオブジェクトファイルがHSPCL.EXEに渡されます。
実行時には、コマンドプロンプトウインドゥが開きHSP CLの実行結果が表示されます。
実行が終了すると、「続行するには何かキーを押してください...」のメッセージが
表示されますので、結果を確認したら何かキーを押してウインドゥを閉じて下さい。
実行ファイル作成のメニューにより、HSP CLランタイムを使用した実行ファイルを
作成することが可能です。
ただし、実行ファイルの作成(ctrl+F9)ではデフォルトで標準のHSPランタイム(hsprt)が
使用されるため、コンソールモード時には正常な実行ファイルが作成されませんので、
ご注意下さい。コンソールモード時に、実行ファイルの自動作成(ctrl+F9)を行なう場合は、
必ずソーススクリプトにランタイムファイルの指定(「#packopt runtime "hspcl.hrt"」)を入れるようにしてください。


・コマンドラインからの実行方法

Windowsのコマンドプロンプトを起動してコマンドラインからHSPのオブジェクト
ファイルを指定することで、実行することができます。

	(例)
	test.axファイルを実行する

	> hspcl test.ax

HSPのオブジェクトファイルは、HSPスクリプトエディタで「HSP」メニューの
「オブジェクトファイル作成」を選ぶことで作成されます。
ただし、この方法ではデバッグ情報が作成されません。デバッグ情報を含む
オブジェクトファイルは、HSPスクリプトエディタから「コンパイルのみ」(F7)
を選択することで作成される「obj」ファイルをお使い下さい。

コンソール上で、直接オブジェクトファイルを作成したり、実行ファイルを作成
する場合には、別途対応ソフト(FORCEさんの"HSP COMMANDLINE COMPILER"
 http://hp.vector.co.jp/authors/VA015266/ など)をご用意下さい。


・通常版との違い

ウインドゥ、オブジェクト、マルチメディアに関する命令は使用できません。
また、waitawaitなどの待ち時間処理はサポートされていません。
HSP CL専用のinput命令が実装されています。書式は以下の通りです。

	input p1,p2,p3				標準入力を取得

	p1=変数名  : 情報を格納する変数名
	p2=1〜     : 変数に代入される最大文字数
	p3=0〜1(0) : 改行コード認識フラグ(0=なし/1=認識)

	・説明

		標準入力の内容をp1で指定された変数に代入します。
		p1で指定された変数は文字列型に変更され結果が代入されます。
		この場合、文字列のサイズは、p2で指定した文字数までとなります。
		p2の指定が省略された場合は、変数に代入できる最大値となります。
		p3を省略するか、0を指定した場合は標準入力すべて(EOFまで)を
		そのまま取得します。p3に1が指定された場合は、改行コード(13)を
		終端として認識します。標準入力として、キーボード入力(コンソール)
		を使用する場合には、p3を1にすることにより[Enter]キーで入力を
		確定させることが可能になります。

		入力結果の文字数はシステム変数strsizeに保存されます。

それ以外の機能は、ver2.61相当として使用することが可能です。
拡張プラグインや、loadlib関連命令も使用可能です。(ただし、プラグイン側が
BMSCR構造体を取得して使用するような場合に動作エラーとなることがあります。)
実行ファイル作成、PACKFILEの埋め込み、暗号化などもサポートしています。
使用可能な命令セットの詳細は、命令一覧を参照してください。


・命令一覧

	◎=互換 / △=一部仕様変更 / ×=未サポート
	-------------------------------------------------------
	◎ gotogosubreturnbreak
	× onexit
	× onkey
	× onclick
	× oncmd
	◎ onerroronexgotowait (指定時間スレッドを停止させます)
	◎ repeatloopmes (標準出力が対象になります)
	△ print (標準出力が対象になります)
	◎ dimsdimallocbloadbsavebcopystop (実行を終了します)
	◎ runrndstrintskiperrdupawait (waitと同じ動作になります)
	◎ pokepeekwpokewpeekstrlengetstrexiststrmidinstrcontinuemref	(VRAM、BMSCR構造体の取得はできません)
	◎ logmodelogmesmemcpymemsetnoteselnoteaddnotegetnotemaxnotedelnoteloadnotesavememfile
	× button

	× title
	× pos
	× cls
	× font
	× sysfont
	× objsize
	× picload
	× color
	× palcolor
	× palette
	× redraw
	× width
	× gsel
	× gcopy
	× gzoom
	× gmode
	× bmpsave
	× textgetkey
	× sndload
	× snd
	× mciinput (標準入力を取得します:マニュアル参照)
	× mesbox
	× buffer
	× screen
	× bgscrdialog
	× chgdispexecmkdir
	× sndoff
	× boxf
	× pget
	× pset
	× palfade
	× getpalgettime
	× palcopyrandomize
	× clrobj
	× chkbox
	× linestick
	× ginfo
	× comboxchdir
	× objprm
	× objsend
	× objmodesysinfogetpath
	× mousedirlistdelete
	× listbox
	× objselll_retll_retsetll_getptrll_peekll_peek1ll_peek2ll_peek4ll_pokell_callfuncll_nll_poke1ll_poke2ll_poke4ll_libfreell_callfnvll_callll_freell_sll_pll_strll_dllll_funcll_typell_zll_libloadll_getprocll_bin


・更新履歴

	2004/03/12 2.61β4

		プラグインの初期化に失敗することがある不具合を修正。
		標準入力取得時(input)の文字数をシステム変数strsizeに保存するように修正。
		標準入力の設定をバイナリモードに修正。

	2003/09/05 2.6β3

		input命令の仕様を変更。改行の認識などを指定可能に修正。

	2003/04/15 2.6β2

		HSP CL専用のスクリプトエディタhsed2cl.exe、hsp2.batを同梱。
		hspcmp.dll(ver2.6)およびver2.6付属DLLを同梱。
		wait,awaitをサポート(一部仕様が異なります)。
		環境変数を取得するサンプル(getenv.as)を追加。
		実行ファイルに拡張子の".ax"が付加される不具合を修正。
		execなど一部の命令が以降の命令をスキップする不具合を修正。
		input命令での標準入力取得を行単位で行なうように修正。
		エラー終了時にerrorlevelを返すように修正。

	2003/04/09 2.6β1

		ver2.6のバリエーションとして作成。


・著作権および連絡先

	使用の規定については通常版(ver2.6)と同様です。
	詳しくは、Hot Soup Processor ver2.6の著作権、ライセンス規定を参照下さい。
	β版を使用したスクリプト・EXEなどの公開、配布は原則として可能ですが、
	十分テストが行なわれていないテスト版であることを留意しておいてください。
	あくまで、自己の責任の範囲で運用してください。
	このβ版についての情報は、以下のURLで扱います。
	不具合やお気づきの点がありましたら、お知らせ下さい。

	http://www.onionsoft.net/hsp/hsp2beta.html

	onion softwareは本プログラムによって生じた、いかなる損害についても
	保証いたしません。自己の責任の範囲で使用してください。
	HSPおよび周辺ツールは、Microsoft Visual C++7.0によってコンパイルされています。

	このソフトに関するお問い合わせ、感想、ご意見などは以下のメールアドレスまで。
		Homepage: http://www.onionsoft.net/
                e-mail  : onitama@onionsoft.net

------------------------------------------------------------------------------
                                                     README.TXT / end of file 
------------------------------------------------------------------------------