Création de votre propre module fournisseur

En général, pour créer votre propre module fournisseur, vous devez implémenter l’ensemble d’interfaces suivant.

$module::SimpleUsage()

But
Affiche des informations d’utilisation des modules simples pour STDOUT.

Paramètres
None

Valeur de retour
None

$module::VerboseUsage()

But
Affiche des informations détaillées sur l’utilisation des modules pour STDOUT.

Paramètres
None

Valeur de retour
None

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

But
Initialise une instance du module fournisseur.

Paramètres

@CommandArguments
Tous les @ARGV arguments qui ne sont pas reconnus par ssindex.cmd comme étant des arguments généraux.

Valeur de retour
Référence qui peut être utilisée dans des opérations ultérieures.

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

But
Permet au module de collecter les informations d’indexation de la source requises pour le répertoire spécifié par le paramètre $SourcePath . Le module ne doit pas supposer que cette entrée n’est appelée qu’une seule fois pour chaque instance d’objet. SSIndex peut l’appeler plusieurs fois pour différents chemins.

Paramètres

$SourcePath
Répertoire local contenant la source à indexer.

$ServerHashReference
Référence à un hachage contenant toutes les entrées du fichier Srcsrv.ini spécifié.

Valeur de retour
None

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

But
Fournit les informations nécessaires pour extraire un seul fichier spécifique du système de contrôle de code source.

Paramètres

$LocalFile
Nom de fichier complet.

Valeurs retournées

$VariableHashReference
Référence de hachage des variables nécessaires pour interpréter le $FileEntry retourné. Ssindex.cmd met en cache ces variables pour chaque fichier source utilisé par un seul fichier de débogage afin de réduire la quantité d’informations écrites dans le flux d’index source.

$FileEntry
Entrée de fichier à écrire dans le flux d’index source pour permettre à SrcSrv d’extraire ce fichier du contrôle de code source. Le format exact de cette ligne est spécifique au système de contrôle de code source.

$TextString= $objref-LongName>()

But
Fournit une chaîne descriptive pour identifier le système de contrôle de code source à l’utilisateur final.

Paramètres
None

Valeur de retour

$TextString
Nom descriptif du système de contrôle de code source.

@StreamVariableLines=$objref-SourceStreamVariables>()

But
Permet au système de contrôle de code source d’ajouter des variables spécifiques au contrôle de code source au flux source pour chaque fichier de débogage. Les exemples de modules utilisent cette méthode pour écrire les variables EXTRACT_CMD et EXTRACT_TARGET requises.

Paramètres
None

Valeur de retour

@StreamVariableLines
Liste des entrées pour les variables de flux source.