Programmatically updating FILEVERSION in a MFC app w/SVN revision number - windows

How do I go about programmatically updating the FILEVERSION string in an MFC app? I have a build process that I use to generate a header file which contains the SVN rev for a given release. I'm using SvnRev from http://www.compuphase.com/svnrev.htm to update a header file which I use to set the caption bar of my MFC app. Now I want to use this #define for my FILEVERION info.
What's the best way to proceed?

An .rc file can #include header files just like .c files can. I have an auto-generated version.h file, which defines things like:
#define MY_PRODUCT_VERSION "0.47"
#define MY_PRODUCT_VERSION_NUM 0,47,0,0
Then I just have my .rc file #include "version.h" and use those defines.
VS_VERSION_INFO VERSIONINFO
FILEVERSION MY_PRODUCT_VERSION_NUM
PRODUCTVERSION MY_PRODUCT_VERSION_NUM
...
VALUE "FileVersion", MY_PRODUCT_VERSION "\0"
VALUE "ProductVersion", MY_PRODUCT_VERSION "\0"
...
I haven't tried this technique with an MFC project. It might be necessary to move your VS_VERSION_INFO resource to your .rc2 file (which won't get edited by Visual Studio).

Don't have enough points to comment yet, but whatever solution you choose keep in mind that FILEVERSION fields can only support a short integer. In our situation, our SVN revision was already above this and resulted in an invalid revision number in our FILEVERSION.

In your application.rc file there is a version block. This block controls the version info displayed in the filesystem.
VS_VERSION_INFO VERSIONINFO
FILEVERSION 1,0,0,1
PRODUCTVERSION 1,0,0,1
You can programmatically update this file. Make sure to open and save the file as binary. We have had issues where edits are done as text and the file gets corrupted.

Changing VS_VERSION_INFO will reflect when you right click on the file in Explorer and see properties only.
If you want to show the current SVN revision number in the Caption bar, i would suggest:
Have a script get the version number and generate version.h file just with
#define SVN_VERSION_NO xxx
Your project includes this version.h and uses that number to show in caption.

Maybe this can be helpful: Versioning Controlled Build

Related

Editing .rc resource files via script or command line?

Trying to automate some of our processes in a C++ Windows app build using Jenkins. What we would like to do is make the updating of the version information in the resource file (.rc) automatic. Currently there is a script that prompts user for which version that they want to release, and preps everything for automated building, i.e. creates branch etc.
We would like part of the process to update the .rc file. Are there tools to edit .rc files programatically that can be run from the command line?
First of all, you should put the code below in a .rc2 file that is neither interpreted nor modified by Visual Studio and include that file in your .rc file.
In order to yield the version strings, you need two helper functions that concatenate the stringified numbers into a string.
The variables F1 through F4 can be defined by including a header file. Ideally you would create a header from the user input that defines just those four variables. This keeps the whole rest of your code base unchanged. The method is identical for the product verion.
#define F1 1 // Defined by an included header
#define F2 2
#define F3 3
#define F4 4
// MyAppVersionInfo.rc2
#define STRTMP(V1, V2, V3, V4) #V1 "." #V2 "." #V3 "." #V4
#define STR(V1, V2, V3, V4) STRTMP(V1, V2, V3, V4)
#define FVC F1,F2,F3,F4
#define FVS STR(F1,F2,F3,F4)
VS_VERSION_INFO VERSIONINFO
FILEVERSION FVC
...
VALUE "FileVersion", FVS
Note that I chose very short identifiers in this example to keep stackoverflow.com happy.

Trying to open a file in C++, but the file cannot be found

I have an algorithm in C++ (main.cpp) and I use CLion to compile and run it. Algorithm would read strings from text file, but there is a mistake:
Could not open data.txt (file exists and placed in one folder with main.cpp)
How can I fix it and make this file "visible" to CLion?
If you are using fopen or something similar and just passing "data.txt", it is assumed that that file is in the current working directory of the running program (the one you just compiled).
So, either
Give a full path instead, like fopen("/full/path/to/data.txt"), where you use the actual full path
(not preferable), Move data.txt to the directory where CLion runs its compiled programs from.
(for #2, here's a hacky way to get that directory)
char buf[1024]; // hack, but fine for this
printf("%s\n", getcwd(buf, 1024));
Run/Edit configurations...
Select your application (on the lefthandside of the window)
Specify Working directory
Apply
Now you can fopen relatively from working directory.
I found another way to solve this problem.
#Lou Franco's solution may affect the project structure. For example, if I deploy code on a server, I should move the resource file to specific directory.
What I do is modify the CmakeLists.txt, on Windows, using
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "D:\\science\\code\\English-Prediction")
CMAKE_RUNTIME_OUTPUT_DIRECTORY is a CMake variable, it assigns the work directory of CLion work directory.
Continuing with the CMAKE_RUNTIME_OUTPUT_DIRECTORY CMakeLists variables, I do the following. In the root directory of my project, I create a directory, e.g., out. Then, in my CMakeLists.txt I set the CMAKE_RUNTIME_OUTPUT_DIRECTORY to that directory:
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/out)
Note, that must come before you have
add_executable(YourProject ${SOURCE_FILES})
I might also add that instead of using fopen() I would keep it more object-oriented by using std::ifstream:
std::ifstream inFile("data.txt");
// check if it opened without issue...
if (!inFile) {
processError(); // a user-defined function to deal with the issue
} else {
// All is good, carry on...
// and when you're done don't forget
inFile.close();
}

do not include required files into vim omnicompletion

If I try to autocomplete smth in a Ruby file, that has require 'xxx' statement, it starts to scan all files required (and files required by required files as well). and it does that every freakin time!
Is it possible to make vim autocomplete to NOT scan required files or just files in particular path (e.g. app/ only)?
One of the following should work
:set path=.,/myinclude1,/myinclude2 to set your own include path
:set complete-=i to disable use of included files in default completion
:set include= to unset the include file matching pattern
I would suggest you use the second one, so CTRL-X CTRL-I will still work correctly

How do I add an icon to a mingw-gcc compiled executable?

In Windows, using mingw's gcc, is there anyway to specify that the output exe file is to take an icon file, so that the exe file shows with that icon in explorer?
You need to create the icon first. Then you need to create a RC file with the below content. Here we'll name it as my.rc.
id ICON "path/to/my.ico"
The id mentioned in the above command can be pretty much anything. It doesn't matter unless you want to refer to it in your code. Then run windres as follows:
windres my.rc -O coff -o my.res
Then while building the executable, along with other object files and resource files, include my.res which we got from the above step. e.g.:
g++ -o my_app obj1.o obj2.o res1.res my.res
And that should be all there is to it.
And, at no extra charge, if you want to include version information in your
application, add the following boilerplate to a new .rc file and follow the above mentioned steps.
1 VERSIONINFO
FILEVERSION 1,0,0,0
PRODUCTVERSION 1,0,0,0
BEGIN
BLOCK "StringFileInfo"
BEGIN
BLOCK "080904E4"
BEGIN
VALUE "CompanyName", "My Company Name"
VALUE "FileDescription", "My excellent application"
VALUE "FileVersion", "1.0"
VALUE "InternalName", "my_app"
VALUE "LegalCopyright", "My Name"
VALUE "OriginalFilename", "my_app.exe"
VALUE "ProductName", "My App"
VALUE "ProductVersion", "1.0"
END
END
BLOCK "VarFileInfo"
BEGIN
VALUE "Translation", 0x809, 1252
END
END
Note, the langID is for U.K. English (which is the closest localisation to
Australia I could identify.) If you want U.S. "English" then change the BLOCK
line to:
BLOCK "040904E4"
and the translation line to:
VALUE "Translation", 0x409, 1252
See VERSIONINFO resource for for info.
In the RC file, the nameID does not even have to be a name, it can just be
an integer. The filename must be quoted only if it contains a space. Instead
of:
windres my.rc -O coff -o my.res
You can use:
windres my.rc my.o
ICON resource
windres man page
Example
Try Resource Hacker. I was able to cross compile my project in Linux (WSL) and generate an icon from the logo on the homepage. Just needed a simple way to embed it in the exe and this program worked great.
Resource Hacker by Angus Johnson

How to programmatically change a project's product version?

I have several deployment projects. In order to deploy an application, I need to do several tasks, one of them is to change each deployment project's product version and product code.
I can't find a way to programmatically change them.
Since it's a Deployment project (which finally produces an executable installer), I'm not able to work with MSBuild, instead I'm using the Devenv from the command prompt.
I was searching for the exact same thing today. I found this using google:
static void Main(string[] args)
{
string setupFileName = #"<Replace the path to vdproj file>";
StreamReader reader = File.OpenText(setupFileName);
string file = string.Empty;
try
{
Regex expression = new Regex(#"(?:\""ProductCode\"" =
\""8.){([\d\w-]+)}");
Regex expression1 = new Regex(#"(?:\""UpgradeCode\"" =
\""8.){([\d\w-]+)}");
file = reader.ReadToEnd();
file = expression.Replace(file, "\"ProductCode\" = \"8:{" +
Guid.NewGuid().ToString().ToUpper() + "}");
file = expression1.Replace(file, "\"UpgradeCode\" = \"8:{"
+ Guid.NewGuid().ToString().ToUpper() + "}");
}
finally
{
// Close the file otherwise the compile may not work
reader.Close();
}
TextWriter tw = new StreamWriter(setupFileName);
try
{
tw.Write(file);
}
finally
{
// close the stream
tw.Close();
}
}
I know that the original poster is looking for a .NET 2.0 solution to this problem. However, since this wasn't tagged as .NET, I'll offer up my C++ solution to the problem. This may be applicable in .NET land, but I'll leave that to others.
This not only updates the version information in the about box and log file for my application, but also all of the Windows version info that is seen in Windows Explorer.
UPDATE: Added some changes that I've made to the process since my original answer.
First off, I moved the entire version info block from my Project.rc file to my Project.rc2 file:
/////////////////////////////////////////////////////////////////////////////
//
// Version
//
VS_VERSION_INFO VERSIONINFO
FILEVERSION FILE_VER
PRODUCTVERSION PROD_VER
FILEFLAGSMASK 0x3fL
#ifdef _DEBUG
FILEFLAGS 0x1L
#else
FILEFLAGS 0x0L
#endif
FILEOS 0x4L
FILETYPE 0x1L
FILESUBTYPE 0x0L
BEGIN
BLOCK "StringFileInfo"
BEGIN
BLOCK "040904e4"
BEGIN
VALUE "CompanyName", "MyCompany"
VALUE "FileDescription", "Software Description"
VALUE "FileVersion", 1,0,0,1
VALUE "InternalName", "FileName.exe"
VALUE "LegalCopyright", "(c) 2008 My Company. All rights reserved."
VALUE "OriginalFilename", "FileName.exe"
VALUE "ProductName", "Product Name"
VALUE "ProductVersion", 1,0,0,1
END
END
BLOCK "VarFileInfo"
BEGIN
VALUE "Translation", 0x409, 1252
END
END
This essentially transports all of the version info stuff that you would edit from the resource editor into a separate file. This makes it so that you don't get errors when editing the resource file from outside of the editor. The downside is that you can no longer edit the version info from the resource editor. But, since we want this stuff updated automatically, that isn't a big deal.
Next, I created a VersionInfo.h file and added it to my project:
#pragma once
//major release version of the program, increment only when major changes are made
#define VER_MAJOR 2
//minor release version of the program, increment if any new features are added
#define VER_MINOR 0
//any bugfix updates, no new features
#define VER_REV 0
//if this is some special release (e.g. Alpha 1) put the special release string here
#define STR_SPECIAL_REL "Alpha 1"
#define FILE_VER VER_MAJOR,VER_MINOR,VER_REV
#define PROD_VER FILE_VER
//these are special macros that convert numerical version tokens into string tokens
//we can't use actual int and string types because they won't work in the RC files
#define STRINGIZE2(x) #x
#define STRINGIZE(x) STRINGIZE2(x)
#define STR_FILE_VER STRINGIZE(VER_MAJOR) "." STRINGIZE(VER_MINOR) "." STRINGIZE(VER_REV)
#define STR_PROD_VER STR_FILE_VER " " STR_SPECIAL_REL
#define STR_COPYRIGHT_INFO "©" BuildYear " Your Company. All rights reserved."
I then included VersionInfo.h in the rc2 file and made the following changes:
#include "VersionInfo.h"
/////////////////////////////////////////////////////////////////////////////
//
// Version
//
<no changes>
VALUE "FileVersion", STR_FILE_VER
<no changes>
VALUE "LegalCopyright", STR_COPYRIGHT_INFO
<no changes>
VALUE "ProductVersion", STR_PROD_VER
<no changes>
With this setup, I could edit my build script (which uses Perl) to modify the version info in the VersionInfo.h file before rebuilding the entire project using the devenv command line.
One additional step that I added that may also be of interest (although it is not completely perfected yet, and may be a future question here) is to generate a unique build number every time the project is built. In the current incarnation, it always works for complete rebuilds, but only sporadically on incremental builds. What I did was create a file called build_number.incl that contains the following:
#define CurrentBuildNumber "20081020P1525"
Which is essentially the date and time that the build was started. I created a batch file that is run as a pre-build event to the project that generates this file. The script also defines BuildYear so that the copyright in the VersionInfo.h file always contains the year of the most recent build. The batch script is the following:
echo Generating Build Number
#For /F "tokens=2,3,4 delims=/ " %%A in ('Date /t') do #(
Set Month=%%A
Set Day=%%B
Set Year=%%C
)
#For /F "tokens=1,2,3 delims=/M: " %%A in ('Time /t') do #(
Set Hour=%%A
Set Minute=%%B
Set AmPm=%%C
)
#echo #define CurrentBuildNumber "%Year%%Month%%Day%%AmPm%%Hour%%Minute%" > "$(ProjectDir)\build_number.incl"
#echo #define BuildYear "%Year%" >> "$(ProjectDir)\build_number.incl"
echo ----------------------------------------------------------------------
This file is then included in any file in the project that needs to use the build number (i.e. the about box).
Some of this was gleaned from this CodeProject post.
Hopefully this info proves helpful.
I had the same problem, and I found out that modifying the .vdproj file in a prebuildevent does not exactly do what I like.
I used some other code to modify the msi file file after the the setup project has been build, so I use the postbuildevent.
See my blog-post here.
We use a program that updates each AssemblyInfo.cs or AssemblyInfo.vb based on a configuration file value. we run this executable before each build. That was the best we could do to automate this process. You can add a call to this batch process in your projects configuration as a pre build step.
You could use the msbuild task to update you product version. Check out this post from the MSBuild team on this subject.
Embedding SVN Revision number at compile time in a Windows app
In my answer to this question, I describe how I accomplish this task using SVN.
This may not be quite what you're after, but way back in the mists of time I wrote something called stampver, which can auto-increment a build number directly in the .exe file as a post-build step.
Resource Tuner Console
This console resource editor allows creating a reliable and repeatable
process for updating Product Version Information resources during the final
stage of the build process from the command prompt.
See specifically the batch manipulation of file version information page for greater details:
http://www.reseditor.com/rtc-solution-version-info.htm
I know this a very old thread, but here's a vbs solution to achieve the same end. Simply place this in your deployment folder next to the .vdproj file.
Function CreateGuid()
CreateGuid = Left(CreateObject("Scriptlet.TypeLib").Guid,38)
End Function
Const ForReading = 1, ForWriting = 2, ForAppending = 8
Set fso = CreateObject("Scripting.FileSystemObject")
Set RegEx = CreateObject("VBScript.RegExp")
For Each file in fso.GetFolder(".").Files
if (fso.GetExtensionName(file.Name) = "vdproj") then
WScript.Echo "Updating: " + file.Name
Set oFile = fso.OpenTextFile(file.Name, ForReading, True)
fileContents = oFile.ReadAll
oFile.Close
RegEx.Pattern = """ProductCode"" = ""8:{.*-.*-.*-.*-.*}"
fileContents=Regex.Replace(fileContents, """ProductCode"" = ""8:" & CreateGuid)
Set oFile = fso.OpenTextFile(file.Name, ForWriting, True)
oFile.Write fileContents
oFile.Close
end if
Next
Then in your real project, have a post build event similar to:
cd $(SolutionDir)\CustomWebSetup
cscript -nologo UpdateProductCode.vbs
This will update the vdproj with a new ProductCode in preparation for the next build. After the build is complete, VS will prompt for a reload of the deployment project.
Look into the use of RCS, CVS and/or subversion. I am only familiar with RCS; my understanding is that CVS is based on RCS but more comprehensive. I have read on various boards that subversion is the better, but I have never used it. RCS has been adequate for keeping track of changes and versions on all my documents and software projects.
RCS is here: http://www.cs.purdue.edu/homes/trinkle/RCS/
CVS is here: http://www.nongnu.org/cvs/
Subversion is here: http://subversion.tigris.org/

Resources