From 638545a9cc2c72eea34cfba6cb2bd847f31ca80a Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Mon, 11 Mar 2019 15:54:30 +0100 Subject: shiboken: Make the indentor helper class more flexible Move it to a separate header and turn it into a non-type template with a tabWidth parameter to make it possible to use it with arbitrary tab widths. Turn it into a non-type template taking the tab width. Change-Id: Ib2b6a7379ce66d1a22e73b4cb6a4a9a9b457014d Reviewed-by: Cristian Maureira-Fredes --- sources/shiboken2/ApiExtractor/typesystem.h | 2 - sources/shiboken2/generator/generator.h | 38 +--------- sources/shiboken2/generator/indentor.h | 85 ++++++++++++++++++++++ .../shiboken2/generator/shiboken2/cppgenerator.cpp | 5 +- .../shiboken2/generator/shiboken2/overloaddata.cpp | 14 ++-- 5 files changed, 95 insertions(+), 49 deletions(-) create mode 100644 sources/shiboken2/generator/indentor.h diff --git a/sources/shiboken2/ApiExtractor/typesystem.h b/sources/shiboken2/ApiExtractor/typesystem.h index 36a75c599..96d0bb5fd 100644 --- a/sources/shiboken2/ApiExtractor/typesystem.h +++ b/sources/shiboken2/ApiExtractor/typesystem.h @@ -46,8 +46,6 @@ extern const char *TARGET_CONVERSION_RULE_FLAG; extern const char *NATIVE_CONVERSION_RULE_FLAG; -class Indentor; - class AbstractMetaType; QT_BEGIN_NAMESPACE class QDebug; diff --git a/sources/shiboken2/generator/generator.h b/sources/shiboken2/generator/generator.h index cdf6d89b3..04840427f 100644 --- a/sources/shiboken2/generator/generator.h +++ b/sources/shiboken2/generator/generator.h @@ -29,6 +29,7 @@ #ifndef GENERATOR_H #define GENERATOR_H +#include "indentor.h" #include #include #include @@ -54,7 +55,6 @@ QT_END_NAMESPACE class PrimitiveTypeEntry; class ContainerTypeEntry; -class Indentor; QTextStream& formatCode(QTextStream &s, const QString& code, Indentor &indentor); void verifyDirectoryFor(const QString &file); @@ -417,41 +417,5 @@ Q_DECLARE_OPERATORS_FOR_FLAGS(Generator::Options) typedef QSharedPointer GeneratorPtr; typedef QVector Generators; -/** -* Utility class to store the identation level, use it in a QTextStream. -*/ -class Indentor -{ -public: - Indentor() : indent(0) {} - int indent; -}; - -/** -* Class that use the RAII idiom to set and unset the identation level. -*/ -class Indentation -{ -public: - Indentation(Indentor &indentor) : indentor(indentor) - { - indentor.indent++; - } - ~Indentation() - { - indentor.indent--; - } - -private: - Indentor &indentor; -}; - -inline QTextStream &operator <<(QTextStream &s, const Indentor &indentor) -{ - for (int i = 0; i < indentor.indent; ++i) - s << " "; - return s; -} - #endif // GENERATOR_H diff --git a/sources/shiboken2/generator/indentor.h b/sources/shiboken2/generator/indentor.h new file mode 100644 index 000000000..111259f12 --- /dev/null +++ b/sources/shiboken2/generator/indentor.h @@ -0,0 +1,85 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt for Python. +** +** $QT_BEGIN_LICENSE:GPL-EXCEPT$ +** 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. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef INDENTOR_H +#define INDENTOR_H + +#include + +/** +* Utility class to store the indentation level, use it in a QTextStream. +*/ + +template +class IndentorBase +{ +public: + int total() const { return tabWidth * indent; } + + int indent = 0; +}; + +using Indentor = IndentorBase<4>; +using Indentor1 = IndentorBase<1>; + +/** +* Class that use the RAII idiom to set and unset the indentation level. +*/ + +template +class IndentationBase +{ +public: + using Indentor = IndentorBase; + + IndentationBase(Indentor &indentor, int count = 1) : m_count(count), indentor(indentor) + { + indentor.indent += m_count; + } + + ~IndentationBase() + { + indentor.indent -= m_count; + } + +private: + const int m_count; + Indentor &indentor; +}; + +using Indentation = IndentationBase<4>; + +template +inline QTextStream &operator <<(QTextStream &s, const IndentorBase &indentor) +{ + for (int i = 0, total = indentor.total(); i < total; ++i) + s << ' '; + return s; +} + +#endif // GENERATOR_H diff --git a/sources/shiboken2/generator/shiboken2/cppgenerator.cpp b/sources/shiboken2/generator/shiboken2/cppgenerator.cpp index e284c6a54..86a632e78 100644 --- a/sources/shiboken2/generator/shiboken2/cppgenerator.cpp +++ b/sources/shiboken2/generator/shiboken2/cppgenerator.cpp @@ -2091,10 +2091,7 @@ void CppGenerator::writeCppSelfDefinition(QTextStream &s, QString checkFunc = cpythonCheckFunction(func->ownerClass()->typeEntry()); s << INDENT << "bool isReverse = " << checkFunc << PYTHON_ARG << ')' << endl; { - Indentation indent1(INDENT); - Indentation indent2(INDENT); - Indentation indent3(INDENT); - Indentation indent4(INDENT); + Indentation indent1(INDENT, 4); s << INDENT << "&& !" << checkFunc << "self);" << endl; } s << INDENT << "if (isReverse)" << endl; diff --git a/sources/shiboken2/generator/shiboken2/overloaddata.cpp b/sources/shiboken2/generator/shiboken2/overloaddata.cpp index a95603754..6a85bf7ef 100644 --- a/sources/shiboken2/generator/shiboken2/overloaddata.cpp +++ b/sources/shiboken2/generator/shiboken2/overloaddata.cpp @@ -30,6 +30,7 @@ #include #include #include "overloaddata.h" +#include "indentor.h" #include "shibokengenerator.h" #include @@ -857,13 +858,14 @@ static inline QString toHtml(QString s) QString OverloadData::dumpGraph() const { - QString indent(4, QLatin1Char(' ')); + Indentor INDENT; + Indentation indent(INDENT); QString result; QTextStream s(&result); if (m_argPos == -1) { const AbstractMetaFunction* rfunc = referenceFunction(); s << "digraph OverloadedFunction {" << endl; - s << indent << "graph [fontsize=12 fontname=freemono labelloc=t splines=true overlap=false rankdir=LR];" << endl; + s << INDENT << "graph [fontsize=12 fontname=freemono labelloc=t splines=true overlap=false rankdir=LR];" << endl; // Shows all function signatures s << "legend [fontsize=9 fontname=freemono shape=rect label=\""; @@ -878,7 +880,7 @@ QString OverloadData::dumpGraph() const s << "\"];" << endl; // Function box title - s << indent << '"' << rfunc->name() << "\" [shape=plaintext style=\"filled,bold\" margin=0 fontname=freemono fillcolor=white penwidth=1 "; + s << INDENT << '"' << rfunc->name() << "\" [shape=plaintext style=\"filled,bold\" margin=0 fontname=freemono fillcolor=white penwidth=1 "; s << "label=<"; s << "
"; if (rfunc->ownerClass()) @@ -931,14 +933,14 @@ QString OverloadData::dumpGraph() const s << "
> ];" << endl; for (const OverloadData *pd : m_nextOverloadData) - s << indent << '"' << rfunc->name() << "\" -> " << pd->dumpGraph(); + s << INDENT << '"' << rfunc->name() << "\" -> " << pd->dumpGraph(); s << "}" << endl; } else { QString argId = QLatin1String("arg_") + QString::number(quintptr(this)); s << argId << ';' << endl; - s << indent << '"' << argId << "\" [shape=\"plaintext\" style=\"filled,bold\" margin=\"0\" fontname=\"freemono\" fillcolor=\"white\" penwidth=1 "; + s << INDENT << '"' << argId << "\" [shape=\"plaintext\" style=\"filled,bold\" margin=\"0\" fontname=\"freemono\" fillcolor=\"white\" penwidth=1 "; s << "label=<"; // Argument box title @@ -982,7 +984,7 @@ QString OverloadData::dumpGraph() const s << "
>];" << endl; for (const OverloadData *pd : m_nextOverloadData) - s << indent << argId << " -> " << pd->dumpGraph(); + s << INDENT << argId << " -> " << pd->dumpGraph(); } return result; } -- cgit v1.2.3