summaryrefslogtreecommitdiffstats
path: root/src/qdoc/qdoc/src/qdoc/location.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/qdoc/qdoc/src/qdoc/location.h')
-rw-r--r--src/qdoc/qdoc/src/qdoc/location.h92
1 files changed, 92 insertions, 0 deletions
diff --git a/src/qdoc/qdoc/src/qdoc/location.h b/src/qdoc/qdoc/src/qdoc/location.h
new file mode 100644
index 000000000..8427bc917
--- /dev/null
+++ b/src/qdoc/qdoc/src/qdoc/location.h
@@ -0,0 +1,92 @@
+// Copyright (C) 2021 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
+
+#ifndef LOCATION_H
+#define LOCATION_H
+
+#include <QtCore/qcoreapplication.h>
+#include <QtCore/qstack.h>
+
+QT_BEGIN_NAMESPACE
+
+class QRegularExpression;
+
+class Location
+{
+public:
+ Location();
+ explicit Location(const QString &filePath);
+ Location(const Location &other);
+ ~Location() { delete m_stk; }
+
+ Location &operator=(const Location &other);
+
+ void start();
+ void advance(QChar ch);
+ void advanceLines(int n)
+ {
+ m_stkTop->m_lineNo += n;
+ m_stkTop->m_columnNo = 1;
+ }
+
+ void push(const QString &filePath);
+ void pop();
+ void setEtc(bool etc) { m_etc = etc; }
+ void setLineNo(int no) { m_stkTop->m_lineNo = no; }
+ void setColumnNo(int no) { m_stkTop->m_columnNo = no; }
+
+ [[nodiscard]] bool isEmpty() const { return m_stkDepth == 0; }
+ [[nodiscard]] int depth() const { return m_stkDepth; }
+ [[nodiscard]] const QString &filePath() const { return m_stkTop->m_filePath; }
+ [[nodiscard]] QString fileName() const;
+ [[nodiscard]] QString fileSuffix() const;
+ [[nodiscard]] int lineNo() const { return m_stkTop->m_lineNo; }
+ [[nodiscard]] int columnNo() const { return m_stkTop->m_columnNo; }
+ [[nodiscard]] bool etc() const { return m_etc; }
+ [[nodiscard]] QString toString() const;
+ void warning(const QString &message, const QString &details = QString()) const;
+ void error(const QString &message, const QString &details = QString()) const;
+ void fatal(const QString &message, const QString &details = QString()) const;
+ void report(const QString &message, const QString &details = QString()) const;
+
+ static void initialize();
+
+ static void terminate();
+ static void information(const QString &message);
+ static void internalError(const QString &hint);
+ static int exitCode();
+
+private:
+ enum MessageType { Warning, Error, Report };
+
+ struct StackEntry
+ {
+ QString m_filePath {};
+ int m_lineNo {};
+ int m_columnNo {};
+ };
+ friend class QTypeInfo<StackEntry>;
+
+ void emitMessage(MessageType type, const QString &message, const QString &details) const;
+ [[nodiscard]] QString top() const;
+
+private:
+ StackEntry m_stkBottom {};
+ QStack<StackEntry> *m_stk {};
+ StackEntry *m_stkTop {};
+ int m_stkDepth {};
+ bool m_etc {};
+
+ static int s_tabSize;
+ static int s_warningCount;
+ static int s_warningLimit;
+ static QString s_programName;
+ static QString s_project;
+ static QRegularExpression *s_spuriousRegExp;
+};
+Q_DECLARE_TYPEINFO(Location::StackEntry, Q_RELOCATABLE_TYPE);
+Q_DECLARE_TYPEINFO(Location, Q_COMPLEX_TYPE); // stkTop = &stkBottom
+
+QT_END_NAMESPACE
+
+#endif