CRNSavable.h

Go to the documentation of this file.

/* Copyright 2006-2016 INSA Lyon, CoReNum, ENS-Lyon
 * 
 * This file is part of libcrn.
 * 
 * libcrn is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * libcrn 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with libcrn.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * file: CRNSavable.h
 * \author Yann LEYDIER
 */

#ifndef CRNSAVABLE_HEADER
#define CRNSAVABLE_HEADER

#include <CRNObject.h>
#include <map>
#include <CRNString.h>
#include <CRNIO/CRNPath.h>
#include <CRNData/CRNMapPtr.h>
#include <mutex>

namespace crn
{
    class Savable;
    CRN_ALIAS_SMART_PTR(Savable)
}
namespace crn
{
    /****************************************************************************/
    class Savable : public Object
    {
        /**************************************************************************/
        /* Complex object interface                                               */
        /**************************************************************************/
        public:
            Savable(const String &s = U"");
            virtual ~Savable();

            Savable(const Savable&) = delete;
            Savable& operator=(const Savable&) = delete;

            Savable(Savable&&) noexcept;
            Savable& operator=(Savable&&c);

            const String& GetName() const { return name; }
            void SetName(const String &s) { name = s; }
            void SetName(String &&s) noexcept { name = std::move(s); }

            void SetUserData(const String &key, SObject value);
            bool IsUserData(const String &key) const;
            SObject GetUserData(const String &key);
            String GetUserDataKey(const SObject &value) const;
            const SObject GetUserData(const String &key) const;
            void DeleteUserData(const String &key);
            void ClearUserData();

        private:
            String name; 
            std::unique_ptr<Map> user_data; 
        /**************************************************************************/
        /* Savable protocol                                                       */
        /**************************************************************************/
        public:
            Savable(const String &s, const Path &fname);
            void Load(const Path &fname);
            void Save(const Path &fname);
            void Save();
            const Path& GetFilename() const noexcept { return filename; }
        protected:
            void setFilename(const Path &fname) { filename = fname; }
            void setFilename(Path &&fname) noexcept { filename = std::move(fname); }
            std::unique_ptr<std::mutex> filelock; 
        private:
            virtual Path completeFilename(const Path &fn) const;
            virtual void load(const Path &fname);
            virtual void save(const Path &fname);
            Path filename; 
        public:
            void deserialize_internal_data(xml::Element &el);
            void serialize_internal_data(xml::Element &el) const;
    };
}

#endif