サクラエディタでマクロを使う

サクラエディタは、国産のWindows用テキストエディタです。マクロ機能が充実しており、マクロを使う目的でサクラエディタを選ぶ人も多いでしょう。ここでは、サクラエディタのマクロ機能の概要から使い方まで解説していきます。

【参考】：サクラエディタ

テキストエディターとは？エンジニア初心者におすすめのエディタも紹介！

マクロとは、繰り返し行う処理や手続きを登録しておき、簡単な操作で一連の操作を効率的に行う仕組みです。マクロ機能を用いて、反復操作を自動実行することができます。例えばMicrosoft Excelには、表計算ソフトとして利用できるマクロ機能が搭載されています。

サクラエディタは、マクロ機能が充実しているテキストエディタとして有名です。ちょっとした作業から高度な作業まで、マクロを活用して効率的に行うことができます。マクロは、ユーザの操作を記録するキーボードマクロ（キーマクロ）、関数や処理を定義して使用するPPAマクロ・WSHマクロが利用できます。

リファレンス情報は以下のリンクに掲載されています。

【参考】：サクラエディタ マクロについて

サクラエディタでは、マクロの種類をファイル拡張子により判別して処理しています。ファイル拡張子は、「.mac」「.ppa」「.js」「.vbs」を識別します。これ以外のファイル拡張子でもWSHが認識できるファイルは使用することができます。

「.mac」は、キーボードマクロ（キーマクロ）で利用されます。キーマクロを直接マクロファイルに記述することで、キーマクロの記録よりも高度な機能を実装することもできます。「.ppa」はPascalベースの独自構文を用いるマクロです。「.js」はWSHのJscript構文、「.vbs」はWSHのVBScript構文を用います。

【参考】：サクラエディタ マクロについて

JavaScriptの入門！その概要や文法の基礎について解説！

サクラエディタのキーマクロの使い方

キーマクロとは、キーボードの操作を記録するマクロ機能です。キーマクロまたはキーボードマクロと言います。キーマクロではキーボードの操作、つまりどのキーを押したのかを「記録開始」から「記録終了」まで記録し、ファイルに格納します。サクラエディタで、多く用いられるマクロの形式です。

【参考】：サクラエディタ キーボードマクロ 【参考】：サクラエディタ キーマクロの記録開始／終了

サクラエディタのキーマクロを記録するには、エディタウィンドウの「ツール」メニューの「キーマクロの記録開始」をクリックします。次の図をご覧ください。

「ツール」メニューの「キーマクロの記録開始」をクリックすると、エディタウィンドウのタイトル表示に「キーマクロの記録中」と表示されます（①②）。

エディタウィンドウのタイトル表示が「キーマクロの記録中」の状態で、次の図のように、キー操作を進めていきます。ここでは”１２３４５６７８９０”+「Enter」をキー入力してみます（①）。

入力が完了したら、「ツール」メニューの「キーマクロの記録終了」をクリックします（②）。これでキーマクロの記録が終了します。

キーマクロの記録が終了すると、デフォルトのキーマクロファイルである”C:\Usersユーザー名\AppData\Roaming\sakura\RecKey.mac”が作成されます。なお一部のキーに関しては、キーマクロで記録することができません。詳しくは以下のリンク先をご確認ください。

【参考】：サクラエディタ キーマクロの記録開始／終了 【参考】：サクラエディタ キー割り当て一覧

サクラエディタのキーマクロを実行するには、「ツール」メニューの「キーマクロの実行」をクリックします。

次の図のように、「キーマクロの実行」をクリックすると、”１２３４５６７８９０”+「Enter」が現行のカーソル位置から入力されます（②）。「キーマクロの実行」を複数回クリックすると、その回数分入力がされます（③）。

このように複数回「キーマクロの実行」を繰り返す場合は、ショートカットキーとして「Shift」+「Ctrl」+「L」が割り当てられていますので、ショートカットキーを使って作業短縮を図るのが良いでしょう。

キーマクロの記録が終了したら、デフォルトのキーマクロファイルが作成されます。ここでキーマクロに名前を付けて保存したり、保存したキーマクロを読み込んだりすることができます。次の図をご覧ください。

キーマクロに名前を付けて保存するには、「ツール」メニューの「キーマクロの保存」をクリックします（①）。任意のフォルダーを選択し、名前を付けて保存することができます。

保存したファイルを開くには、「ツール」メニューの「キーマクロの読み込み」をクリックし、任意のフォルダーから保存済みのファイルを指定して読み込むことができます。

例えば次の図のように、「キー入力の繰り返し」というファイル名を付けて保存し、マクロの動作が分かるようにしておくと良いでしょう。

サクラエディタのマクロの作り方

サクラエディタのマクロの作り方ですが、テキストエディタで作成し、ファイル拡張子を加えて保存します。ファイル拡張子は「.mac」「.ppa」「.js」「.vbs」を判別し、サクラエディタの内部で解釈できるのは「.mac」であり、キーマクロの記録で用いる形式です。

「.ppa」はPPAマクロで、PPA.DLLと言うPascalインタプリタコンポーネントを追加して使用します。「.js」「.vbs」はWSHを呼び出して解釈します。WSHの場合は、Windows標準ですので追加の必要はありません。

実際のマクロ関数は、通常のメニューにあるコマンドからマクロ専用関数まで対応します。これらは、定義されている関数を自由に選択することができます。関数名ですが、PPAでは「S_関数名」とします。

WSHでは「Editor.関数名」とします。キーマクロはPPAと同じですが、先頭の「S_」は省略することができます。

【参考】：サクラエディタ マクロについて 【参考】：サクラエディタ マクロ専用関数/変数

先ほどの手順で作成した、キーマクロのファイルを開いて内容を確認していきます。デフォルトで保存される、”C:\Usersユーザー名\AppData\Roaming\sakura\RecKey.mac”を、エディタの「ファイル」メニューの「開く」で開いてみます。次の図をご覧ください。

「ファイルを開く」のポップアップウィンドウから、フォルダーを”C:\Usersユーザー名\AppData\Roaming\sakura”とし、ファイル名を”RecKey.mac”を指定して「開く」をクリックします（①②）。エディタには、”RecKey.mac”が開きますので表示や編集が可能です（③）。

エディタに表示されているファイルの内容は次の通りです。このファイルを修正して機能を追加していくこともできます。

//キーボードマクロのファイル
InsText('１２３４５６７８９０');    // テキストを貼り付け
Char(13);    // 文字入力

サクラエディタのマクロの登録は、「共通設定」を用います。「共通設定」は、「設定」メニューあるいは常駐プロセスのメニューから開きます。具体的には次の図のように、「設定」メニューの「共通設定」を選択すると、「共通設定」のポップアップウィンドウが表示されます（①②）。

続いて次の図のように、「マクロ」タブをクリックします（①）。「マクロ」タブでは50個のマクロがマクロ一覧に表示されます（②）。初期設定では何も登録されていませんので、必要なマクロを用途別に追加して利用します。

ここでは例として先に保存しておいた「キー入力の繰り返し」のキーマクロを追加してみます。次の図をご覧ください。

最初に「マクロ一覧」の空いている番号を選び、「名前」を入力します（①②）。「名前」は自身で識別できるものを自由に記述します。続いて「File」のプルダウンメニューから登録するファイルを選択します（③④）。問題ないようであれば「設定」をクリックします（⑤）。

マクロの登録が成功すると、「マクロ一覧」に登録したマクロが反映されます（⑥）。なお、デバッグ中のマクロはファイルの更新を行いながら作業しますので、ウィンドウ下部の「マクロを実行するたびにファイルを読み込みなおす」にチェックを入れて登録するのがおすすめです。

「共通設定」の「キー割り当て」を使って、ショートカットキーを割り当てることができます。登録したマクロも「キー割り当て」により、効率的に使用することができます。次の図をご覧ください。

「設定」メニューの「共通設定」を選択し、「共通設定」のポップアップウィンドウを表示します。ここで「共通設定」の「キー割り当て」タブをクリックします。「キー割り当て」タブでは、「種別」から「外部マクロ」を選択します（①）。

「機能」を見ると、登録した「キー入力の繰り返し」が表示されています（②）。右側の「キー」から「Shift」「Ctrl」「Alt」の組み合わせとキーの組み合わせを選びます（③）。「解除」の右欄に「未割当」と表示される組み合わせはどの操作でも未設定の組み合わせです（④⑤）。

今回は未割当である「Ctrl」+「Alt」+「0」を用いて、「割当」をクリックします（⑥）。割り当てが完了すると、「機能に割り当てられているキー」に割り当てられたキーの組み合わせが表示されます（⑦）。

登録したマクロを使うには、「ツール」メニューの「登録済みマクロ」を用います。次の図をご覧ください。

「ツール」メニューの「登録済みマクロ」には、登録済みの「キー入力の繰り返し」が表示されます（①②）。

マクロを使うには、表示されている「キー入力の繰り返し」をクリックするか、キー割り当てしている「Ctrl」+「Alt」+「0」を用います。

マクロは50個まで「マクロ一覧」に登録できます。そのため、機能別にマクロを追加登録するのが良いでしょう。

次の図のように、用途別の3種類のマクロを順番に「マクロ」タブの空いているマクロ番号に「マクロ名」「ファイル名」を入力し設定していきます（①②③④）。続いて「キー割り当て」の表示されているマクロの「機能」毎に「キー」との組み合わせを選択し、「割当」を行います（⑤⑥⑦⑧）。

登録が完了すると次の図のように、「ツール」メニューの「登録済みマクロ」それぞれのマクロが表示されます（①②）。

追加登録したマクロは次の2点です。簡単なマクロですが、サンプルとして紹介します。

1つ目は、ヘッダー項目を追加するマクロのサンプルです。次の図のように、左側がマクロのコード、右側が使用例です（①②）。マクロを実行すると、カーソルの位置に”作成日”と日付を追記します。

マクロのコード部分は以下の通りです。

// ヘッダーの作成
InsText('作成日');    //作成日を張り付け
InsertDate();         //日付を張り付け
Char(13);             //改行文字入力

2つ目は、ネットワーク統計情報を取り込むサンプルです。次の図をご覧ください。こちらも、左側がマクロのコード、右側が使用例です（①②）。外部コマンドの”netstat”の結果を取り込むシンプルなマクロです。

ログの作成などは、Grepや置換などを関数呼び出しにより、さらにカスタマイズすると良いでしょう。

マクロのコード部分は以下の通りです。

// netstatの統計データを取り込む
ExecCommand('netstat /es', 1);

ここでは、サクラエディタのマクロの関連情報を紹介します。マクロのサンプルやマクロ集をお探しの方は、サクラエディタのフォーラムをのぞいてみると良いでしょう。「一般話題」や「マクロ掲示板」にスレッドが掲載されています。汎用で使えるものから特定用途まで多くのマクロが見つかるでしょう。

【参考】：OSDN サクラエディタ フォーラム

サクラエディタのマクロは登録するだけで作業効率が高まります

サクラエディタのマクロは、プログラムの生成したログを他のフォーマットに置き換えたり、定型文を挿入したりすることができます。キー操作や編集の効率向上が期待できます。

これらを踏まえて活用方法を考えると、業務全体の定型化と反復操作の効率を高めてくれるものとして利用価値が高く、おすすめできるエディタと言えるでしょう。

サクラエディタの正規表現まとめ！置換やGrepなど使い方と使用例

テキストエディターのおすすめは？選び方とおすすめ6選を紹介！