SpeedReader/speedreadertext.h at master · vanniktech/SpeedReader · GitHub

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/*
    Copyright 2014-2015 Vanniktech - Niklas Baudy

    This file is part of SpeedReader.

    SpeedReader is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 2 of the License, or
    (at your option) any later version.

    SpeedReader 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with SpeedReader. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef SPEEDREADERTEXT_H
#define SPEEDREADERTEXT_H

#include <QList>
#include <QString>
#include <QStringList>

#include "thread.h"
#include "speedreadersegment.h"
#include "speedreadertextdatasource.h"

class TextParts;

class SpeedReaderText : public Thread {
    Q_OBJECT

    public:
        enum SpeedReaderStatus { SPEEDREADING, STOPPING, FINISHED };

        SpeedReaderText(SpeedReaderTextDataSource* speedReaderTextDataSource, QObject *parent = 0);

        QString getText() const;
        int getIndex() const;
        int getMaxIndex() const;
        int getStopWordsRead() const;
        int getStopWordsCount();
        int getEstimatedTimeInMS() const;
        QString getHTMLColoredText() const;

        bool stopSpeedReading();
        void continueSpeedReading();
        void setText(const QString& text);

        static const QString HTML_ANCHOR_CURRENT_WORD;

        // Only for unit testing
        QList<SpeedReaderSegment> getDissectText() const { return mDissectText; }
    protected:
        void run();

    private:
        SpeedReaderTextDataSource* mSpeedReaderTextDataSource;
        QString mText;
        QList<SpeedReaderSegment> mDissectText;

        bool    mSpeedReading;
        int     mIndex;
        int     mStopWordsRead;
        int     mStopWordsCount;

        void dissectText();
        SpeedReaderSegment getSpeedReaderSegment(QMap<QString, int> delayWords, const QList<QString> &stopWords, const TextParts &textParts) const;
        QString prepareTextForDissecting(QString input) const;
        int getSpeedReadingTimePerMinuteInMs() const;

    signals:
        void changed(QString text, int speedreadTextInPercent, SpeedReaderText::SpeedReaderStatus status);
};

class TextParts {
public:
    static const TextParts EMPTY_TEXT_PARTS;

    TextParts() {}

    TextParts(const QString& string) {
        this->add(string);
    }

    void add(const QString& string) {
        mParts << string;
    }

    int size() const {
        return mParts.size();
    }

    bool contains(const QString& word) const {
        return mParts.contains(word);
    }

    bool contains(const QList<QString>& words) const {
        for (const QString word : words) {
            if (this->contains(word)) {
                return true;
            }
        }

        return false;
    }

    int numberOfOccurrences(const QString& word) const {
        return mParts.count(word);
    }

    void clear() {
        mParts.clear();
    }

    QString toString() const {
        QString result;

        for (QString part : mParts) {
            result.append(part).append(' '); // TODO make constant
        }

        return result.trimmed();
    }

private:
    QStringList mParts;
};

#endif // SPEEDREADERTEXT_H