lib/creaDevManagerLib/CDMUtilities.h

   1 /*
   2 # ---------------------------------------------------------------------
   3 #
   4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5 #                        pour la Sant�)
   6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   9 #
  10 #  This software is governed by the CeCILL-B license under French law and
  11 #  abiding by the rules of distribution of free software. You can  use,
  12 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  13 #  license as circulated by CEA, CNRS and INRIA at the following URL
  14 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  15 #  or in the file LICENSE.txt.
  16 #
  17 #  As a counterpart to the access to the source code and  rights to copy,
  18 #  modify and redistribute granted by the license, users are provided only
  19 #  with a limited warranty  and the software's author,  the holder of the
  20 #  economic rights,  and the successive licensors  have only  limited
  21 #  liability.
  22 #
  23 #  The fact that you are presently reading this means that you have had
  24 #  knowledge of the CeCILL-B license and that you accept its terms.
  25 # ------------------------------------------------------------------------
  26  */
  27
  28 /*
  29  * CDMUtilities.h
  30  *
  31  *  Created on: Nov 23, 2012
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef CDMUTILITIES_H_
  36 #define CDMUTILITIES_H_
  37
  38 #include<iostream>
  39 #include<vector>
  40 #include<cstddef>
  41
  42 namespace CDMUtilities
  43 {
  44   /**
  45    * Path slash
  46    */
  47 #ifdef _WIN32
  48   // ------ Windows
  49   static std::string SLASH = "\\";
  50 #elif __APPLE__
  51   // ------ Apple
  52   static std::string SLASH = "/";
  53 #else
  54   static std::string SLASH = "/";
  55 #endif
  56
  57   /**
  58    * Text editor program
  59    */
  60 #ifdef _WIN32
  61   // ------ Windows
  62   static std::string TEXT_EDITOR = "notepad";
  63 #elif __APPLE__
  64   // ------ Apple
  65   //TODO: implementation for apple
  66 #else
  67   static std::string TEXT_EDITOR = "gedit";
  68 #endif
  69
  70   /**
  71    * File explorer program
  72    */
  73 #ifdef _WIN32
  74   // ------ Windows
  75   static std::string FILE_EXPLORER = "explorer";
  76 #elif __APPLE__
  77   // ------ Apple
  78   //TODO: implementation for apple
  79 #else
  80   static std::string FILE_EXPLORER = "nautilus";
  81 #endif
  82
  83   /**
  84    * Terminal program
  85    */
  86 #ifdef _WIN32
  87   // ------ Windows
  88   static std::string TERMINAL = "start cmd.exe";
  89 #elif __APPLE__
  90   // ------ Apple
  91   //TODO: implementation for apple
  92 #else
  93   static std::string TERMINAL = "gnome-terminal";
  94 #endif
  95
  96   /**
  97    * Structure that handles the split method for c++
  98    * It calls the split method to split a string given certain delimiters.
  99    */
 100   struct splitter
 101   {
 102     /**
 103      * Enum to allow or not empty resulting strings after performing splits.
 104      */
 105     enum empties_t { empties_ok, no_empties };
 106     /**
 107      * Method to split a string given a set of delimiter characters.
 108      * @param result Resulting container.
 109      * @param s String to be splitted.
 110      * @param delimiters Delimiter characters to split the string.
 111      * @param empties Either allow or not empty resulting strings after performing split.
 112      * @return Resulting container.
 113      */
 114     template <typename Container>
 115     static Container& split
 116     (
 117         Container& result,
 118         const typename Container::value_type& s,
 119         const typename Container::value_type& delimiters,
 120         empties_t empties = empties_ok
 121     );
 122   };
 123
 124   /**
 125    * Fixes a given path to avoid double slash directories
 126    * @param path Unfixed path.
 127    * @return Fixed path.
 128    */
 129   const std::string fixPath(const std::string& path);
 130
 131   /**
 132    * Opens the default text editor. If a file is given, then it tries to open the given file.
 133    * @param file Full path to the file.
 134    * @return True if there was an error on the execution of the operation.
 135    */
 136   int openTextEditor(const std::string& file = "");
 137   /**
 138    * Opens the system file explorer on the given file path
 139    * @param file Path of the desired folder to open.
 140    * @return True if there was an error on the execution of the operation.
 141    */
 142   int openFileExplorer(const std::string& file = "");
 143   /**
 144    * Opens a file with a given command.
 145    * @param file Full path of the file to open.
 146    * @param command Command to execute the file with.
 147    * @return True if there was an error on the execution of the operation.
 148    */
 149   int openFileWithCommand(const std::string& file, const std::string& command);
 150   /**
 151    * Opens the BBTK Graphical Editor
 152    * @return True if there was an error on the execution of the operation.
 153    */
 154   int openBBEditor();
 155   /**
 156    * Opens the minitools or the creaTools
 157    * @return True if there was an error on the execution of the operation.
 158    */
 159   int openCreaToolsTools();
 160   /**
 161    * Open a command line interpreter and executes the given command if any.
 162    * @param command Command to execute.
 163    * @return True if there was an error on the execution of the operation.
 164    */
 165   int openTerminal(const std::string& command = "");
 166   /**
 167    * Creates a blank class(.h and .cpp files).
 168    * @param name Name of the new class.
 169    * @param path Path where the class is to be created.
 170    * @return True if the class was successfully created.
 171    */
 172   bool createEmptyClass(const std::string& name, const std::string& path);
 173   /**
 174    * Creates a string replacing each \ by double \ .
 175    * @param line String to stringify.
 176    * @return line stringified.
 177    */
 178   std::string stringify(const std::string& line);
 179
 180   //CMakeLists file handling
 181   /**
 182    * Type definition for the value of a syntax element for CMakeLists files
 183    */
 184   typedef std::vector<std::string> cmdValue;
 185
 186   /**
 187    * Type definition for the type of a syntax element for CMakeLists files
 188    */
 189   typedef std::string cmdType;
 190
 191   /**
 192    * Type definition for syntax elements of a CMakeLists file
 193    */
 194   typedef std::pair<cmdType,cmdValue> syntaxElement;
 195
 196   /**
 197    * Type definition for describing a CMakeLists file content
 198    */
 199   typedef std::vector<syntaxElement> CMLFile;
 200
 201   /**
 202    * Reads a file as string and returns the read data.
 203    * @param file_path Full path of the CMakeLists file.
 204    * @return A string with the contents of the given file.
 205    */
 206   std::string readFile(const std::string& file_path);
 207   /**
 208    * Writes the given string into a file and returns whether the operation is successful.
 209    * @param file_path Full path of the CMakeLists file.
 210    * @param st string to write.
 211    * @return True if the operation was successful.
 212    */
 213   bool writeFile(const std::string& file_path, const std::string& st);
 214
 215   /**
 216    * Reads a CMakeLists file and returns the read data.
 217    * @param file_path Full path of the CMakeLists file.
 218    * @return A CMLFile with the contents of the given file.
 219    */
 220   CMLFile readCMLFile(const std::string& file_path);
 221
 222   /**
 223    * Writes the given data into specified CMakeLists file.
 224    * @param file_path Full path of the CMakeLists file.
 225    * @param data CMakeLists data.
 226    * @return True if the operation was successful.
 227    */
 228   bool writeCMLFile(const std::string& file_path, const CMLFile& data);
 229
 230   /**
 231    * @param st Strips all space character at the beginning and at the end of the string.
 232    */
 233   void normalizeStr(std::string& st);
 234
 235 };
 236
 237 #endif /* CDMUTILITIES_H_ */