mupp.cpp

Go to the documentation of this file.

/***************************************************************************
 
  mupp.cpp
 
  Author: Andreas Suter
  e-mail: andreas.suter@psi.ch
 
***************************************************************************/
 
/***************************************************************************
 *   Copyright (C) 2007-2026 by Andreas Suter                              *
 *   andreas.suter@psi.ch                                                  *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

 
#include <iostream>
 
#include <QObject>
#include <QScopedPointer>
#include <QApplication>
#include <QCoreApplication>
#include <QFile>
#include <QString>
#include <QStringList>
#include <QVector>
#include <QTextStream>
#include <QTimer>
 
#include "mupp_version.h"
#ifdef HAVE_GIT_REV_H
#include "git-revision.h"
#endif
#include "PmuppScript.h"
#include "PmuppGui.h"
 
//------------------------------------------------------------------------
void mupp_script_syntax()
{
  std::cout << std::endl;
  std::cout << "SCRIPT COMMANDS:" << std::endl;
  std::cout << "   Lines starting with '#', '%', or '//' are comments and will be ignored." << std::endl;
  std::cout << "   The same is true for empty lines. Comments are also allowed at the end" << std::endl;
  std::cout << "   for a command, i.e. loadPath ./ # the best place ever." << std::endl;
  std::cout << std::endl;
  std::cout << "   load <coll>     : load a collection. <coll> is the filename of the" << std::endl;
  std::cout << "                     collection (*.db, *.dat)" << std::endl;
  std::cout << "   loadPath <path> : set the load path to <path>; accepting bash variables" << std::endl;
  std::cout << "                     like $HOME, etc." << std::endl;
  std::cout << "   x <var-name>    : set a x-axis variable. <var-name> is a data tag of" << std::endl;
  std::cout << "                     the db/dat-file." << std::endl;
  std::cout << "   y <var-name>    : set a y-axis variable. <var-name> is a data tag of" << std::endl;
  std::cout << "                     the db/dat-file." << std::endl;
  std::cout << "   select <nn>     : select collection <nn>, where <nn> is the row-number" << std::endl;
  std::cout << "                     or the name of the collection to be selected." << std::endl;
  std::cout << "   selectAll       : i.e. already set addX, addY will apply to ALL collections" << std::endl;
  std::cout << "                     present." << std::endl;
  std::cout << "   savePath <path> : sets the save path to <path>; accepting bash variables" << std::endl;
  std::cout << "                     like $HOME, etc." << std::endl;
  std::cout << "   plot <fln>      : where <fln> is the file name with extension under which" << std::endl;
  std::cout << "                     the plot should be saved." << std::endl;
  std::cout << "   macro <fln>     : where <fln> is the file name under which the root macro" << std::endl;
  std::cout << "                     should be saved." << std::endl;
  std::cout << "   var <var_name> = <expr> : defines a variable." << std::endl;
  std::cout << "                             <expr> is a mathematical expression where" << std::endl;
  std::cout << "                             collection variables are addressed via the '$'," << std::endl;
  std::cout << "                             e.g. dataT is addressed by $dataT, etc." << std::endl;
  std::cout << "   var <var_name> = python : the variable is computed in a python block" << std::endl;
  std::cout << "                             <python> ... </python> given later in the script." << std::endl;
  std::cout << "                             Inside the block, collection parameters are bare" << std::endl;
  std::cout << "                             names (e.g. Sigma, SigmaErr); the block must assign" << std::endl;
  std::cout << "                             <var_name> and <var_name>Err. Requires ROOT built" << std::endl;
  std::cout << "                             with -Dtpython=ON." << std::endl;
  std::cout << "   col <nn> : <var_name>   : links <var_name> to the collection <nn>, where" << std::endl;
  std::cout << "                             <nn> is the number of the collection as defined" << std::endl;
  std::cout << "                             by the order of load, starting with 0." << std::endl;
  std::cout << std::endl;
}
 
//------------------------------------------------------------------------
void mupp_syntax()
{
  std::cout << std::endl;
  std::cout << "usage: mupp [OPTIONS] [[--path <fit-param-path>] <fit-param-file-names>]" << std::endl;
  std::cout << std::endl;
  std::cout << "OPTIONS:" << std::endl;
  std::cout << "  -h, --help: this help" << std::endl;
  std::cout << "  -v, --version: current mupp version" << std::endl;
  std::cout << "  -s <fln>, --script <fln>: <fln> being a mupp script." << std::endl;
  std::cout << "  --path <fit-param-path>: path where to look for the <fit-param-file-names>" << std::endl;
  std::cout << "  <fit-param-file-names>: list of file name(s) to be loaded." << std::endl;
  std::cout << "     allowed formats are: db, dat, msr" << std::endl << std::endl;
  mupp_script_syntax();
}
 
//------------------------------------------------------------------------
int mupp_script_read(const char *fln, QStringList &list)
{
  QFile file(fln);
  if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {
    std::cerr << std::endl;
    std::cerr << "*********" << std::endl;
    std::cerr << "**ERROR** couldn't open '" << fln << "'." << std::endl;
    std::cerr << "*********" << std::endl;
    return -1;
  }
 
  QTextStream fin(&file);
  QString line;
  int pos;
  bool inPython = false;     // true while reading a <python> ... </python> block
  QString pyBlock;
  while (!fin.atEnd()) {
    line = fin.readLine();
 
    // a <python> ... </python> block is read verbatim (indentation and the
    // characters #, %, // are significant in python) and stored as a single
    // list entry, so that the normal command processing below is bypassed.
    if (!inPython && line.trimmed().startsWith("<python>")) {
      inPython = true;
      pyBlock = line + "\n";
      continue;
    }
    if (inPython) {
      pyBlock += line + "\n";
      if (line.trimmed() == "</python>") {
        list << pyBlock;
        pyBlock.clear();
        inPython = false;
      }
      continue;
    }
 
    line = line.simplified();
    if (line.isEmpty())
      continue;
    if (line.startsWith("#") || line.startsWith("%") || line.startsWith("//"))
      continue;
    // remove all potentially present trailing comments
    pos = line.indexOf("#");
    if (pos != -1)
      line.remove(pos, line.length()-pos);
    pos = line.indexOf("%");
    if (pos != -1)
      line.remove(pos, line.length()-pos);
    pos = line.indexOf("//");
    if (pos != -1)
      line.remove(pos, line.length()-pos);
    line = line.simplified();
    // feed script list
    list << line;
  }
  if (inPython) {
    std::cerr << std::endl;
    std::cerr << "*********" << std::endl;
    std::cerr << "**ERROR** <python> block not terminated with </python> in '" << fln << "'." << std::endl;
    std::cerr << "*********" << std::endl;
    return -1;
  }
 
  return 0;
}
 
//------------------------------------------------------------------------
bool mupp_bash_variable_exists(const QString str)
{
  QString var = str;
  var.remove("$");
 
  QProcessEnvironment procEnv = QProcessEnvironment::systemEnvironment();
  QString varExpanded = procEnv.value(var, "");
  if (!varExpanded.isEmpty())
    return true;
 
  return false;
}
 
//------------------------------------------------------------------------
int mupp_script_syntax_check(QStringList &list)
{
  QString str;
  QStringList tok;
  QVector<QString> var_names;
  QVector<bool> var_linked;
  int noOfCollections = 0;
  for (int i=0; i<list.size(); i++) {
    tok.clear();
    str = list.at(i);
    if (str.startsWith("loadPath")) {
      tok = str.split(' ', Qt::SkipEmptyParts);
      if (tok.size() < 2) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. <path> is missing." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
      tok.clear();
 
      // check if bash variables are present, and if yes try to resolve them making sure they or NOT empty.
      str = str.remove("loadPath ");
      tok = str.split('/');
      for (int i=0; i<tok.size(); i++) {
        if (tok.at(i).startsWith("$")) {
          if (!mupp_bash_variable_exists(tok.at(i))) {
            std::cerr << std::endl;
            std::cerr << "****************" << std::endl;
            std::cerr << "**SYNTAX ERROR** found in command '" << list.at(i).toLatin1().constData() << "' an empty bash variable '" << tok.at(i).toLatin1().constData() << "'." << std::endl;
            std::cerr << "****************" << std::endl;
            return -2;
          }
        }
      }
    } else if (str.startsWith("load")) {
      tok = str.split(' ', Qt::SkipEmptyParts);
      if (tok.size() < 2) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. At least one collection file name is expected." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
      noOfCollections++;
    } else if (str.startsWith("x")) {
      tok = str.split(' ', Qt::SkipEmptyParts);
      if (tok.size() != 2) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. Only one variable name is accepted." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
    } else if (str.startsWith("y")) {
      tok = str.split(' ', Qt::SkipEmptyParts);
      if (tok.size() < 2) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. At least one variable name is needed." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
    } else if (str.startsWith("select ")) {
      tok = str.split(' ', Qt::SkipEmptyParts);
      if (tok.size() != 2) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. Only one row-number of collection name is accepted." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
    } else if (str.startsWith("selectAll")) {
      if (str.compare("selectAll")) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. selectAll doesn't accept any options." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
    } else if (str.startsWith("savePath")) {
      tok = str.split(' ', Qt::SkipEmptyParts);
      if (tok.size() != 2) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. Only one save path is accepted." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
    } else if (str.startsWith("plot")) {
      tok = str.split(' ', Qt::SkipEmptyParts);
      if (tok.size() != 2) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. Only one file name is accepted." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
      // check extension
      tok.clear();
      tok = str.split('.', Qt::SkipEmptyParts);
      QString ext = tok.at(tok.size()-1);
      ext = ext.toLower();
      if ((ext != "pdf") && (ext != "jpg") && (ext != "png") && (ext != "svg") && (ext != "gif")) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found extension " << ext.toLatin1().constData() << " in '" << str.toLatin1().constData() << "' which is not supported." << std::endl;
        std::cerr << "   Currently only: pdf, jpg, png, svg, and gif are supported." << std::endl;
        std::cerr << "****************" << std::endl;
        return -2;
      }
    } else if (str.startsWith("macro")) {
      tok = str.split(' ', Qt::SkipEmptyParts);
      if (tok.size() != 2) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. Only one file name is accepted." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
      // check extension
      tok.clear();
      tok = str.split('.', Qt::SkipEmptyParts);
      QString ext = tok.at(tok.size()-1);
      ext = ext.toLower();
      if (ext != "c") {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found extension " << ext.toLatin1().constData() << " in '" << str.toLatin1().constData() << "' which is not supported." << std::endl;
        std::cerr << "   Currently only: C are supported." << std::endl;
        std::cerr << "****************" << std::endl;
        return -2;
      }
    } else if (str.startsWith("norm")) {
      // nothing-to-be-done
    } else if (str.startsWith("var")) {
      tok.clear();
      tok = str.split(' ', Qt::SkipEmptyParts);
      if (tok.size() < 2) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'." << std::endl;
        std::cerr << "   Illegal variable definition." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
      // keep var name for later use
      var_names.push_back(tok[1]);
      var_linked.push_back(false);
      // the parsing etc is dealt within the scripting class
    } else if (str.startsWith("col")) {
      tok.clear();
      tok = str.split(' ', Qt::SkipEmptyParts);
      if (tok.size() != 4) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. Syntax for variable collection linking is:" << std::endl;
        std::cerr << "   col <nn> : <var_name>. Where <nn> is the collection index, and <var_name> the variable name to be linked." << std::endl;
        std::cerr << "****************" << std::endl;
        return -1;
      }
      if (tok[2] != ":") {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. Syntax for variable collection linking is:" << std::endl;
        std::cerr << "   col <nn> : <var_name>. Where <nn> is the collection index, and <var_name> the variable name to be linked." << std::endl;
        std::cerr << "****************" << std::endl;
        return -2;
      }
      // will check that the to be linked variable and the target collection exists
      // first check that the collection exists
      bool ok;
      int idx = tok[1].toInt(&ok);
      if (!ok) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** found '" << str.toLatin1().constData() << "'. Syntax for variable collection linking is:" << std::endl;
        std::cerr << "   col <nn> : <var_name>. Where <nn> is the collection index, and <var_name> the variable name to be linked." << std::endl;
        std::cerr << "   collection index is not a number here!" << std::endl;
        std::cerr << "****************" << std::endl;
        return -2;
      }
      if (idx >= noOfCollections) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** in '" << str.toLatin1().constData() << "'." << std::endl;
        std::cerr << "   Requested collection '" << idx << "' is out-of-range." << std::endl;
        std::cerr << "   Only " << noOfCollections << " or present." << std::endl;
        std::cerr << "   Collection indexing starts at 0, not 1." << std::endl;
        std::cerr << "****************" << std::endl;
        return -3;
      }
      // make sure that the variable to be linked has been defined and is NOT an error variable.
      if (tok[3].endsWith("Err")) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** in '" << str.toLatin1().constData() << "'." << std::endl;
        std::cerr << "  Only variables can be linked, NOT error variables." << std::endl;
        std::cerr << "  Error variables are linked implicitly." << std::endl;
        std::cerr << "****************" << std::endl;
        return -4;
      }
      idx = -1;
      for (unsigned int i=0; i<var_names.size(); i++) {
        if (tok[3] == var_names[i]) {
          idx = i;
          break;
        }
      }
      if (idx == -1) {
        std::cerr << std::endl;
        std::cerr << "****************" << std::endl;
        std::cerr << "**SYNTAX ERROR** in '" << str.toLatin1().constData() << "'." << std::endl;
        std::cerr << "  Variable to be linked not defined yet." << std::endl;
        std::cerr << "****************" << std::endl;
        return -5;
      }
      var_linked[idx] = true;
    } else if (str.startsWith("<python>")) {
      // a python block is evaluated through the linked 'var ... = python'
      // declarations; nothing to validate here.
    } else {
      std::cerr << "*********" << std::endl;
      std::cerr << "**ERROR** found unrecognized script command: '" << str.toLatin1().constData() << "'." << std::endl;
      std::cerr << "*********" << std::endl;
      mupp_script_syntax();
      return -3;
    }
  }
  if (noOfCollections == -1) {
    std::cerr << "****************" << std::endl;
    std::cerr << "**SYNTAX ERROR** no data loaded." << std::endl;
    std::cerr << "****************" << std::endl;
    mupp_script_syntax();
    return -4;
  }
  if (var_names.size() != var_linked.size()) {
    std::cerr << "****************" << std::endl;
    std::cerr << "**SYNTAX ERROR**" << std::endl;
    std::cerr << "****************" << std::endl;
    std::cerr << "** Your never should have reached this point **" << std::endl;
    std::cerr << "****************" << std::endl;
    return -4;
  }
  for (int i=0; i<var_names.size(); i++) {
    if (!var_names[i].endsWith("Err") && !var_linked[i]) {
      std::cerr << "****************" << std::endl;
      std::cerr << "**  WARNING   **" << std::endl;
      std::cerr << "****************" << std::endl;
      std::cerr << "  Found unlinked variable : " << var_names[i].toLatin1().constData() << std::endl;
      std::cerr << "****************" << std::endl;
    }
  }
 
  return 0;
}
 
//------------------------------------------------------------------------
QCoreApplication* createApplication(int &argc, char *argv[], bool gui)
{
  if (gui)
    return new QApplication(argc, argv);
  else
    return new QCoreApplication(argc, argv);
}
 
//------------------------------------------------------------------------
int main(int argc, char *argv[])
{
  Q_INIT_RESOURCE(mupp);
 
  QStringList fln;
  QStringList script;
 
  if (argc > 1) {
    if (!qstrcmp(argv[1], "-h") || !qstrcmp(argv[1], "--help")) {
      mupp_syntax();
      return 0;
    } else if (!qstrcmp(argv[1], "-v") || !qstrcmp(argv[1], "--version")) {
#ifdef HAVE_GIT_REV_H
      std::cout << std::endl << "mupp version: " << MUPP_VERSION << ", git-branch: " << GIT_BRANCH << ", git-rev: " << GIT_CURRENT_SHA1 << std::endl << std::endl;
#else
      std::cout << std::endl << "mupp version: " << MUPP_VERSION << std::endl << std::endl;
#endif
      return 0;
    } else if (!qstrcmp(argv[1], "-s") || !qstrcmp(argv[1], "--script")) {
      if (argc != 3) {
        std::cerr << std::endl;
        std::cerr << "*********" << std::endl;
        std::cerr << "**ERROR** the script option cannot be combined with something else." << std::endl;
        std::cerr << "*********" << std::endl;
        mupp_syntax();
        return -1;
      }
      // make sure that the script file exists
      if (!QFile::exists(argv[2])) {
        std::cerr << std::endl;
        std::cerr << "*********" << std::endl;
        std::cerr << "**ERROR** the script file '" << argv[2] << "' doesn't exist." << std::endl;
        std::cerr << "*********" << std::endl << std::endl;
        return -1;
      }
 
      // read script file
      if (mupp_script_read(argv[2], script) != 0) {
        std::cerr << std::endl;
        std::cerr << "*********" << std::endl;
        std::cerr << "**ERROR** couldn't read script '" << argv[2] << "'" << std::endl;
        std::cerr << "*********" << std::endl;
        return -1;
      }
 
      // check syntax of the script
      if (mupp_script_syntax_check(script) != 0) {
        return -1;
      }
    } else if (argc >= 2) { // assume it should be a fit-param-file-name list
      // check if a path is given
      int start=1;
      QString path="";
      if (!qstrcmp(argv[1], "--path")) {
        if (argc < 4) {
          std::cerr << std::endl;
          std::cerr << "*********" << std::endl;
          std::cerr << "**ERROR** tag '--path' needs to be followed by a <fit-param-path> and at least one <fit-param-file-name>" << std::endl;
          std::cerr << "*********" << std::endl;
          mupp_syntax();
          return -1;
        }
        path = argv[2];
        start = 3;
      }
      for (int i=start; i<argc; i++) {
        fln.push_back(argv[i]);
      }
      if (!path.isEmpty()) {
        for (int i=0; i<fln.size(); i++) {
          fln[i].prepend(path+"/");
        }
      }
    }
  }
 
  bool guiFlag=true;
  if (script.size() > 0) { // script
    guiFlag = false;
  }
  QScopedPointer<QCoreApplication> app(createApplication(argc, argv, guiFlag));
 
  std::unique_ptr<PmuppGui> gui;
  std::unique_ptr<PmuppScript> mupp_script;
  if (qobject_cast<QApplication *>(app.get())) { // GUI
    gui = std::make_unique<PmuppGui>(fln);
    if (gui == nullptr) {
      std::cerr << std::endl;
      std::cerr << "*********" << std::endl;
      std::cerr << "**ERROR** couldn't invoke mupp gui..." << std::endl;
      std::cerr << "*********" << std::endl;
      return -1;
    }
    gui->setWindowTitle( "muSR Parameter Plotter" );
    gui->resize( 800, 500 );
    gui->show();
 
    app.get()->connect( app.get(), SIGNAL( lastWindowClosed() ), app.get(), SLOT( quit() ) );
    app.get()->connect( app.get(), SIGNAL( aboutToQuit() ), gui.get(), SLOT( aboutToQuit() ) );
  } else { // scripting
    mupp_script = std::make_unique<PmuppScript>(script);
    if (mupp_script == nullptr) {
      std::cerr << std::endl;
      std::cerr << "*********" << std::endl;
      std::cerr << "**ERROR** couldn't invoke script class..." << std::endl;
      std::cerr << "*********" << std::endl;
      return -1;
    }
 
    // This will cause the application to exit when the task signals finished.
    QObject::connect( mupp_script.get(), SIGNAL( finished() ), app.get(), SLOT( quit() ) );
 
    // This will run the task from the application event loop.
    QTimer::singleShot(0, mupp_script.get(), SLOT( executeScript() ) );
  }
 
  return app->exec();
}