Sukemaru

== マクロライブラリに投稿したマクロ ==

* [[対応する括弧に移動#範囲選択の拡張|｢対応する括弧に移動｣の追加コード]] (last_modified: 2019/12/02)

* [[日付と時刻を挿入#sukemaru 版|日付と時刻を挿入]] (last_modified: 2018/12/09)

* [[行を上下に移動（Mery 2.7 用）]] (uploaded: 2019/05/07)　※ ブックマーク対応

* [[貼付け実行後のカーソル位置を貼付け文字列の先頭にする#sukemaru 版|貼付け実行後のカーソル位置を貼付け文字列の先頭にする]] (added: 2018/11/14)

* [[行の先頭に貼り付け]] (uploaded: 2018/08/24)

<span id="引用符／コメント"></span>

* [[バイト数#バイト数と文字数・行数|バイト数と文字数・行数]] ※イベントマクロ (last_modified: 2018/11/18 → '''2019/12/03 削除''')

* [[ファイルのプロパティ]] (uploaded: 2018/12/18)

* [[編集モードの自動選択]] (通常版／include版) ※イベントマクロ (last_modified: 2019/04/24)　※書き換え禁止で開く

* [[特定のフォルダで「ファイルを開く」ダイアログ]] (last_modified: 2020/05/10)

* [[さいごに閉じたファイルを開く]] ※ポップアップメニュー (last_modified: 2019/11/30)

* [[強制的に上書き保存]] (uploaded: 2020/06/01)

* [[すべて戻す]] (uploaded: 2020/06/01)

* [[全角／半角変換]] (last_modified: 2019/05/11)　※「ＡＢＣ」→｢ABC｣ ／ ｢ABC｣→「ＡＢＣ」

* [[文字列の順番を逆に書き出す]] (last_modified: 2020/01/03)　※｢あいうえお｣ ⇔ ｣おえういあ｢

* [[次／前の文字列を検索・改]] (last_modified: 2020/05/12)　※複数行選択から『次／前の文字列を検索』

* 【自家用】 [[ファイルのフルパスをコピーして閉じる]] ※イベントマクロ (last_modified: 2019/04/14)

* 【実験】 [[位置情報を保存してから「次の文字列を検索」]]＋ 復帰 (include版) (uploaded: 2019/05/28)

* 【自家用】[[行の表示方法を切り替える]] (last_modified: 2019/08/24)　※論理行／表示行 トグル切り替え

* 【実験】 [[ファイルへ移動（物理座標ジャンプ）]] (uploaded: 2019/05/15 → '''2019/10/27 削除''')

* 【実験】 [[ブックマークを復元（Mery 2.7用）]] (last_modified: 2019/04/07 → '''2019/04/12 削除''')

* [[折り返しトグル切り替え#３つの折り返しモードを順々にトグルする|折り返しトグル切り替え]] (include版) (last_modified: 2020/03/15)

* [[Mery.iniのオプション値を取得]] ※組み込み用関数 (last_modified: 2020/05/14)

* [[IO.Serialize() の JSON を参照する]] ※組み込み用関数 (uploaded: 2019/04/17)

* [[アクティブなタブのマクロを実行する]] (last_modified: 2020/04/30)

* [[コンパクトメニュー]] ※ポップアップメニュー (last_modified: 2020/03/29)

* [[キーアサイン集]] (last_modified: 2018/10/19　※w/ ks氏, masme氏, 有志)  

* [[マテリアルデザインっぽいアイコンと『小マクロ集』]] (last_modified: 2020/01/04)　※アイコン収録数 '''337''' コ

== 外部サイトに投稿したマクロ ==

== 組み込み用コード・小関数 ==

メインコードの途中に短い [https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Statements/function 関数] を置く場合は、最初の呼び出しコードより前に変数（[https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Operators/function 関数式]）として定義しておいてもよい。

{

   var hoge = "hogehoge";

   }

}

ならば、以下のような記述でも同じ意味 （ただし、関数式の場合は、最初に呼び出す文よりも前に定義しておくこと）。

// 関数式は最初に呼び出されるよりも前に定義すること

var HogeFuga = function( str ) {

document.selection.Text = HogeFuga( hoge );

=== メタ記号をエスケープする ===

: ※ ref. 『[https://developer.mozilla.org/ja/docs/Web/JavaScript/Guide/Regular_Expressions#Escaping 正規表現 - JavaScript | MDN]』

/**

  * 関数 RegQuote( str )

   return str.replace( /[.*+?^=!:${}()|[\]\/\\]/g, "\\$&" );  

}

* または、記述の簡単な方法（ただし、<q>処理対象の文字列が長大</q> な場合や <q>日本語テキスト</q> の場合には適さない）。

: ※ ref. 『[https://ja.wikibooks.org/wiki/JavaScript/%E6%AD%A3%E8%A6%8F%E8%A1%A8%E7%8F%BE#RegExp JavaScript/正規表現 - Wikibooks]』

/**

  * 関数 Quote( str )

//  } );

// }

=== 数値を３ケタ区切り（カンマ区切り）にする ===

/**

  * 関数 SeparateNum( num )

   return num.toString().replace( /(\d)(?=(?:\d{3})+(?!\d))/g, "$1," );

}

小数、または半角数字を含む文字列の場合は

/**

  * 関数 SeparateNum2( num )

   return a.join( "" );

}

=== 数値を小数点以下３ケタの固定長にする ===

/**

  * 関数 NumFix( num )

// 対象が数値（ Number 型）であれば toFixed() だけでよい

// num = num.toFixed( 3 );

=== 数値をケタ埋め（ゼロ埋め）する ===

※ 引数の型に応じた関数を使用する。

/**

  * 関数 Pad( num )

   return num < 10 ? "0" + num : num;

}

/**

  * 関数 Pad2( str )

   } );

}

/**

  * 関数 NumPad2( val )

   } );

}

=== 任意の文字列のくりかえしで埋める ===

※ Windows XP 用

/**

  * 関数 Repeat( str, count )

   return ret;

}

=== ascii 文字に対応する全角英数記号を半角変換 ／ 数値専用の入力ダイアログ ===

※ IME: ON の状態で入力された「全角数字」も許容、「全角/半角の数字」以外の文字列は無視する入力ダイアログのサンプルコード

/**

  * 関数 ToHalfWidth( str )

       return String.fromCharCode( tmp.charCodeAt(0) - 0xFEE0 )

} ) };

/**

if ( ! p ) { Status = "キャンセル"; }

else      { Alert( p ); }

=== ストップウォッチ・タイマー ===

// 計測開始 ※ ソースコードの先頭付近におくこと

var start = new Date();

// ステータスバーに処理時間を表示

Status = ( ( new Date() - start ) / 1000 ).toFixed( 3 ) + " 秒";

=== Mery のバージョン情報 ===

/**

  * Mery のバージョン情報

                 + editor.Version;

Status = meryVersion;

=== JavaScript (JScript) エンジンのバージョン情報 ===

※ ref. 『[https://docs.microsoft.com/ja-jp/previous-versions/windows/scripting/cc392005%28v=msdn.10%29 ScriptEngine 関数 (JScript) | Microsoft Docs]』

/**

  * JavaScript (JScript) エンジンのバージョン情報

           + ScriptEngineBuildVersion();

Status = engine;

* [https://www.haijin-boys.com/discussions Mery 公式フォーラム]

; 外部サイト

* MSDN（Microsoft Docs）の[https://docs.microsoft.com/ja-jp/previous-versions/windows/scripting/cc392483%28v=msdn.10%29 「Microsoft Windows スクリプト テクノロジ」]

* MSDN（Microsoft Docs）の[https://docs.microsoft.com/ja-jp/previous-versions/windows/scripting/cc409859%28v%3dmsdn.10%29 「JScript ランゲージ リファレンス」]

* MSDN（Microsoft Docs）の[https://docs.microsoft.com/ja-jp/previous-versions/windows/scripting/cc364460%28v=msdn.10%29 「WSH リファレンス」]

* MSDN（Microsoft Docs）の[https://docs.microsoft.com/ja-jp/previous-versions/windows/scripting/cc427968%28v%3dmsdn.10%29 「FileSystemObject リファレンス」]

* MDN web docus（mozzila）の[https://developer.mozilla.org/ja/docs/Web/JavaScript/Guide/Regular_Expressions 「JavaScript ガイド >> 正規表現」]

* MSDN（Microsoft Docs）の[https://docs.microsoft.com/ja-jp/previous-versions/windows/scripting/cc427946%28v=msdn.10%29 「JScript 正規表現の概説」]

* onigmo（鬼雲 ／ 鬼車・改）の[https://github.com/k-takata/Onigmo/blob/master/doc/RE.ja 「正規表現 ReadMe」]

拙作マクロはポップアップメニューを利用するものが多いので、Tips はその方面の内容に偏ってしまいますが、以下、個人的に注意していることや気付いたことなど。

=== Document と Editor.ActiveDocument ===

; マクロをツールバーアイコン化する意味（？）

大前提として [[マクロライブラリ]] の [[マクロ覚え書き（開発者向け）#window.Document と Editor.ActiveDocument の違い|マクロ覚え書き（開発者向け）]] で説明されているような違いがあるが、 [[マクロリファレンス:Editor インターフェイス#ActiveDocument プロパティ|Editor.ActiveDocument]] は、マクロ開始時点でタブにフォーカスがあろうとなかろうと [[マクロリファレンス:Document インターフェイス|window.Document]] オブジェクトを取得することができる、という違いもある。

* 通常、アウトプットバーやアウトラインペイン、検索／置換ダイアログにフォーカスがあると、ショートカットキーからはマクロを起動することはできないし、起動してもマクロ開始時点での <code>Document</code> オブジェクトが <code>undefined</code> になるので <code>Document.Selection</code> のメソッドなどが使用できなくなる。

: ※ ただし、アクティブなタブ以外を操作・編集するマクロにおいては <code>Editor.Documents.Item(n)</code> などのような形式での記述が必要。

※ マクロ／プラグイン／外部ツールの登録数が多かったり <code>#icon="hoge.ico"</code> でアイコン化しているマクロが多いせいか、Mery の起動がもたつくのが悩ましい… （[[#投稿した構文ファイル|自作の編集モード]] が重いのも影響しているかも）

=== イベントマクロ ===

|ファイルを保存する前。

|}

: ※ イベントマクロ であっても、ショートカットキーなどから任意のタイミングで強制的に実行することもできる。

: ※ イベントマクロでない「マクロA」のコードでファイルを 開く または 閉じる をおこない、それ以降にも「マクロA」のコードが続いている場合は、ファイルを開いた時／閉じた時の「イベントマクロB」は発動しないことがある。

=== ポップアップメニュー ===

以下の単純なコードでアイテム 10000 件のポップアップメニューを表示させようとしても、4000 件ぐらい（4000 前後で不定）までしか表示されない…。

var m = CreatePopupMenu();

for ( var i = 1; i <= 10000; i ++ ) {

}

var r = m.Track( mePosMouse );

環境依存の不具合かもしれないが、はて…？

==== オプションフラグ ====

[[マクロリファレンス:PopupMenu インターフェイス#Add メソッド|PopupMenu.Add() メソッド]] の第三引数 '''Flags''' : int を数値化すると

meMenuChecked = 1

meMenuGrayed = 2

meMenuChecked + meMenuGrayed = 3

meMenuSeparator = 4

var menu = CreatePopupMenu();

var hoge = true;

}

var num = menu.Track( mePosMouse );

: ※ オプションフラグ　''meMenuGrayed''　を使用して条件付きで特定の項目をグレーアウトするだけでなく、<code>menu.Add( ... );</code> の行を [https://developer.mozilla.org/ja/docs/Web/JavaScript/Guide/Control_flow_and_error_handling#if...else_statement if() 文] で囲むなどすれば、状況に応じたメニュー項目だけを表示させることもできる。

==== アクセラレータ ====

そのさい、Shift キー付きでの入力が必要な記号は Shift キーなしで入力可能なキーのラベルと同一視される （e.g. 「'''&#'''」で '''<q>#</q>''' 記号をアクセラレータに指定した場合、JIS 配列のキーボードでは <kbd>3</kbd> キーがアクセラレータになる）。

* <span style="color:#0000c0;">'''<q>&</q>''' 記号でアクセラレータ化する文字の位置は限定されないが、<u>最初の '''<q>&</q>''' 記号のうしろの文字がアクセラレータになる</u></span>（ … とおもわれる ← ポップアップメニュー内で「下線つきで表示される文字」と一致しないことがある）。

* <span style="color:#c00;">全角文字はアクセラレータにできない。</span>

: ※ '''<q>&&</q>''' の記述で表示される '''<q>&</q>''' 記号は、アクセラレータにならない。

: ※「'''&<span style="background:#bfdfff;"> </span>'''」(半角アンパサンド＋半角空白) で半角スペースをアクセラレータに指定したアイテムは、<kbd>Space</kbd> キーがアクセスキーになる。

/* アクセラレータを付加する */

var ret = menu.Track( 0 );

/* 10 行ごとに「キャンセル」項目を挿入し、スペースキーでスクロール可能にする */

   document.selection.SetActivePoint( mePosLogical, 1, y );

}

==== ラベルの整形 ====

/**

  * ポップアップメニューに表示するラベルを整形する

// 文字数を切り詰めた場合は「 ...」を付加

menuKey += ( str.length > menuWidth ) ? " ..." : "";

// 文字列の先頭に行番号（連番）を付加する

var num = ( "      " + y ).slice( - numWidth ).replace( /\d$/, "&$&" );

menuKey = num + ": " + menuKey;

: ※ このコードでは色々と unicode 文字を使用しているので、マクロの JS ファイルは UTF-8 などの形式で保存しなければならない。

* また、「[[#マクロライブラリに投稿したマクロ|マクロライブラリに投稿したマクロ]]」の節の画像リンク（サムネイル）のように、タブインデントや連番のケタ埋め、サブメニューの活用などの工夫で、ポップアップメニューの体裁はある程度自分好みにカスタマイズできる。

==== ステータスバーの表示 ====

※ <code>PopupMenu.Track()</code> が発動した時点でエディタウインドウ本体は停止するので、直後に <syntaxhighlight lang="javascript" inline>Status = "hoge";</syntaxhighlight> を記述しても、ポップアップメニューの項目を選択するかメニューをキャンセルするまで表示されない。

// e.g. ポップアップメニュー表示までのマクロの処理時間をステータス表示させる

   document.selection.SetActivePoint( mePosLogical, 1, yy, false );

}

: ※ ポップアップメニューにかぎらず、[[マクロリファレンス:Window インターフェイス#Alert メソッド|警告 (Alert)]] や [[マクロリファレンス:Window インターフェイス#Confirm メソッド|確認 (Confirm)]]、 [[マクロリファレンス:Window インターフェイス#Prompt メソッド|入力 (Prompt)]] ダイアログなどモーダルなポップアップウインドウを表示させる場合も、同様に <syntaxhighlight lang="javascript" inline>Status = "hoge";</syntaxhighlight> を先に記述する必要がある。

: ※ Mery メインウインドウのメニューバー項目のような、マウスホバーで動的にステータス表示を変更させる制御はできない。

==== 配列からポップアップメニューを生成 ====

[https://developer.mozilla.org/ja/docs/Web/JavaScript/Guide/Loop_Statements/for_Statement for 文] などの [https://developer.mozilla.org/ja/docs/Web/JavaScript/Guide/Loop_Statements/ ループ処理] によって配列からポップアップメニューのアイテムを生成する場合に、[[マクロリファレンス:PopupMenu インターフェイス#Add メソッド|PopupMenu.Add() メソッド]] の第二引数 '''id''' （※通常は 1 ～ ）と配列のアイテムのインデックス '''[ i ]''' の値（※通常は 0 ～ ）を一致させたいときは、配列の先頭にダミーまたは空の要素を置いておき、ループ処理の開始インデックスを 1 にする。

var a = new Array( "" ); // 先頭に空のダミー要素を入れておく

a.push( "あああ" );

a.push( "いいい" );

var menuA = CreatePopupMenu();

   menuA.Add( a[i], i ); // Id を ( i + 1 ) にする必要がない

}

}

var numB = menuB.Track( mePosMouse );

サブメニューを多重に含むコードの場合、字下げ（インデント）を活用することで、メニューの階層構造を把握しやすくできる。

var mainMenu = CreatePopupMenu();

mainMenu.Add( "アイテム１", 1 );

var r = mainMenu.Track( 0 );

Alert( r > 0 ? mainMenu.GetText( r ) : "キャンセル" );

* 配列やオブジェクトからポップアップメニューの生成をするときにサブメニューを利用する場合、あらかじめサブメニューのラベルや各要素の振り分け方が決まっていれば難しいことはないが、<span style="color:#c00;">要素が不定数の配列やオブジェクトを複数のサブメニューに振り分けるのは簡単ではない…。</span>

: →　組み込み関数「[[ポップアップメニューを手軽に扱う]]」や「[[階層化マクロメニュー]]」マクロなどのソースコードを参考にして自力でコードを組むか、組み込み関数「[[ポップアップメニューを「n*十件ずつ」のサブメニューに自動分割する]]」で一定数ごとにサブメニュー項目を自動生成して要素を放り込むしかない。

: ※ 自動分割サブメニューのページに「[[ポップアップメニューを「n*十件ずつ」のサブメニューに自動分割する#サンプルコード２|サンプルコード２]] (簡易版)」を追加した。

* [[マクロリファレンス:PopupMenu インターフェイス#AddPopup メソッド|PopupMenu.AddPopup() メソッド]] では [[マクロリファレンス:PopupMenu インターフェイス#Add メソッド|Add() メソッド]] の第三引数（''meMenuChecked, meMenuGrayed, meMenuSeparator''）は使用できない。

: サブメニュー内のすべてのアイテムが無効（グレーアウト）になる条件でも、サブメニュー見出しを無効化することはできないので、サブメニュー見出しが表示されなくなるように（またはグレーアウトされるように） <code>PopupMenu.AddPopup()</code> 周りを [https://developer.mozilla.org/ja/docs/Web/JavaScript/Guide/Control_flow_and_error_handling#if...else_statement if() 文] で囲うしかない（※ メニューの階層構造が複雑な場合に、ソースコードが見づらくなってしまうが…）。

// e.g. 編集モードが Text ならサブメニューを表示する

// ※ Text 以外ならグレーアウトさせた "サブメニュー" アイテムを表示

var r = menu1.Track( mePosMouse );

==== マクロの動作設定を変更可能にする ====

ポップアップメニューマクロでないものは、通常、頻繁に動作設定を弄る必要はないが、sukemaru 好みの動作方式は一般的嗜好と合致しないであろうことから公開用のマクロにするにあたってカスタマイズ可能な「設定項目 (変数)」にして調整しなおすことが多い…。

<span style="color:#0000c0;"> ポップアップメニューマクロであれば、メニュー項目から動作設定をカスタマイズできるようにコーディングすることができる。</span>

* まず、[[利用者:Masme|masme]] 氏の「[[行並べ替え]]」や「[[連番を挿入]]」マクロのように、[https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Statements/do...while do ... while() 文] によるループを利用して、動作設定の既定値を何度も書き換えながらポップアップメニューを再描画する方法がある。

: <s>動作設定の変更内容はマクロの完了時に破棄されてしまうので、</s> 同じマクロを連続して利用することが多いならば、マクロメニューの [[ヘルプ:マクロ#編集|編集]] コマンドからソースコードを開いて、初期設定項目（変数）の既定値を書き換えておくとよい。

* sukemaru の場合は、「[[ポップアップメニューで検索先にジャンプ#include版|検索ジャンプ]]」「[[ブックマーク一覧ジャンプ#include版|ブックマークジャンプ]]」や「[[ファイルを読み直す・開きなおす#include版|読みなおし]]」マクロなどで、【include 版】と称するものを作っている。

: カスタマイズしながら実行するのも、カスタマイズした動作設定を維持したままでままで再実行するのも容易にはなったが、コードが煩雑になって他のマクロに流用しづらくなってしまっている…。

: ※ 非 include 版では、「設定変更」サブメニューや masme 氏のマクロのような処理コードは入れず、動作設定の変更方法はソースコードの変数の値の書き換えのみとしている。

==== GetKeyState.exe の活用 ====

※ ただし、Mery のポップアップメニューは <kbd>Alt</kbd> キーでキャンセルされてしまうので、ポップアップメニュー内のコマンド実行用に仕込めるのは <kbd>Ctrl</kbd> か <kbd>Shift</kbd> キーにかぎられる。

: ref. [[GetKeyState.exe(キー状態取得実行ファイル)#実装例|GetKeyState.exe の実装例： サンプルコード３]]

=== 配列 ===

var arr1 = [];

arr1[arr1.length] = "hoge";

arr1[arr1.length] = "piyo";

... ;

個人的な所感であるが、配列の要素を羅列して定義するさいに、上のような書き方は好きではない。以下のような書き方のほうが、スッキリしていてよい。

var arr2 = [];

arr2.push( "Hoge" );

arr2.push( "Piyo" );

... ;

var arr3 = [

   "HogeHoge",

];

// ※ カンマの位置は、前でも後ろでも

=== 複数行の論理行を範囲選択（末尾改行を含まない） ===

※ 行番号のクリックやドラッグによる行単位の範囲選択をしたときや [[マクロリファレンス:Selection インターフェイス#SelectLine メソッド|Selection.SelectLine()]] のあとなど、選択範囲末尾の改行（次行の先頭）を除外するときに必要。

※ 以下のふたつのコードは、左下（行頭位置）から右上に矩形選択した状態から実行したときの結果が異なる。

var s = document.selection;

// もとの選択範囲の座標を取得

s.EndOfLine( false, mePosLogical );

s.SetAnchorPoint( mePosLogical, 1, ty );

// または masme 氏作成の「コメントマーク付け外し」マクロより

// ※ 左下（行頭位置）から右上に矩形選択した場合も考慮したコード

s.EndOfLine( false, mePosLogical );

s.SetAnchorPoint( mePosLogical, 1, ty );

: ref. Mery 公式フォーラム 『[https://www.haijin-boys.com/discussions/4431 マクロについてアドバイスお願いします]』

=== 選択範囲の 先頭位置／末尾位置 ===

選択範囲の 開始（キャレットなし）／終了（キャレットあり） の位置は [[マクロリファレンス:Selection インターフェイス#GetAnchorPos メソッド|Selection.GetAnchorPos()]] と [[マクロリファレンス:Selection インターフェイス#GetActivePos メソッド|Selection.GetActivePos()]] とで取得できるが、先頭／末尾 の位置はそれらをもとにして前後関係を割りだす必要がある。

var ancPos, actPos, topPos, endPos;

topPos = ( ancPos < actPos ) ? ancPos : actPos;

endPos = ( ancPos < actPos ) ? actPos : ancPos;

=== 変換・挿入した文字列を範囲選択するとき ===

var str = "hoge";

document.Write( str ); // または document.selection.text = str;

// キャレットは選択範囲の末尾位置

document.selection.SetAnchorPos( document.selection.GetActivePos() - str.length );

// または（キャレットは選択範囲の先頭位置）

document.selectionSetActivePos( document.selection.GetActivePos() - str.length, true );

と記述すること。

※ ''[[マクロリファレンス:Selection インターフェイス#CharLeft メソッド|Selection.CharLeft]]( str.length, true )'' の場合、文字列 ''str'' が「折り返し」にかかってしまったときに想定どおりの選択範囲にならない。

: ref. Mery 公式フォーラム 『[https://www.haijin-boys.com/discussions/3740 "折り返し表示" での CharRight( document.selection.Text.length - 1 ) について]』

=== Mery のマクロの定数 ===

  Alert( <b style="color:#408040;">meFindNext</b> );

のような１行マクロで調べることができる。

=== Document.Selection オブジェクトの各種メソッドについて ===

==== ChangeCase() メソッド ====

[[マクロリファレンス:Selection インターフェイス#ChangeCase メソッド|Selection.ChangeCase() メソッド]] は

: ''ref.''　[[#文字列操作が空振りしたときは undo 履歴に残さない|文字列操作が空振りしたときは undo 履歴に残さない]]

: ''ref.''　拙作「[[大文字／小文字／頭文字 トグル変換]]」マクロ

==== ChangeWidth() メソッド ====

[[マクロリファレンス:Selection インターフェイス#ChangeWidth メソッド|Selection.ChangeWidth() メソッド]] は

: ''ref.''　[[#文字列操作が空振りしたときは undo 履歴に残さない|文字列操作が空振りしたときは undo 履歴に残さない]]

: ''ref.''　拙作「[[全角／半角 トグル変換]]」マクロ

==== Collapse() メソッド ====

==== DuplicateLine() メソッド ====

[[マクロリファレンス:Selection インターフェイス#DuplicateLine メソッド|Selection.DuplicateLine() メソッド]] は

* 行を複製したあとのキャレットの位置（桁）が、メソッド実行前の ActivePointX ではなく AnchorPointX になる。

⇒　複数行選択状態や、行番号クリックでの行選択状態から実行した後のキャレット位置が不自然なかんじになる。

じっさいのマクロのコーディングでは行全体の文字列を

// １行選択

document.selection.StartOfLine( mePosLogical );

document.selection.EndOfLine( mePosLogical, true );

: ''ref.''　拙作「[[行を複製 (複数行可)]]」マクロ

==== Indent／Unindent() メソッド ====

[[マクロリファレンス:Selection インターフェイス#Indent メソッド|Selection.Indent() メソッド]] ／ [[マクロリファレンス:Selection インターフェイス#Unindent メソッド|Selection.Unindent() メソッド]] は

* 「選択範囲のテキスト」ではなく、「選択範囲をふくむ論理行全体」が操作対象。

* 実行可能条件を満たしてから実行すると、「もとの選択範囲をふくむ論理行全体 (<span style="color:#0000c0;">末尾改行を'''ふくむ'''</span>)」が範囲選択された状態で残る。

* 引数に 1 以上の数値を渡して実行すると、「元に戻す」さいには <code>document.selection.Indent(n)</code> や <code>document.selection.Unindent(n)</code> での引数の値とおなじ回数の [[マクロリファレンス:Document インターフェイス#Undo メソッド|<code>document.Undo()</code>]] や Ctrl＋Z の操作が必要。

: ''ref.''　「[[非選択状態でも逆インデント]]」「[[字下げ・字上げ]]」など、標準のインデント／逆インデント機能の代替マクロがマクロライブラリにある。

==== NewLine() メソッド ====

[[マクロリファレンス:Selection インターフェイス#NewLine メソッド|Selection.NewLine() メソッド]] は

* 引数に 1 以上の数値を渡して実行したばあい、「元に戻す」さいには <code>document.selection.NewLine(n)</code> での引数の数値とおなじ回数の [[マクロリファレンス:Document インターフェイス#Undo メソッド|<code>document.Undo()</code>]] や Ctrl＋Z の操作が必要。

==== Tabify／Untabify() メソッド ====

[[マクロリファレンス:Selection インターフェイス#Tabify メソッド|Selection.Tabify() メソッド]] ／ [[マクロリファレンス:Selection インターフェイス#Untabify メソッド|Selection.Untabify() メソッド]] は

: ''ref.''　[[#文字列操作が空振りしたときは undo 履歴に残さない|文字列操作が空振りしたときは undo 履歴に残さない]]

: ''ref.''　拙作「[[TAB／半角空白 トグル変換]]」マクロ

==== SelectLine() メソッド ====

[[マクロリファレンス:Selection インターフェイス#SelectLine メソッド|Selection.SelectLine() メソッド]] は

* 「論理行」全体の選択のみで、「表示行」の選択には非対応。

: ※ エディタ内でのトリプルクリック操作に相当し、行末改行も選択範囲にふくまれる。

* トリプルクリックや行番号のクリック（またはドラッグ）で論理行全体が範囲選択された状態から実行すると、もとの選択範囲末尾改行のつぎの行まで範囲選択されてしまう。

: ''c.f.''　[[#複数行の論理行を範囲選択（末尾改行を含まない）|複数行の論理行を範囲選択（末尾改行を含まない）]]

=== 検索／置換 ===

===== Find() メソッド =====

* 定数

  &#32;8: meFindAround 文書の末尾まで検索したら先頭から検索を開始します

  16: meFindReplaceRegExp 正規表現で検索します

  ※ document.selection.'''[[マクロリファレンス:Selection インターフェイス#Replace メソッド|Replace()]]''' メソッド専用の定数

  <span style="color:#808080;">64: meReplaceAll すべて置換します</span>

   

  <span style="color:#808080;">&#32;8192: meFindNotEOL 選択範囲の終端を行頭とみなさず置換します</span>

  16384: meFindKeepOptions 検索ダイアログの文字列、オプション項目を維持します

* <span style="color:#c00;">「検索／置換」ダイアログのオプションフラグをすべて OFF にする方法</span> として

: というコードを挟み込む手法がある（第二引数には 0 または 1 を指定する）。

:: ref. Mery 公式フォーラム 『[https://www.haijin-boys.com/discussions/3398 空検索の動作、など]』

: ※ ただし、「終了したら閉じる」と、[https://www.haijin-boys.com/software/mery/mery-2-6-10#1 ベータ版 2.6.10] で追加された「インクリメンタルサーチ」のオプションフラグはマクロから解除することができない。

* ''meFindReplaceOnlyWord'' と ''meFindReplaceRegExp'' は排他関係なので、<span style="color:#c00;">同時に使用した場合 ''meFindReplaceRegExp'' は適用されるが ''meFindReplaceOnlyWord'' は無視される</span>

: （検索ダイアログで「正規表現」オプションを有効化したときに「単語のみ」オプションが無効になるのと同様）。

* [https://www.haijin-boys.com/software/mery/mery-2-8-3#13 ベータ版 2.8.3] で追加された ''meFindMigemo'' と従来からの ''meFindReplaceRegExp'' も排他関係で、''meFindMigemo'' が優先される。

: たとえば「[[検索(SJIS以外)]]」マクロのような長大な正規表現を使用するマクロで ''meFindKeepOptions'' を適用すると、マクロ実行後に [Shift＋F3] キーによる上方向への再検索はできなくなるので、長大な検索文字列を検索履歴に残したくない特殊な検索（置換）マクロの場合での扱いはむずかしい （検索マクロに「[[GetKeyState.exe(キー状態取得実行ファイル)]]」を導入して、''meFindNext''／''meFindPrevious'' を切り替える、または ''meFindKeepOptions'' の有無を切り替えるなどの対応をするか、検索方向（次／前）の差分で検索マクロを２件登録するか…）。

===== FindRepeat() メソッド =====

  前回検索した文字列を検索します。  

   

: <code>FindRepeat()</code> メソッドでは定数 ''meFindReplaceCase'' や ''meFindReplaceOnlyWord , meFindAround , meFindReplaceRegExp'' が使用できず、 <span style="color:#0000c0;">'''直前''' の「検索／置換」コマンドや <code>Find()</code> / <code>Replace()</code> メソッドで使用したこれらのオプションのうち ''meFindReplaceRegExp'' 以外の三つの ON/OFF 状態が '''継承''' される。</span>

* <code>FindRepeat()</code> メソッドで ''meFindReplaceCase'' や ''meFindReplaceOnlyWord , meFindAround'' を適用した検索をしたいばあいは、以下のように記述する。

: ※ ''meFindReplaceRegExp'' があっても <code>FindRepeat()</code> の実行時には無視される。

// FindRepeat() で使用したいフラグ

var flags = meFindReplaceCase + meFindAround;

// ➁「前回検索した文字列を検索」または キャレット位置の単語で「次の文字列を検索」

// -------------------------------------------------- //

// ➂ 最後にオプションフラグを解除しておきたいなら

document.selection.Find( "", 0 );

: ※ ➂ の行のコードを最後に使用した場合、「検索／置換」ダイアログのオプションフラグも解除される。

: [https://www.haijin-boys.com/software/mery/mery-3-0-0#13 Mery ver 3.0.1] で <code>Find()</code> メソッドなどで利用できる定数が追加されたが、<code>FindRepeat()</code> メソッドの仕様は変わっていないので検索フラグを適用する方法はうえのサンプルコードのようにしなければならないことに変わりはない。

: ※ <span style="color:#c00;">サンプルコードの「➀」で ''meFindKeepOptions'' 定数を追加すると「➁」の <code>FindRepeat()</code> メソッドに「➀」で設定したフラグが適用されなくなり、「検索／置換」ダイアログ内のオプションフラグのチェック状態が適用されてしまうので '''要注意'''。</span>

: マクロ独自のフラグ設定状態で <code>FindRepeat()</code> メソッド（次／前の文字列を検索）使用したいばあいには、「検索／置換」ダイアログ内のオプションフラグをクリア／リセットしなければならないままである。

==== Mery ver 3.0.1 以降でオプションフラグを維持したまま「置換」を行うサンプルコード ====

実行前になんらかの文字列を検索していて "検索マーカーが表示されている場合" を考慮すると、なかなか面倒な部分が多い…。

/**

  * 「スペース×２削除」マクロの Mery v3 対応テスト

   }

}

* ちなみに、sukemaru は検索ダイアログの履歴に残るマクロや、検索ハイライトが残るマクロが好きではないので、なるべく <code>Selection.Find()</code> や <code>Selection.Replace()</code> を使わずに JavaScript ネイティブの [https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf String.indexOf( searchValue, fromIndex )] ／ [https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/String/search String.search( regexp ) メソッド] や [https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/String/replace String.replace( regexp ) メソッド] で検索／置換を行なったり、あるいは [[マクロリファレンス:Document インターフェイス#HighlightFind プロパティ|Document.HighlightFind = false]] で最終的に検索マーカーを消すなどする自作マクロが多い （[https://www.haijin-boys.com/software/mery/mery-2-6-0#3 自動マーカー] でハイライトさせる設定にしているから「検索ハイライト」はいらなくて…）。

: [ [https://www.haijin-boys.com/software/mery/mery-tips#2 Ctrl＋Shift＋↑ / ↓] ] の機能も「[[次／前の文字列を検索・改]]」マクロに置きかえてしまったので、検索ダイアログを開くのは正規表現で検索するときぐらいかも。

=== 文字列操作が空振りしたときは undo 履歴に残さない ===

* 条件付きで文字列操作（挿入・置換など）するマクロが空振りしたとき

// e.g. 選択範囲に「hoge」が含まれていれば「fuga」に置換する

var fuga = document.selection.Text.replace( /hoge/g, "fuga" );

document.selection.Text = fuga;

: 上のようなコードの場合は '''undo''' 履歴に無駄に残ったり、文書に「'''未保存 *'''」のフラグが付加されたりする。

: 以下のように「文字列操作の前後で "変化なし" なら undo 履歴には残さない」記述にすると、[https://www.haijin-boys.com/software/mery/mery-2-6-9#4 変更行の強調表示] なども無用に付かなくなる。

// e.g. 選択範囲に「hoge」が含まれなければ置換しない

var st = document.selection.Text;

   document.selection.Text = piyo;

}

: [[マクロリファレンス:Selection インターフェイス|Document.Selection クラス]] の文字列操作メソッドの場合は、以下のように記述することで「<span style="color:#0000c0;">変換なしなら undo 履歴を巻き戻し</span>」できる。

// 変換前の文字列 と 保存済み／未保存 の状態を取得

var st = document.selection.Text;

   }

}

: ※ ただし、厳密にいえば undo 履歴には残っているので、'''redo''' (やり直し： Ctrl+Y) することができる。

=== スクロール位置の調整 ===

* 同様に、<code>ActiveDocument</code> 以外の <code>Document</code> にたいして <code>Selection.StartOFDocument()</code> 等のキャレット移動をともなうメソッドを実行しても、スクロール位置は移動しない。

: ※ いずれも、操作対象のウインドウ／タブを明示的にアクティブ化（<code>Editors.Item(m).Documents.Item(n).Activate();</code>）してからなら意図的なスクロール操作ができるが、もとのタブをアクティブ状態に戻すならコードの最後に <code>Document.Activate();</code> による復帰操作が必要（ほかのエディタウインドウのドキュメントの操作のばあいは、自他のエディタウインドウの <code>Editors.Item(m)</code> のインデックスの取得が必要）。

* キャレットをジャンプさせた後のスクロール位置とキャレット位置は、移動先の行（表示座標での行番号）がエディタの表示領域の高さに収まるかどうかとジャンプ方向によるので安定的ではない（スクロールマージンの考慮も必要）。

: 以下は、ジャンプしてスクロールが発生した場合に、キャレットが表示領域の先頭位置になるようにスクロール状態（<code>window.ScrollY</code>）を調整するコード。

var s = Document.Selection;

var ax = s.GetActivePointX( mePosLogical ); // キャレット位置の X

// ※ ScrollY プロパティに値を代入するときは物理座標（表示行）の行番号で

※ スクロールマージンは [https://www.haijin-boys.com/software/mery/mery-2-7-0#2 ベータ版 2.7.0] より「オプション」ダイアログの「スクロール」のページ内で変更できるようになっている。[https://www.haijin-boys.com/weblog/assets/uploads/2019/04/mery-2-7-0-4.png?20190417]

=== OutputBar オブジェクト ===

[[マクロリファレンス:OutputBar インターフェイス|OutputBar オブジェクト]] も [[マクロリファレンス:Window インターフェイス#プロパティ|<code>Window</code> オブジェクト直下のプロパティ]] に属するため、アウトプットバー操作の各メソッドやプロパティは、複数ウインドウ状態のときに非アクティブウインドウのアウトプットバーを操作することができない。

※ <code>Editors.Item(m).Documents.Item(0).Activate();</code> してからなら、OutputBar 操作可。

=== Window オブジェクト ===

※ <code>Document</code> や <code>Selection</code>、<code>Alert</code> など他の主要なプロパティは「大文字／小文字／頭文字のみ大文字」の区別なしに同一のプロパティとしてあつかわれる。

=== カレントディレクトリ ===

記述の都合上で相対パスを利用するために特定のカレントディレクトリを指定するマクロもあるが、「あえて流動的なカレントディレクトリを利用する」ようなコードが続く場合は、カレントディレクトリを書きもどす必要がある。

:※ マクロでカレントディレクトリを変更すると、実行中の Mery のプロセスの作業フォルダも変更されるため、あとから他のマクロを実行するさいのカレントディレクトリにも影響する。

// マクロ実行前の作業フォルダを保存する

var wshShell = new ActiveXObject( "WScript.Shell" );

// 最終的にマクロ実行前の作業フォルダを復帰する

wshShell.CurrentDirectory = currentDir;

* システムの関連付けを利用してテキストファイルなどのダブルクリックから Mery を起動した場合、そのファイルの親フォルダが Mery のプロセスの作業フォルダとなり、Windows OS の仕様により Mery のプロセスを終了するまでそのフォルダはロックされた状態になる（フォルダの移動や削除ができなくなる）が、マクロでカレントディレクトリを変更するとフォルダのロックを解除できる。

=== 動作要件としてのバージョンチェック ===

公開するマクロに Mery ベータ版で追加されたマクロ用プロパティ・定数を利用する場合は、マクロの動作要件として Mery 本体のバージョンをチェックするコードを入れておくのが無難である。

* 拙作の '''組み込み関数''' [[Mery本体のバージョンチェック|VersionCheck()]] を利用すれば、Mery のバージョン番号を指定して動作要件のチェックができるが、あらかじめプロパティや定数が導入された Mery のバージョン番号を調べておく必要がある（ ← Mery.txt か CHNGELOG.txt に記載されているはず）。

* JavaScript には特定のプロパティがオブジェクト配下に定義されているかを調べる方法も色々とあるが、親オブジェクトのタイプやプロパティ・定数のタイプ、JavaScript（JScript）のバージョンによる互換性などへの考慮が必要になる。 [https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Operators/typeof][https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Operators/in][https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty]

: ベータバージョンで追加された定数やプロパティが有効かどうかを調べる程度であれば、シンプルな記述で済む。

// ▼ ChangeCase() メソッドで定数 meCaseCapitalize を使えるのは ver 2.6.10 以降

   Status = "小文字…。";

}

// ▼ BeginUndoGroup() メソッドを使えるのは ver 2.7.0 以降

   BeginUndoGroup();

}

=== 外部リソースのチェック ===

// #include "include/IO.js"

   /* IO.js がインクルードされていないときの代替動作 */ ;

}

* また、[[GetKeyState.exe(キー状態取得実行ファイル)]] のあるなしで動作内容を分けるなら、以下のようにコードを記述すればよい。

// あらかじめ変数 ctrl に 0 を代入しておく

var ctrl = 0;

   /* GetKeyState.exe がない、または Ctrl キーが押されていないとき */ ;

}

=== Mery.ini から設定値を取得する ===

* 取得できる項目がきわめて限定的である

* 取得したい項目が複数あると、その都度 Mery.ini 全体の読み込みが発生する（キャッシュ可）

* Mery.exe のファイル名を変更 (e.g. Mery_hoge.exe) している場合、MeryInfo.js のコードを改変しないと Mery.ini (Mery_hoge.ini) のパスを得られず、設定値を取得できない。

==== GetIniOption() 関数 ====

ただし、制約がない代わりに組み込み関数自体のコードが長いことや、引数や戻り値が配列であることでコードが煩雑にならざるをえない（ ⇔ 配列を使用することで、複数の項目を取得する場合でも Mery.ini ファイルの読み込みを１回におさえられる）。

※ [[#Mery.ini を読みこむ|IO.LoadFromFile() 関数で Mery.ini を読みこむ]] という方法もある。

また、Mery.ini 側の仕様として、

  「オプション」など各種の設定ダイアログを [ '''OK''' ] ボタンで閉じたときか、

  Mery.ini に直ちに反映されない

という制約がある（Mery.ini の実体ファイルへの書き込み回数を減らすための仕様）。

<span style="color:#c00;">エディタの表示状態をトグル切り替えするコマンド（縦書き、色の反転、全画面表示、etc. ...）については、マクロ用の標準メソッド／プロパティから「現在の表示状態」を取得する手段がなく、'''組み込み関数 GetIniOption2() で Mery.ini を読み込んでも、必ずしも「最新の設定状態」を取得できるわけではない'''…。</span>

ただし、この方法をとる場合は、外部ファイルに設定内容をあずける項目（コマンド）の切り替えについては必ずマクロ経由で行なわなければならず、デフォルトの メニュー項目／ツールバーアイコン／ショートカットキー による通常操作でその項目の状態の変更をすると、最新の設定状態（現在の表示状態）と外部ファイルが保持している設定内容とのあいだに齟齬が生じてしまう。

: →　e.g. 「[[折り返しトグル切り替え#３つの折り返しモードを順々にトグルする|折り返しトグル切り替え]]」マクロ

==== Mery.ini からさまざまな情報を読み込んで利用するマクロ ====

組み込み関数 GetIniOption ／ GetIniOption2 を利用（必用に応じてカスタマイズ）した拙作マクロ

* 「[[ファイルを読み直す・開きなおす]]」：　自動保存・バックアップの設定状態、タブの閉じるボタンの表示設定などを取得して動作コードの条件分岐に利用。 編集モード名の一覧取得してポップアップメニューから切り替える。

* 「[[マクロメニュー]]」：　[[ヘルプ:マクロ#カスタマイズ|マクロのカスタマイズ]] に登録済みのマクロの一覧をポップアップメニューに表示して、選択したマクロを実行または Mery で開く（編集）。

==== Mery.ini からは「最新の状態」を取得できない設定項目 ====

* [[ヘルプ:ファイル#最近のファイル|最近開いたファイルの一覧]]、検索履歴、[ [[ヘルプ:表示#フォント|フォントの履歴]] ] とフォントのサイズ、標準ツールバーの [ [[ヘルプ:表示|表示]] ] メニューや [ [[ヘルプ:ウィンドウ|ウインドウ]] ] メニュー内から ON／OFF の切り替えが可能な項目、[[ヘルプ:ツール#プラグイン|プラグイン]] の ON／OFF の状態、現在のウインドウサイズや位置、etc. ...。

※ フォントの使用履歴の取得は可能だが、[ 表示 ] メニューから切り替えたさいの「最新の状態」は取得できない。 また、マクロからフォントを変更する手段がない （履歴内の並び順を取得できないので <code>wshShell.SendKeys()</code> などのキーストロークエミュレーションでも不可）。 フォントサイズを 大きく／小さく するだけならマクロからでも変更可能。

=== 外部ファイルにマクロの設定などを書き出す ===

* [[マクロライブラリ]] では「[[折り返しトグル切り替え]]」マクロ（Bleat 版 ／ sukemaru 版）や ks 氏の「[[スマートインデント(C 構文)]]」マクロの SwitchSmartIndent.js のコードが、 <code>IO.Serialize()</code> ／ <code>IO.Deserialize()</code> を利用したマクロの雛形として利用しやすい。

* 複数の設定値を保存／参照する複雑なものとしては、ks 氏の「[[階層化マクロメニュー]]」マクロや、拙作「[[ポップアップメニューで検索先にジャンプ#include版|検索ジャンプ]]」「[[ブックマーク一覧ジャンプ#include版|ブックマークジャンプ]]」や「[[ファイルを読み直す・開きなおす#include版|読みなおし]]」マクロなどもあるが、メイン部分の動作コード自体が長く煩雑なので参考にしづらいとおもわれる…。

以下、「[[折り返しトグル切り替え#３つの折り返しモードを順々にトグルする|折り返しトグル切り替え]]」マクロを例に <code>IO.Serialize()</code> ／ <code>Deserialize()</code> の利用方法の簡単な説明。

#include "include/IO.js"

   // \Macros\include\IO.js をインクルードする

// setting オブジェクトの変更内容を保存する

IO.Serialize( setting, jsonName );

==== Tag プロパティ ====

[https://www.haijin-boys.com/software/mery/mery-3-0-0 ベータ版 ver 3.0.0] で追加された <code>Tag</code> プロパティを活用することで、外部ファイルにマクロの設定を書き出す必用がなくなる場面もでてくるとおもわれる。

: ref. [[マクロリファレンス:3:Document_オブジェクト#Tag_プロパティ|Document.Tag プロパティ]]、[[マクロリファレンス:3:Editor_オブジェクト#Tag_プロパティ|Editor.Tag プロパティ]]、[[マクロリファレンス:3:Window=オブジェクト#Tag_プロパティ|Window.Tag プロパティ]]（＠[[マクロリファレンス:3]]）

* 拙作マクロで外部ファイルの利用から <code>Tag</code> プロパティの利用に切り替えたのは、現時点では上出の「[[折り返しトグル切り替え#３つの折り返しモードを順々にトグルする|折り返しトグル切り替え]]」マクロだけである。

: ※「[[位置情報を保存してから「すべて選択／選択解除」(非スクロール)]]」マクロ (include版) や「[[位置情報を保存してから「すべて選択／選択解除」(非スクロール)#【include 版】位置を復帰／保存|位置を復帰／保存]]」マクロ (include版)、「[[カッコをはずす#カッコを追加／削除|カッコを追加／削除]]」マクロ (include版) も <code>Tag</code> プロパティへの移行を検討中 （いまのところ、ベータ版 ver 3.0.0 で追加された '''マルチカーソル''' 機能 [https://www.haijin-boys.com/software/mery/mery-3-0-0#4] に対応する目処が立っていないので、公開版の更新は保留）。

* ポップアップメニュー内の「設定変更サブメニュー」で動作設定を変更するタイプの拙作【include版】マクロは、外部ファイルを利用する仕様のままにする予定。

=== 関数の「呼び出しコスト」 ===

※ あえて '''ループ処理で１行ずつエスケープ''' してみる （[[#その他、拙作マクロについて|＠ロースペの XP ノート]]）

/* 関数バージョン */

}

document.Text = a.join( "\n" );

関数を使用しない以下のようなベタ書きのコードの場合でも、ほぼ同じ程度の処理時間がかかった （＠ロースペの XP ノート）。

/* 非関数バージョン */

}

document.Text = a.join( "\n" );

※ ループ文の中で関数を定義した場合は、やや遅くなって 1.3 秒台。

BeginUndoGroup();

var lines = document.GetLines( 0 );

}

document.Text = a.join( "\n" );

上とおなじ <code>Quote()</code> 関数を使用しての文書全体の一括処理でも…

function Quote( str ) {

   return str.replace( /\W/g, "\\$&" );

document.Text = Quote( document.Text );

関数を使用しないベタ書きの一括処理でも…

document.Text = document.Text.replace( /\W/g, "\\$&" );

…処理時間はほぼ同じで、約 0.7 ～ 0.8 秒だった。