sw: introduce a manager for content controls

The VBA API for content controls can access e.g. the 3rd content control
in the document, see
<https://learn.microsoft.com/en-us/office/vba/api/word.contentcontrols>.
To support something similar, first we need to track the content
controls in the document, otherwise getting the Nth element of that list
would require scanning the entire document, which would be slow.

SwContentControlManager::m_aContentControls is a plain vector, because
an o3tl::sorted_vector would require sorting at insert time, but our
content controls are typically first created and only later inserted,
and we want to use the insert position as the comparison key when
sorting.

This just keeps track of content controls (visible in the doc model XML
dump), somewhat similar to sw::MetaFieldManager or SwFootnoteIdxs.

UNO API to actually expose this is not yet added.

(cherry picked from commit ad950f10dc382ea169f94a0c301ca8c424e7103e)

Change-Id: I3f75334ffef684afc2c05a1bbdb7f247876d27ad
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/142462
Tested-by: Jenkins CollaboraOffice <jenkinscollaboraoffice@gmail.com>
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>

3 files changed, 25 insertions, 2 deletions

diff --git a/sw/inc/doc.hxx b/sw/inc/doc.hxx
index f7749190e3ea..c6b466d9ab3c 100644
--- a/sw/inc/doc.hxx
+++ b/sw/inc/doc.hxx
@@ -135,6 +135,7 @@ class IDocumentExternalData;
 class IDocumentMarkAccess;
 class SetGetExpFields;
 struct SwInsertTableOptions;
+class SwContentControlManager;
 enum class SvMacroItemId : sal_uInt16;
 enum class SvxFrameDirection;
 enum class RndStdIds;
@@ -210,6 +211,7 @@ class SW_DLLPUBLIC SwDoc final
 
     const std::unique_ptr< ::sw::mark::MarkManager> mpMarkManager;
     const std::unique_ptr< ::sw::MetaFieldManager > m_pMetaFieldManager;
+    const std::unique_ptr< ::SwContentControlManager > m_pContentControlManager;
     const std::unique_ptr< ::sw::DocumentDrawModelManager > m_pDocumentDrawModelManager;
     const std::unique_ptr< ::sw::DocumentRedlineManager > m_pDocumentRedlineManager;
     const std::unique_ptr< ::sw::DocumentStateManager > m_pDocumentStateManager;
@@ -1625,6 +1627,7 @@ public:
     const css::uno::Reference< css::container::XNameContainer >& GetVBATemplateToProjectCache() const { return m_xTemplateToProjectCache; };
     ::sfx2::IXmlIdRegistry& GetXmlIdRegistry();
     ::sw::MetaFieldManager & GetMetaFieldManager();
+    ::SwContentControlManager& GetContentControlManager();
     ::sw::UndoManager      & GetUndoManager();
     ::sw::UndoManager const& GetUndoManager() const;
 
diff --git a/sw/inc/formatcontentcontrol.hxx b/sw/inc/formatcontentcontrol.hxx
index 2cf220b9bcd1..86bc8a0c62b7 100644
--- a/sw/inc/formatcontentcontrol.hxx
+++ b/sw/inc/formatcontentcontrol.hxx
@@ -76,6 +76,7 @@ public:
      * (re-)moved.
      */
     void NotifyChangeTextNode(SwTextNode* pTextNode);
+    SwTextNode* GetTextNode() const;
     static SwFormatContentControl* CreatePoolDefault(sal_uInt16 nWhich);
     std::shared_ptr<SwContentControl> GetContentControl() { return m_pContentControl; }
     const std::shared_ptr<SwContentControl>& GetContentControl() const { return m_pContentControl; }
diff --git a/sw/inc/textcontentcontrol.hxx b/sw/inc/textcontentcontrol.hxx
index 1c445d812099..dc7d210f79a6 100644
--- a/sw/inc/textcontentcontrol.hxx
+++ b/sw/inc/textcontentcontrol.hxx
@@ -20,15 +20,19 @@
 
 #include "txatbase.hxx"
 
+class SwContentControlManager;
 class SwFormatContentControl;
 
 /// SwTextAttr subclass that tracks the location of the wrapped SwFormatContentControl.
 class SW_DLLPUBLIC SwTextContentControl final : public SwTextAttrNesting
 {
-    SwTextContentControl(SwFormatContentControl& rAttr, sal_Int32 nStart, sal_Int32 nEnd);
+    SwContentControlManager* m_pManager;
+
+    SwTextContentControl(SwContentControlManager* pManager, SwFormatContentControl& rAttr,
+                         sal_Int32 nStart, sal_Int32 nEnd);
 
 public:
-    static SwTextContentControl* CreateTextContentControl(SwTextNode* pTargetTextNode,
+    static SwTextContentControl* CreateTextContentControl(SwDoc& rDoc, SwTextNode* pTargetTextNode,
                                                           SwFormatContentControl& rAttr,
                                                           sal_Int32 nStart, sal_Int32 nEnd,
                                                           bool bIsCopy);
@@ -37,7 +41,22 @@ public:
 
     void ChgTextNode(SwTextNode* pNode);
 
+    SwTextNode* GetTextNode() const;
+
     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
 };
 
+/// Knows all the text content controls in the document.
+class SW_DLLPUBLIC SwContentControlManager
+{
+    /// Non-owning reference to text content controls.
+    std::vector<SwTextContentControl*> m_aContentControls;
+
+public:
+    SwContentControlManager();
+    void Insert(SwTextContentControl* pTextContentControl);
+    void Erase(SwTextContentControl* pTextContentControl);
+    void dumpAsXml(xmlTextWriterPtr pWriter) const;
+};
+
 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */