Condividi tramite

Creazione del modulo provider personalizzato

  • Articolo

In generale, per creare un modulo provider personalizzato, è necessario implementare il set di interfacce seguente.

$module::SimpleUsage()

Scopo
Visualizza informazioni sull'utilizzo di moduli semplici su STDOUT.

Parametri
Nessuno

Valore restituito
Nessuno

$module::VerboseUsage()

Scopo
Visualizza informazioni sull'utilizzo del modulo approfondite su STDOUT.

Parametri
Nessuno

Valore restituito
Nessuno

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

Scopo
Inizializza un'istanza del modulo del provider.

Parametri

@CommandArguments
Tutti @ARGV gli argomenti che non sono riconosciuti da ssindex.cmd come argomenti generali.

Valore restituito
Riferimento che può essere usato nelle operazioni successive.

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

Scopo
Consente al modulo di raccogliere le informazioni di indicizzazione di origine necessarie per la directory specificata dal parametro $SourcePath . Il modulo non deve presupporre che questa voce venga chiamata una sola volta per ogni istanza di oggettobecause SSIndex può chiamarla più volte per percorsi diversi.

Parametri

$SourcePath
Directory locale contenente l'origine da indicizzare.

$ServerHashReference
Riferimento a un hash contenente tutte le voci del file di Srcsrv.ini specificato.

Valore restituito
Nessuno

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

Scopo
Fornisce le informazioni necessarie per estrarre un singolo file specifico dal sistema di controllo del codice sorgente.

Parametri

$LocalFile
Nome di file completo.

Valori restituiti

$VariableHashReference
Riferimento hash delle variabili necessarie per interpretare il $FileEntry restituito. Ssindex.cmd memorizza nella cache queste variabili per ogni file di origine usato da un singolo file di debug per ridurre la quantità di informazioni scritte nel flusso di indice di origine.

$FileEntry
Voce di file da scrivere nel flusso di indice di origine per consentire a SrcSrv di estrarre questo file dal controllo del codice sorgente. Il formato esatto di questa riga è specifico del sistema di controllo del codice sorgente.

$TextString= $objref-LongName>()

Scopo
Fornisce una stringa descrittiva per identificare il sistema di controllo del codice sorgente all'utente finale.

Parametri
Nessuno

Valore restituito

$TextString
Nome descrittivo del sistema di controllo del codice sorgente.

@StreamVariableLines=$objref-SourceStreamVariables>()

Scopo
Consente al sistema di controllo del codice sorgente di aggiungere variabili specifiche del controllo del codice sorgente al flusso di origine per ogni file di debug. I moduli di esempio usano questo metodo per scrivere le variabili di EXTRACT_CMD e EXTRACT_TARGET necessarie.

Parametri
Nessuno

Valore restituito

@StreamVariableLines
Elenco di voci per le variabili di flusso di origine.