File: loader.hpp

package info (click to toggle)
openmw 0.49.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,992 kB
  • sloc: cpp: 372,479; xml: 2,149; sh: 1,403; python: 797; makefile: 26
file content (82 lines) | stat: -rw-r--r-- 2,160 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
#ifndef CSM_DOC_LOADER_H
#define CSM_DOC_LOADER_H

#include <chrono>
#include <optional>
#include <string>
#include <utility>
#include <vector>

#include <QMutex>
#include <QObject>
#include <QWaitCondition>

class QTimer;

namespace CSMDoc
{
    class Document;

    class Loader : public QObject
    {
        Q_OBJECT

        struct Stage
        {
            int mFile = 0;
            int mRecordsLoaded = 0;
            bool mRecordsLeft = false;
        };

        QMutex mMutex;
        QWaitCondition mThingsToDo;
        std::vector<std::pair<Document*, Stage>> mDocuments;

        QTimer* mTimer;
        bool mShouldStop;

        std::optional<std::chrono::steady_clock::time_point> mStart;

    public:
        Loader();

        QWaitCondition& hasThingsToDo();

        void stop();

    private slots:

        void load();

    public slots:

        void loadDocument(CSMDoc::Document* document);
        ///< The ownership of \a document is not transferred.

        void abortLoading(CSMDoc::Document* document);
        ///< Abort loading \a docuemnt (ignored if \a document has already finished being
        /// loaded). Will result in a documentNotLoaded signal, once the Loader has finished
        /// cleaning up.

    signals:

        void documentLoaded(Document* document);
        ///< The ownership of \a document is not transferred.

        void documentNotLoaded(Document* document, const std::string& error);
        ///< Document load has been interrupted either because of a call to abortLoading
        /// or a problem during loading). In the former case error will be an empty string.

        void nextStage(CSMDoc::Document* document, const std::string& name, int totalRecords);

        void nextRecord(CSMDoc::Document* document, int records);
        ///< \note This signal is only given once per group of records. The group size is
        /// approximately the total number of records divided by the steps value of the
        /// previous nextStage signal.

        void loadMessage(CSMDoc::Document* document, const std::string& message);
        ///< Non-critical load error or warning
    };
}

#endif