journalviewmodel.hpp

Go to the documentation of this file.

#ifndef MWGUI_JOURNALVIEWMODEL_HPP
#define MWGUI_JOURNALVIEWMODEL_HPP

#include <string>
#include <memory>
#include <functional>
#include <stdint.h>

#include <components/misc/utf8stream.hpp>

namespace MWGui
{
    struct JournalViewModel
    {
        typedef std::shared_ptr <JournalViewModel> Ptr;

        typedef intptr_t QuestId;
        typedef intptr_t TopicId;
        typedef uint8_t const * Utf8Point;
        typedef std::pair <Utf8Point, Utf8Point> Utf8Span;

        struct Entry
        {
            virtual Utf8Span body () const = 0;

            virtual void visitSpans (std::function <void (TopicId, size_t, size_t)> visitor) const = 0;
        };

        struct TopicEntry : Entry
        {
            virtual Utf8Span source () const = 0;
        };

        struct JournalEntry : Entry
        {
            virtual Utf8Span timestamp () const = 0;
        };


        virtual void load () = 0;

        virtual void unload () = 0;

        virtual bool isEmpty () const = 0;

        virtual void visitQuestNames (bool active_only, std::function <void (const std::string&, bool)> visitor) const = 0;

        virtual void visitJournalEntries (const std::string& questName, std::function <void (JournalEntry const &)> visitor) const = 0;

        virtual void visitTopicName (TopicId topicId, std::function <void (Utf8Span)> visitor) const = 0;

        virtual void visitTopicNamesStartingWith (Utf8Stream::UnicodeChar character, std::function < void (const std::string&) > visitor) const = 0;

        virtual void visitTopicEntries (TopicId topicId, std::function <void (TopicEntry const &)> visitor) const = 0;

        // create an instance of the default journal view model implementation
        static Ptr create ();
    };
}

#endif // MWGUI_JOURNALVIEWMODEL_HPP