// Copyright (C) 2021 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 #include "collectionnode.h" #include QT_BEGIN_NAMESPACE /*! \class CollectionNode \brief A class for holding the members of a collection of doc pages. */ /*! Appends \a node to the collection node's member list, if and only if it isn't already in the member list. */ void CollectionNode::addMember(Node *node) { if (!m_members.contains(node)) m_members.append(node); } /*! Returns \c true if this collection node contains at least one namespace node. */ bool CollectionNode::hasNamespaces() const { return std::any_of(m_members.cbegin(), m_members.cend(), [](const Node *member) { return member->isClassNode() && member->isInAPI(); }); } /*! Returns \c true if this collection node contains at least one class node. */ bool CollectionNode::hasClasses() const { return std::any_of(m_members.cbegin(), m_members.cend(), [](const Node *member) { return member->isClassNode() && member->isInAPI(); }); } /*! Loads \a out with all this collection node's members that are namespace nodes. */ void CollectionNode::getMemberNamespaces(NodeMap &out) { out.clear(); for (const auto &member : std::as_const(m_members)) { if (member->isNamespace() && member->isInAPI()) out.insert(member->name(), member); } } /*! Loads \a out with all this collection node's members that are class nodes. */ void CollectionNode::getMemberClasses(NodeMap &out) const { out.clear(); for (const auto &member : std::as_const(m_members)) { if (member->isClassNode() && member->isInAPI()) out.insert(member->name(), member); } } /*! Returns the logical module version. */ QString CollectionNode::logicalModuleVersion() const { QStringList version; version << m_logicalModuleVersionMajor << m_logicalModuleVersionMinor; version.removeAll(QString()); return version.join("."); } /*! This function accepts the logical module \a info as a string list. If the logical module info contains the version number, it splits the version number on the '.' character to get the major and minor version numbers. Both major and minor version numbers should be provided, but the minor version number is not strictly necessary. */ void CollectionNode::setLogicalModuleInfo(const QStringList &info) { m_logicalModuleName = info[0]; if (info.size() > 1) { QStringList dotSplit = info[1].split(QLatin1Char('.')); m_logicalModuleVersionMajor = dotSplit[0]; if (dotSplit.size() > 1) m_logicalModuleVersionMinor = dotSplit[1]; else m_logicalModuleVersionMinor = "0"; } } /*! \fn void CollectionNode::setState(const QString &state) \fn QString CollectionNode::state() Sets or gets a description of this module's state. For example, \e {"Technical Preview"}. This string is used when generating the module's documentation page and reference pages of the module's members. */ QT_END_NAMESPACE