File: scanner.h

package info (click to toggle)
kookbook 0.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 468 kB
  • sloc: cpp: 1,609; python: 75; makefile: 4
file content (97 lines) | stat: -rw-r--r-- 3,273 bytes parent folder | download | duplicates (3)
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
/*
 * Copyright (c) 2018 Sune Vuorela <sune@vuorela.dk>
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once
#include <QObject>
#include <mutex>
#include "recipeparser.h"
#include <memory>
#include <QHash>
#include <future>

class QAbstractItemModel;
/**
 * File system scanner to index the recipes in the recipe collection.
 *
 * As a implementation detail, a worker thread is used for
 * the file system access and parsing and stuff.
 */
class Scanner : public QObject
{
    Q_OBJECT
public:
    Scanner(QObject* parent = nullptr);
    /**
     * \return tree model of parsed tags
     */
    std::shared_ptr<QAbstractItemModel> parsedTags() const;
    /**
     * \return tree model of parsed ingredients
     */
    std::shared_ptr<QAbstractItemModel> parsedIngredients() const;
    /**
     * \return list model of parsed title
     */
    std::shared_ptr<QAbstractItemModel> parsedTitleList() const;
    /**
     * \return map from file path to recipe title
     */
    QHash<QString,QString> parsedFileNameTitleMap() const;
    /**
     * Sets the (new) root path and triggers a re-indexing of everything.
     */
    void setRootPath(const QString& path);
    QString rootPath() const;
    ~Scanner();
public Q_SLOTS:
    /**
     * Re-indexes with current root path
     */
    void doUpdate();
Q_SIGNALS:
    /**
     * Emitted update is done (and new models and maps and such can be read)
     */
    void dataUpdated();
    /**
     * \internal - thread switching for dataUpdated.
     */
    void dataUpdatedInternal(QPrivateSignal p = QPrivateSignal());
private:
    mutable std::mutex m_mutex;
    std::shared_ptr<QAbstractItemModel> m_parsedTags;
    std::shared_ptr<QAbstractItemModel> m_parsedIngredients;
    std::shared_ptr<QAbstractItemModel> m_titleList;
    QHash<QString,QString> m_parsedFileNameTitleMap;
    /**
     * Function to be run in a different thread.
     * \param path Root path to start indexing from
     * \param targetThread The QThread to move created QObjects to (main thread) before switching back.
     */
    void parseThingsInDifferentThread(const QString& path, QThread* targetThread);
    QString m_rootPath;
    std::atomic_bool m_running;
    std::future<void> m_future;
};