completionchunkstotextconverter.h 4 KB
Newer Older
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
/****************************************************************************
**
** Copyright (C) 2015 Digia Plc and/or its subsidiary(-ies).
** Contact: http://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 Digia.  For licensing terms and
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/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 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.
**
** 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 CLANGCODEMODEL_INTERNAL_COMPLETIONCHUNKSTOTEXTCONVERTER_H
#define CLANGCODEMODEL_INTERNAL_COMPLETIONCHUNKSTOTEXTCONVERTER_H

34
#include <clangbackendipc/codecompletionchunk.h>
35 36 37

#include <sqlite/utf8string.h>

Marco Bubke's avatar
Marco Bubke committed
38 39
#include <QString>

40 41
#include <vector>

42 43 44 45 46 47
namespace ClangCodeModel {
namespace Internal {

class CompletionChunksToTextConverter
{
public:
48
    void parseChunks(const ClangBackEnd::CodeCompletionChunks &codeCompletionChunks);
49

50 51 52 53 54
    void setAddPlaceHolderText(bool addPlaceHolderText);
    void setAddPlaceHolderPositions(bool addPlaceHolderPositions);
    void setAddResultType(bool addResultType);
    void setAddSpaces(bool addSpaces);
    void setAddExtraVerticalSpaceBetweenBraces(bool addExtraVerticalSpaceBetweenBraces);
55 56
    void setAddHtmlTags(bool addHtmlTags);
    void setAddOptional(bool addOptional);
57

58
    const QString &text() const;
59 60
    const std::vector<int> &placeholderPositions() const;
    bool hasPlaceholderPositions() const;
61

62 63 64
    static QString convertToFunctionSignature(const ClangBackEnd::CodeCompletionChunks &codeCompletionChunks);
    static QString convertToName(const ClangBackEnd::CodeCompletionChunks &codeCompletionChunks);
    static QString convertToToolTip(const ClangBackEnd::CodeCompletionChunks &codeCompletionChunks);
65
private:
66
    void parse(const ClangBackEnd::CodeCompletionChunk & codeCompletionChunk);
67 68
    void parseResultType(const Utf8String &text);
    void parseText(const Utf8String &text);
69 70 71 72 73
    void parseOptional(const ClangBackEnd::CodeCompletionChunk &optionalCodeCompletionChunk);
    void parsePlaceHolder(const ClangBackEnd::CodeCompletionChunk &codeCompletionChunk);
    void parseLeftParen(const ClangBackEnd::CodeCompletionChunk &codeCompletionChunk);
    void parseLeftBrace(const ClangBackEnd::CodeCompletionChunk &codeCompletionChunk);
    void addExtraVerticalSpaceBetweenBraces();
74
    void addExtraVerticalSpaceBetweenBraces(const ClangBackEnd::CodeCompletionChunks::iterator &);
75

76 77
    bool canAddSpace() const;

78
private:
79
    std::vector<int> m_placeholderPositions;
80
    ClangBackEnd::CodeCompletionChunks m_codeCompletionChunks;
81
    ClangBackEnd::CodeCompletionChunk m_previousCodeCompletionChunk;
82
    QString m_text;
83 84 85 86 87
    bool m_addPlaceHolderText = false;
    bool m_addPlaceHolderPositions = false;
    bool m_addResultType = false;
    bool m_addSpaces = false;
    bool m_addExtraVerticalSpaceBetweenBraces = false;
88 89
    bool m_addHtmlTags = false;
    bool m_addOptional = false;
90 91 92 93 94 95
};

} // namespace Internal
} // namespace ClangCodeModel

#endif // CLANGCODEMODEL_INTERNAL_COMPLETIONCHUNKSTOTEXTCONVERTER_H