「Mery.iniのオプション値を取得」を編集中 (節単位)

== GetIniOption3() 関数 ==
[[#GetIniOption2() 関数|GetIniOption2() 関数]] とおなじく、Mery.ini ファイル内の各項目 <br>
 '''[SectionName]'''
 '''KeyName1'''='''value1'''
 '''KeyName2'''='''value2'''
の「段落名・セクション <code>[SectionName]</code>」と「項目名・キー <code>KeyName</code>」の文字列を指定して「値 <code>value</code>」を取得するための '''組み込み用関数''' です。<br> <span style="color:#0000c0;">ことなるセクションに同じキー名の項目が重複して存在することを考慮してありますので、<u>Mery.ini のすべての項目の参照が可能です</u>。</span>

* GetIniOption2() 関数では戻り値も '''入れ子状の配列''' だったため、任意のキーの「値」を参照するには <syntaxhighlight lang="javascript">
var iniOption = GetIniOption2([[section1, key1], [section2, key2]]);

// 配列の index をふたつずつ指定して「値」を参照
var value1 = iniOption[0][2];
var value2 = iniOption[1][2];
</syntaxhighlight> のように記述しなければならず、コードの可読性にやや難ありでした。

 GetIniOption3() 関数では戻り値を '''オブジェクト型（連想配列）''' にしてあります。
 {section1 : {key1 : value1}, section2 : {key2 : value2} ... }
 
 ⇒　　 ''value1 = objOptions[section1][key1]''
 または ''value2 = objOptions.section2.key2''
: <span style="color:#0000c0;">セクション名とキー名がそのままプロパティ名になる</span>ので、INI から取得する「値」が複数のときに任意の「値」の参照がしやすくなるかとおもいます。<syntaxhighlight lang="javascript">
var keyArray = [["General", "LineColumnView"], ["View", "FontName0"]];
var iniOption = GetIniOption3(keyArray);

// プロパティをセクション名とキー名の文字列で記述して「値」を参照
var value1 = iniOption.General.LineColumnView;	// ドット記法
var value2 = iniOption["View"]["FontName0"];	// ブラケット記法
</syntaxhighlight>

* 戻り値の「値」の部分 <code>value</code> は '''文字列型'''（String）です。
: ※ GetIniOption2() 関数ではセクション名やキー名の指定が正しくなかったときに記述ミスした項目名を <span style="color:#c00;"><syntaxhighlight lang="javascript" inline>undefined</syntaxhighlight></span> にして「値」を <span style="color:#c00;"><syntaxhighlight lang="javascript" inline>null</syntaxhighlight></span> で返しましたが、<span style="color:#c00;">GetIniOption3() 関数では間違えたままの項目名の「プロパティ」に '''<syntaxhighlight lang="javascript" inline>undefined</syntaxhighlight>''' を「値」としてあたえて返します。</span><br> ''e.g.''　<syntaxhighlight lang="javascript" inline>objOptions.General.HOGE = undefined</syntaxhighlight>

* GetIniOption() 関数と GetIniOption2() 関数ではセクション名やキー名の指定が正しくなかったとき、つねに警告ダイアログを表示させる仕様にしてありましたが、GetIniOption3() 関数では第2引数（Bool）に <syntaxhighlight lang="javascript" inline>true</syntaxhighlight> をあたえなかった場合は警告なしで処理を続行します。

<div class="warningbox">
<span style="color:#c00;">※ セクション名に「'''<code>\</code>'''(バックスラッシュ、¥ マーク)」をふくむ項目を指定したときは、戻り値のプロパティ名は '''ブラケット記法''' で記述してください。</span><br>
: ''e.g.'' <syntaxhighlight lang="javascript" inline>[ ["Macros\\Macro0", "FileName"], ["Mode\\Text", "Count"] ]</syntaxhighlight><br>⇒　<syntaxhighlight lang="javascript" inline>objOptions["Macros\\Macro0"]["FileName"]</syntaxhighlight><br>　　<syntaxhighlight lang="javascript" inline>objOptions["Mode\\Text"]["Count"]</syntaxhighlight>
</div>

* [[#関数3|組み込み関数本体]] を任意のマクロのソースコード内にペーストして使用します。
: 使い方は [[#使い方_3|使用例]] を参考にしてください。

* <b style="color:#c00;">このマクロ関数は Mery.ini の内容を編集（書き換え）するものではありません。 </b>

=== ソースコード ===
 // #title="Mery.ini のオプション値を取得"
 
 /**
  * 組み込み関数 '''GetIniOption3( keyArray, boolAlertEnable )'''
  * 
  * 引数で指定した '''任意の''' INI オプション項目名と「値」をプロパティ値として持つ
  * '''''入れ子型のオブジェクト''''' を返す
  * 
  * '''第1引数:''' INI オプション項目（セクション名とキー名）を指定する入れ子型の配列
  * ※ 配列の記述形式は '''''[ [ section1, key2 ], [ section2, key2 ] ... ]''''' （※入れ子にする）
  * 
  * '''第2引数:''' INI オプション項目（セクション名とキー名）の指定ミスがあったときに
  *          警告ダイアログを表示する／しない を <syntaxhighlight lang="javascript" inline>true</syntaxhighlight> か <syntaxhighlight lang="javascript" inline>false</syntaxhighlight> で指定する（省略可）
  * 
  * '''戻り値:''' INI オプション項目の「値」を String 型のプロパティ値として持つ '''''オブジェクト'''''
  * ※ 戻り値の形式は '''''{ section1: { key1: value1 }, section2: { key2: value2 } ... }'''''
  * ⇒ '''''<syntaxhighlight lang="javascript" inline>objOptions[ section ][ key ] = value</syntaxhighlight>'''''
  * 
  * ※ 有効な value はすべて '''文字列型''' （String）で返す
  *  （数字の場合も '''<syntaxhighlight lang="javascript" inline>"1"</syntaxhighlight>''' として返す    <span style="color:#c00;">"1" !== 1</span> ）
  * ※ 無効な section, key が指定されたものにたいしては ''<syntaxhighlight lang="javascript" inline>value = undefined</syntaxhighlight>'' で返す
  * 
  * ※ 各「値」への参照方法は
  *   <syntaxhighlight lang="javascript" inline>var iniOptions = GetIniOption3( keyArray );</syntaxhighlight>
  *   <syntaxhighlight lang="javascript" inline>var value1 = iniOptions[ "section1" ][ "key1" ];	// ブラケット記法</syntaxhighlight>
  *   <syntaxhighlight lang="javascript" inline>var value2 = iniOptions.section2.key2;		// ドット記法</syntaxhighlight>
  */
<div id="関数3"></div>
<syntaxhighlight lang="javascript">
// ---------- ▼ 組み込み関数 ココから ▼ ----------

function GetIniOption3( keyArray, alertEnable ) {
  var Fso = new ActiveXObject( "Scripting.FileSystemObject" );
  // Mery.ini を探す
  var iniPath = editor.FullName.replace( /\.exe$/i, ".ini" );
  if ( ! Fso.FileExists( iniPath ) ) {
    var iniName = /\\([^\\]+)\.exe$/.exec( editor.FullName )[1];
    var WshShell = new ActiveXObject( "WScript.Shell" );
    iniPath = WshShell.SpecialFolders( "APPDATA" )
            + "\\Mery\\" + iniName + ".ini";
  }
  // Mery.ini を読みこむ
  var Adodb = new ActiveXObject( "ADODB.Stream" );
  var adTypeText = 2,  adReadAll = -1;
  Adodb.Type = adTypeText, Adodb.Charset = "UTF-8";
  Adodb.Open();
  Adodb.LoadFromFile( iniPath );
  var iniText = Adodb.ReadText( adReadAll );
  Adodb.Close();

  // 引数の配列をループ処理して ini からオプションの値を取得する
  var options = {};
  var section, key, value, reg, id1, id2, id3, id4;
  var iniLength = iniText.length;
  for ( var i = 0, len = keyArray.length; i < len; id1 = 0, i ++ ) {
    section = keyArray[i][0];
    key     = keyArray[i][1];
    options[ section ] = options[ section ] || {};
    // セクション名を検索
    reg = new RegExp( "^\\[" + section.replace( /\W/g, "\\$&" ) + "\\]$", "m" );
    id1 = iniText.search( reg );					// セクションの開始位置
    if ( id1 != -1 ) {								// セクション名が正しいか？
      id2 = iniText.indexOf( "\r\n[", id1 + 1 );	// 次のセクションの開始位置
      id2 = ( id2 > id1 ) ? id2 : iniLength;
      // キー名を検索
      id3 = iniText.indexOf( "\n" + key + "=", id1 );	// キーの開始位置
      if ( id3 != -1 && id2 > id3 ) {				// セクション内にキーがあるか？
        id4 = iniText.indexOf( "\r\n", id3 );		// 検索項目の行末位置
        value = iniText.slice( id3 + key.length + 2, id4 );	// ("\n"+"=").length = 2
        options[ section ][ key ] = value;
      }
      else {	// キー名の指定ミス
        options[ section ][ key ] = undefined;
        if ( alertEnable ) {
          Alert( "\"" + key + "\" key is NOT found in [" + section + "] section.\n\n"
               + "The function will return ... \n"
               + "{ \"" + section + "\" : { \"" + key + "\" : undefined } }" );
        }
      }
    }
    else {		// セクション名の指定ミス
      options[ section ][ key ] = undefined;
      if ( alertEnable ) {
        Alert( "[" + section + "] section is NOT found in \"Mery.ini\" file.\n\n"
             + "The function will return ... \n"
             + "{ \"" + section + "\" : { \"" + key + "\" : undefined } }" );
      }
    }
  }
  return options;
}

// ---------- ▲ 組み込み関数 ココまで ▲ ----------
</syntaxhighlight>

=== 使い方 ===
 /**
  * 【使い方】
  *
  * GetIniOption3() 関数の使用は１回で済ませないと
  * その都度 '''INI ファイルの読み込み''' が発生してマクロの処理速度が落ちるので
  * 取得したい項目すべてをひとつの配列にまとめること
  *
  * ※ 要求する項目が１セットの場合も配列を '''入れ子''' にすること
  *   '''''<code>GetIniOption3( [ [ "SectionName", "KeyName" ] ] );</code>'''''
  *
  * ※ INI のオプション項目名の記述を間違えても警告ダイアログを表示して続行する
  *    記述ミスをした項目の値 ''value ''は '''''<syntaxhighlight lang="javascript" inline>undefined</syntaxhighlight>''''' で返される
  * ※ INI 内でオプションの値が空 ''<code>KeyName=</code>'' の場合は、空文字列 '''<syntaxhighlight lang="javascript" inline>""</syntaxhighlight>''' を返す
  *
  * ※ 値はすべて '''"文字列型"'''（String）で返されるので、
  *    必要に応じて ''<code>Number( value )</code>'' などのかたちで利用すること
  * 
  * <b style="color:#c00;">【注意】</b>
  * <span style="color:#c00;">※ セクション名にバックスラッシュ「'''<code>\</code>'''」が含まれる場合、</span>
  *    <span style="color:#c00;">戻り値のプロパティ名を指定するさいには '''ブラケット記法''' で記述すること</span>
  * 
  *  e.g. ''<syntaxhighlight lang="javascript" inline>[ "Themes\\Theme0", "Caption" ]</syntaxhighlight>''
  *   ⇒  ''<syntaxhighlight lang="javascript" inline>objOptions["Themes\\Theme0"]["Caption"]</syntaxhighlight>''
  *  （ドット記法で ''<syntaxhighlight lang="javascript" inline>objOptions.Themes\\Theme0.Caption</syntaxhighlight>'' とすると <b style="color:#c00;">エラー</b> になる）
  */
<syntaxhighlight lang="javascript">
// ➀ セクション名とキー名をセットにした配列 [ [section1, key2], [section2, key2] ... ]
//    セクション名に「\」がある場合は、ふたつ重ね「\\」で記述すること
var keyArray = new Array(				// ▼ 戻り値 ▼
  [ "General", "LineColumnView" ], 		// 0 or 1
  [ "General", "FileFilter" ], 			// "*.txt;*ini;*.htm; …"
  [ "General", "Untitled" ], 			// 「無題」の代替値 or ""
  [ "Display", "FallbackFonts" ], 		// フォント名 or ""
  										// → （～ Ver 2.7.4 では undefined）
  [ "View", "FontName0" ], 				// フォント名（履歴） or ""
  [ "Macros\\Macro1", "FileName" ], 	// Macros\マクロ名.js or ""
  [ "Outline\\JavaScript", "Match1" ],	// 文字列値 or 正規表現 or "..."
  [ "Themes\\Theme29", "Caption" ], 	// テーマ名 or ""
  [ "Themes", "HOGE" ],				 	// [Themes] HOGE  =  null
  [ "FUGA", "PIYO" ] 					// [FUGA] PIYO = null
);

// ➁ 関数の引数に配列をあたえて、変数 iniOption に代入する
//    関数の戻り値は入れ子状のオブジェクト
//    { section1 : { key1 : value1 }, section2 : { key2 : value2 } ... }
// ※ value は文字列値（String）で返される（数字の場合も "1"  ※ "1" !== 1 ）

var iniOptions = GetIniOption3( keyArray, true );	// 戻り値は Object 型


// ➂-1.（例１）戻り値で取得した内容をアウトプットバーに出力する

OutputBar.Writeln( "\nRun > " + ScriptName + " : function GetIniOption3()" );
var section, key;
for ( var i = 0; i < keyArray.length; i ++ ) {
  section = keyArray[i][0],  key = keyArray[i][1];
  OutputBar.Writeln( "[" + section + "]\t" + key
                   + "=" + iniOptions[ section ][ key ] );	// ブラケット記法
  // セクション名に「\」をふくむ項目があるのでブラケット記法を使用
}


// ➂-2.（例２）特定の key の値を参照して変数に格納する場合

var ff = iniOptions.General.FileFilter;			// ドット記法
var fn = iniOptions[ "View" ][ "FontName0" ];	// ブラケット記法
Alert( "[General]\nFileFilter=" + ff + "\n"
     + "[View]\nFontName0=" + fn );
</syntaxhighlight>