Ejemplos comparativos de GH Freebrary

[[Al González]]

El propósito de este hilo es tomar muestras de código Delphi de la Red e indicar cómo escribir "la misma idea", pero empleando GH Freebrary. Como en cualquiera de los otros hilos del foro, todo el mundo es libre de participar poniendo ejemplos y adaptaciones que contribuyan a explicar las ventajas de esta biblioteca de programación.

Considero que estos ejemplos, emanados de programas y prácticas de la vida real, ayudarán a comprender cuándo y por qué es útil el uso de esta biblioteca (sin olvidarnos del naciente manual de referencia). En lo personal me resulta más apropiado plantear estas bien intencionadas comparaciones aquí, en el foro GHF, que hacerlo directamente donde se encuentre el código de muestra, pues sería un poco entrometido de mi parte y desvirtuaría el tema tratado en esos lugares.

En el presente hilo toda mención a código ajeno ha de hacerse con el debido respeto a su autor, y el debate no ha de adquirir posiciones dogmáticas sobre qué soluciones son mejores que otras, sino más bien orientarse a descubrir cómo podemos solucionar las misas cosas con clases, funciones y otros elementos de GH Freebrary y el valor agregado que eso tiene.

Comencemos pues...

[[Al González]]

Aquí podemos encontrar estas tres sentencias de código:

Código Delphi [-]
begin
  ...
  PDFReport1.Filename := GetCurrentDir()+'\prueba.rep';
  PDFReport1.PDFFilename := GetCurrentDir()+'\prueba.pdf';
  ...
  Application.MessageBox(PChar('Listado exportado correctamente:' +
    #13 + #13 + PDFReport1.PDFFilename), 'Exportando', MB_ICONINFORMATION);

Tal vez este no sea el caso, pero suponiendo que lo sea, he notado que suele utilizarse la función GetCurrentDir para formar una ruta de archivo relativa a la del programa ejecutable. Pero eso puede ser engañoso, porque las funciones nativas GetCurrentDir y GetCurrentDirectory no necesariamente devuelven el directorio del programa ejecutable, sino sencillamente el "directorio actual", el cual puede ser cambiado inadvertidamente por algún elemento del programa que trabaje con el sistema de archivos. Para derivar una ruta de la del programa ejecutable tenemos la función ghDirPath.

Por otra parte, casi nunca es cómodo escribir o leer una llamada a la función MessageBox de la API de Windows (o al método de TApplication que lleva el mismo nombre) por lo especial de sus parámetros: Las cadenas no son de tipo String sino PChar, así que con frecuencia se recurre a moldes de tipos "PChar(Cadena)"; además primero debe indicarse el texto interior de la ventana y luego su título, cuando la lógica común de cualquier diseño es indicar primero el título de la ventana y luego su contenido; y finalmente la constantes MB_ICONXXX no son precisamente estéticas, abultan el código y restan legibilidad. ¿Existe una función sencilla de manejar que muestre un simple cuadro de texto con el icono de información? Sí, su nombre es ghInform.

El anterior bloque de código quedaría así:

Código Delphi [-]
Uses
  GHFRTL, GHFVCL;

Begin
  ...
  PDFReport1.Filename := ghDirPath ('prueba.rep');
  PDFReport1.PDFFilename := ghDirPath ('prueba.pdf');
  ...
  ghInform ('Exportando', 'Listado exportado correctamente:'#13#13 +
    PDFReport1.PDFFilename);

Sólo es necesario añadir a la cláusula Uses la unidad GHFRTL (que contiene a ghDirPath) y la unidad GHFVCL (que contiene a ghInform).

[Jose Roman]

Gracias por el aporte, no sabia nada al respecto (me considero un novato avanzado) ojala aporten mas ejemplos que ayudan mucho.

[[AzidRain]]

Yo siempre he usado:

Código Delphi [-]
ExtractFilePath(Application.ExeName);

ya que lo que dice Al es muy cierto GetCurrentDir solo nos devuelve el directorio de trabajo actual y puede haber sido cambiado por la aplicación, la propiedad ExeName por otro lado, contiene todo el path completo del ejecutable se haya ejecutado de donde haya sido (inclusive una memoria USB).

[[Al González]]

Código Delphi [-]
  DirPrograma := ExtractFileDir (Application.ExeName);
  ...
  RutaReporte := ExtractFilePath (Application.ExeName) + 'Reporte.pdf';

Alternativa:

Código Delphi [-]
  DirPrograma := ghExeDir;
  ...
  RutaReporte := ghDirPath ('Reporte.pdf');

Además de ser más cortas, las segundas opciones no requieren la existencia del objeto Application (algunos programas prescinden de la unidad Forms).

[[AzidRain]]

Me quedo con mi solución, es cierto que requieres la unidad Forms, pero esa ya viene por defecto y el objeto Application se crea y regula automáticamente. Si ya viene con muchas otras opciones ¿Por qué no usarlo? Claro a menos que en ninguna parte de nuestro poyecto usemos la unidad citada, pero en todo caso todo se resumen e usar o no una unidad adicional (una de ellas nativa), ya sea "forms" o las de GHFreebrary. Al final en los dos casos se obtiene exactamente lo mismo.

[[Al González]]

Será que me gusta mucho la brevedad del código.

[Casimiro Notevi]

Empezado por Al González

Será que me gusta mucho la brevedad del código.

A mí también.
Cada vez que tengo que usar extractfilepath o alguna función similar me da sensación de obsoleta.

[[Al González]]

Ocasionalmente necesitamos un valor de fecha y hora expresado en formato ISO, y a veces tomamos ese valor de lo que devuelve la función nativa Now (la fecha y la hora actuales) para darle tal formato con FormatDateTime.

Es decir, es normal y válido usar algo como esto:

Código Delphi [-]
F := FormatDateTime ('yyyy-mm-dd"T"hh:nn:ss', Now);

Pero podemos recurrir a algo más sencillo:

Código Delphi [-]
F := ghISODateTime;

No perdamos de vista que con frecuencia escribimos grupos de sentencias que contienen varias expresiones, a veces unas dentro de otras, en bloques de código fuente que pueden volverse algo complejos aunque se compongan de unas cuantas líneas. Cuando reducimos el tamaño de las expresiones (sin quitarles del todo su expresividad), conseguimos un código fuente más manejable.

[Casimiro Notevi]

Código Delphi [-]
F := ghISODateTime;

Lo bueno, si breve, dos veces bueno

[[Al González]]

En esta página se propone una solución que conlleva cierta cantidad de código, dentro del cual se presenta esta función:

Código Delphi [-]
  function GetTagValue(const ATag: String): String;
  var
    p: Integer;
  begin
    p := pos('=', ATag);

    if p = 0 then
      Result := ''
    else
      Result := copy(ATag, p + 1, MaxInt);
  end;

Como puede verse, si la cadena dada contiene el símbolo "=", la función devolverá la subcadena que forman todos los caracteres que estén a la derecha de ese símbolo. Y de no incluir el símbolo de igualdad, entonces devolverá cadena vacía.

Observen cómo el código de dicha función puede reducirse a una sola sentencia si ponemos GHFRTL en el Uses:

Código Delphi [-]
  Function GetTagValue (Const ATag :String) :String;
  Begin
    Result := ghRightOf (ATag, '=');
  End;

La nueva GetTagValue hará exactamente el mismo trabajo, pero con menos esfuerzo por parte de quien escribe la función y sobre todo de quienes luego la lean.

Obtener lo que una cadena lleva a la derecha de un carácter específico es algo tan común, que justificó la existencia de la función ghRightOf.

Este hilo, como los demás, está abierto a cualquier duda o inquietud que deseen expresar.

Saludos.

[[Al González]]

Con la función ghEnable, de la unidad GHFUtils, podemos habilitar o inhabilitar un grupo de controles (componentes visuales), sin tener que escribir una instrucción "Control.Enabled := ..." por cada uno.

Tomo como ejemplo este caso, donde el código que se propone es esencialmente:

Código Delphi [-]
Procedure ...
Var
  B :Boolean;
Begin
  B := qry_edo_habestatus.value = 'DES';
  BTN1.Enabled := B;
  BTN2.Enabled := Not B;
  BTN3.Enabled := Not B;
  BTN4.Enabled := Not B;
  BTN5.Enabled := Not B;
  BTN6.Enabled := Not B;
End;

Usando GHF, podría reducirse a:

Código Delphi [-]
Procedure ...
Begin
  BTN1.Enabled := qry_edo_habestatus.value = 'DES';
  ghEnable ([BTN2, BTN3, BTN4, BTN5, BTN6], Not BTN1.Enabled);
End;

Como puede apreciarse, pasamos de siete a sólo dos instrucciones y nos ahorramos la variable de tipo Boolean. Así pues, escribimos menos código sin restarle demasiada comprensibilidad. Además, cuando se tenga la necesidad de agregar otro botón al grupo, tan sólo habremos de añadir una coma, un espacio y el nombre del botón, por ejemplo ", BTN7", en lugar de una sentencia completa "BNT7.Enabled := ...".

El uso de estas simplificaciones de código permite generar programas más concisos, y también más manejables a través del tiempo: No es lo mismo comenzar a modificar una unidad de 700 líneas de código que no habíamos abierto en cinco años, que hacer lo mismo con una unidad de 250 líneas. El código repetitivo puede ser un obstáculo importante a la hora de dar mantenimiento a los sistemas.

Saludos cordiales.

[jhonny]

Una función muy útil, muchas veces uno necesita algo así y no se detiene a pensar que podría ayudarle, gracias Al .

[Casimiro Notevi]

Una duda, curiosidad: ¿por qué el espacio en blanco tras la coma?

[[Al González]]

Empezado por jhonny

Una función muy útil, muchas veces uno necesita algo así y no se detiene a pensar que podría ayudarle, gracias Al .

Un placer Jhonny, gracias.

Empezado por Casimiro Notevi

Una duda, curiosidad: ¿por qué el espacio en blanco tras la coma?

Hola Casi, es sólo una cuestión de estilo, para mayor legibilidad.

[[Al González]]

Quienes han usado directamente la API de Windows tendrán muy presente que esta no suele elevar excepciones al ocurrir una situación de error. En lugar de eso, la API de Windows establece un código de error numérico que podemos recuperar con la función GetLastError. A veces es necesario convertir este código de error a algo que sea relativamente comprensible para el usuario de la aplicación (aunque más útil para el programador que recibirá el reporte del usuario), y para ello Delphi cuenta con la función SysErrorMessage, la cual envuelve a la función FormatMessage del sistema operativo.

También es común que, una vez obtenido el texto del error, queramos elevar una excepción Delphi con él. Así ocurre por ejemplo en este caso:

Código Delphi [-]
else
  raise Exception.Create(SysErrorMessage(GetLastError));

Con GHF, para obtener el texto del error, podemos usar la función ghLastErrorMsg:

Código Delphi [-]
else
  raise Exception.Create (ghLastErrorMsg);

Pero podemos simplificar un poco más toda la sentencia usando la función ghRaiseLastError:

Código Delphi [-]
else
  ghRaiseLastError;

Internamente, esta función llama a ghLastErrorMsg y eleva una excepción con el texto del error. Además, ghRaiseLastError admite un parámetro opcional de tipo String para indicar el formato a dar al mensaje de error. Si no se especifica el formato, se utiliza el predeterminado '%s (GetLastError %d).', viéndose el mensaje de excepción como en este ejemplo:



El formato se aplica con la función estándar Format que todos conocemos. "%s" indica en qué parte del mensaje de excepción debe ghRaiseLastError poner el texto del error devuelto por ghLastErrorMsg. "%d" significa que en esa posición debe aparecer el código de error numérico que arrojó GetLastError. Cualquiera de los dos comodines puede ser omitido, por lo que el formato de la excepción es totalmente flexible. Sólo considerar que en la llamada interna a Format, el texto del error es el primer parámetro y el código numérico el segundo. Otro ejemplo:

Código Delphi [-]
ghRaiseLastError ('No fue posible realizar la operación.'#13#10 +
  'Error interno %1:d (%0:s).');

Resultado:



Posteriormente agregaré la documentación detallada de estas dos funciones al manual de referencia.

Un saludo.

Al González.

[[Al González]]

Me alegra saber que en el club hay compañeros que sí aprecian y valoran de buena fe los ejemplos que he venido escribiendo sobre el uso de GH Freebrary.

Pongamos uno más, simplificando ligeramente este código del compañero wilcg:

Código Delphi [-]
Uses
  GHFRTL;
...
  with Query do
  begin
    SQL.Clear;
    SQL.Add ('Select * from pagos');
    SQL.Add ('where codventa = ' + QuotedStr (edtCodigo.Text));
    SQL.Add ('and f_venta = ' + ghQuotedSQLDate (edtFVdenta.Date)) ;
    SQL.Add ('and f_pago between ');
    SQL.Add (ghQuotedSQLDate (edtDesde.Date));
    SQL.Add ('and '+ ghQuotedSQLDate (Date));
    SQL.Add ('Order By f_pago desc');
    Open;
  end;

La función ghQuotedSQLDate convierte un valor de tipo fecha en su representación literal SQL, es decir, bajo el formato universal aaaa-mm-dd y con una comilla a cada lado. La fecha de hoy, por ejemplo, queda como '2014-08-22' lo cual permite añadirla a cualquier sentencia SQL como el Select del ejemplo. Sin el potencial problema de la configuración regional del sistema operativo o del motor de la base de datos.

[TiammatMX]

Empezado por Al González

... Sin el potencial problema de la configuración regional del sistema operativo o del motor de la base de datos...

Hace un año, ésta función me habría salvado de dos desveladas seguidas peléandome con MSSQLServer y su "bendita" manera de pedir la fecha... ¬¬

¡¡Gracias, compadre!!

[pacopenin]

. Tengo que dedicarle algo de tiempo, pero a veces somos tan cabezotas....