最終更新日 2024-09-25

hmV8のTypeScript型定義ファイルの生成

概要

hmV8用のマクロは、ECMAScript6で記述しても良いですが、
TypeScriptで記述する、という選択肢が最有力となります。

TypeScriptを利用して記述していくにしろ、 ECMAScriptで記述するにせよ、
hmV8のAPIの部分の入力補完を実現したいものです。

TypeScriptの型定義ファイルの機能を利用することで、
Visual StudioやVisual Studio Code等のなどモダンな主要環境であれば、 補完環境を利用出来ます。

ダウンロード

更新日 2022/02/28
hmV8.d.zip

hmV8のTypeScript型定義ファイルの例

以下のソースコードは、先述のダウンロードファイル(hmV8.d.ts)の内容そのままとなります。
本来のhmV8の内部の定義構造や型情報とは全く異なりますが、
「入力補完」や「常識的記述の範疇のチェック」であれば便利に使えるかと思います。

hmV8.d.ts のソースコード内容そのまま
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
declare var clr: any;
  
declare namespace host {
    function lib(libname: string): any;
    function lib(libns: any, libname: string): any;
    function newComObj(progID: string, serverName?: string): any;
}
  
  
  
declare namespace hm {
  
    /**
     * 秀丸のバージョン。
     */
    const version: number;
  
    /**
     * デバッグモニタへの出力。console.logと同じ。
     */
    function debuginfo(message?: any, ...optionalParams: any[]): void;
  
    namespace File {
        interface IEncoding {
            readonly HmEncode: number;
            readonly MsCodePage: number;
        }
  
        interface IHidemaruStreamReader {
            readonly FilePath: string;
            readonly Encoding: IEncoding;
            Read(): string;
            Close(): void;
        }
  
        /**
         * 対象の外部ファイルを秀丸で「はじめて」オープンした際、あなたの設定の秀丸だとどのような文字コードだと判定するか
         */
        function GetEncoding(filepath: string): IEncoding;
  
        /**
         * 対象の外部ファイルを秀丸で「はじめて」オープンした際、あなたの設定の秀丸で開いた時と同じ状態でオープン
         */
        function Open(filepath: string, hm_encode?: number): IHidemaruStreamReader;
    }
  
    namespace Macro {
  
        /**
         * 複数の秀丸マクロをヒアドキュメント的に記述するための特殊な関数表記の型。
         */
        type TFnExpression = (f: any) => void;
  
        /**
         * 秀丸マクロを実行。
         */
        function Eval(expression: string | TFnExpression): {
            readonly Result: number;
            readonly Message: string;
            readonly Error: {
                readonly Message: string;
            }
        };
  
        /**
         * 秀丸マクロの変数の読み書きのための型。関数のような表記と連想配列のような表記。
         */
        interface TVar {
            (key: string): number | string;
            (key: string, value: any): void;
            [key: string]: any;
        }
  
        /**
         * 秀丸マクロの変数の読み書き。
         */
        let Var: TVar;
 
        interface IStatementResult {
            Result :number;
            Args: object[];
            Error: { readonly Message: string };
            Message: string;
        }
        /**
         * ステートメントの実行
         */
        let Statement: any;
 
        interface IFunctionResult {
            Result :number | string;
            Args: object[];
            Error: { readonly Message: string };
            Message: string;
        }
        /**
         * 関数の実行
         */
         let Function: any;
    }
  
    namespace Edit {
  
        /**
         * 編集中のテキスト内容の読み書き
         */
        let TotalText: string;
  
        /**
         * 通常選択や行選択のテキスト内容の読み書き
         */
        let SelectedText: string;
  
        /**
         * カーソル行のテキスト内容の読み書き
         */
        let LineText: string;
  
        /**
         * カーソルの位置
         */
        const CursorPos: {
            readonly column: number;
            readonly lineno: number;
        };
  
        /**
         * マウスの位置に対応するカーソルの位置
         */
        const MousePos: {
            readonly column: number;
            readonly lineno: number;
            readonly x: number;
            readonly y: number;
        };
    }
 
    namespace OutputPane {
  
        /**
         * アウトプット枠への出力
         */
         function Output(message: string): number;
  
        /**
         * 一時退避
         */
         function Push(): number;
 
        /**
         * 復元
         */
         function Pop(): number;
 
         /**
         * クリア
         */
          function Clear(): number;
 
         /**
         * アウトプット枠へのコマンド実行
         */
          function SendMessage(command_id: number): number;
 
         /**
         * ベースディレクトリの設定
         */
          function SetBaseDir(dirpath: string): number;
    }
 
    namespace ExplorerPane {
 
        /**
         * ファイルマネージャ枠のモードの設定
         */
         function SetMode(mode: number): number;
  
        /**
         * ファイルマネージャ枠のモードの取得
         */
         function GetMode(): number;
 
        /**
         * ファイルマネージャ枠に指定のファイルのプロジェクトを読み込む
         */
         function LoadProject(filename: string): number;
 
        /**
         * ファイルマネージャ枠のプロジェクトを指定ファイルに保存
         */
         function SaveProject(filename: string): number;
 
        /**
         * ファイルマネージャ枠にプロジェクトを読み込んでいるならば、そのファイルパスを取得する(読み込んでいなければNoneが返る)
         */
         function GetProject(): string;
 
        /**
         * ファイルマネージャ枠にメッセージを送る
         */
         function SendMessage(command_id: number): number;
 
        /**
         * ファイルマネージャ枠が「プロジェクト」表示のとき、更新された状態であるかどうかを返します
         */
         function GetUpdated(): number;
 
        /**
         * ファイルマネージャ枠のカレントディレクトリを返す
         */
         function GetCurrentDir(): string;
    }
}
  
interface Console {
    assert(test?: boolean, message?: string, ...optionalParams: any[]): void;
    log(message?: any, ...optionalParams: any[]): void;
}
  
declare var console: Console;

hmV8のTypeScript型定義ファイルの使用例

Visual Studio、あるいは、Visual Studio Codeなど、モダンなエディタであれば、
TypeScriptの「トリプルスラッシュ・ディレクティブ」機能であるreference pathを利用することで、補完が効くようになります。

test.tsなどとして、
1
2
3
/// <reference path="hmV8.d.ts"/>
 
let lineno: number = hm.Macro.Var["lineno"];