Difference between revisions of "Show Application Title, Version, and Company"
(→FPC 2.7.1/trunk: Works on Linux, too. probably osx as well...) |
(added cross platform revision tool) |
||
Line 111: | Line 111: | ||
end; | end; | ||
end. | end. | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | == 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: | ||
+ | <syntaxhighlight> | ||
+ | // Created by Svn2RevisionInc | ||
+ | const RevisionStr = '43594'; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 15:31, 26 December 2013
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).
Overview
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.
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.
Implementations using FPC 2.6.x
Contribution via the mailing list: [1]
Use this like
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 } ;
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: [4]
The code belows shows how to get executable info out of
- .exe/.dll files (Windows format)
- Lazarus-compiled ELF executables (Linux)
- Lazarus-compiled MACH-O executables (OSX) (untested, please update this once tested)
regardless of the platform the code is running on.
program printfileinfo;
{ Displays file version info for
- Windows PE executables
- Linux ELF executables (compiled by Lazarus)
- probably OSX MACH-O executables (compiled by Lazarus)
Runs on Windows, Linux, OSX...)
}
{$mode objfpc}{$H+}
uses
{$IFDEF UNIX}{$IFDEF UseCThreads}
cthreads,
{$ENDIF}{$ENDIF}
Classes,sysutils
// FPC trunk 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;
begin
if Paramcount=0 then
begin
writeln('Missing executable filename parameters. Aborting.');
halt(1);
end;
FileVerInfo:=TFileVersionInfo.Create(nil);
try
FileVerInfo.FileName:=paramstr(1);
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.
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.