/home/maarten/src/libreoffice/core/sw/inc/crsrsh.hxx

Bug Summary

File:	home/maarten/src/libreoffice/core/sw/inc/crsrsh.hxx
Warning:	line 881, column 29 Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -cc1 -triple x86_64-unknown-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name viscrs.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /usr/include/libxml2 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D SW_DLLIMPLEMENTATION -D SWUI_DLL_NAME="libswuilo.so" -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/sw/source/core/inc -I /home/maarten/src/libreoffice/core/sw/source/filter/inc -I /home/maarten/src/libreoffice/core/sw/source/uibase/inc -I /home/maarten/src/libreoffice/core/sw/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sw/sdi -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/sw/generated -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/oovbaapi/normal -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/sw/source/core/crsr/viscrs.cxx

/home/maarten/src/libreoffice/core/sw/source/core/crsr/viscrs.cxx

→

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
*   Licensed to the Apache Software Foundation (ASF) under one or more
*   contributor license agreements. See the NOTICE file distributed
*   with this work for additional information regarding copyright
*   ownership. The ASF licenses this file to you under the Apache
*   License, Version 2.0 (the "License"); you may not use this file
*   except in compliance with the License. You may obtain a copy of
*   the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/

20#include <config_features.h>

22#include <vcl/weld.hxx>
23#include <vcl/svapp.hxx>
24#include <vcl/settings.hxx>
25#include <viewopt.hxx>
26#include <frmtool.hxx>
27#include <viscrs.hxx>
28#include <crsrsh.hxx>
29#include <doc.hxx>
30#include <swtable.hxx>
31#include <viewimp.hxx>
32#include <dview.hxx>
33#include <rootfrm.hxx>
34#include <txtfrm.hxx>
35#include <ndtxt.hxx>
36#include <txtfld.hxx>
37#include <scriptinfo.hxx>
38#include <view.hxx>
39#include <IDocumentLayoutAccess.hxx>

41#include <svx/sdr/overlay/overlaymanager.hxx>
42#include <svx/sdrpaintwindow.hxx>
43#include <svx/srchdlg.hxx>
44#include <svx/sdr/overlay/overlayselection.hxx>
45#include "overlayrangesoutline.hxx"

47#include <memory>

49#include <LibreOfficeKit/LibreOfficeKitEnums.h>
50#include <comphelper/lok.hxx>
51#include <sfx2/lokhelper.hxx>
52#include <boost/property_tree/json_parser.hpp>
53#include <comphelper/string.hxx>
54#include <paintfrm.hxx>
55#include <PostItMgr.hxx>
56#include <SwGrammarMarkUp.hxx>
57#include <docsh.hxx>

59#include <cellfrm.hxx>
60#include <wrtsh.hxx>

62// Here static members are defined. They will get changed on alteration of the
63// MapMode. This is done so that on ShowCursor the same size does not have to be
64// expensively determined again and again.

66long SwSelPaintRects::s_nPixPtX = 0;
67long SwSelPaintRects::s_nPixPtY = 0;
68MapMode* SwSelPaintRects::s_pMapMode = nullptr;

70// Starting from here: classes / methods for the non-text-cursor
71SwVisibleCursor::SwVisibleCursor( const SwCursorShell * pCShell )
  : m_pCursorShell( pCShell )
  , m_nPageLastTime(0)
74{
  pCShell->GetWin()->SetCursor( &m_aTextCursor );
  m_bIsVisible = m_aTextCursor.IsVisible();
  m_bIsDragCursor = false;
  m_aTextCursor.SetWidth( 0 );
79}

81SwVisibleCursor::~SwVisibleCursor()
82{
  if( m_bIsVisible && m_aTextCursor.IsVisible() )
      m_aTextCursor.Hide();

  m_pCursorShell->GetWin()->SetCursor( nullptr );
87}

89void SwVisibleCursor::Show()
90{
  if( !m_bIsVisible )
1
Assuming field 'm_bIsVisible' is false→
2
←
Taking true branch→
  {
      m_bIsVisible = true;

      // display at all?
      if( m_pCursorShell->VisArea().IsOver( m_pCursorShell->m_aCharRect ) || comphelper::LibreOfficeKit::isActive() )
3
←
Assuming the condition is true→
          SetPosAndShow(nullptr);
4
←
Calling 'SwVisibleCursor::SetPosAndShow'→
  }
99}

101void SwVisibleCursor::Hide()
102{
  if( m_bIsVisible )
  {
      m_bIsVisible = false;

      if( m_aTextCursor.IsVisible() )      // Shouldn't the flags be in effect?
          m_aTextCursor.Hide();
  }
110}

112namespace
113{

115// Build JSON message to be sent to Online
116OString buildHyperlinkJSON(const OUString& sText, const OUString& sLink)
117{
  boost::property_tree::ptree aTree;
  aTree.put("text", sText);
  aTree.put("link", sLink);
  std::stringstream aStream;
  boost::property_tree::write_json(aStream, aTree, false);

  return OString(aStream.str().c_str()).trim();
125}

127}

129void SwVisibleCursor::SetPosAndShow(SfxViewShell const * pViewShell)
130{
  SwRect aRect;
  long nTmpY = m_pCursorShell->m_aCursorHeight.getY();
  if( 0 > nTmpY )
5
←
Assuming 'nTmpY' is >= 0→
6
←
Taking false branch→
  {
      nTmpY = -nTmpY;
      m_aTextCursor.SetOrientation( 900 );
      aRect = SwRect( m_pCursorShell->m_aCharRect.Pos(),
         Size( m_pCursorShell->m_aCharRect.Height(), nTmpY ) );
      aRect.Pos().setX(aRect.Pos().getX() + m_pCursorShell->m_aCursorHeight.getX());
      if( m_pCursorShell->IsOverwriteCursor() )
          aRect.Pos().setY(aRect.Pos().getY() + aRect.Width());
  }
  else
  {
      m_aTextCursor.SetOrientation();
      aRect = SwRect( m_pCursorShell->m_aCharRect.Pos(),
         Size( m_pCursorShell->m_aCharRect.Width(), nTmpY ) );
      aRect.Pos().setY(aRect.Pos().getY() + m_pCursorShell->m_aCursorHeight.getX());
  }

  // check if cursor should show the current cursor bidi level
  m_aTextCursor.SetDirection();
  const SwCursor* pTmpCursor = m_pCursorShell->GetCursor_();

  if ( pTmpCursor && !m_pCursorShell->IsOverwriteCursor() )
7
←
Assuming 'pTmpCursor' is null→
  {
      SwNode& rNode = pTmpCursor->GetPoint()->nNode.GetNode();
      if( rNode.IsTextNode() )
      {
          const SwTextNode& rTNd = *rNode.GetTextNode();
          const SwFrame* pFrame = rTNd.getLayoutFrame(m_pCursorShell->GetLayout(), nullptr, nullptr);
          if ( pFrame )
          {
              const SwScriptInfo* pSI = static_cast<const SwTextFrame*>(pFrame)->GetScriptInfo();
               // cursor level has to be shown
              if ( pSI && pSI->CountDirChg() > 1 )
              {
                  m_aTextCursor.SetDirection(
                      ( pTmpCursor->GetCursorBidiLevel() % 2 ) ?
                        CursorDirection::RTL :
                        CursorDirection::LTR );
              }
              if ( pFrame->IsRightToLeft() )
              {
                  const OutputDevice *pOut = m_pCursorShell->GetOut();
                  if ( pOut )
                  {
                      long nSize = pOut->GetSettings().GetStyleSettings().GetCursorSize();
                      Size aSize( nSize, nSize );
                      aSize = pOut->PixelToLogic( aSize );
                      aRect.Left( aRect.Left() - aSize.Width() );
                  }
              }
          }
      }
  }

  if( aRect.Height())
8
←
Assuming the condition is false→
9
←
Taking false branch→
  {
      ::SwCalcPixStatics( m_pCursorShell->GetOut() );

      // Disable pixel alignment when tiled rendering, so that twip values of
      // the cursor don't depend on statics.
      if (!comphelper::LibreOfficeKit::isActive())
          ::SwAlignRect( aRect, static_cast<SwViewShell const *>(m_pCursorShell), m_pCursorShell->GetOut() );
  }
  if( !m_pCursorShell->IsOverwriteCursor() || m_bIsDragCursor ||
10
←
Assuming the condition is false→
11
←
Assuming field 'm_bIsDragCursor' is false→
      m_pCursorShell->IsSelection() )
12
←
Calling 'SwCursorShell::IsSelection'→
      aRect.Width( 0 );

  m_aTextCursor.SetSize( aRect.SSize() );

  m_aTextCursor.SetPos( aRect.Pos() );

  bool bPostItActive = false;
  SwView* pView = dynamic_cast<SwView*>(m_pCursorShell->GetSfxViewShell());
  if (pView)
  {
      if (SwPostItMgr* pPostItMgr = pView->GetPostItMgr())
          bPostItActive = pPostItMgr->GetActiveSidebarWin() != nullptr;
  }

  if (comphelper::LibreOfficeKit::isActive() && !bPostItActive)
  {
      // notify about page number change (if that happened)
      sal_uInt16 nPage, nVirtPage;
      // bCalcFrame=false is important to avoid calculating the layout when
      // we're in the middle of doing that already.
      const_cast<SwCursorShell*>(m_pCursorShell)->GetPageNum(nPage, nVirtPage, /*bAtCursorPos=*/true, /*bCalcFrame=*/false);
      if (nPage != m_nPageLastTime)
      {
          m_nPageLastTime = nPage;
          OString aPayload = OString::number(nPage - 1);
          m_pCursorShell->GetSfxViewShell()->libreOfficeKitViewCallback(LOK_CALLBACK_SET_PART, aPayload.getStr());
      }

      // notify about the cursor position & size
      tools::Rectangle aSVRect(aRect.Pos().getX(), aRect.Pos().getY(), aRect.Pos().getX() + aRect.SSize().Width(), aRect.Pos().getY() + aRect.SSize().Height());
      OString sRect = aSVRect.toString();

      // is cursor at a misspelled word ?
      bool bIsWrong = false;
      if (pView && pView->GetWrtShellPtr())
      {
          const SwViewOption* pVOpt = pView->GetWrtShell().GetViewOptions();
          if(pVOpt && pVOpt->IsOnlineSpell())
          {
              SwPaM* pCursor = m_pCursorShell->GetCursor();
              SwPosition aPos(*pCursor->GetPoint());
              Point aPt = aRect.Pos();
              SwCursorMoveState eTmpState(CursorMoveState::SetOnlyText);
              SwTextNode *pNode = nullptr;
              if (m_pCursorShell->GetLayout()->GetModelPositionForViewPoint(&aPos, aPt, &eTmpState))
                  pNode = aPos.nNode.GetNode().GetTextNode();
              if (pNode && !pNode->IsInProtectSect())
              {
                  sal_Int32 nBegin = aPos.nContent.GetIndex();
                  sal_Int32 nLen = 1;

                  SwWrongList *pWrong = nullptr;
                  pWrong = pNode->GetWrong();
                  if (!pWrong)
                      pWrong = pNode->GetGrammarCheck();
                  if (pWrong)
                      bIsWrong = pWrong->InWrongWord(nBegin,nLen) && !pNode->IsSymbolAt(nBegin);
               }
          }
      }

      OString sHyperlink;
      SwContentAtPos aContentAtPos(IsAttrAtPos::InetAttr);
      bool bIsSelection = m_pCursorShell->IsSelection();

      if (const_cast<SwCursorShell*>(m_pCursorShell)->GetContentAtPos(aRect.Pos(), aContentAtPos))
      {
          const SwFormatINetFormat* pItem = static_cast<const SwFormatINetFormat*>(aContentAtPos.aFnd.pAttr);
          sHyperlink = buildHyperlinkJSON(aContentAtPos.sStr, pItem->GetValue());
      }
      else if (bIsSelection)
      {
          SwWrtShell* pShell = m_pCursorShell->GetDoc()->GetDocShell()->GetWrtShell();

          if (pShell)
          {
              SfxItemSet aSet(m_pCursorShell->GetSfxViewShell()->GetPool(),
                  svl::Items<RES_TXTATR_INETFMT,
                  RES_TXTATR_INETFMT>{});
              pShell->GetCurAttr(aSet);
              if(SfxItemState::SET <= aSet.GetItemState( RES_TXTATR_INETFMT ))
              {
                  sHyperlink = buildHyperlinkJSON(m_pCursorShell->GetSelText(),
                                                  aSet.GetItem(RES_TXTATR_INETFMT)->GetValue());
              }
          }
      }

      if (pViewShell)
      {
          if (pViewShell == m_pCursorShell->GetSfxViewShell())
          {
              SfxLokHelper::notifyVisCursorInvalidation(pViewShell, sRect, bIsWrong, sHyperlink);
          }
          else
              SfxLokHelper::notifyOtherView(m_pCursorShell->GetSfxViewShell(), pViewShell, LOK_CALLBACK_INVALIDATE_VIEW_CURSOR, "rectangle", sRect);
      }
      else
      {
          SfxLokHelper::notifyVisCursorInvalidation(m_pCursorShell->GetSfxViewShell(), sRect, bIsWrong, sHyperlink);
          SfxLokHelper::notifyOtherViews(m_pCursorShell->GetSfxViewShell(), LOK_CALLBACK_INVALIDATE_VIEW_CURSOR, "rectangle", sRect);
      }
  }

  if ( m_pCursorShell->IsCursorReadonly() && !m_pCursorShell->GetViewOptions()->IsSelectionInReadonly() )
      return;

  if ( m_pCursorShell->GetDrawView() )
      const_cast<SwDrawView*>(static_cast<const SwDrawView*>(m_pCursorShell->GetDrawView()))->SetAnimationEnabled(
              !m_pCursorShell->IsSelection() );

  sal_uInt16 nStyle = m_bIsDragCursor ? CURSOR_SHADOW(sal_uInt16(0x0001)) : 0;
  if( nStyle != m_aTextCursor.GetStyle() )
  {
      m_aTextCursor.SetStyle( nStyle );
      m_aTextCursor.SetWindow( m_bIsDragCursor ? m_pCursorShell->GetWin() : nullptr );
  }

  m_aTextCursor.Show();
318}

320const vcl::Cursor& SwVisibleCursor::GetTextCursor() const
321{
  return m_aTextCursor;
323}

325SwSelPaintRects::SwSelPaintRects( const SwCursorShell& rCSh )
  : SwRects()
  , m_pCursorShell( &rCSh )
328#if HAVE_FEATURE_DESKTOP1
  , m_bShowTextInputFieldOverlay(true)
330#endif
331{
332}

334SwSelPaintRects::~SwSelPaintRects()
335{
  Hide();
337}

339void SwSelPaintRects::swapContent(SwSelPaintRects& rSwap)
340{
  SwRects::swap(rSwap);

343#if HAVE_FEATURE_DESKTOP1
  // #i75172# also swap m_pCursorOverlay
  std::swap(m_pCursorOverlay, rSwap.m_pCursorOverlay);
  std::swap(m_bShowTextInputFieldOverlay, rSwap.m_bShowTextInputFieldOverlay);
  std::swap(m_pTextInputFieldOverlay, rSwap.m_pTextInputFieldOverlay);
348#endif
349}

351void SwSelPaintRects::Hide()
352{
353#if HAVE_FEATURE_DESKTOP1
  m_pCursorOverlay.reset();
  m_pTextInputFieldOverlay.reset();
356#endif

  SwRects::clear();
359}

361/**
* Return a layout rectangle (typically with minimal width) that represents a
* cursor at rPosition.
*
* @param rPoint layout position as a hint about what layout frame contains
* rPosition (there might be multiple frames for a single node)
* @param rPosition the doc model position (paragraph / character index)
*/
369static SwRect lcl_getLayoutRect(const Point& rPoint, const SwPosition& rPosition)
370{
  const SwContentNode* pNode = rPosition.nNode.GetNode().GetContentNode();
  std::pair<Point, bool> const tmp(rPoint, true);
  const SwContentFrame* pFrame = pNode->getLayoutFrame(
          pNode->GetDoc().getIDocumentLayoutAccess().GetCurrentLayout(),
          &rPosition, &tmp);
  SwRect aRect;
  pFrame->GetCharRect(aRect, rPosition);
  return aRect;
379}

381void SwShellCursor::FillStartEnd(SwRect& rStart, SwRect& rEnd) const
382{
  const SwShellCursor* pCursor = GetShell()->getShellCursor(false);
  rStart = lcl_getLayoutRect(pCursor->GetSttPos(), *pCursor->Start());
  rEnd = lcl_getLayoutRect(pCursor->GetEndPos(), *pCursor->End());
386}

388void SwSelPaintRects::Show(std::vector<OString>* pSelectionRectangles)
389{
  SdrView *const pView = const_cast<SdrView*>(m_pCursorShell->GetDrawView());

  if(!(pView && pView->PaintWindowCount()))
      return;

  // reset rects
  SwRects::clear();
  FillRects();

399#if HAVE_FEATURE_DESKTOP1
  // get new rects
  std::vector< basegfx::B2DRange > aNewRanges;
  aNewRanges.reserve(size());
  for(size_type a = 0; a < size(); ++a)
  {
      const SwRect aNextRect((*this)[a]);
      const tools::Rectangle aPntRect(aNextRect.SVRect());

      aNewRanges.emplace_back(
          aPntRect.Left(), aPntRect.Top(),
          aPntRect.Right() + 1, aPntRect.Bottom() + 1);
  }

  if (m_pCursorOverlay)
  {
      if(!aNewRanges.empty())
      {
          static_cast<sdr::overlay::OverlaySelection*>(m_pCursorOverlay.get())->setRanges(aNewRanges);
      }
      else
      {
          m_pCursorOverlay.reset();
      }
  }
  else if(!empty())
  {
      SdrPaintWindow* pCandidate = pView->GetPaintWindow(0);
      const rtl::Reference< sdr::overlay::OverlayManager >& xTargetOverlay = pCandidate->GetOverlayManager();

      if (xTargetOverlay.is())
      {
          // get the system's highlight color
          const SvtOptionsDrawinglayer aSvtOptionsDrawinglayer;
          const Color aHighlight(aSvtOptionsDrawinglayer.getHilightColor());

          // create correct selection
          m_pCursorOverlay.reset( new sdr::overlay::OverlaySelection(
              sdr::overlay::OverlayType::Transparent,
              aHighlight,
              aNewRanges,
              true) );

          xTargetOverlay->add(*m_pCursorOverlay);
      }
  }

  HighlightInputField();
447#endif

  // Tiled editing does not expose the draw and writer cursor, it just
  // talks about "the" cursor at the moment. As long as that's true,
  // don't say anything about the Writer cursor till a draw object is
  // being edited.
  if (!comphelper::LibreOfficeKit::isActive() || pView->GetTextEditObject())
      return;

  // If pSelectionRectangles is set, we're just collecting the text selections -> don't emit start/end.
  if (!empty() && !pSelectionRectangles)
  {
      // The selection may be a complex polygon, emit the logical
      // start/end cursor rectangle of the selection as separate
      // events, if there is a real selection.
      // This can be used to easily show selection handles on the
      // client side.
      SwRect aStartRect;
      SwRect aEndRect;
      FillStartEnd(aStartRect, aEndRect);

      if (aStartRect.HasArea())
      {
          OString sRect = aStartRect.SVRect().toString();
          GetShell()->GetSfxViewShell()->libreOfficeKitViewCallback(LOK_CALLBACK_TEXT_SELECTION_START, sRect.getStr());
      }
      if (aEndRect.HasArea())
      {
          OString sRect = aEndRect.SVRect().toString();
          GetShell()->GetSfxViewShell()->libreOfficeKitViewCallback(LOK_CALLBACK_TEXT_SELECTION_END, sRect.getStr());
      }
  }

  std::vector<OString> aRect;
  aRect.reserve(size());
  for (size_type i = 0; i < size(); ++i)
  {
      const SwRect& rRect = (*this)[i];
      aRect.push_back(rRect.SVRect().toString());
  }
  OString sRect = comphelper::string::join("; ", aRect);
  if (!pSelectionRectangles)
  {
      GetShell()->GetSfxViewShell()->libreOfficeKitViewCallback(LOK_CALLBACK_TEXT_SELECTION, sRect.getStr());
      SfxLokHelper::notifyOtherViews(GetShell()->GetSfxViewShell(), LOK_CALLBACK_TEXT_VIEW_SELECTION, "selection", sRect);
  }
  else
      pSelectionRectangles->push_back(sRect);
495}

497void SwSelPaintRects::HighlightInputField()
498{
  std::vector< basegfx::B2DRange > aInputFieldRanges;

  if (m_bShowTextInputFieldOverlay)
  {
      SwTextInputField* pCurTextInputFieldAtCursor =
          dynamic_cast<SwTextInputField*>(SwCursorShell::GetTextFieldAtPos( GetShell()->GetCursor()->Start(), false ));
      if ( pCurTextInputFieldAtCursor != nullptr )
      {
          SwTextNode* pTextNode = pCurTextInputFieldAtCursor->GetpTextNode();
          std::unique_ptr<SwShellCursor> pCursorForInputTextField(
              new SwShellCursor( *GetShell(), SwPosition( *pTextNode, pCurTextInputFieldAtCursor->GetStart() ) ) );
          pCursorForInputTextField->SetMark();
          pCursorForInputTextField->GetMark()->nNode = *pTextNode;
          pCursorForInputTextField->GetMark()->nContent.Assign( pTextNode, *(pCurTextInputFieldAtCursor->End()) );

          pCursorForInputTextField->FillRects();
          SwRects* pRects = static_cast<SwRects*>(pCursorForInputTextField.get());
          for (const SwRect & rNextRect : *pRects)
          {
              const tools::Rectangle aPntRect(rNextRect.SVRect());

              aInputFieldRanges.emplace_back(
                  aPntRect.Left(), aPntRect.Top(),
                  aPntRect.Right() + 1, aPntRect.Bottom() + 1);
          }
      }
  }

  if ( !aInputFieldRanges.empty() )
  {
      if (m_pTextInputFieldOverlay != nullptr)
      {
          m_pTextInputFieldOverlay->setRanges( aInputFieldRanges );
      }
      else
      {
          SdrView* pView = const_cast<SdrView*>(GetShell()->GetDrawView());
          SdrPaintWindow* pCandidate = pView->GetPaintWindow(0);
          const rtl::Reference<sdr::overlay::OverlayManager>& xTargetOverlay = pCandidate->GetOverlayManager();

          if (xTargetOverlay.is())
          {
              // use system's highlight color with decreased luminance as highlight color
              const SvtOptionsDrawinglayer aSvtOptionsDrawinglayer;
              Color aHighlight(aSvtOptionsDrawinglayer.getHilightColor());
              aHighlight.DecreaseLuminance( 128 );

              m_pTextInputFieldOverlay.reset( new sw::overlay::OverlayRangesOutline(
                      aHighlight, aInputFieldRanges ) );
              xTargetOverlay->add( *m_pTextInputFieldOverlay );
          }
      }
  }
  else
  {
      m_pTextInputFieldOverlay.reset();
  }
556}

558void SwSelPaintRects::Invalidate( const SwRect& rRect )
559{
  size_type nSz = size();
  if( !nSz )
      return;

  SwRegionRects aReg( GetShell()->VisArea() );
  aReg.assign( begin(), end() );
  aReg -= rRect;
  SwRects::erase( begin(), begin() + nSz );
  SwRects::insert( begin(), aReg.begin(), aReg.end() );

  // If the selection is to the right or at the bottom, outside the
  // visible area, it is never aligned on one pixel at the right/bottom.
  // This has to be determined here and if that is the case the
  // rectangle has to be expanded.
  if( !(GetShell()->m_bVisPortChgd && 0 != ( nSz = size())) )
      return;

  SwSelPaintRects::Get1PixelInLogic( *GetShell() );
  iterator it = begin();
  for( ; nSz--; ++it )
  {
      SwRect& rRectIt = *it;
      if( rRectIt.Right() == GetShell()->m_aOldRBPos.X() )
          rRectIt.AddRight( s_nPixPtX );
      if( rRectIt.Bottom() == GetShell()->m_aOldRBPos.Y() )
          rRectIt.AddBottom( s_nPixPtY );
  }
587}

589// check current MapMode of the shell and set possibly the static members.
590// Optional set the parameters pX, pY
591void SwSelPaintRects::Get1PixelInLogic( const SwViewShell& rSh,
                                      long* pX, long* pY )
593{
  const OutputDevice* pOut = rSh.GetWin();
  if ( ! pOut )
      pOut = rSh.GetOut();

  const MapMode& rMM = pOut->GetMapMode();
  if (s_pMapMode->GetMapUnit() != rMM.GetMapUnit() ||
      s_pMapMode->GetScaleX() != rMM.GetScaleX() ||
      s_pMapMode->GetScaleY() != rMM.GetScaleY())
  {
      *s_pMapMode = rMM;
      Size aTmp( 1, 1 );
      aTmp = pOut->PixelToLogic( aTmp );
      s_nPixPtX = aTmp.Width();
      s_nPixPtY = aTmp.Height();
  }
  if( pX )
      *pX = s_nPixPtX;
  if( pY )
      *pY = s_nPixPtY;
613}

615SwShellCursor::SwShellCursor(
  const SwCursorShell& rCShell,
  const SwPosition &rPos )
  : SwCursor(rPos,nullptr)
  , SwSelPaintRects(rCShell)
  , m_pInitialPoint(SwPaM::GetPoint())
621{}

623SwShellCursor::SwShellCursor(
  const SwCursorShell& rCShell,
  const SwPosition &rPos,
  const Point& rPtPos,
  SwPaM* pRing )
  : SwCursor(rPos, pRing)
  , SwSelPaintRects(rCShell)
  , m_MarkPt(rPtPos)
  , m_PointPt(rPtPos)
  , m_pInitialPoint(SwPaM::GetPoint())
633{}

635SwShellCursor::SwShellCursor( SwShellCursor& rICursor )
  : SwCursor(rICursor, &rICursor)
  , SwSelPaintRects(*rICursor.GetShell())
  , m_MarkPt(rICursor.GetMkPos())
  , m_PointPt(rICursor.GetPtPos())
  , m_pInitialPoint(SwPaM::GetPoint())
641{}

643SwShellCursor::~SwShellCursor()
644{}

646bool SwShellCursor::IsReadOnlyAvailable() const
647{
  return GetShell()->IsReadOnlyAvailable();
649}

651void SwShellCursor::SetMark()
652{
  if (SwPaM::GetPoint() == m_pInitialPoint)
      m_MarkPt = m_PointPt;
  else
      m_PointPt = m_MarkPt;
  SwPaM::SetMark();
658}

660void SwShellCursor::FillRects()
661{
  // calculate the new rectangles
  if( HasMark() &&
      GetPoint()->nNode.GetNode().IsContentNode() &&
      GetPoint()->nNode.GetNode().GetContentNode()->getLayoutFrame( GetShell()->GetLayout() ) &&
      (GetMark()->nNode == GetPoint()->nNode ||
      (GetMark()->nNode.GetNode().IsContentNode() &&
       GetMark()->nNode.GetNode().GetContentNode()->getLayoutFrame( GetShell()->GetLayout() ) )   ))
      GetShell()->GetLayout()->CalcFrameRects( *this );
670}

672void SwShellCursor::Show(SfxViewShell const * pViewShell)
673{
  std::vector<OString> aSelectionRectangles;
  for(SwPaM& rPaM : GetRingContainer())
  {
      SwShellCursor* pShCursor = dynamic_cast<SwShellCursor*>(&rPaM);
      if(pShCursor)
          pShCursor->SwSelPaintRects::Show(&aSelectionRectangles);
  }

  if (!comphelper::LibreOfficeKit::isActive())
      return;

  std::vector<OString> aRect;
  for (const OString & rSelectionRectangle : aSelectionRectangles)
  {
      if (rSelectionRectangle.isEmpty())
          continue;
      aRect.push_back(rSelectionRectangle);
  }
  OString sRect = comphelper::string::join("; ", aRect);
  if (pViewShell)
  {
      // Just notify pViewShell about our existing selection.
      if (pViewShell != GetShell()->GetSfxViewShell())
          SfxLokHelper::notifyOtherView(GetShell()->GetSfxViewShell(), pViewShell, LOK_CALLBACK_TEXT_VIEW_SELECTION, "selection", sRect);
  }
  else
  {
      GetShell()->GetSfxViewShell()->libreOfficeKitViewCallback(LOK_CALLBACK_TEXT_SELECTION, sRect.getStr());
      SfxLokHelper::notifyOtherViews(GetShell()->GetSfxViewShell(), LOK_CALLBACK_TEXT_VIEW_SELECTION, "selection", sRect);
  }
704}

706// This rectangle gets painted anew, therefore the SSelection in this
707// area is invalid.
708void SwShellCursor::Invalidate( const SwRect& rRect )
709{
  for(SwPaM& rPaM : GetRingContainer())
  {
      SwShellCursor* pShCursor = dynamic_cast<SwShellCursor*>(&rPaM);
      // skip any non SwShellCursor objects in the ring
      // see also: SwAutoFormat::DeleteSel()
      if(pShCursor)
          pShCursor->SwSelPaintRects::Invalidate(rRect);
  }
718}

720void SwShellCursor::Hide()
721{
  for(SwPaM& rPaM : GetRingContainer())
  {
      SwShellCursor* pShCursor = dynamic_cast<SwShellCursor*>(&rPaM);
      if(pShCursor)
          pShCursor->SwSelPaintRects::Hide();
  }
728}

730SwCursor* SwShellCursor::Create( SwPaM* pRing ) const
731{
  return new SwShellCursor( *GetShell(), *GetPoint(), GetPtPos(), pRing );
733}

735short SwShellCursor::MaxReplaceArived()
736{
  short nRet = RET_YES;
  SvxSearchDialog* pDlg = SwView::GetSearchDialog();
  if( pDlg )
  {
      // Terminate old actions. The table-frames get constructed and
      // a SSelection can be created.
      std::vector<sal_uInt16> vActionCounts;
      for(SwViewShell& rShell : const_cast< SwCursorShell* >( GetShell() )->GetRingContainer())
      {
          sal_uInt16 nActCnt = 0;
          while(rShell.ActionPend())
          {
              rShell.EndAction();
              ++nActCnt;
          }
          vActionCounts.push_back(nActCnt);
      }
      std::unique_ptr<weld::Builder> xBuilder(Application::CreateBuilder(pDlg->getDialog(), "modules/swriter/ui/asksearchdialog.ui"));
      std::unique_ptr<weld::MessageDialog> xDialog(xBuilder->weld_message_dialog("AskSearchDialog"));
      nRet = xDialog->run();
      auto pActionCount = vActionCounts.begin();
      for(SwViewShell& rShell : const_cast< SwCursorShell* >( GetShell() )->GetRingContainer())
      {
          while(*pActionCount)
          {
              rShell.StartAction();
              --(*pActionCount);
          }
          ++pActionCount;
      }
  }
  else
      // otherwise from the Basic, and then switch to RET_YES
      nRet = RET_YES;

  return nRet;
773}

775void SwShellCursor::SaveTableBoxContent( const SwPosition* pPos )
776{
  const_cast<SwCursorShell*>(GetShell())->SaveTableBoxContent( pPos );
778}

780bool SwShellCursor::UpDown( bool bUp, sal_uInt16 nCnt )
781{
  return SwCursor::UpDown( bUp, nCnt,
                          &GetPtPos(), GetShell()->GetUpDownX(),
                          *GetShell()->GetLayout());
785}

787// if <true> than the cursor can be set to the position.
788bool SwShellCursor::IsAtValidPos( bool bPoint ) const
789{
  if( GetShell() && ( GetShell()->IsAllProtect() ||
      GetShell()->GetViewOptions()->IsReadonly() ||
      ( GetShell()->Imp()->GetDrawView() &&
        GetShell()->Imp()->GetDrawView()->GetMarkedObjectList().GetMarkCount() )))
      return true;

  return SwCursor::IsAtValidPos( bPoint );
797}

799SwShellTableCursor::SwShellTableCursor( const SwCursorShell& rCursorSh,
                                  const SwPosition& rPos )
  : SwCursor(rPos,nullptr), SwShellCursor(rCursorSh, rPos), SwTableCursor(rPos)
802{
803}

805SwShellTableCursor::SwShellTableCursor( const SwCursorShell& rCursorSh,
                  const SwPosition& rMkPos, const Point& rMkPt,
                  const SwPosition& rPtPos, const Point& rPtPt )
  : SwCursor(rPtPos,nullptr), SwShellCursor(rCursorSh, rPtPos), SwTableCursor(rPtPos)
809{
  SetMark();
  *GetMark() = rMkPos;
  GetMkPos() = rMkPt;
  GetPtPos() = rPtPt;
814}

816SwShellTableCursor::~SwShellTableCursor() {}

818void SwShellTableCursor::SetMark()                { SwShellCursor::SetMark(); }

820SwCursor* SwShellTableCursor::Create( SwPaM* pRing ) const
821{
  return SwShellCursor::Create( pRing );
823}

825short SwShellTableCursor::MaxReplaceArived()
826{
  return SwShellCursor::MaxReplaceArived();
828}

830void SwShellTableCursor::SaveTableBoxContent( const SwPosition* pPos )
831{
  SwShellCursor::SaveTableBoxContent( pPos );
833}

835void SwShellTableCursor::FillRects()
836{
  // Calculate the new rectangles. If the cursor is still "parked" do nothing
  if (m_SelectedBoxes.empty() || m_bParked || !GetPoint()->nNode.GetIndex())
      return;

  bool bStart = true;
  SwRegionRects aReg( GetShell()->VisArea() );
  if (comphelper::LibreOfficeKit::isActive())
      aReg = GetShell()->getIDocumentLayoutAccess().GetCurrentLayout()->getFrameArea();
  SwNodes& rNds = GetDoc().GetNodes();
  SwFrame* pEndFrame = nullptr;
  for (size_t n = 0; n < m_SelectedBoxes.size(); ++n)
  {
      const SwStartNode* pSttNd = m_SelectedBoxes[n]->GetSttNd();
      const SwTableNode* pSelTableNd = pSttNd->FindTableNode();

      SwNodeIndex aIdx( *pSttNd );
      SwContentNode* pCNd = rNds.GoNextSection( &aIdx, true, false );

      // table in table
      // (see also lcl_FindTopLevelTable in unoobj2.cxx for a different
      // version to do this)
      const SwTableNode* pCurTableNd = pCNd ? pCNd->FindTableNode() : nullptr;
      while ( pSelTableNd != pCurTableNd && pCurTableNd )
      {
          aIdx = pCurTableNd->EndOfSectionIndex();
          pCNd = rNds.GoNextSection( &aIdx, true, false );
          pCurTableNd = pCNd->FindTableNode();
      }

      if( !pCNd )
          continue;

      std::pair<Point, bool> const tmp(GetSttPos(), false);
      SwFrame* pFrame = pCNd->getLayoutFrame(GetShell()->GetLayout(), nullptr, &tmp);
      while( pFrame && !pFrame->IsCellFrame() )
          pFrame = pFrame->GetUpper();

      OSL_ENSURE( pFrame, "Node not in a table" )do { if (true && (!(pFrame))) { sal_detail_logFormat(
(SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/crsr/viscrs.cxx"
 ":" "874" ": "), "%s", "Node not in a table"); } } while (false
);

      while ( pFrame )
      {
          if( aReg.GetOrigin().IsOver( pFrame->getFrameArea() ) )
          {
              aReg -= pFrame->getFrameArea();
              if (bStart)
              {
                  bStart = false;
                  m_aStart = SwRect(pFrame->getFrameArea().Left(), pFrame->getFrameArea().Top(), 1, pFrame->getFrameArea().Height());
              }
          }

          pEndFrame = pFrame;
          pFrame = pFrame->GetNextCellLeaf();
      }
  }
  if (pEndFrame)
      m_aEnd = SwRect(pEndFrame->getFrameArea().Right(), pEndFrame->getFrameArea().Top(), 1, pEndFrame->getFrameArea().Height());
  aReg.Invert();
  insert( begin(), aReg.begin(), aReg.end() );
896}

898void SwShellTableCursor::FillStartEnd(SwRect& rStart, SwRect& rEnd) const
899{
  rStart = m_aStart;
  rEnd = m_aEnd;
902}

904// Check if the SPoint is within the Table-SSelection.
905bool SwShellTableCursor::IsInside( const Point& rPt ) const
906{
  // Calculate the new rectangles. If the cursor is still "parked" do nothing
  if (m_SelectedBoxes.empty() || m_bParked || !GetPoint()->nNode.GetIndex())
      return false;

  SwNodes& rNds = GetDoc().GetNodes();
  for (size_t n = 0; n < m_SelectedBoxes.size(); ++n)
  {
      SwNodeIndex aIdx( *m_SelectedBoxes[n]->GetSttNd() );
      SwContentNode* pCNd = rNds.GoNextSection( &aIdx, true, false );
      if( !pCNd )
          continue;

      std::pair<Point, bool> const tmp(GetPtPos(), true);
      SwFrame* pFrame = pCNd->getLayoutFrame(GetShell()->GetLayout(), nullptr, &tmp);
      while( pFrame && !pFrame->IsCellFrame() )
          pFrame = pFrame->GetUpper();
      OSL_ENSURE( pFrame, "Node not in a table" )do { if (true && (!(pFrame))) { sal_detail_logFormat(
(SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/crsr/viscrs.cxx"
 ":" "923" ": "), "%s", "Node not in a table"); } } while (false
);
      if( pFrame && pFrame->getFrameArea().IsInside( rPt ) )
          return true;

      for ( SwCellFrame* pCellFrame = static_cast<SwCellFrame*>(pFrame); pCellFrame; pCellFrame = pCellFrame->GetFollowCell() )
      {
          if( pCellFrame->getFrameArea().IsInside( rPt ) )
              return true;
      }
  }
  return false;
934}

936bool SwShellTableCursor::IsAtValidPos( bool bPoint ) const
937{
  return SwShellCursor::IsAtValidPos( bPoint );
939}

941/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

←

/home/maarten/src/libreoffice/core/sw/inc/crsrsh.hxx

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
*   Licensed to the Apache Software Foundation (ASF) under one or more
*   contributor license agreements. See the NOTICE file distributed
*   with this work for additional information regarding copyright
*   ownership. The ASF licenses this file to you under the Apache
*   License, Version 2.0 (the "License"); you may not use this file
*   except in compliance with the License. You may obtain a copy of
*   the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
19#ifndef INCLUDED_SW_INC_CRSRSH_HXX
20#define INCLUDED_SW_INC_CRSRSH_HXX

22#include <com/sun/star/i18n/WordType.hpp>

24#include <rtl/ustring.hxx>
25#include <tools/link.hxx>
26#include <vcl/keycod.hxx>
27#include <o3tl/typed_flags_set.hxx>

29#include "IShellCursorSupplier.hxx"
30#include "swdllapi.h"
31#include "docary.hxx"
32#include "viewsh.hxx"
33#include "calbck.hxx"
34#include "cshtyp.hxx"
35#include "crstate.hxx"
36#include "toxe.hxx"
37#include "tblsel.hxx"
38#include "viscrs.hxx"
39#include "node.hxx"
40#include "fldbas.hxx"
41#include "IDocumentMarkAccess.hxx"

43class SfxItemSet;
44class SfxPoolItem;
45class SwContentFrame;
46class SwUnoCursor;
47class SwFormatField;
48class SwTextFormatColl;
49class SwTextINetFormat;
50class SwFormatINetFormat;
51class SwTextAttr;
52class SwTableBox;
53class SwTOXMark;
54class SwRangeRedline;
55class SwBlockCursor;
56class SwPostItField;
57class SwTextField;

59namespace i18nutil {
  struct SearchOptions2;
61}
62namespace com::sun::star::text { class XTextRange; }
63namespace com::sun::star::container { class XStringKeyMap; }

65// enum and struct to get information via the Doc-Position

67enum class IsAttrAtPos
68{
  NONE             = 0x0000,
  Field            = 0x0001,
  ClickField       = 0x0002,
  Ftn              = 0x0004,
  InetAttr         = 0x0008,
  TableBoxFml      = 0x0010,
  Redline          = 0x0020,
  Outline          = 0x0040,
  ToxMark          = 0x0080,
  RefMark          = 0x0100,
  NumLabel         = 0x0200,
  ContentCheck     = 0x0400,
  SmartTag         = 0x0800,
  FormControl      = 0x1000
83#ifdef DBG_UTIL
  ,CurrAttrs       = 0x2000        ///< only for debugging
  ,TableBoxValue   = 0x4000        ///< only for debugging
86#endif
87};
88namespace o3tl {
  template<> struct typed_flags<IsAttrAtPos> : is_typed_flags<IsAttrAtPos, 0x7fff> {};
90}

92struct SwContentAtPos
93{
  union {
      const SwField* pField;
      const SfxPoolItem* pAttr;
      const SwRangeRedline* pRedl;
      SwContentNode * pNode;
      const sw::mark::IFieldmark* pFieldmark;
  } aFnd;
  IsAttrAtPos eContentAtPos;
  int nDist;
  OUString sStr;
  const SwTextAttr* pFndTextAttr;

  SwContentAtPos( IsAttrAtPos eGetAtPos )
      : eContentAtPos( eGetAtPos )
  {
      aFnd.pField = nullptr;
      pFndTextAttr = nullptr;
      nDist = 0; // #i23726#
  }

  bool IsInProtectSect() const;
  bool IsInRTLText() const;
116};

118// return values of SetCursor (can be combined via ||)
119const int CRSR_POSOLD = 0x01,   // cursor stays at old position
        CRSR_POSCHG = 0x02;   // position changed by the layout

122namespace sw {

124bool ReplaceImpl(SwPaM & rCursor, OUString const& rReplacement,
      bool const bRegExp, SwDoc & rDoc, SwRootFrame const*const pLayout);

127/// Helperfunction to resolve backward references in regular expressions
128std::optional<OUString> ReplaceBackReferences(const i18nutil::SearchOptions2& rSearchOpt,
      SwPaM* pPam, SwRootFrame const* pLayout );

131bool GetRanges(std::vector<std::shared_ptr<SwUnoCursor>> & rRanges,
      SwDoc & rDoc, SwPaM const& rDelPam);

134} // namespace sw

136class SW_DLLPUBLIC__attribute__ ((visibility("default"))) SwCursorShell
  : public SwViewShell
  , public SwModify
  , public ::sw::IShellCursorSupplier
140{
  friend class SwCallLink;
  friend class SwVisibleCursor;
  friend class SwSelPaintRects;

  // requires the Cursor as InternalCursor
  friend bool GetAutoSumSel( const SwCursorShell&, SwCellFrames& );

148public:

  /** for calling UpdateCursor */
  enum CursorFlag {
      UPDOWN      = (1 << 0),     ///< keep Up/Down on columns
      SCROLLWIN   = (1 << 1),     ///< scroll window
      CHKRANGE    = (1 << 2),     ///< check overlapping PaMs
      READONLY    = (1 << 3)      ///< make visible in spite of Readonly
  };

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void UpdateCursor(
      sal_uInt16 eFlags = SwCursorShell::SCROLLWIN|SwCursorShell::CHKRANGE,
      bool bIdleEnd = false );

162private:

  SwRect  m_aCharRect;          ///< Char-SRectangle on which the cursor is located
  Point   m_aCursorHeight;        ///< height & offset from visible Cursor
  Point   m_aOldRBPos;          ///< Right/Bottom of last VisArea
                              // (used in Invalidate by Cursor)

  Link<const SwFlyFrameFormat*,void> m_aFlyMacroLnk;        /**< Link will be called, if the Cursor is set
                                 into a fly. A macro can then be called */
  Link<LinkParamNone*,void> m_aChgLnk;             /**< link will be called by every attribute/
                                 format changes at cursor position.*/
  Link<SwCursorShell&,void> m_aGrfArrivedLnk;      ///< Link calls to UI if a graphic is arrived

  SwShellCursor* m_pCurrentCursor;      ///< current cursor
  SwShellCursor* m_pStackCursor;      ///< stack for the cursor
  SwVisibleCursor *m_pVisibleCursor;        ///< the visible cursor

  SwBlockCursor *m_pBlockCursor;   ///< interface of cursor for block (=rectangular) selection

  SwShellTableCursor* m_pTableCursor; /**< table Cursor; only in tables when the
                                 selection lays over 2 columns */

  SwNodeIndex* m_pBoxIdx;       ///< for recognizing of the changed
  SwTableBox* m_pBoxPtr;        ///< table row

  long m_nUpDownX;              /**< try to move the cursor on up/down always
                                 in the same column */
  long m_nLeftFramePos;
  sal_uLong m_nCurrentNode;     // save CursorPos at Start-Action
  sal_Int32 m_nCurrentContent;
  SwNodeType m_nCurrentNdTyp;

  /*
   * Via the Method SttCursorMove and EndCursorMove this counter gets
   * incremented/decremented. As long as the counter is inequal to 0, the
   * current Cursor gets no update. This way, "complicated" cursor movements
   * (via Find()) can be realised.
   */
  sal_uInt16 m_nCursorMove;
  CursorMoveState m_eMvState;     ///< Status for Cursor-Travelling - GetModelPositionForViewPoint
  SwTable::SearchType m_eEnhancedTableSel; /// table rows or columns selected by not cell by cell

  OUString m_sMarkedListId;
  int m_nMarkedListLevel;

  bool m_bHasFocus : 1;         ///< Shell is "active" in a window
  bool m_bSVCursorVis : 1;        ///< SV-Cursor visible/invisible
  bool m_bChgCallFlag : 1;      ///< attribute change inside Start- and EndAction
  bool m_bVisPortChgd : 1;      ///< in VisPortChg-Call
                              // (used in Invalidate by the Cursor)

  bool m_bCallChgLnk : 1;       ///< flag for derived classes
                              // true -> call ChgLnk
                              // access only via SwChgLinkFlag
  bool m_bAllProtect : 1;       ///< Flag for areas
                              // true -> everything protected / hidden
  bool m_bInCMvVisportChgd : 1; ///< Flag for CursorMoves
                              // true -> view was moved
  bool m_bGCAttr : 1;           // true -> non expanded attributes exist.
  bool m_bIgnoreReadonly : 1;   // true -> make the cursor visible on next
                              // EndAction in spite of Readonly
  bool m_bSelTableCells : 1;      // true -> select cells over the InputWin
  bool m_bAutoUpdateCells : 1;  // true -> autoformat cells
  bool m_bBasicHideCursor : 1;    // true -> HideCursor from Basic
  bool m_bSetCursorInReadOnly : 1;// true -> Cursor is allowed in ReadOnly-Areas
  bool m_bOverwriteCursor : 1;    // true -> show Overwrite Cursor

  bool m_bMacroExecAllowed : 1;

  SwFrame* m_oldColFrame;

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void MoveCursorToNum();

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void ParkPams( SwPaM* pDelRg, SwShellCursor** ppDelRing );

  /** Mark a certain list level of a certain list

      levels of a certain lists are marked now

      @param sListId    list Id of the list whose level is marked
      @param nLevel     to be marked list level

      An empty sListId denotes that no level of a list is marked.
   */
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void MarkListLevel( const OUString& sListId,
                                    const int nLevel );

  // private method(s) accessed from public inline method(s) must be exported.
                 bool LeftRight( bool, sal_uInt16, sal_uInt16, bool );
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool UpDown( bool, sal_uInt16 );
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool LRMargin( bool, bool bAPI = false );
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool IsAtLRMargin( bool, bool bAPI = false ) const;

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool isInHiddenTextFrame(SwShellCursor* pShellCursor);

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool GoStartWordImpl();
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool GoEndWordImpl();
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool GoNextWordImpl();
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool GoPrevWordImpl();
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool GoNextSentenceImpl();
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool GoEndSentenceImpl();
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool GoStartSentenceImpl();

  typedef bool (SwCursor::*FNCursor)();
  typedef bool (SwCursorShell::*FNCursorShell)();
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool CallCursorFN( FNCursor );
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool CallCursorShellFN( FNCursorShell );

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) const SwRangeRedline* GotoRedline_( SwRedlineTable::size_type nArrPos, bool bSelect );

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void sendLOKCursorUpdates();
273protected:

  inline SwMoveFnCollection const & MakeFindRange( SwDocPositions, SwDocPositions, SwPaM* ) const;

  /*
   * Compare-Method for the StackCursor and the current Cursor.
   * The Methods return -1, 0, 1 for lower, equal, greater.
   */
  int CompareCursorStackMkCurrPt() const;

  bool SelTableRowOrCol( bool bRow, bool bRowSimple = false );

  bool SetInFrontOfLabel( bool bNew );

  void RefreshBlockCursor();

  /** Updates the marked list level according to the cursor.
  */
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void UpdateMarkedListLevel();

293protected:
  virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew) override;

296public:
  SwCursorShell( SwDoc& rDoc, vcl::Window *pWin, const SwViewOption *pOpt );
  // disguised copy constructor
  SwCursorShell( SwCursorShell& rShell, vcl::Window *pWin );
  virtual ~SwCursorShell() override;

  // create new cursor and append the old one
  virtual SwPaM & CreateNewShellCursor() override;
  virtual SwPaM & GetCurrentShellCursor() override;

  SwPaM * CreateCursor();
  ///< delete the current cursor and make the following into the current
  void DestroyCursor();
  ///< transform TableCursor to normal cursor, nullify Tablemode
  void TableCursorToCursor();
  ///< enter block mode, change normal cursor into block cursor
  void CursorToBlockCursor();
  ///< leave block mode, change block cursor into normal cursor
  void BlockCursorToCursor();

  // SelAll() selects the document body content
  // if ExtendedSelect() is called afterwards, the whole nodes array is selected
  // only for usage in special cases allowed!
  void ExtendedSelectAll(bool bFootnotes = true);
  /// If ExtendedSelectAll() was called and selection didn't change since then.
  bool ExtendedSelectedAll();
  /// If document body starts with a table.
  bool StartsWithTable();

  SwPaM* GetCursor( bool bMakeTableCursor = true ) const;
  inline SwCursor* GetSwCursor() const;
  // return only the current cursor
        SwShellCursor* GetCursor_()                       { return m_pCurrentCursor; }
  const SwShellCursor* GetCursor_() const                 { return m_pCurrentCursor; }

  // show passed cursor - for UNO
  void    SetSelection(const SwPaM& rCursor);

  // remove all cursors from ContentNodes and set to 0
  void ParkCursor( const SwNodeIndex &rIdx );

  // return the current cursor stack
  // (required in EditShell when deleting contents)
  inline SwPaM* GetStackCursor() const;

  // start parenthesing, hide SV-Cursor and selected areas
  void StartAction();
  // end parenthesing, show SV-Cursor and selected areas
  void EndAction( const bool bIdleEnd = false, const bool DoSetPosX = false );

  // basic cursor travelling
  long GetUpDownX() const             { return m_nUpDownX; }

  bool Left( sal_uInt16 nCnt, sal_uInt16 nMode, bool bAllowVisual = false )
      { return LeftRight( true, nCnt, nMode, bAllowVisual ); }
  bool Right( sal_uInt16 nCnt, sal_uInt16 nMode, bool bAllowVisual = false )
      { return LeftRight( false, nCnt, nMode, bAllowVisual ); }
  bool Up( sal_uInt16 nCnt = 1 )      { return UpDown( true, nCnt ); }
  bool Down( sal_uInt16 nCnt = 1 )    { return UpDown( false, nCnt ); }
  bool LeftMargin()               { return LRMargin( true ); }
  bool RightMargin(bool bAPI = false) { return LRMargin( false, bAPI ); }
  bool SttEndDoc( bool bStt );

  bool MovePage( SwWhichPage, SwPosPage );
  bool MovePara( SwWhichPara, SwMoveFnCollection const & );
  bool MoveSection( SwWhichSection, SwMoveFnCollection const & );
  bool MoveTable( SwWhichTable, SwMoveFnCollection const & );
  void MoveColumn( SwWhichColumn, SwPosColumn );
  bool MoveRegion( SwWhichRegion, SwMoveFnCollection const & );

  // note: DO NOT call it FindText because windows.h
  sal_uLong Find_Text( const i18nutil::SearchOptions2& rSearchOpt,
              bool bSearchInNotes,
              SwDocPositions eStart, SwDocPositions eEnd,
              bool& bCancel,
              FindRanges eRng, bool bReplace = false );

  sal_uLong FindFormat( const SwTextFormatColl& rFormatColl,
              SwDocPositions eStart, SwDocPositions eEnd,
              bool& bCancel,
              FindRanges eRng, const SwTextFormatColl* pReplFormat );

  sal_uLong FindAttrs( const SfxItemSet& rSet, bool bNoCollections,
              SwDocPositions eStart, SwDocPositions eEnd,
              bool& bCancel,
              FindRanges eRng,
              const i18nutil::SearchOptions2* pSearchOpt,
              const SfxItemSet* rReplSet );

  //  Position the Cursor
  //  return values:
  //      CRSR_POSCHG: when cursor was corrected from SPoint by the layout
  //      CRSR_POSOLD: when the cursor was not changed
  int SetCursor( const Point &rPt, bool bOnlyText = false, bool bBlock = true );

  /*
   * Notification that the visible area was changed. m_aVisArea is reset, then
   * scrolling is done. The passed Rectangle lays on pixel borders to avoid
   * pixel errors.
   */
  virtual void VisPortChgd( const SwRect & ) override;

  /*
   * virtual paint method to make selection visible again after Paint
   */
  void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle & rRect) override;

  // Areas
  inline void SetMark();
  inline bool HasMark() const;

  void ClearMark();

  /**
     Ensure point and mark of the current PaM are in a specific order.

     @param bPointFirst true: If the point is behind the mark then
     swap the PaM. false: If the mark is behind the point then swap
     the PaM.
  */
  void NormalizePam(bool bPointFirst = true);

  void SwapPam();
  bool TestCurrPam( const Point & rPt,
                    bool bTstHit = false);   // only exact matches
  void KillPams();

  /// store a copy of the current cursor on the cursor stack
  void Push();
  enum class PopMode { DeleteCurrent, DeleteStack };
  /*
   * Delete a cursor
   *    - either from the top of the stack
   *    - or delete the current one and replace it with the cursor from the
   *      stack
   *  @return <true> if there was one on the stack, <false> otherwise
   */
  bool Pop(PopMode);
  /*
   * Combine 2 Cursors.
   * Delete the topmost from the stack and move its Mark into the current.
   */
  void Combine();

  void SttCursorMove();
  void EndCursorMove( const bool bIdleEnd = false );

  /*
   * When the focus is lost the selected ranges are not displayed anymore.
   * On the other hand, on receiving the focus all selected ranges are displayed again
   * (ranges must be recalculated!).
   */
  bool HasShellFocus() const { return m_bHasFocus; }
  void ShellLoseFocus();
  void ShellGetFocus();

  // Methods for displaying or hiding the visible text cursor.
  void ShowCursor();
  void HideCursor();
  // Methods for displaying or hiding the selected ranges with visible cursor.
  void ShowCursors( bool bCursorVis );
  void HideCursors();

  bool IsOverwriteCursor() const { return m_bOverwriteCursor; }
  void SetOverwriteCursor( bool bFlag ) { m_bOverwriteCursor = bFlag; }

  // Return current frame in which the cursor is placed.
  SwContentFrame *GetCurrFrame( const bool bCalcFrame = true ) const;

  //true if cursor is hidden because of readonly.
  //false if it is working despite readonly.
  bool IsCursorReadonly() const;

  // Cursor is placed in something that is protected or selection contains
  // something that is protected.
  bool HasReadonlySel() const;

  // Can the cursor be set to read only ranges?
  bool IsReadOnlyAvailable() const { return m_bSetCursorInReadOnly; }
  void SetReadOnlyAvailable( bool bFlag );
  bool IsOverReadOnlyPos( const Point& rPt ) const;

  // Methods for aFlyMacroLnk.
  void        SetFlyMacroLnk( const Link<const SwFlyFrameFormat*,void>& rLnk ) { m_aFlyMacroLnk = rLnk; }
  const Link<const SwFlyFrameFormat*,void>& GetFlyMacroLnk() const           { return m_aFlyMacroLnk; }

  // Methods returning/altering link for changes of attributes/formats.
  void        SetChgLnk( const Link<LinkParamNone*,void> &rLnk ) { m_aChgLnk = rLnk; }
  const Link<LinkParamNone*,void>& GetChgLnk() const           { return m_aChgLnk; }

  // Methods returning/altering link for "graphic completely loaded".
  void        SetGrfArrivedLnk( const Link<SwCursorShell&,void> &rLnk ) { m_aGrfArrivedLnk = rLnk; }
  const Link<SwCursorShell&,void>& GetGrfArrivedLnk() const           { return m_aGrfArrivedLnk; }

  //Call ChgLink. When within an action calling will be delayed.
  void CallChgLnk();

  // Check if the current cursor contains a selection, i.e.
  // if Mark is set and SPoint and Mark are different.
  bool HasSelection() const;

  // Check if a selection exists, i.e. if the current cursor comprises a selection.
  inline bool IsSelection() const;
  // returns if multiple cursors are available
  inline bool IsMultiSelection() const;

  // Check if a complete paragraph was selected.
  bool IsSelFullPara() const;

  // Check if selection is within one paragraph.

  //Should WaitPtr be activated for Clipboard.
  bool ShouldWait() const;

  // Check if selection is within one paragraph.
  bool IsSelOnePara() const;

  /*
   * Returns SRectangle, at which the cursor is located.
   */
  const SwRect &GetCharRect() const { return m_aCharRect; }
  /*
   * Returns if cursor is wholly or partly within visible range.
   */
  bool IsCursorVisible() const { return VisArea().IsOver( GetCharRect() ); }
  /*
   * Returns SwRect, at which the character is located.
   */
  void GetCharRectAt(SwRect& rRect, const SwPosition* pPos);

  // Return current page number:
  // true:  in which cursor is located.
  // false: which is visible at the upper margin.
  void GetPageNum( sal_uInt16 &rnPhyNum, sal_uInt16 &rnVirtNum,
                   bool bAtCursorPos = true, const bool bCalcFrame = true );
  // Returns current page's sequential number (1-based),in which cursor is located, ignoring autoinserted empty pages.
  // Returns 0 on error
  sal_uInt16 GetPageNumSeqNonEmpty();
  // Determine how "empty pages" are handled
  // (used in PhyPage).
  sal_uInt16 GetNextPrevPageNum( bool bNext = true );

  // Move cursor at the beginning of page "nPage".
  bool GotoPage( sal_uInt16 nPage );

  sal_uInt16 GetPageCnt();

  bool GoNextCursor();

  bool GoPrevCursor();

  bool GoNextPrevCursorSetSearchLabel(const bool bNext);

  // at CurrentCursor.SPoint
  ::sw::mark::IMark* SetBookmark(
      const vcl::KeyCode&,
      const OUString& rName,
      IDocumentMarkAccess::MarkType eMark = IDocumentMarkAccess::MarkType::BOOKMARK);
  ::sw::mark::IMark* SetBookmark2(
      const vcl::KeyCode&,
      const OUString& rName,
      bool bHide,
      const OUString& rCondition);
  bool GotoMark( const ::sw::mark::IMark* const pMark );    // sets CurrentCursor.SPoint
  bool GotoMark( const ::sw::mark::IMark* const pMark, bool bAtStart );
  bool GoNextBookmark(); // true, if there was one
  bool GoPrevBookmark();

  bool IsFormProtected();
  ::sw::mark::IFieldmark* GetCurrentFieldmark();
  ::sw::mark::IFieldmark* GetFieldmarkAfter();
  ::sw::mark::IFieldmark* GetFieldmarkBefore();
  bool GotoFieldmark( const ::sw::mark::IFieldmark* const pMark );

  // update Cursr, i.e. reset it into content should only be called when the
  // cursor was set to a random position e.g. when deleting frames
  void UpdateCursorPos();

  // get the selected text at the current cursor. It will be filled with
  // fields etc.
  OUString GetSelText() const;

  // Check of SPoint or Mark of current cursor are placed within a table.
  inline const SwTableNode* IsCursorInTable() const;

  bool IsCursorInFootnote() const;

  inline Point& GetCursorDocPos() const;
  inline bool IsCursorPtAtEnd() const;

  inline const  SwPaM* GetTableCrs() const;
  inline        SwPaM* GetTableCrs();

  bool IsTableComplexForChart();
  // get current table selection as text
  OUString GetBoxNms() const;

  // set Cursor to the next/previous cell
  bool GoNextCell( bool bAppendLine = true );
  bool GoPrevCell();
  // go to this box (if available and inside of table)
  bool GotoTable( const OUString& rName );

  // select a table row, column or box (based on the current cursor)
  bool SelTableRow() { return SelTableRowOrCol( true  ); }
  bool SelTableCol() { return SelTableRowOrCol( false ); }
  bool SelTableBox();

  bool SelTable();

  void GotoNextNum();
  void GotoPrevNum();

  bool GotoOutline( const OUString& rName );
  // to the next/previous or the given OutlineNode
  void GotoOutline( SwOutlineNodes::size_type nIdx );
  // find the "outline position" in the nodes array of the current chapter
  SwOutlineNodes::size_type GetOutlinePos(sal_uInt8 nLevel = UCHAR_MAX(127*2 +1), SwPaM* pPaM = nullptr);
  // select the given range of OutlineNodes. Optionally including the children
  // the sal_uInt16s are the positions in OutlineNodes-Array (EditShell)
  bool MakeOutlineSel(SwOutlineNodes::size_type nSttPos, SwOutlineNodes::size_type nEndPos,
                       bool bWithChildren, bool bKillPams = true );

  bool GotoNextOutline();
  bool GotoPrevOutline();

  /** Delivers the current shell cursor

      Some operations have to run on the current cursor ring,
      some on the m_pTableCursor (if exist) or the current cursor ring and
      some on the m_pTableCursor or m_pBlockCursor or the current cursor ring.
      This small function checks the existence and delivers the wished cursor.

      @param bBlock [bool]
      if the block cursor is of interest or not

      @return m_pTableCursor if exist,
      m_pBlockCursor if exist and of interest (param bBlock)
      otherwise m_pCurrentCursor
  */
  SwShellCursor* getShellCursor( bool bBlock );
  const SwShellCursor* getShellCursor( bool bBlock ) const
      { return const_cast<SwCursorShell*>(this)->getShellCursor( bBlock ); }

  bool IsBlockMode() const { return nullptr != m_pBlockCursor; }

  // is the Cursor in a table and is the selection over 2 columns
  bool IsTableMode() const { return nullptr != m_pTableCursor; }
14
←
Assuming the condition is false→
15
←
Returning zero, which participates in a condition later→

  const SwShellTableCursor* GetTableCursor() const { return m_pTableCursor; }
  SwShellTableCursor* GetTableCursor() { return m_pTableCursor; }
  size_t UpdateTableSelBoxes();

  bool GotoFootnoteText();      ///< jump from content to footnote
  bool GotoFootnoteAnchor();   ///< jump from footnote to anchor
  bool GotoPrevFootnoteAnchor();
  bool GotoNextFootnoteAnchor();

  void GotoFlyAnchor();       ///< jump from the frame to the anchor
  bool GotoHeaderText();       ///< jump from the content to the header
  bool GotoFooterText();       ///< jump from the content to the footer
  // jump to the header/footer of the given or current PageDesc
  bool SetCursorInHdFt( size_t nDescNo, bool bInHeader );
  // is point of cursor in header/footer. pbInHeader return true if it is
  // in a headerframe otherwise in a footerframe
  bool IsInHeaderFooter( bool* pbInHeader = nullptr ) const;

  bool GotoNextTOXBase( const OUString* = nullptr );
  bool GotoPrevTOXBase( const OUString* = nullptr );
  void GotoTOXMarkBase();
  // jump to the next or previous index entry
  bool GotoNxtPrvTOXMark( bool bNext = true );
  // jump to the next/previous index mark of this type
  const SwTOXMark& GotoTOXMark( const SwTOXMark& rStart, SwTOXSearch eDir );

  // jump to the next or previous table formula
  // optionally only to broken formulas
  bool GotoNxtPrvTableFormula( bool bNext = true,
                             bool bOnlyErrors = false );
  // jump to the next / previous hyperlink - inside text and also
  // on graphics
  bool SelectNxtPrvHyperlink( bool bNext );

  bool GotoRefMark( const OUString& rRefMark, sal_uInt16 nSubType,
                          sal_uInt16 nSeqNo );

  // get the nth character from the start or end of the  current selection
  sal_Unicode GetChar( bool bEnd = true, long nOffset = 0 );
  bool ExtendSelection( bool bEnd = true, sal_Int32 nCount = 1 );

  // Place only the visible cursor at the given position in the document.
  // Return false if SPoint was corrected by layout.
  // (This is needed for displaying the Drag&Drop/Copy-Cursor.)
  bool SetVisibleCursor( const Point &rPt );
  inline void UnSetVisibleCursor();
  SwVisibleCursor* GetVisibleCursor() const;

  // jump to the next or previous field of the corresponding type
  bool MoveFieldType(
      const SwFieldType* pFieldType,
      const bool bNext,
      const SwFieldIds nResType = SwFieldIds::Unknown,
      const bool bAddSetExpressionFieldsToInputFields = true );

  bool GotoFormatField( const SwFormatField& rField );

  static SwTextField* GetTextFieldAtPos(
      const SwPosition* pPos,
      const bool bIncludeInputFieldAtStart );
  static SwTextField* GetTextFieldAtCursor(
      const SwPaM* pCursor,
      const bool bIncludeInputFieldAtStart );
  static SwField* GetFieldAtCursor(
      const SwPaM* pCursor,
      const bool bIncludeInputFieldAtStart );
  SwField* GetCurField( const bool bIncludeInputFieldAtStart = false ) const;
  bool CursorInsideInputField() const;
  static bool PosInsideInputField( const SwPosition& rPos );
  bool DocPtInsideInputField( const Point& rDocPt ) const;
  static sal_Int32 StartOfInputFieldAtPos( const SwPosition& rPos );
  static sal_Int32 EndOfInputFieldAtPos( const SwPosition& rPos );

  // Return number of cursors in ring (The flag indicates whether
  // only cursors containing selections are requested).
  sal_uInt16 GetCursorCnt( bool bAll = true ) const;

  // Char Travelling - methods (in crstrvl1.cxx)
  bool GoStartWord();
  bool GoEndWord();
  bool GoNextWord();
  bool GoPrevWord();
  bool GoNextSentence();
  bool GoStartSentence();
  bool GoEndSentence();
  bool SelectWord( const Point* pPt );
  void ExpandToSentenceBorders();

  // get position from current cursor
  bool IsStartWord( sal_Int16 nWordType = css::i18n::WordType::ANYWORD_IGNOREWHITESPACES )const;
  bool IsEndWord( sal_Int16 nWordType = css::i18n::WordType::ANYWORD_IGNOREWHITESPACES ) const;
  bool IsInWord( sal_Int16 nWordType = css::i18n::WordType::ANYWORD_IGNOREWHITESPACES ) const;
  bool IsStartSentence() const;
  bool IsEndSentence() const;
  bool IsSttPara() const;
  bool IsEndPara() const;
  bool IsEndOfTable() const; ///< at the very last SwPosition inside a table
  bool IsStartOfDoc() const;
  bool IsEndOfDoc() const;
  bool IsInFrontOfLabel() const;
  bool IsAtLeftMargin()   const       { return IsAtLRMargin( true ); }
  bool IsAtRightMargin() const   { return IsAtLRMargin( false, true/*bAPI*/ ); }

  // delete all created cursors, set the table cursor and the last cursor to
  // its TextNode (or StartNode?)
  // They all get created on the next ::GetCursor again
  // Used for Drag&Drop/Clipboard-Paste in tables
  bool ParkTableCursor();

  // Non expanded attributes?
  bool IsGCAttr() const { return m_bGCAttr; }
  void ClearGCAttr() { m_bGCAttr = false; }
  void    UpdateAttr() {  m_bGCAttr = true; }

  // is the whole document protected/hidden (for UI...)
  bool IsAllProtect() const { return m_bAllProtect; }

  bool GotoRegion( const OUString& rName );

  // show the current selection
  virtual void MakeSelVisible();

  // set the cursor to a NOT protected/hidden node
  bool FindValidContentNode( bool bOnlyText );

  bool GetContentAtPos( const Point& rPt,
                        SwContentAtPos& rContentAtPos,
                        bool bSetCursor = false,
                        SwRect* pFieldRect = nullptr );

  const SwPostItField* GetPostItFieldAtCursor() const;

  // get smart tags rectangle for the given point
  void GetSmartTagRect( const Point& rPt, SwRect& rSelectRect );

  // get smart tags at current cursor position
  void GetSmartTagTerm( std::vector< OUString >& rSmartTagTypes,
                        css::uno::Sequence< css::uno::Reference< css::container::XStringKeyMap > >& rStringKeyMaps,
                        css::uno::Reference<css::text::XTextRange>& rRange ) const;

  bool IsPageAtPos( const Point &rPt ) const;

  bool SelectTextAttr( sal_uInt16 nWhich, bool bExpand, const SwTextAttr* pAttr = nullptr );
  bool GotoINetAttr( const SwTextINetFormat& rAttr );
  const SwFormatINetFormat* FindINetAttr( const OUString& rName ) const;

  bool SelectText( const sal_Int32 nStart,
                      const sal_Int32 nEnd );

  bool CheckTableBoxContent( const SwPosition* pPos = nullptr );
  void SaveTableBoxContent( const SwPosition* pPos = nullptr );
  void ClearTableBoxContent();
  bool EndAllTableBoxEdit();

  void SetSelTableCells( bool bFlag )           { m_bSelTableCells = bFlag; }
  bool IsSelTableCells() const                  { return m_bSelTableCells; }

  void UnsetEnhancedTableSelection()            { m_eEnhancedTableSel = SwTable::SEARCH_NONE; }
  SwTable::SearchType GetEnhancedTableSelection() const  { return m_eEnhancedTableSel; }

  bool IsAutoUpdateCells() const              { return m_bAutoUpdateCells; }
  void SetAutoUpdateCells( bool bFlag )       { m_bAutoUpdateCells = bFlag; }

  bool GetShadowCursorPos( const Point& rPt, SwFillMode eFillMode,
                          SwRect& rRect, sal_Int16& rOrient );
  bool SetShadowCursorPos( const Point& rPt, SwFillMode eFillMode );

  const SwRangeRedline* SelNextRedline();
  const SwRangeRedline* SelPrevRedline();
  const SwRangeRedline* GotoRedline( SwRedlineTable::size_type nArrPos, bool bSelect );

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) SvxFrameDirection GetTextDirection( const Point* pPt = nullptr ) const;
  // is cursor or the point in/over a vertical formatted text?
  bool IsInVerticalText( const Point* pPt = nullptr ) const;
  // is cursor or the point in/over a right to left formatted text?
  bool IsInRightToLeftText() const;

  static void FirePageChangeEvent(sal_uInt16 nOldPage, sal_uInt16 nNewPage);
  bool   bColumnChange();
  static void FireSectionChangeEvent(sal_uInt16 nOldSection, sal_uInt16 nNewSection);
  static void FireColumnChangeEvent(sal_uInt16 nOldColumn, sal_uInt16 nNewColumn);
  // If the current cursor position is inside a hidden range, the hidden range
  // is selected and true is returned:
  bool SelectHiddenRange();

  // remove all invalid cursors
  void ClearUpCursors();

  void SetMacroExecAllowed( const bool _bMacroExecAllowed )
  {
      m_bMacroExecAllowed = _bMacroExecAllowed;
  }
  bool IsMacroExecAllowed() const
  {
      return m_bMacroExecAllowed;
  }

  /**
     Returns textual description of the current selection.

     - If the current selection is a multi-selection the result is
       STR_MULTISEL.
     - Else the result is the text of the selection.

     @return the textual description of the current selection
   */
  OUString GetCursorDescr() const;

  virtual void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  /// Implementation of lok::Document::getPartPageRectangles() for Writer.
  OUString getPageRectangles();

  /// See SwView::NotifyCursor().
  void NotifyCursor(SfxViewShell* pViewShell) const;
859};

861// Cursor Inlines:
862inline SwMoveFnCollection const & SwCursorShell::MakeFindRange(
          SwDocPositions nStt, SwDocPositions nEnd, SwPaM* pPam ) const
864{
  return m_pCurrentCursor->MakeFindRange( nStt, nEnd, pPam );
866}

868inline SwCursor* SwCursorShell::GetSwCursor() const
869{
  return static_cast<SwCursor*>(GetCursor());
871}

873inline SwPaM* SwCursorShell::GetStackCursor() const { return m_pStackCursor; }

875inline void SwCursorShell::SetMark() { m_pCurrentCursor->SetMark(); }

877inline bool SwCursorShell::HasMark() const { return m_pCurrentCursor->HasMark(); }

879inline bool SwCursorShell::IsSelection() const
880{
  return IsTableMode() || m_pCurrentCursor->HasMark() ||
13
←
Calling 'SwCursorShell::IsTableMode'→
16
←
Returning from 'SwCursorShell::IsTableMode'→
17
←
Called C++ object pointer is null
          m_pCurrentCursor->GetNext() != m_pCurrentCursor;
883}
884inline bool SwCursorShell::IsMultiSelection() const
885{
  return m_pCurrentCursor->GetNext() != m_pCurrentCursor;
887}

889inline const SwTableNode* SwCursorShell::IsCursorInTable() const
890{
  return m_pCurrentCursor->GetNode().FindTableNode();
892}

894inline bool SwCursorShell::IsCursorPtAtEnd() const
895{
  return m_pCurrentCursor->End() == m_pCurrentCursor->GetPoint();
897}

899inline Point& SwCursorShell::GetCursorDocPos() const
900{
  return m_pCurrentCursor->GetPtPos();
902}

904inline const SwPaM* SwCursorShell::GetTableCrs() const
905{
  return m_pTableCursor;
907}

909inline SwPaM* SwCursorShell::GetTableCrs()
910{
  return m_pTableCursor;
912}

914inline void SwCursorShell::UnSetVisibleCursor()
915{
  m_pVisibleCursor->Hide();
  m_pVisibleCursor->SetDragCursor( false );
918}

920#endif  // _CRSRSH_HXX

922/* vim:set shiftwidth=4 softtabstop=4 expandtab: */