2 # ---------------------------------------------------------------------
4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
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
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.
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
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 # ------------------------------------------------------------------------
31 * Created on: 13/11/2012
32 * Author: Daniel Felipe Gonzalez Obando
35 #ifndef MODELCDMPROJECT_H_
36 #define MODELCDMPROJECT_H_
42 #include "modelCDMFolder.h"
43 #include "modelCDMLib.h"
44 #include "modelCDMAppli.h"
45 #include "modelCDMPackage.h"
46 #include "modelCDMCMakeListsFile.h"
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.
52 class modelCDMProject : public modelCDMFolder
56 * Default constructor.
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.
67 modelCDMProject(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const std::string& buildPath = "");
77 * Retrieves the name of the project.
78 * @return The name of the project.
80 const std::string& GetNameProject() const;
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.
86 const std::string& GetVersion() const;
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
92 const std::string& GetVersionDate() const;
95 * Retrieves the build path of the project.
96 * @return The build path of the project. By default .../ProjectNameBin.
98 const std::string& GetBuildPath() const;
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.
104 const std::vector<modelCDMPackage*>& GetPackages() const;
107 * Retrieves the appli containing the applications present in the project.
108 * @return The appli object present in the project.
110 modelCDMAppli* GetAppli() const;
113 * Retrieves the lib containing the libraries present in the project.
114 * @return The lib object present in the project.
116 modelCDMLib* GetLib() const;
119 * Retrieves the default make instruction to compile the project.
120 * @return The make instruction to compile.
122 std::string GetBuildInstruction() const;
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.
132 bool SetVersion(const std::string& version, std::string*& result);
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.
140 bool SetBuildPath(const std::string& path, std::string*& result);
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. The created package is included in the project's CMakeLists file.
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.
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"
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.
170 modelCDMIProjectTreeNode* CreateLibrary(
171 const std::string& name,
172 std::string*& result,
173 const std::string& path = "/lib"
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 type Application type. 0=console application, 1=GUI application (wxWidgets).
180 * @param result Result of the operation.
181 * @param path Path of the application if not in the application folder. This parameter is not used (for now).
182 * @return The result of the creation. If everything goes well it returns true, else it returns false.
184 modelCDMIProjectTreeNode* CreateApplication(
185 const std::string& name,
187 std::string*& result,
188 const std::string& path = "/appli"
192 * 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.
193 * @param name Black box name.
194 * @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"
195 * @param authors The authors of the black box. This string should not contain commas or spaces, they will be replaced by '_'.
196 * @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.
197 * @param categories The categories of concerning for the created black box.
198 * @param description Description of the black box. It should not contain spaces, they will be replaced by '_'.
199 * @return The result of the creation. If everything goes well it returns true, else it returns false.
201 modelCDMIProjectTreeNode* CreateBlackBox(
202 const std::string& name,
203 const std::string& package = "", //if empty converts into "/bbtk_*projectName*_PKG"
204 const std::string& authors = "unknown",
205 const std::string& authorsEmail = "",
206 const std::string& categories = "empty",
207 const std::string& description = "no description"
213 * Opens the CMakeLists.txt file in the system's default text editor.
214 * @param result Result of the operation.
215 * @return Success of the operation. If the file doesn't exist or can't be opened it returns false.
217 bool OpenCMakeListsFile(std::string*& result);
220 * Refresh the model with the file hierarchy in the hard drive.
221 * @param result Result of the operation.
222 * @return if there's an error refreshing the project it returns false.
224 virtual const bool Refresh(std::string*& result);
227 * Launches in console the ccmake tool in the build path to configure the building of the project.
228 * @param result The result message of the operation.
229 * @return if the ccmake tool doesn't launches it returns false.
231 bool ConfigureBuild(std::string*& result);
234 * Launches in console the make -clean and make commands to build the project.
235 * @param result Result message for building the project.
236 * @param line Line to execute the compilation.
237 * @return if any of the commands cannot be executed it return false.
239 bool Build(std::string*& result, const std::string& line);
242 * Launches in console the bbPlugPackage command to connect the project to the .bbtk folder in the hard drive.
243 * @param result Result message for connecting the project.
244 * @param folder Folder to make connection with. It must contain the bbtkPackage file
245 * @return if the command cannot be executed it return false.
247 bool Connect(std::string*& result, const std::string& folder);
250 * Checks the CMakeLists files to see what's going to be compiled and what's not.
251 * @param properties Map containing the project compilation properties.
253 void CheckStructure(std::map<std::string, bool>& properties);
256 * Checks if the given package is included in the CMakeLists file.
257 * @param package_name Name of the package to check.
258 * @return True if the package is included, otherwise returns False.
260 bool IsPackageIncluded(const std::string& package_name);
263 * Sets the inclusion of the package in the project's CMakeLists file. If the package inclusion already exist in file, then the line is uncommented/commented depending on the requested action. If the package inclusion doesn't exist yet, then it is included if the request is an inclusion.
264 * @param package_name Name of the package to include/exclude.
265 * @param toInclude True if the request is an inclusion, False otherwise.
266 * @return True if the request was processed successfully.
268 bool SetPackageInclude(const std::string& package_name, const bool& toInclude);
276 std::string nameProject;
282 * Last Project Version Modification Date
284 std::string versionDate;
286 * Build Path for compiling the project
288 std::string buildPath;
297 modelCDMAppli* appli;
301 std::vector<modelCDMPackage*> packages;
305 #endif /* MODELCDMPROJECT_H_ */