2013年12月31日火曜日

【なでしこ】nako_comm.dll

2013年も今日で終わりか!!Σ( ̄口 ̄;;。ってことで結局あまり時間が
とれずにデバッグ出来なかったけど、取りあえず現状の"nako_comm.dll"を公開
します。

上記のリンクを辿るとnako_comm.7zをDL出来ますので、適当なところに解凍
します。

------ここから------
\nako_comm
|   debug.c
|   dll_comm_funcs.c
|   dll_comm_funcs.h
|   dnako_callback_funcs.c
|   dnako_import.c
|   dnako_import.h
|   dnako_import_def.h
|   dnako_import_types.c
|   dnako_import_types.h
|   dnako_plugin_body.c
|   log.txt
|   nako_comm.txt
|  
\---nako_dll_base
    |   dnako_import.def
    |   nako_dll_base.sln
    |   nako_dll_base.vcxproj
    |   nako_dll_base.vcxproj.user
    |  
    \---dll
            nako_comm_d.dll
            nako_comm_r.dll

 ------ここまで------

\nako_dll_base\dllの中に2つDLLが入ってます。「_d」がデバッグ版、
「_r」がリリース版でVC++でコンパイルしてます。使用の際は、それぞれ
「nako_comm.dll」にリネーム後、なでしこの\plug-insフォルダに
コピーして使ってください。


再コンパイルする場合には\nako_dll_base\nako_dll_base.slnをクリックして
VC++(Express)を起動して、コンパイルしてください。


含まれる命令(関数)仕様は以下の通りですが、あんまりデバッグ
してませんので、今回のものはDLLのサンプル程度に参照して
ください。来年(暇があったら)デバッグします(^^;。

------ここから------

■関数仕様

・バイト確保
    書式:バイト確保([int]バイト数、[int]初期値)
    戻値:[int]ハンドル
    説明:バイト数に1,2,4の何れかを指定して、変数を確保し、初期値を
       代入する。以降、戻り値のハンドルを使用して、値を読み書き
          出来る。
         
          確保されるメモリ領域は内部でunsignedで扱われる。この値は
          なでしこ側から見るとグローバルな領域になるので、関数内等
          ローカルスコープから本関数をコールした場合も、変数自体は
          グローバルに確保されていることに注意すること(つまり、
          なでしこの関数を抜けても、変数領域は解放されない)。
         
          確保が成功した場合には0以上の整数が、失敗した場合には-1
          が返される。使用が終了した場合はハンドルを解放すること。

・バイト読込
    書式:バイト読込([int]ハンドル)
    戻値:[int]変数値
    説明:バイト確保命令で取得したハンドルの、現在の値を取得する。
       戻り値は整数型になる。無効なハンドル値を指定した場合には
          常に0が返される。
         
・バイト書込
    書式:バイト書込([int]ハンドル、[int]値)
    戻値:[int]結果
    説明:バイト確保命令で取得したハンドルに対して、指定した値を
       書き込む。書き込める値の範囲は確保されている領域サイズに
          より異なり、範囲外の値を指定した場合にはエラーとなる。
         
          書込が成功した場合には0が、失敗した場合には-1が返される。

・エンディアン変換
    書式:エンディアン変換([int]ハンドル)
    戻値:[int]結果
    説明:バイト確保命令で取得したハンドルに対応する値のエンディアン
       変換を実施する。変換後の値はハンドル対応値に上書きされる。
         
          成功した場合は0が、無効なハンドルを指定した場合は-1が
          返される。

・バッファ確保
    書式:バッファ確保([int]サイズ)
    戻値:[int]ハンドル
    説明:メモリを動的に確保して、そのハンドルを返す。成功した場合、
       0以上のハンドル値が、失敗した場合には-1が返される。
         
          なお、メモリは動的に確保されているので、使用後はかならず
          ハンドルの解放を実施して確保されたメモリ領域を解放する
          こと。

・バッファクリア
    書式:バッファクリア([int]ハンドル、[int]クリア値)
    戻値:[int]結果
    説明:バッファ確保命令で取得したハンドルの領域をクリア値を用いて
       クリアする。クリア値には0~255(0xFF)までの1byte値を指定
          する。
         
          成功した場合は0が、無効なハンドル、クリア値を指定した
          場合は-1が返される。

・バッファコピー
    書式:バッファコピー([int]元ハンドル、[int]先ハンドル、[int]サイズ)
    戻値:[int]結果
    説明:既に確保されているコピー元ハンドルから、コピー先ハンドルに
       データをコピーする。先ハンドルはバッファでなくては
          ならないが、元ハンドルについてはバッファ、もしくは
          上記バイト確保命令で取得したハンドルでも良い。
         
          成功した場合は0が、無効なハンドルを指定した場合には-1が
          返される。

・バッファ読込
    書式:バッファ読込([int]ハンドル、[int]オフセット)
    戻値:[int]読込データ
    説明:既に確保されているメモリ領域(ハンドル)の、所定のオフセット
       位置から、1byteのデータを取得して返す。
         
          無効な引数を指定した場合には0が返される。

・バッファ書込
    書式:バッファ書込([int]ハンドル、[int]オフセット、[int]データ)
    戻値:[int]結果
    説明:既に確保されているメモリ領域(ハンドル)の、所定のオフセット
       位置に、1byteのデータを書き込む。データには0~255の値を
          指定する。
         
          成功した場合には0が、無効な引数を指定した場合には-1が
          返される。

・リングバッファ確保
    書式:バッファ確保([int]サイズ)
    戻値:[int]ハンドル
    説明:メモリを動的に確保して、そのハンドルを返す。成功した場合、
       0以上のハンドル値が、失敗した場合には-1が返される。
         
          なお、メモリは動的に確保されているので、使用後はかならず
          ハンドルの解放を実施して確保されたメモリ領域を解放する
          こと。
         
          「バッファ確保」と処理内容は一緒だが、以降このバッファは
          リングバッファとして扱われる。

・リングバッファ読込
    書式:リングバッファ読込([int]ハンドル、[int]先ハンドル、[int]サイズ)
    戻値:[int]サイズ
    説明:確保されているリングバッファハンドルから、サイズ分を読み
         込んで先ハンドル(バッファ)に書き込む。読み込めるサイズは
          コピー先のバッファサイズに依存し、バッファサイズ以上の
          データは読み込まない。読み込めたサイズは戻り値として返される。
         
          リングバッファなので、読み込みの開始位置は現在の読込位置
          となり、読み込んだサイズ分は以降書込可能領域となる。
         
          引数が不正な場合等、エラーの場合は-1が返される。

・リングバッファ書込
    書式:リングバッファ書込([int]ハンドル、[int]元ハンドル、[int]サイズ)
    戻値:[int]サイズ
    説明:作成済みの元ハンドル(バッファ)からサイズ分読み込んで、
       確保されているリングバッファハンドルに対して書き込む。
          書き込めるサイズは元ハンドルのサイズに依存し、それ以上の
          サイズを指定した場合は、書き込めるだけ書き込む。
          (データがある分だけ書き込む)。書き込めたサイズが戻り値
          として返される。
         
          書き込み位置はリングバッファ中の書き込み可能な領域の先頭
          からとなり、書き込んだ分は以降読込可能となる。書き込む前に
          空き領域を知りたい場合には「リングバッファ空きサイズ」
          命令でサイズを取得出来る。
         
          引数が不正な場合等、エラーの場合は-1が返される。

・リングバッファ読込サイズ
    書式:リングバッファ読込サイズ([int]ハンドル)
    戻値:[int]読込可能サイズ
    説明:確保されているリングバッファハンドルの、現在読み込める
       データサイズを返す。
         
          引数が不正な場合等、エラーの場合は-1が返される。

・キュー作成
    書式:キュー作成(#引数なし)
    戻値:[int]ハンドル
    説明:空のキューを作成して、そのハンドルを返す。キューに対しては
       本ライブラリで生成出来るハンドルを追加・取得出来る(FIFO)。
         
          成功した場合にはハンドル値が、失敗した場合には-1が返される。

・キュー追加
    書式:キュー追加([int]キュー、[int]ハンドル)
    戻値:[int]結果
    説明:指定のキューハンドルに、ハンドルを追加する。
   
       成功した場合は0が、失敗した場合は-1が返される。

・キュー取得
    書式:キュー取得([int]キュー)
    戻値:[int]ハンドル
    説明:指定されたキューから、先頭の1要素を取得して返す。
   
       成功した場合にはハンドル値が、失敗した場合には-1が返される。

・キュー要素数取得
    書式:キュー要素数([int]ハンドル)
    戻値:[int]要素数
    説明:指定されたキューに繋がれているハンドル数(要素数)を
       返す。失敗した場合には-1が返される。

・スタック作成
    書式:スタック作成(#引数なし)
    戻値:[int]ハンドル
    説明:空のスタックを作成して、そのハンドルを返す。スタックに対しては
       本ライブラリで生成出来るハンドルを追加・取得出来る(LIFO)。
         
          成功した場合にはハンドル値が、失敗した場合には-1が返される。

・スタック追加
    書式:スタック追加([int]スタック、[int]ハンドル)
    戻値:[int]結果
    説明:指定のスタックハンドルに、ハンドルを追加する。
   
       成功した場合は0が、失敗した場合は-1が返される。

・スタック取得
    書式:スタック取得([int]スタック)
    戻値:[int]ハンドル
    説明:指定されたスタックから、末尾の1要素を取得して返す。
   
       成功した場合にはハンドル値が、失敗した場合には-1が返される。

・スタック要素数取得
    書式:スタック要素数([int]ハンドル)
    戻値:[int]要素数
    説明:指定されたスタックに繋がれているハンドル数(要素数)を
       返す。失敗した場合には-1が返される。

・バイナリオープン
    書式:バイナリオープン([str]ファイル名、[int]モード)
    戻値:[int]ハンドル
    説明:ファイル名で指定されたファイルを、モードで指定された方法で
       オープンする。モードには0,1,2,3の何れかを指定し、意味は
          以下のとおり。

           0 : 読込専用
           1 : 書込専用
           2 : 読み書き
           3 : 追記
           
         ファイルは常にバイナリとしてオープンされる。テキストモード
          で扱いたい場合には、なでしこの組み込み命令を使用すると良い。

         成功すると0以上のハンドルが返される。失敗した場合には-1が
          返される(ファイルがない、モードが範囲外など)

・バイナリ読込
    書式:バイナリ読込([int]ハンドル、[int]先ハンドル、[int]サイズ)
    戻値:[int]サイズ
    説明:バイナリオープンされているハンドルから、サイズ分を読み
         込んで先ハンドル(バッファ)に書き込む。読み込めるサイズは
          コピー先のバッファサイズに依存し、バッファサイズ以上の
          データは読み込まない。読み込めたサイズは戻り値として
          返される。
         
          読み込み開始位置は現在の開始位置で、読み込む毎にオフセット
          がプラスされる。現在の開始位置はバイナリ位置取得命令で
          取得出来、位置の変更はバイナリシーク命令で可能である。
         
          引数が不正な場合等、エラーの場合は-1が返される。

・バイナリ書込
    書式:バイナリ書込([int]ハンドル、[int]元ハンドル、[int]サイズ)
    戻値:[int]サイズ
    説明:作成済みのバッファ(元ハンドル)からサイズ分読み込んで、
     バイナリオープンされているハンドルに対して書き込む。
          書き込めるサイズは元ハンドルのサイズに依存し、それ以上の
          サイズを指定した場合は、書き込めるだけ書き込む。
          (データがある分だけ書き込む)。書き込めたサイズが戻り値
          として返される。
         
          書込開始位置は、書込専用、読み書き用にオープンしている場合は
          ファイルの先頭から開始し、書き込む毎にオフセットがプラスされ
          る。既存ファイルの場合は一旦ファイルが消去されるので注意する
          こと。追記モードの場合はファイルの終端から書込が開始される。
         
          引数が不正な場合等、エラーの場合は-1が返される。

・バイナリシーク
    書式:バイナリシーク([int]ハンドル、[int]オフセット)
    戻値:[int]オフセット
    説明:バイナリオープンされているハンドルの読み込み・書込開始
       位置をオフセットの値に設定する。オフセットは0以上の
          値で、ファイルサイズ以上の値を設定した場合には、ファイルの
          末尾となる。
         
          成功した場合にはオフセット値が、失敗した場合には-1が
          返される。

・バイナリ位置取得
    書式:バイナリ位置取得([int]ハンドル)
    戻値:[int]位置
    説明:バイナリオープンされているハンドルの、現在開始位置を
       返す。引数が不正だった場合には-1が返される。

・ビットチェック
    書式:ビットチェック([int]ハンドル、[int]パターン)
    戻値:[int]結果
    説明:対象となるハンドルと、パターンを指定して、パターンビット
       が対象に含まれているかチェックする。対象はバイト確保
          されたハンドルであること。
         
          パターンが含まれている場合には1(TRUE)が、含まれていない
          場合は0(FALSE)が返される。引数が不正な場合には0が返される。

・ビットセット
    書式:ビットセット([int]対象、[int]パターン)
    戻値:[int]結果
    説明:対象のハンドル値に、パターンビットを設定する。対象は
         バイト確保されたハンドルを指定する。
         
          成功した場合には0が、引数に不正があった場合には-1が
          返される。

・ビットクリア
    書式:ビットクリア([int]対象、[int]パターン)
    戻値:[int]結果
    説明:対象のハンドル値の、パターンで指定されるビットをクリア
       する。対象はバイト確保されたハンドルであること。
         
          成功した場合には0が、引数に不正があった場合には-1が
          返される。

・ソケットオープン
    書式:ソケットオープン([int]タイプ)
    戻値:[int]ハンドル
    説明:タイプを指定してソケットを作成(オープンする)。
       タイプには以下の何れかを指定する。
           
            0 : TCP
            1 : UDP
         
          成功した場合には0以上のハンドル値が返される。失敗
          した場合には-1が返される。

・ソケット接続待ち
    書式:ソケット接続待ち([int]ハンドル、[int]ポート)
    戻値:[int]ソケットハンドル
    説明:ソケットオープンで取得済のハンドルと、指定のポートを
          使って、TCPで相手が接続してくるのを待つ。
         
          成功した場合は新規のソケットハンドルが、失敗した場合は
          -1が返される。成功した場合、後述の「相手IPアドレス取得」
          命令を使用して、接続相手のアドレスを取得することが出来る。

・ソケット接続
    書式:ソケット接続([int]ハンドル、[str]相手のアドレス、[int]ポート)
    戻値:[int]結果
    説明:ソケットオープンで取得済のハンドルと、サーバ側のアドレス、
         ポートを指定してTCPで接続する。
         
          接続が成功した場合には0が、失敗した場合には-1が返される。

・TCP送信
    書式:TCP送信([int]ハンドル、[int]バッファ、[int]サイズ)
    戻値:[int]サイズ
    説明:ソケットオープンで取得済のハンドル、且つこのソケットで
       相手に接続している場合に、バッファで指定されるハンドル
          のデータをサイズ分送信する。バッファはバッファ確保で
          取得したハンドルを指定すること。
         
          成功した場合には送信出来たサイズが返される。失敗した
          場合には-1が返される。

・TCP受信
    書式:TCP受信([int]ハンドル、[int]バッファ)
    戻値:[int]サイズ
    説明:ソケットオープンで取得済のハンドル、且つこのソケットで
       相手に接続している場合に、バッファで指定されるハンドル
          にデータを受信する。

          成功した場合には受信出来たサイズが返される。失敗した
          場合には-1が返される。

・UDP送信
    書式:UDP送信([int]ハンドル、[int]バッファ、[str]相手アドレス、[str]ポート)
    戻値:[int]サイズ
    説明:ソケットオープンで取得済のハンドルと、送信対象のバッファ
       のハンドル、及び相手アドレスとポートを指定してデータを
          送信する。ソケットハンドルはUDPでオープンされていること。
         
          成功した場合には送信サイズが返さえる。失敗した場合には
          -1が返される。

・UDP受信
    書式:UDP送信([int]ハンドル、[int]バッファ、[str]ポート)
    戻値:[int]サイズ
    説明:ソケットオープンで取得済のハンドルと、受信データ書きこみ
       用のバッファハンドル、及びポートを指定してデータを受信
          する。
         
          成功した場合には受信出来たサイズが返される。失敗した
          場合には-1が返される。

・相手IPアドレス取得
    書式:相手IPアドレス取得([int]ハンドル)
    戻値:[str]相手IPアドレス(文字列)
    説明:ソケットハンドルを指定して、TCP通信で接続した相手のアドレス、
       及びUDP通信で受信した場合の相手のIPアドレスを文字列で返す。

・シリアルオープン
    書式:シリアルオープン([int]ポート、[int]ボーレート)
    戻値:[int]ハンドル
    説明:ポートとボーレートを指定して、シリアルポートをオープン
        する。ポート、ボーレート以外のパラメータは、
         
           データ  :8bit
            パリティ :なし
            ストップ :1bit
            フロー制御:なし
         
          となる。
         
          成功した場合は0以上のハンドル値が返される。失敗した場合は
          -1が返される。

・シリアル送信
    書式:シリアル送信([int]ハンドル、[int]バッファ、[int]サイズ)
    戻値:[int]サイズ
    説明:シリアルオープンで取得済のハンドル、及びバッファ確保した
         ハンドルを指定してサイズ分のデータを送信する。
         
          成功した場合には送信出来たサイズが、失敗した場合には-1が
          返される。

・シリアル受信
    書式:シリアル受信([int]ハンドル、[int]バッファ、[int]サイズ)
    戻値:[int]サイズ
    説明:シリアルオープンで取得済のハンドル、及びバッファ確保した
         ハンドルを指定してサイズ分のデータを受信する。

          成功した場合には受信サイズが、失敗した場合には-1が
          返される。

・シリアルデータサイズ
    書式:シリアルデータサイズ([int]ハンドル)
    戻値:[int]サイズ
    説明:シリアルオープンで取得済のハンドルで指定されるシリアル
       ポートに対して、そのバッファに受信されているデータ
          サイズを取得する。
         
          ここでのバッファとは上記バッファ確保したものではなく
          Windowsのシリアルドライバが保持している受信バッファで
          ある。

・ハンドルタイプ取得
    書式:ハンドルタイプ([int]ハンドル)
    戻値:[int]ハンドルタイプ
    説明:指定ハンドルの種別を取得する。戻り値は以下のとおり。
      
       -1 :エラー(使われてない、など)
        1 :バイト
        2 :バッファ(リングバッファ)
        4 :ファイル
        8 :キュー
       16 :スタック
       32 :ソケット
       64 :シリアルポート
      
・ハンドル解放
    書式:ハンドル解放([int]ハンドル)
    戻値:なし
    説明:取得したハンドルを解放する。対象がメモリの場合はメモリ
       が解放され、バイナリ(ファイル)やソケットの場合は
          それらがクローズされる。

------ここまで------

いや~、なんか色々入れすぎた感もありますが、使いこなせば
C言語に近い動作をさせられそう♪。ただ、この後別のアプリを
なでしこでざっと作ってみて、なでしこに足りない部分はこの手の
命令よりも、実はGUIかなあ…と思ってます。エディタの簡易GUI
構築環境…思ってたよりも使えなかったなあ( ̄へ ̄;。

来年はこのあたりの解決方法を検討しよう♪