Vytvoření vlastního modulu zprostředkovatele

Obecně platí, že pokud chcete vytvořit vlastní modul poskytovatele, musíte implementovat následující sadu rozhraní.

$module::SimpleUsage()

účelu
Zobrazí jednoduché informace o využití modulů do STDOUT.

parametry
Žádný

návratová hodnota
Žádný

$module::VerboseUsage()

účelu
Zobrazí podrobné informace o využití modulů na STDOUT.

parametry
Žádný

návratová hodnota
Žádný

$objref = $module::new(@CommandArguments)

účelu
Inicializuje instanci modulu zprostředkovatele.

parametry

@CommandArguments
Všechny @ARGV argumenty, které ssindex.cmd nerozpoznají jako obecné argumenty.

návratová hodnota
Odkaz, který lze použít v pozdějších operacích.

$objref->GatherFileInformation($SourcePath;$ServerHashReference)

účel
Umožňuje modulu shromáždit požadované informace o indexování zdroje pro adresář určený parametrem $SourcePath. Modul by neměl předpokládat, že tato položka je volána pouze jednou pro každou instanci objektu, protože SSIndex ji může volat vícekrát pro různé cesty.

parametry

$SourcePath
Místní adresář obsahující zdroj, který se má indexovat.

$ServerHashReference
Odkaz na hodnotu hash obsahující všechny položky ze zadaného souboru Srcsrv.ini.

návratová hodnota
Žádný

($VariableHashReference,$FileEntry) = $objref–>GetFileInfo($LocalFile)

účel
Poskytuje potřebné informace k extrakci jednoho konkrétního souboru ze systému správy zdrojového kódu.

parametry

$LocalFile
Plně kvalifikovaný název souboru.

Vrácené Hodnoty

$VariableHashReference
Hashový odkaz proměnných potřebných k interpretaci vrácených $FileEntry. Ssindex.cmd tyto proměnné ukládá do mezipaměti pro každý zdrojový soubor používaný jedním ladicím souborem, aby se snížilo množství informací zapsaných do streamu zdrojového indexu.

$FileEntry
Položka souboru, která se má zapsat do streamu zdrojového indexu, aby SrcSrv mohl extrahovat tento soubor ze správy zdrojového kódu. Přesný formát tohoto řádku je specifický pro systém správy zdrojového kódu.

$TextString= $objref->LongName()

účel
Poskytuje popisný řetězec pro identifikaci systému správy zdrojového kódu koncovému uživateli.

parametry
Žádný

návratová hodnota

$TextString
Popisný název systému správy zdrojového kódu.

@StreamVariableLines=$objref->SourceStreamVariables()

účelu
Umožňuje systému správy zdrojového kódu přidat proměnné specifické pro správu zdrojového kódu do zdrojového streamu pro každý ladicí soubor. Ukázkové moduly používají tuto metodu pro psaní požadovaných EXTRACT_CMD a EXTRACT_TARGET proměnných.

parametry
Žádný

návratová hodnota

@StreamVariableLines
Seznam položek pro proměnné zdrojového datového proudu.