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