Cタグ

Ctags は、さまざまなプログラミング言語のソース ファイルとヘッダー ファイルにある名前のインデックスファイル (またはタグ ファイル)を生成して、コードの理解を助けるプログラミング ツールです。言語によっては、関数、変数、クラスメンバー、マクロなどがインデックス化される場合があります。これらのタグにより、テキスト エディター、コード検索エンジン、またはその他のユーティリティで定義をすばやく簡単に見つけることができます。また、一連の言語ファイルにあるさまざまな名前に関する情報を人間が読める形式 で一覧表示する相互参照ファイルを生成する出力モードもあります。

オリジナルのCtagsはBSD Unix 2.0 ^{[1] [2]}で導入され、 Ken Arnoldによって書かれ、FortranのサポートはJim Kleckner、PascalのサポートはBill Joyによって行われました。これは、1992年のSingle Unix仕様とXPG4の最初のリリースの一部です。

タグ インデックス ファイルは、次のような多くのソース コード エディターでサポートされています。

ctagsプログラムには他にもいくつかの実装があります。

GNU Emacsには、同じソースコードからコンパイルされた2 つの ctags ユーティリティ、etagsと ctags が付属しています。etags は Emacs 用のタグ テーブル ファイルを生成し、ctags コマンドはviが理解できる形式で同様のテーブルを作成するために使用されます。これらのユーティリティには異なるコマンド ライン オプション セットがあります。etags は、ctags コマンドによって生成された vi スタイルのタグ ファイルにのみ意味のあるオプションを認識せず、無視します。^[6]

Exuberant Ctagsは、2009年までDarren Hiebertによって作成および保守され、^[7]当初はVimとともに配布されていましたが、Vim 6のリリース時に別のプロジェクトになりました。Emacsのサポートと互換性が含まれていますetags。^{[8] [9]}

Exuberant Ctags には 40 を超えるプログラミング言語のサポートが含まれており、正規表現を使用してさらに多くの言語のサポートを追加できます。

Universal CtagsはExuberant Ctagsのフォークであり、その開発を継続することを目的としています。いくつかのパーサーは言語をより適切にサポートするために書き直されています。^[10]

HasktagsはHaskell用のctags互換のタグファイルを作成します。^[11]Emacs etagsファイルの作成もサポートしています。^[12]

jsctagsはJavaScript用のctags互換コードインデックスソリューションです。^[13]JavaScriptに特化しており、CommonJSパッケージングシステムを使用しています。JavaScriptExuberant Ctags、後者よりも多くのタグを見つけます。^[14]

タグファイル形式は複数あります。そのうちのいくつかを以下に説明します。以下では、\ x## は16 進数表現##のバイトを表します。各行は改行(LF、\ n = \ x0A ) で終わります。

オリジナルのctagsとExuberant/Universalの派生版は似たようなファイル形式を持っている: ^[15]

これはviやさまざまなクローンによって使用される形式です。タグ ファイルは通常、「tags」という名前になります。

タグ ファイルは行のリストであり、各行は次の形式になります。

{タグ名}\ t {タグファイル}\ t {タグアドレス}

フィールドは次のように指定されます。

• {tagname } – 空白を含まない任意の識別子
• \ t –タブ文字( \ x0b ) は1 つだけですが、 viの多くのバージョンでは任意の数の空白文字を処理できます。
• {tagfile } –現在のディレクトリからの相対パスで、{tagname } が定義されているファイルの名前
• {tagaddress } –エディターをタグの場所に移動するexモード コマンド。viの POSIX 実装では、これは検索または行番号のみになる可能性があり、任意のコマンド実行に対するセキュリティが強化されます。

タグ ファイルは{tagname } フィールドでソートされるため、タグ ファイルを高速に検索できます。

これは、 Vimの Exuberant Ctags と Universal Ctagsで使用される形式です。これらのプログラムは、オリジナルのctagsファイル形式、または下位互換性を維持しようとする拡張形式を生成できます。

拡張タグ ファイルは行のリストであり、各行は次の形式になります。

{タグ名}\ t {タグファイル}\ t {タグアドレス}[;"\ t {タグフィールド...}]

{tagaddress }までのフィールドは、上記の ctags の場合と同じです。

オプションの追加フィールドは角括弧 (“[...]”) で示され、次のものが含まれます。

• ;" – セミコロン + 二重引用符: viまたはexへのコメントの開始のように見える方法で{tagaddress } を終了します。
• {tagfield } – 拡張フィールド: 詳細については、タブで区切られた「キー:値」のペアを参照してください。

この形式は、追加データがコメントとして解釈されるため、非POSIX viと互換性があります。ただし、 viのPOSIX実装は、これをサポートするように変更する必要があります。^[15]

これは Emacs etagsで使用される形式です。タグ ファイルは通常「TAGS」という名前になります。

etags ファイルは複数のセクションで構成されます。入力ソース ファイルごとに 1 つのセクションがあります。セクションはプレーン テキストで、特殊な目的で使用されるいくつかの印刷できない ASCII 文字が含まれています。これらの文字は、以下のように下線付きの 16 進コードで表されます。

セクションは 2 行のヘッダーで始まります (最初の 2 バイトはマジック ナンバーを構成します)。

\ x0c 
{ src_file },{タグ定義データのサイズ（バイト単位） }

ヘッダーの後にはタグ定義が続き、1 行に 1 つの定義が次の形式で続きます。

{タグ定義テキスト}\ x7f {タグ名}\ x01 {行番号},{バイトオフセット}

タグ定義のテキストからタグの名前を推測できる場合は、 {tagname} \x01を省略できます。

1 行の test.c ソース コードがあるとします。

#CCC(x) を定義します

TAGS (etags) ファイルは次のようになります。

\ x0c
テスト.c,21
#define CCC(\ x7f CCC\ x01 1,0

タグ (ctags) ファイルは次のようになります。

CCC(テスト.c 1

または、検索を使用してより柔軟に:

CCC( test.c /^#define CCC(/

• GNUグローバル

WikibookのUnixガイドには、コマンドに関するページがあります。

• ctags: タグ ファイルを作成する – シェルおよびユーティリティ リファレンス、The Single UNIX 仕様、バージョン 4、The Open Group
• ユニバーサル Ct​​ags ホームページ
• 活気あふれる Ctags ホームページ
• VMS 上の Ctags
• Emacs vtags.el モジュールのソースコード