qSlicerUtils.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 __qSlicerUtils_h
#define __qSlicerUtils_h

#include <QFile>
#include <QString>

#include "qSlicerBaseQTCoreExport.h"

class qSlicerAbstractCoreModule;

class Q_SLICER_BASE_QTCORE_EXPORT qSlicerUtils
{

public:
  typedef qSlicerUtils Self;

  static bool isExecutableName(const QString& name);

  static bool isCLIExecutable(const QString& filePath);

  static bool isCLIScriptedExecutable(const QString& filePath);

  static bool isCLILoadableModule(const QString& filePath);

  static bool isLoadableModule(const QString& filePath);

  static bool isTestingModule(qSlicerAbstractCoreModule* module);

  static QString searchTargetInIntDir(const QString& directory, const QString& target);

  static QString executableExtension();

  //static QString libraryExtension();

  static QString extractModuleNameFromLibraryName(const QString& libraryName);

  static QString extractModuleNameFromClassName(const QString& className);

  static bool isPluginInstalled(const QString& filePath, const QString& applicationHomeDir);

  static bool isPluginBuiltIn(const QString& filePath, const QString& applicationHomeDir, const QString& applicationRevision);

  static QString pathWithoutIntDir(const QString& path, const QString& subDirWithoutIntDir);
  static QString pathWithoutIntDir(const QString& path, const QString& subDirWithoutIntDir, QString& intDir);

  static bool pathEndsWith(const QString& inputPath, const QString& path);


  static bool setPermissionsRecursively(const QString &path,
                                        QFile::Permissions directoryPermissions,
                                        QFile::Permissions filePermissions);

  static QString replaceWikiUrlVersion(const QString& text, const QString& version);

  static QString replaceDocumentationUrlVersion(const QString& text, const QString& hostname, const QString& version);

private:
  qSlicerUtils() = default;
  virtual ~qSlicerUtils() = default;

};

#endif