Criando seu próprio módulo de provedor

Em geral, para criar seu próprio módulo de provedor, você deve implementar o seguinte conjunto de interfaces.

$module::SimpleUsage()

Propósito
Exibe informações simples de uso do módulo para STDOUT.

Parâmetros
Nenhum

Valor retornado
Nenhum

$module::VerboseUsage()

Propósito
Exibe informações detalhadas de uso do módulo para STDOUT.

Parâmetros
Nenhum

Valor retornado
Nenhum

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

Propósito
Inicializa uma instância do módulo do provedor.

Parâmetros

@CommandArguments
Todos os @ARGV argumentos que não são reconhecidos por ssindex.cmd como argumentos gerais.

Valor retornado
Uma referência que pode ser usada em operações posteriores.

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

Propósito
Permite que o módulo colete as informações de indexação de origem necessárias para o diretório especificado pelo parâmetro $SourcePath . O módulo não deve assumir que essa entrada é chamada apenas uma vez para cada instância de objetobecause SSIndex pode chamá-la várias vezes para caminhos diferentes.

Parâmetros

$SourcePath
O diretório local que contém a origem a ser indexada.

$ServerHashReference
Uma referência a um hash que contém todas as entradas do arquivo Srcsrv.ini especificado.

Valor retornado
Nenhum

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

Propósito
Fornece as informações necessárias para extrair um único arquivo específico do sistema de controle do código-fonte.

Parâmetros

$LocalFile
Um nome de arquivo totalmente qualificado.

Valores retornados

$VariableHashReference
Uma referência de hash das variáveis necessárias para interpretar o $FileEntry retornado. O Ssindex.cmd armazena essas variáveis em cache para cada arquivo de origem usado por um único arquivo de depuração para reduzir a quantidade de informações gravadas no fluxo de índice de origem.

$FileEntry
A entrada de arquivo a ser gravada no fluxo de índice de origem para permitir que o SrcSrv extraia esse arquivo do controle do código-fonte. O formato exato dessa linha é específico para o sistema de controle do código-fonte.

$TextString= $objref-LongName>()

Propósito
Fornece uma cadeia de caracteres descritiva para identificar o sistema de controle do código-fonte para o usuário final.

Parâmetros
Nenhum

Valor retornado

$TextString
O nome descritivo do sistema de controle do código-fonte.

@StreamVariableLines=$objref-SourceStreamVariables>()

Propósito
Permite que o sistema de controle do código-fonte adicione variáveis específicas do controle do código-fonte ao fluxo de origem para cada arquivo de depuração. Os módulos de exemplo usam esse método para gravar as variáveis de EXTRACT_CMD e EXTRACT_TARGET necessárias.

Parâmetros
Nenhum

Valor retornado

@StreamVariableLines
A lista de entradas para as variáveis de fluxo de origem.