いろいろなプログラミング言語を利用していると、
同じような機能の関数の名前が言語間で異なることがしばしばあります。
ブラウザを立ち上げてドキュメントを探して、としても良いかもしれませんが、
ちょっとど忘れした名前を調べるだけならば、使っている処理系に問いあわせるだけで
目的を達成できそうです。
ということで、各処理系でのヘルプ機能を調べてみました。
Ruby
Rubyのオブジェクトにはメソッドやメンバ変数の一覧を取得するメソッドが備わっています。
- methods メソッドを返す
- public_methods publicなメソッドを返す
- private_methods privateなメソッドを返す
- protected_methods protectedなメソッドを返す
- instance_methods メソッドを返す
- included_modules インクルードしているモジュールを返す
- constants 定数名を返す
- instance_variables インスタンス変数名を返す
xxx_methods系の戻り値の各要素は、1.8系だと文字列、1.9系だとシンボルだそうです。
> String.instance_methods.grep /upcase/
#=> ["upcase!", "upcase"]
Python
Pythonには情報を表示するhelp関数が存在します。
モジュールやクラスなどを指定できるようです。
> help(__builtins__)
> help(str)
> help("print")
また、inspectモジュールをインポートするとgetmembers関数で
メンバ一覧を取得できるようになるので、メソッドを検索することもできます。
> import inspect
> import re
> for (name, _) in inspect.getmembers(str):
... if re.search("up", name):
... print name
...
isupper
upper
inspectモジュールには関数の定義ファイルやソースコードを取得する関数もあるようです。
> inspect.getfile(inspect.getfile)
'/usr/lib/python2.6/inspect.py'
> inspect.getsource(inspect.getsource)
...
Common Lisp
Common Lisp処理系は、関数や変数を検索するapropos関数を備えています。
apropos関数は検索するパッケージを指定することができるので、
COMMON-LISPパッケージ(CLパッケージ)を指定することで仕様に存在する関数のみを検索する、
ということも可能です(指定しない場合はすべてのパッケージが対象)
- apropos 関数や変数を検索する。パッケージを指定できる。
- apropos-list 関数や変数を検索しリストにして返す。パッケージを指定できる。
;; SBCL
> (apropos "upcase" :cl)
CHAR-UPCASE (fbound)
NSTRING-UPCASE (fbound)
STRING-UPCASE (fbound)
パッケージ一覧やシンボル一覧を取得する方法もあります。
- list-all-packages すべてのパッケージを返す
- do-all-symbols すべてのシンボルを処理するためのループを実行するマクロ
- do-external-symbols パッケージ外部に公開されているシンボルを処理するためのループを実行するマクロ
- *features* 有効な機能一覧を格納している変数
オブジェクトの情報を表示するdescribe関数、
情報の表示を対話的に行うinspect関数といった機能があります。
また、Common Lispでは関数や変数の定義にドキュメントを含めることができ、
documentation関数でそのドキュメントを取得することができます。
Racket
Scheme処理系のRacketは、REPL(インタプリタ)にhelpと打ち込むと
インストールされているドキュメントを既定のブラウザで開いてくれます。
また、xreplというライブラリを読み込むことでREPLに機能を追加してくれます。
追加されるヘルプ機能は以下のとおりです。
- apropos 関数や変数を検索する
- describe 関数や変数がどこで定義されたかを表示する
- doc 指定した関数のドキュメントを既定のブラウザで表示する
> (require xrepl)
> ,apropos upcase
; Matches: char-upcase, string-locale-upcase, string-upcase.
> ,describe string-upcase
; `string-upcase' is a bound identifier,
; defined in #%kernel
; required through "racket/init.rkt"
> ,doc string-upcase
Sending to web browser...
file: c:\Program Files (x86)\Racket\doc\reference\strings.html
anchor: (def._((quote._~23~25kernel)._string-upcase))
Gauche
Scheme処理系のGaucheは、関数や変数を探すapropos関数を備えています。
> (apropos 'upcase)
char-upcase (scheme)
;; 文字列処理を行うSRFI-13ライブラリを読み込む
> (use srfi-13)
#<undef>
> (apropos 'upcase)
char-upcase (scheme)
string-upcase (srfi-13)
string-upcase! (srfi-13)
オブジェクトの情報を表示したい場合は、describe関数が使えます。
Guile
GNUのScheme処理系Guileは、関数や変数を探すapropos関数を備えています。
> (apropos "upcase")
(guile): char-upcase #<primitive-procedure char-upcase>
(guile): string-upcase! #<primitive-procedure string-upcase!>
(guile): string-upcase #<primitive-procedure string-upcase>
Chicken
Scheme処理系のChickenは、utilsライブラリを読み込むことで
関数や変数を検索するapropos関数が利用できるようになります。
> (require 'utils)
> (apropos 'upcase)
char-upcase : (procedure c692)
> (require 'srfi-13)
> (apropos 'upcase)
char-upcase : (procedure c692)
string-upcase : (procedure s694 . maybe-start+end695)
string-upcase! : (procedure s698 . maybe-start+end699)
Clojure
JVM上のLisp系言語であるClojureは、関数や変数の検索、ドキュメントや
ソースコードの表示といったヘルプ機能を備えているようです。
- doc ドキュメントを表示する
- source ソースコードを表示する
- find-doc ドキュメントを検索する
- apropos 関数名を検索する
Emacs Lisp
Emacsの拡張言語であるEmacs Lispにはさまざまなヘルプ機能があります。
多すぎるのでよく使っているもののみを列挙します。
- apropos 関数名や変数名を検索する
- help-for-help ヘルプ(デフォルトでC-hに割り当てられているコマンド)
- find-function 関数の定義位置へ移動する
- find-variable 変数の定義位置へ移動する
