Skip to content

Code4Delphi/C4D-Console

Repository files navigation

C4D-Console - Framework para escrita de logs em Console Application

Code4Delphi

Com o C4D-Console, você pode controlar de uma forma rápida e fácil, a escrita de Logs para quando estiver utilizando um projeto Console Application no Delphi

📞 Contacts

     

⚙️ Instalação

  • Instalação usando o Boss:
boss install github.com/Code4Delphi/C4D-Console
  • Instalação manual: Abra seu Delphi e adicione a seguinte pasta ao seu projeto, em Project > Options > Resource Compiler > Directories and Conditionals > Include file search path
..\C4D-Console\Src

🚀 Como usar

  • Adicione a uses a seu sistema:
uses
  C4D.Console;
  • Configure os dados básicos do framework, caso deseje:
C4DConsole
    .Prefix('C4DConsoleDemo01')
    .Version('1.0.0')
    .Port(0);
  • Estrutura básica de código, do arquivo .dpr:
uses
  C4D.Console;

var
 FDig: String;

begin
   ReportMemoryLeaksOnShutdown := True;
   C4DConsole
     .Prefix('MeuPrefix')
     .Version('1.0.0')
     .Port(0)
     .WriteInitialSummary('#CODE4DELPHI SERVIDOR INICIADO');

   FDig := '';
   while(FDig <> C4DConsole.CommandFinish)do
   begin
      ReadLn(FDig);
      C4DConsole.ProcessDigitated(FDig);
   end;
end.

👨‍💻 Comandos aceitos

  • -h help
********************************************************************************
MeuPrefix AJUDA:
 -l   Desativar geração de log
 +l   Ativar geração de log
 -r   Gerar resumo
 \q   Encerrar
********************************************************************************
  • -l Desativar a geração de log
********************************************************************************
LOG DESATIVADO
********************************************************************************
  • +l Ativar a geração de log
********************************************************************************
LOG ATIVADO
********************************************************************************
  • -r Exibe um resumo
********************************************************************************
MeuPrefix  RESUMO:
  Servidor iniciado em: 12/05/2023 00:38:49
  Servidor rodando a: 0 dias, 0 horas, 1 minutos e 40 segundos
  Porta: 0
  Versão: 1.0.0
  Caminho: C:\Componentes-Delphi\Code4D\C4D-Console\Samples\Demo01\Win32\Debug\C4DConsoleDemo01.exe
  Compilado em: 12/05/2023 00:38:17
********************************************************************************

🖥️ Métodos disponíveis:

Ativar/Desativar Logs

  • Verificar se o log esta ativo:
var
 LLogAtivo: Boolean;
begin
   LLogAtivo := C4DConsole.LogEnabled;
end;
  • Ativa geração de Log:
C4DConsole.EnableLog;
  • Desativar geração de Log:
C4DConsole.DisableLog;

Inserir um resumo inicial

  • Comando:
C4DConsole.WriteInitialSummary;
  • Será exibido:

Print-Console-Init

Outros métodos:

  • Exibir data e hora atual: C4DConsole.DtHrStr;

  • Inserir data e hora da compilação do projeto: C4DConsole.DhCompilation;

  • Inserir um texto na tela sem quebra de linha: C4DConsole.WriteStr('Texto a ser exibido');

  • Inserir um texto na tela com quebra de linha:: C4DConsole.WriteStrLn('Texto a ser exibido');

  • Inserir um texto na tela com a data e hora como prefixo sem quebra de linha: C4DConsole.WriteDh('Texto a ser exibido');

  • Inserir um texto na tela com a data e hora como prefixo com quebra de linha: C4DConsole.WriteDhLn('Texto a ser exibido');

  • Inserir quebra de linhas: C4DConsole.BreachLines(2);

  • Inserir separador de linha sem quebra de linha: C4DConsole.WriteLineSeparation('#', 80);

  • Inserir separador de linha com quebra de linha: C4DConsole.WritelnLineSeparation('#', 80);

  • Metodo usado para processar o que for digitado no console:

   ReadLn(FDig);
   C4DConsole.ProcessDigitated(FDig);

Métodos Get e Set:

Método Tipo Obter Setar Valor Default
Prefixo String LPrefix := C4DConsole.Prefix; C4DConsole.Prefix('MeuPrefix'); C4D
Version String LVersion := C4DConsole.Version; C4DConsole.Version('0.0.0'); Vazio
Port Integer LPort := C4DConsole.Port; C4DConsole.Port(9000); 0
DhIni TDateTime LDhIni := C4DConsole.DhIni; C4DConsole.DhIni(Now); Now
CommandFinish String LStr := C4DConsole.CommandFinish; C4DConsole.CommandFinish('\q'); \q

⌨️ Demo

  • Junto aos fontes do projeto, você encontrara um projeto teste, na pasta:
..\C4D-Console\Samples\Demo01