Tworzenie własnego modułu dostawcy

Ogólnie rzecz biorąc, aby utworzyć własny moduł dostawcy, należy zaimplementować następujący zestaw interfejsów.

$module::SimpleUsage()

Cel
Wyświetla proste informacje o użyciu modułu do funkcji STDOUT.

Parametry
Żaden

Wartość zwracana
Żaden

$module::VerboseUsage()

Cel
Wyświetla szczegółowe informacje o użyciu modułu na STDOUT.

Parametry
Żaden

Wartość zwracana
Żaden

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

Cel
Inicjuje wystąpienie modułu dostawcy.

Parametry

@CommandArguments
Wszystkie @ARGV argumenty, które nie są rozpoznawane przez ssindex.cmd jako argumenty ogólne.

Wartość zwracana
Odwołanie, które może być używane w kolejnych operacjach.

$objref—>GatherFileInformation($SourcePath,$ServerHashReference)

Cel
Umożliwia modułowi zbieranie wymaganych informacji dotyczących indeksowania źródła dla katalogu określonego przez parametr $SourcePath . Moduł nie powinien zakładać, że ten wpis jest wywoływany tylko raz dla każdego wystąpienia obiektu, ponieważ SSIndex może go wywołać wiele razy dla różnych ścieżek.

Parametry

$SourcePath
Katalog lokalny zawierający źródło do indeksowania.

$ServerHashReference
Odwołanie do skrótu zawierającego wszystkie wpisy z określonego pliku Srcsrv.ini.

Wartość zwracana
Żaden

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

Cel
Zawiera informacje niezbędne do wyodrębnienia pojedynczego, określonego pliku z systemu kontroli źródła.

Parametry

$LocalFile
W pełni kwalifikowana nazwa pliku.

Zwracane wartości

$VariableHashReference
Odwołanie do hasha zmiennych niezbędnych do interpretacji zwróconego $FileEntry. Ssindex.cmd buforuje te zmienne dla każdego pliku źródłowego używanego przez pojedynczy plik debugowania w celu zmniejszenia ilości informacji zapisanych w strumieniu indeksu źródłowego.

$FileEntry
Wpis pliku, który ma zostać zapisany w strumieniu indeksu źródła, aby umożliwić usłudze SrcSrv wyodrębnienie tego pliku z systemu kontroli wersji. Dokładny format tego wiersza jest specyficzny dla systemu kontroli źródła.

$TextString= $objref->LongName()

Cel
Zawiera opisowy ciąg umożliwiający zidentyfikowanie systemu kontroli źródła dla użytkownika końcowego.

Parametry
Żaden

Wartość zwracana

$TextString
Opisowa nazwa systemu kontroli źródła.

@StreamVariableLines=$objref-SourceStreamVariables>()

Cel
Umożliwia systemowi kontroli źródła dodawanie zmiennych specyficznych dla kontroli źródła do strumienia źródłowego dla każdego pliku debugowania. W przykładowych modułach użyto tej metody do pisania wymaganych zmiennych EXTRACT_CMD i EXTRACT_TARGET.

Parametry
Żaden

Wartość zwracana

@StreamVariableLines
Lista wpisów zmiennych strumienia źródłowego.