Sukemaru (トーク | 投稿記録)
Sukemaru (トーク | 投稿記録)
124行目: 124行目:
* マクロライブラリにある ks 氏らの「[[マクロ覚え書き(開発者向け)|マクロ覚え書き]]」
* マクロライブラリにある ks 氏らの「[[マクロ覚え書き(開発者向け)|マクロ覚え書き]]」
* 黄身氏の「[[利用者:黄身#覚え書き|覚え書き]]」
* 黄身氏の「[[利用者:黄身#覚え書き|覚え書き]]」
<br>
拙作マクロはポップアップメニューを利用するものが多いので、Tips はその分野の内容に偏ってしまうが…。


=== アイコン化したマクロ ===
== アイコン化したマクロ ==
通常、フォーカスがアウトプットバーやアウトラインペイン、検索/置換ダイアログにあると、ポップアップメニューやショートカットキーからマクロを起動することはできない。<br>
通常、フォーカスがアウトプットバーやアウトラインペイン、検索/置換ダイアログにあると、ポップアップメニューやショートカットキーからマクロを起動することはできない。<br>
'''Document''' オブジェクトのかわりに '''Editor.ActiveDocument''' で記述したマクロであれば、エディタ領域にフォーカスがない場合でもツールバーアイコンやマクロメニューからマクロを起動できる。<br>
'''Document''' オブジェクトのかわりに '''Editor.ActiveDocument''' で記述したマクロであれば、エディタ領域にフォーカスがない場合でもツールバーアイコンやマクロメニューからマクロを起動できる。<br>
ただし、アクティブなタブ以外を操作・編集するマクロにおいては Editor.Documents.Item( dd ) などのような記述が必要。
ただし、アクティブなタブ以外を操作・編集するマクロにおいては Editor.Documents.Item( dd ) などのような記述が必要。


=== ポップアップメニュー ===
== ポップアップメニュー ==
* PopupMenu.Add() メソッドの第三引数 Flags : int を数値化すると
=== オプションフラグ ===
[[マクロリファレンス:PopupMenu インターフェイス#Add メソッド|PopupMenu.Add() メソッド]] の第三引数 '''Flags''' : int を数値化すると
<source lang="javascript">
<source lang="javascript">
meMenuChecked = 1
meMenuChecked = 1
138行目: 141行目:
meMenuSeparator = 4
meMenuSeparator = 4
</source>
</source>
: となるので、真偽値が true=1 / false=0 で評価されることを利用して、真偽値を返す変数や条件式を代入することができる(ただし Number 型に変換する必要がある)。
となるので、真偽値が true=1 / false=0 で評価されることを利用して、真偽値を返す変数や条件式を代入することができる(ただし Number 型に変換する必要がある)。
<source lang="javascript">
<source lang="javascript">
var menu = CreatePopupMenu();
var menu = CreatePopupMenu();
149行目: 152行目:
</source>
</source>


* for 文などのループ処理によって配列からポップアップメニューのアイテムを生成する場合に、 PopupMenu.Add() メソッドの第二引数 Id (※通常は 1 ~ )と配列のアイテムのインデックス [i] の値(※通常は 0 ~ )を一致させたいときは、配列の先頭にダミーまたは空の要素を置いておき、ループ処理の開始インデックスを 1 にする。
=== アクセラレータ ===
ポップアップメニューのラベルの文字列に「半角アンパサンド記号('''&''') + 半角英数字 (またはアスキー記号)」を付記することで、アクセラレータ(アクセスキー)を設定することができる。
ラベルの先頭に連番数字などがある場合は、アンパサンド記号を付加することで、数字をアクセラレータにするとよい。
そのさい、Shift キー付きでの入力が必要な記号は Shift キーなしで入力可能なキーのラベルと同一視される (e.g. &# で "#" 記号をアクセラレータに指定した場合、JIS 配列のキーボードでは [2] キーがアクセラレータになる)。
また、"& " で半角スペースをアクセラレータに指定したアイテムは、スペースキーがアクセスキーになる。
 
*<span style="color:#c00;">"'''&'''" 記号でアクセラレータ化する文字の位置は限定されないが、最初の "'''&'''" 記号のうしろの文字がアクセラレータになる。</span>
*<span style="color:#c00;">全角文字はアクセラレータにできない。</span>
*<span style="color:#c00;">ラベル文字列に含まれる "'''&'''" 記号はエスケープされ、ポップアップメニューに表示されない。<br> ラベルに "'''&'''" 記号を表示させたいときは、"'''&&'''" のように二重に記述する必要がある。</span><br> → 不特定の文字列をラベルにする場合は、あらかじめ String.replace( /&/g, "&&" ) と記述するとよい。
*<span style="color:#c00;">同じキーが重複してアクセラレータに指定されていると、そのキーを押した場合、アイテム間をトグル移動する(→ [Enter] キーで決定する)。</span>
<source lang="javascript">
var menu = CreatePopupMenu();
var piyo = "LOVE & PEACE & ...";
 
menu.Add( "アイテム1(&1)", 1 ); // [1] キーがアクセラレータ
menu.Add( "アイテム&2", 2 ); // [2] キーがアクセラレータ
menu.Add( "0&3 アイテム3", 3 ); // [3] キーがアクセラレータ
menu.Add( "&Hello World &4", 4 ); // [H] キーがアクセラレータ
menu.Add( piyo.replace( /&/g, "&&" ) + "(&5)", 5 ); // [5] キーがアクセラレータ
menu.Add( piyo + "(&6)", 6 ); // スペースキーがアクセラレータ
menu.Add( "※※※※", 0, meMenuSeparator ); // meMenuSeparator があると第一引数の文字列は無視される
menu.Add( "キャンセル & ", 0 ); // スペースキーがアクセラレータ
 
// 5つめのアイテムは "LOVE & PEACE & ..." と表示されるが
// 6つめのアイテムは "LOVE  PEACE  ..." と表示される
// ※ 5つめのアイテムと最後のアイテムでアクセラレータが重複している
 
var ret = menu.Track();
</source>
 
=== ラベルの整形 ===
ポップアップメニュー(警告/確認ダイアログなどもだが)は UI フォントで表示されるので、英数字の羅列は読みづらい (…と個人的に感じている)。
文書内の文字列をラベル化する「[[ポップアップメニューで検索先にジャンプ#sukemaru 版|検索ジャンプ]]」や「[[ブックマーク一覧ジャンプ#sukemaru 版|ブックマークジャンプ]]」マクロなどでは、読みづらい半角アルファベットや記号を全角化させたりしている。
<source lang="javascript">
/**
* ポップアップメニューに表示するラベルを整形する
*
* ・行頭空白を除去、空白文字を圧縮
* ・文字数を切り詰め
* ・削られてしまう「&」を補完
* ・「¥」(U+005C) を「∖」(U+2216) に置換
* ・判別しづらいメタ文字を全角に置換: !"%'(),.:;@[]`{|}
* ・「a-z」を全角に置換
*/
 
var y = Document.Selection.GetActivePointY( mePosLogical )
var menuKey = Document.GetLine( y, 0 );
var menuWidth = 55;
 
menuKey = menuKey.replace( /^[\t  ]+/, "" )
                .replace( /(?:\t|[ ]{3,}|[ ]{2,})+/g, " › " )
                .slice( 0, menuWidth + 1 )
                .replace( /[&]/g, "&&" )
                .replace( /[\\]/g, "∖" )
                .replace( /([^∖!"',.:;`|\t  ])([∖]+)/g, "$1 $2" )
                .replace( /[!"%'(),.:;@\[\]`a-z{|}]/g,
                  function( tmp ) {
                    return String.fromCharCode( tmp.charCodeAt( 0 ) + 0xFEE0 )
                  } );
// アクセラレータつきの連番を付加
menuKey = "&" + y + ": " + menuKey;
 
// ※ 実際には「行番号を空白文字でケタ埋め (右端揃え)」などの追加処理もしている。
</source>
 
=== 配列からポップアップメニューを生成 ===
for 文などのループ処理によって配列からポップアップメニューのアイテムを生成する場合に、[[マクロリファレンス:PopupMenu インターフェイス#Add メソッド|PopupMenu.Add() メソッド]] の第二引数 '''Id''' (※通常は 1 ~ )と配列のアイテムのインデックス [i] の値(※通常は 0 ~ )を一致させたいときは、配列の先頭にダミーまたは空の要素を置いておき、ループ処理の開始インデックスを 1 にする。
<source lang="javascript">
<source lang="javascript">
var a = new Array( "" ); // 先頭に空のダミー要素を入れておく
var a = new Array( "" ); // 先頭に空のダミー要素を入れておく
171行目: 240行目:
</source>
</source>


=== 選択範囲の 先頭位置/末尾位置 ===
=== サブメニュー ===
配列やオブジェクトからポップアップメニューを生成するさいに [[マクロリファレンス:PopupMenu インターフェイス#AddPopup メソッド|サブメニュー]] を利用する場合、あらかじめサブメニューのラベルや各要素の振り分け方が決まっていれば難しいことはないが、要素が不定数の配列やオブジェクトをサブメニューに振り分けるのは簡単ではない。
「[[階層化マクロメニュー]]」マクロなどのソースコードを参考にしてコードを組むか、組み込み関数「[[ポップアップメニューを「n*十件ずつ」のサブメニューに自動分割する]]」で一定数ごとにサブメニュー項目を自動生成して要素を放り込むしかない…。
 
=== マクロの動作設定を変更する ===
拙作マクロは、ポップアップメニューを使うものにかぎらず動作設定用の項目が多い。<br>
ポップアップメニューマクロでないものは、通常、頻繁に動作設定を弄る必要はないが、sukemaru 好みの動作方式は一般的嗜好と合致しないであろうことから公開用のマクロにするにあたってカスタマイズ可能な「設定項目」に調整しなおすことが多い。
<br><br>
ポップアップメニューマクロであれば、メニュー項目から動作設定をカスタマイズできるようにコーディングすることができる。
<br><br>
まず、[[利用者:Masme|masme]] 氏の「[[行並べ替え]]」や「[[連番を挿入]]」マクロのように do - while ループで動作設定の既定値を何度も書き換えながらポップアップメニューを再描画する方法がある。<br>
動作設定の変更内容はマクロの完了時に破棄されてしまうので、連続して同じマクロを利用する場合には、ソースコードの既定値を書き換えてカスタマイズしておくとよい。
<br><br>
sukemaru の場合は、「[[ポップアップメニューで検索先にジャンプ#include版|検索ジャンプ]]」や「[[ブックマーク一覧ジャンプ#include版|ブックマークジャンプ]]」、「[[ファイルを読みなおす・開きなおす#include版|読みなおし]]」マクロなどで、"include 版" と称するものを作っている。 <br>
これらにおいては、[[includeライブラリ|include ライブラリ]] の IO クラス(IO.js)の Serealize / Deserialize を利用して、変更した設定値を外部ファイル(JSON ファイル)に保持できるようにしている。<br>
動作設定を同じままで再実行するのも、カスタマイズしながら再実行するのも容易にはなったが、コードが煩雑になって他のマクロに流用しづらくなってしまっている…。<br>
非 include 版では、masme 氏のマクロのような処理コードは入れず、動作設定の変更方法はソースコードの変数の値の書き換えのみとしている。
 
== 選択範囲の 先頭位置/末尾位置 ==
選択範囲の 開始(キャレットなし)/終了(キャレットあり) の位置は Selection.GetAnchorPos() と Selection.GetActivePos() とで取得できるが、先頭/末尾 の位置はそれらをもとにして前後関係を割りだす必要がある。
選択範囲の 開始(キャレットなし)/終了(キャレットあり) の位置は Selection.GetAnchorPos() と Selection.GetActivePos() とで取得できるが、先頭/末尾 の位置はそれらをもとにして前後関係を割りだす必要がある。
<source lang="javascript">
<source lang="javascript">
181行目: 268行目:
</source>
</source>


=== スクロール位置の調整 ===
== スクロール位置の調整 ==
キャレットをジャンプさせた後のスクロール位置とキャレット位置は、移動した行数がエディタの表示領域の高さに収まるかどうか(スクロールマージンの考慮が必要)とジャンプ方向によるので安定的ではない。<br>
キャレットをジャンプさせた後のスクロール位置とキャレット位置は、移動した行数がエディタの表示領域の高さに収まるかどうか(スクロールマージンの考慮が必要)とジャンプ方向によるので安定的ではない。<br>
以下のコードは、ジャンプ後にエディタの表示領域がスクロールした場合に、キャレットが表示領域の先頭位置になるように調整するもの。
以下のコードは、ジャンプ後にエディタの表示領域がスクロールした場合に、キャレットが表示領域の先頭位置になるように調整するもの。
202行目: 289行目:
</source>
</source>


=== カレントディレクトリ ===
== カレントディレクトリ ==
カレントディレクトリは、Mery を起動したときに決定され、一定ではない。<br>
カレントディレクトリは、Mery を起動したときに決定され、一定ではない。<br>
記述の都合上で相対パスを利用するマクロにおいては特定のカレントディレクトリの指定が必要な場合もあるが、あえて「流動的なカレントディレクトリ」を利用するようなマクロがほかにある(かも知れない)ことを考慮しておいたほうがよい(…とおもう)。
記述の都合上で相対パスを利用するマクロにおいては特定のカレントディレクトリの指定が必要な場合もあるが、あえて「流動的なカレントディレクトリ」を利用するようなマクロがほかにある(かも知れない)ことを考慮しておいたほうがよい(…とおもう)。
219行目: 306行目:
   var currentDir = wshShell.CurrentDirectory;
   var currentDir = wshShell.CurrentDirectory;


   // 相対パス解決のためにカレントディレクトリを設定 e.g. %AppData%\Mery
   // 相対パス解決のためにカレントディレクトリを設定 e.g. %AppData%\Mery
   wshShell.CurrentDirectory = wshShell.SpecialFolders( "APPDATA" ) + "\\Mery";
   wshShell.CurrentDirectory = wshShell.SpecialFolders( "APPDATA" ) + "\\Mery";
   wshShell.Run( "notepad " + "Mery.ini" );
   wshShell.Run( "notepad " + "Mery.ini" );
228行目: 315行目:
</source>
</source>


=== バージョンチェック ===
== 動作要件としてのバージョンチェック ==
Mery ベータ版で追加されたマクロ用プロパティを利用する場合は、マクロの動作要件として Mery 本体のバージョンチェックをするのが無難である。<br>
Mery ベータ版で追加されたマクロ用プロパティを利用する場合は、マクロの動作要件として Mery 本体のバージョンチェックをするのが無難である。<br>
JavaScript には特定のプロパティがオブジェクト配下に定義されているかを調べる方法が色々とあるが、専用の組み込み関数 [[Mery本体のバージョンチェック|VersionCheck()]] を利用すれば Mery のバージョン番号を指定してのチェックができる。
JavaScript には特定のプロパティがオブジェクト配下に定義されているかを調べる方法が色々とあるが、専用の組み込み関数 [[Mery本体のバージョンチェック|VersionCheck()]] を利用すれば Mery のバージョン番号を指定してのチェックができる。
 
<br>
=== 外部リソースのチェック ===
== 外部リソースのチェック ==
[[includeライブラリ|include ライブラリ]] が必要なマクロの場合、ユーザー側が include ライブラリを正しく導入していることが要求される。
ユーザー側で include ライブラリが導入されていて、マクロ側で
  #include "include/IO.js"
  #include "include/IO.js"
のようなプリフィクスがソースコードの先頭で宣言されていれば問題ないが、[[includeライブラリ|include ライブラリ]] がなくても、プリフィクスを削除(コメントアウト)すればマクロがある程度動くようにコーディングすることもできる。
のようなプリフィクスがソースコードの先頭で宣言されていれば問題ないのだが、include ライブラリが導入されていなくても、プリフィクスを削除(コメントアウト)すればマクロがある程度動くようにコーディングすることもできる。
<source lang="javascript">
<source lang="javascript">
// #include "include/IO.js"
if ( typeof IO == "object" ) {
if ( typeof IO == "object" ) {
   /* IO.js がインクルードされているときの動作 */ ;
   /* IO.js がインクルードされているときの動作 */ ;
243行目: 334行目:
}
}
</source>
</source>
 
<br>
また、[[GetKeyState.exe(キー状態取得実行ファイル)|GetKeyState.exe]] のあるなしで動作内容を分けるなら、以下のようにコードを記述すればよい。
また、[[GetKeyState.exe(キー状態取得実行ファイル)|GetKeyState.exe]] のあるなしで動作内容を分けるなら、以下のようにコードを記述すればよい。
<source lang="javascript">
<source lang="javascript">
266行目: 357行目:
</source>
</source>


== Mery.ini から設定値を取得する ==
[[includeライブラリ|include ライブラリ]] の MeryInfo クラス (MeryInfo.js) を利用して Mery.ini からいくつかの設定項目の値や状態を取得することはできるが、制約が非常に多い。
* 取得できる項目がきわめて限定的である
* Mery.exe のファイル名を変更 (e.g. Mery_hoge.exe) している場合、MeryInfo.js のコードを改変しないと Mery.ini (Mery_hoge.ini) のパスを得られない。
<br>
拙作の組み込み関数 [[Mery.iniのオプション値を取得#GetIniOption() 関数|GetIniOption()]] と [[Mery.iniのオプション値を取得#GetIniOption2() 関数|GetIniOption2()]] はこれらの制約を受けず、とくに後者は Mery.ini のすべての項目にアクセスして値を取得することができる。
<br><br>
ただし、制約がない代わりに組み込み関数自体のコードが長いことや、引数や戻り値が配列であることでコードが煩雑にならざるをえない。
<br><br>
また、Mery.ini 側の仕様として、
: 「オプション」など各種の設定ダイアログを [OK] で閉じたときか、エディタウインドウを閉じたときにしか Mery.ini への書き込みがされないため、メニュー項目/ツールバーアイコン/ショートカットキー などで設定を変更した場合には Mery.ini に直ちに反映されない
という制約がある(実体ファイルへの書き込み回数を減らすための仕様)。
<br><br>
エディタの表示状態をトグル切り替えするコマンド(縦書き、色の反転、etc. ...)については、マクロから「現在の表示状態」を取得する手段がなく、組み込み関数で Mery.ini から読み込んでも「最新の設定状態」を取得できるわけではない…。
<br><br>
現在の表示状態を取得してから ON/OFF を指定しての切り替えを行なうためには、include ライブラリの IO クラスを利用するなどして外部に Mery.ini とは別の設定ファイル (e.g. JSON ファイル) を利用して、切り替え実行のたびに設定ファイルを読み書きする必要がある。<br>
この場合、外部ファイルに設定内容をあずける項目の切り替えについては必ずマクロ経由で行なわなければならず、デフォルトの メニュー項目/ツールバーアイコン/ショートカットキー などから切り替えをすると最新の設定状態とマクロの設定ファイルとのあいだに齟齬が生じてしまう。


= 投稿した構文ファイル =
= 投稿した構文ファイル =
スポンサーリンク