plugin.hpp

Go to the documentation of this file.

/*****************************************************************************
    NumeRe: Framework fuer Numerische Rechnungen
    Copyright (C) 2014  Erik Haenel et al.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/
 
 
 
 
 
// CLASS Plugin
 
 
#ifndef PLUGIN_HPP
#define PLUGIN_HPP
 
#include <iostream>
#include <fstream>
#include <string>
 
#include "../io/filesystem.hpp"
#include "../ui/error.hpp"
 
 
class Package
{
    private:
        std::string getOptionValue(const std::string& sInstallInfoString, const std::string& sOption, const std::string& sDefault);
 
        std::string stripParentheses(const std::string& sString) const
        {
            if (sString.front() == '(' && sString.back() == ')')
                return sString.substr(1, sString.length()-2);
 
            return sString;
        }
 
    public:
        std::string sCommand;
        std::string sMainProcedure;
        std::string sArgumentList;
        std::string sType;
        std::string sLicense;
        std::string sName;
        std::string sVersion;
        std::string sAuthor;
        std::string sDescription;
        std::string sMenuEntry;
        std::string sDocumentationIndexID;
        std::string sKeyWords;
        std::string sChangesLog;
 
        Package();
        Package(const std::string& sInstallInfoString);
 
        std::string exportDefinition() const;
        void importDefinition(std::string sDefinitionString);
 
        bool isPlugin() const;
        bool operator==(const Package& _plugin) const;
        bool operator!=(const Package& _plugin) const;
        void update(const Package& _plugin);
        void incrementVersion();
        std::string getName() const;
        std::string getAuthor() const;
        std::string getDescription() const;
        std::string getKeyWords() const;
        std::string getLicense() const;
        std::string getMenuEntry() const;
        std::string getCommandSignature() const;
        std::string getChangesLog() const;
};
 
 
class PackageManager : public FileSystem
{
    private:
        std::fstream fPlugins;
        std::vector<Package> vPackageInfo;
        std::string sPluginDefinitionFile;
 
        std::string sPluginProcName;
        std::string sPluginVarList;
        void assign(const PackageManager& _manager);
        void updatePluginFile();
 
    public:
        PackageManager();
        PackageManager(const PackageManager& _manager);
        ~PackageManager();
        PackageManager& operator= (const PackageManager& _manager);
 
        bool loadPlugins();
        bool evalPluginCmd(std::string& sCmd);
        bool declareNewPackage(const std::string& sInstallInfoString);
        bool isPluginCmd(const std::string& sCmd) const;
        std::string deletePackage(const std::string& sPackage);
        std::map<std::string, std::string> getMenuMap() const;
 
        inline unsigned int getPackageCount() const
            {return vPackageInfo.size();}
 
        std::string getPluginInfoPath();
        void addHelpIndex(const std::string& _sPluginName, std::string _sHelpId);
 
        const std::vector<Package>& getPackages() const
        {
            return vPackageInfo;
        }
 
        inline std::string getPluginNames() const
        {
            std::string sReturn = ";";
 
            for (unsigned int i = 0; i < vPackageInfo.size(); i++)
                sReturn += vPackageInfo[i].getName() + ";";
 
            return sReturn;
        }
 
        inline std::string getPluginProcName() const
            {return sPluginProcName;}
 
        inline std::string getPluginVarList() const
            {return sPluginVarList;}
 
        inline std::string getPluginCommand(unsigned int i = 0) const
        {
            if (i < vPackageInfo.size())
                return vPackageInfo[i].sCommand;
 
            return "";
        }
 
        inline std::string getPluginCommandSignature(unsigned int i = 0) const
        {
            if (i < vPackageInfo.size())
                return vPackageInfo[i].getCommandSignature();
 
            return "";
        }
 
        inline std::string getPackageName(unsigned int i = 0) const
        {
            if (i < vPackageInfo.size())
                return vPackageInfo[i].getName();
 
            return "";
        }
 
        inline std::string getPackageVersion(unsigned int i = 0) const
        {
            if (i < vPackageInfo.size())
                return vPackageInfo[i].sVersion;
 
            return "";
        }
 
        inline std::string getPackageAuthor(unsigned int i = 0) const
        {
            if (i < vPackageInfo.size())
                return vPackageInfo[i].getAuthor();
 
            return "";
        }
 
        inline std::string getPackageDescription(unsigned int i = 0) const
        {
            if (i < vPackageInfo.size())
                return vPackageInfo[i].getDescription();
 
            return "";
        }
 
        inline std::string getPackageLicense(unsigned int i = 0) const
        {
            if (i < vPackageInfo.size())
                return vPackageInfo[i].getLicense();
 
            return "";
        }
 
        inline std::string getPluginMenuEntry(unsigned int i = 0) const
        {
            if (i < vPackageInfo.size())
                return vPackageInfo[i].getMenuEntry();
 
            return "";
        }
};
 
#endif