src/common/genversion.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2012 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 /** This is called at compile time and generates a suitable version.gen.
  22  *  usage: genversion git_root target_file
  23  */
  24
  25 #include <QDebug>
  26 #include <QProcess>
  27 #include <QString>
  28 #include <QStringList>
  29 #include <QRegExp>
  30 #include <QFile>
  31
  32 int main(int argc, char **argv)
  33 {
  34     if (argc < 3) {
  35         qFatal("Usage: ./genversion <git_root> <target_file>");
  36         return 255;
  37     }
  38     QString gitroot = argv[1];
  39     QString target = argv[2];
  40     QString basever, protover, clientneeds, coreneeds, descrver, dirty;
  41     QString committish, commitdate;
  42
  43     // check Git for information if present
  44     if (QFile::exists(gitroot + "/.git")) {
  45         // try to execute git-describe to get a version string
  46         QProcess git;
  47         git.setWorkingDirectory(gitroot);
  48     #ifdef Q_OS_WIN
  49         git.start("cmd.exe", QStringList() << "/C" << "git" << "describe" << "--long");
  50     #else
  51         git.start("git", QStringList() << "describe" << "--long");
  52     #endif
  53         if (git.waitForFinished(10000)) {
  54             QString descr = git.readAllStandardOutput().trimmed();
  55             if (!descr.isEmpty() && !descr.contains("fatal")) {
  56                 // seems we have a valid git describe string
  57                 descrver = descr;
  58                 // check if the workdir is dirty
  59         #ifdef Q_OS_WIN
  60                 git.start("cmd.exe", QStringList() << "/C" << "git" << "diff-index" << "--name-only" << "HEAD");
  61         #else
  62                 git.start("git", QStringList() << "diff-index" << "--name-only" << "HEAD");
  63         #endif
  64                 if (git.waitForFinished(10000)) {
  65                     if (!git.readAllStandardOutput().isEmpty()) dirty = "*";
  66                 }
  67                 // get a full committish
  68         #ifdef Q_OS_WIN
  69                 git.start("cmd.exe", QStringList() << "/C" << "git" << "rev-parse" << "HEAD");
  70         #else
  71                 git.start("git", QStringList() << "rev-parse" << "HEAD");
  72         #endif
  73                 if (git.waitForFinished(10000)) {
  74                     committish = git.readAllStandardOutput().trimmed();
  75                 }
  76                 // Now we do some replacement magic...
  77                 //QRegExp rxCheckTag("(.*)-0-g[0-9a-f]+\n$");
  78                 //QRegExp rxGittify("(.*)-(\\d+)-g([0-9a-f]+)\n$");
  79                 //gitversion.replace(rxCheckTag, QString("\\1%1").arg(dirty));
  80                 //gitversion.replace(rxGittify, QString("\\1:git-\\3+\\2%1").arg(dirty));
  81             }
  82         }
  83     }
  84
  85     // parse version.inc
  86     QFile verfile(gitroot + "/version.inc");
  87     if (verfile.open(QIODevice::ReadOnly | QIODevice::Text)) {
  88         QString ver = verfile.readAll();
  89
  90         QRegExp rxBasever("baseVersion\\s*=\\s*\"(.*)\";");
  91         if (rxBasever.indexIn(ver) >= 0)
  92             basever = rxBasever.cap(1);
  93
  94         QRegExp rxProtover("protocolVersion\\s*=\\s*(\\d+)");
  95         if (rxProtover.indexIn(ver) >= 0)
  96             protover = rxProtover.cap(1);
  97
  98         QRegExp rxClientneeds("clientNeedsProtocol\\s*=\\s*(\\d+)");
  99         if (rxClientneeds.indexIn(ver) >= 0)
 100             clientneeds = rxClientneeds.cap(1);
 101
 102         QRegExp rxCoreneeds("coreNeedsProtocol\\s*=\\s*(\\d+)");
 103         if (rxCoreneeds.indexIn(ver) >= 0)
 104             coreneeds = rxCoreneeds.cap(1);
 105
 106         if (committish.isEmpty()) {
 107             QRegExp rxCommit("distCommittish\\s*=\\s*([0-9a-f]+)");
 108             if (rxCommit.indexIn(ver) >= 0) committish = rxCommit.cap(1);
 109         }
 110
 111         QRegExp rxTimestamp("distCommitDate\\s*=\\s*([0-9]+)");
 112         if (rxTimestamp.indexIn(ver) >= 0) commitdate = rxTimestamp.cap(1);
 113         verfile.close();
 114     }
 115
 116     // generate the contents for version.gen
 117     QByteArray contents = QString("QString buildinfo = \"%1,%2,%3,%4,%5,%6,%7,%8\";\n")
 118                           .arg(basever, descrver, dirty, committish, commitdate, protover, clientneeds, coreneeds)
 119                           .toAscii();
 120
 121     QFile gen(target);
 122     if (!gen.open(QIODevice::ReadWrite | QIODevice::Text)) {
 123         qFatal("%s", qPrintable(QString("Could not write %1!").arg(target)));
 124         return EXIT_FAILURE;
 125     }
 126     QByteArray oldContents = gen.readAll();
 127     if (oldContents != contents) { // only touch the file if something changed
 128         gen.seek(0);
 129         gen.resize(0);
 130         gen.write(contents);
 131         gen.waitForBytesWritten(10000);
 132     }
 133     gen.close();
 134
 135     return EXIT_SUCCESS;
 136 }