NYAGOS - The Nihongo Yet Another GOing Shell

English / Japanese

Lua拡張

nyagos では、EXE の本体の機能はコンパクトとし、便利機能はなるべく Lua で機能を拡張できるよう設計を進めています。現在は以下のような関数が使用できます。

`nyagos.alias.エイリアス名 = "置換コード"`

エイリアスを設定します。以下のマクロが使用可能です。

$1、$2、$3…$n - n番目の引数(引用符は削除されない)
$* - 全ての引数(引用符は削除されない)
$~1、$~2、$~3…$~n - n番目の引数(引用符は削除される)
$~* - 全ての引数(引用符は削除される)

`nyagos.alias.エイリアス名 = function(args)～end`

Lua 関数をエイリアスコマンドとして呼び出せるようにします。 args には全引数を格納したテーブルが入ります。

{
    [1]=第一引数,
    [2]=第二引数,
    [3]=第三引数,
        :
    ["rawargs"]={
        [1]=第一引数(引用符を除去していない),
        [2]=第二引数(引用符を除去していない),
        [3]=第三引数(引用符を除去していない),
            :
    }
}

エラーがあった時、関数は %ERRORLEVEL% に格納すべき「整数値」とエラーメッセージの二値を返さなくてはいけません。 (return なしの場合は「return 0,nil」と同じです)

戻り値が文字列や、文字列テーブルの場合、その文字列(テーブル)が新コマンドラインとして実行されます。

エイリアスは Lua の別のインスタンスで実行されるため、.nyagos で定義された変数は、共有テーブルshare[] を除いて、参照できません。 share[] はユーザが自由に使用可能ですが、全てのインスタンスで、ただちに同期されるのは share[] 直下のメンバーのみです。

`nyagos.env.環境変数名`

環境変数にリンクしています。参照・変更が可能です。

`nyagos.fields(TEXT)`

TEXT を空白で分割して、文字列のテーブルとして返します

`errorlevel,errormessage = nyagos.exec("シェルコマンド")`

`errorlevel,errormessage = nyagos.exec{"EXENAME","PARAM1","PARAM2"...}`

シェルコマンドを実行します。外部コマンドだけでなく、nyagos内蔵コマンドも呼び出せます。バッチファイルを呼び出した時、環境変数の変更も取り込めます。

エラーが発生した時、戻り値は %ERRORLEVEL% に格納すべき整数値とエラーメッセージが入ります。エラーが無い時は (0,nil) が戻ります。

`errorlevel,errormessage = nyagos.rawexec("外部コマンド名","引数1","引数2"…)`

`errorlevel,errormessage = nyagos.rawexec{"外部コマンド名","引数1","引数2"…}`

外部コマンドを実行します。OSの API を呼んでいるだけなので、nyagos 内蔵コマンドは使えませんが、動作は軽いです。

戻り値は %ERRORLEVEL% に格納すべき整数値とエラーメッセージが入ります。エラーが無い時は (0,nil) が戻ります。 (os.execute との違いは引数が UTF8 と解釈される点です)

`nyagos.eval("シェルコマンド")`

nyagos.exec と同じですが、標準出力を取り込んで、戻り値として返します。実行に失敗した場合などは nil が戻ります。

`OUTPUT,ERR = nyagos.raweval("外部コマンド名","引数1","引数2"…)`

`OUTPUT,ERR = nyagos.raweval{"外部コマンド名","引数1","引数2"…}`

外部コマンドを実行して、標準出力の内容を戻り値として返します。実行に失敗した場合は nil とエラーが戻ります。

`nyagos.write(テキスト)`

テキストを標準出力に出力しますが、リダイレクトされている場合は文字コードはUTF8 になります。内蔵 Lua の print は nyagos.write(テキスト..'\n') に差し替えられています。

`nyagos.writerr(テキスト)`

テキストを標準エラー出力に出力しますが、リダイレクトされている場合は文字コードはUTF8 になります。

`nyagos.getwd()`

現在のカレントディレクトリを返します。

`nyagos.chdir('DIRECTORY')`

カレントディレクトリを変更します。

`nyagos.utoa(UTF8文字列)`

UTF8文字列を、現在のコードページの文字列に変換します。

`nyagos.atou(ANSI文字列)`

現在のコードページの文字列を、UTF8 へ変換します。

`UTF8STRING = nyagos.atou_if_needed(STRING)`

STRING が適切な UTF8 文字列でない場合、それを現在のコードページの文字列とみなして UTF8 への変換を試みます。

`nyagos.glob(ワイルドカード文字列1,ワイルドカード文字列2,...)`

ワイルドカードを展開し、それらを格納したテーブルを返します。

`path = nyagos.pathjoin('パス1','パス2'...)`

パスの要素を連結して、一つのパスにします。

`path = nyagos.dirname('C:\\path\\to\\where')`

パスのディレクトリ部分を返します。例では C:\\path\\to が得られます。

`nyagos.envadd('ENVNAME','PATH'...)`

nyagos.envadd("PATH","C:\\path\\to") は set PATH=%PATH%;C:\path\to と等価です。ただし、%PATH% が既に C:\path\to を含んでいる時、 C:\path\to が存在しない場合は除きます。

例:

nyagos.envadd("PATH",
    "C:\\go\\bin",
    "C:\\TDM-GCC-64\\bin",
    "%ProgramFiles%\\Git\\bin",
    "%ProgramFiles%\\Git\\cmd",
    "%ProgramFiles(x86)%\\Git\\bin",
    "%ProgramFiles(x86)%\\Git\\cmd",
    "%ProgramFiles%\\Subversion\\bin",
    "%ProgramFiles(x86)%\\Subversion\\bin",
    "%VBOX_MSI_INSTALL_PATH%",
    "~\\Share\\bin",
    "~\\Share\\cmds")

`nyagos.envdel('ENVNAME','PATTERN')`

ENVNAME が示す環境変数の中から PATTERN を含む要素を削除します。

例：

nyagos.envdel("PATH",
    "Oracle","Lenovo","Skype","SQL Server",
    "TypeScript","WindowsApps",
    "Wbem","dotnet")

`nyagos.bindkey("キー名","機能名")`

`nyagos.key["キー名"] = "機能名"`

`nyagos.key.キー名 = "機能名"`

一行入力のキーに機能を割り当てます。

キー名として以下が使えます。

    "C_A" "C_B" ... "C_Z" "M_A" "M_B" ... "M_Z"
    "F1" "F2" ... "F24"
    "BACKSPACE" "CTRL" "DEL" "DOWN" "END"
    "ENTER" "ESCAPE" "HOME" "LEFT" "RIGHT" "SHIFT" "UP",
    "C_BREAK" "CAPSLOCK" "PAGEUP" "PAGEDOWN" "PAUSE"
    "C_HOME" "C_END" "C_PAGEUP" "C_PAGEDOWN"

機能名として以下が使えます。

    "BACKWARD_DELETE_CHAR" "BACKWARD_CHAR" "CLEAR_SCREEN" "DELETE_CHAR"
    "DELETE_OR_ABORT" "ACCEPT_LINE" "KILL_LINE" "UNIX_LINE_DISCARD"
    "FORWARD_CHAR" "BEGINNING_OF_LINE" "PASS" "YANK" "KILL_WHOLE_LINE"
    "END_OF_LINE" "COMPLETE" "PREVIOUS_HISTORY" "NEXT_HISTORY" "INTR"
    "ISEARCH_BACKWARD" "REPAINT_ON_NEWLINE"

成功すると true を、失敗すると nil とエラーメッセージを返します。大文字・小文字は区別せず、_ のかわりに - を使うことができます。

`nyagos.bindkey("キー名",function(this) ... end)`

`nyagos.key["キー名"] = function(this) ... end`

`nyagos.key.キー名 = function(this) ... end`

キーが押下された時、関数を呼び出します。引数 this は次のようなメンバーを持ったテーブルです。

this.pos … バイト数で数えたカーソル位置(先頭は 1 になります)
this.text … utf8 で表現された現在の入力テキスト
this:call("FUNCNAME") ... this.call("BACKWARD_DELETE_CHAR") のように機能を呼び出す
this:insert("TEXT") ... TEXT をカーソル位置に挿入します
this:firstword() ... コマンドラインの先頭の単語(コマンド名)を返します
this:lastword() ... コマンドラインの最後の単語とその位置を返します
this:boxprint({...}) ... テーブルの要素を補完候補リスト風に表示します
this:replacefrom(POS,"TEXT") ... POSからカーソルまでを TEXT と差替えます

また、戻り値は次のように使われます。

文字列の時: カーソル位置に挿入されます。
true の時: Enter が押下されたのと同様に入力を終結します
false の時: Ctrl-C が押下されたのと同様に内容を破棄して入力を終結します。
nil の時: 無視されます。

`nyagos.filter`

通常ユーザが呼び出すことはありません。当関数を定義すると、ユーザが入力したコマンドラインの内容を引数として NYAGOS.EXE から呼び出されます。これを加工して戻り値とすると、 NYAGOS.EXE はコマンドラインを、その文字列と置き換えます。

標準の nyagos.lua では nyagos.filter には、逆クォート機能を実現する関数が定義されています。処理内容としては nyagos.eval でコマンドの出力を取り込み、 nyagos.atou で UTF8 に変換して、NYAGOS.EXE に返しています。

`nyagos.argsfilter`

nyagos.argsfilter は nyagos.filter と似ていますが、コマンドラインを字句解析した後の、引数配列(args)を加工できる点が違います。

標準の nyagos.lua では nyagos.argsfilter を使って、 suffix というコマンドを作成しています。

コマンド
    suffix 拡張子 インタプリタ名 引数1 引数2 …
Lua:関数
    suffix("拡張子",{"インタプリタ名","引数1"…})

これはコマンドに特定の拡張子がついた時に、インタプリタ名を先頭に挿入するものです。

`s = nyagos.prompt(template)`

通常ユーザが直接呼び出すことはありません。引数のプロンプトのテンプレート(=%PROMPT%)を展開して、プロンプト文字列を生成して、戻り値として返す関数が格納されています。 (注意：4.4.13 までは、prompt 関数の中で表示し、文字の桁数を返す仕様でした)

ユーザはこれを横取りして独自のプロンプト表示を改造することができます。

nyagos.prompt = function(this)
    local title = "NYAGOS - ".. nyagos.getwd():gsub('\\','/')
    return nyagos.default_prompt('$e[40;36;1m'..this..'$e[37;1m',title)
end

nyagos.default_prompt はデフォルトのプロンプト生成関数です。第二引数でターミナルのタイトルを変更することができます。

`nyagos.gethistory(N)` もしくは `nyagos.history[N]`

N 番目のヒストリ内容を返します。N が負の時は現在から(-N)個過去のヒストリを返します。

`nyagos.gethistory()` もしくは `#nyagos.history`

ヒストリの総数を返します。

`nyagos.histsize`

ヒストリの、終了時に保存されるエントリ数の上限値を取得/変更します。

`nyagos.access(PATH,MODE)`

PATH で示されるファイルがアクセス可能かどうかを boolean 値で返します。 C言語の access 関数と同じです。

`RESULT = nyagos.box({ CHOICES... })`

ユーザがカーソルキーなどで選択した結果を得ます

`nyagos.complete_for["COMMAND"] = function(args) ... end`

コマンド毎の簡易補完フックです。

最初の単語が COMMAND の時に関数が呼び出されます。 args はカーソル前に存在する単語を格納する配列がセットされます。

例: goコマンドのサブコマンド補完

nyagos.complete_for.go = function(args)
    if #args == 2 then
        return {
            "build", "clean", "doc", "env", "fix", "fmt", "generate",
            "get", "install", "list", "mod", "run", "test", "tool",
            "version", "vet"
        }
    end
    return nil
end

関数はマッチしない単語を返すことができます。nyagos.exe が削除してくれます。nil を返した時、nyagos.exe は普通のファイル名補完を行います。

`nyagos.completion_hook = function(c) ... end`

補完のフックです。関数を代入してください。引数 c は下記のような要素を持つテーブルです。

c.list[1] .. c.list[#c.list] - コマンド名・ファイル名の補完候補
c.shownlist[1] .. c.shownlist[#c.shownlist] - 補完結果をリスト表示する際のテキスト(省略可能:代入用)
c.word - 補完元の単語(二重引用符を含まない)
c.rawword - 補完元の単語(二重引用符を含む場合がある)
c.pos - 補完元の単語の始まる位置(0起点)
c.text - コマンドラインの全文字列
c.field - c.text の空白で分割した文字列の配列
c.left - カーソルよりも左の文字列

nyagos.completion_hook は更新した候補リストのテーブルか nil を戻り値としてください。nil は、更新しない c.list と等価です。

`nyagos.completion_slash = true OR false`

true の時、ファイル名補完はデフォルトのパス区切り文字に / を使い、 false の時 \ が使われます。

`nyagos.on_command_not_found = function(args) ... end`

定義されていると、コマンドが見付からなかった時に呼び出されます。コマンド名とパラメータが args[0] ～ args[#args] にセットされます。関数が nil か false を返した場合は nyagos.exe は通常のエラーを表示します。

関数は別の Lua インスタンスで実行されるため、.nyagos で定義された変数へのアクセスはエイリアス同様の制限があります。

`WIDTH,HEIGHT = nyagos.getviewwidth()`

ターミナルの横幅と高さを返します。

`STAT = nyagos.stat(FILENAME)`

ファイルの情報を返します。ファイルが存在する時、テーブル STAT は下記のようなメンバーを持ちます。

STAT.name
STAT.isdir (ディレクトリなら true, さもなければ false)
STAT.size  (バイト数)
STAT.mtime.year
STAT.mtime.month
STAT.mtime.day
STAT.mtime.hour
STAT.mtime.minute
STAT.mtime.second

ファイルがない時、STAT は nil です。

`nyagos.getkey()`

入力されたキーの、Unicode、スキャンコード、シフト状態を返します。

`nyagos.open(PATH,MODE)`

PATH が utf8 と解釈される以外は io.open と等価です。

`nyagos.loadfile(PATH)`

PATH が UTF8 と解釈される以外は、通常の loadfile と等価です。

`nyagos.lines(PATH)`

PATH が UTF8 と解釈される以外は、通常の io.lines と等価です。

for text in nyagos.lines(PATH) do ... end

text は UTF8 変換などはなく、io.lines 同様、ただのバイト列です

`OLEOBJECT = nyagos.create_object('SERVERNAME.TYPENAME')`

OLEオブジェクトを作成します。OLEオブジェクトはメソッド・プロパティーを持ちます。

メソッド
- OLEOBJECT:METHOD(PARAMETERS).
プロパティ
- value = OLEOBJECT:_get('PROPERTYNAME')
- OLEOBJECT:_set('PROPERTYNAME',value)
その他
- OLEOBJECT:_iter() : コレクションのイタレーターを得る
- OLEOBJECT:_release() COM-instanceを解放する

`INTEGER_FOR_OLE = nyagos.to_ole_integer(10)`

実数を OLE オブジェクトへのパラメータに使える整数にコンバートします。この関数は nyagos.d/trash.lua のために作られました。

`nyagos.option.glob`

true の時、外部コマンドに対するワイルドカード展開を有効にします。

`nyagos.option.noclobber`

true の時、リダイレクトによる既存ファイルの上書きを禁止します。リダイレクト記号の >| と >! は nyagos.option.noclobber が true の時でもファイルの上書きができます。

`nyagos.option.usesource`

true の時(デフォルト)、バッチファイルで NYAGOS の環境変数が変更できるようになります。false の場合、バッチファイルから環境変数の変更を読みとるには source コマンドを使う必要があります。

`nyagos.option.cleaup_buffer`

true の場合、一行入力の前に入力バッファをクリアします。

`nyagos.option.predict_color`

入力予測機能の色を設定します。

例: nyagos.option.predict_color = "\027[0;31;1m" (赤)

`nyagos.goversion`

ビルドに使用した Go のバージョン文字列が格納されます。 (例：「go1.6」)

`nyagos.goarch`

実行ファイルが想定している CPU アーキテクチャを示す文字列が格納されます。 (例：「386」「amd64」)

`nyagos.goos`

OS名 (windows or linux)

`nyagos.preexechook`

コマンド実行前のフックです。

登録

nyagos.preexechook = function(args)
    io.write("Call ")
    for i=1,#args do
        io.write("[" .. args[i] .. "]")
    end
    io.write("\n")
end

解除

nyagos.preexechook = nil

`nyagos.postexechook`

コマンド実行後のフックです。

登録

nyagos.postexechook = function(args)
    io.write("Done ")
    for i=1,#args do
        io.write("[" .. args[i] .. "]")
    end
    io.write("\n")
end

解除

nyagos.postexechook = nil

`nyagos.exe`

nyagos.exe のフルパスが格納されています。

`nyagos.skk`

SKK のセットアップを行います。

nyagos.skk{
    user="~/.go-skk-jisyo" , -- ユーザ辞書
    "~/Share/Etc/SKK-JISYO.L", -- システム辞書
    "~/Share/Etc/SKK-JISYO.emoji",-- システム辞書
    ctrlj="C-J", -- 日本語切り替えキー(省略時は Ctrl-J)
}

`nyagos.shellexecute(ACTION,PATH,PARAM,DIRECTORY)`

管理者モードで実行ファイルを起動します。

ACTION … runas を指定します(他に open, properties などが選択できます)
PATH … 起動する実行ファイルのパスを指定します
PARAM … 起動コマンドへのパラメータを指定します
DIRECTORY … コマンドを実行する時のカレントディレクトリを指定します

NYAGOS - The Nihongo Yet Another GOing Shell

Lua拡張

nyagos.alias.エイリアス名 = "置換コード"

nyagos.alias.エイリアス名 = function(args)～end

nyagos.env.環境変数名

nyagos.fields(TEXT)

errorlevel,errormessage = nyagos.exec("シェルコマンド")

errorlevel,errormessage = nyagos.exec{"EXENAME","PARAM1","PARAM2"...}

errorlevel,errormessage = nyagos.rawexec("外部コマンド名","引数1","引数2"…)

errorlevel,errormessage = nyagos.rawexec{"外部コマンド名","引数1","引数2"…}

nyagos.eval("シェルコマンド")

OUTPUT,ERR = nyagos.raweval("外部コマンド名","引数1","引数2"…)

OUTPUT,ERR = nyagos.raweval{"外部コマンド名","引数1","引数2"…}

nyagos.write(テキスト)

nyagos.writerr(テキスト)

nyagos.getwd()

nyagos.chdir('DIRECTORY')

nyagos.utoa(UTF8文字列)

nyagos.atou(ANSI文字列)

UTF8STRING = nyagos.atou_if_needed(STRING)

nyagos.glob(ワイルドカード文字列1,ワイルドカード文字列2,...)

path = nyagos.pathjoin('パス1','パス2'...)

path = nyagos.dirname('C:\\path\\to\\where')

nyagos.envadd('ENVNAME','PATH'...)

nyagos.envdel('ENVNAME','PATTERN')

nyagos.bindkey("キー名","機能名")

nyagos.key["キー名"] = "機能名"

nyagos.key.キー名 = "機能名"

nyagos.bindkey("キー名",function(this) ... end)

nyagos.key["キー名"] = function(this) ... end

nyagos.key.キー名 = function(this) ... end

nyagos.filter

nyagos.argsfilter

s = nyagos.prompt(template)

nyagos.gethistory(N) もしくは nyagos.history[N]

nyagos.gethistory() もしくは #nyagos.history

nyagos.histsize

nyagos.access(PATH,MODE)

RESULT = nyagos.box({ CHOICES... })

nyagos.complete_for["COMMAND"] = function(args) ... end

nyagos.completion_hook = function(c) ... end

nyagos.completion_slash = true OR false

nyagos.on_command_not_found = function(args) ... end

WIDTH,HEIGHT = nyagos.getviewwidth()

STAT = nyagos.stat(FILENAME)

nyagos.getkey()

nyagos.open(PATH,MODE)

nyagos.loadfile(PATH)

nyagos.lines(PATH)

OLEOBJECT = nyagos.create_object('SERVERNAME.TYPENAME')

INTEGER_FOR_OLE = nyagos.to_ole_integer(10)

nyagos.option.glob

nyagos.option.noclobber

nyagos.option.usesource

nyagos.option.cleaup_buffer

nyagos.option.predict_color

nyagos.goversion

nyagos.goarch

nyagos.goos

nyagos.preexechook

登録

解除

nyagos.postexechook

登録

解除

nyagos.exe

nyagos.skk

nyagos.shellexecute(ACTION,PATH,PARAM,DIRECTORY)

目次

リリースノート