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         result.clear();
 124         size_t current;
 125         size_t next = -1;
 126         do
 127         {
 128           if (empties == no_empties)
 129           {
 130             next = s.find_first_not_of(delimiters, next + 1);
 131             if (next == Container::value_type::npos)
 132             {
 133               break;
 134             }
 135             next -= 1;
 136           }
 137           current = next + 1;
 138           next = s.find_first_of(delimiters, current);
 139           result.push_back(s.substr(current, next - current));
 140         }
 141         while (next != Container::value_type::npos);
 142         return result;
 143       }
 144   };
 145
 146   /**
 147    * Fixes a given path to avoid double slash directories
 148    * @param path Unfixed path.
 149    * @return Fixed path.
 150    */
 151   const std::string fixPath(const std::string& path);
 152
 153   /**
 154    * Opens the default text editor. If a file is given, then it tries to open the given file.
 155    * @param file Full path to the file.
 156    * @return True if there was an error on the execution of the operation.
 157    */
 158   int openTextEditor(const std::string& file = "");
 159   /**
 160    * Opens the system file explorer on the given file path
 161    * @param file Path of the desired folder to open.
 162    * @return True if there was an error on the execution of the operation.
 163    */
 164   int openFileExplorer(const std::string& file = "");
 165   /**
 166    * Opens a file with a given command.
 167    * @param file Full path of the file to open.
 168    * @param command Command to execute the file with.
 169    * @return True if there was an error on the execution of the operation.
 170    */
 171   int openFileWithCommand(const std::string& file, const std::string& command);
 172   /**
 173    * Opens the BBTK Graphical Editor
 174    * @return True if there was an error on the execution of the operation.
 175    */
 176   int openBBEditor();
 177   /**
 178    * Opens the minitools or the creaTools
 179    * @return True if there was an error on the execution of the operation.
 180    */
 181   int openCreaToolsTools();
 182   /**
 183    * Open a command line interpreter and executes the given command if any.
 184    * @param command Command to execute.
 185    * @return True if there was an error on the execution of the operation.
 186    */
 187   int openTerminal(const std::string& command = "");
 188   /**
 189    * Creates a blank class(.h and .cpp files).
 190    * @param name Name of the new class.
 191    * @param path Path where the class is to be created.
 192    * @return True if the class was successfully created.
 193    */
 194   bool createEmptyClass(const std::string& name, const std::string& path);
 195   /**
 196    * Creates a string replacing each \ by double \ .
 197    * @param line String to stringify.
 198    * @return line stringified.
 199    */
 200   std::string stringify(const std::string& line);
 201
 202   //CMakeLists file handling
 203   /**
 204    * Type definition for the value of a syntax element for CMakeLists files
 205    */
 206   typedef std::vector<std::string> cmdValue;
 207
 208   /**
 209    * Type definition for the type of a syntax element for CMakeLists files
 210    */
 211   typedef std::string cmdType;
 212
 213   /**
 214    * Type definition for syntax elements of a CMakeLists file
 215    */
 216   typedef std::pair<cmdType,cmdValue> syntaxElement;
 217
 218   /**
 219    * Type definition for describing a CMakeLists file content
 220    */
 221   typedef std::vector<syntaxElement> CMLFile;
 222
 223   /**
 224    * Reads a file as string and returns the read data.
 225    * @param file_path Full path of the CMakeLists file.
 226    * @return A string with the contents of the given file.
 227    */
 228   std::string readFile(const std::string& file_path);
 229   /**
 230    * Writes the given string into a file and returns whether the operation is successful.
 231    * @param file_path Full path of the CMakeLists file.
 232    * @param st string to write.
 233    * @return True if the operation was successful.
 234    */
 235   bool writeFile(const std::string& file_path, const std::string& st);
 236
 237   /**
 238    * Reads a CMakeLists file and returns the read data.
 239    * @param file_path Full path of the CMakeLists file.
 240    * @return A CMLFile with the contents of the given file.
 241    */
 242   CMLFile readCMLFile(const std::string& file_path);
 243
 244   /**
 245    * Writes the given data into specified CMakeLists file.
 246    * @param file_path Full path of the CMakeLists file.
 247    * @param data CMakeLists data.
 248    * @return True if the operation was successful.
 249    */
 250   bool writeCMLFile(const std::string& file_path, const CMLFile& data);
 251
 252   /**
 253    * @param st Strips all space character at the beginning and at the end of the string.
 254    */
 255   void normalizeStr(std::string& st);
 256
 257 };
 258
 259 #endif /* CDMUTILITIES_H_ */