cpp_simshell/workspace/Workspace.h

Go to the documentation of this file.

#ifndef WS_WORKSPACE_H_INCLUDED
#define WS_WORKSPACE_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 "Preferences.h"
#include "util/FileSystemWatcher.h"

#include <functional>

namespace SimShell {
namespace Ws {

template <class ProjectType, const std::string& index_file>
class Workspace : public IWorkspace, public Preferences
{
public:
        Workspace(const std::string& path,
                  const std::string& prefs_file);

        Workspace(Workspace<ProjectType, index_file>&&);

        virtual ~Workspace() {}

        virtual ProjectIterator begin();

        virtual ConstProjectIterator begin() const;

        virtual ProjectIterator end();

        virtual ConstProjectIterator end() const;

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

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

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

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

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

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

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

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

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

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

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

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

        virtual const boost::property_tree::ptree& GetUserData(const std::string& user) const;

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

        virtual void Refresh();

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

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

        virtual void Remove(ProjectIterator);

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

        virtual void SetUserData(const std::string& user, const boost::property_tree::ptree&);

private:
        Workspace(const Workspace<ProjectType, index_file>&);

        Workspace<ProjectType, index_file>& operator=(const Workspace<ProjectType, index_file>&);

        void Store() const;

protected:
        std::string                           m_path;        
        std::string                           m_prefs_file;  
        ProjectMap                            m_projects;    
        mutable boost::property_tree::ptree   m_user_data;   
        Util::FileSystemWatcher               m_filesystem_watcher; 
};

} // namespace
} // namespace

#endif // end_of_inclde_guard