todoitemsscanner.h 2.17 KB
Newer Older
Dmitry Savchenko's avatar
Dmitry Savchenko committed
1 2
/**************************************************************************
**
3 4
** Copyright (c) 2013 Dmitry Savchenko
** Copyright (c) 2013 Vasiliy Sorokin
hjk's avatar
hjk committed
5
** Contact: http://www.qt-project.org/legal
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 13 14 15
** 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
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
Dmitry Savchenko's avatar
Dmitry Savchenko committed
16 17
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
18 19 20 21 22 23
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
Dmitry Savchenko's avatar
Dmitry Savchenko committed
24
**
hjk's avatar
hjk committed
25 26
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
Dmitry Savchenko's avatar
Dmitry Savchenko committed
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
Dmitry Savchenko's avatar
Dmitry Savchenko committed
30 31 32 33 34

#ifndef TODOITEMSSCANNER_H
#define TODOITEMSSCANNER_H

#include "todoitem.h"
35
#include "keyword.h"
Dmitry Savchenko's avatar
Dmitry Savchenko committed
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

#include <QObject>

namespace Todo {
namespace Internal {

// TodoItemsScanner is an abstract class

class TodoItemsScanner : public QObject
{
    Q_OBJECT

public:
    explicit TodoItemsScanner(const KeywordList &keywordList, QObject *parent = 0);
    void setKeywordList(const KeywordList &keywordList);

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

protected:
    KeywordList m_keywordList;

    virtual void keywordListChanged();
    void processCommentLine(const QString &fileName, const QString &comment, unsigned lineNumber,
        QList<TodoItem> &outItemList);
};

}
}

#endif // TODOITEMSSCANNER_H