一般に、独自のプロバイダー モジュールを作成するには、次のインターフェイスのセットを実装する必要があります。
$module::SimpleUsage()
目的
STDOUT に単純なモジュール使用状況情報を表示します。
パラメーター
なし
戻り値
なし
$module::VerboseUsage()
目的
STDOUT にモジュールの使用状況に関する詳細な情報を表示します。
パラメーター
なし
戻り値
なし
$objref = $module::new(@CommandArguments)
目的
プロバイダー モジュールのインスタンスを初期化します。
パラメーター
@CommandArguments
ssindex.cmdによって一般的な引数として認識されないすべての @ARGV 引数。
戻り値
後の操作で使用できる参照。
$objref->GatherFileInformation($SourcePath,$ServerHashReference)
目的
モジュールが、 $SourcePath パラメーターで指定されたディレクトリに必要なソース インデックス情報を収集できるようにします。 モジュールは、SSIndex が異なるパスに対して複数回呼び出す可能性があるため、このエントリがオブジェクト インスタンスごとに 1 回だけ呼び出されることを想定しないでください。
パラメーター
$SourcePath
インデックスを作成するソースを含むローカル ディレクトリ。
$ServerHashReference
指定した Srcsrv.ini ファイルのすべてのエントリを含むハッシュへの参照。
戻り値
なし
($VariableHashReference,$FileEntry) = $objref->GetFileInfo($LocalFile)
目的
ソース管理システムから 1 つの特定のファイルを抽出するために必要な情報を提供します。
パラメーター
$LocalFile
完全修飾ファイル名。
戻り値
$VariableHashReference
返された $FileEntryを解釈するために必要な変数のハッシュ参照。 Ssindex.cmdは、ソース インデックス ストリームに書き込まれる情報の量を減らすために、1 つのデバッグ ファイルで使用されるすべてのソース ファイルに対してこれらの変数をキャッシュします。
$FileEntry
SrcSrv がソース管理からこのファイルを抽出できるように、ソース インデックス ストリームに書き込むファイル エントリ。 この行の正確な形式は、ソース管理システムに固有です。
$TextString= $objref->LongName()
目的
エンド ユーザーにソース管理システムを識別するための説明文字列を提供します。
パラメーター
なし
戻り値
$TextString
ソース管理システムのわかりやすい名前。
@StreamVariableLines=$objref->SourceStreamVariables()
目的
ソース管理システムが、各デバッグ ファイルのソース ストリームにソース管理固有の変数を追加できるようにします。 サンプル モジュールでは、このメソッドを使用して、必要なEXTRACT_CMDとEXTRACT_TARGET変数を記述します。
パラメーター
なし
戻り値
@StreamVariableLines
ソース ストリーム変数のエントリの一覧。