forked from qt-creator/qt-creator
1d3d18a969
Change-Id: Iaf02e4d026f1ac8b216833d83cd7a735e21ff60a Reviewed-by: Nikolai Kosjar <nikolai.kosjar@qt.io> Reviewed-by: Orgad Shaneh <orgads@gmail.com>
110 lines
4.2 KiB
C++
110 lines
4.2 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** 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 The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "cpptools_global.h"
|
|
|
|
#include <cplusplus/CppDocument.h>
|
|
#include <cplusplus/PreprocessorClient.h>
|
|
|
|
#include <QList>
|
|
#include <QString>
|
|
|
|
QT_FORWARD_DECLARE_CLASS(QStringList)
|
|
QT_FORWARD_DECLARE_CLASS(QTextDocument)
|
|
|
|
namespace CppTools {
|
|
namespace IncludeUtils {
|
|
|
|
using Include = CPlusPlus::Document::Include;
|
|
using IncludeType = CPlusPlus::Client::IncludeType;
|
|
|
|
class CPPTOOLS_EXPORT IncludeGroup
|
|
{
|
|
public:
|
|
static QList<IncludeGroup> detectIncludeGroupsByNewLines(QList<Include> &includes);
|
|
static QList<IncludeGroup> detectIncludeGroupsByIncludeDir(const QList<Include> &includes);
|
|
static QList<IncludeGroup> detectIncludeGroupsByIncludeType(const QList<Include> &includes);
|
|
|
|
static QList<IncludeGroup> filterMixedIncludeGroups(const QList<IncludeGroup> &groups);
|
|
static QList<IncludeGroup> filterIncludeGroups(const QList<IncludeGroup> &groups,
|
|
CPlusPlus::Client::IncludeType includeType);
|
|
|
|
public:
|
|
explicit IncludeGroup(const QList<Include> &includes) : m_includes(includes) {}
|
|
|
|
QList<Include> includes() const { return m_includes; }
|
|
Include first() const { return m_includes.first(); }
|
|
Include last() const { return m_includes.last(); }
|
|
int size() const { return m_includes.size(); }
|
|
bool isEmpty() const { return m_includes.isEmpty(); }
|
|
|
|
QString commonPrefix() const;
|
|
QString commonIncludeDir() const; /// only valid if hasCommonDir() == true
|
|
bool hasCommonIncludeDir() const;
|
|
bool hasOnlyIncludesOfType(CPlusPlus::Client::IncludeType includeType) const;
|
|
bool isSorted() const; /// name-wise
|
|
|
|
int lineForNewInclude(const QString &newIncludeFileName,
|
|
CPlusPlus::Client::IncludeType newIncludeType) const;
|
|
|
|
private:
|
|
QStringList filesNames() const;
|
|
|
|
QList<Include> m_includes;
|
|
};
|
|
|
|
class CPPTOOLS_EXPORT LineForNewIncludeDirective
|
|
{
|
|
public:
|
|
enum MocIncludeMode { RespectMocIncludes, IgnoreMocIncludes };
|
|
enum IncludeStyle { LocalBeforeGlobal, GlobalBeforeLocal, AutoDetect };
|
|
|
|
LineForNewIncludeDirective(const QTextDocument *textDocument,
|
|
const CPlusPlus::Document::Ptr cppDocument,
|
|
MocIncludeMode mocIncludeMode = IgnoreMocIncludes,
|
|
IncludeStyle includeStyle = AutoDetect);
|
|
|
|
/// Returns the line (1-based) at which the include directive should be inserted.
|
|
/// On error, -1 is returned.
|
|
int operator()(const QString &newIncludeFileName, unsigned *newLinesToPrepend = nullptr,
|
|
unsigned *newLinesToAppend = nullptr);
|
|
|
|
private:
|
|
int findInsertLineForVeryFirstInclude(unsigned *newLinesToPrepend, unsigned *newLinesToAppend);
|
|
QList<IncludeGroup> getGroupsByIncludeType(const QList<IncludeGroup> &groups,
|
|
IncludeType includeType);
|
|
|
|
const QTextDocument *m_textDocument;
|
|
const CPlusPlus::Document::Ptr m_cppDocument;
|
|
|
|
IncludeStyle m_includeStyle;
|
|
QList<Include> m_includes;
|
|
};
|
|
|
|
} // namespace IncludeUtils
|
|
} // namespace CppTools
|