lib/creaDevManagerLib/modelCDMProject.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  * modelCDMProject.h
  30  *
  31  *  Created on: 13/11/2012
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef MODELCDMPROJECT_H_
  36 #define MODELCDMPROJECT_H_
  37
  38 #include<iostream>
  39 #include<vector>
  40 #include <map>
  41
  42 #include "modelCDMFolder.h"
  43 #include "modelCDMLib.h"
  44 #include "modelCDMAppli.h"
  45 #include "modelCDMPackage.h"
  46 #include "modelCDMCMakeListsFile.h"
  47
  48 /**
  49  * Project model class.
  50  * This class represents a project stored in a hard drive. It can perform some of the most relevant operations for a crea project.
  51  */
  52 class modelCDMProject : public modelCDMFolder
  53 {
  54 public:
  55   /**
  56    * Default constructor.
  57    */
  58   modelCDMProject();
  59
  60   /**
  61    * Constructor receiving the source path and the build path.
  62    * @param parent Parent node of the Project node.
  63    * @param path The source path.
  64    * @param name Name of the project folder.
  65    * @param buildPath The build path. By default it's an empty string.
  66    */
  67   modelCDMProject(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const std::string& buildPath = "");
  68
  69   /**
  70    * Destructor.
  71    */
  72   ~modelCDMProject();
  73
  74
  75   //Getters
  76   /**
  77    * Retrieves the name of the project.
  78    * @return The name of the project.
  79    */
  80   const std::string& GetNameProject() const;
  81
  82   /**
  83    * Retrieves the version of the project.
  84    * @return The version of the project in the format X.Y.Z where X is the major version of the project, Y is the minor version of the project, and Z is the build version.
  85    */
  86   const std::string& GetVersion() const;
  87
  88   /**
  89    * Retrieves the last version modification date of the project
  90    * @return The date of the last version modification in the format DD/MM/YYYY
  91    */
  92   const std::string& GetVersionDate() const;
  93
  94   /**
  95    * Retrieves the build path of the project.
  96    * @return The build path of the project. By default .../ProjectNameBin.
  97    */
  98   const std::string& GetBuildPath() const;
  99
 100   /**
 101    * Retrieves the package vector containing the packages present in the project.
 102    * @return The package vector containing references to the packages of the project.
 103    */
 104   const std::vector<modelCDMPackage*>& GetPackages() const;
 105
 106   /**
 107    * Retrieves the appli containing the applications present in the project.
 108    * @return The appli object present in the project.
 109    */
 110   modelCDMAppli* GetAppli() const;
 111
 112   /**
 113    * Retrieves the lib containing the libraries present in the project.
 114    * @return The lib object present in the project.
 115    */
 116   modelCDMLib* GetLib() const;
 117
 118   /**
 119    * Retrieves the default make instruction to compile the project.
 120    * @return The make instruction to compile.
 121    */
 122   std::string GetBuildInstruction() const;
 123
 124
 125   //Setters
 126   /**
 127    * Sets the version of the project. It also modifies the build date of the project.
 128    * @param version New version of the project.
 129    * @param result returns the result of the operation.
 130    * @return If the version configuration was successful it returns true. If not, it returns false and the error description returns in the parameter result.
 131    */
 132   bool SetVersion(const std::string& version, std::string*& result);
 133
 134   /**
 135    * Sets the build path of the project.
 136    * @param path Path for builing the project.
 137    * @param result Result of the operation.
 138    * @return If the build path configuration was successful it returns true. If not, it returns false and the error description returns in the parameter result.
 139    */
 140   bool SetBuildPath(const std::string& path, std::string*& result);
 141
 142
 143   //Creations
 144   /**
 145    * Creates a package and sets it as a children of the project. This method creates the package in the hard drive and also in the model.
 146    * @param name Name of the package.
 147    * @param result Result of the operation.
 148    * @param authors Authors of the operation. If any space is found, it will be replaced by '_'.
 149    * @param authorsEmail Authors' E-mails. This is appended to the package description.
 150    * @param description Package description.
 151    * @param version Package version in the format X.Y.Z where X is the major version, Y the minor version, and Z the build version.
 152    * @return The result of the creation. If everything goes well it returns true, else it returns false.
 153    */
 154   modelCDMIProjectTreeNode* CreatePackage(
 155       const std::string& name,
 156       std::string*& result,
 157       const std::string& authors = "info-dev",
 158       const std::string& authorsEmail = "info-dev@creatis.insa-lyon.fr",
 159       const std::string& description = "no description",
 160       const std::string& version = "1.0.0"
 161   );
 162
 163   /**
 164    * Creates a library and sets it as a children of the lib folder in the project. This method creates the library in the hard drive and also in the model.
 165    * @param name Library name.
 166    * @param result Result of the operation.
 167    * @param path Path of the library if not in the lib folder. This parameter is not used (for now).
 168    * @return The result of the creation. If everything goes well it returns true, else it returns false.
 169    */
 170   modelCDMIProjectTreeNode* CreateLibrary(
 171       const std::string& name,
 172       std::string*& result,
 173       const std::string& path = "/lib"
 174   );
 175
 176   /**
 177    * Creates an application and sets it as a children of the appli folder in the project. This method creates the library in the hard drive and also in the model.
 178    * @param name Application name.
 179    * @param result Result of the operation.
 180    * @param path Path of the application if not in the application folder. This parameter is not used (for now).
 181    * @return The result of the creation. If everything goes well it returns true, else it returns false.
 182    */
 183   modelCDMIProjectTreeNode* CreateApplication(
 184       const std::string& name,
 185       const int& type,
 186       std::string*& result,
 187       const std::string& path = "/appli"
 188   );
 189
 190   /**
 191    * Creates a black box and sets it as a children of the specified package folder in the project. This method creates the black box in the hard drive and also in the model.
 192    * @param name Black box name.
 193    * @param package The name of the package where the black box is created. The name should not contain neither the "bbtk_" , nor the "_PKG" parts of the folder name. If empty converts into "/bbtk_*projectName*_PKG"
 194    * @param authors The authors of the black box. This string should not contain commas or spaces, they will be replaced by '_'.
 195    * @param authorsEmail The authors e-mails. This string should not contain spaces, they will be replaced by '/'. This field is appended to the black box description.
 196    * @param categories The categories of concerning for the created black box.
 197    * @param description Description of the black box. It should not contain spaces, they will be replaced by '_'.
 198    * @return The result of the creation. If everything goes well it returns true, else it returns false.
 199    */
 200   modelCDMIProjectTreeNode* CreateBlackBox(
 201       const std::string& name,
 202       const std::string& package = "", //if empty converts into "/bbtk_*projectName*_PKG"
 203       const std::string& authors = "unknown",
 204       const std::string& authorsEmail = "",
 205       const std::string& categories = "empty",
 206       const std::string& description = "no description"
 207   );
 208
 209
 210   //Operations
 211   /**
 212    * Opens the CMakeLists.txt file in the system's default text editor.
 213    * @param result Result of the operation.
 214    * @return Success of the operation. If the file doesn't exist or can't be opened it returns false.
 215    */
 216   bool OpenCMakeListsFile(std::string*& result);
 217
 218   /**
 219    * Refresh the model with the file hierarchy in the hard drive.
 220    * @param result Result of the operation.
 221    * @return if there's an error refreshing the project it returns false.
 222    */
 223   virtual const bool Refresh(std::string*& result);
 224
 225   /**
 226    * Launches in console the ccmake tool in the build path to configure the building of the project.
 227    * @param result The result message of the operation.
 228    * @return if the ccmake tool doesn't launches it returns false.
 229    */
 230   bool ConfigureBuild(std::string*& result);
 231
 232   /**
 233    * Launches in console the make -clean and make commands to build the project.
 234    * @param result Result message for building the project.
 235    * @param line Line to execute the compilation.
 236    * @return if any of the commands cannot be executed it return false.
 237    */
 238   bool Build(std::string*& result, const std::string& line);
 239
 240   /**
 241    * Launches in console the bbPlugPackage command to connect the project to the .bbtk folder in the hard drive.
 242    * @param result Result message for connecting the project.
 243    * @return if the command cannot be executed it return false.
 244    */
 245   bool Connect(std::string*& result, const std::string& folder);
 246
 247   /**
 248    * Checks the CMakeLists files to see what's going to be compiled and what's not.
 249    * @param properties Map containing the project compilation properties.
 250    */
 251   void CheckStructure(std::map<std::string, bool>& properties);
 252
 253
 254 private:
 255
 256   /**
 257    * Project Name
 258    */
 259   std::string nameProject;
 260   /**
 261    * Project Version
 262    */
 263   std::string version;
 264   /**
 265    * Last Project Version Modification Date
 266    */
 267   std::string versionDate;
 268   /**
 269    * Build Path for compiling the project
 270    */
 271   std::string buildPath;
 272
 273   /**
 274    * lib folder
 275    */
 276   modelCDMLib* lib;
 277   /**
 278    * appli folder
 279    */
 280   modelCDMAppli* appli;
 281   /**
 282    * package folders
 283    */
 284   std::vector<modelCDMPackage*> packages;
 285
 286 };
 287
 288 #endif /* MODELCDMPROJECT_H_ */