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
  41 #include "modelCDMFolder.h"
  42 #include "modelCDMLib.h"
  43 #include "modelCDMAppli.h"
  44 #include "modelCDMPackage.h"
  45 #include "modelCDMCMakeListsFile.h"
  46
  47 /**
  48  * Project model class.
  49  * This class represents a project stored in a hard drive. It can perform some of the most relevant operations for a crea project.
  50  */
  51 class modelCDMProject : public modelCDMFolder
  52 {
  53 public:
  54   /**
  55    * Default constructor.
  56    */
  57   modelCDMProject();
  58
  59   /**
  60    * Constructor receiving the source path and the build path.
  61    * @param path The source path.
  62    * @param buildPath The build path. By default it's an empty string.
  63    */
  64   modelCDMProject(const std::string& path, const std::string& buildPath = "");
  65
  66   /**
  67    * Destructor.
  68    */
  69   ~modelCDMProject();
  70
  71   /**
  72    * Unimplemented.
  73    */
  74   void PopulateProject();
  75
  76
  77   //Getters
  78   /**
  79    * Retrieves the name of the project.
  80    * @return The name of the project.
  81    */
  82   const std::string& GetNameProject() const;
  83
  84   /**
  85    * Retrieves the version of the project.
  86    * @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.
  87    */
  88   const std::string& GetVersion() const;
  89
  90   /**
  91    * Retrieves the last version modification date of the project
  92    * @return The date of the last version modification in the format DD/MM/YYYY
  93    */
  94   const std::string& GetVersionDate() const;
  95
  96   /**
  97    * Retrieves the build path of the project.
  98    * @return The build path of the project. By default .../ProjectNameBin.
  99    */
 100   const std::string& GetBuildPath() const;
 101
 102
 103   //Setters
 104   /**
 105    * Sets the version of the project. It also modifies the build date of the project.
 106    * @param version New version of the project.
 107    * @param result returns the result of the operation.
 108    * @return If the version configuration was successful it returns true. If not, it returns false and the error description returns in the parameter result.
 109    */
 110   bool SetVersion(const std::string& version, std::string*& result);
 111
 112   /**
 113    * Sets the build path of the project.
 114    * @param path Path for builing the project.
 115    * @param result Result of the operation.
 116    * @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.
 117    */
 118   bool SetBuildPath(const std::string& path, std::string*& result);
 119
 120
 121   //Creations
 122   /**
 123    * 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.
 124    * @param name Name of the package.
 125    * @param result Result of the operation.
 126    * @param authors Authors of the operation. If any space is found, it will be replaced by '_'.
 127    * @param authorsEmail Authors' E-mails. This is appended to the package description.
 128    * @param description Package description.
 129    * @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.
 130    * @return The result of the creation. If everything goes well it returns true, else it returns false.
 131    */
 132   modelCDMIProjectTreeNode* CreatePackage(
 133       const std::string& name,
 134       std::string*& result,
 135       const std::string& authors = "info-dev",
 136       const std::string& authorsEmail = "info-dev@creatis.insa-lyon.fr",
 137       const std::string& description = "no description",
 138       const std::string& version = "1.0.0"
 139   );
 140
 141   /**
 142    * 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.
 143    * @param name Library name.
 144    * @param result Result of the operation.
 145    * @param path Path of the library if not in the lib folder. This parameter is not used (for now).
 146    * @return The result of the creation. If everything goes well it returns true, else it returns false.
 147    */
 148   modelCDMIProjectTreeNode* CreateLibrary(
 149       const std::string& name,
 150       std::string*& result,
 151       const std::string& path = "/lib"
 152   );
 153
 154   /**
 155    * 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.
 156    * @param name Application name.
 157    * @param result Result of the operation.
 158    * @param path Path of the application if not in the application folder. This parameter is not used (for now).
 159    * @return The result of the creation. If everything goes well it returns true, else it returns false.
 160    */
 161   modelCDMIProjectTreeNode* CreateApplication(
 162       const std::string& name,
 163       std::string*& result,
 164       const std::string& path = "/appli"
 165   );
 166
 167   /**
 168    * 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.
 169    * @param name Black box name.
 170    * @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"
 171    * @param authors The authors of the black box. This string should not contain commas or spaces, they will be replaced by '_'.
 172    * @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.
 173    * @param categories The categories of concerning for the created black box.
 174    * @param description Description of the black box. It should not contain spaces, they will be replaced by '_'.
 175    * @return The result of the creation. If everything goes well it returns true, else it returns false.
 176    */
 177   modelCDMIProjectTreeNode* CreateBlackBox(
 178       const std::string& name,
 179       const std::string& package = "", //if empty converts into "/bbtk_*projectName*_PKG"
 180       const std::string& authors = "unknown",
 181       const std::string& authorsEmail = "",
 182       const std::string& categories = "empty",
 183       const std::string& description = "no description"
 184   );
 185
 186
 187   //Operations
 188   /**
 189    * Opens the CMakeLists.txt file in the system's default text editor.
 190    * @param result Result of the operation.
 191    * @return Success of the operation. If the file doesn't exist or can't be opened it returns false.
 192    */
 193   bool OpenCMakeListsFile(std::string*& result);
 194
 195   /**
 196    * Refresh the model with the file hierarchy in the hard drive.
 197    * @param result Result of the operation.
 198    * @return if there's an error refreshing the project it returns false.
 199    */
 200   virtual const bool Refresh(std::string*& result);
 201
 202   /**
 203    * Launches in console the ccmake tool in the build path to configure the building of the project.
 204    * @param result The result message of the operation.
 205    * @return if the ccmake tool doesn't launches it returns false.
 206    */
 207   bool ConfigureBuild(std::string*& result);
 208
 209   /**
 210    * Launches in console the make -clean and make commands to build the project.
 211    * @param result Result message for building the project.
 212    * @return if any of the commands cannot be executed it return false.
 213    */
 214   bool Build(std::string*& result);
 215
 216   /**
 217    * Launches in console the bbPlugPackage command to connect the project to the .bbtk folder in the hard drive.
 218    * @param result Result message for connecting the project.
 219    * @return if the command cannot be executed it return false.
 220    */
 221   bool Connect(std::string*& result);
 222
 223
 224 private:
 225
 226   std::string nameProject;
 227   std::string version;
 228   std::string versionDate;
 229   std::string buildPath;
 230
 231   modelCDMLib* lib;
 232   modelCDMAppli* appli;
 233   std::vector<modelCDMPackage*> packages;
 234
 235 };
 236
 237 #endif /* MODELCDMPROJECT_H_ */