Compartir a través de

Creación de su propio módulo de proveedor

  • Artículo

En general, para crear su propio módulo de proveedor, debe implementar el siguiente conjunto de interfaces.

$module::SimpleUsage()

Propósito
Muestra información de uso de módulos sencilla a STDOUT.

Parámetros
Ninguno

Valor devuelto
Ninguno

$module::VerboseUsage()

Propósito
Muestra información de uso del módulo en profundidad para STDOUT.

Parámetros
Ninguno

Valor devuelto
None

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

Propósito
Inicializa una instancia del módulo de proveedor.

Parámetros

@CommandArguments
Todos los @ARGV argumentos que ssindex.cmd no reconocen como argumentos generales.

Valor devuelto
Referencia que se puede usar en operaciones posteriores.

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

Propósito
Permite al módulo recopilar la información necesaria de indexación de origen para el directorio especificado por el parámetro $SourcePath . El módulo no debe suponer que esta entrada se llama solo una vez para cada instancia de objeto porque SSIndex puede llamarla varias veces para diferentes rutas de acceso.

Parámetros

$SourcePath
Directorio local que contiene el origen que se va a indexar.

$ServerHashReference
Referencia a un hash que contiene todas las entradas del archivo de Srcsrv.ini especificado.

Valor devuelto
Ninguno

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

Propósito
Proporciona la información necesaria para extraer un único archivo específico del sistema de control de código fuente.

Parámetros

$LocalFile
Un nombre de archivo completo.

Valores devueltos

$VariableHashReference
Referencia hash de las variables necesarias para interpretar el $FileEntry devuelto. Ssindex.cmd almacena en caché estas variables para cada archivo de origen usado por un único archivo de depuración para reducir la cantidad de información escrita en el flujo de índice de origen.

$FileEntry
Entrada de archivo que se va a escribir en el flujo de índice de origen para permitir que SrcSrv extraiga este archivo del control de código fuente. El formato exacto de esta línea es específico del sistema de control de código fuente.

$TextString= $objref-LongName>()

Propósito
Proporciona una cadena descriptiva para identificar el sistema de control de código fuente al usuario final.

Parámetros
Ninguno

Valor devuelto

$TextString
Nombre descriptivo del sistema de control de código fuente.

@StreamVariableLines=$objref-SourceStreamVariables>()

Propósito
Permite al sistema de control de código fuente agregar variables específicas del control de código fuente al flujo de origen para cada archivo de depuración. Los módulos de ejemplo usan este método para escribir las variables de EXTRACT_CMD y EXTRACT_TARGET necesarias.

Parámetros
Ninguno

Valor devuelto

@StreamVariableLines
Lista de entradas para las variables de flujo de origen.