Difference between revisions of "Show Application Title, Version, and Company"

From Free Pascal wiki
Jump to navigationJump to search
(→‎FPC 2.7.1/trunk: sample program)
(Add see also section)
 
(30 intermediate revisions by 10 users not shown)
Line 1: Line 1:
''This article is a placeholder containing links to code, some of which might be obsolete as of late 2013 (Lazarus 1.0, FPC 2.6.2).''
+
{{LanguageBar}}
 +
== Overview ==
  
== Overview ==
+
=== Windows ===
From its earliest versions, Microsoft Windows had the capability of storing version information etc. in an executable file. Support for that was added to Delphi around v3, and was part-functional in Lazarus 0.9.24.
+
From its earliest versions, Microsoft Windows had the capability of storing version information etc. in an executable file. Support for that was added to Delphi around v3, and was partly functional in Lazarus 0.9.24.
  
 
=== Linux ===
 
=== Linux ===
There is no implicit provision in the ELF file format for version numbers, copyright and so on, but Lazarus stores this in resource sections. Reading the information back at runtime relies on FPC units, below are some pointers that might be useful.
+
There is no implicit provision in the ELF file format for version numbers, copyright and so on, but Lazarus stores this in resource sections. Reading the information back at runtime relies on FPC units, below is some useful information.
 +
 
 +
=== macOS and iOS ===
 +
On macOS, Lazarus file version information can be stored in two locations:
 +
* the MACH-O executable (like on Windows, Linux); see below
 +
* the application bundle (if present) in a plist. See [[Mac Show Application Title, Version, and Company]] for details.
 +
 
 +
== Implementations ==
 +
=== FPC 3.0+ ===
 +
 
 +
Implementation in FPC 3.0.x using [[fcl-res]]: see [[User_Changes_3.0#TVersionInfo_.28fileinfo_unit.29_re-implemented_in_a_platform_independent_way| announcement in User Changes 3.0]].
 +
 
 +
The code below shows how to get executable info out of:
 +
 +
* .exe/.dll/.ocx files (Windows format)
 +
* Lazarus-compiled ELF executables (Linux)
 +
* Lazarus-compiled MACH-O executables (macOS)
 +
 
 +
<syntaxhighlight lang="pascal">
 +
program printfileinfo;
 +
 
 +
{
 +
  Displays file version info for
 +
- Windows PE executables
 +
- Linux ELF executables (compiled by Lazarus)
 +
- macOS MACH-O executables (compiled by Lazarus)
 +
  Runs on Windows, Linux, macOS
 +
}
 +
 
 +
{$mode objfpc}{$H+}
 +
{$ifdef mswindows}{$apptype console}{$endif}
 +
uses
 +
  {$IFDEF UNIX}{$IFDEF UseCThreads}
 +
  cthreads,
 +
  {$ENDIF}{$ENDIF}
 +
  Classes,sysutils
 +
  // FPC 3.0 fileinfo reads exe resources as long as you register the appropriate units
 +
  , fileinfo
 +
  , winpeimagereader {need this for reading exe info}
 +
  , elfreader {needed for reading ELF executables}
 +
  , machoreader {needed for reading MACH-O executables}
 +
  ;
 +
 
 +
var
 +
  FileVerInfo: TFileVersionInfo;
 +
 
 +
{$R *.res}
 +
 
 +
begin
 +
  FileVerInfo:=TFileVersionInfo.Create(nil);
 +
  try
 +
    FileVerInfo.ReadFileInfo;
 +
    writeln('Company: ',FileVerInfo.VersionStrings.Values['CompanyName']);
 +
    writeln('File description: ',FileVerInfo.VersionStrings.Values['FileDescription']);
 +
    writeln('File version: ',FileVerInfo.VersionStrings.Values['FileVersion']);
 +
    writeln('Internal name: ',FileVerInfo.VersionStrings.Values['InternalName']);
 +
    writeln('Legal copyright: ',FileVerInfo.VersionStrings.Values['LegalCopyright']);
 +
    writeln('Original filename: ',FileVerInfo.VersionStrings.Values['OriginalFilename']);
 +
    writeln('Product name: ',FileVerInfo.VersionStrings.Values['ProductName']);
 +
    writeln('Product version: ',FileVerInfo.VersionStrings.Values['ProductVersion']);
 +
  finally
 +
    FileVerInfo.Free;
 +
  end;
 +
end.
 +
</syntaxhighlight>
  
=== Implementations using FPC 2.6.x ===
+
=== Implementations using legacy FPC 2.6.x ===
Contribution via the mailing list: [http://lists.lazarus.freepascal.org/pipermail/lazarus/attachments/20100723/8db6b97e/attachment.ksh]
+
Uses [[fcl-res]]; contribution via the mailing list: [http://lists.lazarus.freepascal.org/pipermail/lazarus/attachments/20100723/8db6b97e/attachment.ksh]
  
 
Use this like
 
Use this like
<syntaxhighlight>
+
<syntaxhighlight lang="pascal">
 +
uses
 +
  resource, versiontypes, versionresource;
 +
 
 
  FUNCTION resourceVersionInfo: STRING;
 
  FUNCTION resourceVersionInfo: STRING;
 
   
 
   
Line 53: Line 121:
 
Using vinfo: [http://forum.lazarus.freepascal.org/index.php?topic=12435.0] and [http://forum.lazarus.freepascal.org/index.php?topic=13957.0]
 
Using vinfo: [http://forum.lazarus.freepascal.org/index.php?topic=12435.0] and [http://forum.lazarus.freepascal.org/index.php?topic=13957.0]
  
On an Apple OSX machine: [[Mac Show Application Title, Version, and Company]]
 
 
=== FPC 2.7.1/trunk ===
 
Implementation in FPC 2.7.1 using [[fcl-res]]: [http://wiki.lazarus.freepascal.org/User_Changes_Trunk#TVersionInfo_.28fileinfo_unit.29_re-implemented_in_a_platform_independent_way]
 
 
The code belows shows how to get stanard executable info out of .exe/.dll files (Windows format) regardless of the platform the code is running on.
 
Depending on the format Lazarus uses to encode version info on other platforms, it could be extended for those platforms (e.g. ELF for Linux, MACHO for OSX):
 
<syntaxhighlight>
 
program printfileinfo;
 
{ Displays file version info for Windows PE executables (runs on Windows, Linux, OSX...)}
 
  
{$mode objfpc}{$H+}
 
  
uses
+
== Related tips ==
  {$IFDEF UNIX}{$IFDEF UseCThreads}
+
=== SVN/Git/Hg/Mercurial revision ===
  cthreads,
+
Use $(lazarusdir)/tools/svn2revisioninc to get revision number (from a subversion, git or mercurial repository) into a file revision.inc, e.g. something like:
  {$ENDIF}{$ENDIF}
+
<syntaxhighlight lang="pascal">
  Classes,sysutils
+
// Created by Svn2RevisionInc
  // FPC trunk fileinfo reads exe resources as long as you register the appropriate units
+
const RevisionStr = '43594';
  , fileinfo
 
  , winpeimagereader {need this for reading exe info}
 
  {todo: add required image formats, e.g.
 
  machoreader for osx
 
  elfreader for linux
 
  and verify if this works for those file formats
 
  ;
 
 
 
var
 
  WindowsInfo: TFileVersionInfo;
 
begin
 
  if Paramcount=0 then
 
  begin
 
    writeln('Missing executable filename parameters. Aborting.');
 
    halt(1);
 
  end;
 
  WindowsInfo:=TFileVersionInfo.Create(nil);
 
  try
 
    WindowsInfo.FileName:=paramstr(1);
 
    WindowsInfo.ReadFileInfo;
 
    writeln('Company: ',WindowsInfo.VersionStrings.Values['CompanyName']);
 
    writeln('File description: ',WindowsInfo.VersionStrings.Values['FileDescription']);
 
    writeln('File version: ',WindowsInfo.VersionStrings.Values['FileVersion']);
 
    writeln('Internal name: ',WindowsInfo.VersionStrings.Values['InternalName']);
 
    writeln('Legal copyright: ',WindowsInfo.VersionStrings.Values['LegalCopyright']);
 
    writeln('Original filename: ',WindowsInfo.VersionStrings.Values['OriginalFilename']);
 
    writeln('Product name: ',WindowsInfo.VersionStrings.Values['ProductName']);
 
    writeln('Product version: ',WindowsInfo.VersionStrings.Values['ProductVersion']);
 
  finally
 
    WindowsInfo.Free;
 
  end;
 
end.
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 119: Line 144:
  
 
Put this into the program:
 
Put this into the program:
<syntaxhighlight>
+
<syntaxhighlight lang="pascal">
 
   (*$IFDEF UNIX  *)
 
   (*$IFDEF UNIX  *)
 
           rev= (*$I project_svnrevision.inc *) ;
 
           rev= (*$I project_svnrevision.inc *) ;
Line 147: Line 172:
 
That should be a single line. Note quote and backtick positions.
 
That should be a single line. Note quote and backtick positions.
  
[[Category:Mac OS X]]
+
== See also ==
 +
 
 +
* [[TVersionResource]]
 +
 
 +
[[Category:macOS]]
 
[[Category:Linux]]
 
[[Category:Linux]]
 
[[Category:Windows]]
 
[[Category:Windows]]

Latest revision as of 07:23, 22 August 2020

English (en) русский (ru)

Overview

Windows

From its earliest versions, Microsoft Windows had the capability of storing version information etc. in an executable file. Support for that was added to Delphi around v3, and was partly functional in Lazarus 0.9.24.

Linux

There is no implicit provision in the ELF file format for version numbers, copyright and so on, but Lazarus stores this in resource sections. Reading the information back at runtime relies on FPC units, below is some useful information.

macOS and iOS

On macOS, Lazarus file version information can be stored in two locations:

Implementations

FPC 3.0+

Implementation in FPC 3.0.x using fcl-res: see announcement in User Changes 3.0.

The code below shows how to get executable info out of:

  • .exe/.dll/.ocx files (Windows format)
  • Lazarus-compiled ELF executables (Linux)
  • Lazarus-compiled MACH-O executables (macOS)
program printfileinfo;

{ 
  Displays file version info for 
- Windows PE executables 
- Linux ELF executables (compiled by Lazarus)
- macOS MACH-O executables (compiled by Lazarus)
  Runs on Windows, Linux, macOS
}

{$mode objfpc}{$H+}
{$ifdef mswindows}{$apptype console}{$endif}
uses
  {$IFDEF UNIX}{$IFDEF UseCThreads}
  cthreads,
  {$ENDIF}{$ENDIF}
  Classes,sysutils
  // FPC 3.0 fileinfo reads exe resources as long as you register the appropriate units
  , fileinfo
  , winpeimagereader {need this for reading exe info}
  , elfreader {needed for reading ELF executables}
  , machoreader {needed for reading MACH-O executables}
  ;

var
  FileVerInfo: TFileVersionInfo;

{$R *.res}

begin
  FileVerInfo:=TFileVersionInfo.Create(nil);
  try
    FileVerInfo.ReadFileInfo;
    writeln('Company: ',FileVerInfo.VersionStrings.Values['CompanyName']);
    writeln('File description: ',FileVerInfo.VersionStrings.Values['FileDescription']);
    writeln('File version: ',FileVerInfo.VersionStrings.Values['FileVersion']);
    writeln('Internal name: ',FileVerInfo.VersionStrings.Values['InternalName']);
    writeln('Legal copyright: ',FileVerInfo.VersionStrings.Values['LegalCopyright']);
    writeln('Original filename: ',FileVerInfo.VersionStrings.Values['OriginalFilename']);
    writeln('Product name: ',FileVerInfo.VersionStrings.Values['ProductName']);
    writeln('Product version: ',FileVerInfo.VersionStrings.Values['ProductVersion']);
  finally
    FileVerInfo.Free;
  end;
end.

Implementations using legacy FPC 2.6.x

Uses fcl-res; contribution via the mailing list: [1]

Use this like

uses
  resource, versiontypes, versionresource;

 FUNCTION resourceVersionInfo: STRING;
 
 (* Unlike most of AboutText (below), this takes significant activity at run-    *)
 (* time to extract version/release/build numbers from resource information      *)
 (* appended to the binary.                                                      *)
 
 VAR     Stream: TResourceStream;
         vr: TVersionResource;
         fi: TVersionFixedInfo;
 
 BEGIN
   RESULT:= '';
   TRY
 
 (* This raises an exception if version info has not been incorporated into the  *)
 (* binary (Lazarus Project -> Project Options -> Version Info -> Version        *)
 (* numbering).                                                                  *)
 
     Stream:= TResourceStream.CreateFromID(HINSTANCE, 1, PChar(RT_VERSION));
     TRY
       vr:= TVersionResource.Create;
       TRY
         vr.SetCustomRawDataStream(Stream);
         fi:= vr.FixedInfo;
         RESULT := 'Version ' + IntToStr(fi.FileVersion[0]) + '.' + IntToStr(fi.FileVersion[1]) +
                ' release ' + IntToStr(fi.FileVersion[2]) + ' build ' + IntToStr(fi.FileVersion[3]) + eol;
         vr.SetCustomRawDataStream(nil)
       FINALLY
         vr.Free
       END
     FINALLY
       Stream.Free
     END
   EXCEPT
   END
 END { resourceVersionInfo } ;


Using vinfo: [2] and [3]


Related tips

SVN/Git/Hg/Mercurial revision

Use $(lazarusdir)/tools/svn2revisioninc to get revision number (from a subversion, git or mercurial repository) into a file revision.inc, e.g. something like:

// Created by Svn2RevisionInc
const RevisionStr = '43594';

Unix-only hacks

These work with Linux on various platforms, and probably with Solaris provided that the GNU-derived utilities are installed.

Getting Subversion revision information as a program-accessible string

Put this into Project options -> Compilation -> Execute before -> Command:

/bin/sh -c "echo -n C`svnversion -n`C |tr A-G %-+ >project_svnrevision.inc"

Note quote and backtick positions. The tr is converting C into another layer of quotes which is necessary for things to work as required.

Put this into the program:

   (*$IFDEF UNIX   *)
           rev= (*$I project_svnrevision.inc *) ;
   (*$ELSE         *)
           rev= 'unimplemented';
   (*$ENDIF        *)

Note that that has to be a string, since the revision number will have a non-numeric suffix if the project has been updated since it was last committed.

Renaming the final executable to include platform and timestamp

Put this into Project options -> Paths -> Unit output directory:

lib/$(TargetCPU)-$(TargetOS)

Put this into Project options -> Paths -> Target file name:

UnyokedBackend-$(TargetCPU)-$(TargetOS)-$(LCLWidgetType)

Make sure that "Apply conventions" is ticked (checked). This might vary slightly according to IDE and compiler/linker versions.

Put this into Project options -> Compilation -> Execute after -> Command:

 /bin/sh -c "mv libunyokedbackend-$(TargetCPU)-$(TargetOS)-$(LCLWidgetType).so UnyokedBackend-$(TargetCPU)-$(TargetOS)-$(LCLWidgetType).`date +%F.%R`.so"

That should be a single line. Note quote and backtick positions.

See also