「API/Shell」の編集履歴（バックアップ）一覧はこちら
「API/Shell」(2014/01/01 (水) 11:35:33) の最新版変更点
追加された行は緑色になります。
削除された行は赤色になります。
このページでは Shell API について解説する。
参考資料：
-[[Shell API>http://computercraft.info/wiki/Shell_%28API%29]]
執筆時のバージョン：
-ComputerCraft 1.55 for Minecraft 1.6.2
----
#contents
----
*Shell API
シェル（ユーザーインターフェース）プログラムに関するAPI。
**exit
-shell.exit()
-現在実行中のシェルを終了する
-戻り値：nil
トップレベルのシェルを終了した場合、コンピュータはシャットダウンされる。
**dir
-shell.dir()
-カレントディレクトリのパスを取得する
-戻り値：文字列型。カレントディレクトリのパス
ルートディレクトリは""（サイズ0文字列）。
**setDir
-shell.setDir( &italic(){path} )
-カレントディレクトリを絶対パス&italic(){path}（文字列）に設定する
-戻り値：nil
未作成のディレクトリでも設定できる。
例：
shell.setDir( "rom" )
カレントディレクトリをromに変更する。
**path
-shell.path()
-ファイルの検索対象となるパスを取得する
-戻り値：文字列型。ファイルの検索対象となるパス
いわゆる環境変数PATHに相当する文字列を取得する。戻り値には複数のパスが含まれている可能性があり、":"（コロン）で区切られている。
Computer：
.:/rom/programs:/rom/programs/computer
Advanced Computer：
.:/rom/programs:/rom/programs/computer:/rom/programs/color
Turtle：
.:/rom/programs:/rom/programs/turtle
Advanced Turtle：
.:/rom/programs:/rom/programs/turtle:/rom/programs/color
※HTTP APIが有効な場合は、上記各パスに :/rom/programs/http が追加される
**setPath
-shell.setPath( &italic(){path} )
-ファイルの検索対象となるパスを&italic(){path}（文字列）に設定する
-戻り値：nil
検索対象のパスを&italic(){path}で上書きする。任意のパスを追加する場合は、shell.path関数で取得した文字列の後ろに":"（区切り記号、コロン）＋追加パスの形で追加する。
**resolve
-shell.resolve( &italic(){localpath} )
-パス&italic(){localpath}（文字列）を絶対パスにして返す
-戻り値：文字列型。変換された絶対パス
&italic(){localpath}をカレントディレクトリからの相対パスと見なし、絶対パスに変換して返す。ただし、&italic(){localpath}が"/"または"\\"で始まる場合は、&italic(){localpath}自体が絶対パスとして扱われ、戻り値は単に&italic(){localpath}から先頭の"/"や"\\"を削除したものとなる。
**resolveProgram
-shell.resolveProgram( &italic(){name} )
-エイリアス（プログラムの短縮名）や検索対象となるディレクトリからプログラム名（ファイル名）&italic(){name}（文字列）を検索し、&italic(){name}が見つかった場合はその絶対パスを返す。
-戻り値：文字列型。&italic(){name}の絶対パス。見つからなかった場合はnil
まず始めに、&italic(){name}をエイリアスのリストから検索する。次に、&italic(){name}がエイリアスだった場合はエイリアスに登録された本来のプログラム名を、エイリアスでなかった場合は&italic(){name}自体をプログラムの相対パスと見なし、検索対象となるディレクトリから検索する。ただし、エイリアスの本来のプログラム名または&italic(){name}が"/"または"\\"で始まる場合は、それを絶対パスと見なしてそのパスだけを検索する。
検索対象となるディレクトリはshell.path関数で得られ、shell.setPath関数を使えば任意に変更できる。
shell.run関数やシェル上（プロンプト">"に続いてプログラム名と引数を入力してEnterを押す）からプログラムを実行する時にも、入力したプログラム名を絶対パスに変換するために使われている。
例：
print( shell.resolveProgram( "hello" ) )
プログラムhelloを検索し、絶対パスを表示する。Computerの場合は"rom/programs/computer/hello"と表示される。Turtleの場合は見つからないので何も表示されない。
**programs
-shell.programs( [ &italic(){hidden} ] )
-検索対象となるディレクトリにある全てのファイルの名前を取得する。&br()&italic(){hidden}（ブーリアン）がtrueの場合は隠しファイルも対象となる。省略あるいはfalseの場合は隠しファイルを無視する
-戻り値：テーブル型。キーは1以上の整数、値は見つかったファイル名（文字列）。昇順ソートされている
隠しファイルとは名前が"."で始まるファイルのこと。
検索対象となるディレクトリはshell.path関数で得られ、shell.setPath関数を使えば任意に変更できる。
**aliases
-shell.aliases()
-エイリアス（プログラムの短縮名）のリストを取得する
-戻り値：テーブル型。キーはエイリアス（文字列）、値は実際に実行されるプログラム名（文字列）
**setAlias
-shell.setAlias( &italic(){alias}, &italic(){program} )
-&italic(){alias}（文字列）をプログラム&italic(){program}（文字列）のエイリアス（短縮名）として設定する
-戻り値：nil
エイリアスのエイリアスを指定することはできない（&italic(){program}はプログラム名）。
例：
shell.setAlias("start", "startup")
プログラムstartupのエイリアスとしてstartを設定する。
**clearAlias
-shell.clearAlias( &italic(){alias} )
-設定されているエイリアス（プログラムの短縮名）&italic(){alias}（文字列）をクリアする
-戻り値：nil
例：
shell.clearAlias("start")
エイリアスstartをクリアする。
**run
-shell.run( &italic(){program} [, &italic(){...}] )
-プログラム&italic(){program}（文字列）を実行する。2番目以降の引数&italic(){...}（文字列）でプログラムに渡される引数を指定できる
-戻り値：ブーリアン型。成功したらture、失敗したらfalse
プログラム名&italic(){program}をshell.resolveProgram関数を使って絶対パスに変換してから[[os.run関数>API/OS#id_722d6494]]で実行している。
プログラム側では可変引数&italic(){...}で実行時に指定した引数を受け取ることができる。ただし引数は全て文字列として渡されるため、数値はtonumber関数で数値型に戻す必要がある。
例：
shell.run("myprogram", "test", "ing")
プログラムmyprogramを引数に"test"と"ing"を指定して実行する。
**getRunningProgram
-shell.getRunningProgram()
-現在実行しているプログラムのパスを取得する
-戻り値：文字列型。実行しているプログラムの絶対パスが返る
このページでは Shell API について解説する。
参考資料：
-[[Shell API>http://computercraft.info/wiki/Shell_%28API%29]]
執筆時のバージョン：
-ComputerCraft 1.55 for Minecraft 1.6.2
----
#contents
----
*Shell API
シェル（ユーザーインターフェース）プログラムに関するAPI。
assets\computercraft\lua\rom\programs\shell で定義
**exit
-shell.exit()
-現在実行中のシェルを終了する
-戻り値：nil
トップレベルのシェルを終了した場合、コンピュータはシャットダウンされる。
**dir
-shell.dir()
-カレントディレクトリのパスを取得する
-戻り値：文字列型。カレントディレクトリのパス
ルートディレクトリは""（サイズ0文字列）。
**setDir
-shell.setDir( &italic(){path} )
-カレントディレクトリを絶対パス&italic(){path}（文字列）に設定する
-戻り値：nil
未作成のディレクトリでも設定できる。
例：
shell.setDir( "rom" )
カレントディレクトリをromに変更する。
**path
-shell.path()
-ファイルの検索対象となるパスを取得する
-戻り値：文字列型。ファイルの検索対象となるパス
いわゆる環境変数PATHに相当する文字列を取得する。戻り値には複数のパスが含まれている可能性があり、":"（コロン）で区切られている。
デフォルトの値は assets\computercraft\lua\rom\startup で定義
Computer：
.:/rom/programs:/rom/programs/computer
Advanced Computer：
.:/rom/programs:/rom/programs/computer:/rom/programs/color
Turtle：
.:/rom/programs:/rom/programs/turtle
Advanced Turtle：
.:/rom/programs:/rom/programs/turtle:/rom/programs/color
※HTTP APIが有効な場合は、上記各パスに :/rom/programs/http が追加される
**setPath
-shell.setPath( &italic(){path} )
-ファイルの検索対象となるパスを&italic(){path}（文字列）に設定する
-戻り値：nil
検索対象のパスを&italic(){path}で上書きする。任意のパスを追加する場合は、shell.path関数で取得した文字列の後ろに":"（区切り記号、コロン）＋追加パスの形で追加する。
**resolve
-shell.resolve( &italic(){localpath} )
-パス&italic(){localpath}（文字列）を絶対パスにして返す
-戻り値：文字列型。変換された絶対パス
&italic(){localpath}をカレントディレクトリからの相対パスと見なし、絶対パスに変換して返す。ただし、&italic(){localpath}が"/"または"\\"で始まる場合は、&italic(){localpath}自体が絶対パスとして扱われ、戻り値は単に&italic(){localpath}から先頭の"/"や"\\"を削除したものとなる。
**resolveProgram
-shell.resolveProgram( &italic(){name} )
-エイリアス（プログラムの短縮名）や検索対象となるディレクトリからプログラム名（ファイル名）&italic(){name}（文字列）を検索し、&italic(){name}が見つかった場合はその絶対パスを返す。
-戻り値：文字列型。&italic(){name}の絶対パス。見つからなかった場合はnil
まず始めに、&italic(){name}をエイリアスのリストから検索する。次に、&italic(){name}がエイリアスだった場合はエイリアスに登録された本来のプログラム名を、エイリアスでなかった場合は&italic(){name}自体をプログラムの相対パスと見なし、検索対象となるディレクトリから検索する。ただし、エイリアスの本来のプログラム名または&italic(){name}が"/"または"\\"で始まる場合は、それを絶対パスと見なしてそのパスだけを検索する。
検索対象となるディレクトリはshell.path関数で得られ、shell.setPath関数を使えば任意に変更できる。
shell.run関数やシェル上（プロンプト">"に続いてプログラム名と引数を入力してEnterを押す）からプログラムを実行する時にも、入力したプログラム名を絶対パスに変換するために使われている。
例：
print( shell.resolveProgram( "hello" ) )
プログラムhelloを検索し、絶対パスを表示する。Computerの場合は"rom/programs/computer/hello"と表示される。Turtleの場合は見つからないので何も表示されない。
**programs
-shell.programs( [ &italic(){hidden} ] )
-検索対象となるディレクトリにある全てのファイルの名前を取得する。&br()&italic(){hidden}（ブーリアン）がtrueの場合は隠しファイルも対象となる。省略あるいはfalseの場合は隠しファイルを無視する
-戻り値：テーブル型。キーは1以上の整数、値は見つかったファイル名（文字列）。昇順ソートされている
隠しファイルとは名前が"."で始まるファイルのこと。
検索対象となるディレクトリはshell.path関数で得られ、shell.setPath関数を使えば任意に変更できる。
**aliases
-shell.aliases()
-エイリアス（プログラムの短縮名）のリストを取得する
-戻り値：テーブル型。キーはエイリアス（文字列）、値は実際に実行されるプログラム名（文字列）
**setAlias
-shell.setAlias( &italic(){alias}, &italic(){program} )
-&italic(){alias}（文字列）をプログラム&italic(){program}（文字列）のエイリアス（短縮名）として設定する
-戻り値：nil
エイリアスのエイリアスを指定することはできない（&italic(){program}はプログラム名）。
例：
shell.setAlias("start", "startup")
プログラムstartupのエイリアスとしてstartを設定する。
**clearAlias
-shell.clearAlias( &italic(){alias} )
-設定されているエイリアス（プログラムの短縮名）&italic(){alias}（文字列）をクリアする
-戻り値：nil
例：
shell.clearAlias("start")
エイリアスstartをクリアする。
**run
-shell.run( &italic(){program} [, &italic(){...}] )
-プログラム&italic(){program}（文字列）を実行する。2番目以降の引数&italic(){...}（文字列）でプログラムに渡される引数を指定できる
-戻り値：ブーリアン型。成功したらture、失敗したらfalse
プログラム名&italic(){program}をshell.resolveProgram関数を使って絶対パスに変換してから[[os.run関数>API/OS#id_722d6494]]で実行している。
プログラム側では可変引数&italic(){...}で実行時に指定した引数を受け取ることができる。ただし引数は全て文字列として渡されるため、数値はtonumber関数で数値型に戻す必要がある。
例：
shell.run("myprogram", "test", "ing")
プログラムmyprogramを引数に"test"と"ing"を指定して実行する。
**getRunningProgram
-shell.getRunningProgram()
-現在実行しているプログラムのパスを取得する
-戻り値：文字列型。実行しているプログラムの絶対パスが返る
