IWorkspace.h

Go to the documentation of this file.

#ifndef WS_IWORKSPACE_H_INCLUDED
#define WS_IWORKSPACE_H_INCLUDED
/*
 * Copyright 2011-2016 Universiteit Antwerpen
 *
 * Licensed under the EUPL, Version 1.1 or  as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl5
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing
 * permissions and limitations under the Licence.
 */
#include "IPreferences.h"
#include "IUserData.h"
#include "event/PreferencesChanged.h"
#include "event/WorkspaceChanged.h"
#include "util/misc/Subject.h"

#include <boost/property_tree/ptree.hpp>
#include <map>

namespace SimShell {
namespace Ws {

class IProject;
class IWorkspace;

class IWorkspace : public virtual IPreferences,
                   public IUserData,
                   public SimPT_Sim::Util::Subject<Event::WorkspaceChanged, std::weak_ptr<const void>>
{
public:
        virtual ~IWorkspace() {}

        class ProjectMapEntry {
        public:
                ProjectMapEntry(const std::shared_ptr<IProject>& p, const std::string& t)
                        : m_project(p), m_type(t) {}

                inline IProject* operator->() { return m_project.get(); }
                inline const IProject* operator->() const { return m_project.get(); }

                inline IProject& operator*() { return *m_project.get(); }
                inline const IProject& operator*() const { return *m_project.get(); }

                inline std::shared_ptr<const IProject> Project() const { return m_project; }
                inline std::shared_ptr<IProject> Project() { return m_project; }

                inline std::string Type() { return m_type; }

        private:
                std::shared_ptr<IProject>  m_project;
                std::string                m_type;
        };

        using ProjectMap = std::map<std::string, ProjectMapEntry>;
        using ProjectIterator = typename ProjectMap::iterator;
        using ConstProjectIterator = typename ProjectMap::const_iterator ;

        virtual ProjectIterator Add(const std::string& type, const std::string& name) = 0;

        virtual std::shared_ptr<IProject> Back() = 0;

        virtual std::shared_ptr<const IProject> Back() const = 0;

        virtual ProjectIterator begin() = 0;

        virtual ConstProjectIterator begin() const = 0;

        virtual std::shared_ptr<IProject> Front() = 0;

        virtual std::shared_ptr<const IProject> Front() const = 0;

        virtual ProjectIterator end() = 0;

        virtual ConstProjectIterator end() const = 0;

        virtual ProjectIterator Find(const std::string& name) = 0;

        virtual ConstProjectIterator Find(const std::string& name) const = 0;

        virtual bool IsProject(const std::string& name) const = 0;

        virtual std::shared_ptr<IProject> Get(const std::string& name) = 0;

        virtual std::shared_ptr<const IProject> Get(const std::string& name) const = 0;

        virtual const std::string& GetIndexFile() const = 0;

        virtual const std::string& GetPath() const = 0;

        virtual ProjectIterator New(const std::string& type, const std::string& name) = 0;

        virtual void Refresh() = 0;

        virtual void Remove(ProjectIterator it) = 0;

        virtual void Remove(const std::string& name) = 0;

        virtual ProjectIterator Rename(ProjectIterator, const std::string& new_name) = 0;

        virtual ProjectIterator Rename(const std::string& old_name, const std::string& new_name) = 0;
};

} // namespace
} // namespace

#endif // end_of_inclde_guard