Created a helper class to format books for display from the journal

view-model data.

apps/openmw/CMakeLists.txt

@@ -31,7 +31,7 @@ add_openmw_dir (mwgui
     confirmationdialog alchemywindow referenceinterface spellwindow mainmenu quickkeysmenu
     itemselection spellbuyingwindow loadingscreen levelupdialog waitdialog spellcreationdialog
     enchantingdialog trainingwindow travelwindow imagebutton exposedwindow cursor spellicons
-    merchantrepair repair soulgemdialog companionwindow bookpage journalviewmodel
+    merchantrepair repair soulgemdialog companionwindow bookpage journalviewmodel journalbooks
     )
 
 add_openmw_dir (mwdialogue

apps/openmw/mwgui/journalbooks.cpp

@@ -0,0 +1,323 @@
+#include "journalbooks.hpp"
+
+using namespace MWGui;
+
+namespace
+{
+    IBookTypesetter::utf8_span to_utf8_span (char const * Text)
+    {
+        typedef IBookTypesetter::utf8_point point;
+
+        point begin = reinterpret_cast <point> (Text);
+
+        return IBookTypesetter::utf8_span (begin, begin + strlen (Text));
+    }
+
+    const MyGUI::Colour linkHot    (0.40f, 0.40f, 0.80f);
+    const MyGUI::Colour linkNormal (0.20f, 0.20f, 0.60f);
+    const MyGUI::Colour linkActive (0.50f, 0.50f, 1.00f);
+
+    struct addContent
+    {
+        IBookTypesetter::ptr typesetter;
+        IBookTypesetter::IStyle* body_style;
+
+        addContent (IBookTypesetter::ptr typesetter, IBookTypesetter::IStyle* body_style) :
+            typesetter (typesetter), body_style (body_style)
+        {
+        }
+    };
+
+    struct addSpan : addContent
+    {
+        addSpan (IBookTypesetter::ptr typesetter, IBookTypesetter::IStyle* body_style) :
+            addContent (typesetter, body_style)
+        {
+        }
+
+        void operator () (intptr_t topicId, size_t begin, size_t end)
+        {
+            auto style = body_style;
+
+            if (topicId)
+                style = typesetter->createHotStyle (body_style, linkNormal, linkHot, linkActive, topicId);
+
+            typesetter->write (style, begin, end);
+        }
+    };
+
+    struct addEntry
+    {
+        IBookTypesetter::ptr typesetter;
+        IBookTypesetter::IStyle* body_style;
+
+        addEntry (IBookTypesetter::ptr typesetter, IBookTypesetter::IStyle* body_style) :
+            typesetter (typesetter), body_style (body_style)
+        {
+        }
+
+        void operator () (IJournalViewModel::IEntry const & Entry)
+        {
+            typesetter->add_content (Entry.body ());
+
+            Entry.visit_spans (addSpan (typesetter, body_style));
+        }
+    };
+
+    struct addJournalEntry : addEntry
+    {
+        bool add_header;
+        IBookTypesetter::IStyle* header_style;
+
+        addJournalEntry (IBookTypesetter::ptr typesetter, IBookTypesetter::IStyle* body_style,
+                            IBookTypesetter::IStyle* header_style, bool add_header) :
+            addEntry (typesetter, body_style),
+            header_style (header_style),
+            add_header (add_header)
+        {
+        }
+
+        void operator () (IJournalViewModel::IJournalEntry const & Entry)
+        {
+            if (add_header)
+            {
+                typesetter->write (header_style, Entry.timestamp ());
+                typesetter->lineBreak ();
+            }
+
+            addEntry::operator () (Entry);
+
+            typesetter->sectionBreak (10);
+        }
+    };
+
+    struct addTopicEntry : addEntry
+    {
+        intptr_t contentId;
+        IBookTypesetter::IStyle* header_style;
+
+        addTopicEntry (IBookTypesetter::ptr typesetter, IBookTypesetter::IStyle* body_style,
+                        IBookTypesetter::IStyle* header_style, intptr_t contentId) :
+            addEntry (typesetter, body_style), header_style (header_style), contentId (contentId)
+        {
+        }
+
+        void operator () (IJournalViewModel::ITopicEntry const & Entry)
+        {
+            typesetter->write (body_style, Entry.source ());
+            typesetter->write (body_style, 0, 3);// begin
+
+            addEntry::operator() (Entry);
+
+            typesetter->select_content (contentId);
+            typesetter->write (body_style, 2, 3);// end quote
+
+            typesetter->sectionBreak (10);
+        }
+    };
+
+    struct addTopicName : addContent
+    {
+        addTopicName (IBookTypesetter::ptr typesetter, IBookTypesetter::IStyle* style) :
+            addContent (typesetter, style)
+        {
+        }
+
+        void operator () (IJournalViewModel::utf8_span topicName)
+        {
+            typesetter->write (body_style, topicName);
+            typesetter->sectionBreak (10);
+        }
+    };
+
+    struct addQuestName : addContent
+    {
+        addQuestName (IBookTypesetter::ptr typesetter, IBookTypesetter::IStyle* style) :
+            addContent (typesetter, style)
+        {
+        }
+
+        void operator () (IJournalViewModel::utf8_span topicName)
+        {
+            typesetter->write (body_style, topicName);
+            typesetter->sectionBreak (10);
+        }
+    };
+
+    struct addTopicLink : addContent
+    {
+        addTopicLink (IBookTypesetter::ptr typesetter, IBookTypesetter::IStyle* style) :
+            addContent (typesetter, style)
+        {
+        }
+
+        void operator () (IJournalViewModel::topic_id topicId, IJournalViewModel::utf8_span name)
+        {
+            auto link = typesetter->createHotStyle (body_style, MyGUI::Colour::Black, linkHot, linkActive, topicId);
+
+            typesetter->write (link, name);
+            typesetter->lineBreak ();
+        }
+    };
+
+    struct addQuestLink : addContent
+    {
+        addQuestLink (IBookTypesetter::ptr typesetter, IBookTypesetter::IStyle* style) :
+            addContent (typesetter, style)
+        {
+        }
+
+        void operator () (IJournalViewModel::quest_id id, IJournalViewModel::utf8_span name)
+        {
+            auto style = typesetter->createHotStyle (body_style, MyGUI::Colour::Black, linkHot, linkActive, id);
+
+            typesetter->write (style, name);
+            typesetter->lineBreak ();
+        }
+    };
+}
+
+typedef ITypesetBook::ptr book;
+
+JournalBooks::JournalBooks (IJournalViewModel::ptr Model) :
+    Model (Model)
+{
+}
+
+book JournalBooks::createEmptyJournalBook ()
+{
+    auto typesetter = createTypesetter ();
+
+    auto header = typesetter->createStyle ("EB Garamond", MyGUI::Colour (0.60f, 0.00f, 0.00f));
+    auto body   = typesetter->createStyle ("EB Garamond", MyGUI::Colour::Black);
+
+    typesetter->write (header, to_utf8_span ("You have no journal entries!"));
+    typesetter->lineBreak ();
+    typesetter->write (body, to_utf8_span ("You should have gone though the starting quest and got an initial quest."));
+
+    auto big    = typesetter->createStyle ("EB Garamond 24", MyGUI::Colour::Black);
+    auto test   = typesetter->createStyle ("MonoFont", MyGUI::Colour::Blue);
+
+    typesetter->sectionBreak (20);
+    typesetter->write (body, to_utf8_span (
+        "The layout engine doesn't currently support aligning fonts to "
+        "their baseline within a single line so the following text looks "
+        "funny. In order to properly implement it, a stupidly simple "
+        "change is needed in MyGUI to report the where the baseline is for "
+        "a particular font"
+    ));
+
+    typesetter->sectionBreak (20);
+    typesetter->write (big, to_utf8_span ("big text g"));
+    typesetter->write (body, to_utf8_span (" проверяем только в дебаге"));
+    typesetter->write (body, to_utf8_span (" normal g"));
+    typesetter->write (big, to_utf8_span (" done g"));
+
+    typesetter->sectionBreak (20);
+    typesetter->write (test, to_utf8_span (
+        "int main (int argc,\n"
+        "          char ** argv)\n"
+        "{\n"
+        "    print (\"hello world!\\n\");\n"
+        "    return 0;\n"
+        "}\n"
+    ));
+
+    return typesetter->complete ();
+}
+
+book JournalBooks::createJournalBook ()
+{
+    auto typesetter = createTypesetter ();
+
+    auto header = typesetter->createStyle ("EB Garamond", MyGUI::Colour (0.60f, 0.00f, 0.00f));
+    auto body   = typesetter->createStyle ("EB Garamond", MyGUI::Colour::Black);
+
+    Model->visit_journal_entries (0, addJournalEntry (typesetter, body, header, true));
+
+    return typesetter->complete ();
+}
+
+book JournalBooks::createTopicBook (uintptr_t topicId)
+{
+    auto typesetter = createTypesetter ();
+
+    auto header = typesetter->createStyle ("EB Garamond", MyGUI::Colour (0.60f, 0.00f, 0.00f));
+    auto body   = typesetter->createStyle ("EB Garamond", MyGUI::Colour::Black);
+
+    Model->visit_topic_name (topicId, addTopicName (typesetter, header));
+
+    auto contentId = typesetter->add_content (to_utf8_span (", \""));
+
+    Model->visit_topic_entries (topicId, addTopicEntry (typesetter, body, header, contentId));
+
+    return typesetter->complete ();
+}
+
+book JournalBooks::createQuestBook (uintptr_t questId)
+{
+    auto typesetter = createTypesetter ();
+
+    auto header = typesetter->createStyle ("EB Garamond", MyGUI::Colour (0.60f, 0.00f, 0.00f));
+    auto body   = typesetter->createStyle ("EB Garamond", MyGUI::Colour::Black);
+
+    Model->visit_quest_name (questId, addQuestName (typesetter, header));
+
+    Model->visit_journal_entries (questId, addJournalEntry (typesetter, body, header, false));
+
+    return typesetter->complete ();
+}
+
+book JournalBooks::createTopicIndexBook ()
+{
+    auto typesetter = IBookTypesetter::create (92, 250);
+
+    typesetter->setSectionAlignment (IBookTypesetter::alignCenter);
+
+    auto body   = typesetter->createStyle ("EB Garamond", MyGUI::Colour::Black);
+
+    for (int i = 0; i < 26; ++i)
+    {
+        char ch = 'A' + i;
+
+        char buffer [32];
+
+        sprintf (buffer, "( %c )", ch);
+
+        auto style = typesetter->createHotStyle (body, MyGUI::Colour::Black, linkHot, linkActive, ch);
+
+        if (i == 13)
+            typesetter->sectionBreak ();
+
+        typesetter->write (style, to_utf8_span (buffer));
+        typesetter->lineBreak ();
+    }
+
+    return typesetter->complete ();
+}
+
+book JournalBooks::createTopicIndexBook (char character)
+{
+    auto typesetter = IBookTypesetter::create (0x7FFFFFFF, 0x7FFFFFFF);
+    auto style = typesetter->createStyle ("EB Garamond", MyGUI::Colour::Black);
+
+    Model->visit_topic_names_starting_with (character, addTopicLink (typesetter, style));
+
+    return typesetter->complete ();
+}
+
+book JournalBooks::createQuestIndexBook (bool activeOnly)
+{
+    auto typesetter = IBookTypesetter::create (0x7FFFFFFF, 0x7FFFFFFF);
+    auto base = typesetter->createStyle ("EB Garamond", MyGUI::Colour::Black);
+
+    Model->visit_quest_names (activeOnly, addQuestLink (typesetter, base));
+
+    return typesetter->complete ();
+}
+
+IBookTypesetter::ptr JournalBooks::createTypesetter ()
+{
+    //TODO: determine page size from layout...
+    return IBookTypesetter::create (240, 300);
+}

apps/openmw/mwgui/journalbooks.hpp

@@ -0,0 +1,29 @@
+#ifndef MWGUI_JOURNALBOOKS_HPP
+#define MWGUI_JOURNALBOOKS_HPP
+
+#include "bookpage.hpp"
+#include "journalviewmodel.hpp"
+
+namespace MWGui
+{
+    struct JournalBooks
+    {
+        typedef ITypesetBook::ptr book;
+        IJournalViewModel::ptr Model;
+
+        JournalBooks (IJournalViewModel::ptr Model);
+
+        book createEmptyJournalBook ();
+        book createJournalBook ();
+        book createTopicBook (uintptr_t topicId);
+        book createQuestBook (uintptr_t questId);
+        book createTopicIndexBook ();
+        book createTopicIndexBook (char character);
+        book createQuestIndexBook (bool showAll);
+
+    private:
+        IBookTypesetter::ptr createTypesetter ();
+    };
+}
+
+#endif // MWGUI_JOURNALBOOKS_HPP