Source/dccontainer.h

   1 //  Copyright (c) 2012 Dennco Project
   2 //
   3 // This program is free software: you can redistribute it and/or modify
   4 // it under the terms of the GNU General Public License as published by
   5 // the Free Software Foundation, either version 3 of the License, or
   6 // (at your option) any later version.
   7 //
   8 // This program is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 // GNU General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 //
  17 //  Created by tkawata on Sep-30, 2012.
  18 //
  19 #ifndef DCCONTAINER_H
  20 #define DCCONTAINER_H
  21
  22 #include "TKContainer.h"
  23
  24 class TKCell;
  25 class TKCellCode;
  26 class DCCell;
  27 class DCCellCode;
  28 class DCScene;
  29 class DCContent;
  30 class DCVComponent;
  31 class DCUIGraphicsScene;
  32
  33 #include "dcvcomponent.h"
  34
  35 #include <QList>
  36 #include <QString>
  37
  38 class DCContainer : public TKContainer
  39 {
  40     DCContent       *d_content;
  41     DCScene         *d_scene;
  42
  43     std::string     d_factoryCachedLocation;
  44     DCVCRefHolder   d_factoryCachedPageObject;
  45
  46     QString         d_workDirRoot;
  47     QString         d_workDirCellRoot;
  48     QString         d_workDirCellCodeRoot;
  49
  50 public:
  51     DCContainer();
  52     virtual ~DCContainer();
  53
  54     virtual TKCell*         addCell(std::string theLocation, std::string theName, std::string type, std::string customScript);
  55     virtual TKCell*         addCell(std::string theLocation, std::string theName, TKCellCode *cellCode, std::string customScript);
  56     virtual TKCellCode*     addCellCode(std::string theName, std::string theAPIType, std::string code);
  57
  58     virtual TKCell*         cellFactory(std::string location, std::string name, std::string type, bool canInterface = true);
  59     virtual TKAxon*         axonFactory(TKCell *theOwner);
  60     virtual TKReceptor*     receptorFactory(TKCell *theOwner);
  61     virtual TKAxonTerminal* axonTerminalFactory(TKAxon *theOwner);
  62     virtual TKCellCode*     cellCodeFactory(std::string name, std::string cellapi, std::string code);
  63
  64     /**
  65      * @brief remove cell from container and the page (DCVCPage) belonging.
  66      * @param cell
  67      *
  68      * All the axon terminals connected to this cell will also be removed after this.
  69      * This expected to only be called from command classes which are defined in dceditcommands.h
  70      *
  71      * @return true for success, false for failure
  72      */
  73     bool                    removeCell(DCCell *cell);
  74
  75     /**
  76      * @brief remove cell code from container and the page (DCVCPage) belonging.
  77      * @param cellcode
  78      *
  79      * The cells which use the deleting cell code will have empty cell code after this.
  80      * This expected to only be called from command classes which are defined in dceditcommands.h
  81      *
  82      * @return true for success, false for failure
  83      */
  84     bool                    removeCellCode(DCCellCode *cellcode);
  85
  86     /**
  87      * @brief movePage
  88      *
  89      * @param oldContainerBasedPathName
  90      * @param newContainerBasedPathName
  91      *
  92      * Change the name / path for a container file.
  93      * All cells, cell codes and connections are updated accordingly.
  94      * This expected to be called from command classes which are defined in dceditcommands.h
  95      *
  96      * @return pointer to a page object for the new file path or NULL when this failed.
  97      */
  98     DCVCPage*               movePage(const QString &oldContainerBasedPathName, const QString &newContainerBasedPathName);
  99
 100     /**
 101      * @brief change the path information of a cell.
 102      * @param cell
 103      * @param pageNewContainerBasedPathName
 104      *
 105      * @note This will be called from DCVCCell::changePageBelonging().
 106      * This shouldn't be directly called from other methods.
 107      * @return
 108      */
 109     bool                    moveCell(DCCell*cell, const QString& pageNewContainerBasedPathName);
 110
 111     /**
 112      * @brief change the path information of a cell code.
 113      * @param cellcode
 114      * @param pageNewContainerBasedPathName
 115      *
 116      * @note This will be called from DCVCCellCode::changePageBelonging().
 117      * This shouldn't be directly called from other methods.
 118      * @return
 119      */
 120     bool                    moveCellCodeClass(DCCellCode*cellcode, const QString& pageNewContainerBasedPathName);
 121
 122     bool                    renameCell(DCCell *cell, const QString& newName);
 123
 124     bool                    renameCellCodeClass(DCCellCode *cellcode, const QString& newName);
 125
 126     //
 127     DCContent*              getContent() const { return d_content; }
 128     DCScene*                getScene() const { return d_scene; }
 129     QList<DCVComponent*>    getSelectedCellObjects() const;
 130     virtual float           getValue(std::string key) const { return 0; }
 131
 132     TKCellCode*             getEmptyCellCodeClass() const { return mEmptyCellClass; }
 133     bool                    isScriptableCell(DCCell *cell);
 134
 135     //
 136     void                    setContent(DCContent *content);
 137
 138     void                    unselectCellObjectAll();
 139
 140     virtual void            setValue(std::string key, float value) {}
 141
 142     virtual void            beganParsePage(const char *docRoot, const char *path);
 143     virtual void            endedParsePage(const char *docRoot, const char *path);
 144
 145     void                    beganBuildContainer();
 146     void                    endedBuildContainer();
 147
 148     bool                    saveCustomScriptToWorkFile(TKCell *cell, std::string customScript);
 149     bool                    saveClassScriptToWorkFile(TKCellCode *cellCode, std::string code);
 150
 151     QString                 sysFilePathToContainerBasedPath(const QString& sysFilePath);
 152     QString                 containerBasedPathToSysFilePath(const QString& containerBasedPath);
 153
 154     QString                 readCustomScriptFromWorkFile(const DCCell *cell);
 155     QString                 readCellCodeScriptFromFile(const DCCellCode *cellcode);
 156
 157
 158     /***************************************************************************
 159      * Cell type rules
 160      **************************************************************************/
 161
 162     /**
 163      * @brief return the avaiable cell types as the list of QString
 164      * @return
 165      */
 166     QList<QString>          getAvailableCellTypes() const;
 167
 168     /**
 169      * @brief check if given cell type can have script
 170      * @param type
 171      * @return true if the given cell type can have script, false if no script avaiable for the cell type.
 172      */
 173     bool                    getIsScriptable(const QString& type) const;
 174
 175     /**
 176      * @brief return if the cell type can accept receptors.
 177      *        The cell which inputs value from external can not receive value from internal cells.
 178      * @param type
 179      * @return
 180      */
 181     bool                    getIsReceptorAvailable(const QString& type) const;
 182
 183 };
 184
 185 #endif // DCCONTAINER_H