Erstellen eines eigenen Anbietermoduls

Um ein eigenes Anbietermodul zu erstellen, müssen Sie im Allgemeinen die folgenden Schnittstellen implementieren.

$module::SimpleUsage()

Zweck
Zeigt einfache Modulnutzungsinformationen für STDOUT an.

Parameter
Keine

Rückgabewert
Keine

$module::VerboseUsage()

Zweck
Zeigt ausführliche Modulnutzungsinformationen für STDOUT an.

Parameter
Keine

Rückgabewert
Keine

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

Zweck
Initialisiert eine instance des Anbietermoduls.

Parameter

@CommandArguments
Alle @ARGV Argumente, die von ssindex.cmd nicht als allgemeine Argumente erkannt werden.

Rückgabewert
Ein Verweis, der in späteren Vorgängen verwendet werden kann.

>$objref GatherFileInformation($SourcePath,$ServerHashReference)

Zweck
Ermöglicht dem Modul das Sammeln der erforderlichen Quellindizierungsinformationen für das durch den $SourcePath-Parameter angegebene Verzeichnis. Das Modul sollte nicht davon ausgehen, dass dieser Eintrag nur einmal für jede Objektinstanz aufgerufen wird, da SSIndex ihn möglicherweise mehrmals für unterschiedliche Pfade aufruft.

Parameter

$SourcePath
Das lokale Verzeichnis, das die zu indizierte Quelle enthält.

$ServerHashReference
Ein Verweis auf einen Hash, der alle Einträge aus der angegebenen Srcsrv.ini Datei enthält.

Rückgabewert
Keine

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

Zweck
Stellt die erforderlichen Informationen bereit, um eine einzelne, spezifische Datei aus dem Quellcodeverwaltungssystem zu extrahieren.

Parameter

$LocalFile
Ein vollqualifizierter Dateiname.

Rückgabewerte

$VariableHashReference
Ein Hashverweis der Variablen, die zum Interpretieren der zurückgegebenen $FileEntry erforderlich sind. Ssindex.cmd speichert diese Variablen für jede Quelldatei zwischen, die von einer einzelnen Debugdatei verwendet wird, um die Menge der in den Quellindexdatenstrom geschriebenen Informationen zu reduzieren.

$FileEntry
Der Dateieintrag, der in den Quellindexdatenstrom geschrieben werden soll, damit SrcSrv diese Datei aus der Quellcodeverwaltung extrahieren kann. Das genaue Format dieser Zeile ist spezifisch für das Quellcodeverwaltungssystem.

$TextString= $objref-LongName>()

Zweck
Stellt eine beschreibende Zeichenfolge bereit, um das Quellcodeverwaltungssystem für den Endbenutzer zu identifizieren.

Parameter
Keine

Rückgabewert

$TextString
Der beschreibende Name des Quellcodeverwaltungssystems.

@StreamVariableLines=$objref-SourceStreamVariables>()

Zweck
Ermöglicht dem Quellcodeverwaltungssystem, dem Quellstream für jede Debugdatei quellcodekontrollspezifische Variablen hinzuzufügen. Die Beispielmodule verwenden diese Methode zum Schreiben der erforderlichen EXTRACT_CMD und EXTRACT_TARGET Variablen.

Parameter
Keine

Rückgabewert

@StreamVariableLines
Die Liste der Einträge für die Quellstreamvariablen.