cpp_simshell/workspace/Project.h

Go to the documentation of this file.

#ifndef WS_PROJECT_H_INCLUDED
#define WS_PROJECT_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 "IProject.h"
#include "Preferences.h"
#include "session/ISession.h"
#include "util/FileSystemWatcher.h"

namespace SimShell {
namespace Ws {

template <class FileType, const std::string& index_file>
class Project : public IProject,
                public Preferences
{
public:
        Project(const std::string& path,
                const std::string& prefs_file,
                const std::shared_ptr<IWorkspace>& w);

        Project(Project<FileType, index_file>&&);

        virtual ~Project() {}

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

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

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

        virtual FileIterator begin();

        virtual ConstFileIterator begin() const;

        virtual FileIterator end();

        virtual ConstFileIterator end() const;

        virtual void Close();

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

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

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

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

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

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

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

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

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

        virtual std::string GetSessionFileName() const;

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

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

        virtual bool IsOpened() const;

        virtual bool IsWatchingDirectory() const;

        virtual void Open();

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

        virtual void Open(FileIterator);

        virtual void Refresh();

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

        virtual void Remove(FileIterator);

        virtual Session::ISession& Session() const;

        virtual void SetWatchingDirectory(bool);

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

private:
        Project(const Project<FileType, index_file>&);

        Project<FileType, index_file>& operator=(const Project<FileType, index_file>&);

        void Store();

protected:
        std::string                           m_path;               
        std::shared_ptr<IWorkspace>           m_workspace;          
        std::shared_ptr<Session::ISession>    m_session;            
        std::string                           m_session_name;       
        FileMap                               m_files;              
        mutable boost::property_tree::ptree   m_user_data;          
        Util::FileSystemWatcher               m_filesystem_watcher; 
};

} // namespace
} // namespace

#endif // end_of_inclde_guard