adabrowse - クラウド上のオンライン

プログラム：

NAME

adabrowse - Ada 95 仕様の完全に相互参照された HTML レンダリングを生成します

SYNOPSIS

アドブラウズ [オプション] -f file

DESCRIPTION

アドブラウズ Ada 95 仕様の完全に相互参照された HTML レンダリングを生成します (本文なし)。
これは、javadoc が Java ソースに対して行うことと同様です。 アドブラウズ コマンドラインユーティリティです。 それは持っています
グラフィカルユーザーインターフェイスはありません。

アドブラウズ コマンドライン オプション、スタイル シート、および
設定ファイル

アドブラウズ ソースコードを完全に分解し、HTMLドキュメントを生成します。
含む：
· すべてのコンテキスト句
・ユニットヘッダー
· ユニットがパッケージの場合:
— すべての例外 (名前変更を含む)
— すべての定数
— すべての変数
— すべての型とその基本的な操作を含む型インデックス (後者のみ)
(タグ付き) レコード タイプ、プライベート タイプ、およびそれらから派生したタイプ)。 の
プリミティブ操作リストは完全に相互参照され、新しく定義された順に並べられます。
オーバーライドおよび継承された操作。
— その他の項目

USAGE

使用する方法はXNUMXつあります アドブラウズ:

1。 コール アドブラウズ あなたの仕様のために： アドブラウズ -f file (必要に応じてその他のオプションも
特定の -I ファイルが現在のディレクトリにない場合、または他のユニットに依存している場合
ソースが現在のディレクトリにありません!) 指定されたユニットのツリー ファイルがない場合
存在し、 アドブラウズ 生成しようとします。

or

1. を呼び出して、処理する仕様のツリー ファイルを生成します。 ぶよぶよ -c -gnatc
-ブヨ file (適切な -I 必要に応じてオプションを追加します。)

2。 コール アドブラウズ これらの仕様の場合: アドブラウズ -f file (必要に応じてその他のオプションも
[特に見てください -T!])。

アドブラウズ は、デフォルトで現在のディレクトリに HTML ファイルを生成します。

アドブラウズ ツリー ファイルがスペックから生成されたかボディから生成されたかは関係ありません。
本体のツリー ファイルには常に仕様に関する情報も含まれているため、
どちらかを使用して作業します。

OPTIONS

-h, -?, -助けて, - 助けて
包括的なヘルプ テキストを作成します。

-a, -すべて, - すべて
-f オプションで指定したユニットだけでなく、すべてのユニットの HTML を生成します。
意味的に依存するアプリケーション単位 (「with」の推移閉包)
および親ユニット）。

このオプションは推移的なアプリケーション ユニットのみを処理することに注意してください。
「-g」オプションも指定されている場合でもクロージャー。 「with」されたものは処理しません
標準ライブラリユニット。 これは、指定されたユニットが標準ライブラリである場合にも意味します。
ユニットでは、「-all」オプションは効果がありません。 この動作は意図的なものです。
通常、すべての標準を処理することによって、標準ライブラリの HTML を XNUMX 回生成します。
ライブラリユニットを明示的に作成し、これらのユニットの HTML を再生成したくない場合
アプリケーションユニットの XNUMX つが標準ライブラリユニットと「結合」するたびに。

-c file
HTML ジェネレーターの構成ファイルを定義します。 複数 -c オプションは
与えられた; ファイルは指定された順序で処理され、以前の設定が上書きされる可能性があります
設定を行います。

-f file
処理する仕様のファイル名 (*.ads) を指定します。 このファイル名には、
パス！ その他のコメントについては、以下を参照してください。 唯一 -f というオプションが与えられるかもしれない。

-g 設定されている場合、 アドブラウズ また、ライブラリユニットのアイテムへの相互参照も生成します。
標準パッケージとランタイムパッケージ（暗黙的パッケージの項目を除く）
"標準"。 注: これは構成ファイルのキーによって設定することもできます。
「Refs_To_Standard」。 後者の定義が優先されます。

-G 出力形式...
出力形式を指定する アドブラウズ 生成するものとする。 の -G オプションに従う必要があります
別の引数として指定された XNUMX つ以上の出力形式名によって指定されます。 認識された出力
フォーマット名は HTML 　 XML （大文字小文字を区別しません）。

-i [file]
設定されている場合、 アドブラウズ 「ファイル入力モード」で実行するとパッケージインデックスが生成されます。
(以下を参照) または -すべて オプションが設定されているため、出力は標準出力に出力されません。

ファイル名が指定されている場合、インデックスはそのファイル (または、ファイル名が指定されている場合は stdout) に書き込まれます。
ファイル名は「-」です）。

-です [file]
-i と同じですが、子ユニットのインデントを使用してインデックスを生成します。

-l メーカー アドブラウズ 行番号のみを使用して HTML 出力に相互参照を生成します。
これは以前のバージョンのものです アドブラウズ (V2.13 まで) 常にそうでした。
V3.0 では、相互参照は行と行の両方を考慮して構築されています。
項目の列番号。 このオプションは、HTML がある場合にのみ使用してください。
以前に生成されたドキュメント アドブラウズ バージョンがあり、どういうわけか再実行できません
そのドキュメントを生成します。 ただし、推奨される使用法は、これを決して使用しないことです。
オプションを使用して、既存の HTML ドキュメントを再生成することもできます。

HTML は次のように生成されることに注意してください。 -l を使用せずに生成された HTML とは互換性がありません。 -l!
また、生成されたHTMLは、 アドブラウズ 3.0 以降は生成された HTML と互換性があります
by アドブラウズ 2.13 以前の場合のみ、 -l オプションが与えられます。

このオプションを使用すると、標準エラー出力に警告メッセージが生成されます。

-o [file]
出力ファイル名を定義します。 設定されていない場合、出力は次の名前のファイルに保存されます。
入力とサフィックス .htmlを。 場合 file ディレクトリを指定します（つまり、ディレクトリは「\」で終わります）
Windows または Unix の「/」)、生成されたすべての HTML ファイルがその中に置かれます。
ディレクトリ。 ファイル名が「-」の場合、出力は stdout に書き込まれます。 唯一 -o オプション
与えられるかもしれません。

ファイル名としてダッシュ (「-」) を使用できるのは、出力形式が XNUMX つだけである場合のみです。
指定された。 複数の出力形式が指定されている場合 (XML と HTML の両方など)、
出力を標準出力に送ることはできません。

-p [file]
As -iただし、処理されるすべてのユニットに対してサブプログラム インデックスが生成されます。

-民間, - プライベート
与えられた場合、 アドブラウズ パッケージとタスクのプライベート部分も処理します。または
保護された宣言。 (デフォルトではそうはなりませんが、プライベートの情報を置き換えます。
「実装定義」というコメントで囲まれた部分。)

-q Quiet モード: 警告メッセージや情報メッセージを発行しません。 の同義語 -w0.

-s URL 生成された HTML ファイルが使用するスタイル シートの URL を定義します。 このURL
は、HTML ファイルを配置する最終的な場所を基準にして指定する必要があります。 ご了承ください
a -s オプションは後で上書きできます -c オプション、構成ファイルの場合
キー「Style_Sheet」を定義します。

-t [file]
As -iただし、処理されるすべてのユニットに対してグローバル タイプ インデックスが生成されます。

-バージョン, - バージョン
のバージョン情報を印刷します アドブラウズ stderrに。

-wi の警告レベルを設定します。 アドブラウズ. i 次のいずれかになります。
0 または e はエラー メッセージのみを出力します。
1、または w は警告とエラーを出力します。
2、または i、または a すべてのメッセージを出力します。

-x 設定されている場合、 アドブラウズ 既存の HTML ファイルを上書きすることはありません。 (役に立つかもしれません
と組み合わせて -a オプション。）

-X 名=値
環境変数を定義する 名 価値あり 値。 この値はどの値よりも優先されます
おそらくすでに存在する定義 名 このためのシステム環境で
に呼び出します アドブラウズ。 新しい定義は、処理されるすべての構成ファイルに影響します。
その後、プロジェクト ファイル (存在する場合) も保存します。 の 名 白を含めてはいけません
空間; もし 値 空白が含まれている場合は、-X"user=John のように定義全体を引用します。
Doe"。間に空白がある場合とない場合があります。 -X と変数
定義。

-I ディレクトリにジョブを開始します。
ASIS のソース パスを定義します。 GNAT と同じセマンティクス。 複数 -I オプションは
与えられる。

-T ディレクトリにジョブを開始します。
ASIS がツリー ファイル (*.adt) を検索するためのパスを定義します。 複数 -T オプションは
与えられた。

ファイル名を付けると、 -i 「s」で始まるオプション、
オプションとファイル名の間には空白が必要です。空白がなければ、
として認識される -です オプション。 また、ファイル名が「-」で始まる場合は、
オプションとファイル名の間に空白文字がある場合は、それを空白文字にします。 アドブラウズ
ファイル名が次のオプションであると想定し、そのように処理します (オプションはすべて
ファイル名としてではなく、「-」で始まります。

同じ注意事項が次の場合にも当てはまります。 -p サブプログラムのインデックスを作成する場合のオプション
「rivate」という名前のファイルに移動します。空白がなければなりません。空白でなければ、全体が
として認識される -民間 オプション。 (確かにこれはかなり病的です
ただし、完全を期すためにここで言及しています。)

、 -f オプション

当学校区の -f オプションには XNUMX つの異なる形式があります。

1. ファイル名が「-」または「@-」の場合、 アドブラウズ 処理するユニットのユニット仕様を読み取ります。
標準入力から、EOF に達するまで、XNUMX 行に XNUMX ユニットずつ。 空行はスキップされます。 （もし
これを対話的に試す場合は、自分で EOF を通知する必要があります。 そうしないと、次の可能性があります
「ls -1 *.ads | adabrowse -f- ...」のように入力がパイプから来る場合に便利です）

2. ファイル名が「@」で始まる場合、 アドブラウズ それをユニットのスペックとはみなしませんが、
ユニット名を読み取るテキスト ファイルの名前 (XNUMX 行に XNUMX ユニット)。 空行
ファイル内にあるものは無視されます。

3. どちらにも当てはまらない場合は、 アドブラウズ 指定されたファイル名をユニット仕様として使用します。

最初の XNUMX つのケースは、「ファイル入力モード」と呼ばれます。 アドブラウズ。 ファイルには以下が含まれる場合があります
空の行とコメント (行の最初の「#」から始まり、
行の終わり）、これらは無視されます。 構成ファイルとは異なり、文字列
コメントの開始を見つけるための処理は行われず、行の継続も行われません。
ことができました。

XNUMX つのケースすべてにおいて、ユニット仕様はパスを含む可能性のあるファイル名です。 可能な接尾辞
無視されます。 ユニット仕様はファイル名であることに注意してください。 言い換えれば、あなたは与える テスト生成または
テストジェネレーション広告、ではない テスト.ジェネ。 その理由は単純で、ほとんどのシェル スクリプトでは
言語の場合、ファイル名をユニット名に組み込むよりもファイル名を操作する方が簡単です (例:
ダッシュをドットに置き換えることによって)。 また、ファイル名が壊れている場合は、単純な方法はありません。
ファイル名とユニット名の関係。

ユニット仕様にパスが含まれている場合、そのユニットの HTML ファイルはそのディレクトリに配置されます。
によってオーバーライドされない限り、 -o オプション。 ユニット仕様にパスが含まれている場合、ほとんどの場合、
おそらくまた設定する必要があります -T or -I たまたま ASIS を持っていない限り、オプション
直接入手可能な情報 (つまり、現在のディレクトリ内のユニットのツリー ファイル。
しかし、それはまったく典型的なものではありません)。

ファイル入力モードでは、 -o オプション (指定されている場合) は「-」のいずれかです (この場合、すべて
出力は stdout に送られます)、またはディレクトリを指定しますが、ファイルは指定しないでください。

アドブラウズ は、ソース ファイルと HTML ファイルに対して GNAT に似た命名スキームを想定しています。 また、
ファイルごとに 1.4 つのライブラリ ユニットがあること。 VXNUMX以降では、 アドブラウズ 圧縮されたファイルを処理できる
の名前 -f オプション。ソース ファイルが見つかり、拡張子が付いている場合に限ります。 .ads.
もしそうなら、 アドブラウズ ソース ファイルを開いて解析し、ユニット名を抽出します。
ファイル名から直接取得します。 生成されたファイルは常に名前に基づいていることに注意してください
元のファイル名ではなくユニット名に基づいて変更されます。つまり、出力ファイル名が変更されることはありません。
ぎくしゃくした。

生成された HTML ファイルには常に「.html」という接尾辞が付きます (「.htm」ではありません)。

INDEX GENERATION

インデックス生成は次の場合にアクティブになります。 アドブラウズ 複数のユニットを処理するように指示され、出力は
stdout には出力されません ( -O- オプションが与えられています）。

インデックス生成を制御するオプションがいくつかあります。

-i or -です ユニットインデックスの生成をオンにします。
-p サブプログラムインデックスの生成をオンにします。
-t タイプインデックスの生成をオンにします。

これらのオプションはすべて、オプションのファイル名をパラメータとして受け取ります。 ファイル名が続く場合、
インデックスはそのファイル (ファイル名が "-" の場合は stdout) に書き込まれます。 もし
ファイル名は指定されていません。デフォルト名が選択されています。

これらのオプションはすべて、実際には下位互換性の理由のみで維持されています。 現在
V4.0 では、インデックスはコマンドではなく、主に構成ファイルのエントリを通じて定義されます。
ライン。 以前のコマンドラインオプションを使用して既存のスクリプトを壊さないようにするため
アドブラウズ バージョンにかかわらず、これらのオプションは引き続き使用できます。

アドブラウズ は、次の場合に複数のユニットを処理することを想定しています。
・ファイル入力モード時（-f @file_name or -NS-).
・プロジェクトファイルを使用する場合（-P プロジェクトファイル名).
・いつ -すべて オプションが与えられます。

ファイル名が指定されていない場合、またはファイルにパスが含まれていない場合は、
インデックスが配置されるその他のオプション:
· ファイル入力モードの場合、 -o オプションを指定する場合は、ディレクトリを指定する必要があります。 すべてのHTML
インデックスを含むファイルがそのディレクトリに置かれます。
· いいえの場合 -o オプションが指定されていますが、最初のユニット仕様にパスが含まれているため、インデックスが置かれます
そのパスで指定されたディレクトリにコピーします。
· ファイル入力モードではなく、-all オプションが指定されている場合、 -o オプションはかもしれません
ファイル名を指定します。 インデックスはパス部分で指定されたディレクトリに配置されます
そのファイル名（ファイル名にパスが含まれていない場合は、現在のディレクトリ）の。
· プロジェクト ファイルを使用する場合、インデックスは ADABROWSE_OUTPUT ディレクトリに書き込まれます。
· それ以外の場合、このインデックスは現在のディレクトリに置かれます。

パスを含むファイル名が指定された場合、インデックスはそのファイルに配置されます。
指定されたディレクトリ。 ファイル名にパスのみが含まれている場合は、 アドブラウズ そのパスを使用し、
指定されたディレクトリに「index.html」という名前のインデックスを作成します。

もし -x オプションが指定されており（既存の HTML ファイルの上書きを禁止）、ファイルが存在します
すでにその場所に アドブラウズ インデックスを追加したいのですが、インデックスは生成されません
　 アドブラウズ 警告を発します。 また、インデックスを生成できない場合にも警告が表示されます。
他の理由がありますが、それ以外の場合は処理を続行します。

onworks.net サービスを使用してオンラインで adabrowse を使用する