IProject.h

Go to the documentation of this file.

#ifndef WS_IPROJECT_H_INCLUDED
#define WS_IPROJECT_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 "IWorkspace.h"
#include "IPreferences.h"
#include "event/PreferencesChanged.h"
#include "event/ProjectChanged.h"
#include "util/misc/Subject.h"

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

class QAction;
class QWidget;

namespace SimShell {

namespace Session {
class ISession;
}

namespace Ws {

class IFile;
class MergedPreferences;

class IProject : public virtual IPreferences,
                 public IUserData,
                 public SimPT_Sim::Util::Subject<Event::ProjectChanged, std::weak_ptr<const void>>
{
public:
        using ConstructorType = std::function<std::shared_ptr<IProject>(
                const std::string&, const std::string&, const std::string&, const std::shared_ptr<IWorkspace>&)>;
        using FileMap = std::map<std::string, std::shared_ptr<IFile>>;
        using FileIterator = typename FileMap::iterator;
        using ConstFileIterator = typename FileMap::const_iterator;

        struct WidgetCallback {
                typedef std::function<std::shared_ptr<QWidget>(std::shared_ptr<MergedPreferences>, QWidget*)> Type;

                std::string    name;     
                Type           callback; 
        };

public:
        virtual ~IProject() {}

        virtual FileIterator Add(const std::string& name) = 0;

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

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

        virtual FileIterator begin() = 0;

        virtual ConstFileIterator begin() const = 0;

        virtual FileIterator end() = 0;

        virtual ConstFileIterator end() const = 0;

        virtual void Close() = 0;

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

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

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

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

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

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

        virtual std::vector<QAction*> GetContextMenuActions() const = 0;

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

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

        virtual std::shared_ptr<Session::ISession> GetSession() const = 0;

        virtual std::string GetSessionFileName() const = 0;

        virtual std::vector<WidgetCallback> GetWidgets() = 0;

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

        virtual bool IsOpened() const = 0;

        virtual bool IsWatchingDirectory() const = 0;

        virtual void Open() = 0;

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

        virtual void Open(FileIterator it) = 0;

        virtual void Refresh() = 0;

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

        virtual void Remove(FileIterator it) = 0;

        virtual Session::ISession& Session() const = 0;

        virtual void SetWatchingDirectory(bool) = 0;
};

} // namespace
} // namespace

#endif // end_of_inclde_guard