12.71 text.info - infoドキュメントアクセス

Module: text.info ¶

このモジュールは、texinfoシステムが生成する infoファイルから情報を抜き出す基本的な機能を提供します。 (texinfoについてはhttps://www.gnu.org/software/texinfo/参照)。 REPLのトップレベルコマンドinfoやdocはこのモジュールを 使っています(REPLでの開発)。 主にGaucheのドキュメントを扱うために作られたので、texinfoの全ての機能はカバーされていません。

Class: <info-document> ¶

{text.info} infoファイルの集合であるinfoドキュメントを表すオブジェクトです。 open-info-documentが返します。スロットは全てプライベートです。

Class: <info-node> ¶

{text.info} infoノードを表すオブジェクトです。ノードの内容と他のノードへの参照を持っています。 インスタンスは変更不可なオブジェクトとして扱われなければなりません。

<info-document>オブジェクトにinfo-get-nodeを適用することで ノードを得ることができます。

Instance Variable of <info-node>: name ¶

ノードの名前の文字列です。どのinfoドキュメントにも、最低限"Top"ノードは 含まれています。

Instance Variable of <info-node>: next ¶

「次」のノードの名前の文字列です。「次」をたどってゆくことで、ドキュメントの全ての ノードを見ることができます。 ドキュメントの最後のノードでは#fになっています。

Instance Variable of <info-node>: prev ¶

「前」のノードの名前の文字列です。「次」のノードとは逆のリンクになっています。 "Top"のノードの前は慣習により"(dir)"となっていて、 infoシステムではシステムにインストールされている全てのinfoドキュメントを表示する 特別なノード名となっています。

Instance Variable of <info-node>: up ¶

このノードが他のノードのサブノードなら、親となるノードの名前の文字列。 例えばこのノードが節(section)なら、親は章(chapter)です。 "Top"ノードではここは#fです。

Instance Variable of <info-node>: file ¶

このノードが含まれる<info-document>オブジェクトです。

Instance Variable of <info-node>: content ¶

ノードの内容の文字列です。

Function: open-info-document info-file-path ¶

{text.info} 指定されたパスのinfoドキュメントを読み込んで<info-document>インスタンスを 返します。引数はマスターinfoファイルのパス名で、通常.infoサフィックスが ついています。インストール状況によってはinfoファイルはgzipやbzip2で圧縮されていて、 .infoの後に.gzや.bz2がついていることもありますが、 これらの圧縮サフィックスはつける必要がありません。この手続きは指定のパス名そのものが 見つからなかったら圧縮サフィックスがついている名前も探します。

大きなinfoドキュメントは分割されていて、それぞれに.info-1、.info-2 などの名前がついていますが、それらは自動的に読まれるので、マスターとなるinfoファイルだけ 指定すれば良いです。

infoドキュメントが見つからなかったり、ファイルフォーマットが認識できなかった場合は エラーが投げられます。

Function: info-get-node info-doc node-name ¶

{text.info} <info-document>のインスタンスinfo-docから、 node-nameを持つノードを探して、その<info-node>インスタンスを返します。 該当するノードが見つからなければ#fを返します。

Function: info-index-add! info-doc index-node-name :optional key-modifier ¶

{text.info} infoドキュメントinfo-docにある、名前index-node-name持つノードを 読み取り、そのメニューの内容をインデックステーブルに加えます。

この手続きは、infoドキュメントの索引ノードを読み込んで索引を作るのに便利です。 例えば関数索引のページを読み込めば、関数名から定義があるノードを探し当てることができます。 典型的なinfoドキュメントでは、索引ページにはIndexという名前がついています。 但し、長いドキュメントでは索引がカテゴリごとに分けられていて、 それぞれ違う名前がついているかもしれません (Gaucheのユーザリファレンスもそのひとつです)。 この手続きをそれぞれの索引ノードについて呼び出すことで、複数の索引ノードの内容を 取り込むことができます。

省略可能なkey-modifier引数は、索引ノードのテーブルのキー(文字列)を取って 実際の見出しを文字列で返す手続きです。 しばしば索引に示されるキーは、実際の見出しとは異なることがあります。 例えばGaucheのクラス索引は、クラス名を囲む<と>を取り除いたものを キーとしています。実際の名前を使うと、全てのキーが<の下に集められてしまい あまり有用ではないからです。この場合は、key-modifierに (^e #"<~|e|>")を渡すことで、実際の名前で索引を引けるようになります。

同じキーに対応するエントリが複数ある場合、それらは全てテーブルに格納されます。 下のinfo-index-refを参照してください。

Function: info-index-ref info-doc key ¶

{text.info} キーに対応するエントリを索引テーブルから探し、 (node-name line-number)のリストを返します。

node-nameをinfo-node-getに渡せば定義を含んでいるinfoノードを 得られます。また、そのinfoノードとline-numberを info-extract-definitionに渡せば定義をテキストで得ることができます。

Function: info-index-keys info-doc ¶

{text.info} infoドキュメントの索引テーブルに登録されているキー(文字列)のリストを返します。

Function: info-index->alist info-doc ¶

{text.info} infoドキュメントの索引テーブルの内容を ((key (node line) ...) ...)の形で返します。

Function: info-parse-menu info-node ¶

{text.info} これはinfo-index-add!の中で使われている手続きですが、 単独でinfoノード中のメニューをパーズするのにも使えます。 * Menu:という行を探し、見つかったらそれに続く エントリ名とノード名を集めます。索引ページの場合はノード名だけでなく 定義のある行番号も記されています。

見つかったメニューエントリのリストを返します。各エントリは次の形です。

(<entry-name> <node-name> [<line-number>])

Function: info-extract-definition info-node start-line ¶

{text.info} ノードの内容から、ひとつの定義を抜き出して文字列で返します。 定義はstart-lineで示される行から始まっていると解釈されます。 その行から順に見てゆき、定義の終わりを探します。定義の終わりは、 infoノードの終わりか、3つ未満の空白文字で始まっている行の手前までです (但し、’defunx’形式の複数エントリは定義の終わりとはみなされません)。

定義を記述している文字列を返します。定義が見つからなければ空文字列が返ります。

典型的な使いかたは、まず索引ノードをinfo-index-add!で登録しておき、 info-index-refで知りたい見出しの定義を含むノードと行を入手して、 この手続きで実際の定義を得るというものです。