Feature #1711 CreaDevManager application implementation

[crea.git] / lib / creaDevManagerLib / modelCDMProject.h

diff --git a/lib/creaDevManagerLib/modelCDMProject.h b/lib/creaDevManagerLib/modelCDMProject.h
index 7e69c799fbcdd0000b252f4df7fc8c3b9a890852..a3459d77dfb5a87753cfa5f0969493f932298422 100644 (file)
--- a/lib/creaDevManagerLib/modelCDMProject.h
+++ b/lib/creaDevManagerLib/modelCDMProject.h
@@ -59,7 +59,9 @@ public:
 
   /**
    * Constructor receiving the source path and the build path.
+   * @param parent Parent node of the Project node.
    * @param path The source path.
+   * @param name Name of the project folder.
    * @param buildPath The build path. By default it's an empty string.
    */
   modelCDMProject(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const std::string& buildPath = "");
@@ -140,7 +142,7 @@ public:
 
   //Creations
   /**
-   * 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.
+   * 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.
    * @param name Name of the package.
    * @param result Result of the operation.
    * @param authors Authors of the operation. If any space is found, it will be replaced by '_'.
@@ -174,12 +176,14 @@ public:
   /**
    * 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.
    * @param name Application name.
+   * @param type Application type. 0=console application, 1=GUI application (wxWidgets).
    * @param result Result of the operation.
    * @param path Path of the application if not in the application folder. This parameter is not used (for now).
    * @return The result of the creation. If everything goes well it returns true, else it returns false.
    */
   modelCDMIProjectTreeNode* CreateApplication(
       const std::string& name,
+      const int& type,
       std::string*& result,
       const std::string& path = "/appli"
   );
@@ -229,6 +233,7 @@ public:
   /**
    * Launches in console the make -clean and make commands to build the project.
    * @param result Result message for building the project.
+   * @param line Line to execute the compilation.
    * @return if any of the commands cannot be executed it return false.
    */
   bool Build(std::string*& result, const std::string& line);
@@ -236,9 +241,10 @@ public:
   /**
    * Launches in console the bbPlugPackage command to connect the project to the .bbtk folder in the hard drive.
    * @param result Result message for connecting the project.
+   * @param folder Folder to make connection with. It must contain the bbtkPackage file
    * @return if the command cannot be executed it return false.
    */
-  bool Connect(std::string*& result);
+  bool Connect(std::string*& result, const std::string& folder);
 
   /**
    * Checks the CMakeLists files to see what's going to be compiled and what's not.
@@ -246,16 +252,64 @@ public:
    */
   void CheckStructure(std::map<std::string, bool>& properties);
 
+  /**
+   * Checks if the given package is included in the CMakeLists file.
+   * @param package_name Name of the package to check.
+   * @return True if the package is included, otherwise returns False.
+   */
+  bool IsPackageIncluded(const std::string& package_name);
+
+  /**
+   * 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.
+   * @param package_name Name of the package to include/exclude.
+   * @param toInclude True if the request is an inclusion, False otherwise.
+   * @return True if the request was processed successfully.
+   */
+  bool SetPackageInclude(const std::string& package_name, const bool& toInclude);
+
+  /**
+   * Checks the project folder's CMakeLists file to check which third party libraries are enabled.
+   * @return A map with the name of the library and if it's included in the CMakeLists file.
+   */
+  std::map<std::string, bool> Get3rdPartyLibraries();
+
+  /**
+   * Sets the 3rd party library inclusion in the CMakeLists file.
+   * @return if the operation was successful.
+   */
+  bool Set3rdPartyLibrary(const std::string& library_name, const bool& toInclude);
+
 
 private:
 
+  /**
+   * Project Name
+   */
   std::string nameProject;
+  /**
+   * Project Version
+   */
   std::string version;
+  /**
+   * Last Project Version Modification Date
+   */
   std::string versionDate;
+  /**
+   * Build Path for compiling the project
+   */
   std::string buildPath;
 
+  /**
+   * lib folder
+   */
   modelCDMLib* lib;
+  /**
+   * appli folder
+   */
   modelCDMAppli* appli;
+  /**
+   * package folders
+   */
   std::vector<modelCDMPackage*> packages;
 
 };