/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx

Bug Summary

File:	home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx
Warning:	line 1113, column 13 1st function call argument is an uninitialized value

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 ChartController.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 -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 EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -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/chart2/source/controller/inc -I /home/maarten/src/libreoffice/core/chart2/source/inc -I /home/maarten/src/libreoffice/core/chart2/inc -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/CustomTarget/officecfg/registry -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/chart2/source/controller/main/ChartController.cxx

/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.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 <memory>
21#include <sal/config.h>

23#include <set>

25#include <ChartController.hxx>
26#include <servicenames.hxx>
27#include <ResId.hxx>
28#include <dlg_DataSource.hxx>
29#include <ChartModel.hxx>
30#include <ChartModelHelper.hxx>
31#include "ControllerCommandDispatch.hxx"
32#include <strings.hrc>
33#include <chartview/ExplicitValueProvider.hxx>
34#include <ChartViewHelper.hxx>

36#include <ChartWindow.hxx>
37#include <chartview/DrawModelWrapper.hxx>
38#include <DrawViewWrapper.hxx>
39#include <ObjectIdentifier.hxx>
40#include <DiagramHelper.hxx>
41#include <ControllerLockGuard.hxx>
42#include "UndoGuard.hxx"
43#include "ChartDropTargetHelper.hxx"

45#include <dlg_ChartType.hxx>
46#include <AccessibleChartView.hxx>
47#include "DrawCommandDispatch.hxx"
48#include "ShapeController.hxx"
49#include "UndoActions.hxx"
50#include <ViewElementListProvider.hxx>

52#include <cppuhelper/supportsservice.hxx>

54#include <com/sun/star/chart2/XChartDocument.hpp>
55#include <com/sun/star/chart2/data/XDataReceiver.hpp>
56#include <com/sun/star/frame/XController2.hpp>
57#include <com/sun/star/util/CloseVetoException.hpp>
58#include <com/sun/star/util/XModeChangeBroadcaster.hpp>
59#include <com/sun/star/util/XModifyBroadcaster.hpp>
60#include <com/sun/star/frame/LayoutManagerEvents.hpp>
61#include <com/sun/star/frame/XLayoutManagerEventBroadcaster.hpp>
62#include <com/sun/star/document/XUndoManagerSupplier.hpp>
63#include <com/sun/star/ui/XSidebar.hpp>
64#include <com/sun/star/chart2/XChartTypeContainer.hpp>
65#include <com/sun/star/chart2/XCoordinateSystemContainer.hpp>
66#include <com/sun/star/chart2/XDataProviderAccess.hpp>

68#include <sal/log.hxx>
69#include <tools/debug.hxx>
70#include <svx/sidebar/SelectionChangeHandler.hxx>
71#include <toolkit/awt/vclxwindow.hxx>
72#include <toolkit/helper/vclunohelper.hxx>
73#include <vcl/svapp.hxx>
74#include <vcl/weld.hxx>
75#include <osl/mutex.hxx>

77#include <sfx2/sidebar/SidebarController.hxx>

79#include <com/sun/star/frame/XLayoutManager.hpp>

81// this is needed to properly destroy the unique_ptr to the AcceleratorExecute
82// object in the DTOR
83#include <svtools/acceleratorexecute.hxx>
84#include <svx/ActionDescriptionProvider.hxx>
85#include <tools/diagnose_ex.h>

87// enable the following define to let the controller listen to model changes and
88// react on this by rebuilding the view
89#define TEST_ENABLE_MODIFY_LISTENER

91namespace chart
92{

94using namespace ::com::sun::star;
95using namespace ::com::sun::star::accessibility;
96using namespace ::com::sun::star::chart2;
97using ::com::sun::star::uno::Reference;
98using ::com::sun::star::uno::Sequence;

100ChartController::ChartController(uno::Reference<uno::XComponentContext> const & xContext) :
  m_aLifeTimeManager( nullptr ),
  m_bSuspended( false ),
  m_xCC(xContext), //@todo is it allowed to hold this context??
  m_aModelMutex(),
  m_aModel( nullptr, m_aModelMutex ),
  m_xViewWindow(),
  m_xChartView(),
  m_pDrawModelWrapper(),
  m_eDragMode(SdrDragMode::Move),
  m_bWaitingForDoubleClick(false),
  m_bWaitingForMouseUp(false),
  m_bFieldButtonDown(false),
  m_bConnectingToView(false),
  m_bDisposed(false),
  m_aDispatchContainer( m_xCC ),
  m_eDrawMode( CHARTDRAW_SELECT ),
  mpSelectionChangeHandler(new svx::sidebar::SelectionChangeHandler(
          [this]() { return this->GetContextName(); },
              this, vcl::EnumContext::Context::Cell))
120{
  m_aDoubleClickTimer.SetInvokeHandler( LINK( this, ChartController, DoubleClickWaitingHdl )::tools::detail::makeLink( ::tools::detail::castTo<ChartController
 *>(this), &ChartController::LinkStubDoubleClickWaitingHdl
) );
122}

124ChartController::~ChartController()
125{
  stopDoubleClickWaiting();
127}

129ChartController::TheModel::TheModel( const uno::Reference< frame::XModel > & xModel ) :
  m_xModel( xModel ),
  m_bOwnership( true )
132{
  m_xCloseable =
      uno::Reference< util::XCloseable >( xModel, uno::UNO_QUERY );
135}

137ChartController::TheModel::~TheModel()
138{
139}

141void ChartController::TheModel::addListener( ChartController* pController )
142{
  if(m_xCloseable.is())
  {
      //if you need to be able to veto against the destruction of the model
      // you must add as a close listener

      //otherwise you 'can' add as closelistener or 'must' add as dispose event listener

      m_xCloseable->addCloseListener(
          static_cast<util::XCloseListener*>(pController) );
  }
  else if( m_xModel.is() )
  {
      //we need to add as dispose event listener
      m_xModel->addEventListener(
          static_cast<util::XCloseListener*>(pController) );
  }

160}

162void ChartController::TheModel::removeListener(  ChartController* pController )
163{
  if(m_xCloseable.is())
      m_xCloseable->removeCloseListener(
          static_cast<util::XCloseListener*>(pController) );

  else if( m_xModel.is() )
      m_xModel->removeEventListener(
          static_cast<util::XCloseListener*>(pController) );
171}

173void ChartController::TheModel::tryTermination()
174{
  if(!m_bOwnership)
      return;

  try
  {
      if(m_xCloseable.is())
      {
          try
          {
              //@todo ? are we allowed to use sal_True here if we have the explicit ownership?
              //I think yes, because there might be other CloseListeners later in the list which might be interested still
              //but make sure that we do not throw the CloseVetoException here ourselves
              //so stop listening before trying to terminate or check the source of queryclosing event
              m_xCloseable->close(true);

              m_bOwnership                = false;
          }
          catch( const util::CloseVetoException& )
          {
              //since we have indicated to give up the ownership with parameter true in close call
              //the one who has thrown the CloseVetoException is the new owner

              SAL_WARN_IF( m_bOwnership, "chart2.main", "a well known owner has caught a CloseVetoException after calling close(true)")do { if (true && (m_bOwnership)) { switch (sal_detail_log_report
(::SAL_DETAIL_LOG_LEVEL_WARN, "chart2.main")) { case SAL_DETAIL_LOG_ACTION_IGNORE
: break; case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail
::getResult( ::sal::detail::StreamStart() << "a well known owner has caught a CloseVetoException after calling close(true)"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("chart2.main"
), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "197" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "a well known owner has caught a CloseVetoException after calling close(true)"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
 << "a well known owner has caught a CloseVetoException after calling close(true)"
; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("chart2.main"
), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "197" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "a well known owner has caught a CloseVetoException after calling close(true)"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("chart2.main"
), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "197" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "a well known owner has caught a CloseVetoException after calling close(true)"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
 << "a well known owner has caught a CloseVetoException after calling close(true)"
; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("chart2.main"
), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "197" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
              m_bOwnership                = false;
              return;
          }

      }
      else if( m_xModel.is() )
      {
          //@todo correct??
          m_xModel->dispose();
          return;
      }
  }
  catch(const uno::Exception&)
  {
      DBG_UNHANDLED_EXCEPTION( "chart2", "Termination of model failed" )DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "212" ": ", "chart2", "Termination of model failed" );;
  }
214}

216ChartController::TheModelRef::TheModelRef( TheModel* pTheModel, osl::Mutex& rMutex ) :
  m_rModelMutex(rMutex)
218{
  osl::Guard< osl::Mutex > aGuard( m_rModelMutex );
  m_xTheModel = pTheModel;
221}
222ChartController::TheModelRef::TheModelRef( const TheModelRef& rTheModel, ::osl::Mutex& rMutex ) :
  m_rModelMutex(rMutex)
224{
  osl::Guard< osl::Mutex > aGuard( m_rModelMutex );
  m_xTheModel = rTheModel.m_xTheModel;
227}
228ChartController::TheModelRef& ChartController::TheModelRef::operator=(TheModel* pTheModel)
229{
  osl::Guard< osl::Mutex > aGuard( m_rModelMutex );
  m_xTheModel = pTheModel;
  return *this;
233}
234ChartController::TheModelRef& ChartController::TheModelRef::operator=(const TheModelRef& rTheModel)
235{
  osl::Guard< osl::Mutex > aGuard( m_rModelMutex );
  m_xTheModel = rTheModel.operator->();
  return *this;
239}
240ChartController::TheModelRef::~TheModelRef()
241{
  osl::Guard< osl::Mutex > aGuard( m_rModelMutex );
  m_xTheModel.clear();
244}
245bool ChartController::TheModelRef::is() const
246{
  return m_xTheModel.is();
248}

250namespace {

252css::uno::Reference<css::chart2::XChartType> getChartType(
      const css::uno::Reference<css::chart2::XChartDocument>& xChartDoc)
254{
  Reference <chart2::XDiagram > xDiagram = xChartDoc->getFirstDiagram();
  if (!xDiagram.is()) {
      return css::uno::Reference<css::chart2::XChartType>();
  }

  Reference< chart2::XCoordinateSystemContainer > xCooSysContainer( xDiagram, uno::UNO_QUERY_THROW );

  Sequence< Reference< chart2::XCoordinateSystem > > xCooSysSequence( xCooSysContainer->getCoordinateSystems());
  if (!xCooSysSequence.hasElements()) {
      return css::uno::Reference<css::chart2::XChartType>();
  }

  Reference< chart2::XChartTypeContainer > xChartTypeContainer( xCooSysSequence[0], uno::UNO_QUERY_THROW );

  Sequence< Reference< chart2::XChartType > > xChartTypeSequence( xChartTypeContainer->getChartTypes() );

  return xChartTypeSequence[0];
272}

274}

276OUString ChartController::GetContextName()
277{
  if (m_bDisposed)
      return OUString();

  uno::Any aAny = getSelection();
  if (!aAny.hasValue())
      return "Chart";

  OUString aCID;
  aAny >>= aCID;

  if (aCID.isEmpty())
      return "Chart";

  ObjectType eObjectID = ObjectIdentifier::getObjectType(aCID);
  switch (eObjectID)
  {
      case OBJECTTYPE_DATA_SERIES:
          return "Series";
      break;
      case OBJECTTYPE_DATA_ERRORS_X:
      case OBJECTTYPE_DATA_ERRORS_Y:
      case OBJECTTYPE_DATA_ERRORS_Z:
          return "ErrorBar";
      case OBJECTTYPE_AXIS:
          return "Axis";
      case OBJECTTYPE_GRID:
          return "Grid";
      case OBJECTTYPE_DIAGRAM:
          {
              css::uno::Reference<css::chart2::XChartType> xChartType = getChartType(css::uno::Reference<css::chart2::XChartDocument>(getModel(), uno::UNO_QUERY));
              if (xChartType.is() && xChartType->getChartType() == "com.sun.star.chart2.PieChartType")
                  return "ChartElements";
              break;
          }
      case OBJECTTYPE_DATA_CURVE:
      case OBJECTTYPE_DATA_AVERAGE_LINE:
          return "Trendline";
      default:
      break;
  }

  return "Chart";
320}

322// private methods

324bool ChartController::impl_isDisposedOrSuspended() const
325{
  if( m_aLifeTimeManager.impl_isDisposed() )
      return true;

  if( m_bSuspended )
  {
      OSL_FAIL( "This Controller is suspended" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "331" ": "), "%s", "This Controller is suspended"); } } while
 (false);
      return true;
  }
  return false;
335}

337// lang::XServiceInfo

339OUString SAL_CALL ChartController::getImplementationName()
340{
  return CHART_CONTROLLER_SERVICE_IMPLEMENTATION_NAME"com.sun.star.comp.chart2.ChartController";
342}

344sal_Bool SAL_CALL ChartController::supportsService( const OUString& rServiceName )
345{
  return cppu::supportsService(this, rServiceName);
347}

349css::uno::Sequence< OUString > SAL_CALL ChartController::getSupportedServiceNames()
350{
  return {
      CHART_CONTROLLER_SERVICE_NAME"com.sun.star.chart2.ChartController",
      "com.sun.star.frame.Controller"
      //// @todo : add additional services if you support any further
  };
356}

358namespace {

360uno::Reference<ui::XSidebar> getSidebarFromModel(const uno::Reference<frame::XModel>& xModel)
361{
  uno::Reference<container::XChild> xChild(xModel, uno::UNO_QUERY);
  if (!xChild.is())
      return nullptr;

  uno::Reference<frame::XModel> xParent (xChild->getParent(), uno::UNO_QUERY);
  if (!xParent.is())
      return nullptr;

  uno::Reference<frame::XController2> xController(xParent->getCurrentController(), uno::UNO_QUERY);
  if (!xController.is())
      return nullptr;

  uno::Reference<ui::XSidebarProvider> xSidebarProvider  = xController->getSidebar();
  if (!xSidebarProvider.is())
      return nullptr;

  return xSidebarProvider->getSidebar();
379}

381}

383// XController

385void SAL_CALL ChartController::attachFrame(
  const uno::Reference<frame::XFrame>& xFrame )
387{
  SolarMutexGuard aGuard;

  if( impl_isDisposedOrSuspended() ) //@todo? allow attaching the frame while suspended?
      return; //behave passive if already disposed or suspended

  mpSelectionChangeHandler->Connect();

  uno::Reference<ui::XSidebar> xSidebar = getSidebarFromModel(getModel());
  if (xSidebar.is())
  {
      auto pSidebar = dynamic_cast<sfx2::sidebar::SidebarController*>(xSidebar.get());
      assert(pSidebar)(static_cast <bool> (pSidebar) ? void (0) : __assert_fail
 ("pSidebar", "/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
, 399, __extension__ __PRETTY_FUNCTION__));
      sfx2::sidebar::SidebarController::registerSidebarForFrame(pSidebar, this);
      pSidebar->updateModel(getModel());
      css::lang::EventObject aEvent;
      mpSelectionChangeHandler->selectionChanged(aEvent);
  }

  if(m_xFrame.is()) //what happens, if we do have a Frame already??
  {
      //@todo? throw exception?
      OSL_FAIL( "there is already a frame attached to the controller" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "409" ": "), "%s", "there is already a frame attached to the controller"
); } } while (false);
      return;
  }

  //--attach frame
  m_xFrame = xFrame; //the frameloader is responsible to call xFrame->setComponent

  //add as disposelistener to the frame (due to persistent reference) ??...:

  //the frame is considered to be owner of this controller and will live longer than we do
  //the frame or the disposer of the frame has the duty to call suspend and dispose on this object
  //so we do not need to add as lang::XEventListener for DisposingEvents right?

  //@todo nothing right???

  //create view @todo is this the correct place here??

  vcl::Window* pParent = nullptr;
  //get the window parent from the frame to use as parent for our new window
  if(xFrame.is())
  {
      uno::Reference< awt::XWindow > xContainerWindow = xFrame->getContainerWindow();
      VCLXWindow* pParentComponent = comphelper::getUnoTunnelImplementation<VCLXWindow>(xContainerWindow);
      assert(pParentComponent)(static_cast <bool> (pParentComponent) ? void (0) : __assert_fail
 ("pParentComponent", "/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
, 432, __extension__ __PRETTY_FUNCTION__));
      if (pParentComponent)
          pParentComponent->setVisible(true);

      pParent = VCLUnoHelper::GetWindow( xContainerWindow ).get();
  }

  {
      // calls to VCL
      SolarMutexGuard aSolarGuard;
      auto pChartWindow = VclPtr<ChartWindow>::Create(this,pParent,pParent?pParent->GetStyle():0);
      pChartWindow->SetBackground();//no Background
      m_xViewWindow.set( pChartWindow->GetComponentInterface(), uno::UNO_QUERY );
      pChartWindow->Show();
      m_apDropTargetHelper.reset(
          new ChartDropTargetHelper( pChartWindow->GetDropTarget(),
                                     uno::Reference< chart2::XChartDocument >( getModel(), uno::UNO_QUERY )));

      impl_createDrawViewController();
  }

  //create the menu
  {
      uno::Reference< beans::XPropertySet > xPropSet( xFrame, uno::UNO_QUERY );
      if( xPropSet.is() )
      {
          try
          {
              uno::Reference< css::frame::XLayoutManager > xLayoutManager;
              xPropSet->getPropertyValue( "LayoutManager" ) >>= xLayoutManager;
              if ( xLayoutManager.is() )
              {
                  xLayoutManager->lock();
                  xLayoutManager->requestElement( "private:resource/menubar/menubar" );
                  //@todo: createElement should become unnecessary, remove when #i79198# is fixed
                  xLayoutManager->createElement( "private:resource/toolbar/standardbar" );
                  xLayoutManager->requestElement( "private:resource/toolbar/standardbar" );
                  //@todo: createElement should become unnecessary, remove when #i79198# is fixed
                  xLayoutManager->createElement( "private:resource/toolbar/toolbar" );
                  xLayoutManager->requestElement( "private:resource/toolbar/toolbar" );

                  // #i12587# support for shapes in chart
                  xLayoutManager->createElement( "private:resource/toolbar/drawbar" );
                  xLayoutManager->requestElement( "private:resource/toolbar/drawbar" );

                  xLayoutManager->requestElement( "private:resource/statusbar/statusbar" );
                  xLayoutManager->unlock();

                  // add as listener to get notified when
                  m_xLayoutManagerEventBroadcaster.set( xLayoutManager, uno::UNO_QUERY );
                  if( m_xLayoutManagerEventBroadcaster.is())
                      m_xLayoutManagerEventBroadcaster->addLayoutManagerEventListener( this );
              }
          }
          catch( const uno::Exception & )
          {
              DBG_UNHANDLED_EXCEPTION("chart2")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "488" ": ", "chart2" );;
          }
      }
  }
492}

494//XModeChangeListener
495void SAL_CALL ChartController::modeChanged( const util::ModeChangeEvent& rEvent )
496{
  SolarMutexGuard aGuard;
  auto pChartWindow(GetChartWindow());
  //adjust controller to view status changes

  if( rEvent.NewMode == "dirty" )
  {
      //the view has become dirty, we should repaint it if we have a window
      if( pChartWindow )
          pChartWindow->ForceInvalidate();
  }
  else if( rEvent.NewMode == "invalid" )
  {
      //the view is about to become invalid so end all actions on it
      impl_invalidateAccessible();
      if( m_pDrawViewWrapper && m_pDrawViewWrapper->IsTextEdit() )
          this->EndTextEdit();
      if( m_pDrawViewWrapper )
      {
          m_pDrawViewWrapper->UnmarkAll();
          m_pDrawViewWrapper->HideSdrPage();
      }
  }
  else
  {
      //the view was rebuild so we can start some actions on it again
      if( !m_bConnectingToView )
      {
          if(pChartWindow && m_aModel.is() )
          {
              m_bConnectingToView = true;

              GetDrawModelWrapper();
              if(m_pDrawModelWrapper)
              {
                  {
                      if( m_pDrawViewWrapper )
                          m_pDrawViewWrapper->ReInit();
                  }

                  //reselect object
                  if( m_aSelection.hasSelection() )
                      this->impl_selectObjectAndNotiy();
                  else
                      ChartModelHelper::triggerRangeHighlighting( getModel() );

                  impl_initializeAccessible();

                  {
                      if( pChartWindow )
                          pChartWindow->Invalidate();
                  }
              }

              m_bConnectingToView = false;
          }
      }
  }
554}

556sal_Bool SAL_CALL ChartController::attachModel( const uno::Reference< frame::XModel > & xModel )
557{
  impl_invalidateAccessible();

  //is called to attach the controller to a new model.
  //return true if attach was successfully, false otherwise (e.g. if you do not work with a model)

  SolarMutexResettableGuard aGuard;
  if( impl_isDisposedOrSuspended() ) //@todo? allow attaching a new model while suspended?
      return false; //behave passive if already disposed or suspended
  aGuard.clear();

  TheModelRef aNewModelRef( new TheModel( xModel), m_aModelMutex);
  TheModelRef aOldModelRef(m_aModel,m_aModelMutex);
  m_aModel = aNewModelRef;

  //--handle relations to the old model if any
  if( aOldModelRef.is() )
  {
      uno::Reference< util::XModeChangeBroadcaster > xViewBroadcaster( m_xChartView, uno::UNO_QUERY );
      if( xViewBroadcaster.is() )
          xViewBroadcaster->removeModeChangeListener(this);
      m_pDrawModelWrapper.reset();

      aOldModelRef->removeListener( this );
#ifdef TEST_ENABLE_MODIFY_LISTENER
      uno::Reference< util::XModifyBroadcaster > xMBroadcaster( aOldModelRef->getModel(),uno::UNO_QUERY );
      if( xMBroadcaster.is())
          xMBroadcaster->removeModifyListener( this );
585#endif
  }

  //--handle relations to the new model
  aNewModelRef->addListener( this );

  aGuard.reset(); // lock for m_aDispatchContainer access
  // set new model at dispatchers
  m_aDispatchContainer.setModel( aNewModelRef->getModel());
  ControllerCommandDispatch * pDispatch = new ControllerCommandDispatch( m_xCC, this, &m_aDispatchContainer );
  pDispatch->initialize();

  // the dispatch container will return "this" for all commands returned by
  // impl_getAvailableCommands().  That means, for those commands dispatch()
  // is called here at the ChartController.
  m_aDispatchContainer.setChartDispatch( pDispatch, impl_getAvailableCommands() );

  DrawCommandDispatch* pDrawDispatch = new DrawCommandDispatch( m_xCC, this );
  pDrawDispatch->initialize();
  m_aDispatchContainer.setDrawCommandDispatch( pDrawDispatch );

  ShapeController* pShapeController = new ShapeController( m_xCC, this );
  pShapeController->initialize();
  m_aDispatchContainer.setShapeController( pShapeController );
  aGuard.clear();

611#ifdef TEST_ENABLE_MODIFY_LISTENER
  uno::Reference< util::XModifyBroadcaster > xMBroadcaster( aNewModelRef->getModel(),uno::UNO_QUERY );
  if( xMBroadcaster.is())
      xMBroadcaster->addModifyListener( this );
615#endif

  // #i119999# Do not do this per default to allow the user to deselect the chart OLE with a single press to ESC
  // select chart area per default:
  // select( uno::Any( ObjectIdentifier::createClassifiedIdentifier( OBJECTTYPE_PAGE, OUString() ) ) );

  uno::Reference< lang::XMultiServiceFactory > xFact( getModel(), uno::UNO_QUERY );
  if( xFact.is())
  {
      m_xChartView = xFact->createInstance( CHART_VIEW_SERVICE_NAME"com.sun.star.chart2.ChartView" );
      GetDrawModelWrapper();
      uno::Reference< util::XModeChangeBroadcaster > xViewBroadcaster( m_xChartView, uno::UNO_QUERY );
      if( xViewBroadcaster.is() )
          xViewBroadcaster->addModeChangeListener(this);
  }

  //the frameloader is responsible to call xModel->connectController
  {
      SolarMutexGuard aGuard2;
      auto pChartWindow(GetChartWindow());
      if( pChartWindow )
          pChartWindow->Invalidate();
  }

  uno::Reference< document::XUndoManagerSupplier > xSuppUndo( getModel(), uno::UNO_QUERY_THROW );
  m_xUndoManager.set( xSuppUndo->getUndoManager(), uno::UNO_SET_THROW );

  return true;
643}

645uno::Reference< frame::XFrame > SAL_CALL ChartController::getFrame()
646{
  //provides access to owner frame of this controller
  //return the frame containing this controller

  return m_xFrame;
651}

653uno::Reference< frame::XModel > SAL_CALL ChartController::getModel()
654{
  //provides access to currently attached model
  //returns the currently attached model

  //return nothing, if you do not have a model
  TheModelRef aModelRef( m_aModel, m_aModelMutex);
  if(aModelRef.is())
      return aModelRef->getModel();

  return uno::Reference< frame::XModel > ();
664}

666uno::Any SAL_CALL ChartController::getViewData()
667{
  //provides access to current view status
  //set of data that can be used to restore the current view status at later time
  //  by using XController::restoreViewData()

  SolarMutexGuard aGuard;
  if( impl_isDisposedOrSuspended() )
      return uno::Any(); //behave passive if already disposed or suspended //@todo? or throw an exception??

  //-- collect current view state
  uno::Any aRet;
  //// @todo integrate specialized implementation

  return aRet;
681}

683void SAL_CALL ChartController::restoreViewData(
  const uno::Any& /* Value */ )
685{
  //restores the view status using the data gotten from a previous call to XController::getViewData()

  SolarMutexGuard aGuard;
  if( impl_isDisposedOrSuspended() )
      return; //behave passive if already disposed or suspended //@todo? or throw an exception??

  //// @todo integrate specialized implementation
693}

695sal_Bool SAL_CALL ChartController::suspend( sal_Bool bSuspend )
696{
  //is called to prepare the controller for closing the view
  //bSuspend==true: force the controller to suspend his work
  //bSuspend==false try to reactivate the controller
  //returns true if request was accepted and of course successfully finished, false otherwise

  //we may show dialogs here to ask the user for saving changes ... @todo?

  SolarMutexGuard aGuard;
  if( m_aLifeTimeManager.impl_isDisposed() )
      return false; //behave passive if already disposed, return false because request was not accepted //@todo? correct

  if(bool(bSuspend) == m_bSuspended)
  {
      OSL_FAIL( "new suspend mode equals old suspend mode" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "710" ": "), "%s", "new suspend mode equals old suspend mode"
); } } while (false);
      return true;
  }

  //change suspend mode
  m_bSuspended = bSuspend;
  return true;
717}

719void ChartController::impl_createDrawViewController()
720{
  SolarMutexGuard aGuard;
  if(!m_pDrawViewWrapper)
  {
      if( m_pDrawModelWrapper )
      {
          m_pDrawViewWrapper.reset( new DrawViewWrapper(m_pDrawModelWrapper->getSdrModel(),GetChartWindow()) );
          m_pDrawViewWrapper->attachParentReferenceDevice( getModel() );
      }
  }
730}

732void ChartController::impl_deleteDrawViewController()
733{
  if( m_pDrawViewWrapper )
  {
      SolarMutexGuard aGuard;
      if( m_pDrawViewWrapper->IsTextEdit() )
          this->EndTextEdit();
      m_pDrawViewWrapper.reset();
  }
741}

743// XComponent (base of XController)

745void SAL_CALL ChartController::dispose()
746{
  m_bDisposed = true;

  if (getModel().is())
  {
      uno::Reference<ui::XSidebar> xSidebar = getSidebarFromModel(getModel());
      if (sfx2::sidebar::SidebarController* pSidebar = dynamic_cast<sfx2::sidebar::SidebarController*>(xSidebar.get()))
      {
          sfx2::sidebar::SidebarController::unregisterSidebarForFrame(pSidebar, this);
      }
  }
  mpSelectionChangeHandler->selectionChanged(css::lang::EventObject());
  mpSelectionChangeHandler->Disconnect();

  try
  {
      //This object should release all resources and references in the
      //easiest possible manner
      //This object must notify all registered listeners using the method
      //<member>XEventListener::disposing</member>

      //hold no mutex
      if( !m_aLifeTimeManager.dispose() )
          return;

771//  OSL_ENSURE( m_bSuspended, "dispose was called but controller is not suspended" );

      this->stopDoubleClickWaiting();

      //end range highlighting
      if( m_aModel.is())
      {
          uno::Reference< view::XSelectionChangeListener > xSelectionChangeListener;
          uno::Reference< chart2::data::XDataReceiver > xDataReceiver( getModel(), uno::UNO_QUERY );
          if( xDataReceiver.is() )
              xSelectionChangeListener.set( xDataReceiver->getRangeHighlighter(), uno::UNO_QUERY );
          if( xSelectionChangeListener.is() )
          {
              uno::Reference< frame::XController > xController( this );
              lang::EventObject aEvent( xController );
              xSelectionChangeListener->disposing( aEvent );
          }
      }

      //--release all resources and references
      {
          uno::Reference< util::XModeChangeBroadcaster > xViewBroadcaster( m_xChartView, uno::UNO_QUERY );
          if( xViewBroadcaster.is() )
              xViewBroadcaster->removeModeChangeListener(this);

          impl_invalidateAccessible();
          SolarMutexGuard aSolarGuard;
          impl_deleteDrawViewController();
          m_pDrawModelWrapper.reset();

          m_apDropTargetHelper.reset();

          //the accessible view is disposed within window destructor of m_pChartWindow
          if(m_xViewWindow.is())
              m_xViewWindow->dispose(); //ChartWindow is deleted via UNO due to dispose of m_xViewWindow (triggered by Framework (Controller pretends to be XWindow also))
          m_xChartView.clear();
      }

      // remove as listener to layout manager events
      if( m_xLayoutManagerEventBroadcaster.is())
      {
          m_xLayoutManagerEventBroadcaster->removeLayoutManagerEventListener( this );
          m_xLayoutManagerEventBroadcaster.set( nullptr );
      }

      m_xFrame.clear();
      m_xUndoManager.clear();

      TheModelRef aModelRef( m_aModel, m_aModelMutex);
      m_aModel = nullptr;

      if( aModelRef.is())
      {
          uno::Reference< frame::XModel > xModel( aModelRef->getModel() );
          if(xModel.is())
              xModel->disconnectController( uno::Reference< frame::XController >( this ));

          aModelRef->removeListener( this );
829#ifdef TEST_ENABLE_MODIFY_LISTENER
          try
          {
              uno::Reference< util::XModifyBroadcaster > xMBroadcaster( aModelRef->getModel(),uno::UNO_QUERY );
              if( xMBroadcaster.is())
                  xMBroadcaster->removeModifyListener( this );
          }
          catch( const uno::Exception & )
          {
              DBG_UNHANDLED_EXCEPTION("chart2")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "838" ": ", "chart2" );;
          }
840#endif
          aModelRef->tryTermination();
      }

      //// @todo integrate specialized implementation
      //e.g. release further resources and references

      SolarMutexGuard g;
      m_aDispatchContainer.DisposeAndClear();
  }
  catch( const uno::Exception & )
  {
      DBG_UNHANDLED_EXCEPTION("chart2")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "852" ": ", "chart2" );;
      assert(!m_xChartView.is())(static_cast <bool> (!m_xChartView.is()) ? void (0) : __assert_fail
 ("!m_xChartView.is()", "/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
, 853, __extension__ __PRETTY_FUNCTION__));
  }
}

857void SAL_CALL ChartController::addEventListener(
  const uno::Reference<lang::XEventListener>& xListener )
859{
  SolarMutexGuard aGuard;
  if( impl_isDisposedOrSuspended() )//@todo? allow adding of listeners in suspend mode?
      return; //behave passive if already disposed or suspended

  //--add listener
  m_aLifeTimeManager.m_aListenerContainer.addInterface( cppu::UnoType<lang::XEventListener>::get(), xListener );
866}

868void SAL_CALL ChartController::removeEventListener(
  const uno::Reference<lang::XEventListener>& xListener )
870{
  SolarMutexGuard aGuard;
  if( m_aLifeTimeManager.impl_isDisposed(false) )
      return; //behave passive if already disposed or suspended

  //--remove listener
  m_aLifeTimeManager.m_aListenerContainer.removeInterface( cppu::UnoType<lang::XEventListener>::get(), xListener );
877}

879// util::XCloseListener
880void SAL_CALL ChartController::queryClosing(
  const lang::EventObject& rSource,
  sal_Bool /*bGetsOwnership*/ )
883{
  //do not use the m_aControllerMutex here because this call is not allowed to block

  TheModelRef aModelRef( m_aModel, m_aModelMutex);

  if( !aModelRef.is() )
      return;

  if( aModelRef->getModel() != rSource.Source )
  {
      OSL_FAIL( "queryClosing was called on a controller from an unknown source" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "893" ": "), "%s", "queryClosing was called on a controller from an unknown source"
); } } while (false);
      return;
  }

  //@ todo prepare to closing model -> don't start any further hindering actions
898}

900void SAL_CALL ChartController::notifyClosing(
  const lang::EventObject& rSource )
902{
  //Listener should deregister himself and release all references to the closing object.

  TheModelRef aModelRef( m_aModel, m_aModelMutex);
  if( !impl_releaseThisModel( rSource.Source ) )
      return;

  //--stop listening to the closing model
  aModelRef->removeListener( this );

  // #i79087# If the model using this controller is closed, the frame is
  // expected to be closed as well
  Reference< util::XCloseable > xFrameCloseable( m_xFrame, uno::UNO_QUERY );
  if( xFrameCloseable.is())
  {
      try
      {
          xFrameCloseable->close( false /* DeliverOwnership */ );
          m_xFrame.clear();
      }
      catch( const util::CloseVetoException & )
      {
          // closing was vetoed
      }
  }
927}

929bool ChartController::impl_releaseThisModel(
  const uno::Reference< uno::XInterface > & xModel )
931{
  bool bReleaseModel = false;
  {
      ::osl::Guard< ::osl::Mutex > aGuard( m_aModelMutex );
      if( m_aModel.is() && m_aModel->getModel() == xModel )
      {
          m_aModel = nullptr;
          m_xUndoManager.clear();
          bReleaseModel = true;
      }
  }
  if( bReleaseModel )
  {
      SolarMutexGuard g;
      m_aDispatchContainer.setModel( nullptr );
  }
  return bReleaseModel;
948}

950// util::XEventListener (base of XCloseListener)
951void SAL_CALL ChartController::disposing(
  const lang::EventObject& rSource )
953{
  if( !impl_releaseThisModel( rSource.Source ))
  {
      if( rSource.Source == m_xLayoutManagerEventBroadcaster )
          m_xLayoutManagerEventBroadcaster.set( nullptr );
  }
959}

961void SAL_CALL ChartController::layoutEvent(
  const lang::EventObject& aSource,
  sal_Int16 eLayoutEvent,
  const uno::Any& /* aInfo */ )
965{
  if( eLayoutEvent == frame::LayoutManagerEvents::MERGEDMENUBAR )
  {
      Reference< frame::XLayoutManager > xLM( aSource.Source, uno::UNO_QUERY );
      if( xLM.is())
      {
          xLM->createElement(  "private:resource/statusbar/statusbar" );
          xLM->requestElement( "private:resource/statusbar/statusbar" );
      }
  }
975}

977// XDispatchProvider (required interface)

979namespace
980{

982bool lcl_isFormatObjectCommand( const OUString& aCommand )
983{
  return aCommand == "MainTitle"
      || aCommand == "SubTitle"
      || aCommand == "XTitle"
      || aCommand == "YTitle"
      || aCommand == "ZTitle"
      || aCommand == "SecondaryXTitle"
      || aCommand == "SecondaryYTitle"
      || aCommand == "AllTitles"
      || aCommand == "DiagramAxisX"
      || aCommand == "DiagramAxisY"
      || aCommand == "DiagramAxisZ"
      || aCommand == "DiagramAxisA"
      || aCommand == "DiagramAxisB"
      || aCommand == "DiagramAxisAll"
      || aCommand == "DiagramGridXMain"
      || aCommand == "DiagramGridYMain"
      || aCommand == "DiagramGridZMain"
      || aCommand == "DiagramGridXHelp"
      || aCommand == "DiagramGridYHelp"
      || aCommand == "DiagramGridZHelp"
      || aCommand == "DiagramGridAll"

      || aCommand == "DiagramWall"
      || aCommand == "DiagramFloor"
      || aCommand == "DiagramArea"
      || aCommand == "Legend"

      || aCommand == "FormatWall"
      || aCommand == "FormatFloor"
      || aCommand == "FormatChartArea"
      || aCommand == "FormatLegend"

      || aCommand == "FormatTitle"
      || aCommand == "FormatAxis"
      || aCommand == "FormatDataSeries"
      || aCommand == "FormatDataPoint"
      || aCommand == "FormatDataLabels"
      || aCommand == "FormatDataLabel"
      || aCommand == "FormatXErrorBars"
      || aCommand == "FormatYErrorBars"
      || aCommand == "FormatMeanValue"
      || aCommand == "FormatTrendline"
      || aCommand == "FormatTrendlineEquation"
      || aCommand == "FormatStockLoss"
      || aCommand == "FormatStockGain"
      || aCommand == "FormatMajorGrid"
      || aCommand == "FormatMinorGrid";
1031}

1033} // anonymous namespace

1035uno::Reference<frame::XDispatch> SAL_CALL
  ChartController::queryDispatch(
      const util::URL& rURL,
      const OUString& rTargetFrameName,
      sal_Int32 /* nSearchFlags */)
1040{
  SolarMutexGuard aGuard;

  if ( !m_aLifeTimeManager.impl_isDisposed() && getModel().is() )
  {
      if( !rTargetFrameName.isEmpty() && rTargetFrameName == "_self" )
          return m_aDispatchContainer.getDispatchForURL( rURL );
  }
  return uno::Reference< frame::XDispatch > ();
1049}

1051uno::Sequence<uno::Reference<frame::XDispatch > >
  ChartController::queryDispatches(
      const uno::Sequence<frame::DispatchDescriptor>& xDescripts )
1054{
  SolarMutexGuard g;

  if ( !m_aLifeTimeManager.impl_isDisposed() )
  {
      return m_aDispatchContainer.getDispatchesForURLs( xDescripts );
  }
  return uno::Sequence<uno::Reference<frame::XDispatch > > ();
1062}

1064// frame::XDispatch

1066void SAL_CALL ChartController::dispatch(
  const util::URL& rURL,
  const uno::Sequence< beans::PropertyValue >& rArgs )
1069{
  OUString aCommand = rURL.Path;

  if(aCommand == "LOKSetTextSelection")
1
Calling 'operator==<char const[20]>'→
10
←
Returning from 'operator==<char const[20]>'→
11
←
Taking false branch→
  {
      if (rArgs.getLength() == 3)
      {
          sal_Int32 nType = -1;
          rArgs[0].Value >>= nType;
          sal_Int32 nX = 0;
          rArgs[1].Value >>= nX;
          sal_Int32 nY = 0;
          rArgs[2].Value >>= nY;
          executeDispatch_LOKSetTextSelection(nType, nX, nY);
      }
  }
  else if (aCommand == "LOKTransform")
12
←
Calling 'operator==<char const[13]>'→
21
←
Returning from 'operator==<char const[13]>'→
22
←
Taking false branch→
  {
      if (rArgs[0].Name == "Action")
      {
          OUString sAction;
          if ((rArgs[0].Value >>= sAction) && sAction == "PieSegmentDragging")
          {
              if (rArgs[1].Name == "Offset")
              {
                  sal_Int32 nOffset;
                  if (rArgs[1].Value >>= nOffset)
                  {
                      this->executeDispatch_LOKPieSegmentDragging(nOffset);
                  }
              }
          }
      }
      else
      {
          this->executeDispatch_PositionAndSize(&rArgs);
      }
  }
  else if(aCommand == "FillColor")
23
←
Calling 'operator==<char const[10]>'→
32
←
Returning from 'operator==<char const[10]>'→
33
←
Assuming the condition is true→
34
←
Taking true branch→
  {
      if (rArgs.getLength() > 0)
35
←
Assuming the condition is true→
36
←
Taking true branch→
      {
          sal_uInt32 nColor;
37
←
'nColor' declared without an initial value→
          rArgs[0].Value >>= nColor;
38
←
Calling 'operator>>=<unsigned int>'→
41
←
Returning from 'operator>>=<unsigned int>'→
          this->executeDispatch_FillColor(nColor);
42
←
1st function call argument is an uninitialized value
      }
  }
  else if(aCommand == "Paste")
      this->executeDispatch_Paste();
  else if(aCommand == "Copy" )
      this->executeDispatch_Copy();
  else if(aCommand == "Cut" )
      this->executeDispatch_Cut();
  else if(aCommand == "DataRanges" )
      this->executeDispatch_SourceData();
  else if(aCommand == "Update" ) //Update Chart
  {
      ChartViewHelper::setViewToDirtyState( getModel() );
      SolarMutexGuard aGuard;
      auto pChartWindow(GetChartWindow());
      if( pChartWindow )
          pChartWindow->Invalidate();
  }
  else if(aCommand == "DiagramData" )
      this->executeDispatch_EditData();
  //insert objects
  else if( aCommand == "InsertTitles"
      || aCommand == "InsertMenuTitles")
      this->executeDispatch_InsertTitles();
  else if( aCommand == "InsertMenuLegend" )
      this->executeDispatch_OpenLegendDialog();
  else if( aCommand == "InsertLegend" )
      this->executeDispatch_InsertLegend();
  else if( aCommand == "DeleteLegend" )
      this->executeDispatch_DeleteLegend();
  else if( aCommand == "InsertMenuDataLabels" )
      this->executeDispatch_InsertMenu_DataLabels();
  else if( aCommand == "InsertMenuAxes"
      || aCommand == "InsertRemoveAxes" )
      this->executeDispatch_InsertAxes();
  else if( aCommand == "InsertMenuGrids" )
      this->executeDispatch_InsertGrid();
  else if( aCommand == "InsertMenuTrendlines" )
      this->executeDispatch_InsertMenu_Trendlines();
  else if( aCommand == "InsertMenuMeanValues" )
      this->executeDispatch_InsertMenu_MeanValues();
  else if( aCommand == "InsertMenuXErrorBars" )
      this->executeDispatch_InsertErrorBars(false);
  else if( aCommand == "InsertMenuYErrorBars" )
      this->executeDispatch_InsertErrorBars(true);
  else if( aCommand == "InsertSymbol" )
       this->executeDispatch_InsertSpecialCharacter();
  else if( aCommand == "InsertTrendline" )
       this->executeDispatch_InsertTrendline();
  else if( aCommand == "DeleteTrendline" )
       this->executeDispatch_DeleteTrendline();
  else if( aCommand == "InsertMeanValue" )
      this->executeDispatch_InsertMeanValue();
  else if( aCommand == "DeleteMeanValue" )
      this->executeDispatch_DeleteMeanValue();
  else if( aCommand == "InsertXErrorBars" )
      this->executeDispatch_InsertErrorBars(false);
  else if( aCommand == "InsertYErrorBars" )
      this->executeDispatch_InsertErrorBars(true);
  else if( aCommand == "DeleteXErrorBars" )
      this->executeDispatch_DeleteErrorBars(false);
  else if( aCommand == "DeleteYErrorBars" )
      this->executeDispatch_DeleteErrorBars(true);
  else if( aCommand == "InsertTrendlineEquation" )
       this->executeDispatch_InsertTrendlineEquation();
  else if( aCommand == "DeleteTrendlineEquation" )
       this->executeDispatch_DeleteTrendlineEquation();
  else if( aCommand == "InsertTrendlineEquationAndR2" )
       this->executeDispatch_InsertTrendlineEquation( true );
  else if( aCommand == "InsertR2Value" )
       this->executeDispatch_InsertR2Value();
  else if( aCommand == "DeleteR2Value")
       this->executeDispatch_DeleteR2Value();
  else if( aCommand == "InsertDataLabels" )
      this->executeDispatch_InsertDataLabels();
  else if( aCommand == "InsertDataLabel" )
      this->executeDispatch_InsertDataLabel();
  else if( aCommand == "DeleteDataLabels")
      this->executeDispatch_DeleteDataLabels();
  else if( aCommand == "DeleteDataLabel" )
      this->executeDispatch_DeleteDataLabel();
  else if( aCommand == "ResetAllDataPoints" )
      this->executeDispatch_ResetAllDataPoints();
  else if( aCommand == "ResetDataPoint" )
      this->executeDispatch_ResetDataPoint();
  else if( aCommand == "InsertAxis" )
      this->executeDispatch_InsertAxis();
  else if( aCommand == "InsertMajorGrid" )
      this->executeDispatch_InsertMajorGrid();
  else if( aCommand == "InsertMinorGrid" )
      this->executeDispatch_InsertMinorGrid();
  else if( aCommand == "InsertAxisTitle" )
      this->executeDispatch_InsertAxisTitle();
  else if( aCommand == "DeleteAxis" )
      this->executeDispatch_DeleteAxis();
  else if( aCommand == "DeleteMajorGrid")
      this->executeDispatch_DeleteMajorGrid();
  else if( aCommand == "DeleteMinorGrid" )
      this->executeDispatch_DeleteMinorGrid();
  //format objects
  else if( aCommand == "FormatSelection" )
      this->executeDispatch_ObjectProperties();
  else if( aCommand == "TransformDialog" )
  {
      if ( isShapeContext() )
      {
          this->impl_ShapeControllerDispatch( rURL, rArgs );
      }
      else
      {
          this->executeDispatch_PositionAndSize();
      }
  }
  else if( lcl_isFormatObjectCommand(aCommand) )
      this->executeDispatch_FormatObject(rURL.Path);
  //more format
  else if( aCommand == "DiagramType" )
      this->executeDispatch_ChartType();
  else if( aCommand == "View3D" )
      this->executeDispatch_View3D();
  else if ( aCommand == "Forward" )
  {
      if ( isShapeContext() )
      {
          this->impl_ShapeControllerDispatch( rURL, rArgs );
      }
      else
      {
          this->executeDispatch_MoveSeries( true );
      }
  }
  else if ( aCommand == "Backward" )
  {
      if ( isShapeContext() )
      {
          this->impl_ShapeControllerDispatch( rURL, rArgs );
      }
      else
      {
          this->executeDispatch_MoveSeries( false );
      }
  }
  else if( aCommand == "NewArrangement")
      this->executeDispatch_NewArrangement();
  else if( aCommand == "ToggleLegend" )
      this->executeDispatch_ToggleLegend();
  else if( aCommand == "ToggleGridHorizontal" )
      this->executeDispatch_ToggleGridHorizontal();
  else if( aCommand == "ToggleGridVertical" )
      this->executeDispatch_ToggleGridVertical();
  else if( aCommand == "ScaleText" )
      this->executeDispatch_ScaleText();
  else if( aCommand == "StatusBarVisible" )
  {
      // workaround: this should not be necessary.
      uno::Reference< beans::XPropertySet > xPropSet( m_xFrame, uno::UNO_QUERY );
      if( xPropSet.is() )
      {
          uno::Reference< css::frame::XLayoutManager > xLayoutManager;
          xPropSet->getPropertyValue( "LayoutManager" ) >>= xLayoutManager;
          if ( xLayoutManager.is() )
          {
              bool bIsVisible( xLayoutManager->isElementVisible( "private:resource/statusbar/statusbar" ));
              if( bIsVisible )
              {
                  xLayoutManager->hideElement( "private:resource/statusbar/statusbar" );
                  xLayoutManager->destroyElement( "private:resource/statusbar/statusbar" );
              }
              else
              {
                  xLayoutManager->createElement( "private:resource/statusbar/statusbar" );
                  xLayoutManager->showElement( "private:resource/statusbar/statusbar" );
              }
              // @todo: update menu state (checkmark next to "Statusbar").
          }
      }
  }
1291}

1293void SAL_CALL ChartController::addStatusListener(
  const uno::Reference<frame::XStatusListener >& /* xControl */,
  const util::URL& /* aURL */ )
1296{
  //@todo
1298}

1300void SAL_CALL ChartController::removeStatusListener(
  const uno::Reference<frame::XStatusListener >& /* xControl */,
  const util::URL& /* aURL */ )
1303{
  //@todo
1305}

1307// XContextMenuInterception (optional interface)
1308void SAL_CALL ChartController::registerContextMenuInterceptor(
  const uno::Reference< ui::XContextMenuInterceptor >& /* xInterceptor */)
1310{
  //@todo
1312}

1314void SAL_CALL ChartController::releaseContextMenuInterceptor(
  const uno::Reference< ui::XContextMenuInterceptor > & /* xInterceptor */)
1316{
  //@todo
1318}

1320// ____ XEmbeddedClient ____
1321// implementation see: ChartController_EditData.cxx

1323void ChartController::executeDispatch_ChartType()
1324{
  UndoLiveUpdateGuard aUndoGuard(
      SchResId( STR_ACTION_EDIT_CHARTTYPEreinterpret_cast<char const *>("STR_ACTION_EDIT_CHARTTYPE"
 "\004" u8"Edit chart type") ), m_xUndoManager );

  SolarMutexGuard aSolarGuard;
  //prepare and open dialog
  ChartTypeDialog aDlg(GetChartFrame(), getModel());
  if (aDlg.run() == RET_OK)
  {
      impl_adaptDataSeriesAutoResize();
      aUndoGuard.commit();
  }
1336}

1338void ChartController::executeDispatch_SourceData()
1339{
  //convert properties to ItemSet
  uno::Reference< XChartDocument >   xChartDoc( getModel(), uno::UNO_QUERY );
  OSL_ENSURE( xChartDoc.is(), "Invalid XChartDocument" )do { if (true && (!(xChartDoc.is()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "1342" ": "), "%s", "Invalid XChartDocument"); } } while
 (false);
  if( !xChartDoc.is() )
      return;

  // If there is a data table we should ask user if we really want to destroy it
  // and switch to data ranges.
  ChartModel& rModel = dynamic_cast<ChartModel&>(*xChartDoc);
  if ( rModel.hasInternalDataProvider() )
  {
      // Check if we will able to create data provider later
      css::uno::Reference< com::sun::star::chart2::XDataProviderAccess > xCreatorDoc(
          rModel.getParent(), uno::UNO_QUERY);
      if (!xCreatorDoc.is())
          return;

      SolarMutexGuard aSolarGuard;

      std::unique_ptr<weld::MessageDialog> xQueryBox(Application::CreateMessageDialog(GetChartFrame(),
                                                     VclMessageType::Question, VclButtonsType::YesNo, SchResId(STR_DLG_REMOVE_DATA_TABLEreinterpret_cast<char const *>("STR_DLG_REMOVE_DATA_TABLE"
 "\004" u8"This chart currently contains an internal data table. Do you want to proceed, deleting the internal data table, and set a new data range?"
))));
      // If "No" then just return
      if (xQueryBox->run() == RET_NO)
          return;

      // Remove data table
      rModel.removeDataProviders();

      // Ask parent document to create new data provider

      uno::Reference< data::XDataProvider > xDataProvider = xCreatorDoc->createDataProvider();
      SAL_WARN_IF( !xDataProvider.is(), "chart2.main", "Data provider was not created" )do { if (true && (!xDataProvider.is())) { switch (sal_detail_log_report
(::SAL_DETAIL_LOG_LEVEL_WARN, "chart2.main")) { case SAL_DETAIL_LOG_ACTION_IGNORE
: break; case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail
::getResult( ::sal::detail::StreamStart() << "Data provider was not created"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("chart2.main"
), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "1371" ": "), ::sal::detail::unwrapStream( ::sal::detail
::StreamStart() << "Data provider was not created"), 0)
; } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
 << "Data provider was not created"; ::sal::detail::log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("chart2.main"), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "1371" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "Data provider was not created") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("chart2.main"), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "1371" ": "), ::sal::detail::unwrapStream( ::sal::detail
::StreamStart() << "Data provider was not created"), 0)
; } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
 << "Data provider was not created"; ::sal::detail::log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("chart2.main"), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "1371" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
      if (xDataProvider.is())
      {
          rModel.attachDataProvider(xDataProvider);
      }
  }

  UndoLiveUpdateGuard aUndoGuard(
      SchResId(STR_ACTION_EDIT_DATA_RANGESreinterpret_cast<char const *>("STR_ACTION_EDIT_DATA_RANGES"
 "\004" u8"Edit data ranges")), m_xUndoManager);

  SolarMutexGuard aSolarGuard;
  ::chart::DataSourceDialog aDlg(GetChartFrame(), xChartDoc, m_xCC);
  if (aDlg.run() == RET_OK)
  {
      impl_adaptDataSeriesAutoResize();
      aUndoGuard.commit();
  }
1388}

1390void ChartController::executeDispatch_MoveSeries( bool bForward )
1391{
  ControllerLockGuardUNO aCLGuard( getModel() );

  //get selected series
  OUString aObjectCID(m_aSelection.getSelectedCID());
  uno::Reference< XDataSeries > xGivenDataSeries( ObjectIdentifier::getDataSeriesForCID( //yyy todo also legend entries and labels?
          aObjectCID, getModel() ) );

  UndoGuardWithSelection aUndoGuard(
      ActionDescriptionProvider::createDescription(
          (bForward ? ActionDescriptionProvider::ActionType::MoveToTop : ActionDescriptionProvider::ActionType::MoveToBottom),
          SchResId(STR_OBJECT_DATASERIESreinterpret_cast<char const *>("STR_OBJECT_DATASERIES" "\004"
 u8"Data Series"))),
      m_xUndoManager );

  bool bChanged = DiagramHelper::moveSeries( ChartModelHelper::findDiagram( getModel() ), xGivenDataSeries, bForward );
  if( bChanged )
  {
      m_aSelection.setSelection( ObjectIdentifier::getMovedSeriesCID( aObjectCID, bForward ) );
      aUndoGuard.commit();
  }
1411}

1413// ____ XMultiServiceFactory ____
1414uno::Reference< uno::XInterface > SAL_CALL
  ChartController::createInstance( const OUString& aServiceSpecifier )
1416{
  uno::Reference< uno::XInterface > xResult;

  if( aServiceSpecifier == CHART_ACCESSIBLE_TEXT_SERVICE_NAME"com.sun.star.accessibility.AccessibleTextComponent" )
      xResult.set( impl_createAccessibleTextContext());
  return xResult;
1422}

1424uno::Reference< uno::XInterface > SAL_CALL
  ChartController::createInstanceWithArguments(
      const OUString& ServiceSpecifier,
      const uno::Sequence< uno::Any >& /* Arguments */ )
1428{
  // ignore Arguments
  return createInstance( ServiceSpecifier );
1431}

1433uno::Sequence< OUString > SAL_CALL
  ChartController::getAvailableServiceNames()
1435{
  uno::Sequence< OUString > aServiceNames { CHART_ACCESSIBLE_TEXT_SERVICE_NAME"com.sun.star.accessibility.AccessibleTextComponent" };
  return aServiceNames;
1438}

1440// ____ XModifyListener ____
1441void SAL_CALL ChartController::modified(
  const lang::EventObject& /* aEvent */ )
1443{
  // the source can also be a subobject of the ChartModel
  // @todo: change the source in ChartModel to always be the model itself ?
  //todo? update menu states ?
1447}

1449void ChartController::NotifyUndoActionHdl( std::unique_ptr<SdrUndoAction> pUndoAction )
1450{
  ENSURE_OR_RETURN_VOID( pUndoAction, "invalid Undo action" )if( !(pUndoAction) ) { do { if (true && (!(pUndoAction
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "1451" ": "), "%s", "invalid Undo action"); } } while (false
); return; };

  OUString aObjectCID = m_aSelection.getSelectedCID();
  if ( !aObjectCID.isEmpty() )
      return;

  try
  {
      const Reference< document::XUndoManagerSupplier > xSuppUndo( getModel(), uno::UNO_QUERY_THROW );
      const Reference< document::XUndoManager > xUndoManager( xSuppUndo->getUndoManager(), uno::UNO_SET_THROW );
      const Reference< document::XUndoAction > xAction( new impl::ShapeUndoElement( std::move(pUndoAction) ) );
      xUndoManager->addUndoAction( xAction );
  }
  catch( const uno::Exception& )
  {
      DBG_UNHANDLED_EXCEPTION("chart2")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/chart2/source/controller/main/ChartController.cxx"
 ":" "1466" ": ", "chart2" );;
  }
1468}

1470DrawModelWrapper* ChartController::GetDrawModelWrapper()
1471{
  if( !m_pDrawModelWrapper )
  {
      ExplicitValueProvider* pProvider = comphelper::getUnoTunnelImplementation<ExplicitValueProvider>( m_xChartView );
      if( pProvider )
          m_pDrawModelWrapper = pProvider->getDrawModelWrapper();
      if ( m_pDrawModelWrapper )
      {
          m_pDrawModelWrapper->getSdrModel().SetNotifyUndoActionHdl(
              std::bind(&ChartController::NotifyUndoActionHdl, this, std::placeholders::_1) );
      }
  }
  return m_pDrawModelWrapper.get();
1484}

1486DrawViewWrapper* ChartController::GetDrawViewWrapper()
1487{
  if ( !m_pDrawViewWrapper )
  {
      impl_createDrawViewController();
  }
  return m_pDrawViewWrapper.get();
1493}


1496VclPtr<ChartWindow> ChartController::GetChartWindow() const
1497{
  // clients getting the naked VCL Window from UNO should always have the
  // solar mutex (and keep it over the lifetime of this ptr), as VCL might
  // might deinit otherwise
  DBG_TESTSOLARMUTEX()do { DbgTestSolarMutex(); } while(false);
  if(!m_xViewWindow.is())
      return nullptr;
  return dynamic_cast<ChartWindow*>(VCLUnoHelper::GetWindow(m_xViewWindow).get());
1505}

1507weld::Window* ChartController::GetChartFrame()
1508{
  // clients getting the naked VCL Window from UNO should always have the
  // solar mutex (and keep it over the lifetime of this ptr), as VCL might
  // might deinit otherwise
  DBG_TESTSOLARMUTEX()do { DbgTestSolarMutex(); } while(false);
  return Application::GetFrameWeld(m_xViewWindow);
1514}

1516bool ChartController::isAdditionalShapeSelected() const
1517{
  return m_aSelection.isAdditionalShapeSelected();
1519}

1521void ChartController::SetAndApplySelection(const Reference<drawing::XShape>& rxShape)
1522{
  if(rxShape.is())
  {
      m_aSelection.setSelection(rxShape);
      m_aSelection.applySelection(GetDrawViewWrapper());
  }
1528}



1532uno::Reference< XAccessible > ChartController::CreateAccessible()
1533{
  uno::Reference< XAccessible > xResult = new AccessibleChartView( GetDrawViewWrapper() );
  impl_initializeAccessible( uno::Reference< lang::XInitialization >( xResult, uno::UNO_QUERY ) );
  return xResult;
1537}

1539void ChartController::impl_invalidateAccessible()
1540{
  SolarMutexGuard aGuard;
  auto pChartWindow(GetChartWindow());
  if( pChartWindow )
  {
      Reference< lang::XInitialization > xInit( pChartWindow->GetAccessible(false), uno::UNO_QUERY );
      if(xInit.is())
      {
          uno::Sequence< uno::Any > aArguments(3);//empty arguments -> invalid accessible
          xInit->initialize(aArguments);
      }
  }
1552}
1553void ChartController::impl_initializeAccessible()
1554{
  SolarMutexGuard aGuard;
  auto pChartWindow(GetChartWindow());
  if( pChartWindow )
      this->impl_initializeAccessible( Reference< lang::XInitialization >( pChartWindow->GetAccessible(false), uno::UNO_QUERY ) );
1559}
1560void ChartController::impl_initializeAccessible( const uno::Reference< lang::XInitialization >& xInit )
1561{
  if(!xInit.is())
      return;

  uno::Sequence< uno::Any > aArguments(5);
  aArguments[0] <<= uno::Reference<view::XSelectionSupplier>(this);
  aArguments[1] <<= getModel();
  aArguments[2] <<= m_xChartView;
  uno::Reference< XAccessible > xParent;
  {
      SolarMutexGuard aGuard;
      auto pChartWindow(GetChartWindow());
      if( pChartWindow )
      {
          vcl::Window* pParentWin( pChartWindow->GetAccessibleParentWindow());
          if( pParentWin )
              xParent.set( pParentWin->GetAccessible());
      }
  }
  aArguments[3] <<= xParent;
  aArguments[4] <<= m_xViewWindow;

  xInit->initialize(aArguments);
1584}

1586const o3tl::sorted_vector< OUString >& ChartController::impl_getAvailableCommands()
1587{
  static const o3tl::sorted_vector< OUString > s_AvailableCommands {
      // commands for container forward
      "AddDirect",           "NewDoc",                "Open",
      "Save",                "SaveAs",                "SendMail",
      "EditDoc",             "ExportDirectToPDF",     "PrintDefault",

      // own commands
      "Cut",                "Copy",                 "Paste",
      "DataRanges",         "DiagramData",
      // insert objects
      "InsertMenuTitles",   "InsertTitles",
      "InsertMenuLegend",   "InsertLegend",         "DeleteLegend",
      "InsertMenuDataLabels",
      "InsertMenuAxes",     "InsertRemoveAxes",         "InsertMenuGrids",
      "InsertSymbol",
      "InsertTrendlineEquation",  "InsertTrendlineEquationAndR2",
      "InsertR2Value",      "DeleteR2Value",
      "InsertMenuTrendlines",  "InsertTrendline",
      "InsertMenuMeanValues", "InsertMeanValue",
      "InsertMenuXErrorBars",  "InsertXErrorBars",
      "InsertMenuYErrorBars",   "InsertYErrorBars",
      "InsertDataLabels",   "InsertDataLabel",
      "DeleteTrendline",    "DeleteMeanValue",      "DeleteTrendlineEquation",
      "DeleteXErrorBars",   "DeleteYErrorBars",
      "DeleteDataLabels",   "DeleteDataLabel",
      //format objects
      "FormatSelection",     "TransformDialog",
      "DiagramType",        "View3D",
      "Forward",            "Backward",
      "MainTitle",          "SubTitle",
      "XTitle",             "YTitle",               "ZTitle",
      "SecondaryXTitle",    "SecondaryYTitle",
      "AllTitles",          "Legend",
      "DiagramAxisX",       "DiagramAxisY",         "DiagramAxisZ",
      "DiagramAxisA",       "DiagramAxisB",         "DiagramAxisAll",
      "DiagramGridXMain",   "DiagramGridYMain",     "DiagramGridZMain",
      "DiagramGridXHelp",   "DiagramGridYHelp",     "DiagramGridZHelp",
      "DiagramGridAll",
      "DiagramWall",        "DiagramFloor",         "DiagramArea",

      //context menu - format objects entries
      "FormatWall",        "FormatFloor",         "FormatChartArea",
      "FormatLegend",

      "FormatAxis",           "FormatTitle",
      "FormatDataSeries",     "FormatDataPoint",
      "ResetAllDataPoints",   "ResetDataPoint",
      "FormatDataLabels",     "FormatDataLabel",
      "FormatMeanValue",      "FormatTrendline",      "FormatTrendlineEquation",
      "FormatXErrorBars",     "FormatYErrorBars",
      "FormatStockLoss",      "FormatStockGain",

      "FormatMajorGrid",      "InsertMajorGrid",      "DeleteMajorGrid",
      "FormatMinorGrid",      "InsertMinorGrid",      "DeleteMinorGrid",
      "InsertAxis",           "DeleteAxis",           "InsertAxisTitle",

      // toolbar commands
      "ToggleGridHorizontal", "ToggleGridVertical", "ToggleLegend",         "ScaleText",
      "NewArrangement",     "Update",
      "DefaultColors",      "BarWidth",             "NumberOfLines",
      "ArrangeRow",
      "StatusBarVisible",
      "ChartElementSelector"};
  return s_AvailableCommands;
1652}

1654ViewElementListProvider ChartController::getViewElementListProvider()
1655{
  return ViewElementListProvider(m_pDrawModelWrapper.get());
1657}

1659} //namespace chart

1661extern "C" SAL_DLLPUBLIC_EXPORT__attribute__ ((visibility("default"))) css::uno::XInterface *
1662com_sun_star_comp_chart2_ChartController_get_implementation(css::uno::XComponentContext *context,
                                                          css::uno::Sequence<css::uno::Any> const &)
1664{
  return cppu::acquire(new chart::ChartController(context));
1666}

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

←

/home/maarten/src/libreoffice/core/include/rtl/ustring.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 .
*/

20#ifndef INCLUDED_RTL_USTRING_HXX
21#define INCLUDED_RTL_USTRING_HXX

23#include "sal/config.h"

25#include <cassert>
26#include <cstddef>
27#include <cstdlib>
28#include <limits>
29#include <new>
30#include <ostream>
31#include <utility>

33#if defined LIBO_INTERNAL_ONLY1
34#include <string_view>
35#include <type_traits>
36#endif

38#include "rtl/ustring.h"
39#include "rtl/string.hxx"
40#include "rtl/stringutils.hxx"
41#include "rtl/textenc.h"

43#ifdef LIBO_INTERNAL_ONLY1 // "RTL_FAST_STRING"
44#include "config_global.h"
45#include "rtl/stringconcat.hxx"
46#endif

48#ifdef RTL_STRING_UNITTEST
49extern bool rtl_string_unittest_invalid_conversion;
50#endif

52// The unittest uses slightly different code to help check that the proper
53// calls are made. The class is put into a different namespace to make
54// sure the compiler generates a different (if generating also non-inline)
55// copy of the function and does not merge them together. The class
56// is "brought" into the proper rtl namespace by a typedef below.
57#ifdef RTL_STRING_UNITTEST
58#define rtl rtlunittest
59#endif

61namespace rtl
62{

64class OUStringBuffer;

66#ifdef RTL_STRING_UNITTEST
67#undef rtl
68#endif

70#if defined LIBO_INTERNAL_ONLY1 // "RTL_FAST_STRING"
71/// @cond INTERNAL

73/**
74A wrapper dressing a string literal as a static-refcount rtl_uString.

76This class is not part of public API and is meant to be used only in LibreOffice code.
77@since LibreOffice 4.0
78*/
79template<std::size_t N> class SAL_WARN_UNUSED__attribute__((warn_unused)) OUStringLiteral {
  static_assert(N != 0);
  static_assert(N - 1 <= std::numeric_limits<sal_Int32>::max(), "literal too long");

83public:
84#if HAVE_CPP_CONSTEVAL0
  consteval
86#else
  constexpr
88#endif
  OUStringLiteral(char16_t const (&literal)[N]) {
      assertLayout();
      assert(literal[N - 1] == '\0')(static_cast <bool> (literal[N - 1] == '\0') ? void (0)
 : __assert_fail ("literal[N - 1] == '\\0'", "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 91, __extension__ __PRETTY_FUNCTION__));
      //TODO: Use C++20 constexpr std::copy_n (P0202R3):
      for (std::size_t i = 0; i != N; ++i) {
          buffer[i] = literal[i];
      }
  }

  constexpr sal_Int32 getLength() const { return length; }

  constexpr sal_Unicode const * getStr() const SAL_RETURNS_NONNULL__attribute__((returns_nonnull)) { return buffer; }

  constexpr operator std::u16string_view() const { return {buffer, sal_uInt32(length)}; }

104private:
  static constexpr void assertLayout() {
      // These static_asserts verifying the layout compatibility with rtl_uString cannot be class
      // member declarations, as offsetof requires a complete type, so defer them to here:
      static_assert(offsetof(OUStringLiteral, refCount)__builtin_offsetof(OUStringLiteral, refCount) == offsetof(rtl_uString, refCount)__builtin_offsetof(rtl_uString, refCount));
      static_assert(std::is_same_v<decltype(refCount), decltype(rtl_uString::refCount)>);
      static_assert(offsetof(OUStringLiteral, length)__builtin_offsetof(OUStringLiteral, length) == offsetof(rtl_uString, length)__builtin_offsetof(rtl_uString, length));
      static_assert(std::is_same_v<decltype(length), decltype(rtl_uString::length)>);
      static_assert(offsetof(OUStringLiteral, buffer)__builtin_offsetof(OUStringLiteral, buffer) == offsetof(rtl_uString, buffer)__builtin_offsetof(rtl_uString, buffer));
      static_assert(
          std::is_same_v<
              std::remove_extent_t<decltype(buffer)>,
              std::remove_extent_t<decltype(rtl_uString::buffer)>>);
  }

  // Same layout as rtl_uString (include/rtl/ustring.h):
  oslInterlockedCount refCount = 0x40000000; // SAL_STRING_STATIC_FLAG (sal/rtl/strimp.hxx)
  sal_Int32 length = N - 1;
  sal_Unicode buffer[N] = {}; //TODO: drop initialization for C++20 (P1331R2)
123};

125#if defined RTL_STRING_UNITTEST
126namespace libreoffice_internal {
127template<std::size_t N> struct ExceptConstCharArrayDetector<OUStringLiteral<N>> {};
128template<std::size_t N> struct ExceptCharArrayDetector<OUStringLiteral<N>> {};
129}
130#endif

132/// @endcond
133#endif

135/* ======================================================================= */

137/**
This String class provides base functionality for C++ like Unicode
character array handling. The advantage of this class is that it
handles all the memory management for you - and it does it
more efficiently. If you assign a string to another string, the
data of both strings are shared (without any copy operation or
memory allocation) as long as you do not change the string. This class
also stores the length of the string, so that many operations are
faster than the C-str-functions.

This class provides only readonly string handling. So you could create
a string and you could only query the content from this string.
It provides also functionality to change the string, but this results
in every case in a new string instance (in the most cases with a
memory allocation). You don't have functionality to change the
content of the string. If you want to change the string content, then
you should use the OStringBuffer class, which provides these
functionalities and avoids too much memory allocation.

The design of this class is similar to the string classes in Java so
less people should have understanding problems when they use this class.
158*/

160class SAL_WARN_UNUSED__attribute__((warn_unused)) SAL_DLLPUBLIC_RTTI__attribute__ ((type_visibility("default"))) OUString
161{
162public:
  /// @cond INTERNAL
  rtl_uString * pData;
  /// @endcond

  /**
    New string containing no characters.
  */
  OUString()
  {
      pData = NULL__null;
      rtl_uString_new( &pData );
  }

  /**
    New string from OUString.

    @param    str         an OUString.
  */
  OUString( const OUString & str )
  {
      pData = str.pData;
      rtl_uString_acquire( pData );
  }

187#if defined LIBO_INTERNAL_ONLY1
  /**
    Move constructor.

    @param    str         an OUString.
    @since LibreOffice 5.2
  */
  OUString( OUString && str ) noexcept
  {
      pData = str.pData;
      str.pData = nullptr;
      rtl_uString_new( &str.pData );
  }
200#endif

  /**
    New string from OUString data.

    @param    str         an OUString data.
  */
  OUString( rtl_uString * str )
  {
      pData = str;
      rtl_uString_acquire( pData );
  }

  /** New OUString from OUString data without acquiring it.  Takeover of ownership.

      The SAL_NO_ACQUIRE dummy parameter is only there to distinguish this
      from other constructors.

      @param str
             OUString data
  */
  OUString( rtl_uString * str, __sal_NoAcquire )
      { pData = str; }

  /**
    New string from a single Unicode character.

    @param    value       a Unicode character.
  */
  explicit OUString( sal_Unicode value )
      : pData (NULL__null)
  {
      rtl_uString_newFromStr_WithLength( &pData, &value, 1 );
  }

235#if defined LIBO_INTERNAL_ONLY1 && !defined RTL_STRING_UNITTEST_CONCAT
  /// @cond INTERNAL
  // Catch inadvertent conversions to the above ctor (but still allow
  // construction from char literals):
  OUString(int) = delete;
  explicit OUString(char c):
      OUString(sal_Unicode(static_cast<unsigned char>(c)))
  {}
  /// @endcond
244#endif

246#if defined LIBO_INTERNAL_ONLY1

  template<typename T> explicit OUString(
      T const & value,
      typename libreoffice_internal::CharPtrDetector<T, libreoffice_internal::Dummy>::TypeUtf16
          = libreoffice_internal::Dummy()):
      pData(nullptr)
  { rtl_uString_newFromStr(&pData, value); }

  template<typename T> explicit OUString(
      T & value,
      typename
      libreoffice_internal::NonConstCharArrayDetector<T, libreoffice_internal::Dummy>::TypeUtf16
          = libreoffice_internal::Dummy()):
      pData(nullptr)
  { rtl_uString_newFromStr(&pData, value); }

263#else

  /**
    New string from a Unicode character buffer array.

    @param    value       a NULL-terminated Unicode character array.
  */
  OUString( const sal_Unicode * value )
  {
      pData = NULL__null;
      rtl_uString_newFromStr( &pData, value );
  }

276#endif

  /**
    New string from a Unicode character buffer array.

    @param    value       a Unicode character array.
    @param    length      the number of character which should be copied.
                          The character array length must be greater than
                          or equal to this value.
  */
  OUString( const sal_Unicode * value, sal_Int32 length )
  {
      pData = NULL__null;
      rtl_uString_newFromStr_WithLength( &pData, value, length );
  }

  /**
    New string from an 8-Bit string literal that is expected to contain only
    characters in the ASCII set (i.e. first 128 characters). This constructor
    allows an efficient and convenient way to create OUString
    instances from ASCII literals. When creating strings from data that
    is not pure ASCII, it needs to be converted to OUString by explicitly
    providing the encoding to use for the conversion.

    If there are any embedded \0's in the string literal, the result is undefined.
    Use the overload that explicitly accepts length.

    @param    literal         the 8-bit ASCII string literal

    @since LibreOffice 3.6
  */
  template< typename T >
  OUString( T& literal, typename libreoffice_internal::ConstCharArrayDetector< T, libreoffice_internal::Dummy >::Type = libreoffice_internal::Dummy() )
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 311, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 311, __extension__ __PRETTY_FUNCTION__));
      pData = NULL__null;
      if (libreoffice_internal::ConstCharArrayDetector<T>::length == 0) {
          rtl_uString_new(&pData);
      } else {
          rtl_uString_newFromLiteral(
              &pData,
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length, 0);
      }
322#ifdef RTL_STRING_UNITTEST
      rtl_string_unittest_const_literal = true;
324#endif
  }

327#if defined LIBO_INTERNAL_ONLY1
  /** @overload @since LibreOffice 5.3 */
  template<typename T> OUString(
      T & literal,
      typename libreoffice_internal::ConstCharArrayDetector<
          T, libreoffice_internal::Dummy>::TypeUtf16
              = libreoffice_internal::Dummy()):
      pData(nullptr)
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 337, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 337, __extension__ __PRETTY_FUNCTION__));
      if (libreoffice_internal::ConstCharArrayDetector<T>::length == 0) {
          rtl_uString_new(&pData);
      } else {
          rtl_uString_newFromStr_WithLength(
              &pData,
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length);
      }
  }
348#endif

350#if defined LIBO_INTERNAL_ONLY1 && defined RTL_STRING_UNITTEST
  /// @cond INTERNAL
  /**
   * Only used by unittests to detect incorrect conversions.
   * @internal
   */
  template< typename T >
  OUString( T&, typename libreoffice_internal::ExceptConstCharArrayDetector< T >::Type = libreoffice_internal::Dummy() )
  {
      pData = NULL__null;
      rtl_uString_newFromLiteral( &pData, "!!br0ken!!", 10, 0 ); // set to garbage
      rtl_string_unittest_invalid_conversion = true;
  }
  /**
   * Only used by unittests to detect incorrect conversions.
   * @internal
   */
  template< typename T >
  OUString( const T&, typename libreoffice_internal::ExceptCharArrayDetector< T >::Type = libreoffice_internal::Dummy() )
  {
      pData = NULL__null;
      rtl_uString_newFromLiteral( &pData, "!!br0ken!!", 10, 0 ); // set to garbage
      rtl_string_unittest_invalid_conversion = true;
  }
  /// @endcond
375#endif

377#ifdef LIBO_INTERNAL_ONLY1 // "RTL_FAST_STRING"
  /// @cond INTERNAL
  /**
    New string from a string literal.

    @since LibreOffice 5.0
  */
  template<std::size_t N> OUString(OUStringLiteral<N> const & literal):
      pData(const_cast<rtl_uString *>(reinterpret_cast<rtl_uString const *>(&literal))) {}
  template<std::size_t N> OUString(OUStringLiteral<N> &&) = delete;
  /// @endcond
388#endif

  /**
    New string from an 8-Bit character buffer array.

    @param    value           An 8-Bit character array.
    @param    length          The number of character which should be converted.
                              The 8-Bit character array length must be
                              greater than or equal to this value.
    @param    encoding        The text encoding from which the 8-Bit character
                              sequence should be converted.
    @param    convertFlags    Flags which control the conversion.
                              see RTL_TEXTTOUNICODE_FLAGS_...

    @exception std::bad_alloc is thrown if an out-of-memory condition occurs
  */
  OUString( const char * value, sal_Int32 length,
            rtl_TextEncoding encoding,
            sal_uInt32 convertFlags = OSTRING_TO_OUSTRING_CVTFLAGS(((sal_uInt32)0x0003) | ((sal_uInt32)0x0030) | ((sal_uInt32)0x0300
)) )
  {
      pData = NULL__null;
      rtl_string2UString( &pData, value, length, encoding, convertFlags );
      if (pData == NULL__null) {
          throw std::bad_alloc();
      }
  }

  /** Create a new string from an array of Unicode code points.

      @param codePoints
      an array of at least codePointCount code points, which each must be in
      the range from 0 to 0x10FFFF, inclusive.  May be null if codePointCount
      is zero.

      @param codePointCount
      the non-negative number of code points.

      @exception std::bad_alloc
      is thrown if either an out-of-memory condition occurs or the resulting
      number of UTF-16 code units would have been larger than SAL_MAX_INT32.

      @since UDK 3.2.7
  */
  explicit OUString(
      sal_uInt32 const * codePoints, sal_Int32 codePointCount):
      pData(NULL__null)
  {
      rtl_uString_newFromCodePoints(&pData, codePoints, codePointCount);
      if (pData == NULL__null) {
          throw std::bad_alloc();
      }
  }

441#ifdef LIBO_INTERNAL_ONLY1 // "RTL_FAST_STRING"
  /**
   @overload
   @internal
  */
  template< typename T1, typename T2 >
  OUString( OUStringConcat< T1, T2 >&& c )
  {
      const sal_Int32 l = c.length();
      pData = rtl_uString_alloc( l );
      if (l != 0)
      {
          sal_Unicode* end = c.addData( pData->buffer );
          pData->length = l;
          *end = '\0';
          // TODO realloc in case pData->length is noticeably smaller than l?
      }
  }

  /**
   @overload
   @internal
  */
  template< typename T >
  OUString( OUStringNumber< T >&& n )
      : OUString( n.buf, n.length )
  {}
468#endif

470#if defined LIBO_INTERNAL_ONLY1
  OUString(std::u16string_view sv) {
      if (sv.size() > sal_uInt32(std::numeric_limits<sal_Int32>::max())) {
          throw std::bad_alloc();
      }
      pData = nullptr;
      rtl_uString_newFromStr_WithLength(&pData, sv.data(), sv.size());
  }
478#endif

  /**
    Release the string data.
  */
  ~OUString()
  {
      rtl_uString_release( pData );
  }

  /** Provides an OUString const & passing a storage pointer of an
      rtl_uString * handle.
      It is more convenient to use C++ OUString member functions when dealing
      with rtl_uString * handles.  Using this function avoids unnecessary
      acquire()/release() calls for a temporary OUString object.

      @param ppHandle
             pointer to storage
      @return
             OUString const & based on given storage
  */
  static OUString const & unacquired( rtl_uString * const * ppHandle )
      { return * reinterpret_cast< OUString const * >( ppHandle ); }

  /**
    Assign a new string.

    @param    str         an OUString.
  */
  OUString & operator=( const OUString & str )
  {
      rtl_uString_assign( &pData, str.pData );
      return *this;
  }

513#if defined LIBO_INTERNAL_ONLY1
  /**
    Move assign a new string.

    @param    str         an OUString.
    @since LibreOffice 5.2
  */
  OUString & operator=( OUString && str ) noexcept
  {
      rtl_uString_release( pData );
      pData = str.pData;
      str.pData = nullptr;
      rtl_uString_new( &str.pData );
      return *this;
  }
528#endif

  /**
    Assign a new string from an 8-Bit string literal that is expected to contain only
    characters in the ASCII set (i.e. first 128 characters). This operator
    allows an efficient and convenient way to assign OUString
    instances from ASCII literals. When assigning strings from data that
    is not pure ASCII, it needs to be converted to OUString by explicitly
    providing the encoding to use for the conversion.

    @param    literal         the 8-bit ASCII string literal

    @since LibreOffice 3.6
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, OUString& >::Type operator=( T& literal )
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 546, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 546, __extension__ __PRETTY_FUNCTION__));
      if (libreoffice_internal::ConstCharArrayDetector<T>::length == 0) {
          rtl_uString_new(&pData);
      } else {
          rtl_uString_newFromLiteral(
              &pData,
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length, 0);
      }
      return *this;
  }

559#if defined LIBO_INTERNAL_ONLY1
  /** @overload @since LibreOffice 5.3 */
  template<typename T>
  typename
      libreoffice_internal::ConstCharArrayDetector<T, OUString &>::TypeUtf16
  operator =(T & literal) {
      if (libreoffice_internal::ConstCharArrayDetector<T>::length == 0) {
          rtl_uString_new(&pData);
      } else {
          rtl_uString_newFromStr_WithLength(
              &pData,
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length);
      }
      return *this;
  }

  /** @overload @since LibreOffice 5.4 */
  template<std::size_t N> OUString & operator =(OUStringLiteral<N> const & literal) {
      if (literal.getLength() == 0) {
          rtl_uString_new(&pData);
      } else {
          rtl_uString_newFromStr_WithLength(&pData, literal.getStr(), literal.getLength());
      }
      return *this;
  }

  template<typename T>
  OUString & operator =(OUStringNumber<T> && n) {
      // n.length should never be zero, so no need to add an optimization for that case
      rtl_uString_newFromStr_WithLength(&pData, n.buf, n.length);
      return *this;
  }

  OUString & operator =(std::u16string_view sv) {
      if (sv.empty()) {
          rtl_uString_new(&pData);
      } else {
          rtl_uString_newFromStr_WithLength(&pData, sv.data(), sv.size());
      }
      return *this;
  }
602#endif

604#if defined LIBO_INTERNAL_ONLY1
  /**
    Append the contents of an OUStringBuffer to this string.

    @param    str         an OUStringBuffer.

    @exception std::bad_alloc is thrown if an out-of-memory condition occurs
    @since LibreOffice 6.2
  */
  inline OUString & operator+=( const OUStringBuffer & str ) &;
614#endif

  /**
    Append a string to this string.

    @param    str         an OUString.

    @exception std::bad_alloc is thrown if an out-of-memory condition occurs
  */
  OUString & operator+=( const OUString & str )
624#if defined LIBO_INTERNAL_ONLY1
      &
626#endif
  {
      return internalAppend(str.pData);
  }
630#if defined LIBO_INTERNAL_ONLY1
  void operator+=(OUString const &) && = delete;
632#endif

  /** Append an ASCII string literal to this string.

      @param literal  an 8-bit ASCII-only string literal

      @since LibreOffice 5.1
  */
  template<typename T>
  typename libreoffice_internal::ConstCharArrayDetector<T, OUString &>::Type
  operator +=(T & literal)
643#if defined LIBO_INTERNAL_ONLY1
      &
645#endif
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 648, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 648, __extension__ __PRETTY_FUNCTION__));
      rtl_uString_newConcatAsciiL(
          &pData, pData,
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(literal),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
      return *this;
  }
655#if defined LIBO_INTERNAL_ONLY1
  template<typename T>
  typename libreoffice_internal::ConstCharArrayDetector<T, OUString &>::Type
  operator +=(T &) && = delete;
659#endif

661#if defined LIBO_INTERNAL_ONLY1
  /** @overload @since LibreOffice 5.3 */
  template<typename T>
  typename
      libreoffice_internal::ConstCharArrayDetector<T, OUString &>::TypeUtf16
  operator +=(T & literal) & {
      rtl_uString_newConcatUtf16L(
          &pData, pData,
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(literal),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
      return *this;
  }
  template<typename T>
  typename
      libreoffice_internal::ConstCharArrayDetector<T, OUString &>::TypeUtf16
  operator +=(T &) && = delete;

  /** @overload @since LibreOffice 5.4 */
  template<std::size_t N> OUString & operator +=(OUStringLiteral<N> const & literal) & {
      rtl_uString_newConcatUtf16L(&pData, pData, literal.getStr(), literal.getLength());
      return *this;
  }
  template<std::size_t N> void operator +=(OUStringLiteral<N> const &) && = delete;

  OUString & operator +=(std::u16string_view sv) & {
      if (sv.size() > sal_uInt32(std::numeric_limits<sal_Int32>::max())) {
          throw std::bad_alloc();
      }
      rtl_uString_newConcatUtf16L(&pData, pData, sv.data(), sv.size());
      return *this;
  }
  void operator +=(std::u16string_view) && = delete;
693#endif

695#ifdef LIBO_INTERNAL_ONLY1 // "RTL_FAST_STRING"
  /**
   @overload
   @internal
  */
  template< typename T1, typename T2 >
  OUString& operator+=( OUStringConcat< T1, T2 >&& c ) & {
      sal_Int32 l = c.length();
      if( l == 0 )
          return *this;
      l += pData->length;
      rtl_uString_ensureCapacity( &pData, l );
      sal_Unicode* end = c.addData( pData->buffer + pData->length );
      *end = '\0';
      pData->length = l;
      return *this;
  }
  template<typename T1, typename T2> void operator +=(
      OUStringConcat<T1, T2> &&) && = delete;

  /**
   @overload
   @internal
  */
  template< typename T >
  OUString& operator+=( OUStringNumber< T >&& n ) & {
      sal_Int32 l = n.length;
      if( l == 0 )
          return *this;
      l += pData->length;
      rtl_uString_ensureCapacity( &pData, l );
      sal_Unicode* end = addDataHelper( pData->buffer + pData->length, n.buf, n.length );
      *end = '\0';
      pData->length = l;
      return *this;
  }
  template<typename T> void operator +=(
      OUStringNumber<T> &&) && = delete;
733#endif

  /**
    Clears the string, i.e, makes a zero-character string
    @since LibreOffice 4.4
  */
  void clear()
  {
      rtl_uString_new( &pData );
  }

  /**
    Returns the length of this string.

    The length is equal to the number of Unicode characters in this string.

    @return   the length of the sequence of characters represented by this
              object.
  */
  sal_Int32 getLength() const { return pData->length; }

  /**
    Checks if a string is empty.

    @return   true if the string is empty;
              false, otherwise.

    @since LibreOffice 3.4
  */
  bool isEmpty() const
  {
      return pData->length == 0;
  }

  /**
    Returns a pointer to the Unicode character buffer for this string.

    It isn't necessarily NULL terminated.

    @return   a pointer to the Unicode characters buffer for this object.
  */
  const sal_Unicode * getStr() const SAL_RETURNS_NONNULL__attribute__((returns_nonnull)) { return pData->buffer; }

  /**
    Access to individual characters.

    @param index must be non-negative and less than length.

    @return the character at the given index.

    @since LibreOffice 3.5
  */
  sal_Unicode operator [](sal_Int32 index) const {
      // silence spurious -Werror=strict-overflow warnings from GCC 4.8.2
      assert(index >= 0 && static_cast<sal_uInt32>(index) < static_cast<sal_uInt32>(getLength()))(static_cast <bool> (index >= 0 && static_cast
<sal_uInt32>(index) < static_cast<sal_uInt32>(
getLength())) ? void (0) : __assert_fail ("index >= 0 && static_cast<sal_uInt32>(index) < static_cast<sal_uInt32>(getLength())"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 787, __extension__ __PRETTY_FUNCTION__));
      return getStr()[index];
  }

  /**
    Compares two strings.

    The comparison is based on the numeric value of each character in
    the strings and return a value indicating their relationship.
    This function can't be used for language specific sorting.

    @param    str         the object to be compared.
    @return   0 - if both strings are equal
              < 0 - if this string is less than the string argument
              > 0 - if this string is greater than the string argument
  */
  sal_Int32 compareTo( const OUString & str ) const
  {
      return rtl_ustr_compare_WithLength( pData->buffer, pData->length,
                                          str.pData->buffer, str.pData->length );
  }

  /**
    Compares two strings with a maximum count of characters.

    The comparison is based on the numeric value of each character in
    the strings and return a value indicating their relationship.
    This function can't be used for language specific sorting.

    @param    str         the object to be compared.
    @param    maxLength   the maximum count of characters to be compared.
    @return   0 - if both strings are equal
              < 0 - if this string is less than the string argument
              > 0 - if this string is greater than the string argument

    @since UDK 3.2.7
  */
  sal_Int32 compareTo( const OUString & str, sal_Int32 maxLength ) const
  {
      return rtl_ustr_shortenedCompare_WithLength( pData->buffer, pData->length,
                                                   str.pData->buffer, str.pData->length, maxLength );
  }

  /**
    Compares two strings in reverse order.

    The comparison is based on the numeric value of each character in
    the strings and return a value indicating their relationship.
    This function can't be used for language specific sorting.

    @param    str         the object to be compared.
    @return   0 - if both strings are equal
              < 0 - if this string is less than the string argument
              > 0 - if this string is greater than the string argument
  */
842#if defined LIBO_INTERNAL_ONLY1
  sal_Int32 reverseCompareTo(std::u16string_view sv) const {
      return rtl_ustr_reverseCompare_WithLength(
          pData->buffer, pData->length, sv.data(), sv.size());
  }
847#else
  sal_Int32 reverseCompareTo( const OUString & str ) const
  {
      return rtl_ustr_reverseCompare_WithLength( pData->buffer, pData->length,
                                                 str.pData->buffer, str.pData->length );
  }
853#endif

  /**
   @overload
   This function accepts an ASCII string literal as its argument.
   @since LibreOffice 4.1
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, sal_Int32 >::Type reverseCompareTo( T& literal ) const
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 864, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 864, __extension__ __PRETTY_FUNCTION__));
      return rtl_ustr_asciil_reverseCompare_WithLength(
          pData->buffer, pData->length,
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(literal),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
  }

  /**
    Perform a comparison of two strings.

    The result is true if and only if second string
    represents the same sequence of characters as the first string.
    This function can't be used for language specific comparison.

    @param    str         the object to be compared.
    @return   true if the strings are equal;
              false, otherwise.
  */
  bool equals( const OUString & str ) const
  {
      if ( pData->length != str.pData->length )
          return false;
      if ( pData == str.pData )
          return true;
      return rtl_ustr_reverseCompare_WithLength( pData->buffer, pData->length,
                                                 str.pData->buffer, str.pData->length ) == 0;
  }

  /**
    Perform an ASCII lowercase comparison of two strings.

    The result is true if and only if second string
    represents the same sequence of characters as the first string,
    ignoring the case.
    Character values between 65 and 90 (ASCII A-Z) are interpreted as
    values between 97 and 122 (ASCII a-z).
    This function can't be used for language specific comparison.

    @param    str         the object to be compared.
    @return   true if the strings are equal;
              false, otherwise.
  */
906#if defined LIBO_INTERNAL_ONLY1
  bool equalsIgnoreAsciiCase(std::u16string_view sv) const {
      return
          rtl_ustr_compareIgnoreAsciiCase_WithLength(
              pData->buffer, pData->length, sv.data(), sv.size())
          == 0;
  }
913#else
  bool equalsIgnoreAsciiCase( const OUString & str ) const
  {
      if ( pData->length != str.pData->length )
          return false;
      if ( pData == str.pData )
          return true;
      return rtl_ustr_compareIgnoreAsciiCase_WithLength( pData->buffer, pData->length,
                                                         str.pData->buffer, str.pData->length ) == 0;
  }
923#endif

  /**
    Perform an ASCII lowercase comparison of two strings.

    Compare the two strings with uppercase ASCII
    character values between 65 and 90 (ASCII A-Z) interpreted as
    values between 97 and 122 (ASCII a-z).
    This function can't be used for language specific comparison.

    @param    str         the object to be compared.
    @return   0 - if both strings are equal
              < 0 - if this string is less than the string argument
              > 0 - if this string is greater than the string argument

    @since LibreOffice 4.0
  */
940#if defined LIBO_INTERNAL_ONLY1
  sal_Int32 compareToIgnoreAsciiCase(std::u16string_view sv) const {
      return rtl_ustr_compareIgnoreAsciiCase_WithLength(
          pData->buffer, pData->length, sv.data(), sv.size());
  }
945#else
  sal_Int32 compareToIgnoreAsciiCase( const OUString & str ) const
  {
      return rtl_ustr_compareIgnoreAsciiCase_WithLength( pData->buffer, pData->length,
                                                         str.pData->buffer, str.pData->length );
  }
951#endif

  /**
   @overload
   This function accepts an ASCII string literal as its argument.
   @since LibreOffice 3.6
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type equalsIgnoreAsciiCase( T& literal ) const
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 962, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 962, __extension__ __PRETTY_FUNCTION__));
      return
          (pData->length
           == libreoffice_internal::ConstCharArrayDetector<T>::length)
          && (rtl_ustr_ascii_compareIgnoreAsciiCase_WithLength(
                  pData->buffer, pData->length,
                  libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                      literal))
              == 0);
  }

 /**
    Match against a substring appearing in this string.

    The result is true if and only if the second string appears as a substring
    of this string, at the given position.
    This function can't be used for language specific comparison.

    @param    str         the object (substring) to be compared.
    @param    fromIndex   the index to start the comparison from.
                          The index must be greater than or equal to 0
                          and less or equal as the string length.
    @return   true if str match with the characters in the string
              at the given position;
              false, otherwise.
  */
988#if defined LIBO_INTERNAL_ONLY1
  bool match(std::u16string_view sv, sal_Int32 fromIndex = 0) const {
      return
          rtl_ustr_shortenedCompare_WithLength(
              pData->buffer + fromIndex, pData->length - fromIndex, sv.data(), sv.size(),
              sv.size())
          == 0;
  }
996#else
  bool match( const OUString & str, sal_Int32 fromIndex = 0 ) const
  {
      return rtl_ustr_shortenedCompare_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
                                                   str.pData->buffer, str.pData->length, str.pData->length ) == 0;
  }
1002#endif

  /**
   @overload
   This function accepts an ASCII string literal as its argument.
   @since LibreOffice 3.6
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type match( T& literal, sal_Int32 fromIndex = 0 ) const
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1013, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1013, __extension__ __PRETTY_FUNCTION__));
      return
          rtl_ustr_ascii_shortenedCompare_WithLength(
              pData->buffer+fromIndex, pData->length-fromIndex,
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length)
          == 0;
  }

  /**
    Match against a substring appearing in this string, ignoring the case of
    ASCII letters.

    The result is true if and only if the second string appears as a substring
    of this string, at the given position.
    Character values between 65 and 90 (ASCII A-Z) are interpreted as
    values between 97 and 122 (ASCII a-z).
    This function can't be used for language specific comparison.

    @param    str         the object (substring) to be compared.
    @param    fromIndex   the index to start the comparison from.
                          The index must be greater than or equal to 0
                          and less than or equal to the string length.
    @return   true if str match with the characters in the string
              at the given position;
              false, otherwise.
  */
1041#if defined LIBO_INTERNAL_ONLY1
  bool matchIgnoreAsciiCase(std::u16string_view sv, sal_Int32 fromIndex = 0) const {
      return
          rtl_ustr_shortenedCompareIgnoreAsciiCase_WithLength(
              pData->buffer + fromIndex, pData->length - fromIndex, sv.data(), sv.size(),
              sv.size())
          == 0;
  }
1049#else
  bool matchIgnoreAsciiCase( const OUString & str, sal_Int32 fromIndex = 0 ) const
  {
      return rtl_ustr_shortenedCompareIgnoreAsciiCase_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
                                                                  str.pData->buffer, str.pData->length,
                                                                  str.pData->length ) == 0;
  }
1056#endif

  /**
   @overload
   This function accepts an ASCII string literal as its argument.
   @since LibreOffice 3.6
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type matchIgnoreAsciiCase( T& literal, sal_Int32 fromIndex = 0 ) const
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1067, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1067, __extension__ __PRETTY_FUNCTION__));
      return
          rtl_ustr_ascii_shortenedCompareIgnoreAsciiCase_WithLength(
              pData->buffer+fromIndex, pData->length-fromIndex,
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length)
          == 0;
  }

  /**
    Compares two strings.

    The comparison is based on the numeric value of each character in
    the strings and return a value indicating their relationship.
    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated.
    This function can't be used for language specific sorting.

    @param  asciiStr      the 8-Bit ASCII character string to be compared.
    @return   0 - if both strings are equal
              < 0 - if this string is less than the string argument
              > 0 - if this string is greater than the string argument
  */
  sal_Int32 compareToAscii( const char* asciiStr ) const
  {
      return rtl_ustr_ascii_compare_WithLength( pData->buffer, pData->length, asciiStr );
  }

  /**
    Compares two strings with a maximum count of characters.

    The comparison is based on the numeric value of each character in
    the strings and return a value indicating their relationship.
    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated.
    This function can't be used for language specific sorting.

    @deprecated  This is a confusing overload with unexpectedly different
    semantics from the one-parameter form, so it is marked as deprecated.
    Practically all uses compare the return value against zero and can thus
    be replaced with uses of startsWith.

    @param  asciiStr          the 8-Bit ASCII character string to be compared.
    @param  maxLength         the maximum count of characters to be compared.
    @return   0 - if both strings are equal
              < 0 - if this string is less than the string argument
              > 0 - if this string is greater than the string argument
  */
  SAL_DEPRECATED(__attribute__((deprecated("replace s1.compareToAscii(s2, strlen(s2)) == 0 with s1.startsWith(s2)"
)))
      "replace s1.compareToAscii(s2, strlen(s2)) == 0 with s1.startsWith(s2)")__attribute__((deprecated("replace s1.compareToAscii(s2, strlen(s2)) == 0 with s1.startsWith(s2)"
)))
  sal_Int32 compareToAscii( const char * asciiStr, sal_Int32 maxLength ) const
  {
      return rtl_ustr_ascii_shortenedCompare_WithLength( pData->buffer, pData->length,
                                                         asciiStr, maxLength );
  }

  /**
    Compares two strings in reverse order.

    This could be useful, if normally both strings start with the same
    content. The comparison is based on the numeric value of each character
    in the strings and return a value indicating their relationship.
    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated and must be greater than
    or equal to asciiStrLength.
    This function can't be used for language specific sorting.

    @param    asciiStr        the 8-Bit ASCII character string to be compared.
    @param    asciiStrLength  the length of the ascii string
    @return   0 - if both strings are equal
              < 0 - if this string is less than the string argument
              > 0 - if this string is greater than the string argument
  */
  sal_Int32 reverseCompareToAsciiL( const char * asciiStr, sal_Int32 asciiStrLength ) const
  {
      return rtl_ustr_asciil_reverseCompare_WithLength( pData->buffer, pData->length,
                                                        asciiStr, asciiStrLength );
  }

  /**
    Perform a comparison of two strings.

    The result is true if and only if second string
    represents the same sequence of characters as the first string.
    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated.
    This function can't be used for language specific comparison.

    @param    asciiStr        the 8-Bit ASCII character string to be compared.
    @return   true if the strings are equal;
              false, otherwise.
  */
  bool equalsAscii( const char* asciiStr ) const
  {
      return rtl_ustr_ascii_compare_WithLength( pData->buffer, pData->length,
                                                asciiStr ) == 0;
  }

  /**
    Perform a comparison of two strings.

    The result is true if and only if second string
    represents the same sequence of characters as the first string.
    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated and must be greater than
    or equal to asciiStrLength.
    This function can't be used for language specific comparison.

    @param    asciiStr         the 8-Bit ASCII character string to be compared.
    @param    asciiStrLength   the length of the ascii string
    @return   true if the strings are equal;
              false, otherwise.
  */
  bool equalsAsciiL( const char* asciiStr, sal_Int32 asciiStrLength ) const
  {
      if ( pData->length != asciiStrLength )
5
←
Assuming 'asciiStrLength' is not equal to field 'length'→
6
←
Taking true branch→
16
←
Assuming 'asciiStrLength' is not equal to field 'length'→
17
←
Taking true branch→
27
←
Assuming 'asciiStrLength' is equal to field 'length'→
28
←
Taking false branch→
          return false;
7
←
Returning zero, which participates in a condition later→
18
←
Returning zero, which participates in a condition later→

      return rtl_ustr_asciil_reverseEquals_WithLength(
29
←
Returning value, which participates in a condition later→
                  pData->buffer, asciiStr, asciiStrLength );
  }

  /**
    Perform an ASCII lowercase comparison of two strings.

    The result is true if and only if second string
    represents the same sequence of characters as the first string,
    ignoring the case.
    Character values between 65 and 90 (ASCII A-Z) are interpreted as
    values between 97 and 122 (ASCII a-z).
    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated.
    This function can't be used for language specific comparison.

    @param    asciiStr        the 8-Bit ASCII character string to be compared.
    @return   true if the strings are equal;
              false, otherwise.
  */
  bool equalsIgnoreAsciiCaseAscii( const char * asciiStr ) const
  {
      return rtl_ustr_ascii_compareIgnoreAsciiCase_WithLength( pData->buffer, pData->length, asciiStr ) == 0;
  }

  /**
    Compares two ASCII strings ignoring case

    The comparison is based on the numeric value of each character in
    the strings and return a value indicating their relationship.
    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated.
    This function can't be used for language specific sorting.

    @param  asciiStr      the 8-Bit ASCII character string to be compared.
    @return   0 - if both strings are equal
              < 0 - if this string is less than the string argument
              > 0 - if this string is greater than the string argument

    @since LibreOffice 3.5
  */
  sal_Int32 compareToIgnoreAsciiCaseAscii( const char * asciiStr ) const
  {
      return rtl_ustr_ascii_compareIgnoreAsciiCase_WithLength( pData->buffer, pData->length, asciiStr );
  }

  /**
    Perform an ASCII lowercase comparison of two strings.

    The result is true if and only if second string
    represents the same sequence of characters as the first string,
    ignoring the case.
    Character values between 65 and 90 (ASCII A-Z) are interpreted as
    values between 97 and 122 (ASCII a-z).
    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated and must be greater than
    or equal to asciiStrLength.
    This function can't be used for language specific comparison.

    @param    asciiStr        the 8-Bit ASCII character string to be compared.
    @param    asciiStrLength  the length of the ascii string
    @return   true if the strings are equal;
              false, otherwise.
  */
  bool equalsIgnoreAsciiCaseAsciiL( const char * asciiStr, sal_Int32 asciiStrLength ) const
  {
      if ( pData->length != asciiStrLength )
          return false;

      return rtl_ustr_ascii_compareIgnoreAsciiCase_WithLength( pData->buffer, pData->length, asciiStr ) == 0;
  }

  /**
    Match against a substring appearing in this string.

    The result is true if and only if the second string appears as a substring
    of this string, at the given position.
    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated and must be greater than or
    equal to asciiStrLength.
    This function can't be used for language specific comparison.

    @param    asciiStr    the object (substring) to be compared.
    @param    asciiStrLength the length of asciiStr.
    @param    fromIndex   the index to start the comparison from.
                          The index must be greater than or equal to 0
                          and less than or equal to the string length.
    @return   true if str match with the characters in the string
              at the given position;
              false, otherwise.
  */
  bool matchAsciiL( const char* asciiStr, sal_Int32 asciiStrLength, sal_Int32 fromIndex = 0 ) const
  {
      return rtl_ustr_ascii_shortenedCompare_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
                                                         asciiStr, asciiStrLength ) == 0;
  }

  // This overload is left undefined, to detect calls of matchAsciiL that
  // erroneously use RTL_CONSTASCII_USTRINGPARAM instead of
  // RTL_CONSTASCII_STRINGPARAM (but would lead to ambiguities on 32 bit
  // platforms):
1305#if SAL_TYPES_SIZEOFLONG8 == 8
  void matchAsciiL(char const *, sal_Int32, rtl_TextEncoding) const;
1307#endif

  /**
    Match against a substring appearing in this string, ignoring the case of
    ASCII letters.

    The result is true if and only if the second string appears as a substring
    of this string, at the given position.
    Character values between 65 and 90 (ASCII A-Z) are interpreted as
    values between 97 and 122 (ASCII a-z).
    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated and must be greater than or
    equal to asciiStrLength.
    This function can't be used for language specific comparison.

    @param    asciiStr        the 8-Bit ASCII character string to be compared.
    @param    asciiStrLength  the length of the ascii string
    @param    fromIndex       the index to start the comparison from.
                              The index must be greater than or equal to 0
                              and less than or equal to the string length.
    @return   true if str match with the characters in the string
              at the given position;
              false, otherwise.
  */
  bool matchIgnoreAsciiCaseAsciiL( const char* asciiStr, sal_Int32 asciiStrLength, sal_Int32 fromIndex = 0 ) const
  {
      return rtl_ustr_ascii_shortenedCompareIgnoreAsciiCase_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
                                                                        asciiStr, asciiStrLength ) == 0;
  }

  // This overload is left undefined, to detect calls of
  // matchIgnoreAsciiCaseAsciiL that erroneously use
  // RTL_CONSTASCII_USTRINGPARAM instead of RTL_CONSTASCII_STRINGPARAM (but
  // would lead to ambiguities on 32 bit platforms):
1343#if SAL_TYPES_SIZEOFLONG8 == 8
  void matchIgnoreAsciiCaseAsciiL(char const *, sal_Int32, rtl_TextEncoding)
      const;
1346#endif

  /**
    Check whether this string starts with a given substring.

    @param str the substring to be compared

    @param rest if non-null, and this function returns true, then assign a
    copy of the remainder of this string to *rest. Available since
    LibreOffice 4.2

    @return true if and only if the given str appears as a substring at the
    start of this string

    @since LibreOffice 4.0
  */
1362#if defined LIBO_INTERNAL_ONLY1
  bool startsWith(std::u16string_view sv, OUString * rest = nullptr) const {
      auto const b = match(sv);
      if (b && rest != nullptr) {
          *rest = copy(sv.size());
      }
      return b;
  }
1370#else
  bool startsWith(OUString const & str, OUString * rest = NULL__null) const {
      bool b = match(str);
      if (b && rest != NULL__null) {
          *rest = copy(str.getLength());
      }
      return b;
  }
1378#endif

  /**
   @overload
   This function accepts an ASCII string literal as its argument.
   @since LibreOffice 4.0
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type startsWith(
      T & literal, OUString * rest = NULL__null) const
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1390, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1390, __extension__ __PRETTY_FUNCTION__));
      bool b
          = (libreoffice_internal::ConstCharArrayDetector<T>::length
             <= sal_uInt32(pData->length))
          && rtl_ustr_asciil_reverseEquals_WithLength(
              pData->buffer,
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length);
      if (b && rest != NULL__null) {
          *rest = copy(
              libreoffice_internal::ConstCharArrayDetector<T>::length);
      }
      return b;
  }

  /**
    Check whether this string starts with a given string, ignoring the case of
    ASCII letters.

    Character values between 65 and 90 (ASCII A-Z) are interpreted as
    values between 97 and 122 (ASCII a-z).
    This function can't be used for language specific comparison.

    @param str the substring to be compared

    @param rest if non-null, and this function returns true, then assign a
    copy of the remainder of this string to *rest. Available since
    LibreOffice 4.2

    @return true if and only if the given str appears as a substring at the
    start of this string, ignoring the case of ASCII letters ("A"--"Z" and
    "a"--"z")

    @since LibreOffice 4.0
  */
1426#if defined LIBO_INTERNAL_ONLY1
  bool startsWithIgnoreAsciiCase(std::u16string_view sv, OUString * rest = nullptr) const {
      auto const b = matchIgnoreAsciiCase(sv);
      if (b && rest != nullptr) {
          *rest = copy(sv.size());
      }
      return b;
  }
1434#else
  bool startsWithIgnoreAsciiCase(OUString const & str, OUString * rest = NULL__null)
      const
  {
      bool b = matchIgnoreAsciiCase(str);
      if (b && rest != NULL__null) {
          *rest = copy(str.getLength());
      }
      return b;
  }
1444#endif

  /**
   @overload
   This function accepts an ASCII string literal as its argument.
   @since LibreOffice 4.0
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type
  startsWithIgnoreAsciiCase(T & literal, OUString * rest = NULL__null) const
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1456, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1456, __extension__ __PRETTY_FUNCTION__));
      bool b
          = (rtl_ustr_ascii_compareIgnoreAsciiCase_WithLengths(
                 pData->buffer,
                 libreoffice_internal::ConstCharArrayDetector<T>::length,
                 libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                     literal),
                 libreoffice_internal::ConstCharArrayDetector<T>::length)
             == 0);
      if (b && rest != NULL__null) {
          *rest = copy(
              libreoffice_internal::ConstCharArrayDetector<T>::length);
      }
      return b;
  }

  /**
    Check whether this string ends with a given substring.

    @param str the substring to be compared

    @param rest if non-null, and this function returns true, then assign a
    copy of the remainder of this string to *rest. Available since
    LibreOffice 4.2

    @return true if and only if the given str appears as a substring at the
    end of this string

    @since LibreOffice 3.6
  */
1486#if defined LIBO_INTERNAL_ONLY1
  bool endsWith(std::u16string_view sv, OUString * rest = nullptr) const {
      auto const b = sv.size() <= sal_uInt32(pData->length)
          && match(sv, pData->length - sv.size());
      if (b && rest != nullptr) {
          *rest = copy(0, (pData->length - sv.size()));
      }
      return b;
  }
1495#else
  bool endsWith(OUString const & str, OUString * rest = NULL__null) const {
      bool b = str.getLength() <= getLength()
          && match(str, getLength() - str.getLength());
      if (b && rest != NULL__null) {
          *rest = copy(0, getLength() - str.getLength());
      }
      return b;
  }
1504#endif

  /**
   @overload
   This function accepts an ASCII string literal as its argument.
   @since LibreOffice 3.6
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type
  endsWith(T & literal, OUString * rest = NULL__null) const
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1516, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1516, __extension__ __PRETTY_FUNCTION__));
      bool b
          = (libreoffice_internal::ConstCharArrayDetector<T>::length
             <= sal_uInt32(pData->length))
          && rtl_ustr_asciil_reverseEquals_WithLength(
              (pData->buffer + pData->length
               - libreoffice_internal::ConstCharArrayDetector<T>::length),
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length);
      if (b && rest != NULL__null) {
          *rest = copy(
              0,
              (getLength()
               - libreoffice_internal::ConstCharArrayDetector<T>::length));
      }
      return b;
  }

  /**
    Check whether this string ends with a given ASCII string.

    @param asciiStr a sequence of at least asciiStrLength ASCII characters
        (bytes in the range 0x00--0x7F)
    @param asciiStrLength the length of asciiStr; must be non-negative
    @return true if this string ends with asciiStr; otherwise, false is
    returned

    @since UDK 3.2.7
   */
  bool endsWithAsciiL(char const * asciiStr, sal_Int32 asciiStrLength)
      const
  {
      return asciiStrLength <= pData->length
          && rtl_ustr_asciil_reverseEquals_WithLength(
              pData->buffer + pData->length - asciiStrLength, asciiStr,
              asciiStrLength);
  }

  /**
    Check whether this string ends with a given string, ignoring the case of
    ASCII letters.

    Character values between 65 and 90 (ASCII A-Z) are interpreted as
    values between 97 and 122 (ASCII a-z).
    This function can't be used for language specific comparison.

    @param str the substring to be compared

    @param rest if non-null, and this function returns true, then assign a
    copy of the remainder of this string to *rest. Available since
    LibreOffice 4.2

    @return true if and only if the given str appears as a substring at the
    end of this string, ignoring the case of ASCII letters ("A"--"Z" and
    "a"--"z")

    @since LibreOffice 3.6
  */
1575#if defined LIBO_INTERNAL_ONLY1
  bool endsWithIgnoreAsciiCase(std::u16string_view sv, OUString * rest = nullptr) const {
      auto const b = sv.size() <= sal_uInt32(pData->length)
          && matchIgnoreAsciiCase(sv, pData->length - sv.size());
      if (b && rest != nullptr) {
          *rest = copy(0, pData->length - sv.size());
      }
      return b;
  }
1584#else
  bool endsWithIgnoreAsciiCase(OUString const & str, OUString * rest = NULL__null) const
  {
      bool b =  str.getLength() <= getLength()
          && matchIgnoreAsciiCase(str, getLength() - str.getLength());
      if (b && rest != NULL__null) {
          *rest = copy(0, getLength() - str.getLength());
      }
      return b;
  }
1594#endif

  /**
   @overload
   This function accepts an ASCII string literal as its argument.
   @since LibreOffice 3.6
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type
  endsWithIgnoreAsciiCase(T & literal, OUString * rest = NULL__null) const
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1606, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1606, __extension__ __PRETTY_FUNCTION__));
      bool b
          = (libreoffice_internal::ConstCharArrayDetector<T>::length
             <= sal_uInt32(pData->length))
          && (rtl_ustr_ascii_compareIgnoreAsciiCase_WithLengths(
                  (pData->buffer + pData->length
                   - libreoffice_internal::ConstCharArrayDetector<T>::length),
                  libreoffice_internal::ConstCharArrayDetector<T>::length,
                  libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                      literal),
                  libreoffice_internal::ConstCharArrayDetector<T>::length)
              == 0);
      if (b && rest != NULL__null) {
          *rest = copy(
              0,
              (getLength()
               - libreoffice_internal::ConstCharArrayDetector<T>::length));
      }
      return b;
  }

  /**
    Check whether this string ends with a given ASCII string, ignoring the
    case of ASCII letters.

    @param asciiStr a sequence of at least asciiStrLength ASCII characters
        (bytes in the range 0x00--0x7F)
    @param asciiStrLength the length of asciiStr; must be non-negative
    @return true if this string ends with asciiStr, ignoring the case of ASCII
    letters ("A"--"Z" and "a"--"z"); otherwise, false is returned
   */
  bool endsWithIgnoreAsciiCaseAsciiL(
      char const * asciiStr, sal_Int32 asciiStrLength) const
  {
      return asciiStrLength <= pData->length
          && (rtl_ustr_ascii_compareIgnoreAsciiCase_WithLengths(
                  pData->buffer + pData->length - asciiStrLength,
                  asciiStrLength, asciiStr, asciiStrLength)
              == 0);
  }

  friend bool     operator == ( const OUString& rStr1,    const OUString& rStr2 )
                      { return rStr1.equals(rStr2); }

  friend bool     operator != ( const OUString& rStr1,        const OUString& rStr2 )
                      { return !(operator == ( rStr1, rStr2 )); }

  friend bool     operator <  ( const OUString& rStr1,    const OUString& rStr2 )
                      { return rStr1.compareTo( rStr2 ) < 0; }
  friend bool     operator >  ( const OUString& rStr1,    const OUString& rStr2 )
                      { return rStr1.compareTo( rStr2 ) > 0; }
  friend bool     operator <= ( const OUString& rStr1,    const OUString& rStr2 )
                      { return rStr1.compareTo( rStr2 ) <= 0; }
  friend bool     operator >= ( const OUString& rStr1,    const OUString& rStr2 )
                      { return rStr1.compareTo( rStr2 ) >= 0; }

1662#if defined LIBO_INTERNAL_ONLY1

  template<typename T> friend typename libreoffice_internal::CharPtrDetector<T, bool>::TypeUtf16
  operator ==(OUString const & s1, T const & s2) {
      return rtl_ustr_compare_WithLength(s1.getStr(), s1.getLength(), s2, rtl_ustr_getLength(s2))
          == 0;
  }

  template<typename T>
  friend typename libreoffice_internal::NonConstCharArrayDetector<T, bool>::TypeUtf16
  operator ==(OUString const & s1, T & s2) {
      return rtl_ustr_compare_WithLength(s1.getStr(), s1.getLength(), s2, rtl_ustr_getLength(s2))
          == 0;
  }

  template<typename T> friend typename libreoffice_internal::CharPtrDetector<T, bool>::TypeUtf16
  operator ==(T const & s1, OUString const & s2) {
      return rtl_ustr_compare_WithLength(s1, rtl_ustr_getLength(s1), s2.getStr(), s2.getLength())
          == 0;
  }

  template<typename T>
  friend typename libreoffice_internal::NonConstCharArrayDetector<T, bool>::TypeUtf16
  operator ==(T & s1, OUString const & s2) {
      return rtl_ustr_compare_WithLength(s1, rtl_ustr_getLength(s1), s2.getStr(), s2.getLength())
          == 0;
  }

  template<typename T> friend typename libreoffice_internal::CharPtrDetector<T, bool>::TypeUtf16
  operator !=(OUString const & s1, T const & s2) { return !(s1 == s2); }

  template<typename T>
  friend typename libreoffice_internal::NonConstCharArrayDetector<T, bool>::TypeUtf16
  operator !=(OUString const & s1, T & s2) { return !(s1 == s2); }

  template<typename T> friend typename libreoffice_internal::CharPtrDetector<T, bool>::TypeUtf16
  operator !=(T const & s1, OUString const & s2) { return !(s1 == s2); }

  template<typename T>
  friend typename libreoffice_internal::NonConstCharArrayDetector<T, bool>::TypeUtf16
  operator !=(T & s1, OUString const & s2) { return !(s1 == s2); }

1704#else

  friend bool     operator == ( const OUString& rStr1,    const sal_Unicode * pStr2 )
                      { return rStr1.compareTo( pStr2 ) == 0; }
  friend bool     operator == ( const sal_Unicode * pStr1,    const OUString& rStr2 )
                      { return OUString( pStr1 ).compareTo( rStr2 ) == 0; }

  friend bool     operator != ( const OUString& rStr1,    const sal_Unicode * pStr2 )
                      { return !(operator == ( rStr1, pStr2 )); }
  friend bool     operator != ( const sal_Unicode * pStr1,    const OUString& rStr2 )
                      { return !(operator == ( pStr1, rStr2 )); }

1716#endif

  /**
   * Compare string to an ASCII string literal.
   *
   * This operator is equal to calling equalsAsciiL().
   *
   * @since LibreOffice 3.6
   */
  template< typename T >
  friend typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type operator==( const OUString& rString, T& literal )
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1729, __extension__ __PRETTY_FUNCTION__))
2
←
Assuming the condition is true→
3
←
'?' condition is true→
13
←
Assuming the condition is true→
14
←
'?' condition is true→
24
←
Assuming the condition is true→
25
←
'?' condition is true→
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1729, __extension__ __PRETTY_FUNCTION__));
      return rString.equalsAsciiL(
4
←
Calling 'OUString::equalsAsciiL'→
8
←
Returning from 'OUString::equalsAsciiL'→
9
←
Returning zero, which participates in a condition later→
15
←
Calling 'OUString::equalsAsciiL'→
19
←
Returning from 'OUString::equalsAsciiL'→
20
←
Returning zero, which participates in a condition later→
26
←
Calling 'OUString::equalsAsciiL'→
30
←
Returning from 'OUString::equalsAsciiL'→
31
←
Returning value, which participates in a condition later→
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(literal),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
  }
  /**
   * Compare string to an ASCII string literal.
   *
   * This operator is equal to calling equalsAsciiL().
   *
   * @since LibreOffice 3.6
   */
  template< typename T >
  friend typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type operator==( T& literal, const OUString& rString )
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1745, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1745, __extension__ __PRETTY_FUNCTION__));
      return rString.equalsAsciiL(
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(literal),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
  }
  /**
   * Compare string to an ASCII string literal.
   *
   * This operator is equal to calling !equalsAsciiL().
   *
   * @since LibreOffice 3.6
   */
  template< typename T >
  friend typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type operator!=( const OUString& rString, T& literal )
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1761, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1761, __extension__ __PRETTY_FUNCTION__));
      return !rString.equalsAsciiL(
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(literal),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
  }
  /**
   * Compare string to an ASCII string literal.
   *
   * This operator is equal to calling !equalsAsciiL().
   *
   * @since LibreOffice 3.6
   */
  template< typename T >
  friend typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type operator!=( T& literal, const OUString& rString )
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1777, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 1777, __extension__ __PRETTY_FUNCTION__));
      return !rString.equalsAsciiL(
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(literal),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
  }

1783#if defined LIBO_INTERNAL_ONLY1
  /** @overload @since LibreOffice 5.3 */
  template<typename T> friend typename libreoffice_internal::ConstCharArrayDetector<T, bool>::TypeUtf16
  operator ==(OUString const & string, T & literal) {
      return
          rtl_ustr_reverseCompare_WithLength(
              string.pData->buffer, string.pData->length,
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length)
          == 0;
  }
  /** @overload @since LibreOffice 5.3 */
  template<typename T> friend typename libreoffice_internal::ConstCharArrayDetector<T, bool>::TypeUtf16
  operator ==(T & literal, OUString const & string) {
      return
          rtl_ustr_reverseCompare_WithLength(
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length,
              string.pData->buffer, string.pData->length)
          == 0;
  }
  /** @overload @since LibreOffice 5.3 */
  template<typename T> friend typename libreoffice_internal::ConstCharArrayDetector<T, bool>::TypeUtf16
  operator !=(OUString const & string, T & literal) {
      return
          rtl_ustr_reverseCompare_WithLength(
              string.pData->buffer, string.pData->length,
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length)
          != 0;
  }
  /** @overload @since LibreOffice 5.3 */
  template<typename T> friend typename libreoffice_internal::ConstCharArrayDetector<T, bool>::TypeUtf16
  operator !=(T & literal, OUString const & string) {
      return
          rtl_ustr_reverseCompare_WithLength(
              libreoffice_internal::ConstCharArrayDetector<T>::toPointer(
                  literal),
              libreoffice_internal::ConstCharArrayDetector<T>::length,
              string.pData->buffer, string.pData->length)
          != 0;
  }
1828#endif

1830#if defined LIBO_INTERNAL_ONLY1
  /// @cond INTERNAL

  /* Comparison between OUString and OUStringLiteral.

     @since LibreOffice 5.0
  */

  template<std::size_t N>
  friend bool operator ==(OUString const & lhs, OUStringLiteral<N> const & rhs) {
      return
          rtl_ustr_reverseCompare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.getStr(), rhs.getLength())
          == 0;
  }

  template<std::size_t N>
  friend bool operator !=(OUString const & lhs, OUStringLiteral<N> const & rhs) {
      return
          rtl_ustr_reverseCompare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.getStr(), rhs.getLength())
          != 0;
  }

  template<std::size_t N>
  friend bool operator <(OUString const & lhs, OUStringLiteral<N> const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.getStr(), rhs.getLength()))
          < 0;
  }

  template<std::size_t N>
  friend bool operator <=(OUString const & lhs, OUStringLiteral<N> const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.getStr(), rhs.getLength()))
          <= 0;
  }

  template<std::size_t N>
  friend bool operator >(OUString const & lhs, OUStringLiteral<N> const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.getStr(), rhs.getLength()))
          > 0;
  }

  template<std::size_t N>
  friend bool operator >=(OUString const & lhs, OUStringLiteral<N> const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.getStr(), rhs.getLength()))
          >= 0;
  }

  template<std::size_t N>
  friend bool operator ==(OUStringLiteral<N> const & lhs, OUString const & rhs) {
      return
          rtl_ustr_reverseCompare_WithLength(
              lhs.getStr(), lhs.getLength(), rhs.pData->buffer, rhs.pData->length)
          == 0;
  }

  template<std::size_t N>
  friend bool operator !=(OUStringLiteral<N> const & lhs, OUString const & rhs) {
      return
          rtl_ustr_reverseCompare_WithLength(
              lhs.getStr(), lhs.getLength(), rhs.pData->buffer, rhs.pData->length)
          != 0;
  }

  template<std::size_t N>
  friend bool operator <(OUStringLiteral<N> const & lhs, OUString const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.getStr(), lhs.getLength(), rhs.pData->buffer, rhs.pData->length))
          < 0;
  }

  template<std::size_t N>
  friend bool operator <=(OUStringLiteral<N> const & lhs, OUString const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.getStr(), lhs.getLength(), rhs.pData->buffer, rhs.pData->length))
          <= 0;
  }

  template<std::size_t N>
  friend bool operator >(OUStringLiteral<N> const & lhs, OUString const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.getStr(), lhs.getLength(), rhs.pData->buffer, rhs.pData->length))
          > 0;
  }

  template<std::size_t N>
  friend bool operator >=(OUStringLiteral<N> const & lhs, OUString const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.getStr(), lhs.getLength(), rhs.pData->buffer, rhs.pData->length))
          >= 0;
  }

  /// @endcond
1935#endif

1937#if defined LIBO_INTERNAL_ONLY1
  friend bool operator ==(OUString const & lhs, std::u16string_view rhs) {
      return
          rtl_ustr_reverseCompare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.data(), rhs.size())
          == 0;
  }

  friend bool operator !=(OUString const & lhs, std::u16string_view rhs) {
      return
          rtl_ustr_reverseCompare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.data(), rhs.size())
          != 0;
  }

  friend bool operator <(OUString const & lhs, std::u16string_view rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.data(), rhs.size()))
          < 0;
  }

  friend bool operator <=(OUString const & lhs, std::u16string_view rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.data(), rhs.size()))
          <= 0;
  }

  friend bool operator >(OUString const & lhs, std::u16string_view rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.data(), rhs.size()))
          > 0;
  }

  friend bool operator >=(OUString const & lhs, std::u16string_view rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.pData->buffer, lhs.pData->length, rhs.data(), rhs.size()))
          >= 0;
  }

  friend bool operator ==(std::u16string_view lhs, OUString const & rhs) {
      return
          rtl_ustr_reverseCompare_WithLength(
              lhs.data(), lhs.size(), rhs.pData->buffer, rhs.pData->length)
          == 0;
  }

  friend bool operator !=(std::u16string_view lhs, OUString const & rhs) {
      return
          rtl_ustr_reverseCompare_WithLength(
              lhs.data(), lhs.size(), rhs.pData->buffer, rhs.pData->length)
          != 0;
  }

  friend bool operator <(std::u16string_view lhs, OUString const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.data(), lhs.size(), rhs.pData->buffer, rhs.pData->length))
          < 0;
  }

  friend bool operator <=(std::u16string_view lhs, OUString const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.data(), lhs.size(), rhs.pData->buffer, rhs.pData->length))
          <= 0;
  }

  friend bool operator >(std::u16string_view lhs, OUString const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.data(), lhs.size(), rhs.pData->buffer, rhs.pData->length))
          > 0;
  }

  friend bool operator >=(std::u16string_view lhs, OUString const & rhs) {
      return
          (rtl_ustr_compare_WithLength(
              lhs.data(), lhs.size(), rhs.pData->buffer, rhs.pData->length))
          >= 0;
  }
2021#endif

  /**
    Returns a hashcode for this string.

    @return   a hash code value for this object.

    @see rtl::OUStringHash for convenient use of std::unordered_map
  */
  sal_Int32 hashCode() const
  {
      return rtl_ustr_hashCode_WithLength( pData->buffer, pData->length );
  }

  /**
    Returns the index within this string of the first occurrence of the
    specified character, starting the search at the specified index.

    @param    ch          character to be located.
    @param    fromIndex   the index to start the search from.
                          The index must be greater than or equal to 0
                          and less than or equal to the string length.
    @return   the index of the first occurrence of the character in the
              character sequence represented by this string that is
              greater than or equal to fromIndex, or
              -1 if the character does not occur.
  */
  sal_Int32 indexOf( sal_Unicode ch, sal_Int32 fromIndex = 0 ) const
  {
      sal_Int32 ret = rtl_ustr_indexOfChar_WithLength( pData->buffer+fromIndex, pData->length-fromIndex, ch );
      return (ret < 0 ? ret : ret+fromIndex);
  }

  /**
    Returns the index within this string of the last occurrence of the
    specified character, searching backward starting at the end.

    @param    ch          character to be located.
    @return   the index of the last occurrence of the character in the
              character sequence represented by this string, or
              -1 if the character does not occur.
  */
  sal_Int32 lastIndexOf( sal_Unicode ch ) const
  {
      return rtl_ustr_lastIndexOfChar_WithLength( pData->buffer, pData->length, ch );
  }

  /**
    Returns the index within this string of the last occurrence of the
    specified character, searching backward starting before the specified
    index.

    @param    ch          character to be located.
    @param    fromIndex   the index before which to start the search.
    @return   the index of the last occurrence of the character in the
              character sequence represented by this string that
              is less than fromIndex, or -1
              if the character does not occur before that point.
  */
  sal_Int32 lastIndexOf( sal_Unicode ch, sal_Int32 fromIndex ) const
  {
      return rtl_ustr_lastIndexOfChar_WithLength( pData->buffer, fromIndex, ch );
  }

  /**
    Returns the index within this string of the first occurrence of the
    specified substring, starting at the specified index.

    If str doesn't include any character, always -1 is
    returned. This is also the case, if both strings are empty.

    @param    str         the substring to search for.
    @param    fromIndex   the index to start the search from.
    @return   If the string argument occurs one or more times as a substring
              within this string at the starting index, then the index
              of the first character of the first such substring is
              returned. If it does not occur as a substring starting
              at fromIndex or beyond, -1 is returned.
  */
2100#if defined LIBO_INTERNAL_ONLY1
  sal_Int32 indexOf(std::u16string_view sv, sal_Int32 fromIndex = 0) const {
      auto const n = rtl_ustr_indexOfStr_WithLength(
          pData->buffer + fromIndex, pData->length - fromIndex, sv.data(), sv.size());
      return n < 0 ? n : n + fromIndex;
  }
2106#else
  sal_Int32 indexOf( const OUString & str, sal_Int32 fromIndex = 0 ) const
  {
      sal_Int32 ret = rtl_ustr_indexOfStr_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
                                                      str.pData->buffer, str.pData->length );
      return (ret < 0 ? ret : ret+fromIndex);
  }
2113#endif

  /**
   @overload
   This function accepts an ASCII string literal as its argument.
   @since LibreOffice 3.6
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, sal_Int32 >::Type indexOf( T& literal, sal_Int32 fromIndex = 0 ) const
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2124, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2124, __extension__ __PRETTY_FUNCTION__));
      sal_Int32 n = rtl_ustr_indexOfAscii_WithLength(
          pData->buffer + fromIndex, pData->length - fromIndex,
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(literal),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
      return n < 0 ? n : n + fromIndex;
  }

  /**
     Returns the index within this string of the first occurrence of the
     specified ASCII substring, starting at the specified index.

     @param str
     the substring to be searched for.  Need not be null-terminated, but must
     be at least as long as the specified len.  Must only contain characters
     in the ASCII range 0x00--7F.

     @param len
     the length of the substring; must be non-negative.

     @param fromIndex
     the index to start the search from.  Must be in the range from zero to
     the length of this string, inclusive.

     @return
     the index (starting at 0) of the first character of the first occurrence
     of the substring within this string starting at the given fromIndex, or
     -1 if the substring does not occur.  If len is zero, -1 is returned.

     @since UDK 3.2.7
  */
  sal_Int32 indexOfAsciiL(
      char const * str, sal_Int32 len, sal_Int32 fromIndex = 0) const
  {
      sal_Int32 ret = rtl_ustr_indexOfAscii_WithLength(
          pData->buffer + fromIndex, pData->length - fromIndex, str, len);
      return ret < 0 ? ret : ret + fromIndex;
  }

  // This overload is left undefined, to detect calls of indexOfAsciiL that
  // erroneously use RTL_CONSTASCII_USTRINGPARAM instead of
  // RTL_CONSTASCII_STRINGPARAM (but would lead to ambiguities on 32 bit
  // platforms):
2167#if SAL_TYPES_SIZEOFLONG8 == 8
  void indexOfAsciiL(char const *, sal_Int32 len, rtl_TextEncoding) const;
2169#endif

  /**
    Returns the index within this string of the last occurrence of
    the specified substring, searching backward starting at the end.

    The returned index indicates the starting index of the substring
    in this string.
    If str doesn't include any character, always -1 is
    returned. This is also the case, if both strings are empty.

    @param    str         the substring to search for.
    @return   If the string argument occurs one or more times as a substring
              within this string, then the index of the first character of
              the last such substring is returned. If it does not occur as
              a substring, -1 is returned.
  */
2186#if defined LIBO_INTERNAL_ONLY1
  sal_Int32 lastIndexOf(std::u16string_view sv) const {
      return rtl_ustr_lastIndexOfStr_WithLength(
          pData->buffer, pData->length, sv.data(), sv.size());
  }
2191#else
  sal_Int32 lastIndexOf( const OUString & str ) const
  {
      return rtl_ustr_lastIndexOfStr_WithLength( pData->buffer, pData->length,
                                                 str.pData->buffer, str.pData->length );
  }
2197#endif

  /**
    Returns the index within this string of the last occurrence of
    the specified substring, searching backward starting before the specified
    index.

    The returned index indicates the starting index of the substring
    in this string.
    If str doesn't include any character, always -1 is
    returned. This is also the case, if both strings are empty.

    @param    str         the substring to search for.
    @param    fromIndex   the index before which to start the search.
    @return   If the string argument occurs one or more times as a substring
              within this string before the starting index, then the index
              of the first character of the last such substring is
              returned. Otherwise, -1 is returned.
  */
2216#if defined LIBO_INTERNAL_ONLY1
  sal_Int32 lastIndexOf(std::u16string_view sv, sal_Int32 fromIndex) const {
      return rtl_ustr_lastIndexOfStr_WithLength(pData->buffer, fromIndex, sv.data(), sv.size());
  }
2220#else
  sal_Int32 lastIndexOf( const OUString & str, sal_Int32 fromIndex ) const
  {
      return rtl_ustr_lastIndexOfStr_WithLength( pData->buffer, fromIndex,
                                                 str.pData->buffer, str.pData->length );
  }
2226#endif

  /**
   @overload
   This function accepts an ASCII string literal as its argument.
   @since LibreOffice 3.6
  */
  template< typename T >
  typename libreoffice_internal::ConstCharArrayDetector< T, sal_Int32 >::Type lastIndexOf( T& literal ) const
  {
      assert((static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2237, __extension__ __PRETTY_FUNCTION__))
          libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(literal)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2237, __extension__ __PRETTY_FUNCTION__));
      return rtl_ustr_lastIndexOfAscii_WithLength(
          pData->buffer, pData->length,
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(literal),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
  }

  /**
     Returns the index within this string of the last occurrence of the
     specified ASCII substring.

     @param str
     the substring to be searched for.  Need not be null-terminated, but must
     be at least as long as the specified len.  Must only contain characters
     in the ASCII range 0x00--7F.

     @param len
     the length of the substring; must be non-negative.

     @return
     the index (starting at 0) of the first character of the last occurrence
     of the substring within this string, or -1 if the substring does not
     occur.  If len is zero, -1 is returned.

     @since UDK 3.2.7
  */
  sal_Int32 lastIndexOfAsciiL(char const * str, sal_Int32 len) const
  {
      return rtl_ustr_lastIndexOfAscii_WithLength(
          pData->buffer, pData->length, str, len);
  }

  /**
    Returns a new string that is a substring of this string.

    The substring begins at the specified beginIndex. If
    beginIndex is negative or be greater than the length of
    this string, behaviour is undefined.

    @param     beginIndex   the beginning index, inclusive.
    @return    the specified substring.
  */
  SAL_WARN_UNUSED_RESULT[[nodiscard]] OUString copy( sal_Int32 beginIndex ) const
  {
      return copy(beginIndex, getLength() - beginIndex);
  }

  /**
    Returns a new string that is a substring of this string.

    The substring begins at the specified beginIndex and contains count
    characters.  If either beginIndex or count are negative,
    or beginIndex + count are greater than the length of this string
    then behaviour is undefined.

    @param     beginIndex   the beginning index, inclusive.
    @param     count        the number of characters.
    @return    the specified substring.
  */
  SAL_WARN_UNUSED_RESULT[[nodiscard]] OUString copy( sal_Int32 beginIndex, sal_Int32 count ) const
  {
      rtl_uString *pNew = NULL__null;
      rtl_uString_newFromSubString( &pNew, pData, beginIndex, count );
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

  /**
    Concatenates the specified string to the end of this string.

    @param    str   the string that is concatenated to the end
                    of this string.
    @return   a string that represents the concatenation of this string
              followed by the string argument.
  */
  SAL_WARN_UNUSED_RESULT[[nodiscard]] OUString concat( const OUString & str ) const
  {
      rtl_uString* pNew = NULL__null;
      rtl_uString_newConcat( &pNew, pData, str.pData );
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

2318#ifndef LIBO_INTERNAL_ONLY1 // "RTL_FAST_STRING"
  friend OUString operator+( const OUString& rStr1, const OUString& rStr2  )
  {
      return rStr1.concat( rStr2 );
  }
2323#endif

  /**
    Returns a new string resulting from replacing n = count characters
    from position index in this string with newStr.

    @param  index   the replacing index in str.
                    The index must be greater than or equal to 0 and
                    less than or equal to the length of the string.
    @param  count   the count of characters that will be replaced
                    The count must be greater than or equal to 0 and
                    less than or equal to the length of the string minus index.
    @param  newStr  the new substring.
    @return the new string.
  */
  SAL_WARN_UNUSED_RESULT[[nodiscard]] OUString replaceAt( sal_Int32 index, sal_Int32 count, const OUString& newStr ) const
  {
      rtl_uString* pNew = NULL__null;
      rtl_uString_newReplaceStrAt( &pNew, pData, index, count, newStr.pData );
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

  /**
    Returns a new string resulting from replacing all occurrences of
    oldChar in this string with newChar.

    If the character oldChar does not occur in the character sequence
    represented by this object, then the string is assigned with
    str.

    @param    oldChar     the old character.
    @param    newChar     the new character.
    @return   a string derived from this string by replacing every
              occurrence of oldChar with newChar.
  */
  SAL_WARN_UNUSED_RESULT[[nodiscard]] OUString replace( sal_Unicode oldChar, sal_Unicode newChar ) const
  {
      rtl_uString* pNew = NULL__null;
      rtl_uString_newReplace( &pNew, pData, oldChar, newChar );
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

  /**
    Returns a new string resulting from replacing the first occurrence of a
    given substring with another substring.

    @param from  the substring to be replaced

    @param to  the replacing substring

    @param[in,out] index  pointer to a start index; if the pointer is
    non-null: upon entry to the function, its value is the index into this
    string at which to start searching for the \p from substring, the value
    must be non-negative and not greater than this string's length; upon exiting
    the function its value is the index into this string at which the
    replacement took place or -1 if no replacement took place; if the pointer
    is null, searching always starts at index 0

    @since LibreOffice 3.6
  */
2383#if defined LIBO_INTERNAL_ONLY1
  [[nodiscard]] OUString replaceFirst(
      std::u16string_view from, std::u16string_view to, sal_Int32 * index = nullptr) const
  {
      rtl_uString * s = nullptr;
      sal_Int32 i = 0;
      rtl_uString_newReplaceFirstUtf16LUtf16L(
          &s, pData, from.data(), from.size(), to.data(), to.size(),
          index == nullptr ? &i : index);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2394#else
  SAL_WARN_UNUSED_RESULT[[nodiscard]] OUString replaceFirst(
      OUString const & from, OUString const & to, sal_Int32 * index = NULL__null) const
  {
      rtl_uString * s = NULL__null;
      sal_Int32 i = 0;
      rtl_uString_newReplaceFirst(
          &s, pData, from.pData, to.pData, index == NULL__null ? &i : index);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2404#endif

  /**
    Returns a new string resulting from replacing the first occurrence of a
    given substring with another substring.

    @param from  ASCII string literal, the substring to be replaced

    @param to  the replacing substring

    @param[in,out] index  pointer to a start index; if the pointer is
    non-null: upon entry to the function, its value is the index into the this
    string at which to start searching for the \p from substring, the value
    must be non-negative and not greater than this string's length; upon exiting
    the function its value is the index into this string at which the
    replacement took place or -1 if no replacement took place; if the pointer
    is null, searching always starts at index 0

    @since LibreOffice 3.6
  */
2424#if defined LIBO_INTERNAL_ONLY1
  template<typename T> [[nodiscard]]
  typename libreoffice_internal::ConstCharArrayDetector<T, OUString >::Type replaceFirst(
      T & from, std::u16string_view to, sal_Int32 * index = nullptr) const
  {
      assert(libreoffice_internal::ConstCharArrayDetector<T>::isValid(from))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(from)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(from)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2429, __extension__ __PRETTY_FUNCTION__));
      rtl_uString * s = nullptr;
      sal_Int32 i = 0;
      rtl_uString_newReplaceFirstAsciiLUtf16L(
          &s, pData, libreoffice_internal::ConstCharArrayDetector<T>::toPointer(from),
          libreoffice_internal::ConstCharArrayDetector<T>::length, to.data(), to.size(),
          index == nullptr ? &i : index);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2438#else
  template< typename T >
  SAL_WARN_UNUSED_RESULT[[nodiscard]] typename libreoffice_internal::ConstCharArrayDetector< T, OUString >::Type replaceFirst( T& from, OUString const & to,
                                                                                                      sal_Int32 * index = NULL__null) const
  {
      assert(libreoffice_internal::ConstCharArrayDetector<T>::isValid(from))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(from)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(from)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2443, __extension__ __PRETTY_FUNCTION__));
      rtl_uString * s = NULL__null;
      sal_Int32 i = 0;
      rtl_uString_newReplaceFirstAsciiL(
          &s, pData,
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(from),
          libreoffice_internal::ConstCharArrayDetector<T>::length, to.pData,
          index == NULL__null ? &i : index);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2453#endif

  /**
    Returns a new string resulting from replacing the first occurrence of a
    given substring with another substring.

    @param from  the substring to be replaced

    @param to  ASCII string literal, the replacing substring

    @param[in,out] index  pointer to a start index; if the pointer is
    non-null: upon entry to the function, its value is the index into the this
    string at which to start searching for the \p from substring, the value
    must be non-negative and not greater than this string's length; upon exiting
    the function its value is the index into this string at which the
    replacement took place or -1 if no replacement took place; if the pointer
    is null, searching always starts at index 0

    @since LibreOffice 5.1
  */
2473#if defined LIBO_INTERNAL_ONLY1
  template<typename T> [[nodiscard]]
  typename libreoffice_internal::ConstCharArrayDetector<T, OUString >::Type replaceFirst(
      std::u16string_view from, T & to, sal_Int32 * index = nullptr) const
  {
      assert(libreoffice_internal::ConstCharArrayDetector<T>::isValid(to))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(to)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(to)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2478, __extension__ __PRETTY_FUNCTION__));
      rtl_uString * s = nullptr;
      sal_Int32 i = 0;
      rtl_uString_newReplaceFirstUtf16LAsciiL(
          &s, pData, from.data(), from.size(),
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(to),
          libreoffice_internal::ConstCharArrayDetector<T>::length, index == nullptr ? &i : index);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2487#else
  template< typename T >
  SAL_WARN_UNUSED_RESULT[[nodiscard]] typename libreoffice_internal::ConstCharArrayDetector< T, OUString >::Type replaceFirst( OUString const & from, T& to,
                                                                                                      sal_Int32 * index = NULL__null) const
  {
      assert(libreoffice_internal::ConstCharArrayDetector<T>::isValid(to))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(to)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(to)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2492, __extension__ __PRETTY_FUNCTION__));
      rtl_uString * s = NULL__null;
      sal_Int32 i = 0;
      rtl_uString_newReplaceFirstToAsciiL(
          &s, pData, from.pData,
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(to),
          libreoffice_internal::ConstCharArrayDetector<T>::length,
          index == NULL__null ? &i : index);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2502#endif

  /**
    Returns a new string resulting from replacing the first occurrence of a
    given substring with another substring.

    @param from  ASCII string literal, the substring to be replaced

    @param to  ASCII string literal, the substring to be replaced

    @param[in,out] index  pointer to a start index; if the pointer is
    non-null: upon entry to the function, its value is the index into the this
    string at which to start searching for the \p from substring, the value
    must be non-negative and not greater than this string's length; upon exiting
    the function its value is the index into this string at which the
    replacement took place or -1 if no replacement took place; if the pointer
    is null, searching always starts at index 0

    @since LibreOffice 3.6
  */
  template< typename T1, typename T2 >
      SAL_WARN_UNUSED_RESULT[[nodiscard]] typename libreoffice_internal::ConstCharArrayDetector< T1, typename libreoffice_internal::ConstCharArrayDetector< T2, OUString >::Type >::Type
      replaceFirst( T1& from, T2& to, sal_Int32 * index = NULL__null) const
  {
      assert(libreoffice_internal::ConstCharArrayDetector<T1>::isValid(from))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T1>::isValid(from)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T1>::isValid(from)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2526, __extension__ __PRETTY_FUNCTION__));
      assert(libreoffice_internal::ConstCharArrayDetector<T2>::isValid(to))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T2>::isValid(to)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T2>::isValid(to)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2527, __extension__ __PRETTY_FUNCTION__));
      rtl_uString * s = NULL__null;
      sal_Int32 i = 0;
      rtl_uString_newReplaceFirstAsciiLAsciiL(
          &s, pData,
          libreoffice_internal::ConstCharArrayDetector<T1>::toPointer(from),
          libreoffice_internal::ConstCharArrayDetector<T1>::length,
          libreoffice_internal::ConstCharArrayDetector<T2>::toPointer(to),
          libreoffice_internal::ConstCharArrayDetector<T2>::length,
          index == NULL__null ? &i : index);
      return OUString(s, SAL_NO_ACQUIRE);
  }

  /**
    Returns a new string resulting from replacing all occurrences of a given
    substring with another substring.

    Replacing subsequent occurrences picks up only after a given replacement.
    That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

    @param from  the substring to be replaced

    @param to  the replacing substring

    @param fromIndex  the position in the string where we will begin searching

    @since LibreOffice 4.0
  */
2555#if defined LIBO_INTERNAL_ONLY1
  [[nodiscard]] OUString replaceAll(
      std::u16string_view from, std::u16string_view to, sal_Int32 fromIndex = 0) const
  {
      rtl_uString * s = nullptr;
      rtl_uString_newReplaceAllFromIndexUtf16LUtf16L(
          &s, pData, from.data(), from.size(), to.data(), to.size(), fromIndex);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2564#else
  SAL_WARN_UNUSED_RESULT[[nodiscard]] OUString replaceAll(
      OUString const & from, OUString const & to, sal_Int32 fromIndex = 0) const
  {
      rtl_uString * s = NULL__null;
      rtl_uString_newReplaceAllFromIndex(&s, pData, from.pData, to.pData, fromIndex);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2572#endif

  /**
    Returns a new string resulting from replacing all occurrences of a given
    substring with another substring.

    Replacing subsequent occurrences picks up only after a given replacement.
    That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

    @param from ASCII string literal, the substring to be replaced

    @param to  the replacing substring

    @since LibreOffice 3.6
  */
2587#if defined LIBO_INTERNAL_ONLY1
  template<typename T> [[nodiscard]]
  typename libreoffice_internal::ConstCharArrayDetector<T, OUString >::Type replaceAll(
      T & from, std::u16string_view to) const
  {
      assert(libreoffice_internal::ConstCharArrayDetector<T>::isValid(from))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(from)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(from)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2592, __extension__ __PRETTY_FUNCTION__));
      rtl_uString * s = nullptr;
      rtl_uString_newReplaceAllAsciiLUtf16L(
          &s, pData, libreoffice_internal::ConstCharArrayDetector<T>::toPointer(from),
          libreoffice_internal::ConstCharArrayDetector<T>::length, to.data(), to.size());
      return OUString(s, SAL_NO_ACQUIRE);
  }
2599#else
  template< typename T >
  SAL_WARN_UNUSED_RESULT[[nodiscard]] typename libreoffice_internal::ConstCharArrayDetector< T, OUString >::Type replaceAll( T& from, OUString const & to) const
  {
      assert(libreoffice_internal::ConstCharArrayDetector<T>::isValid(from))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(from)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(from)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2603, __extension__ __PRETTY_FUNCTION__));
      rtl_uString * s = NULL__null;
      rtl_uString_newReplaceAllAsciiL(
          &s, pData,
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(from),
          libreoffice_internal::ConstCharArrayDetector<T>::length, to.pData);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2611#endif

  /**
    Returns a new string resulting from replacing all occurrences of a given
    substring with another substring.

    Replacing subsequent occurrences picks up only after a given replacement.
    That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

    @param from  the substring to be replaced

    @param to  ASCII string literal, the replacing substring

    @since LibreOffice 5.1
  */
2626#if defined LIBO_INTERNAL_ONLY1
  template<typename T> [[nodiscard]]
  typename libreoffice_internal::ConstCharArrayDetector<T, OUString >::Type replaceAll(
      std::u16string_view from, T & to) const
  {
      assert(libreoffice_internal::ConstCharArrayDetector<T>::isValid(to))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(to)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(to)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2631, __extension__ __PRETTY_FUNCTION__));
      rtl_uString * s = nullptr;
      rtl_uString_newReplaceAllUtf16LAsciiL(
          &s, pData, from.data(), from.size(),
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(to),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2639#else
  template< typename T >
  SAL_WARN_UNUSED_RESULT[[nodiscard]] typename libreoffice_internal::ConstCharArrayDetector< T, OUString >::Type replaceAll( OUString const & from, T& to) const
  {
      assert(libreoffice_internal::ConstCharArrayDetector<T>::isValid(to))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T>::isValid(to)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T>::isValid(to)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2643, __extension__ __PRETTY_FUNCTION__));
      rtl_uString * s = NULL__null;
      rtl_uString_newReplaceAllToAsciiL(
          &s, pData, from.pData,
          libreoffice_internal::ConstCharArrayDetector<T>::toPointer(to),
          libreoffice_internal::ConstCharArrayDetector<T>::length);
      return OUString(s, SAL_NO_ACQUIRE);
  }
2651#endif

  /**
    Returns a new string resulting from replacing all occurrences of a given
    substring with another substring.

    Replacing subsequent occurrences picks up only after a given replacement.
    That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

    @param from  ASCII string literal, the substring to be replaced

    @param to  ASCII string literal, the substring to be replaced

    @since LibreOffice 3.6
  */
  template< typename T1, typename T2 >
  SAL_WARN_UNUSED_RESULT[[nodiscard]] typename libreoffice_internal::ConstCharArrayDetector< T1, typename libreoffice_internal::ConstCharArrayDetector< T2, OUString >::Type >::Type
      replaceAll( T1& from, T2& to ) const
  {
      assert(libreoffice_internal::ConstCharArrayDetector<T1>::isValid(from))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T1>::isValid(from)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T1>::isValid(from)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2670, __extension__ __PRETTY_FUNCTION__));
      assert(libreoffice_internal::ConstCharArrayDetector<T2>::isValid(to))(static_cast <bool> (libreoffice_internal::ConstCharArrayDetector
<T2>::isValid(to)) ? void (0) : __assert_fail ("libreoffice_internal::ConstCharArrayDetector<T2>::isValid(to)"
, "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 2671, __extension__ __PRETTY_FUNCTION__));
      rtl_uString * s = NULL__null;
      rtl_uString_newReplaceAllAsciiLAsciiL(
          &s, pData,
          libreoffice_internal::ConstCharArrayDetector<T1>::toPointer(from),
          libreoffice_internal::ConstCharArrayDetector<T1>::length,
          libreoffice_internal::ConstCharArrayDetector<T2>::toPointer(to),
          libreoffice_internal::ConstCharArrayDetector<T2>::length);
      return OUString(s, SAL_NO_ACQUIRE);
  }

  /**
    Converts from this string all ASCII uppercase characters (65-90)
    to ASCII lowercase characters (97-122).

    This function can't be used for language specific conversion.
    If the string doesn't contain characters which must be converted,
    then the new string is assigned with str.

    @return   the string, converted to ASCII lowercase.
  */
  SAL_WARN_UNUSED_RESULT[[nodiscard]] OUString toAsciiLowerCase() const
  {
      rtl_uString* pNew = NULL__null;
      rtl_uString_newToAsciiLowerCase( &pNew, pData );
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

  /**
    Converts from this string all ASCII lowercase characters (97-122)
    to ASCII uppercase characters (65-90).

    This function can't be used for language specific conversion.
    If the string doesn't contain characters which must be converted,
    then the new string is assigned with str.

    @return   the string, converted to ASCII uppercase.
  */
  SAL_WARN_UNUSED_RESULT[[nodiscard]] OUString toAsciiUpperCase() const
  {
      rtl_uString* pNew = NULL__null;
      rtl_uString_newToAsciiUpperCase( &pNew, pData );
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

  /**
    Returns a new string resulting from removing white space from both ends
    of the string.

    All characters that have codes less than or equal to
    32 (the space character), and Unicode General Punctuation area Space
    and some Control characters are considered to be white space (see
    rtl_ImplIsWhitespace).
    If the string doesn't contain white spaces at both ends,
    then the new string is assigned with str.

    @return   the string, with white space removed from the front and end.
  */
  SAL_WARN_UNUSED_RESULT[[nodiscard]] OUString trim() const
  {
      rtl_uString* pNew = NULL__null;
      rtl_uString_newTrim( &pNew, pData );
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

  /**
    Returns a token in the string.

    Example:
      sal_Int32 nIndex = 0;
      do
      {
          ...
          OUString aToken = aStr.getToken( 0, ';', nIndex );
          ...
      }
      while ( nIndex >= 0 );

    @param    token       the number of the token to return
    @param    cTok        the character which separate the tokens.
    @param    index       the position at which the token is searched in the
                          string.
                          The index must not be greater than the length of the
                          string.
                          This param is set to the position of the
                          next token or to -1, if it is the last token.
    @return   the token; if either token or index is negative, an empty token
              is returned (and index is set to -1)
  */
  OUString getToken( sal_Int32 token, sal_Unicode cTok, sal_Int32& index ) const
  {
      rtl_uString * pNew = NULL__null;
      index = rtl_uString_getToken( &pNew, pData, token, cTok, index );
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

  /**
    Returns a token from the string.

    The same as getToken(sal_Int32, sal_Unicode, sal_Int32 &), but always
    passing in 0 as the start index in the third argument.

    @param count  the number of the token to return, starting with 0
    @param separator  the character which separates the tokens

    @return  the given token, or an empty string

    @since LibreOffice 3.6
   */
  OUString getToken(sal_Int32 count, sal_Unicode separator) const {
      sal_Int32 n = 0;
      return getToken(count, separator, n);
  }

  /**
    Returns the Boolean value from this string.

    This function can't be used for language specific conversion.

    @return   true, if the string is 1 or "True" in any ASCII case.
              false in any other case.
  */
  bool toBoolean() const
  {
      return rtl_ustr_toBoolean( pData->buffer );
  }

  /**
    Returns the first character from this string.

    @return   the first character from this string or 0, if this string
              is empty.
  */
  sal_Unicode toChar() const
  {
      return pData->buffer[0];
  }

  /**
    Returns the int32 value from this string.

    This function can't be used for language specific conversion.

    @param    radix       the radix (between 2 and 36)
    @return   the int32 represented from this string.
              0 if this string represents no number or one of too large
              magnitude.
  */
  sal_Int32 toInt32( sal_Int16 radix = 10 ) const
  {
      return rtl_ustr_toInt32( pData->buffer, radix );
  }

  /**
    Returns the uint32 value from this string.

    This function can't be used for language specific conversion.

    @param    radix       the radix (between 2 and 36)
    @return   the uint32 represented from this string.
              0 if this string represents no number or one of too large
              magnitude.

    @since LibreOffice 4.2
  */
  sal_uInt32 toUInt32( sal_Int16 radix = 10 ) const
  {
      return rtl_ustr_toUInt32( pData->buffer, radix );
  }

  /**
    Returns the int64 value from this string.

    This function can't be used for language specific conversion.

    @param    radix       the radix (between 2 and 36)
    @return   the int64 represented from this string.
              0 if this string represents no number or one of too large
              magnitude.
  */
  sal_Int64 toInt64( sal_Int16 radix = 10 ) const
  {
      return rtl_ustr_toInt64( pData->buffer, radix );
  }

  /**
    Returns the uint64 value from this string.

    This function can't be used for language specific conversion.

    @param    radix       the radix (between 2 and 36)
    @return   the uint64 represented from this string.
              0 if this string represents no number or one of too large
              magnitude.

    @since LibreOffice 4.1
  */
  sal_uInt64 toUInt64( sal_Int16 radix = 10 ) const
  {
      return rtl_ustr_toUInt64( pData->buffer, radix );
  }

  /**
    Returns the float value from this string.

    This function can't be used for language specific conversion.

    @return   the float represented from this string.
              0.0 if this string represents no number.
  */
  float toFloat() const
  {
      return rtl_ustr_toFloat( pData->buffer );
  }

  /**
    Returns the double value from this string.

    This function can't be used for language specific conversion.

    @return   the double represented from this string.
              0.0 if this string represents no number.
  */
  double toDouble() const
  {
      return rtl_ustr_toDouble( pData->buffer );
  }


  /**
     Return a canonical representation for a string.

     A pool of strings, initially empty is maintained privately
     by the string class. On invocation, if present in the pool
     the original string will be returned. Otherwise this string,
     or a copy thereof will be added to the pool and returned.

     @return
     a version of the string from the pool.

     @exception std::bad_alloc is thrown if an out-of-memory condition occurs

     @since UDK 3.2.7
  */
  OUString intern() const
  {
      rtl_uString * pNew = NULL__null;
      rtl_uString_intern( &pNew, pData );
      if (pNew == NULL__null) {
          throw std::bad_alloc();
      }
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

  /**
     Return a canonical representation for a converted string.

     A pool of strings, initially empty is maintained privately
     by the string class. On invocation, if present in the pool
     the original string will be returned. Otherwise this string,
     or a copy thereof will be added to the pool and returned.

     @param    value           a 8-Bit character array.
     @param    length          the number of character which should be converted.
                               The 8-Bit character array length must be
                               greater than or equal to this value.
     @param    encoding        the text encoding from which the 8-Bit character
                               sequence should be converted.
     @param    convertFlags    flags which controls the conversion.
                               see RTL_TEXTTOUNICODE_FLAGS_...
     @param    pInfo           pointer to return conversion status or NULL.

     @return
     a version of the converted string from the pool.

     @exception std::bad_alloc is thrown if an out-of-memory condition occurs

     @since UDK 3.2.7
  */
  static OUString intern( const char * value, sal_Int32 length,
                          rtl_TextEncoding encoding,
                          sal_uInt32 convertFlags = OSTRING_TO_OUSTRING_CVTFLAGS(((sal_uInt32)0x0003) | ((sal_uInt32)0x0030) | ((sal_uInt32)0x0300
)),
                          sal_uInt32 *pInfo = NULL__null )
  {
      rtl_uString * pNew = NULL__null;
      rtl_uString_internConvert( &pNew, value, length, encoding,
                                 convertFlags, pInfo );
      if (pNew == NULL__null) {
          throw std::bad_alloc();
      }
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

  /**
    Converts to an OString, signalling failure.

    @param pTarget
    An out parameter receiving the converted OString.  Must not be null; the
    contents are not modified if conversion fails (convertToOString returns
    false).

    @param nEncoding
    The text encoding to convert into.  Must be an octet encoding (i.e.,
    rtl_isOctetTextEncoding(nEncoding) must return true).

    @param nFlags
    A combination of RTL_UNICODETOTEXT_FLAGS that detail how to do the
    conversion (see rtl_convertUnicodeToText).  RTL_UNICODETOTEXT_FLAGS_FLUSH
    need not be included, it is implicitly assumed.  Typical uses are either
    RTL_UNICODETOTEXT_FLAGS_UNDEFINED_ERROR |
    RTL_UNICODETOTEXT_FLAGS_INVALID_ERROR (fail if a Unicode character cannot
    be converted to the target nEncoding) or OUSTRING_TO_OSTRING_CVTFLAGS
    (make a best efforts conversion).

    @return
    True if the conversion succeeded, false otherwise.
   */
  bool convertToString(OString * pTarget, rtl_TextEncoding nEncoding,
                              sal_uInt32 nFlags) const
  {
      return rtl_convertUStringToString(&pTarget->pData, pData->buffer,
                                          pData->length, nEncoding, nFlags);
  }

  /** Iterate through this string based on code points instead of UTF-16 code
      units.

      See Chapter 3 of The Unicode Standard 5.0 (Addison--Wesley, 2006) for
      definitions of the various terms used in this description.

      This string is interpreted as a sequence of zero or more UTF-16 code
      units.  For each index into this sequence (from zero to one less than
      the length of the sequence, inclusive), a code point represented
      starting at the given index is computed as follows:

      - If the UTF-16 code unit addressed by the index constitutes a
      well-formed UTF-16 code unit sequence, the computed code point is the
      scalar value encoded by that UTF-16 code unit sequence.

      - Otherwise, if the index is at least two UTF-16 code units away from
      the end of the sequence, and the sequence of two UTF-16 code units
      addressed by the index constitutes a well-formed UTF-16 code unit
      sequence, the computed code point is the scalar value encoded by that
      UTF-16 code unit sequence.

      - Otherwise, the computed code point is the UTF-16 code unit addressed
      by the index.  (This last case catches unmatched surrogates as well as
      indices pointing into the middle of surrogate pairs.)

      @param indexUtf16
      pointer to a UTF-16 based index into this string; must not be null.  On
      entry, the index must be in the range from zero to the length of this
      string (in UTF-16 code units), inclusive.  Upon successful return, the
      index will be updated to address the UTF-16 code unit that is the given
      incrementCodePoints away from the initial index.

      @param incrementCodePoints
      the number of code points to move the given *indexUtf16.  If
      non-negative, moving is done after determining the code point at the
      index.  If negative, moving is done before determining the code point
      at the (then updated) index.  The value must be such that the resulting
      UTF-16 based index is in the range from zero to the length of this
      string (in UTF-16 code units), inclusive.

      @return
      the code point (an integer in the range from 0 to 0x10FFFF, inclusive)
      that is represented within this string starting at the index computed as
      follows:  If incrementCodePoints is non-negative, the index is the
      initial value of *indexUtf16; if incrementCodePoints is negative, the
      index is the updated value of *indexUtf16.  In either case, the computed
      index must be in the range from zero to one less than the length of this
      string (in UTF-16 code units), inclusive.

      @since UDK 3.2.7
  */
  sal_uInt32 iterateCodePoints(
      sal_Int32 * indexUtf16, sal_Int32 incrementCodePoints = 1) const
  {
      return rtl_uString_iterateCodePoints(
          pData, indexUtf16, incrementCodePoints);
  }

  /**
   * Convert an OString to an OUString, assuming that the OString is
   * UTF-8-encoded.
   *
   * @param rSource
   * an OString to convert
   *
   * @since LibreOffice 4.4
   */
  static OUString fromUtf8(const OString& rSource)
  {
      OUString aTarget;
      bool bSuccess = rtl_convertStringToUString(&aTarget.pData,
                                                 rSource.getStr(),
                                                 rSource.getLength(),
                                                 RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76)),
                                                 RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_ERROR((sal_uInt32)0x0001)|RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_ERROR((sal_uInt32)0x0010)|RTL_TEXTTOUNICODE_FLAGS_INVALID_ERROR((sal_uInt32)0x0100));
      (void) bSuccess;
      assert(bSuccess)(static_cast <bool> (bSuccess) ? void (0) : __assert_fail
 ("bSuccess", "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 3071, __extension__ __PRETTY_FUNCTION__));
      return aTarget;
  }

  /**
   * Convert this string to an OString, assuming that the string can be
   * UTF-8-encoded successfully.
   *
   * In other words, you must not use this method on a random sequence of
   * UTF-16 code units, but only at places where it is assumed that the
   * content is a proper string.
   *
   * @since LibreOffice 4.4
   */
  OString toUtf8() const
  {
      OString aTarget;
      bool bSuccess = rtl_convertUStringToString(&aTarget.pData,
                                                 getStr(),
                                                 getLength(),
                                                 RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76)),
                                                 RTL_UNICODETOTEXT_FLAGS_UNDEFINED_ERROR((sal_uInt32)0x0001)|RTL_UNICODETOTEXT_FLAGS_INVALID_ERROR((sal_uInt32)0x0010));
      (void) bSuccess;
      assert(bSuccess)(static_cast <bool> (bSuccess) ? void (0) : __assert_fail
 ("bSuccess", "/home/maarten/src/libreoffice/core/include/rtl/ustring.hxx"
, 3094, __extension__ __PRETTY_FUNCTION__));
      return aTarget;
  }

3098#ifdef LIBO_INTERNAL_ONLY1 // "RTL_FAST_STRING"

  static OUStringNumber< int > number( int i, sal_Int16 radix = 10 )
  {
      return OUStringNumber< int >( i, radix );
  }
  static OUStringNumber< long long > number( long long ll, sal_Int16 radix = 10 )
  {
      return OUStringNumber< long long >( ll, radix );
  }
  static OUStringNumber< unsigned long long > number( unsigned long long ll, sal_Int16 radix = 10 )
  {
      return OUStringNumber< unsigned long long >( ll, radix );
  }
  static OUStringNumber< unsigned long long > number( unsigned int i, sal_Int16 radix = 10 )
  {
      return number( static_cast< unsigned long long >( i ), radix );
  }
  static OUStringNumber< long long > number( long i, sal_Int16 radix = 10)
  {
      return number( static_cast< long long >( i ), radix );
  }
  static OUStringNumber< unsigned long long > number( unsigned long i, sal_Int16 radix = 10 )
  {
      return number( static_cast< unsigned long long >( i ), radix );
  }
  static OUStringNumber< float > number( float f )
  {
      return OUStringNumber< float >( f );
  }
  static OUStringNumber< double > number( double d )
  {
      return OUStringNumber< double >( d );
  }
3132#else
  /**
    Returns the string representation of the integer argument.

    This function can't be used for language specific conversion.

    @param    i           an integer value
    @param    radix       the radix (between 2 and 36)
    @return   a string with the string representation of the argument.
    @since LibreOffice 4.1
  */
  static OUString number( int i, sal_Int16 radix = 10 )
  {
      sal_Unicode aBuf[RTL_USTR_MAX_VALUEOFINT3233];
      return OUString(aBuf, rtl_ustr_valueOfInt32(aBuf, i, radix));
  }
  /// @overload
  /// @since LibreOffice 4.1
  static OUString number( unsigned int i, sal_Int16 radix = 10 )
  {
      return number( static_cast< unsigned long long >( i ), radix );
  }
  /// @overload
  /// @since LibreOffice 4.1
  static OUString number( long i, sal_Int16 radix = 10)
  {
      return number( static_cast< long long >( i ), radix );
  }
  /// @overload
  /// @since LibreOffice 4.1
  static OUString number( unsigned long i, sal_Int16 radix = 10 )
  {
      return number( static_cast< unsigned long long >( i ), radix );
  }
  /// @overload
  /// @since LibreOffice 4.1
  static OUString number( long long ll, sal_Int16 radix = 10 )
  {
      sal_Unicode aBuf[RTL_USTR_MAX_VALUEOFINT6465];
      return OUString(aBuf, rtl_ustr_valueOfInt64(aBuf, ll, radix));
  }
  /// @overload
  /// @since LibreOffice 4.1
  static OUString number( unsigned long long ll, sal_Int16 radix = 10 )
  {
      sal_Unicode aBuf[RTL_USTR_MAX_VALUEOFUINT6465];
      return OUString(aBuf, rtl_ustr_valueOfUInt64(aBuf, ll, radix));
  }

  /**
    Returns the string representation of the float argument.

    This function can't be used for language specific conversion.

    @param    f           a float.
    @return   a string with the decimal representation of the argument.
    @since LibreOffice 4.1
  */
  static OUString number( float f )
  {
      sal_Unicode aBuf[RTL_USTR_MAX_VALUEOFFLOAT15];
      return OUString(aBuf, rtl_ustr_valueOfFloat(aBuf, f));
  }

  /**
    Returns the string representation of the double argument.

    This function can't be used for language specific conversion.

    @param    d           a double.
    @return   a string with the decimal representation of the argument.
    @since LibreOffice 4.1
  */
  static OUString number( double d )
  {
      sal_Unicode aBuf[RTL_USTR_MAX_VALUEOFDOUBLE25];
      return OUString(aBuf, rtl_ustr_valueOfDouble(aBuf, d));
  }
3210#endif

  /**
    Returns the string representation of the sal_Bool argument.

    If the sal_Bool is true, the string "true" is returned.
    If the sal_Bool is false, the string "false" is returned.
    This function can't be used for language specific conversion.

    @param    b   a sal_Bool.
    @return   a string with the string representation of the argument.
    @deprecated use boolean()
  */
  SAL_DEPRECATED("use boolean()")__attribute__((deprecated("use boolean()"))) static OUString valueOf( sal_Bool b )
  {
      return boolean(b);
  }

  /**
    Returns the string representation of the boolean argument.

    If the argument is true, the string "true" is returned.
    If the argument is false, the string "false" is returned.
    This function can't be used for language specific conversion.

    @param    b   a bool.
    @return   a string with the string representation of the argument.
    @since LibreOffice 4.1
  */
  static OUString boolean( bool b )
  {
      sal_Unicode aBuf[RTL_USTR_MAX_VALUEOFBOOLEAN6];
      return OUString(aBuf, rtl_ustr_valueOfBoolean(aBuf, b));
  }

  /**
    Returns the string representation of the char argument.

    @param    c   a character.
    @return   a string with the string representation of the argument.
    @deprecated use operator, function or constructor taking char or sal_Unicode argument
  */
  SAL_DEPRECATED("convert to OUString or use directly")__attribute__((deprecated("convert to OUString or use directly"
))) static OUString valueOf( sal_Unicode c )
  {
      return OUString( &c, 1 );
  }

  /**
    Returns the string representation of the int argument.

    This function can't be used for language specific conversion.

    @param    i           a int32.
    @param    radix       the radix (between 2 and 36)
    @return   a string with the string representation of the argument.
    @deprecated use number()
  */
  SAL_DEPRECATED("use number()")__attribute__((deprecated("use number()"))) static OUString valueOf( sal_Int32 i, sal_Int16 radix = 10 )
  {
      return number( i, radix );
  }

  /**
    Returns the string representation of the long argument.

    This function can't be used for language specific conversion.

    @param    ll          a int64.
    @param    radix       the radix (between 2 and 36)
    @return   a string with the string representation of the argument.
    @deprecated use number()
  */
  SAL_DEPRECATED("use number()")__attribute__((deprecated("use number()"))) static OUString valueOf( sal_Int64 ll, sal_Int16 radix = 10 )
  {
      return number( ll, radix );
  }

  /**
    Returns the string representation of the float argument.

    This function can't be used for language specific conversion.

    @param    f           a float.
    @return   a string with the string representation of the argument.
    @deprecated use number()
  */
  SAL_DEPRECATED("use number()")__attribute__((deprecated("use number()"))) static OUString valueOf( float f )
  {
      return number(f);
  }

  /**
    Returns the string representation of the double argument.

    This function can't be used for language specific conversion.

    @param    d           a double.
    @return   a string with the string representation of the argument.
    @deprecated use number()
  */
  SAL_DEPRECATED("use number()")__attribute__((deprecated("use number()"))) static OUString valueOf( double d )
  {
      return number(d);
  }

  /**
    Returns an OUString copied without conversion from an ASCII
    character string.

    Since this method is optimized for performance, the ASCII character
    values are not converted in any way. The caller has to make sure that
    all ASCII characters are in the allowed range between 0 and 127.
    The ASCII string must be NULL-terminated.

    Note that for string literals it is simpler and more efficient
    to directly use the OUString constructor.

    @param    value       the 8-Bit ASCII character string
    @return   a string with the string representation of the argument.
   */
  static OUString createFromAscii( const char * value )
  {
      rtl_uString* pNew = NULL__null;
      rtl_uString_newFromAscii( &pNew, value );
      return OUString( pNew, SAL_NO_ACQUIRE );
  }

3337#if defined LIBO_INTERNAL_ONLY1
  static OUString createFromAscii(std::string_view value) {
      rtl_uString * p = nullptr;
      rtl_uString_newFromLiteral(&p, value.data(), value.size(), 0); //TODO: check for overflow
      return OUString(p, SAL_NO_ACQUIRE);
  }
#endif

3345#if defined LIBO_INTERNAL_ONLY1
  operator std::u16string_view() const { return {getStr(), sal_uInt32(getLength())}; }
3347#endif

3349#if defined LIBO_INTERNAL_ONLY1
  // A wrapper for the first expression in an
  //
  //   OUString::Concat(e1) + e2 + ...
  //
  // concatenation chain, when neither of the first two e1, e2 is one of our rtl string-related
  // classes (so something like
  //
  //   OUString s = "a" + (b ? std::u16string_view(u"c") : std::u16string_view(u"dd"));
  //
  // would not compile):
  template<typename T> [[nodiscard]] static
  typename std::enable_if_t<
      ToStringHelper<T>::allowOUStringConcat, OUStringConcat<OUStringConcatMarker, T>>
  Concat(T const & value) { return OUStringConcat<OUStringConcatMarker, T>({}, value); }

  // This overload is needed so that an argument of type 'char const[N]' ends up as
  // 'OUStringConcat<rtl::OUStringConcatMarker, char const[N]>' rather than as
  // 'OUStringConcat<rtl::OUStringConcatMarker, char[N]>':
  template<typename T, std::size_t N> [[nodiscard]] static
  typename std::enable_if_t<
      ToStringHelper<T[N]>::allowOUStringConcat, OUStringConcat<OUStringConcatMarker, T[N]>>
  Concat(T (& value)[N]) { return OUStringConcat<OUStringConcatMarker, T[N]>({}, value); }
3372#endif

3374private:
  OUString & internalAppend( rtl_uString* pOtherData )
  {
      rtl_uString* pNewData = NULL__null;
      rtl_uString_newConcat( &pNewData, pData, pOtherData );
      if (pNewData == NULL__null) {
          throw std::bad_alloc();
      }
      rtl_uString_assign(&pData, pNewData);
      rtl_uString_release(pNewData);
      return *this;
  }

3387};

3389#if defined LIBO_INTERNAL_ONLY1
3390// Prevent the operator ==/!= overloads with 'sal_Unicode const *' parameter from
3391// being selected for nonsensical code like
3392//
3393//   if (ouIdAttr == nullptr)
3394//
3395void operator ==(OUString const &, std::nullptr_t) = delete;
3396void operator ==(std::nullptr_t, OUString const &) = delete;
3397void operator !=(OUString const &, std::nullptr_t) = delete;
3398void operator !=(std::nullptr_t, OUString const &) = delete;
3399#endif

3401#if defined LIBO_INTERNAL_ONLY1 // "RTL_FAST_STRING"
3402/// @cond INTERNAL

3404/**
@internal
3406*/
3407template<>
3408struct ToStringHelper< OUString >
  {
  static std::size_t length( const OUString& s ) { return s.getLength(); }
  static sal_Unicode* addData( sal_Unicode* buffer, const OUString& s ) { return addDataHelper( buffer, s.getStr(), s.getLength()); }
  static const bool allowOStringConcat = false;
  static const bool allowOUStringConcat = true;
  };

3416/**
@internal
3418*/
3419template<std::size_t N>
3420struct ToStringHelper< OUStringLiteral<N> >
  {
  static std::size_t length( const OUStringLiteral<N>& str ) { return str.getLength(); }
  static sal_Unicode* addData( sal_Unicode* buffer, const OUStringLiteral<N>& str ) { return addDataHelper( buffer, str.getStr(), str.getLength() ); }
  static const bool allowOStringConcat = false;
  static const bool allowOUStringConcat = true;
  };

3428/**
@internal
3430*/
3431template< typename charT, typename traits, typename T1, typename T2 >
3432inline std::basic_ostream<charT, traits> & operator <<(
  std::basic_ostream<charT, traits> & stream, OUStringConcat< T1, T2 >&& concat)
3434{
  return stream << OUString( std::move(concat) );
3436}

3438/// @endcond
3439#endif

3441/** A helper to use OUStrings with hash maps.

  Instances of this class are unary function objects that can be used as
  hash function arguments to std::unordered_map and similar constructs.
*/
3446struct OUStringHash
3447{
  /** Compute a hash code for a string.

      @param rString
      a string.

      @return
      a hash code for the string.  This hash code should not be stored
      persistently, as its computation may change in later revisions.
   */
  size_t operator()(const OUString& rString) const
      { return static_cast<size_t>(rString.hashCode()); }
3459};

3461/* ======================================================================= */

3463/** Convert an OString to an OUString, using a specific text encoding.

  The lengths of the two strings may differ (e.g., for double-byte
  encodings, UTF-7, UTF-8).

  @param rStr
  an OString to convert.

  @param encoding
  the text encoding to use for conversion.

  @param convertFlags
  flags which control the conversion.  Either use
  OSTRING_TO_OUSTRING_CVTFLAGS, or see
  <http://udk.openoffice.org/cpp/man/spec/textconversion.html> for more
  details.
*/
3480inline OUString OStringToOUString( const OString & rStr,
                                 rtl_TextEncoding encoding,
                                 sal_uInt32 convertFlags = OSTRING_TO_OUSTRING_CVTFLAGS(((sal_uInt32)0x0003) | ((sal_uInt32)0x0030) | ((sal_uInt32)0x0300
)) )
3483{
  return OUString( rStr.getStr(), rStr.getLength(), encoding, convertFlags );
3485}

3487/** Convert an OUString to an OString, using a specific text encoding.

  The lengths of the two strings may differ (e.g., for double-byte
  encodings, UTF-7, UTF-8).

  @param rUnicode
  an OUString to convert.

  @param encoding
  the text encoding to use for conversion.

  @param convertFlags
  flags which control the conversion.  Either use
  OUSTRING_TO_OSTRING_CVTFLAGS, or see
  <http://udk.openoffice.org/cpp/man/spec/textconversion.html> for more
  details.
*/
3504inline OString OUStringToOString( const OUString & rUnicode,
                                rtl_TextEncoding encoding,
                                sal_uInt32 convertFlags = OUSTRING_TO_OSTRING_CVTFLAGS(((sal_uInt32)0x0006) | ((sal_uInt32)0x0060) | ((sal_uInt32)0x0100
) | ((sal_uInt32)0x0400)) )
3507{
  return OString( rUnicode.getStr(), rUnicode.getLength(), encoding, convertFlags );
3509}

3511/* ======================================================================= */

3513/**
  Support for rtl::OUString in std::ostream (and thus in
  CPPUNIT_ASSERT or SAL_INFO macros, for example).

  The rtl::OUString is converted to UTF-8.

  @since LibreOffice 3.5.
3520*/
3521template< typename charT, typename traits >
3522inline std::basic_ostream<charT, traits> & operator <<(
  std::basic_ostream<charT, traits> & stream, OUString const & rString)
3524{
  return stream <<
      OUStringToOString(rString, RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76)));
      // best effort; potentially loses data due to conversion failures
      // (stray surrogate halves) and embedded null characters
3529}

3531} // namespace

3533#ifdef RTL_STRING_UNITTEST
3534namespace rtl
3535{
3536typedef rtlunittest::OUString OUString;
3537}
3538#endif

3540// In internal code, allow to use classes like OUString without having to
3541// explicitly refer to the rtl namespace, which is kind of superfluous given
3542// that OUString itself is namespaced by its OU prefix:
3543#if defined LIBO_INTERNAL_ONLY1 && !defined RTL_STRING_UNITTEST
3544using ::rtl::OUString;
3545using ::rtl::OUStringHash;
3546using ::rtl::OStringToOUString;
3547using ::rtl::OUStringToOString;
3548using ::rtl::OUStringLiteral;
3549using ::rtl::OUStringChar;
3550#endif

3552/// @cond INTERNAL
3553/**
Make OUString hashable by default for use in STL containers.

@since LibreOffice 6.0
3557*/
3558#if defined LIBO_INTERNAL_ONLY1
3559namespace std {

3561template<>
3562struct hash<::rtl::OUString>
3563{
  std::size_t operator()(::rtl::OUString const & s) const
  { return std::size_t(s.hashCode()); }
3566};

3568}

3570#endif
3571/// @endcond

3573#endif /* _RTL_USTRING_HXX */

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

←

/home/maarten/src/libreoffice/core/include/com/sun/star/uno/Any.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 * This file incorporates work covered by the following license notice:
10 *
11 *   Licensed to the Apache Software Foundation (ASF) under one or more
12 *   contributor license agreements. See the NOTICE file distributed
13 *   with this work for additional information regarding copyright
14 *   ownership. The ASF licenses this file to you under the Apache
15 *   License, Version 2.0 (the "License"); you may not use this file
16 *   except in compliance with the License. You may obtain a copy of
17 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef INCLUDED_COM_SUN_STAR_UNO_ANY_HXX
20#define INCLUDED_COM_SUN_STAR_UNO_ANY_HXX
21 
22#include "sal/config.h"
23 
24#include <algorithm>
25#include <cassert>
26#include <cstddef>
27#include <iomanip>
28#include <ostream>
29#include <utility>
30 
31#include "com/sun/star/uno/Any.h"
32#include "uno/data.h"
33#include "uno/sequence2.h"
34#include "com/sun/star/uno/Type.hxx"
35#include "com/sun/star/uno/Reference.h"
36#include "com/sun/star/uno/genfunc.hxx"
37#include "com/sun/star/uno/RuntimeException.hpp"
38#include "cppu/cppudllapi.h"
39#include "cppu/unotype.hxx"
40 
41extern "C" CPPU_DLLPUBLIC__attribute__ ((visibility("default"))) rtl_uString * SAL_CALL cppu_Any_extraction_failure_msg(
42    uno_Any const * pAny, typelib_TypeDescriptionReference * pType )
43    SAL_THROW_EXTERN_C()throw ();
44 
45namespace com
46{
47namespace sun
48{
49namespace star
50{
51namespace uno
52{
53 
54 
55inline Any::Any()
56{
57    ::uno_any_construct( this, NULL__null, NULL__null, cpp_acquire );
58}
59 
60 
61template <typename T>
62inline Any::Any( T const & value )
63{
64    ::uno_type_any_construct(
65        this, const_cast<T *>(&value),
66        ::cppu::getTypeFavourUnsigned(&value).getTypeLibType(),
67        cpp_acquire );
68}
69 
70inline Any::Any( bool value )
71{
72    sal_Bool b = value;
73    ::uno_type_any_construct(
74        this, &b, cppu::UnoType<bool>::get().getTypeLibType(),
75        cpp_acquire );
76}
77 
78#if defined LIBO_INTERNAL_ONLY1
79template<typename T1, typename T2>
80Any::Any(rtl::OUStringConcat<T1, T2> && value):
81    Any(rtl::OUString(std::move(value)))
82{}
83#endif
84 
85inline Any::Any( const Any & rAny )
86{
87    ::uno_type_any_construct( this, rAny.pData, rAny.pType, cpp_acquire );
88}
89 
90inline Any::Any( const void * pData_, const Type & rType )
91{
92    ::uno_type_any_construct(
93        this, const_cast< void * >( pData_ ), rType.getTypeLibType(),
94        cpp_acquire );
95}
96 
97inline Any::Any( const void * pData_, typelib_TypeDescription * pTypeDescr )
98{
99    ::uno_any_construct(
100        this, const_cast< void * >( pData_ ), pTypeDescr, cpp_acquire );
101}
102 
103inline Any::Any( const void * pData_, typelib_TypeDescriptionReference * pType_ )
104{
105    ::uno_type_any_construct(
106        this, const_cast< void * >( pData_ ), pType_, cpp_acquire );
107}
108 
109inline Any::~Any()
110{
111    ::uno_any_destruct(
112        this, cpp_release );
113}
114 
115inline Any & Any::operator = ( const Any & rAny )
116{
117    if (this != &rAny)
118    {
119        ::uno_type_any_assign(
120            this, rAny.pData, rAny.pType,
121            cpp_acquire, cpp_release );
122    }
123    return *this;
124}
125 
126#if defined LIBO_INTERNAL_ONLY1
127 
128namespace detail {
129 
130inline void moveAnyInternals(Any & from, Any & to) noexcept {
131    uno_any_construct(&to, nullptr, nullptr, &cpp_acquire);
132    std::swap(from.pType, to.pType);
133    std::swap(from.pData, to.pData);
134    std::swap(from.pReserved, to.pReserved);
135    if (to.pData == &from.pReserved) {
136        to.pData = &to.pReserved;
137    }
138    // This leaves from.pData (where "from" is now VOID) dangling to somewhere (cf.
139    // CONSTRUCT_EMPTY_ANY, cppu/source/uno/prim.hxx), but what's relevant is
140    // only that it isn't a nullptr (as e.g. >>= -> uno_type_assignData ->
141    // _assignData takes a null pSource to mean "construct a default value").
142}
143 
144}
145 
146Any::Any(Any && other) noexcept {
147    detail::moveAnyInternals(other, *this);
148}
149 
150Any & Any::operator =(Any && other) noexcept {
151    uno_any_destruct(this, &cpp_release);
152    detail::moveAnyInternals(other, *this);
153    return *this;
154}
155 
156#endif
157 
158inline ::rtl::OUString Any::getValueTypeName() const
159{
160    return ::rtl::OUString( pType->pTypeName );
161}
162 
163inline void Any::setValue( const void * pData_, const Type & rType )
164{
165    ::uno_type_any_assign(
166        this, const_cast< void * >( pData_ ), rType.getTypeLibType(),
167        cpp_acquire, cpp_release );
168}
169 
170inline void Any::setValue( const void * pData_, typelib_TypeDescriptionReference * pType_ )
171{
172    ::uno_type_any_assign(
173        this, const_cast< void * >( pData_ ), pType_,
174        cpp_acquire, cpp_release );
175}
176 
177inline void Any::setValue( const void * pData_, typelib_TypeDescription * pTypeDescr )
178{
179    ::uno_any_assign(
180        this, const_cast< void * >( pData_ ), pTypeDescr,
181        cpp_acquire, cpp_release );
182}
183 
184inline void Any::clear()
185{
186    ::uno_any_clear(
187        this, cpp_release );
188}
189 
190inline bool Any::isExtractableTo( const Type & rType ) const
191{
192    return ::uno_type_isAssignableFromData(
193        rType.getTypeLibType(), pData, pType,
194        cpp_queryInterface, cpp_release );
195}
196 
197 
198template <typename T>
199inline bool Any::has() const
200{
201    Type const & rType = ::cppu::getTypeFavourUnsigned(static_cast< T * >(0));
202    return ::uno_type_isAssignableFromData(
203        rType.getTypeLibType(), pData, pType,
204        cpp_queryInterface,
205        cpp_release );
206}
207 
208#if defined LIBO_INTERNAL_ONLY1
209template<> bool Any::has<Any>() const = delete;
210#endif
211 
212inline bool Any::operator == ( const Any & rAny ) const
213{
214    return ::uno_type_equalData(
215        pData, pType, rAny.pData, rAny.pType,
216        cpp_queryInterface, cpp_release );
217}
218 
219inline bool Any::operator != ( const Any & rAny ) const
220{
221    return (! ::uno_type_equalData(
222        pData, pType, rAny.pData, rAny.pType,
223        cpp_queryInterface, cpp_release ));
224}
225 
226 
227template< class C >
228inline Any SAL_CALL makeAny( const C & value )
229{
230    return Any(value);
231}
232 
233#if !defined LIBO_INTERNAL_ONLY1
234template<> Any makeAny(sal_uInt16 const & value)
235{ return Any(&value, cppu::UnoType<cppu::UnoUnsignedShortType>::get()); }
236#endif
237 
238template<typename T> Any toAny(T const & value) { return makeAny(value); }
239 
240template<> Any toAny(Any const & value) { return value; }
241 
242#if defined LIBO_INTERNAL_ONLY1
243 
244template<typename T1, typename T2>
245Any makeAny(rtl::OUStringConcat<T1, T2> && value)
246{ return Any(std::move(value)); }
247 
248template<typename T1, typename T2>
249Any toAny(rtl::OUStringConcat<T1, T2> && value)
250{ return makeAny(std::move(value)); }
251 
252template<typename T>
253Any makeAny(rtl::OUStringNumber<T> && value)
254{ return Any(OUString(std::move(value))); }
255 
256template<typename T>
257Any toAny(rtl::OUStringNumber<T> && value)
258{ return makeAny(std::move(value)); }
259 
260template<typename T> bool fromAny(Any const & any, T * value) {
261    assert(value != nullptr)(static_cast <bool> (value != nullptr) ? void (0) : __assert_fail
 ("value != nullptr", "/home/maarten/src/libreoffice/core/include/com/sun/star/uno/Any.hxx"
, 261, __extension__ __PRETTY_FUNCTION__));
262    return any >>= *value;
263}
264 
265template<> bool fromAny(Any const & any, Any * value) {
266    assert(value != nullptr)(static_cast <bool> (value != nullptr) ? void (0) : __assert_fail
 ("value != nullptr", "/home/maarten/src/libreoffice/core/include/com/sun/star/uno/Any.hxx"
, 266, __extension__ __PRETTY_FUNCTION__));
267    *value = any;
268    return true;
269}
270 
271#endif
272 
273template< class C >
274inline void SAL_CALL operator <<= ( Any & rAny, const C & value )
275{
276    const Type & rType = ::cppu::getTypeFavourUnsigned(&value);
277    ::uno_type_any_assign(
278        &rAny, const_cast< C * >( &value ), rType.getTypeLibType(),
279        cpp_acquire, cpp_release );
280}
281 
282// additionally for C++ bool:
283 
284template<>
285inline void SAL_CALL operator <<= ( Any & rAny, bool const & value )
286{
287    sal_Bool b = value;
288    ::uno_type_any_assign(
289        &rAny, &b, cppu::UnoType<bool>::get().getTypeLibType(),
290        cpp_acquire, cpp_release );
291}
292 
293 
294#ifdef LIBO_INTERNAL_ONLY1 // "RTL_FAST_STRING"
295template< class C1, class C2 >
296inline void SAL_CALL operator <<= ( Any & rAny, rtl::OUStringConcat< C1, C2 >&& value )
297{
298    const rtl::OUString str( std::move(value) );
299    const Type & rType = ::cppu::getTypeFavourUnsigned(&str);
300    ::uno_type_any_assign(
301        &rAny, const_cast< rtl::OUString * >( &str ), rType.getTypeLibType(),
302        cpp_acquire, cpp_release );
303}
304template<typename T1, typename T2>
305void operator <<=(Any &, rtl::OUStringConcat<T1, T2> const &) = delete;
306template< class C >
307inline void SAL_CALL operator <<= ( Any & rAny, rtl::OUStringNumber< C >&& value )
308{
309    const rtl::OUString str( std::move(value) );
310    const Type & rType = ::cppu::getTypeFavourUnsigned(&str);
311    ::uno_type_any_assign(
312        &rAny, const_cast< rtl::OUString * >( &str ), rType.getTypeLibType(),
313        cpp_acquire, cpp_release );
314}
315template<typename T>
316void operator <<=(Any &, rtl::OUStringNumber<T> const &) = delete;
317#endif
318 
319#if defined LIBO_INTERNAL_ONLY1
320template<> void SAL_CALL operator <<=(Any &, Any const &) = delete;
321#endif
322 
323template< class C >
324inline bool SAL_CALL operator >>= ( const Any & rAny, C & value )
325{
326    const Type & rType = ::cppu::getTypeFavourUnsigned(&value);
327    return ::uno_type_assignData(
328        &value, rType.getTypeLibType(),
329        rAny.pData, rAny.pType,
330        cpp_queryInterface,
331        cpp_acquire, cpp_release );
332}
333 
334// bool
335 
336template<>
337inline bool SAL_CALL operator >>= ( const ::com::sun::star::uno::Any & rAny, sal_Bool & value )
338{
339    if (typelib_TypeClass_BOOLEAN == rAny.pType->eTypeClass)
340    {
341        value = bool(* static_cast< const sal_Bool * >( rAny.pData ));
342        return true;
343    }
344    return false;
345}
346 
347template<>
348inline bool SAL_CALL operator == ( const Any & rAny, const sal_Bool & value )
349{
350    return (typelib_TypeClass_BOOLEAN == rAny.pType->eTypeClass &&
351            bool(value) == bool(* static_cast< const sal_Bool * >( rAny.pData )));
352}
353 
354 
355template<>
356inline bool SAL_CALL operator >>= ( Any const & rAny, bool & value )
357{
358    if (rAny.pType->eTypeClass == typelib_TypeClass_BOOLEAN)
359    {
360        value = *static_cast< sal_Bool const * >( rAny.pData );
361        return true;
362    }
363    return false;
364}
365 
366 
367template<>
368inline bool SAL_CALL operator == ( Any const & rAny, bool const & value )
369{
370    return (rAny.pType->eTypeClass == typelib_TypeClass_BOOLEAN &&
371            (value ==
372             bool(*static_cast< sal_Bool const * >( rAny.pData ))));
373}
374 
375// byte
376 
377template<>
378inline bool SAL_CALL operator >>= ( const ::com::sun::star::uno::Any & rAny, sal_Int8 & value )
379{
380    if (typelib_TypeClass_BYTE == rAny.pType->eTypeClass)
381    {
382        value = * static_cast< const sal_Int8 * >( rAny.pData );
383        return true;
384    }
385    return false;
386}
387// short
388 
389template<>
390inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int16 & value )
391{
392    switch (rAny.pType->eTypeClass)
393    {
394    case typelib_TypeClass_BYTE:
395        value = * static_cast< const sal_Int8 * >( rAny.pData );
396        return true;
397    case typelib_TypeClass_SHORT:
398    case typelib_TypeClass_UNSIGNED_SHORT:
399        value = * static_cast< const sal_Int16 * >( rAny.pData );
400        return true;
401    default:
402        return false;
403    }
404}
405 
406template<>
407inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt16 & value )
408{
409    switch (rAny.pType->eTypeClass)
410    {
411    case typelib_TypeClass_BYTE:
412        value = static_cast<sal_uInt16>( * static_cast< const sal_Int8 * >( rAny.pData ) );
413        return true;
414    case typelib_TypeClass_SHORT:
415    case typelib_TypeClass_UNSIGNED_SHORT:
416        value = * static_cast< const sal_uInt16 * >( rAny.pData );
417        return true;
418    default:
419        return false;
420    }
421}
422// long
423 
424template<>
425inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int32 & value )
426{
427    switch (rAny.pType->eTypeClass)
428    {
429    case typelib_TypeClass_BYTE:
430        value = * static_cast< const sal_Int8 * >( rAny.pData );
431        return true;
432    case typelib_TypeClass_SHORT:
433        value = * static_cast< const sal_Int16 * >( rAny.pData );
434        return true;
435    case typelib_TypeClass_UNSIGNED_SHORT:
436        value = * static_cast< const sal_uInt16 * >( rAny.pData );
437        return true;
438    case typelib_TypeClass_LONG:
439    case typelib_TypeClass_UNSIGNED_LONG:
440        value = * static_cast< const sal_Int32 * >( rAny.pData );
441        return true;
442    default:
443        return false;
444    }
445}
446 
447template<>
448inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt32 & value )
449{
450    switch (rAny.pType->eTypeClass)
39
←
Control jumps to the 'default' case at line 465→
451    {
452    case typelib_TypeClass_BYTE:
453        value = static_cast<sal_uInt32>( * static_cast< const sal_Int8 * >( rAny.pData ) );
454        return true;
455    case typelib_TypeClass_SHORT:
456        value = static_cast<sal_uInt32>( * static_cast< const sal_Int16 * >( rAny.pData ) );
457        return true;
458    case typelib_TypeClass_UNSIGNED_SHORT:
459        value = * static_cast< const sal_uInt16 * >( rAny.pData );
460        return true;
461    case typelib_TypeClass_LONG:
462    case typelib_TypeClass_UNSIGNED_LONG:
463        value = * static_cast< const sal_uInt32 * >( rAny.pData );
464        return true;
465    default:
466        return false;
40
←
Returning without writing to 'value'→
467    }
468}
469// hyper
470 
471template<>
472inline bool SAL_CALL operator >>= ( const Any & rAny, sal_Int64 & value )
473{
474    switch (rAny.pType->eTypeClass)
475    {
476    case typelib_TypeClass_BYTE:
477        value = * static_cast< const sal_Int8 * >( rAny.pData );
478        return true;
479    case typelib_TypeClass_SHORT:
480        value = * static_cast< const sal_Int16 * >( rAny.pData );
481        return true;
482    case typelib_TypeClass_UNSIGNED_SHORT:
483        value = * static_cast< const sal_uInt16 * >( rAny.pData );
484        return true;
485    case typelib_TypeClass_LONG:
486        value = * static_cast< const sal_Int32 * >( rAny.pData );
487        return true;
488    case typelib_TypeClass_UNSIGNED_LONG:
489        value = * static_cast< const sal_uInt32 * >( rAny.pData );
490        return true;
491    case typelib_TypeClass_HYPER:
492    case typelib_TypeClass_UNSIGNED_HYPER:
493        value = * static_cast< const sal_Int64 * >( rAny.pData );
494        return true;
495    default:
496        return false;
497    }
498}
499 
500template<>
501inline bool SAL_CALL operator >>= ( const Any & rAny, sal_uInt64 & value )
502{
503    switch (rAny.pType->eTypeClass)
504    {
505    case typelib_TypeClass_BYTE:
506        value = static_cast<sal_uInt64>( * static_cast< const sal_Int8 * >( rAny.pData ) );
507        return true;
508    case typelib_TypeClass_SHORT:
509        value = static_cast<sal_uInt64>( * static_cast< const sal_Int16 * >( rAny.pData ) );
510        return true;
511    case typelib_TypeClass_UNSIGNED_SHORT:
512        value = * static_cast< const sal_uInt16 * >( rAny.pData );
513        return true;
514    case typelib_TypeClass_LONG:
515        value = static_cast<sal_uInt64>( * static_cast< const sal_Int32 * >( rAny.pData ) );
516        return true;
517    case typelib_TypeClass_UNSIGNED_LONG:
518        value = * static_cast< const sal_uInt32 * >( rAny.pData );
519        return true;
520    case typelib_TypeClass_HYPER:
521    case typelib_TypeClass_UNSIGNED_HYPER:
522        value = * static_cast< const sal_uInt64 * >( rAny.pData );
523        return true;
524    default:
525        return false;
526    }
527}
528// float
529 
530template<>
531inline bool SAL_CALL operator >>= ( const Any & rAny, float & value )
532{
533    switch (rAny.pType->eTypeClass)
534    {
535    case typelib_TypeClass_BYTE:
536        value = * static_cast< const sal_Int8 * >( rAny.pData );
537        return true;
538    case typelib_TypeClass_SHORT:
539        value = * static_cast< const sal_Int16 * >( rAny.pData );
540        return true;
541    case typelib_TypeClass_UNSIGNED_SHORT:
542        value = * static_cast< const sal_uInt16 * >( rAny.pData );
543        return true;
544    case typelib_TypeClass_FLOAT:
545        value = * static_cast< const float * >( rAny.pData );
546        return true;
547    default:
548        return false;
549    }
550}
551// double
552 
553template<>
554inline bool SAL_CALL operator >>= ( const Any & rAny, double & value )
555{
556    switch (rAny.pType->eTypeClass)
557    {
558    case typelib_TypeClass_BYTE:
559        value = * static_cast< const sal_Int8 * >( rAny.pData );
560        return true;
561    case typelib_TypeClass_SHORT:
562        value = * static_cast< const sal_Int16 * >( rAny.pData );
563        return true;
564    case typelib_TypeClass_UNSIGNED_SHORT:
565        value = * static_cast< const sal_uInt16 * >( rAny.pData );
566        return true;
567    case typelib_TypeClass_LONG:
568        value = * static_cast< const sal_Int32 * >( rAny.pData );
569        return true;
570    case typelib_TypeClass_UNSIGNED_LONG:
571        value = * static_cast< const sal_uInt32 * >( rAny.pData );
572        return true;
573    case typelib_TypeClass_FLOAT:
574        value = * static_cast< const float * >( rAny.pData );
575        return true;
576    case typelib_TypeClass_DOUBLE:
577        value = * static_cast< const double * >( rAny.pData );
578        return true;
579    default:
580        return false;
581    }
582}
583// string
584 
585template<>
586inline bool SAL_CALL operator >>= ( const Any & rAny, ::rtl::OUString & value )
587{
588    if (typelib_TypeClass_STRING == rAny.pType->eTypeClass)
589    {
590        value = * static_cast< const ::rtl::OUString * >( rAny.pData );
591        return true;
592    }
593    return false;
594}
595 
596template<>
597inline bool SAL_CALL operator == ( const Any & rAny, const ::rtl::OUString & value )
598{
599    return (typelib_TypeClass_STRING == rAny.pType->eTypeClass &&
600            value == * static_cast< const ::rtl::OUString * >( rAny.pData ) );
601}
602// type
603 
604template<>
605inline bool SAL_CALL operator >>= ( const Any & rAny, Type & value )
606{
607    if (typelib_TypeClass_TYPE == rAny.pType->eTypeClass)
608    {
609        value = * static_cast< const Type * >( rAny.pData );
610        return true;
611    }
612    return false;
613}
614 
615template<>
616inline bool SAL_CALL operator == ( const Any & rAny, const Type & value )
617{
618    return (typelib_TypeClass_TYPE == rAny.pType->eTypeClass &&
619            value.equals( * static_cast< const Type * >( rAny.pData ) ));
620}
621// any
622 
623#if defined LIBO_INTERNAL_ONLY1
624template<> bool SAL_CALL operator >>=(Any const &, Any &) = delete;
625#else
626template<>
627inline bool SAL_CALL operator >>= ( const Any & rAny, Any & value )
628{
629    if (&rAny != &value)
630    {
631        ::uno_type_any_assign(
632            &value, rAny.pData, rAny.pType,
633            cpp_acquire, cpp_release );
634    }
635    return true;
636}
637#endif
638// interface
639 
640template<>
641inline bool SAL_CALL operator == ( const Any & rAny, const BaseReference & value )
642{
643    if (typelib_TypeClass_INTERFACE == rAny.pType->eTypeClass)
644    {
645        return static_cast< const BaseReference * >( rAny.pData )->operator == ( value );
646    }
647    return false;
648}
649 
650// operator to compare to an any.
651 
652template< class C >
653inline bool SAL_CALL operator == ( const Any & rAny, const C & value )
654{
655    const Type & rType = ::cppu::getTypeFavourUnsigned(&value);
656    return ::uno_type_equalData(
657        rAny.pData, rAny.pType,
658        const_cast< C * >( &value ), rType.getTypeLibType(),
659        cpp_queryInterface, cpp_release );
660}
661// operator to compare to an any.  may use specialized operators ==.
662 
663template< class C >
664inline bool SAL_CALL operator != ( const Any & rAny, const C & value )
665{
666    return (! operator == ( rAny, value ));
667}
668 
669template <typename T>
670T Any::get() const
671{
672    T value = T();
673    if (! (*this >>= value)) {
674        throw RuntimeException(
675            ::rtl::OUString(
676                cppu_Any_extraction_failure_msg(
677                    this,
678                    ::cppu::getTypeFavourUnsigned(&value).getTypeLibType() ),
679                SAL_NO_ACQUIRE ) );
680    }
681    return value;
682}
683 
684#if defined LIBO_INTERNAL_ONLY1
685template<> Any Any::get() const = delete;
686#endif
687 
688/**
689   Support for Any in std::ostream (and thus in CPPUNIT_ASSERT or SAL_INFO
690   macros, for example).
691 
692   @since LibreOffice 4.2
693*/
694template<typename charT, typename traits>
695inline std::basic_ostream<charT, traits> &operator<<(std::basic_ostream<charT, traits> &o, Any const &any) {
696    o << "<Any: (" << any.getValueTypeName() << ')';
697    switch(any.pType->eTypeClass) {
698        case typelib_TypeClass_VOID:
699            break;
700        case typelib_TypeClass_BOOLEAN:
701            o << ' ' << any.get<bool>();
702            break;
703        case typelib_TypeClass_BYTE:
704        case typelib_TypeClass_SHORT:
705        case typelib_TypeClass_LONG:
706        case typelib_TypeClass_HYPER:
707            o << ' ' << any.get<sal_Int64>();
708            break;
709        case typelib_TypeClass_UNSIGNED_SHORT:
710        case typelib_TypeClass_UNSIGNED_LONG:
711        case typelib_TypeClass_UNSIGNED_HYPER:
712            o << ' ' << any.get<sal_uInt64>();
713            break;
714        case typelib_TypeClass_FLOAT:
715        case typelib_TypeClass_DOUBLE:
716            o << ' ' << any.get<double>();
717            break;
718        case typelib_TypeClass_CHAR: {
719            std::ios_base::fmtflags flgs = o.setf(
720                std::ios_base::hex, std::ios_base::basefield);
721            charT fill = o.fill('0');
722            o << " U+" << std::setw(4)
723              << unsigned(*static_cast<sal_Unicode const *>(any.getValue()));
724            o.setf(flgs);
725            o.fill(fill);
726            break;
727        }
728        case typelib_TypeClass_STRING:
729            o << ' ' << any.get<rtl::OUString>();
730            break;
731        case typelib_TypeClass_TYPE:
732            o << ' ' << any.get<css::uno::Type>().getTypeName();
733            break;
734        case typelib_TypeClass_SEQUENCE:
735            o << " len "
736              << ((*static_cast<uno_Sequence * const *>(any.getValue()))->
737                  nElements);
738            break;
739        case typelib_TypeClass_ENUM:
740            o << ' ' << *static_cast<sal_Int32 const *>(any.getValue());
741            break;
742        case typelib_TypeClass_STRUCT:
743        case typelib_TypeClass_EXCEPTION:
744            o << ' ' << any.getValue();
745            break;
746        case typelib_TypeClass_INTERFACE:
747            o << ' ' << *static_cast<void * const *>(any.getValue());
748            break;
749        default:
750            assert(false)(static_cast <bool> (false) ? void (0) : __assert_fail (
"false", "/home/maarten/src/libreoffice/core/include/com/sun/star/uno/Any.hxx"
, 750, __extension__ __PRETTY_FUNCTION__)); // this cannot happen
751            break;
752    }
753    o << '>';
754    return o;
755}
756 
757}
758}
759}
760}
761 
762#endif
763 
764/* vim:set shiftwidth=4 softtabstop=4 expandtab: */