CTK/Libs/CommandLineModules/Core/ctkCmdLineModule.cpp

/*=============================================================================
  
  Library: CTK
  
  Copyright (c) German Cancer Research Center,
    Division of Medical and Biological Informatics
    
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
  
    http://www.apache.org/licenses/LICENSE-2.0
    
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
  
=============================================================================*/

#include "ctkCmdLineModule.h"
#include "ctkCmdLineModuleDescription.h"
#include "ctkCmdLineModuleParameter.h"
#include "ctkCmdLineModuleParameterGroup.h"
#include "ctkCmdLineModuleReference.h"
#include "ctkCmdLineModuleProcessTask.h"
#include "ctkCmdLineModuleFuture.h"

#include "ctkException.h"

#include <QStringList>
#include <QDebug>
#include <QVariant>

struct ctkCmdLineModulePrivate
{
  ctkCmdLineModulePrivate(ctkCmdLineModule* qq,
                                  const ctkCmdLineModuleReference& moduleRef)
    : ModuleReference(moduleRef), q(qq)
  {

  }

  QString normalizeFlag(const QString& flag)
  {
    return flag.trimmed().remove(QRegExp("^-*"));
  }

  ctkCmdLineModuleReference ModuleReference;

  QList<QString> ParameterNames;

private:

  ctkCmdLineModule* q;

};


ctkCmdLineModule::ctkCmdLineModule(const ctkCmdLineModuleReference& moduleRef)
  : d(new ctkCmdLineModulePrivate(this, moduleRef))
{
}

ctkCmdLineModule::~ctkCmdLineModule()
{
}

QList<QString> ctkCmdLineModule::parameterNames() const
{
  if (!d->ParameterNames.isEmpty()) return d->ParameterNames;

  foreach (ctkCmdLineModuleParameterGroup paramGroup,
           moduleReference().description().parameterGroups())
  {
    foreach (ctkCmdLineModuleParameter param, paramGroup.parameters())
    {
      d->ParameterNames.push_back(param.name());
    }
  }
  return d->ParameterNames;
}

ctkCmdLineModuleReference ctkCmdLineModule::moduleReference() const
{
  return d->ModuleReference;
}

QString ctkCmdLineModule::location() const
{
  return d->ModuleReference.location();
}

QStringList ctkCmdLineModule::commandLineArguments() const
{
  QStringList cmdLineArgs;
  QHash<int, QString> indexedArgs;

  ctkCmdLineModuleDescription description = moduleReference().description();

  QHash<QString,QVariant> currentValues = values();
  QHashIterator<QString,QVariant> valuesIter(currentValues);

  while(valuesIter.hasNext())
  {
    valuesIter.next();

    ctkCmdLineModuleParameter parameter = description.parameter(valuesIter.key());
    if (parameter.index() > -1)
    {
      indexedArgs.insert(parameter.index(), valuesIter.value().toString());
    }
    else
    {
      QString argFlag;
      if (parameter.longFlag().isEmpty())
      {
        argFlag = QString("-") + d->normalizeFlag(parameter.flag());
      }
      else
      {
        argFlag = QString("--") + d->normalizeFlag(parameter.longFlag());
      }

      if (parameter.tag() == "boolean")
      {
        if (valuesIter.value().toBool())
        {
          cmdLineArgs << argFlag;
        }
      }
      else
      {
        QStringList args;
        if (parameter.multiple())
        {
          args = valuesIter.value().toString().split(',', QString::SkipEmptyParts);
        }
        else
        {
          QString arg = valuesIter.value().toString();
          if (arg.isEmpty())
          {
            arg = parameter.defaultValue();
          }
          if (!arg.isEmpty())
          {
            args.push_back(valuesIter.value().toString());
          }
        }

        if (args.length() > 0) // don't write the argFlag if there was no argument, and no default.
        {
          foreach(QString arg, args)
          {
            cmdLineArgs << argFlag << arg;
          }
        }
      }
    }
  }

  QList<int> indexes = indexedArgs.keys();
  qSort(indexes.begin(), indexes.end());
  foreach(int index, indexes)
  {
    cmdLineArgs << indexedArgs[index];
  }

  return cmdLineArgs;
}

ctkCmdLineModuleFuture ctkCmdLineModule::run() const
{
  QStringList args = commandLineArguments();

  // Instances of ctkCmdLineModuleProcessTask are auto-deleted by the
  // thread pool.
  ctkCmdLineModuleProcessTask* moduleProcess =
      new ctkCmdLineModuleProcessTask(d->ModuleReference.location(), args);
  return moduleProcess->start();
}


QHash<QString, QVariant> ctkCmdLineModule::values() const
{
  QHash<QString,QVariant> result;
  foreach(QString parameterName, parameterNames())
  {
    result.insert(parameterName, value(parameterName));
  }
  return result;
}

void ctkCmdLineModule::setValues(const QHash<QString, QVariant> &values)
{
  QHashIterator<QString,QVariant> iter(values);
  while(iter.hasNext())
  {
    iter.next();
    setValue(iter.key(), iter.value());
  }
}