docprivate.h

Go to the documentation of this file.

// 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 DOCPRIVATE_H
#define DOCPRIVATE_H
 
#include "atom.h"
#include "config.h"
#include "codemarker.h"
#include "doc.h"
#include "editdistance.h"
#include "generator.h"
#include "utilities.h"
#include "openedlist.h"
#include "quoter.h"
#include "text.h"
#include "tokenizer.h"
 
#include <QtCore/qdatetime.h>
#include <QtCore/qfile.h>
#include <QtCore/qfileinfo.h>
#include <QtCore/qhash.h>
#include <QtCore/qmap.h>
#include <QtCore/qtextstream.h>
 
#include <cctype>
#include <climits>
#include <utility>
 
QT_BEGIN_NAMESPACE
 
typedef QMap<QString, ArgList> CommandMap;
 
struct DocPrivateExtra
{
    QList<Atom *> m_tableOfContents {};
    QList<int> m_tableOfContentsLevels {};
    QList<Atom *> m_keywords {};
    QList<Atom *> m_targets {};
    QStringMultiMap m_metaMap {};
    QMultiMap<ComparisonCategory, Text> m_comparesWithMap {};
};
 
class DocPrivate
{
public:
    explicit DocPrivate(const Location &start = Location(), const Location &end = Location(),
                        QString source = QString())
        : m_start_loc(start), m_end_loc(end), m_src(std::move(source)), m_hasLegalese(false) {};
    ~DocPrivate();
 
    void addAlso(const Text &also);
    void constructExtra();
    void ref() { ++count; }
    bool deref() { return (--count == 0); }
 
    int count { 1 };
    // ### move some of this in DocPrivateExtra
    Location m_start_loc {};
    Location m_end_loc {};
    QString m_src {};
    Text m_text {};
    QSet<QString> m_params {};
    QList<Text> m_alsoList {};
    QStringList m_enumItemList {};
    QStringList m_omitEnumItemList {};
    QSet<QString> m_metacommandsUsed {};
    CommandMap m_metaCommandMap {};
    DocPrivateExtra *extra { nullptr };
    TopicList m_topics {};
 
    bool m_hasLegalese : 1;
};
 
QT_END_NAMESPACE
 
#endif // DOCPRIVATE_H