qSlicerCoreCommandOptions.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Kitware Inc.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  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.
 
  This file was originally developed by Jean-Christophe Fillion-Robin, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1
 
==============================================================================*/
 
#ifndef __qSlicerCoreCommandOptions_h
#define __qSlicerCoreCommandOptions_h
 
// CTK includes
#include <ctkCommandLineParser.h>
 
#include "qSlicerBaseQTCoreExport.h"
#include "vtkSlicerConfigure.h" // For Slicer_USE_PYTHONQT
 
class QSettings;
class qSlicerCoreCommandOptionsPrivate;
 
class Q_SLICER_BASE_QTCORE_EXPORT qSlicerCoreCommandOptions : public ctkCommandLineParser
{
  Q_OBJECT
  Q_PROPERTY(bool displayHelpAndExit READ displayHelpAndExit CONSTANT)
  Q_PROPERTY(bool ignoreSlicerRC READ ignoreSlicerRC CONSTANT)
  Q_PROPERTY(QString pythonScript READ pythonScript CONSTANT)
  Q_PROPERTY(QString extraPythonScript READ extraPythonScript CONSTANT)
  Q_PROPERTY(int extraPythonScriptProcessedArgumentsCount READ extraPythonScriptProcessedArgumentsCount CONSTANT)
  Q_PROPERTY(QString pythonCode READ pythonCode CONSTANT)
  Q_PROPERTY(bool runPythonAndExit READ runPythonAndExit WRITE setRunPythonAndExit)
  Q_PROPERTY(bool disableCLIModules READ disableCLIModules CONSTANT)
  Q_PROPERTY(bool disableLoadableModules READ disableLoadableModules CONSTANT)
  Q_PROPERTY(bool disableScriptedLoadableModules READ disableScriptedLoadableModules CONSTANT)
  Q_PROPERTY(bool disableBuiltInCLIModules READ disableBuiltInCLIModules CONSTANT)
  Q_PROPERTY(bool disableBuiltInLoadableModules READ disableBuiltInLoadableModules CONSTANT)
  Q_PROPERTY(bool disableBuiltInScriptedLoadableModules READ disableBuiltInScriptedLoadableModules CONSTANT)
  Q_PROPERTY(bool displayApplicationInformation READ displayApplicationInformation CONSTANT)
  Q_PROPERTY(bool displayVersionAndExit READ displayVersionAndExit CONSTANT)
  Q_PROPERTY(bool displayProgramPathAndExit READ displayProgramPathAndExit CONSTANT)
  Q_PROPERTY(bool displayHomePathAndExit READ displayHomePathAndExit CONSTANT)
  Q_PROPERTY(bool displaySettingsPathAndExit READ displaySettingsPathAndExit CONSTANT)
  Q_PROPERTY(bool displayTemporaryPathAndExit READ displayTemporaryPathAndExit CONSTANT)
  Q_PROPERTY(bool displayMessageAndExit READ displayMessageAndExit STORED false CONSTANT)
  Q_PROPERTY(bool verboseModuleDiscovery READ verboseModuleDiscovery CONSTANT)
  Q_PROPERTY(bool disableMessageHandlers READ disableMessageHandlers CONSTANT)
  Q_PROPERTY(bool testingEnabled READ isTestingEnabled CONSTANT)
  Q_PROPERTY(bool pythonDisabled READ isPythonDisabled CONSTANT)
  Q_PROPERTY(QStringList additionalModulePaths READ additionalModulePaths CONSTANT)
  Q_PROPERTY(QStringList modulesToIgnore READ modulesToIgnore CONSTANT)
public:
  typedef ctkCommandLineParser Superclass;
  qSlicerCoreCommandOptions();
  ~qSlicerCoreCommandOptions() override;

  bool parse(const QStringList& arguments);

  bool displayHelpAndExit() const;

  bool ignoreRest() const;

  bool ignoreSlicerRC() const;

  QString pythonScript() const;

  QString extraPythonScript() const;

  void setExtraPythonScript(const QString& newExtraPythonScript);

  int extraPythonScriptProcessedArgumentsCount() const;
  void setExtraPythonScriptProcessedArgumentsCount(int argumentCount);
  QString pythonCode() const;

  bool runPythonAndExit() const;

  void setRunPythonAndExit(bool value);

  QStringList additionalModulePaths() const;

  QStringList modulesToIgnore() const;

  bool disableModules() const;

  bool disableBuiltInModules() const;

  bool disableCLIModules() const;

  bool disableBuiltInCLIModules() const;

  bool disableLoadableModules() const;

  bool disableBuiltInLoadableModules() const;

  bool disableScriptedLoadableModules() const;

  bool disableBuiltInScriptedLoadableModules() const;

  bool displayVersionAndExit() const;

  bool displayProgramPathAndExit() const;

  bool displayHomePathAndExit() const;

  bool displaySettingsPathAndExit() const;

  bool displayTemporaryPathAndExit() const;

  virtual bool displayMessageAndExit() const;

  bool displayApplicationInformation() const;

  bool verboseModuleDiscovery() const;

  bool verbose() const;

  bool disableMessageHandlers() const;

  bool disableTerminalOutputs() const;

  bool settingsDisabled() const;

  bool keepTemporarySettings() const;

  bool isTestingEnabled() const;

  bool isPythonDisabled() const;
 
protected:
  virtual void addArguments();

  QHash<QString, QVariant> parsedArgs() const;
 
protected:
  QScopedPointer<qSlicerCoreCommandOptionsPrivate> d_ptr;
 
private:
  Q_DECLARE_PRIVATE(qSlicerCoreCommandOptions);
  Q_DISABLE_COPY(qSlicerCoreCommandOptions);
};
 
#endif