global オブジェクト(非標準関数) ...

print 関数 global(nonstd func)...

print( str[, str2, ...] )
println( str[, str2, ...] ) deprecated
p( str[, str2, ...] ) deprecated

print("abc =", 123, "+", 321);
print("abc =", 444);
// abc = 123 + 321
// abc = 444

putstr 関数global(nonstd func)...

putstr( str[, str2, ...] )

putstr("abc =", 123, "+", 321); // abc = 123 + 321

alert 関数 global(nonstd func)...

alert( message[, title][, style][, hwnd] )

警告メッセージ

タイトル(省略時、"Warning")

alert.MB_OK, MB_OKCANCEL, ...., MB_TASKMODALなど
省略時はMB_TASKMODAL

Windowハンドル
省略時は0

style==-1のとき、返値なし
style!=-1のとき、WindowsのMessageBox関数と同じ結果が返される.

confirm 関数 global(nonstd func)...

confirm( message ) : Boolean

確認メッセージ

[OK] ボタンを押すと真（true）が、[Cancel]ボタンを押すと偽（false）が返されます。

prompt 関数 global(nonstd func)...

prompt( message[, default, title] ) : String or null

newGlobal 関数 global(nonstd func)...

new_global = newGlobal([options]) : Object

intern 関数 global(nonstd func)...

intern(str)

__wrapper__ 関数 global(nonstd func)...

wrappedfunc = __wrapper__(func, [fname=""], [nonProcForError=false]) : Function

evaluate 関数 global(nonstd func)...

evaluate( scriptcode[, option] )

例1．単純な計算
  TODO
  
例2．変数の値
  TODO

__evalWithThis__ 関数 global(nonstd func)...

__evalWithThis__( scriptcode )
__evalWithThis__.call( ctx, scriptcode )

例1．単純な計算
  var x = 3, y = 4;
  alert(
     __evalWithThis__("Math.sqrt( x*x + y*y)")
  );  //5
  alert(
     __evalWithThis__.call({x:5, y:12}, "Math.sqrt( x*x + y*y)")
  );  //13
  
例2．変数の値
  var z = 1;
  function f() {
    var z = 2;
    alert(
      __evalWithThis__("z = z * 100")
    );
  }
  f();  // 100

  function g() {
    var z = 2;
    alert(
      eval("z = z * 100")
    );
  }
  g();  // 200

load 関数 global(nonstd func)...

load( scriptname[, before, after] )
load( dllname )

__loadDll__ 関数 global(nonstd func)...

__loadDll__( dllname, obj )

compile 関数 global(nonstd func)...

compile( scriptcode[, scriptname="" [, lineno=1] ] )

__modifyCode__ 関数 global(nonstd func)...

__modifyCode__(code[, filename [, lineno]]) : String

__snarf__ 関数 global(nonstd func)...

text = __snarf__(filename)
binary = __snarf__(filename, "binary")

__dump__ 関数 global(nonstd func)...

str = __dump__(value)
ok = __dump__(value, filename)

__debugLogger__ 関数 global(nonstd func)...

logout = __debugLogger__(logfilename)

__getTempFilename__ 関数 global(nonstd func)...

__getTempFilename__([path=""], [prefix=""]) : String

__searchFile__ 関数 global(nonstd func)...

__searchFile__(filename[, defautext=""]) : Object

filenameがフルパスでないとき、実行スクリプトファイルのフォルダーとlibPathに登録されたフォルダーから検索してファイルを見つけます。

__interactive__ 関数 global(nonstd func)...

__interactive__(b) : Boolean

__silent__ 関数 global(nonstd func)...

__silent__([b]) : Boolean

quit 関数 global(nonstd func)...

quit( [exitcode] )

sleep 関数 global(nonstd func)...

sleep( time )

ミリ秒

Javascriptの実行を指定時間、休止します。

__exit__ 関数 global(nonstd func)...

__exit__( [exitcode] )

gc 関数 global(nonstd func)...

gc()

for (var i=0; i<100000; ++i) {
    ・  // メモリーを消費する処理
  if ((i+1)%1000==0) gc(); // 1000回に処理を繰り返したらメモリー掃除を行う
}

gcparam 関数 global(nonstd func)...

gcparam( name[, value] )

options 関数 global(nonstd func)...

options( opts ) : String

isOption 関数 global(nonstd func)...

isOption( optionname ) : Boolean

setOption 関数 global(nonstd func)...

setOption( optionname, [bset=true] )

safeMode 関数 global(nonstd func)...

safeMode( [code] ) : Number

isSafe 関数 global(nonstd func)...

isSafe() : Boolean

__getNprocessor__ 関数 global(nonstd func)...

__getNprocessor__() : Integer

__getNworkerthread__ 関数 global(nonstd func)...

__getNworkerthread__() : Integer

__setNworkerthread__ 関数 global(nonstd func)...

__setNworkerthread__(nworkerthread) : Integer

__setTimer__ 関数 global(nonstd func)...

timer_id = __setTimer__(delay) : Integer

__killTimer__ 関数 global(nonstd func)...

__killTimer__(timer_id) : Boolean

__procTimer__ 関数 global(nonstd func)...

__procTimer__(timer_id)

version 関数 global(nonstd func)...

verno = vesion()
verno = version(vernoToSet)

build 関数 global(nonstd func)...

build()

help 関数 global(nonstd func)...

help([func ...])()

__bits__ 定数global(nonstd func)...

__bits__ : Integer [ReadOnly]

CPUビット数
64ビット版 OgO.exeの場合、64.
32ビット版 OgO.exeの場合、32.
  

__context__ 文字列定数global(nonstd func)...

__context__ : String [ReadOnly]

JavaScriptコンテキストアドレスを１６進数で文字列化

__hwnd__ 定数global(nonstd func)...

__hwnd__ : Integer [ReadOnly]

JavaScript Windowハンドル

__hmainWnd__ 定数global(nonstd func)...

__hmainWnd__ : Integer [ReadOnly]

アプリメイン Windowハンドル

__dirname 文字列定数global(nonstd func)...

__dirname : String [ReadOnly]

現在実行中スクリプトファイルのディレクトリ名(最後「\」なし)

__filename 文字列定数global(nonstd func)...

__filename : String [ReadOnly]

現在実行中スクリプトのフルファイルパス名

__root_dir__ 文字列定数global(nonstd func)...

__root_dir__ : String [ReadOnly]

OgOルートディレクトリ(最後「\」なし)

__appFolder__ 文字列定数global(nonstd func)...

__appFolder__ : String [ReadOnly]

アプリケーションルートディレクトリ(最後「\」あり)

__appName__ 文字列定数global(nonstd func)...

__appName__ : String [ReadOnly]

アプリケーション名

__appProgname__ 文字列定数global(nonstd func)...

__appProgname__ : String [ReadOnly]

アプリケーション実行プログラム名

_r, _R 関数 global(nonstd func)...

_r`raw_string`
_R`raw_string`

OgO内部で次のように定義しています。
let   _r = String.raw;
let   _R = String.raw;

__regEndProc__ 関数 global(nonstd func)...

__regEndProc__(endProc)()

function endProc() {
  //ここにJSスレッドが終了すときに、後始末などの処理を行うプログラムを記述
  ・・・
}

__unregEndProc__ 関数 global(nonstd func)...

__unregEndProc__(endProc)()

PWorkerクラス ...

JavaScript実行環境OgOが動作する(Activeな)プロセスやスレッドを、PWorker(プロセスWorker)と呼ぶことにします。
PWorkerオブジェクトは、プロセスWorker間を通信可能にするオブジェクトです。

PWorkerオブジェクトを使ったプロセス間通信プログラムは、PWorkerを呼び出す側(クライアント側)と呼び出される側(サーバ側)のコードを決まった手順で記述します。

■ シンプルなプロセス間通信の手順

=PWorkerを呼び出す側(クライアント側)コード=
[C1] 呼び出すPWorkerオブジェクトを作成(ロードしていなければロードする)
[C2] サーバ側からのレスポンスを受信する関数を登録
[C3] サーバ側でリクエスト処理中に起きたエラーをキャッチする関数を登録
[C4] サーバ側にリクエストを送る

=呼び出される側(サーバ側)PWorkerのコード=
[S1] クライアント側からのリクエストを受信する関数を登録
[S2] クライアント側にレスポンスを返す

□ 簡単なプロセス間通信のサンプルプログラム

2つのクライアント(SimpleClient,SimpleClient2)が１つのサーバー(SimpleServer)からサービスを受ける

*** SimpleClient.js ***(Start PWorker)
// PWorkerを呼び出す側(クライアント側)コード
var  pw = new PWorker("SimpleServer", "SimpleServer.js"); // [C1]
on("ansAdd", function(ans) { print("ans = " + ans); });  // [C2]
on("error", function(err) { // [C3]
    alert("filename : " + err.filename + "\n" +
          "lineno   : " + err.lineno + "\n" +
          "message  : " + err.message);
});
pw.post("add", 100,200);  // [C4]

/* 出力結果
ans = 300
*/

*** SimpleClient2.js ***(Second PWorker)
// PWorkerを呼び出す側(クライアント側)コード
var  pw = new PWorker("SimpleServer"); // [C1]  すでにサーバが起動していればニックネームのみの引数でよい
on("ansAdd", function(ans) { print("ans = " + ans); });  // [C2]
pw.post("add", 10,20);  // [C4]

/* 出力結果
ans = 30
*/

----------------------------------------------------------------------
*** SimpleServer.js ***(Server PWorker)
// 呼び出される側(サーバ側)PWorkerのコード
on("add", function(a,b) { // [S1]
  this.source.post("ansAdd",a + b ); //[S2] sourceは呼び出す側(クライアント側)のPWorkerオブジェクト
});

■ 精密なプロセス間通信の手順

=PWorkerを呼び出す側(クライアント側)コード=
[C1] 呼び出すPWorkerオブジェクトを作成(ロードしていなければロードする)
[C2] connect要求して portを取得
[C3] portオブジェクトにサーバ側からのレスポンスを受信する関数を登録
[C4] サーバ側でリクエスト処理中に起きたエラーをキャッチする関数を登録
[C5] サーバ側でportを閉じられたことをキャッチする関数((port切断時の終了処理))を登録
[C6] サーバ側にportを使ってリクエストを送る
[C7] portの切断

=呼び出される側(サーバ側)PWorkerのコード=
[S1] クライアント側からのconnect要求を受信する関数を登録
[S2] クライアント側からのリクエストを受信する関数を登録
[S3] クライアント側でportが閉じられたことをキャッチする関数(port切断時の終了処理)を登録
[S4] クライアント側にレスポンスを返す

□ 精密なプロセス間通信のサンプルプログラム

2つのクライアント(ExactClient,ExactClient2)が１つのサーバー(ExactServer)からサービスを受ける

*** ExactClient.js ***(Start PWorker)
// PWorkerを呼び出す側(クライアント側)コード
var  pw = new PWorker("ExactServer", "ExactServer.js"); // [C1]
var  port = pw.connect("ExactClient");  // [C2]
port.on("ansAdd", function(ans, name, cnt) { print(cnt + " call => [add] ans = " + ans + " name = " + name); });  // [C3]
port.on("ansSub", function(ans, name, cnt) { print(cnt + " call => [sub] ans = " + ans + " name = " + name); });  // [C3]
port.on("error", function(err) { // [C4]
    alert("filename : " + err.filename + "\n" +
          "lineno   : " + err.lineno + "\n" +
          "message  : " + err.message);
});
port.on("close", function() { // [C5]
    // サーバ側から portが閉じられた
    // portが切断された
    // ・・・
});

port.post("add", 200,100); // [C6]
port.post("sub", 200,100); // [C6]
port.close();  // [C7]  以降、通信できない

/* 出力結果
1 call => [add] ans = 300 name = ExactClient
2 call => [add] ans = 100 name = ExactClient
*/

*** ExactClient2.js ***(Second PWorker)
// PWorkerを呼び出す側(クライアント側)コード
var  pw = new PWorker("ExactServer");   // [C1]   すでにサーバが起動していればニックネームのみの引数でよい
var  port = pw.connect("ExactClient2");  // [C2]
port.on("ansAdd", function(ans, name, cnt) { print(cnt + " call => [add] ans = " + ans + " name = " + name); });  // [C3]
port.on("ansSub", function(ans, name, cnt) { print(cnt + " call => [sub] ans = " + ans + " name = " + name); });  // [C3]

port.post("add", 20,10); // [C6]
port.post("sub", 20,10); // [C6]
port.post("add", 2000,1000); // [C6]
port.close();  // [C7]  以降、通信できない

/* 出力結果
1 call => [add] ans = 30 name = ExactClient2
2 call => [sub] ans = 10 name = ExactClient2
3 call => [add] ans = 3000 name = ExactClient2
*/

----------------------------------------------------------------------
*** ExactServer.js ***(Server PWorker)
// 呼び出される側(サーバ側)PWorkerのコード
on("connect", function(event) {   // [S1]
  var port = event.ports[0];
  var name = event.data;
  var cnt = 0;
  
  port.on("add", function(a,b) {  // [S2]
    port.post("ansAdd", a + b, name, ++cnt); // [S4]
  });
  port.on("sub", function(a,b) {  // [S2]
    port.post("ansSub", a - b, name, ++cnt); // [S4]
  });
  port.on("close", function() {   // [S3]
    // クライアントが portを閉じた
    // portが切断された
    // ....
  });
});

===== イベント送受信 =====
上記のプロセスWorker間の通信は、post,connect,close関数を使ってイベントを送信し、送信先の受信関数でイベントを受け取ることで実現されています。
下図は濃いブルーは「シンプルなプロセス間通信」、濃いレッドは「精密なプロセス間通信」のイベント送受信の様子をあらわしています。

矢印先で登録された受信関数が呼び出されます。この受信関数登録は、
「シンプルなプロセス間通信」では、addListener, onグローバル関数が使用されます。
「精密なプロセス間通信」では、PWportオブジェクトメソッド addListener, on関数が使用されます。

addListener, on 関数 global(nonstd func)... PWorker...

addListener( name, func ) : GloablObject
on( name, func ) : GloablObject

addListener(name, function(arg1,arg2) { // または on(name, function(arg1,arg2) {
  /*
    thisのプロパティ
      type   : name
      source : (通信相手)PWorkerオブジェクト
      data   : [arg1, arg2]
  */
  // ・・・  処理
});
    

addListener("message", function(event) { // または on("message", function(event) {
  /*
    this : pworker

    eventオブジェクトのプロパティ
      type   : "message"
      source : (通信相手)PWorkerオブジェクト
      data   : data
  */
  var  data = event.data;
  // ・・・  処理
});
    

addListener("connect", function( event ) { // または on("connect", function( event ) {
  /*
    this : pworker

    eventオブジェクトのプロパティ
      type   : "connect"
      source : (通信相手)PWorkerオブジェクト
      ports  : pwport[]
      data   : data
  */
  // 通信切断 終了処理・・・
});
    

addListener("error", function(err) { // または on("error", function(err) {
  /*
    this : (通信相手)PWorkerオブジェクト

    errオブジェクトのプロパティ
      message  : エラーメッセージ
      filename : ファイル名
      lineno   : 行番号
  */
  // ・・・
});
    

removeListener, off 関数 global(nonstd func)... PWorker...

removeListener( name, func ) : GloablObject
off( name, func ) : GloablObject
removeListener( name ) : GloablObject
off( name ) : GloablObject
removeListener() : GloablObject
off() : GloablObject

__isProcessingRequest__ 関数 global(nonstd func)... PWorker...

__isProcessingRequest__() : Boolean

__waitEvents__ 関数 global(nonstd func)... PWorker...

__waitEvents__([millisecond])

__cancelWaitEvents__ 関数 global(nonstd func)... PWorker...

__cancelWaitEvents__()

regSelf クラス関数 PWorker...

PWorker.regSelf( name ) : Integer

unregSelf クラス関数 PWorker...

PWorker.unregSelf( id )

myName クラス関数 PWorker...

PWorker.myName() : String
PWorker.myName(id) : String

__myNameS__ クラス関数 PWorker...

PWorker.__myNameS__() : Array

mySelf クラス関数 PWorker...

PWorker.mySelf() : PWorker
PWorker.mySelf(id) : PWorker

__isServer__ クラス関数 PWorker...

PWorker.__isServer__() : Boolean

PWorker コンストラクタ PWorker...

(1) pworker = new PWorker( nickname ) : PWorker
(2) pworker = new PWorker( nickname, workerpath[, visible=false] ) : PWorker
(3) pworker = new PWorker( nickname, option ) : PWorker

connect 関数 PWorker...

port = pworker.connect() : PWport
port = pworker.connect( data ) : PWport

on("connect", function(event) {
  var port = event.ports[0];  // PWportオブジェクト
  var data = event.data;      // 呼び出し側のconnectメソッド関数の引数
  
  port.on("add", function(a,b) { // 呼び出し側のrequestイベントを受信する関数を登録
    port.post("ansAdd", a + b);  // 呼び出し側へreposeイベントを送る
  });
  port.on("sub", function(a,b) {
    port.post("ansSub", a - b);
  });
  port.on("close", function() {   // 呼び出し側がportを切断したイベントを受け取る関数を登録
    // portが切断された
    // ....
  });
});
    

post 関数 PWorker...

pworker.post(name[,data, ...])

on(name, function(data) {
  // data は postメソッド関数の引数
  var source = this.source; // イベント送り側のPWorkerオブジェクト
  ・・・  // 処理
  source.post(ansEventname, ansValue);  // イベントで返答できる。ただし、イベント送り側に受信関数の登録が必要。
});
    

postMessage 関数 PWorker...

pworker.postMessage( data )

on("message", function(event) {
  var data = event.data; // data は postメソッド関数の引数
  var source = event.source; // イベント送り側のPWorkerオブジェクト
  ・・・  // 処理
  source.post(ansEventname, ansValue);  // イベントで返答できる。ただし、イベント送り側に受信関数の登録が必要。
});
    

getName 関数 PWorker...

pworker.getName() : String

equal 関数 PWorker...

pworker.equal( apworker[, strict=false] ) : Boolean

__connect__ 関数 PWorker...

id = pworker.__connect__() : Integer
id = pworker.__connect__( data ) : Integer

__destroy__ 関数 PWorker...

pworker.__destroy__()

invalid 関数 PWorker...

pworker.invalid() : Boolean

__data__ 関数 PWorker...

pworker.__data__() : Array

__destroy__ 関数 PWorker...

pworker.__destroy__()

__postMessage__ 関数 PWorker...

pworker.__postMessage__(data, name="", portid=0)

__valid__ 関数 PWorker...

pworker.__valid__( strict=false ) : Boolean

PWportクラス ...

PWorkerオブジェクトを使ったプロセス間通信プログラムは簡易で分かりやすいです。
しかし、欠点として不特定多数の相手と通信ができてしまうため、通信の目的と相手の特定があやふやになりがちです。

この欠点を解決するのが、PWportクラスです。 PWorkerオブジェクトのconnectメソッド関数を使って、指定プロセスWorker間の通信回線を行えるPWportオブジェクトが作成できます。
この通信回線は、他のPWorkerオブジェクトから割り込めず、通信中の状態変移を維持するので目的の処理を確実に行えます。

__get__ クラス関数 PWport...

PWport.__get__( portid ) : PWport

pworker プロパティ PWport...

pwport.pworker : PWorker [ReadOnly]

post 関数 PWport...

pwport.post(name[,data, ...])

port.on(name, function(data) {
  // data は postメソッド関数の引数
  ・・・  // 処理
  port.post(ansEventname, ansValue);  // イベントで返答できる。ただし、イベント送り側に受信関数の登録が必要。
});
    

postMessage 関数 PWport...

pwport.postMessage( data )

port.on("message", function(event) {
  var data = event.data; // data は postメソッド関数の引数
  ・・・  // 処理
  port.post(ansEventname, ansValue);  // イベントで返答できる。ただし、イベント送り側に受信関数の登録が必要。
});
    

close 関数 PWport...

pwport.close( data )

addListener, on 関数 PWport...

pwport.addListener( name, func ) : PWport
pwport.on( name, func ) : PWport

pwport.addListener(name, function(arg1,arg2) { // または pwport.on(name, function(arg1,arg2) {
  /*
    thisのプロパティ
      type   : name
      source : (通信相手)PWorkerオブジェクト
      port   : pwport
      data   : [arg1, arg2]
  */
  // ・・・  処理
});
    

pwport.addListener("message", function(event) { // または pwport.on("message", function(event) {
  /*
    this : pwport

    eventオブジェクトのプロパティ
      type   : "message"
      source : (通信相手)PWorkerオブジェクト
      port   : pwportS
      data   : data
  */
  var  data = event.data;
  // ・・・  処理
});
    

pwport.addListener("close", function() { // または pwport.on("close", function() {
  /*
    this : pwport

  */
  // 通信切断 終了処理・・・
});
    

pwport.addListener("error", function(err) { // または pwport.on("error", function(err) {
  /*
    this : (通信相手)pwportオブジェクト

    errオブジェクトのプロパティ
      message  : エラーメッセージ
      filename : ファイル名
      lineno   : 行番号
  */
  // ・・・
});
    

removeListener, off 関数 PWport...

pwport.removeListener( name, func )
pwport.off( name, func )
pwport.removeListener( name )
pwport.off( name )
pwport.removeListener() pwport.off()

invalid 関数 PWport...

pwport.invalid() : Boolean

__data__ 関数 PWport...

pwport.__data__() : Array

__valid__ 関数 PWport...

pwport.__valid__() : Boolean

MemMapFileクラス ...

MemMapFileオブジェクトは、メモリへマップされたファイルを、ctypesモジュールのメモリアクセス機能でファイルの中身を操る機能を提供します。

MemMapFileオブジェクトは次の３つのモードで作成でき、指定ファイルのMemMapFileオブジェクト数とアクセスが制限されます。

• NORMALモード　・・・MemMapFileオブジェクト１つに制限される。Read/Write操作可能。
• READONLYモード・・・MemMapFileオブジェクトは複数作成可能。操作Readのみで、Writeしてもファイルに反映されない。
• SHAREDモード　・・・MemMapFileオブジェクトは複数作成可能。Read/Write操作可能。プロセス・スレッド間のデータ交換が可能。

    var {MemMapFile} = require('MemMap');
    または
    var {MemMapFile, NORMAL, READONLY, SHARED} = require('MemMap');
  

   // 個人情報をバイナリファイルでwriteして、ファイルを閉じる。
   var {MemMapFile} = require('MemMap');

   var {Person} = DSL.C(`
      typedef struct {
        char name[64];
        int age;
        char sex[8];
        char hobby[128];
      } Person;
   `);
   var TwoPerson = Person.array(2);
   var mmf = new MemMapFile("personalInfo.data", TwoPerson.size);
   var persons = mmf.getRef(TwoPerson);

   persons[0] = {name:"山田太郎", age:24, sex:"man", hobby:"野球"};
   persons[1] = {name:"福山花子", age:22, sex:"woman", hobby:"旅行"};

   mmf.close();

   // 上記のバイナリーデータファイルをopenして読み込む
   var mmf = new MemMapFile("personalInfo.data");
   var persons = mmf.getRef(TwoPerson);
　 
   var name, age, sex, hobby;
   for (var i=0; i<2; i++) {
     name = persons[i].name.readString();
     age = persons[i].age;
     sex = persons[i].sex.readString();
     hobby = persons[i].hobby.readString();
     print(`------------------
     name=${name}, age=${age}, sex=${sex}, hobby=${hobby}
     `)
   }

   mmf.close();
  

   // 奇数をバイナリーで書き込み(SHAREDモード)
   var {MemMapFile, NORMAL, READONLY, SHARED} = require('MemMap');
 
   var int = ctypes.int;
   var arrytype100 = int.array(100);

   var mmf = new MemMapFile("odds.data", arrytype100.size, SHARED);
   var odds = mmf.getRef(arrytype100);

   for (var i=0; i<100; i++) {
    odds[i] = 2*i + 1;
   }

   mmf.close();

  -----------------------------------------
  // 上記のバイナリーデータファイルを読み込む(SHAREDモード)(上記と違うプロセスまたはスレッドでプログラムを走らせる)
  var {SHARED} = MemMapFile; 
  var int = ctypes.int;
  var arrytype100 = int.array(100);

  var mmf = new MemMapFile("odds.data",0,SHARED);
  var odds = mmf.getRef(arrytype100);

  print(`odds[45]=${odds[45]}`);
  //odds[45]=91

  mmf.close();
 

MemMapFile コンストラクター MemMapFile...

new MemMapFile( filename[, size][, mode] ) : MemMapFile

ファイル名

バイト数(省略時は0)

size=0のとき、既存ファイルからMemMapファイルを作成し、サイズはそのサイズ。

size>0のとき、
     ファイルがあればMemMapファイルを作成し、
            そのファイルサイズ ＜ size なら、ファイルサイズが拡張される。
                ファイルサイズ ≧ size なら、ファイルサイズは変更されない。
     ファイルが無ければ、そのサイズのファイルが作成される。
        

作成フラッグ(省略時はNORMAL)

mode=NORMALのとき、PC内でopenできるのはこのMemMapファイルオブジェクトだけとなり、
     別のプロセス・スレッドで同じファイルのMemMapファイルオブジェクトは作成できない。
     読み書きはもちろん可能である。

mode=READONLYのとき、ファイルを読み込むが、書き込んでもファイルに反映されない。

mode=SHAREDのとき、読み書き可能な複数のMemMapファイルオブジェクトを作成できるモード。
     別のプロセス・スレッドで同じファイルのメモリマップファイルオブジェクトを作成すれば、ファイルが共有されデータ交換が可能になる。

    

   // 単位円上点座標のバイナリーデータファイルを作成
   var {MemMapFile, NORMAL, READONLY, SHARED} = require('MemMap');

   var {Pnts} = DSL.c(`
      typedef struct Point {
        double x, y;
      } Point;
      typedef Point Pnts[101];
   `);

   var mmf = new MemMapFile("pnts.data", Pnts.size, SHARED);
   var pnts = mmf.getRef(Pnts);

   var dth = Math.PI/100;
   for (var i=0; i<=100; i++) {
     pnts[i].x = Math.cos(dth*i);
     pnts[i].y = Math.sin(dth*i);
   }

   mmf.close();


  -----------------------------------------
  // 上記のバイナリーデータファイルを読み込む(上記と違うプロセスまたはスレッドでプログラムを走らせる)
  var {SHARED} = MemMapFile;

  var {Pnts} = DSL.c(`
    typedef struct Point {
       double x, y;
    } Point;
    typedef Point Pnts[101];
  `);

  var mmf = new MemMapFile("pnts.data", 0, SHARED);
  var pnts = mmf.getRef(Pnts);

  print(`pnts[45]=(${pnts[45].x}, ${pnts[45].y})`);
  //pnts[45]=(0.1564344650402307, 0.9876883405951378)

  mmf.close();
      

resize クラス関数 MemMapFile...

MemMapFile.resize(filename, size[, mode])

SharedMemクラス ...

SharedMemオブジェクトは、プロセスWorker間で共有可能なメモリを管理するオブジェクトです。
これを使用して、２つ以上のプロセスWorkerが同じメモリをアクセスし目的の処理を効率よくおこなえます。

SharedMem クラスを使う前に、require関数でロードする必要があります。

    var {SharedMem} = require('MemMap');
  

length, byteLength プロパティ SharedMem...

sharedmem.length : Integer
sharedmem.byteLength : Integer

name プロパティ SharedMem...

sharedmem.name : String

SharedMem コンストラクター SharedMem...

① new SharedMem( name, size ) : SharedMem
② new SharedMem( name ) : SharedMem
③ new SharedMem( size ) : SharedMem

共有メモリ名

バイト数

//==単純な例==
var {SharedMem} = require('MemMap');

var smA = new SharedMem("SimpleSample", 100);
var aryA = smA.getRef();

for (var i=0; i<100; i++) aryA[i] = 2*i;

print(aryA[99]); //198

//==複雑な例==
var {Point} =
#.dl{
typedef struct Point {
  double x, y;
} Point;
}#

var AryPnt = Point.array(100);
var smB = new SharedMem("ComplexSample", AryPnt.size);
var pnts = smB.getRef(AryPnt);

var {cos, sin} = Math;
var R = 100, dth = 2*Math.PI/100;
for (var i=0; i<100; i++) {
  pnts[i].x = R * cos(dth*i);
  pnts[i].y = R * sin(dth*i);
}

print(pnts[33]);  // Point(-48.175367410171546, 87.63066800438635)
    

mapView 関数 SharedMem...

① sharedmem.mapView() : MapView
② sharedmem.mapView( size ) : MapView
② sharedmem.mapView( offset, size ) : MapView

共有メモリの窓サイズ

共有メモリの窓オフセット

共有メモリをアクセスするMapViewオブジェクトを返します。

//==巨大メモリアクセス==
var {SharedMem} = require('MemMap');

var BigArray = ctypes.double.array(1000000);
var sm = new SharedMem("Big Array", BigArray.size);

//500000番目から1000要素に値を代入
var mv = sm.mapView(ctypes.double.size*500000, ctypes.double.size*1000);
var a = mv.getRef(ctypes.double.array(1000));

for (var i=0; i<1000; i++) a[i] = Math.PI * Math.random();
    

close 関数 SharedMem...

sharedmem.close()

getRef 関数 SharedMem...

① sharedmem.getRef([offset]) : uint8_t C配列
② sharedmem.getRef( [offset,]　ctype ) : ctype

Cタイプ

先頭からのオフセット(バイト数)

var mapview = sharedmem.mapView();
var cobj = mapview.getRef(ctype);  // var cobj = mapview.getRef();
//cobはsharedmem.getRef(ctype)の返値と同じ
      

      ==単純な例==,   ==複雑な例==
    

getPtr 関数 SharedMem...

① sharedmem.getPtr([offset]) : uint8_t.ptr C配列
② sharedmem.getPtr([offset,]　ctype ) : ctype.ptr

Cタイプ

先頭からのオフセット(バイト数)

var mapview = sharedmem.mapView();
var cptr = mapview.getPtr(ctype);  // var cptr = mapview.getPtr();
//cptrはsharedmem.getPtr(ctype)の返値と同じ
      

MapViewクラス ...

MapViewオブジェクトは、共有メモリをアクセスするためのオブジェクトです。窓を通して共有メモリをアクセスするイメージです。
特に巨大な共有メモリをアクセスする場合、手ごろなサイズの窓を通してデータを扱えばシステムの負担を軽減します。

MapView クラスを使う前に、require関数でロードする必要があります。

      var {MapView} = require('MemMap');
  

length, byteLength プロパティ MapView...

mapview.length : Integer
mapview.byteLength : Integer

offset プロパティ MapView...

mapview.offset : Integer

getRef 関数 MapView...

① mapview.getRef([offset]) : uint8_t C配列
② mapview.getRef([offset,]　ctype ) : ctype

Cタイプ

先頭からのオフセット(バイト数)

//==巨大メモリアクセス==
var {SharedMem} = require('MemMap');

var BigArray = ctypes.double.array(1000000);
var sm = new SharedMem("Big Array", BigArray.size);

//500000番目から1000要素に値を代入
var mv = sm.mapView(ctypes.double.size*500000, ctypes.double.size*1000);
var a = mv.getRef(ctypes.double.array(1000));

for (var i=0; i<1000; i++) a[i] = Math.PI * Math.random();
    

getPtr 関数 MapView...

① mapview.getPtr([offset]) : uint8_t.ptr
② mapview.getPtr([offset,]　ctype ) : ctype.ptr

Cタイプ

先頭からのオフセット(バイト数)

//==巨大メモリアクセス==
var {SharedMem} = require('MemMap');

var BigArray = ctypes.double.array(1000000);
var sm = new SharedMem("Big Array", BigArray.size);

//500000番目から1000要素に値を代入
var mv = sm.mapView(ctypes.double.size*500000, ctypes.double.size*1000);
var aptr = mv.getPtr(ctypes.double.array(1000));

for (var i=0; i<1000; i++) aptr.contents[i] = Math.PI * Math.random();
    

get_address 関数 MapView...

mapview.get_address() : Array

close 関数 MapView...

mapview.close()

PTreeクラス ...

PTreeは、ツリー構造の汎用プロパティ管理のためのクラスで、JSON, XML, INI, INFOデータフォーマットへの統一的なアクセス方法を提供します。
このクラスを使うには、次のプログラムのように最初に「property_tree」ライブラリをrequire関数でロードします。

var {PTree} = require('property_tree');
var  xml = PTree.parseXML("<point><x>100</x><y>200</y></point>");
print(xml.get("point.x"));   //100

PTreeが扱うデータフォーマットのサンプルを以下に列挙します。

[1] JSON

{
   "Data": 
   {
      "value": 3,
      "str": "Hello",
      "info": 
      [
         {"id": 1, "name": "Alice"},
         {"id": 2, "name": "Millia"}
      ]
   }
}

[2] XML

<?xml version="1.0" encoding="utf-8"?>

<root>
    <str>Hello</str>
    <values>
        <value>1</value>
        <value>2</value>
        <value>3</value>
    </values>
</root>

[3] INI

[Data]
value = 3
str = Hello

[4] INFO

Data
{
　 value 3
   str   Hello
   info
   {
       ""
       {
           id    1
           name  Alice
       }
       ""
      {
           id    2
           name  Millia
      }
   }
}

XML 定数 PTree...

NO_CONCAT_TEXT	:	text値を１つの文字列に連結せず、<xmltext>キーのプロパティにします。
NO_COMMENTS	:	コメント <!-- comment --> 部分をスキップします。
TRIM_WHITESPACE	:	contentsの前後の空白を除いてパースします。

parseXML クラス関数 PTree...

PTree.parseXML(filename, flags=TRIM_WHITESPACE) : PTree
PTree.parseXML(datastr, flags=TRIM_WHITESPACE) : PTree

var text = `
<!--comment-->
<person id="3">
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );
print(pt.get("person.name")); // Ichiro Tanaka
print(pt.get("person.<xmlattr>.id")); // 3
print(pt.get("<xmlcomment>")); // comment

parseJSON クラス関数 PTree...

PTree.parseJSON(filename) : PTree
PTree.parseJSON(datastr) : PTree

var text = `
{
  "Data": 
  {
    "value": 3,
    "str": "Hello",
    "info": 
    [
      {"id": 1, "name": "Alice"},
      {"id": 2, "name": "Millia"}
    ]
  }
}
`;

var pt = PTree.parseJSON( text );
print(pt.get("Data.value")); // 3

var info = pt.get_("Data.info");
for (var i=0; i<2; i++) {
  var e = info.nth(i);
  print(e.get("id"), e.get("name"));
}
/*
1, Alice
2, Millia
*/

parseINI クラス関数 PTree...

PTree.parseINI(filename) : PTree
PTree.parseINI(datastr) : PTree

var text = `
[Data]
value=3
str=Hello
`;

var pt = PTree.parseINI( text );
print(pt.get("Data.value")); // 3
print(pt.get("Data.str"));   // Hello

parseINFO クラス関数 PTree...

PTree.parseINFO(filename) : PTree
PTree.parseINFO(datastr) : PTree

var {PTree} = require('property_tree');
var text = `
Data
{
  value 3
  str Hello
  info
  {
    ""
    {
      id 1
      name Alice
    }
    ""
    {
		  id 2
		  name Millia
    }
  }
}
`;

var pt = PTree.parseINFO( text );
print(pt.get("Data.value")); // 3

var info = pt.get_("Data.info");
for (var i=0; i<2; i++) {
  var e = info.nth(i);
  print(e.get("id"), e.get("name"));
}
/*
1, Alice
2, Millia
*/

read_xml クラス関数 PTree...

PTree.read_xml(filename, pt, flags=TRIM_WHITESPACE)
PTree.read_xml(datastr, pt, flags=TRIM_WHITESPACE)

write_xml クラス関数 PTree...

PTree.write_xml(filename, pt, setting=undefined)

var pt = new PTree();
pt.put("<xmlcomment>", "comment");
pt.put("person.name", "Ichiro Tanaka");
pt.put("person.age", 20);
pt.put("person.<xmlattr>.id", 3);

PTree.write_xml("d:/work/test.xml", pt);
/* d:/work/test.xml
<?xml version="1.0" encoding="utf-8"?>
<!--comment-->
<person id="3">
 <name>Ichiro Tanaka
 <age>20
</person>
*/

read_json クラス関数 PTree...

PTree.read_json(filename, pt)
PTree.read_json(datastr, pt)

write_json クラス関数 PTree...

PTree.write_json(filename, pt, pretty=true)

var pt = new PTree();
var elm = new PTree();

pt.put("Data.value", 3);
pt.put("Data.str", "Hello");

elm.put("id",1);
elm.put("name","Alice");
pt.add_("Data.info.", elm);

elm.put("id",2);
elm.put("name","Millia");
pt.add_("Data.info.", elm);

PTree.write_json("d:/work/test.json",pt);
/* d:/work/test.json
{
   "Data": {
      "value": "3",
      "str": "Hello",
      "info": [
         {
            "id": "1",
            "name": "Alice"
         },
         {
            "id": "2",
            "name": "Millia"
         }
      ]
   }
}
*/

read_ini クラス関数 PTree...

PTree.read_ini(filename, pt)
PTree.read_ini(datastr, pt)

write_ini クラス関数 PTree...

PTree.write_ini(filename, pt)

var pt = new PTree();
pt.put("Data.value", 3);
pt.put("Data.str", "Hello");

PTree.write_ini("d:/work/test.ini", pt);
/* d:/work/test.ini
[Data]
value=3
str=Hello
*/

read_info クラス関数 PTree...

PTree.read_info(filename, pt)
PTree.read_info(datastr, pt)

write_info クラス関数 PTree...

PTree.write_info(filename, pt)
PTree.write_info(filename, pt, settings)

var pt = new PTree();
var elm = new PTree();

pt.put("Data.value", 3);
pt.put("Data.str", "Hello");

elm.put("id",1);
elm.put("name","Alice");
pt.add_("Data.info.", elm);

elm.put("id",2);
elm.put("name","Millia");
pt.add_("Data.info.", elm);

PTree.write_info("d:/work/test.info",pt, {ch:' ', indent:2});
/* d:/work/test.info
Data
{
  value 3
  str Hello
  info
  {
    ""
    {
      id 1
      name Alice
    }
    ""
    {
      id 2
      name Millia
    }
  }
}

modifyMatchdata クラス関数 PTree...

PTree.modifyMatchdata( findstr ) : Regexp

var r = PTree.modifyMatchdata("a*"); // r==/^a\w*$/

PTree コンストラクター PTree...

new PTree() : PTree
new PTree( ptree ) : PTree

var text = `
<person id="3">
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );

var qt = new PTree(pt);
print(qt.toXMLString());
/*
<person id="3">
 <name>Ichiro Tanaka</name>
 <age>20</age>
</person>
*/

pt.put("person.name", "Taro Yamada");

print(pt.get("person.name"));	// Taro Yamada
print(qt.get("person.name"));	// Ichiro Tanaka

size 関数 PTree...

ptree.size() : Integer

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );

print(pt.size()); // 1
print(pt.get_("person").size());  // 2

//-----------------------------------------
var text = `
<person id="3">
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );

print(pt.size()); // 1
print(pt.get_("person").size());  // 3

empty 関数 PTree...

ptree.empty() : Boolean

var pt = new PTree();

print( pt.empty() );  // true
print( pt.size() );   // 0

equal 関数 PTree...

ptree.equal( pt ) : Boolean

var text = `
<person id="3">
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );

var qt = new PTree(pt);

print( pt.equal(qt) );			// true
print( pt.not_equal(qt) );	// false

pt.put("person.name", "Taro Yamada");

print( pt.equal(qt) );			// false
print( pt.not_equal(qt) );	// true

not_equal 関数 PTree...

ptree.not_equal( pt ) : Boolean

count 関数 PTree...

ptree.count( key ) : Integer

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
`;

var pt = PTree.parseXML( text );
print(pt.count('a')); // 2
print(pt.count('b')); // 1
print(pt.count('c')); // 0

clear 関数 PTree...

ptree.clear( key )

erase 関数 PTree...

ptree.erase( key ) : Intger
ptree.erase( iter ) : Intger
ptree.erase( riter ) : Intger

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
<b>bb</b>
`;

var pt = PTree.parseXML( text );

pt.erase('a');
print( pt.toXMLString() );
/*
<b>b</b>
<b>bb</b>
*/

var iter = pt.begin();
iter.next()
pt.erase(iter);
print( pt.toXMLString() );
/*
<b>b</b>
*/

get_child, get_ 関数 PTree...

ptree.get_child( path ) : PTree ptree.get_( path ) : PTree

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );

var child = pt.get_("person");

print( child.toXMLString() );
/*
<name>Ichiro Tanaka</name>
<age>20</age>
*/

put_child, put_ 関数 PTree...

ptree.put_child( path, pt ) : PTree ptree.put_( path, pt ) : PTree

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var text2 = `
<name>Tarou Yamada</name>
<age>30</age>
<family>5</family>
`;

var pt = PTree.parseXML( text );
var pt2 = PTree.parseXML( text2 );

pt.put_("person", pt2);

print( pt.toXMLString() );
/*
<person>
 <name>Tarou Yamada</name>
 <age>30</age>
 <family>5</family>
</person>
*/

add_child, add_ 関数 PTree...

ptree.add_child( path, pt ) : PTree ptree.add_( path, pt ) : PTree

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var text2 = `
<name>Tarou Yamada</name>
<age>30</age>
<family>5</family>
`;

var pt = PTree.parseXML( text );
var pt2 = PTree.parseXML( text2 );

pt.add_("person", pt2);

print( pt.toXMLString() );
/*
<person>
 <name>Tarou Yamada</name>
 <age>30</age>
 <family>5</family>
</person>
<person>
 <name>Tarou Yamada</name>
 <age>30</age>
 <family>5</family>
</person>
*/

get_value 関数 PTree...

ptree.get_value() : String

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );
var child = pt.get_("person.name");

print(child.get_value());   // Ichiro Tanaka
print(pt.get(person.name"); // Ichiro Tanaka

PTree...

ptree.put_value( value )

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );
var child = pt.get_("person.name");

child.put_value("Taro Yamada");
print(pt.get("person.name"));     // Taro Yamada

pt.put("person.name", "Jiro Yamada");
print(pt.get("person.name"));     // Jiro Yamada

get 関数 PTree...

ptree.get( path ) : String

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );
print(pt.get(person.name"); // Ichiro Tanaka

put 関数 PTree...

ptree.put( path, value ) : String

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );
pt.put("person.name", "Taro Ymada");
pt.put("person.family", 3);

print(pt.toXMLString());
/*
<person>
 <name>Taro Ymada</name>
 <age>20</age>
 <family>3</family>
</person>
*/

add 関数 PTree...

ptree.add( path, value ) : String

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML( text );
pt.add("person.name", "Taro Ymada");
pt.add("person.family", 3);

print(pt.toXMLString());
/*
<person>
 <name>Ichiro Tanaka</name>
 <age>20</age>
 <name>Taro Ymada</name>
 <family>3</family>
</person>
*/

begin 関数 PTree...

ptree.begin() : __IterPTree__
ptree.begin( key ) : __IterPTree__

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
`;

var pt = PTree.parseXML( text );

for (var iter=pt.begin(); !iter.isEnd(); iter.next()) {
  var e = iter.contents();
  print("key=" + e[1] + " value=" + e[0].get());
}
/*
key=a value=a
key=a value=aa
key=b value=b
*/

for (var iter=pt.begin("b"); !iter.isEnd(); iter.next()) {
  var e = iter.contents();
  print("key=" + e[1] + " value=" + e[0].get());
}
/*
key=b value=b
*/

rbegin 関数 PTree...

ptree.rbegin() : __RIterPTree__
ptree.rbegin( key ) : __RIterPTree__

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
`;

var pt = PTree.parseXML( text );

for (var iter=pt.rbegin(); !iter.isEnd(); iter.next()) {
  var e = iter.contents();
  print("key=" + e[1] + " value=" + e[0].get());
}
/*
key=b value=b
key=a value=aa
key=a value=a
*/

for (var iter=pt.rbegin("b"); !iter.isEnd(); iter.next()) {
  var e = iter.contents();
  print("key=" + e[1] + " value=" + e[0].get());
}
/*
key=b value=b
*/

parent 関数 PTree...

ptree.parent() : PTree

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML(text);

print(pt.parent()==null); // true

var child = pt.get_("person.name");
print(child.parent().toXMLString());
/*
<name>Ichiro Tanaka</name>
<age>20</age>
*/

exists 関数 PTree...

ptree.exists( key ) : Boolean

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML(text);

print(pt.exists("person"));	// true
print(pt.exists("person.name"));	// false

exists_ 関数 PTree...

ptree.exists_( key ) : Integer

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML(text);

print(pt.exists_("name"));	// 2
print(pt.exists("name"));	// false

toXMLString 関数 PTree...

ptree.toXMLString( settings=null ) : String

var pt = new PTree();
pt.put("<xmlcomment>", "comment");
pt.put("person.name", "Ichiro Tanaka");
pt.put("person.age", 20);
pt.put("person.<xmlattr>.id", 3);

print( pt.toXMLString() );
/*
<!--comment-->
<person id="3">
 <name>Ichiro Tanaka
 <age>20
</person>
*/

toJSONString 関数 PTree...

ptree.toJSONString( pretty=true ) : String

var pt = new PTree();
var elm = new PTree();

pt.put("Data.value", 3);
pt.put("Data.str", "Hello");

elm.put("id",1);
elm.put("name","Alice");
pt.add_("Data.info.", elm);

elm.put("id",2);
elm.put("name","Millia");
pt.add_("Data.info.", elm);

print( pt.toJSONString() );
/*
{
   "Data": {
      "value": "3",
      "str": "Hello",
      "info": [
         {
            "id": "1",
            "name": "Alice"
         },
         {
            "id": "2",
            "name": "Millia"
         }
      ]
   }
}
*/

toINIString 関数 PTree...

ptree.toINIString() : String

var pt = new PTree();
pt.put("Data.value", 3);
pt.put("Data.str", "Hello");

print( pt.toINIString() );
/*
[Data]
value=3
str=Hello
*/

toINFOString 関数 PTree...

ptree.toINFOString( settings=null ) : String

var pt = new PTree();
var elm = new PTree();

pt.put("Data.value", 3);
pt.put("Data.str", "Hello");

elm.put("id",1);
elm.put("name","Alice");
pt.add_("Data.info.", elm);

elm.put("id",2);
elm.put("name","Millia");
pt.add_("Data.info.", elm);

print( pt.toINFOString() );
/*
Data
{
  value 3
  str Hello
  info
  {
    ""
    {
      id 1
      name Alice
    }
    ""
    {
      id 2
      name Millia
    }
  }
}

forEach 関数 PTree...

ptree.forEach( func, tisObj={} )
ptree.forEach( match, func, tisObj={} )

function func( elm, key ) {
  // this==thisObj
  // elm : 子PTreeオブジェクト, key : キー
  // 繰返 呼出しを中断するには return true; を実行します。
}
      

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
`;

var pt = PTree.parseXML( text );

pt.forEach( function(elm, key) {
  print("key=" + key + " value=" + elm.get());
});
/*
key=a value=a
key=a value=aa
key=b value=b
*/

pt.forEach( "b", function(elm, key) {
  print("key=" + key + " value=" + elm.get());
});
/*
key=b value=b
*/

children 関数 PTree...

ptree.children( match=undefined ) : Array

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
`;

var pt = PTree.parseXML( text );

var children = pt.children("a");
for (var i=0; i<children.length; i++) {
  var contents = children[i];
  print("key=" + contents[1] + " value=" + contents[0].get());
}
/*
key=a value=a
key=a value=aa
*/

descendants, desc_関数 PTree...

ptree.descendants( match=undefined ) : Array ptree.desc_( match=undefined ) : Array

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
`;

var pt = PTree.parseXML(text);

var descendants = pt.desc_("*");
for (var i=0; i<descendants.length; i++) {
  var contents = descendants[i];
  print("key=" + contents[1] + " value=" + contents[0].get());
}
/*
key=person value=
key=name value=Ichiro Tanaka
key=age value=20
*/

first 関数 PTree...

ptree.first( match=undefined ) : PTree

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
<person>
  <name>Taro Yamada</name>
  <age>30</age>
</person>
`;

var pt = PTree.parseXML( text );

print( pt.first().toXMLString() );
/*
<name>Ichiro Tanaka</name>
<age>20</age>
*/

first_node 関数 PTree...

ptree.first_node( match=undefined ) : Array

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
<person>
  <name>Taro Yamada</name>
  <age>30</age>
</person>
`;

var pt = PTree.parseXML( text );

var first_node = pt.first_node();
print( first_node[1] );	// person
print( first_node[0].toXMLString() );
/*
<name>Ichiro Tanaka</name>
<age>20</age>
*/

last 関数 PTree...

ptree.last( match=undefined ) : PTree

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
<person>
  <name>Taro Yamada</name>
  <age>30</age>
</person>
`;

var pt = PTree.parseXML( text );

print( pt.last().toXMLString() );
/*
<name>Taro Yamada</name>
<age>30</age>
*/

last_node 関数 PTree...

ptree.last_node( match=undefined ) : Array

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
<person>
  <name>Taro Yamada</name>
  <age>30</age>
</person>
`;

var pt = PTree.parseXML( text );

var last_node = pt.first_node();
print( last_node[1] );	// person
print( last_node[0].toXMLString() );
/*
<name>Taro Yamada</name>
<age>30</age>
*/

nth 関数 PTree...

ptree.nth(index, match=undefined ) : PTree

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
<person>
  <name>Hiroshi Sato</name>
  <age>25</age>
</person>
<person>
  <name>Taro Yamada</name>
  <age>30</age>
</person>
`;

var pt = PTree.parseXML( text );

print( pt.nth(1).toXMLString() );
/*
<name>Hiroshi Sato</name>
<age>25</age>
*/

nth_node 関数 PTree...

ptree.nth_node(index, match=undefined ) : Array

var text = `
<person>
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
<person>
  <name>Hiroshi Sato</name>
  <age>25</age>
</person>
<person>
  <name>Taro Yamada</name>
  <age>30</age>
</person>
`;

var pt = PTree.parseXML( text );

var nth_node = pt.nth_node(1);

print( nth_node[1] ); // person

print( nth_node[0].toXMLString() );
/*
<name>Hiroshi Sato</name>
<age>25</age>
*/

__IterPTree__クラス ...

__IterPTree__オブジェクトは、PTreeオブジェクトの要素を順次取り出すための反復子オブジェクトです。
PTreeオブジェクトのメンバーbegin関数が返す値です。
次の例のようにして要素を順次取り出します。

var {PTree} = require('property_tree');

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
`;

var pt = PTree.parseXML( text );

for (var iter=pt.begin(); !iter.isEnd(); iter.next()) {
  var e = iter.contents();
  print("key=" + e[1] + " value=" + e[0].get());
}
/*
key=a value=a
key=a value=aa
key=b value=b
*/

for (var iter=pt.begin("b"); !iter.isEnd(); iter.next()) {
  var e = iter.contents();
  print("key=" + e[1] + " value=" + e[0].get());
}
/*
key=b value=b
*/

begin 関数 PTree...

iterPtree.begin()

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
`;

var pt = PTree.parseXML( text );

var iter=pt.begin();
iter.next();

var e = iter.contents();
print("key=" + e[1] + " value=" + e[0].get());
/*
key=a value=aa
*/

iter.begin(); // 反復子の指す位置を先頭に巻き戻す。
e = iter.contents();
print("key=" + e[1] + " value=" + e[0].get());
/*
key=a value=a
*/

next 関数 PTree...

iterPtree.next()

isEnd 関数 PTree...

iterPtree.isEnd() : Boolean

isSafe 関数 PTree...

iterPtree.isSafe() : Boolean

contents 関数 PTree...

iterPtree.contennts() : Array

__RIterPTree__クラス ...

__RIterPTree__オブジェクトは、PTreeオブジェクトの要素を逆順に取り出すための反復子オブジェクトです。
PTreeオブジェクトのメンバーrbegin関数が返す値です。
次の例のようにして要素を逆順に取り出します。

var {PTree} = require('property_tree');

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
`;

var pt = PTree.parseXML( text );

for (var riter=pt.rbegin(); !riter.isEnd(); riter.next()) {
  var e = riter.contents();
  print("key=" + e[1] + " value=" + e[0].get());
}
/*
key=b value=b
key=a value=aa
key=a value=a
*/

for (var riter=pt.rbegin("b"); !riter.isEnd(); iter.next()) {
  var e = riter.contents();
  print("key=" + e[1] + " value=" + e[0].get());
}
/*
key=b value=b
*/

rbegin 関数 PTree...

riterPtree.rbegin()

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
`;

var pt = PTree.parseXML( text );

var riter=pt.rbegin();
riter.next();

var e = riter.contents();
print("key=" + e[1] + " value=" + e[0].get());
/*
key=a value=aa
*/

riter.rbegin(); // 反復子の指す位置を最後尾に巻き戻す。
e = riter.contents();
print("key=" + e[1] + " value=" + e[0].get());
/*
key=b value=b
*/

next 関数 PTree...

riterPtree.next()

isEnd 関数 PTree...

riterPtree.isEnd() : Boolean

isSafe 関数 PTree...

riterPtree.isSafe() : Boolean

contents 関数 PTree...

riterPtree.contennts() : Array

XMLクラス ...

XMLオブジェクトは、PTreeオブジェクトを使ってE4Xに近いXML操作を可能にするオブジェクトです。

var {XML} = require('xml');

var text = `
<person id="3">
  <name>Ichiro Tanaka</name>
  <age>20</age>
</person>
<person id='4'>
 <name>Taro Yamada</name>
 <age>30</age>
</person>
`;

var xml = XML(text);

for (var riter=pt.rbegin(); !riter.isEnd(); riter.next()) {
  var e = riter.contents();
  print("key=" + e[1] + " value=" + e[0].get());
}
/*
key=b value=b
key=a value=aa
key=a value=a
*/

for (var riter=pt.rbegin("b"); !riter.isEnd(); iter.next()) {
  var e = riter.contents();
  print("key=" + e[1] + " value=" + e[0].get());
}
/*
key=b value=b
*/

rbegin 関数 PTree...

riterPtree.rbegin()

var text = `
<a>a</a>
<a>aa</a>
<b>b</b>
`;

var pt = PTree.parseXML( text );

var riter=pt.rbegin();
riter.next();

var e = riter.contents();
print("key=" + e[1] + " value=" + e[0].get());
/*
key=a value=aa
*/

riter.rbegin(); // 反復子の指す位置を最後尾に巻き戻す。
e = riter.contents();
print("key=" + e[1] + " value=" + e[0].get());
/*
key=b value=b
*/