summaryrefslogtreecommitdiff
path: root/src/plugins/clangcodemodel/utils.h
blob: d1a8abb4a056cc166d6daede08b59748074bdb3d (plain)
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
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** 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.
**
** GNU Lesser General Public License Usage
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef UTILS_H
#define UTILS_H

#include "pchinfo.h"

#include <QString>
#include <QStringList>
#include <QByteArray>
#include <QMap>
#include <QPair>

/*
 * A header for globally visible typedefs. This is particularly useful
 * so we don't have to #include files simply because of a typedef. Still,
 * not every typedef should go in here, only the minimal subset of the
 * ones which are needed quite often.
 */
namespace ClangCodeModel {
namespace Internal {

typedef QMap<QString, QByteArray> UnsavedFiles;

/**
 * Utility method to create a PCH file from a header file.
 *
 * \returns a boolean indicating success (true) or failure (false), and a
 *          list of diagnostic messages.
 */
QPair<bool, QStringList> precompile(const PchInfo::Ptr &pchInfo);

void initializeClang();

} // Internal namespace
} // ClangCodeModel namespace

#endif // UTILS_H