sw/inc/ToxLinkProcessor.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9 #pragma once
  10
  11 #include "fmtinfmt.hxx"
  12 #include <rtl/ustring.hxx>
  13
  14 #include <memory>
  15 #include <optional>
  16 #include <utility>
  17 #include <vector>
  18
  19 class SwTextNode;
  20
  21 class ToxLinkProcessorTest;
  22
  23 namespace sw {
  24
  25 /** A helper class for ToxTextGenerator.
  26  * It collects information about encountered link tokens and allows access in a processed form.
  27  */
  28 class ToxLinkProcessor {
  29 public:
  30     ToxLinkProcessor() {}
  31     virtual ~ToxLinkProcessor() {}
  32
  33     void
  34     StartNewLink(sal_Int32 startPosition, const OUString& characterStyle);
  35
  36     /** Close a link which has been found during processing.
  37      *
  38      * @internal
  39      * If you close more links than were opened, then the method will behave
  40      * as if a start link was opened at position 0 with the character style
  41      * STR_POOLCHR_TOXJUMP.
  42      */
  43     void
  44     CloseLink(sal_Int32 endPosition, const OUString& url, bool bRelative);
  45
  46     /** Insert the found links as attributes to a text node */
  47     void
  48     InsertLinkAttributes(SwTextNode& node);
  49
  50 private:
  51     /** Obtain the pool id which belongs to a character style.
  52      *
  53      * @internal
  54      * This method is overridden in the unittests. You should not override it yourself.
  55      */
  56     virtual sal_uInt16
  57     ObtainPoolId(const OUString& characterStyle) const;
  58
  59     /** Information about a started link */
  60     struct StartedLink {
  61         StartedLink(sal_Int32 startPosition, OUString characterStyle) :
  62                 mStartPosition(startPosition), mCharacterStyle(std::move(characterStyle)) {
  63         }
  64         sal_Int32 mStartPosition;
  65         OUString mCharacterStyle;
  66     };
  67
  68     /** A link that has been encountered while parsing a tox.
  69      * A link is closed if it has both a start and an end token.
  70      */
  71     struct ClosedLink {
  72         ClosedLink(const OUString& url, sal_Int32 startPosition, sal_Int32 endPosition)
  73             : mINetFormat(url, OUString())
  74             , mStartTextPos(startPosition)
  75             , mEndTextPos(endPosition)
  76         {
  77         }
  78         SwFormatINetFormat mINetFormat;
  79         sal_Int32 mStartTextPos;
  80         sal_Int32 mEndTextPos;
  81     };
  82
  83     std::vector<std::unique_ptr<ClosedLink>> m_ClosedLinks;
  84
  85     std::optional<StartedLink> m_oStartedLink;
  86
  87     friend class ::ToxLinkProcessorTest;
  88 };
  89
  90 }
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */