todoitemsscanner.h 2.4 KB
Newer Older
Dmitry Savchenko's avatar
Dmitry Savchenko committed
1 2
/**************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4 5
** Copyright (C) 2015 Dmitry Savchenko
** Copyright (C) 2015 Vasiliy Sorokin
** Contact: http://www.qt.io/licensing
Dmitry Savchenko's avatar
Dmitry Savchenko committed
6
**
hjk's avatar
hjk committed
7
** This file is part of Qt Creator.
Dmitry Savchenko's avatar
Dmitry Savchenko committed
8
**
hjk's avatar
hjk committed
9 10 11 12
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
Eike Ziller's avatar
Eike Ziller committed
13 14
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
15
** use the contact form at http://www.qt.io/contact-us.
Dmitry Savchenko's avatar
Dmitry Savchenko committed
16 17
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
18
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
19 20 21 22 23 24
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
Dmitry Savchenko's avatar
Dmitry Savchenko committed
25
**
Eike Ziller's avatar
Eike Ziller committed
26 27
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
Dmitry Savchenko's avatar
Dmitry Savchenko committed
28 29
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
30
****************************************************************************/
Dmitry Savchenko's avatar
Dmitry Savchenko committed
31 32 33 34 35

#ifndef TODOITEMSSCANNER_H
#define TODOITEMSSCANNER_H

#include "todoitem.h"
36
#include "keyword.h"
Dmitry Savchenko's avatar
Dmitry Savchenko committed
37 38 39

#include <QObject>

40 41 42 43
namespace ProjectExplorer {
class Project;
}

Dmitry Savchenko's avatar
Dmitry Savchenko committed
44 45 46 47 48 49 50 51 52 53 54
namespace Todo {
namespace Internal {

// TodoItemsScanner is an abstract class

class TodoItemsScanner : public QObject
{
    Q_OBJECT

public:
    explicit TodoItemsScanner(const KeywordList &keywordList, QObject *parent = 0);
55
    void setParams(const KeywordList &keywordList);
Dmitry Savchenko's avatar
Dmitry Savchenko committed
56 57 58 59 60 61 62

signals:
    void itemsFetched(const QString &fileName, const QList<TodoItem> &items);

protected:
    KeywordList m_keywordList;

63 64 65 66 67
    // Descendants can override and make a request for full rescan here if needed
    virtual void scannerParamsChanged() = 0;

    void processCommentLine(const QString &fileName, const QString &comment,
                            unsigned lineNumber, QList<TodoItem> &outItemList);
Dmitry Savchenko's avatar
Dmitry Savchenko committed
68 69 70 71 72 73
};

}
}

#endif // TODOITEMSSCANNER_H