/home/maarten/src/libreoffice/core/sw/source/core/txtnode/fntcap.cxx

Bug Summary

File:	home/maarten/src/libreoffice/core/sw/source/core/txtnode/fntcap.cxx
Warning:	line 619, column 13 Use of memory after it is freed

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

/home/maarten/src/libreoffice/core/sw/source/core/txtnode/fntcap.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 <editeng/svxfont.hxx>

22#include <vcl/outdev.hxx>
23#include <com/sun/star/i18n/CharType.hpp>
24#include <com/sun/star/i18n/WordType.hpp>
25#include <com/sun/star/i18n/XBreakIterator.hpp>

27#include <fntcache.hxx>
28#include <swfont.hxx>
29#include <breakit.hxx>
30#include <txtfrm.hxx>
31#include <scriptinfo.hxx>
32#include <fntcap.hxx>

34using namespace ::com::sun::star::i18n;

36namespace {

38// The information encapsulated in SwCapitalInfo is required
39// by the ::Do functions. They contain the information about
40// the original string, whereas rDo.GetInf() contains information
41// about the display string.
42class SwCapitalInfo
43{
44public:
  explicit SwCapitalInfo( const OUString& rOrigText ) :
      rString( rOrigText ), nIdx( 0 ), nLen( 0 ) {};
  const OUString& rString;
  TextFrameIndex nIdx;
  TextFrameIndex nLen;
50};

52}

54// rFnt: required for CalcCaseMap
55// rOrigString: The original string
56// nOfst: Position of the substring in rOrigString
57// nLen: Length if the substring in rOrigString
58// nIdx: Refers to a position in the display string and should be mapped
59//       to a position in rOrigString
60TextFrameIndex sw_CalcCaseMap(const SwFont& rFnt,
                          const OUString& rOrigString,
                          TextFrameIndex const nOfst,
                          TextFrameIndex const nLen,
                          TextFrameIndex const nIdx)
65{
  int j = 0;
  const TextFrameIndex nEnd = nOfst + nLen;
  OSL_ENSURE( sal_Int32(nEnd) <= rOrigString.getLength(), "sw_CalcCaseMap: Wrong parameters" )do { if (true && (!(sal_Int32(nEnd) <= rOrigString
.getLength()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/txtnode/fntcap.cxx"
 ":" "68" ": "), "%s", "sw_CalcCaseMap: Wrong parameters"); }
 } while (false);

  // special case for title case:
  const bool bTitle = SvxCaseMap::Capitalize == rFnt.GetCaseMap();
  for (TextFrameIndex i = nOfst; i < nEnd; ++i)
  {
      OUString aTmp(rOrigString.copy(sal_Int32(i), 1));

      if ( !bTitle ||
           g_pBreakIt->GetBreakIter()->isBeginWord(
               rOrigString, sal_Int32(i),
               g_pBreakIt->GetLocale( rFnt.GetLanguage() ),
               WordType::ANYWORD_IGNOREWHITESPACES ) )
          aTmp = rFnt.GetActualFont().CalcCaseMap( aTmp );

      j += aTmp.getLength();

      if (TextFrameIndex(j) > nIdx)
          return i;
  }

  return nOfst + nLen;
90}

92class SwDoCapitals
93{
94protected:
  SwDrawTextInfo &rInf;
  SwCapitalInfo* pCapInf; // refers to additional information
                         // required by the ::Do function
  explicit SwDoCapitals ( SwDrawTextInfo &rInfo ) : rInf( rInfo ), pCapInf( nullptr ) { }
  ~SwDoCapitals() {}
100public:
  virtual void Init( SwFntObj *pUpperFont, SwFntObj *pLowerFont ) = 0;
  virtual void Do() = 0;
  OutputDevice& GetOut() { return rInf.GetOut(); }
  SwDrawTextInfo& GetInf() { return rInf; }
  SwCapitalInfo* GetCapInf() const { return pCapInf; }
  void SetCapInf( SwCapitalInfo& rNew ) { pCapInf = &rNew; }
107};

109namespace {

111class SwDoGetCapitalSize : public SwDoCapitals
112{
113protected:
  Size aTextSize;
115public:
  explicit SwDoGetCapitalSize( SwDrawTextInfo &rInfo ) : SwDoCapitals ( rInfo ) { }
  virtual ~SwDoGetCapitalSize() {}
  virtual void Init( SwFntObj *pUpperFont, SwFntObj *pLowerFont ) override;
  virtual void Do() override;
  const Size &GetSize() const { return aTextSize; }
121};

123}

125void SwDoGetCapitalSize::Init( SwFntObj *, SwFntObj * )
126{
  aTextSize.setHeight( 0 );
  aTextSize.setWidth( 0 );
129}

131void SwDoGetCapitalSize::Do()
132{
  aTextSize.AdjustWidth(rInf.GetSize().Width() );
  if( rInf.GetUpper() )
      aTextSize.setHeight( rInf.GetSize().Height() );
136}

138Size SwSubFont::GetCapitalSize( SwDrawTextInfo& rInf )
139{
  // Start:
  const long nOldKern = rInf.GetKern();
  rInf.SetKern( CheckKerning() );
  rInf.SetPos( Point() );
  rInf.SetSpace( 0 );
  rInf.SetDrawSpace( false );
  SwDoGetCapitalSize aDo( rInf );
  DoOnCapitals( aDo );
  Size aTextSize( aDo.GetSize() );

  // End:
  if( !aTextSize.Height() )
  {
      SV_STAT( nGetTextSize );
      aTextSize.setHeight( short ( rInf.GetpOut()->GetTextHeight() ) );
  }
  rInf.SetKern( nOldKern );
  return aTextSize;
158}

160namespace {

162class SwDoGetCapitalBreak : public SwDoCapitals
163{
164protected:
  long nTextWidth;
  TextFrameIndex m_nBreak;

168public:
  SwDoGetCapitalBreak( SwDrawTextInfo &rInfo, long const nWidth)
      :   SwDoCapitals ( rInfo )
      ,   nTextWidth( nWidth )
      ,   m_nBreak( -1 )
      { }
  virtual ~SwDoGetCapitalBreak() {}
  virtual void Init( SwFntObj *pUpperFont, SwFntObj *pLowerFont ) override;
  virtual void Do() override;
  TextFrameIndex getBreak() const { return m_nBreak; }
178};

180}

182void SwDoGetCapitalBreak::Init( SwFntObj *, SwFntObj * )
183{
184}

186void SwDoGetCapitalBreak::Do()
187{
  if ( !nTextWidth )
      return;

  if ( rInf.GetSize().Width() < nTextWidth )
      nTextWidth -= rInf.GetSize().Width();
  else
  {
      TextFrameIndex nEnd = rInf.GetEnd();
      m_nBreak = TextFrameIndex(GetOut().GetTextBreak(
                     rInf.GetText(), nTextWidth, sal_Int32(rInf.GetIdx()),
                     sal_Int32(rInf.GetLen()), rInf.GetKern()));

      if (m_nBreak > nEnd || m_nBreak < TextFrameIndex(0))
          m_nBreak = nEnd;

      // m_nBreak may be relative to the display string. It has to be
      // calculated relative to the original string:
      if ( GetCapInf()  )
      {
          if ( GetCapInf()->nLen != rInf.GetLen() )
              m_nBreak = sw_CalcCaseMap( *rInf.GetFont(),
                                        GetCapInf()->rString,
                                        GetCapInf()->nIdx,
                                        GetCapInf()->nLen, m_nBreak );
          else
              m_nBreak = m_nBreak + GetCapInf()->nIdx;
      }

      nTextWidth = 0;
  }
218}

220TextFrameIndex SwFont::GetCapitalBreak( SwViewShell const * pSh, const OutputDevice* pOut,
  const SwScriptInfo* pScript, const OUString& rText, long const nTextWidth,
  TextFrameIndex const nIdx, TextFrameIndex const nLen)
223{
  // Start:
  Point aPos( 0, 0 );
  SwDrawTextInfo aInfo(pSh, *const_cast<OutputDevice*>(pOut), pScript, rText, nIdx, nLen,
      0, false);
  aInfo.SetPos( aPos );
  aInfo.SetSpace( 0 );
  aInfo.SetWrong( nullptr );
  aInfo.SetGrammarCheck( nullptr );
  aInfo.SetSmartTags( nullptr );
  aInfo.SetDrawSpace( false );
  aInfo.SetKern( CheckKerning() );
  aInfo.SetKanaComp( pScript ? 0 : 100 );
  aInfo.SetFont( this );

  SwDoGetCapitalBreak aDo(aInfo, nTextWidth);
  DoOnCapitals( aDo );
  return aDo.getBreak();
241}

243namespace {

245class SwDoDrawCapital : public SwDoCapitals
246{
247protected:
  SwFntObj *pUpperFnt;
  SwFntObj *pLowerFnt;
250public:
  explicit SwDoDrawCapital( SwDrawTextInfo &rInfo ) :
      SwDoCapitals( rInfo ), pUpperFnt(nullptr), pLowerFnt(nullptr)
      { }
  virtual ~SwDoDrawCapital() {}
  virtual void Init( SwFntObj *pUpperFont, SwFntObj *pLowerFont ) override;
  virtual void Do() override;
  void DrawSpace( Point &rPos );
258};

260}

262void SwDoDrawCapital::Init( SwFntObj *pUpperFont, SwFntObj *pLowerFont )
263{
  pUpperFnt = pUpperFont;
  pLowerFnt = pLowerFont;
266}

268void SwDoDrawCapital::Do()
269{
  SV_STAT( nDrawText );
  const sal_uInt16 nOrgWidth = rInf.GetWidth();
  rInf.SetWidth( sal_uInt16(rInf.GetSize().Width()) );
  if ( rInf.GetUpper() )
      pUpperFnt->DrawText( rInf );
  else
  {
      bool bOldBullet = rInf.GetBullet();
      rInf.SetBullet( false );
      pLowerFnt->DrawText( rInf );
      rInf.SetBullet( bOldBullet );
  }

  OSL_ENSURE( pUpperFnt, "No upper font, dying soon!")do { if (true && (!(pUpperFnt))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/txtnode/fntcap.cxx"
 ":" "283" ": "), "%s", "No upper font, dying soon!"); } } while
 (false);
  rInf.Shift( pUpperFnt->GetFont().GetOrientation() );
  rInf.SetWidth( nOrgWidth );
286}

288void SwDoDrawCapital::DrawSpace( Point &rPos )
289{
  long nDiff = rInf.GetPos().X() - rPos.X();

  Point aPos( rPos );
  const bool bSwitchL2R = rInf.GetFrame()->IsRightToLeft() &&
                        ! rInf.IsIgnoreFrameRTL();

  if ( bSwitchL2R )
     rInf.GetFrame()->SwitchLTRtoRTL( aPos );

  const ComplexTextLayoutFlags nMode = rInf.GetpOut()->GetLayoutMode();
  const bool bBidiPor = ( bSwitchL2R !=
                          ( ComplexTextLayoutFlags::Default != ( ComplexTextLayoutFlags::BiDiRtl & nMode ) ) );

  if ( bBidiPor )
      nDiff = -nDiff;

  if ( rInf.GetFrame()->IsVertical() )
      rInf.GetFrame()->SwitchHorizontalToVertical( aPos );

  if ( nDiff )
  {
      rInf.ApplyAutoColor();
      GetOut().DrawStretchText( aPos, nDiff,
          "  ", 0, 2 );
  }
  rPos.setX( rInf.GetPos().X() + rInf.GetWidth() );
316}

318void SwSubFont::DrawCapital( SwDrawTextInfo &rInf )
319{
  // Precondition: rInf.GetPos() has already been calculated

  rInf.SetDrawSpace( GetUnderline() != LINESTYLE_NONE ||
                     GetOverline()  != LINESTYLE_NONE ||
                     GetStrikeout() != STRIKEOUT_NONE );
  SwDoDrawCapital aDo( rInf );
  DoOnCapitals( aDo );
327}

329namespace {

331class SwDoCapitalCursorOfst : public SwDoCapitals
332{
333protected:
  SwFntObj *pUpperFnt;
  SwFntObj *pLowerFnt;
  TextFrameIndex nCursor;
  sal_uInt16 nOfst;
338public:
  SwDoCapitalCursorOfst( SwDrawTextInfo &rInfo, const sal_uInt16 nOfs ) :
      SwDoCapitals( rInfo ), pUpperFnt(nullptr), pLowerFnt(nullptr), nCursor( 0 ), nOfst( nOfs )
      { }
  virtual ~SwDoCapitalCursorOfst() {}
  virtual void Init( SwFntObj *pUpperFont, SwFntObj *pLowerFont ) override;
  virtual void Do() override;

  TextFrameIndex GetCursor() const { return nCursor; }
347};

349}

351void SwDoCapitalCursorOfst::Init( SwFntObj *pUpperFont, SwFntObj *pLowerFont )
352{
  pUpperFnt = pUpperFont;
  pLowerFnt = pLowerFont;
355}

357void SwDoCapitalCursorOfst::Do()
358{
  if ( !nOfst )
      return;

  if ( static_cast<long>(nOfst) > rInf.GetSize().Width() )
  {
      nOfst -= rInf.GetSize().Width();
      nCursor = nCursor + rInf.GetLen();
  }
  else
  {
      SwDrawTextInfo aDrawInf( rInf.GetShell(), *rInf.GetpOut(),
                               rInf.GetScriptInfo(),
                               rInf.GetText(),
                               rInf.GetIdx(),
                               rInf.GetLen(), 0, false );
      aDrawInf.SetOffset( nOfst );
      aDrawInf.SetKern( rInf.GetKern() );
      aDrawInf.SetKanaComp( rInf.GetKanaComp() );
      aDrawInf.SetFrame( rInf.GetFrame() );
      aDrawInf.SetFont( rInf.GetFont() );

      if ( rInf.GetUpper() )
      {
          aDrawInf.SetSpace( 0 );
          nCursor = nCursor + pUpperFnt->GetModelPositionForViewPoint( aDrawInf );
      }
      else
      {
          aDrawInf.SetSpace( rInf.GetSpace() );
          nCursor = nCursor + pLowerFnt->GetModelPositionForViewPoint( aDrawInf );
      }
      nOfst = 0;
  }
392}

394TextFrameIndex SwSubFont::GetCapitalCursorOfst( SwDrawTextInfo& rInf )
395{
  const long nOldKern = rInf.GetKern();
  rInf.SetKern( CheckKerning() );
  SwDoCapitalCursorOfst aDo( rInf, rInf.GetOffset() );
  rInf.SetPos( Point() );
  rInf.SetDrawSpace( false );
  DoOnCapitals( aDo );
  rInf.SetKern( nOldKern );
  return aDo.GetCursor();
404}

406namespace {

408class SwDoDrawStretchCapital : public SwDoDrawCapital
409{
  const TextFrameIndex nStrLen;
  const sal_uInt16 nCapWidth;
  const sal_uInt16 nOrgWidth;
413public:
  virtual void Do() override;

  SwDoDrawStretchCapital( SwDrawTextInfo &rInfo, const sal_uInt16 nCapitalWidth )
          : SwDoDrawCapital( rInfo ),
            nStrLen( rInfo.GetLen() ),
            nCapWidth( nCapitalWidth ),
            nOrgWidth( rInfo.GetWidth() )
      { }
422};

424}

426void SwDoDrawStretchCapital::Do()
427{
  SV_STAT( nDrawStretchText );
  long nPartWidth = rInf.GetSize().Width();

  if( rInf.GetLen() )
  {
      // small caps and kerning
      long nDiff = long(nOrgWidth) - long(nCapWidth);
      if( nDiff )
      {
          nDiff *= sal_Int32(rInf.GetLen());
          nDiff /= sal_Int32(nStrLen);
          nDiff += nPartWidth;
          if( 0 < nDiff )
              nPartWidth = nDiff;
      }

      rInf.ApplyAutoColor();

      Point aPos( rInf.GetPos() );
      const bool bSwitchL2R = rInf.GetFrame()->IsRightToLeft() &&
                            ! rInf.IsIgnoreFrameRTL();

      if ( bSwitchL2R )
          rInf.GetFrame()->SwitchLTRtoRTL( aPos );

      if ( rInf.GetFrame()->IsVertical() )
          rInf.GetFrame()->SwitchHorizontalToVertical( aPos );

      // Optimise:
      if (TextFrameIndex(1) >= rInf.GetLen())
          GetOut().DrawText(aPos, rInf.GetText(), sal_Int32(rInf.GetIdx()),
              sal_Int32(rInf.GetLen()));
      else
          GetOut().DrawStretchText(aPos, nPartWidth, rInf.GetText(),
                  sal_Int32(rInf.GetIdx()), sal_Int32(rInf.GetLen()));
  }
  const_cast<Point&>(rInf.GetPos()).AdjustX(nPartWidth );
465}

467void SwSubFont::DrawStretchCapital( SwDrawTextInfo &rInf )
468{
  // Precondition: rInf.GetPos() has already been calculated

  if (rInf.GetLen() == TextFrameIndex(COMPLETE_STRING))
      rInf.SetLen(TextFrameIndex(rInf.GetText().getLength()));

  const Point aOldPos = rInf.GetPos();
  const sal_uInt16 nCapWidth = static_cast<sal_uInt16>( GetCapitalSize( rInf ).Width() );
  rInf.SetPos(aOldPos);

  rInf.SetDrawSpace( GetUnderline() != LINESTYLE_NONE ||
                     GetOverline()  != LINESTYLE_NONE ||
                     GetStrikeout() != STRIKEOUT_NONE );
  SwDoDrawStretchCapital aDo( rInf, nCapWidth );
  DoOnCapitals( aDo );
483}

485void SwSubFont::DoOnCapitals( SwDoCapitals &rDo )
486{
  OSL_ENSURE( pLastFont, "SwFont::DoOnCapitals: No LastFont?!" )do { if (true && (!(pLastFont))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/txtnode/fntcap.cxx"
 ":" "487" ": "), "%s", "SwFont::DoOnCapitals: No LastFont?!"
); } } while (false);
1
Assuming 'pLastFont' is non-null→
2
←
Taking false branch→
3
←
Loop condition is false.  Exiting loop→

  long nKana = 0;
  const OUString aText( CalcCaseMap( rDo.GetInf().GetText() ) );
  TextFrameIndex nMaxPos = std::min(
      TextFrameIndex(rDo.GetInf().GetText().getLength()) - rDo.GetInf().GetIdx(),
                           rDo.GetInf().GetLen() );
  rDo.GetInf().SetLen( nMaxPos );

  const OUString oldText = rDo.GetInf().GetText();
  rDo.GetInf().SetText( aText );
  TextFrameIndex nPos = rDo.GetInf().GetIdx();
  TextFrameIndex nOldPos = nPos;
  nMaxPos = nMaxPos + nPos;

  // Look if the length of the original text and the ToUpper-converted
  // text is different. If yes, do special handling.
  SwCapitalInfo aCapInf(oldText);
  bool bCaseMapLengthDiffers(aText.getLength() != oldText.getLength());
4
←
Assuming the condition is false→
  if ( bCaseMapLengthDiffers4.1
'bCaseMapLengthDiffers' is false
1
'bCaseMapLengthDiffers' is false
1
'bCaseMapLengthDiffers' is false
1
'bCaseMapLengthDiffers' is false
1
'bCaseMapLengthDiffers' is false
 )
5
←
Taking false branch→
      rDo.SetCapInf( aCapInf );

  SwFntObj *pOldLast = pLastFont;
  std::unique_ptr<SwFntAccess> pBigFontAccess;
  SwFntObj *pBigFont;
  std::unique_ptr<SwFntAccess> pSpaceFontAccess;
  SwFntObj *pSpaceFont = nullptr;

  const void* nFontCacheId2 = nullptr;
  sal_uInt16 nIndex2 = 0;
  SwSubFont aFont( *this );
  Point aStartPos( rDo.GetInf().GetPos() );

  const bool bTextLines = aFont.GetUnderline() != LINESTYLE_NONE
6
←
Assuming the condition is false→
                       || aFont.GetOverline()  != LINESTYLE_NONE
7
←
Assuming the condition is false→
                       || aFont.GetStrikeout() != STRIKEOUT_NONE;
8
←
Assuming the condition is false→
  const bool bWordWise = bTextLines8.1
'bTextLines' is false
1
'bTextLines' is false
1
'bTextLines' is false
1
'bTextLines' is false
1
'bTextLines' is false
 && aFont.IsWordLineMode() &&
                         rDo.GetInf().GetDrawSpace();
  const long nTmpKern = rDo.GetInf().GetKern();

  if ( bTextLines8.2
'bTextLines' is false
2
'bTextLines' is false
2
'bTextLines' is false
2
'bTextLines' is false
2
'bTextLines' is false
 )
9
←
Taking false branch→
  {
      if ( bWordWise )
      {
          aFont.SetWordLineMode( false );
          pSpaceFontAccess.reset(new SwFntAccess( nFontCacheId2, nIndex2, &aFont,
                                              rDo.GetInf().GetShell() ));
          pSpaceFont = pSpaceFontAccess->Get();
      }
      else
          pSpaceFont = pLastFont;

      // Construct a font for the capitals:
      aFont.SetUnderline( LINESTYLE_NONE );
      aFont.SetOverline( LINESTYLE_NONE );
      aFont.SetStrikeout( STRIKEOUT_NONE );
      nFontCacheId2 = nullptr;
      nIndex2 = 0;
      pBigFontAccess.reset(new SwFntAccess( nFontCacheId2, nIndex2, &aFont,
                                        rDo.GetInf().GetShell() ));
      pBigFont = pBigFontAccess->Get();
  }
  else
      pBigFont = pLastFont;

  // Older LO versions had 66 as the small caps percentage size, later changed to 80,
  // therefore a backwards compatibility option is kept (otherwise layout is changed).
  // NOTE: There are more uses of SMALL_CAPS_PERCENTAGE in editeng, but it seems they
  // do not matter for Writer (and if they did it'd be pretty ugly to propagate
  // the option there).
  int smallCapsPercentage = m_bSmallCapsPercentage66 ? 66 : SMALL_CAPS_PERCENTAGE80;
10
←
Assuming field 'm_bSmallCapsPercentage66' is false→
11
←
'?' condition is false→
  aFont.SetProportion( (aFont.GetPropr() * smallCapsPercentage ) / 100 );
  nFontCacheId2 = nullptr;
  nIndex2 = 0;
  std::unique_ptr<SwFntAccess> pSmallFontAccess( new SwFntAccess( nFontCacheId2, nIndex2, &aFont,
                                                   rDo.GetInf().GetShell() ));
  SwFntObj *pSmallFont = pSmallFontAccess->Get();

  rDo.Init( pBigFont, pSmallFont );
  OutputDevice* pOutSize = pSmallFont->GetPrt();
  if( !pOutSize )
12
←
Assuming 'pOutSize' is non-null→
13
←
Taking false branch→
      pOutSize = &rDo.GetOut();
  OutputDevice* pOldOut = &rDo.GetOut();

  const LanguageType eLng = LANGUAGE_DONTKNOWLanguageType(0x03FF) == GetLanguage()
14
←
'?' condition is false→
                          ? LANGUAGE_SYSTEMLanguageType(0x0000) : GetLanguage();

  if( nPos < nMaxPos )
15
←
Taking true branch→
  {
      nPos = TextFrameIndex(g_pBreakIt->GetBreakIter()->endOfCharBlock(
                      oldText, sal_Int32(nPos),
          g_pBreakIt->GetLocale( eLng ), CharType::LOWERCASE_LETTER));
      if (nPos < TextFrameIndex(0))
16
←
Taking false branch→
          nPos = nOldPos;
      else if( nPos > nMaxPos )
17
←
Taking false branch→
          nPos = nMaxPos;
  }

  while( nOldPos < nMaxPos )
18
←
Loop condition is true.  Entering loop body→
  {

      //  The lower ones...
      if( nOldPos != nPos )
19
←
Taking true branch→
      {
          SV_STAT( nGetTextSize );
          pLastFont = pSmallFont;
          pLastFont->SetDevFont( rDo.GetInf().GetShell(), rDo.GetOut() );

          // #107816#, #i14820#
          if( bCaseMapLengthDiffers19.1
'bCaseMapLengthDiffers' is false
1
'bCaseMapLengthDiffers' is false
1
'bCaseMapLengthDiffers' is false
1
'bCaseMapLengthDiffers' is false
1
'bCaseMapLengthDiffers' is false
 )
20
←
Taking false branch→
          {
              // Build an own 'changed' string for the given part of the
              // source string and use it. That new string may differ in length
              // from the source string.
              const OUString aNewText = CalcCaseMap(
                  oldText.copy(sal_Int32(nOldPos), sal_Int32(nPos-nOldPos)));
              aCapInf.nIdx = nOldPos;
              aCapInf.nLen = nPos - nOldPos;
              rDo.GetInf().SetIdx(TextFrameIndex(0));
              rDo.GetInf().SetLen(TextFrameIndex(aNewText.getLength()));
              rDo.GetInf().SetText( aNewText );
          }
          else
          {
              rDo.GetInf().SetIdx( nOldPos );
              rDo.GetInf().SetLen( nPos - nOldPos );
          }

          rDo.GetInf().SetUpper( false );
          rDo.GetInf().SetOut( *pOutSize );
21
←
Calling 'SwDrawTextInfo::SetOut'→
33
←
Returning; memory was released→
          Size aPartSize = pSmallFont->GetTextSize( rDo.GetInf() );
          nKana += rDo.GetInf().GetKanaDiff();
          rDo.GetInf().SetOut( *pOldOut );
34
←
Use of memory after it is freed
          if( nTmpKern && nPos < nMaxPos )
              aPartSize.AdjustWidth(nTmpKern );
          rDo.GetInf().SetSize( aPartSize );
          rDo.Do();
          nOldPos = nPos;
      }
      nPos = TextFrameIndex(g_pBreakIt->GetBreakIter()->nextCharBlock(
                          oldText, sal_Int32(nPos),
             g_pBreakIt->GetLocale( eLng ), CharType::LOWERCASE_LETTER));
      if (nPos < TextFrameIndex(0) || nPos > nMaxPos)
          nPos = nMaxPos;
      OSL_ENSURE( nPos, "nextCharBlock not implemented?" )do { if (true && (!(nPos))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/txtnode/fntcap.cxx"
 ":" "631" ": "), "%s", "nextCharBlock not implemented?"); } }
 while (false);
632#if OSL_DEBUG_LEVEL1 > 1
      if( !nPos )
          nPos = nMaxPos;
635#endif
      // The upper ones...
      if( nOldPos != nPos )
      {
          const long nSpaceAdd = rDo.GetInf().GetSpace() / SPACING_PRECISION_FACTOR100;

          do
          {
              rDo.GetInf().SetUpper( true );
              pLastFont = pBigFont;
              pLastFont->SetDevFont( rDo.GetInf().GetShell(), rDo.GetOut() );
              TextFrameIndex nTmp;
              if( bWordWise )
              {
                  nTmp = nOldPos;
                  while (nTmp < nPos && CH_BLANK == oldText[sal_Int32(nTmp)])
                      ++nTmp;
                  if( nOldPos < nTmp )
                  {
                      pLastFont = pSpaceFont;
                      pLastFont->SetDevFont( rDo.GetInf().GetShell(),
                                             rDo.GetOut() );
                      static_cast<SwDoDrawCapital&>(rDo).DrawSpace( aStartPos );
                      pLastFont = pBigFont;
                      pLastFont->SetDevFont( rDo.GetInf().GetShell(),
                                             rDo.GetOut() );

                      // #107816#, #i14820#
                      if( bCaseMapLengthDiffers )
                      {
                          // Build an own 'changed' string for the given part of the
                          // source string and use it. That new string may differ in length
                          // from the source string.
                          const OUString aNewText = CalcCaseMap(
                              oldText.copy(sal_Int32(nOldPos), sal_Int32(nTmp-nOldPos)));
                          aCapInf.nIdx = nOldPos;
                          aCapInf.nLen = nTmp - nOldPos;
                          rDo.GetInf().SetIdx(TextFrameIndex(0));
                          rDo.GetInf().SetLen(TextFrameIndex(aNewText.getLength()));
                          rDo.GetInf().SetText( aNewText );
                      }
                      else
                      {
                          rDo.GetInf().SetIdx( nOldPos );
                          rDo.GetInf().SetLen( nTmp - nOldPos );
                      }

                      rDo.GetInf().SetOut( *pOutSize );
                      Size aPartSize = pBigFont->GetTextSize( rDo.GetInf() );
                      nKana += rDo.GetInf().GetKanaDiff();
                      rDo.GetInf().SetOut( *pOldOut );
                      if( nSpaceAdd )
                          aPartSize.AdjustWidth(nSpaceAdd * sal_Int32(nTmp - nOldPos));
                      if( nTmpKern && nPos < nMaxPos )
                          aPartSize.AdjustWidth(nTmpKern );
                      rDo.GetInf().SetSize( aPartSize );
                      rDo.Do();
                      aStartPos = rDo.GetInf().GetPos();
                      nOldPos = nTmp;
                  }

                  while (nTmp < nPos && CH_BLANK != oldText[sal_Int32(nTmp)])
                      ++nTmp;
              }
              else
                  nTmp = nPos;
              if( nTmp > nOldPos )
              {
                    // #107816#, #i14820#
                  if( bCaseMapLengthDiffers )
                  {
                      // Build an own 'changed' string for the given part of the
                      // source string and use it. That new string may differ in length
                      // from the source string.
                      const OUString aNewText = CalcCaseMap(
                          oldText.copy(sal_Int32(nOldPos), sal_Int32(nTmp-nOldPos)));
                      aCapInf.nIdx = nOldPos;
                      aCapInf.nLen = nTmp - nOldPos;
                      rDo.GetInf().SetIdx(TextFrameIndex(0));
                      rDo.GetInf().SetLen(TextFrameIndex(aNewText.getLength()));
                      rDo.GetInf().SetText( aNewText );
                  }
                  else
                  {
                      rDo.GetInf().SetIdx( nOldPos );
                      rDo.GetInf().SetLen( nTmp - nOldPos );
                  }

                  rDo.GetInf().SetOut( *pOutSize );
                  Size aPartSize = pBigFont->GetTextSize( rDo.GetInf() );
                  nKana += rDo.GetInf().GetKanaDiff();
                  rDo.GetInf().SetOut( *pOldOut );
                  if( !bWordWise && rDo.GetInf().GetSpace() )
                  {
                      for (TextFrameIndex nI = nOldPos; nI < nPos; ++nI)
                      {
                          if (CH_BLANK == oldText[sal_Int32(nI)])
                              aPartSize.AdjustWidth(nSpaceAdd );
                      }
                  }
                  if( nTmpKern && nPos < nMaxPos )
                      aPartSize.AdjustWidth(nTmpKern );
                  rDo.GetInf().SetSize( aPartSize );
                  rDo.Do();
                  nOldPos = nTmp;
              }
          } while( nOldPos != nPos );
      }
      nPos = TextFrameIndex(g_pBreakIt->GetBreakIter()->endOfCharBlock(
                          oldText, sal_Int32(nPos),
             g_pBreakIt->GetLocale( eLng ), CharType::LOWERCASE_LETTER));
      if (nPos < TextFrameIndex(0) || nPos > nMaxPos)
          nPos = nMaxPos;
      OSL_ENSURE( nPos, "endOfCharBlock not implemented?" )do { if (true && (!(nPos))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/txtnode/fntcap.cxx"
 ":" "748" ": "), "%s", "endOfCharBlock not implemented?"); }
 } while (false);
749#if OSL_DEBUG_LEVEL1 > 1
      if( !nPos )
          nPos = nMaxPos;
752#endif
  }

  // clean up:
  if( pBigFont != pOldLast )
      pBigFontAccess.reset();

  if( bTextLines )
  {
      if( rDo.GetInf().GetDrawSpace() )
      {
          pLastFont = pSpaceFont;
          pLastFont->SetDevFont( rDo.GetInf().GetShell(), rDo.GetOut() );
          static_cast<SwDoDrawCapital&>( rDo ).DrawSpace( aStartPos );
      }
      if ( bWordWise )
          pSpaceFontAccess.reset();
  }
  pLastFont = pOldLast;
  pLastFont->SetDevFont( rDo.GetInf().GetShell(), rDo.GetOut() );

  pSmallFontAccess.reset();
  rDo.GetInf().SetText(oldText);
  rDo.GetInf().SetKanaDiff( nKana );
776}

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

←

/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.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_SW_SOURCE_CORE_INC_DRAWFONT_HXX
21#define INCLUDED_SW_SOURCE_CORE_INC_DRAWFONT_HXX

23#include <osl/diagnose.h>
24#include <vcl/vclptr.hxx>
25#include <vcl/outdev.hxx>
26#include "TextFrameIndex.hxx"
27#include <swdllapi.h>

29class SwTextFrame;
30class SwViewShell;
31class SwScriptInfo;
32namespace sw { class WrongListIterator; }
33class SwFont;
34namespace vcl {
  class Font;
  class TextLayoutCache;
  typedef OutputDevice RenderContext;
38}
39class SwUnderlineFont;

41// encapsulates information for drawing text
42class SW_DLLPUBLIC__attribute__ ((visibility("default"))) SwDrawTextInfo
43{
  const SwTextFrame* m_pFrame;
  VclPtr<OutputDevice> m_pOut;
  SwViewShell const * m_pSh;
  const SwScriptInfo* m_pScriptInfo;
  Point m_aPos;
  vcl::TextLayoutCache const* m_pCachedVclData;
  OUString m_aText;
  sw::WrongListIterator* m_pWrong;
  sw::WrongListIterator* m_pGrammarCheck;
  sw::WrongListIterator* m_pSmartTags;
  Size m_aSize;
  SwFont *m_pFnt;
  SwUnderlineFont* m_pUnderFnt;
  TextFrameIndex* m_pHyphPos;
  long m_nKanaDiff;
  TextFrameIndex m_nIdx;
  TextFrameIndex m_nLen;
  /// this is not a string index
  sal_Int32 m_nOfst;
  sal_uInt16 m_nWidth;
  sal_uInt16 m_nAscent;
  sal_uInt16 m_nCompress;
  long m_nSperren;
  long m_nSpace;
  long m_nKern;
  TextFrameIndex m_nNumberOfBlanks;
  sal_uInt8 m_nCursorBidiLevel;
  bool m_bBullet : 1;
  bool m_bUpper : 1;        // for small caps: upper case flag
  bool m_bDrawSpace : 1;    // for small caps: underline/ line through
  bool m_bGreyWave  : 1;    // grey wave line for extended text input
  // For underlining we need to know, if a section is right in front of a
  // whole block or a fix margin section.
  bool m_bSpaceStop : 1;
  bool m_bSnapToGrid : 1;   // Does paragraph snap to grid?
  // Paint text as if text has LTR direction, used for line numbering
  bool m_bIgnoreFrameRTL : 1;
  // GetModelPositionForViewPoint should not return the next position if screen position is
  // inside second half of bound rect, used for Accessibility
  bool m_bPosMatchesBounds :1;

85public:

87#ifdef DBG_UTIL
  // These flags should control that the appropriate Set-function has been
  // called before calling the Get-function of a member
  bool m_bPos   : 1;
  bool m_bWrong : 1;
  bool m_bGrammarCheck : 1;
  bool m_bSize  : 1;
  bool m_bFnt   : 1;
  bool m_bHyph  : 1;
  bool m_bKana  : 1;
  bool m_bOfst  : 1;
  bool m_bAscent: 1;
  bool m_bSperr : 1;
  bool m_bSpace : 1;
  bool m_bNumberOfBlanks : 1;
  bool m_bUppr  : 1;
  bool m_bDrawSp: 1;
104#endif

  /// constructor for simple strings
  SwDrawTextInfo( SwViewShell const *pSh, OutputDevice &rOut,
                  const OUString &rText, sal_Int32 const nIdx, sal_Int32 const nLen,
                  sal_uInt16 nWidth = 0, bool bBullet = false)
      : SwDrawTextInfo(pSh, rOut, nullptr, rText, TextFrameIndex(nIdx), TextFrameIndex(nLen), nWidth, bBullet)
  {}
  /// constructor for text frame contents
  SwDrawTextInfo( SwViewShell const *pSh, OutputDevice &rOut, const SwScriptInfo* pSI,
                  const OUString &rText, TextFrameIndex const nIdx, TextFrameIndex const nLen,
                  sal_uInt16 nWidth = 0, bool bBullet = false,
                  vcl::TextLayoutCache const*const pCachedVclData = nullptr)
      : m_pCachedVclData(pCachedVclData)
  {
      m_pFrame = nullptr;
      m_pSh = pSh;
      m_pOut = &rOut;
      m_pScriptInfo = pSI;
      m_aText = rText;
      m_nIdx = nIdx;
      m_nLen = nLen;
      m_nKern = 0;
      m_nCompress = 0;
      m_nWidth = nWidth;
      m_nNumberOfBlanks = TextFrameIndex(0);
      m_nCursorBidiLevel = 0;
      m_bBullet = bBullet;
      m_pUnderFnt = nullptr;
      m_bGreyWave = false;
      m_bSpaceStop = false;
      m_bSnapToGrid = false;
      m_bIgnoreFrameRTL = false;
      m_bPosMatchesBounds = false;

      // These values are initialized but have to be set explicitly via their
      // Set-function before they may be accessed by their Get-function:
      m_pWrong = nullptr;
      m_pGrammarCheck = nullptr;
      m_pSmartTags = nullptr;
      m_pFnt = nullptr;
      m_pHyphPos = nullptr;
      m_nKanaDiff = 0;
      m_nOfst = 0;
      m_nAscent = 0;
      m_nSperren = 0;
      m_nSpace = 0;
      m_bUpper = false;
      m_bDrawSpace = false;

154#ifdef DBG_UTIL
      // these flags control whether the matching member variables have been
      // set by using the Set-function before they may be accessed by their
      // Get-function:
      m_bPos = m_bWrong = m_bGrammarCheck = m_bSize = m_bFnt = m_bAscent =
      m_bSpace = m_bNumberOfBlanks = m_bUppr =
      m_bDrawSp = m_bKana = m_bOfst = m_bHyph =
      m_bSperr = false;
162#endif
  }

  const SwTextFrame* GetFrame() const
  {
      return m_pFrame;
  }

  void SetFrame( const SwTextFrame* pNewFrame )
  {
      m_pFrame = pNewFrame;
  }

  SwViewShell const *GetShell() const
  {
      return m_pSh;
  }

  vcl::RenderContext& GetOut() const
  {
      return *m_pOut;
  }

  vcl::RenderContext *GetpOut() const
  {
      return m_pOut;
  }

  const SwScriptInfo* GetScriptInfo() const
  {
      return m_pScriptInfo;
  }

  const Point &GetPos() const
  {
197#ifdef DBG_UTIL
      OSL_ENSURE( m_bPos, "DrawTextInfo: Undefined Position" )do { if (true && (!(m_bPos))) { sal_detail_logFormat(
(SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "198" ": "), "%s", "DrawTextInfo: Undefined Position"); }
 } while (false);
199#endif
      return m_aPos;
  }

  TextFrameIndex *GetHyphPos() const
  {
205#ifdef DBG_UTIL
      OSL_ENSURE( m_bHyph, "DrawTextInfo: Undefined Hyph Position" )do { if (true && (!(m_bHyph))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "206" ": "), "%s", "DrawTextInfo: Undefined Hyph Position"
); } } while (false);
207#endif
      return m_pHyphPos;
  }

  vcl::TextLayoutCache const* GetVclCache() const
  {
      return m_pCachedVclData;
  }

  const OUString &GetText() const
  {
      return m_aText;
  }

  sw::WrongListIterator* GetWrong() const
  {
223#ifdef DBG_UTIL
      OSL_ENSURE( m_bWrong, "DrawTextInfo: Undefined WrongList" )do { if (true && (!(m_bWrong))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "224" ": "), "%s", "DrawTextInfo: Undefined WrongList");
 } } while (false);
225#endif
      return m_pWrong;
  }

  sw::WrongListIterator* GetGrammarCheck() const
  {
231#ifdef DBG_UTIL
      OSL_ENSURE( m_bGrammarCheck, "DrawTextInfo: Undefined GrammarCheck List" )do { if (true && (!(m_bGrammarCheck))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "232" ": "), "%s", "DrawTextInfo: Undefined GrammarCheck List"
); } } while (false);
233#endif
      return m_pGrammarCheck;
  }

  sw::WrongListIterator* GetSmartTags() const
  {
      return m_pSmartTags;
  }

  const Size &GetSize() const
  {
244#ifdef DBG_UTIL
      OSL_ENSURE( m_bSize, "DrawTextInfo: Undefined Size" )do { if (true && (!(m_bSize))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "245" ": "), "%s", "DrawTextInfo: Undefined Size"); } } while
 (false);
246#endif
      return m_aSize;
  }

  SwFont* GetFont() const
  {
252#ifdef DBG_UTIL
      OSL_ENSURE( m_bFnt, "DrawTextInfo: Undefined Font" )do { if (true && (!(m_bFnt))) { sal_detail_logFormat(
(SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "253" ": "), "%s", "DrawTextInfo: Undefined Font"); } } while
 (false);
254#endif
      return m_pFnt;
  }

  SwUnderlineFont* GetUnderFnt() const
  {
      return m_pUnderFnt;
  }

  TextFrameIndex GetIdx() const
  {
      return m_nIdx;
  }

  TextFrameIndex GetLen() const
  {
      return m_nLen;
  }

  sal_Int32 GetOffset() const
  {
275#ifdef DBG_UTIL
      OSL_ENSURE( m_bOfst, "DrawTextInfo: Undefined Offset" )do { if (true && (!(m_bOfst))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "276" ": "), "%s", "DrawTextInfo: Undefined Offset"); } }
 while (false);
277#endif
      return m_nOfst;
  }

  TextFrameIndex GetEnd() const
  {
      return m_nIdx + m_nLen;
  }

  long GetKanaDiff() const
  {
288#ifdef DBG_UTIL
      OSL_ENSURE( m_bKana, "DrawTextInfo: Undefined kana difference" )do { if (true && (!(m_bKana))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "289" ": "), "%s", "DrawTextInfo: Undefined kana difference"
); } } while (false);
290#endif
      return m_nKanaDiff;
  }

  sal_uInt16 GetWidth() const
  {
      return m_nWidth;
  }

  sal_uInt16 GetAscent() const
  {
301#ifdef DBG_UTIL
      OSL_ENSURE( m_bAscent, "DrawTextInfo: Undefined Ascent" )do { if (true && (!(m_bAscent))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "302" ": "), "%s", "DrawTextInfo: Undefined Ascent"); } }
 while (false);
303#endif
      return m_nAscent;
  }

  sal_uInt16 GetKanaComp() const
  {
      return m_nCompress;
  }

  long GetSperren() const
  {
314#ifdef DBG_UTIL
      OSL_ENSURE( m_bSperr, "DrawTextInfo: Undefined >Sperren<" )do { if (true && (!(m_bSperr))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "315" ": "), "%s", "DrawTextInfo: Undefined >Sperren<"
); } } while (false);
316#endif
      return m_nSperren;
  }

  long GetKern() const
  {
      return m_nKern;
  }

  long GetSpace() const
  {
327#ifdef DBG_UTIL
      OSL_ENSURE( m_bSpace, "DrawTextInfo: Undefined Spacing" )do { if (true && (!(m_bSpace))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "328" ": "), "%s", "DrawTextInfo: Undefined Spacing"); }
 } while (false);
329#endif
      return m_nSpace;
  }

  TextFrameIndex GetNumberOfBlanks() const
  {
335#ifdef DBG_UTIL
      OSL_ENSURE( m_bNumberOfBlanks, "DrawTextInfo::Undefined NumberOfBlanks" )do { if (true && (!(m_bNumberOfBlanks))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "336" ": "), "%s", "DrawTextInfo::Undefined NumberOfBlanks"
); } } while (false);
337#endif
      return m_nNumberOfBlanks;
  }

  sal_uInt8 GetCursorBidiLevel() const
  {
      return m_nCursorBidiLevel;
  }

  bool GetBullet() const
  {
      return m_bBullet;
  }

  bool GetUpper() const
  {
353#ifdef DBG_UTIL
      OSL_ENSURE( m_bUppr, "DrawTextInfo: Undefined Upperflag" )do { if (true && (!(m_bUppr))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "354" ": "), "%s", "DrawTextInfo: Undefined Upperflag");
 } } while (false);
355#endif
      return m_bUpper;
  }

  bool GetDrawSpace() const
  {
361#ifdef DBG_UTIL
      OSL_ENSURE( m_bDrawSp, "DrawTextInfo: Undefined DrawSpaceflag" )do { if (true && (!(m_bDrawSp))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/inc/drawfont.hxx"
 ":" "362" ": "), "%s", "DrawTextInfo: Undefined DrawSpaceflag"
); } } while (false);
363#endif
      return m_bDrawSpace;
  }

  bool GetGreyWave() const
  {
      return m_bGreyWave;
  }

  bool IsSpaceStop() const
  {
      return m_bSpaceStop;
  }

  bool SnapToGrid() const
  {
      return m_bSnapToGrid;
  }

  bool IsIgnoreFrameRTL() const
  {
      return m_bIgnoreFrameRTL;
  }

  bool IsPosMatchesBounds() const
  {
      return m_bPosMatchesBounds;
  }

  void SetOut( OutputDevice &rNew )
  {
      m_pOut = &rNew;
22
←
Calling 'VclPtr::operator='→
32
←
Returning; memory was released→
  }

  void SetPos( const Point &rNew )
  {
      m_aPos = rNew;
400#ifdef DBG_UTIL
      m_bPos = true;
402#endif
  }

  void SetHyphPos(TextFrameIndex *const pNew)
  {
      m_pHyphPos = pNew;
408#ifdef DBG_UTIL
      m_bHyph = true;
410#endif
  }

  void SetText( const OUString &rNew )
  {
      m_aText = rNew;
      m_pCachedVclData = nullptr; // would any case benefit from save/restore?
  }

  void SetWrong(sw::WrongListIterator *const pNew)
  {
      m_pWrong = pNew;
422#ifdef DBG_UTIL
      m_bWrong = true;
424#endif
  }

  void SetGrammarCheck(sw::WrongListIterator *const pNew)
  {
      m_pGrammarCheck = pNew;
430#ifdef DBG_UTIL
      m_bGrammarCheck = true;
432#endif
  }

  void SetSmartTags(sw::WrongListIterator *const pNew)
  {
      m_pSmartTags = pNew;
  }

  void SetSize( const Size &rNew )
  {
      m_aSize = rNew;
443#ifdef DBG_UTIL
      m_bSize = true;
445#endif
  }

  void SetFont( SwFont* pNew )
  {
      m_pFnt = pNew;
451#ifdef DBG_UTIL
      m_bFnt = true;
453#endif
  }

  void SetIdx(TextFrameIndex const nNew)
  {
      m_nIdx = nNew;
  }

  void SetLen(TextFrameIndex const nNew)
  {
      m_nLen = nNew;
  }

  void SetOffset( sal_Int32 nNew )
  {
      m_nOfst = nNew;
469#ifdef DBG_UTIL
      m_bOfst = true;
471#endif
  }

  void SetKanaDiff( long nNew )
  {
      m_nKanaDiff = nNew;
477#ifdef DBG_UTIL
      m_bKana = true;
479#endif
  }

  void SetWidth( sal_uInt16 nNew )
  {
      m_nWidth = nNew;
  }

  void SetAscent( sal_uInt16 nNew )
  {
      m_nAscent = nNew;
490#ifdef DBG_UTIL
      m_bAscent = true;
492#endif
  }

  void SetKern( long nNew )
  {
      m_nKern = nNew;
  }

  void SetSpace( long nNew )
  {
      if( nNew < 0 )
      {
          m_nSperren = -nNew;
          m_nSpace = 0;
      }
      else
      {
          m_nSpace = nNew;
          m_nSperren = 0;
      }
512#ifdef DBG_UTIL
      m_bSpace = true;
      m_bSperr = true;
515#endif
  }

  void SetNumberOfBlanks( TextFrameIndex const nNew )
  {
520#ifdef DBG_UTIL
      m_bNumberOfBlanks = true;
522#endif
      m_nNumberOfBlanks = nNew;
  }

  void SetCursorBidiLevel( sal_uInt8 nNew )
  {
      m_nCursorBidiLevel = nNew;
  }

  void SetKanaComp( short nNew )
  {
      m_nCompress = nNew;
  }

  void SetBullet( bool bNew )
  {
      m_bBullet = bNew;
  }

  void SetUnderFnt( SwUnderlineFont* pULFnt )
  {
      m_pUnderFnt = pULFnt;
  }

  void SetUpper( bool bNew )
  {
      m_bUpper = bNew;
549#ifdef DBG_UTIL
      m_bUppr = true;
551#endif
  }

  void SetDrawSpace( bool bNew )
  {
      m_bDrawSpace = bNew;
557#ifdef DBG_UTIL
      m_bDrawSp = true;
559#endif
  }

  void SetGreyWave( bool bNew )
  {
      m_bGreyWave = bNew;
  }

  void SetSpaceStop( bool bNew )
  {
      m_bSpaceStop = bNew;
  }

  void SetSnapToGrid( bool bNew )
  {
      m_bSnapToGrid = bNew;
  }

  void SetIgnoreFrameRTL( bool bNew )
  {
      m_bIgnoreFrameRTL = bNew;
  }

  void SetPosMatchesBounds( bool bNew )
  {
      m_bPosMatchesBounds = bNew;
  }

  void Shift( sal_uInt16 nDir );

  // sets a new color at the output device if necessary if a font is passed
  // as argument, the change if made to the font otherwise the font at the
  // output device is changed returns if the font has been changed
  bool ApplyAutoColor( vcl::Font* pFnt = nullptr );
593};

595#endif

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

←

/home/maarten/src/libreoffice/core/include/vcl/vclptr.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_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX

23#include <sal/config.h>

25#include <rtl/ref.hxx>

27#include <utility>
28#include <type_traits>

30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif

36class VclReferenceBase;

38namespace vcl::detail {

40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }

43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
  int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }

47} // namespace vcl::detail

49/**
* A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
*
* For more details on the design please see vcl/README.lifecycle
*
* @param reference_type must be a subclass of vcl::Window
*/
56template <class reference_type>
57class VclPtr
58{
  static_assert(
      vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
          nullptr),
      "template argument type must be derived from VclReferenceBase");

  ::rtl::Reference<reference_type> m_rInnerRef;

66public:
  /** Constructor...
   */
  VclPtr()
      : m_rInnerRef()
  {}

  /** Constructor...
   */
  VclPtr (reference_type * pBody)
      : m_rInnerRef(pBody)
  {}

  /** Constructor... that doesn't take a ref.
   */
  VclPtr (reference_type * pBody, __sal_NoAcquire)
      : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
  {}

  /** Up-casting conversion constructor: Copies interface reference.

      Does not work for up-casts to ambiguous bases.  For the special case of
      up-casting to Reference< XInterface >, see the corresponding conversion
      operator.

      @param rRef another reference
  */
  template< class derived_type >
  VclPtr(
      const VclPtr< derived_type > & rRef,
      typename std::enable_if<
          std::is_base_of<reference_type, derived_type>::value, int>::type
          = 0 )
      : m_rInnerRef( static_cast<reference_type*>(rRef) )
  {
  }

103#if defined(DBG_UTIL) && !defined(_WIN32)
  virtual ~VclPtr()
  {
      assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__));
      // We can be one of the intermediate counts, but if we are the last
      // VclPtr keeping this object alive, then something forgot to call dispose().
      assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
 "someone forgot to call dispose()") ? void (0) : __assert_fail
 ("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
              && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
 "someone forgot to call dispose()") ? void (0) : __assert_fail
 ("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__));
  }
  VclPtr(VclPtr const &) = default;
  VclPtr(VclPtr &&) = default;
  VclPtr & operator =(VclPtr const &) = default;
  VclPtr & operator =(VclPtr &&) = default;
116#endif

  /**
   * A construction helper for VclPtr. Since VclPtr types are created
   * with a reference-count of one - to help fit into the existing
   * code-flow; this helps us to construct them easily.
   *
   * For more details on the design please see vcl/README.lifecycle
   *
   * @tparam reference_type must be a subclass of vcl::Window
   */
  template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
  {
      return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
  }

  /** Probably most common used: handle->someBodyOp().
   */
  reference_type * operator->() const
  {
      return m_rInnerRef.get();
  }

  /** Get the body. Can be used instead of operator->().
       I.e. handle->someBodyOp() and handle.get()->someBodyOp()
       are the same.
    */
  reference_type * get() const
  {
      return m_rInnerRef.get();
  }

  void set(reference_type *pBody)
  {
      m_rInnerRef.set(pBody);
  }

  void reset(reference_type *pBody)
  {
      m_rInnerRef.set(pBody);
  }

  /** Up-casting copy assignment operator.

      Does not work for up-casts to ambiguous bases.

      @param rRef another reference
  */
  template<typename derived_type>
  typename std::enable_if<
      std::is_base_of<reference_type, derived_type>::value,
      VclPtr &>::type
  operator =(VclPtr<derived_type> const & rRef)
  {
      m_rInnerRef.set(rRef.get());
      return *this;
  }

  VclPtr & operator =(reference_type * pBody)
  {
      m_rInnerRef.set(pBody);
23
←
Calling 'Reference::set'→
31
←
Returning; memory was released→
      return *this;
  }

  operator reference_type * () const
  {
      return m_rInnerRef.get();
  }

  explicit operator bool () const
  {
      return m_rInnerRef.get() != nullptr;
  }

  void clear()
  {
      m_rInnerRef.clear();
  }

  void reset()
  {
      m_rInnerRef.clear();
  }

  void disposeAndClear()
  {
      // hold it alive for the lifetime of this method
      ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
      m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
      if (aTmp.get()) {
          aTmp->disposeOnce();
      }
  }

  /** Needed to place VclPtr's into STL collection.
   */
  bool operator< (const VclPtr<reference_type> & handle) const
  {
      return (m_rInnerRef < handle.m_rInnerRef);
  }
216}; // class VclPtr

218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
  return p1.get() == p2.get();
221}

223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
  return p1.get() == p2;
226}

228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
  return p1.get() == p2;
230}

232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
  return p1 == p2.get();
235}

237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
  return p1 == p2.get();
239}

241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
  return !(p1 == p2);
244}

246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
  return !(p1 == p2);
249}

251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
  return !(p1 == p2);
253}

255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
  return !(p1 == p2);
258}

260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
  return !(p1 == p2);
262}

264/**
* A construction helper for a temporary VclPtr. Since VclPtr types
* are created with a reference-count of one - to help fit into
* the existing code-flow; this helps us to construct them easily.
* see also VclPtr::Create and ScopedVclPtr
*
* For more details on the design please see vcl/README.lifecycle
*
* @param reference_type must be a subclass of vcl::Window
*/
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
  template<typename... Arg> VclPtrInstance(Arg &&... arg)
      : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
  {
  }

  /**
   * Override and disallow this, to prevent people accidentally calling it and actually
   * getting VclPtr::Create and getting a naked VclPtr<> instance
   */
  template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};

290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
  /** Constructor...
   */
  ScopedVclPtr()
      : VclPtr<reference_type>()
  {}

  /** Constructor
   */
  ScopedVclPtr (reference_type * pBody)
      : VclPtr<reference_type>(pBody)
  {}

  /** Copy constructor...
   */
  ScopedVclPtr (const VclPtr<reference_type> & handle)
      : VclPtr<reference_type>(handle)
  {}

  /**
     Assignment that releases the last reference.
   */
  void disposeAndReset(reference_type *pBody)
  {
      if (pBody != this->get()) {
          VclPtr<reference_type>::disposeAndClear();
          VclPtr<reference_type>::set(pBody);
      }
  }

  /**
     Assignment that releases the last reference.
   */
  ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
  {
      disposeAndReset(pBody);
      return *this;
  }

  /** Up-casting conversion constructor: Copies interface reference.

      Does not work for up-casts to ambiguous bases.  For the special case of
      up-casting to Reference< XInterface >, see the corresponding conversion
      operator.

      @param rRef another reference
  */
  template< class derived_type >
  ScopedVclPtr(
      const VclPtr< derived_type > & rRef,
      typename std::enable_if<
          std::is_base_of<reference_type, derived_type>::value, int>::type
          = 0 )
      : VclPtr<reference_type>( rRef )
  {
  }

  /** Up-casting assignment operator.

      Does not work for up-casts to ambiguous bases.

      @param rRef another VclPtr
  */
  template<typename derived_type>
  typename std::enable_if<
      std::is_base_of<reference_type, derived_type>::value,
      ScopedVclPtr &>::type
  operator =(VclPtr<derived_type> const & rRef)
  {
      disposeAndReset(rRef.get());
      return *this;
  }

  /**
   * Override and disallow this, to prevent people accidentally calling it and actually
   * getting VclPtr::Create and getting a naked VclPtr<> instance
   */
  template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;

  ~ScopedVclPtr()
  {
      VclPtr<reference_type>::disposeAndClear();
      assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references
  }

378private:
  // Most likely we don't want this default copy-constructor.
  ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
  // And certainly we don't want a default assignment operator.
  ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
  // And disallow reset as that doesn't call disposeAndClear on the original reference
  void reset() = delete;
  void reset(reference_type *pBody) = delete;

387protected:
  ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
      : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
  {}
391};

393/**
* A construction helper for ScopedVclPtr. Since VclPtr types are created
* with a reference-count of one - to help fit into the existing
* code-flow; this helps us to construct them easily.
*
* For more details on the design please see vcl/README.lifecycle
*
* @param reference_type must be a subclass of vcl::Window
*/
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
  template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
      : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
  {
  }

  /**
   * Override and disallow this, to prevent people accidentally calling it and actually
   * getting VclPtr::Create and getting a naked VclPtr<> instance
   */
  template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;

421private:
  // Prevent the above perfect forwarding ctor from hijacking (accidental)
  // attempts at ScopedVclPtrInstance copy construction (where the hijacking
  // would typically lead to somewhat obscure error messages); both non-const
  // and const variants are needed here, as the ScopedVclPtr base class has a
  // const--variant copy ctor, so the implicitly declared copy ctor for
  // ScopedVclPtrInstance would also be the const variant, so non-const copy
  // construction attempts would be hijacked by the perfect forwarding ctor;
  // but if we only declared a non-const variant here, the const variant would
  // no longer be implicitly declared (as there would already be an explicitly
  // declared copy ctor), so const copy construction attempts would then be
  // hijacked by the perfect forwarding ctor:
  ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
  ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif

440#endif // INCLUDED_VCL_PTR_HXX

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

←

/home/maarten/src/libreoffice/core/include/rtl/ref.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_REF_HXX
21#define INCLUDED_RTL_REF_HXX

23#include "sal/config.h"

25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif

32#include "sal/types.h"

34namespace rtl
35{

37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
  /** The <b>reference_type</b> body pointer.
   */
  reference_type * m_pBody;


47public:
  /** Constructor...
   */
  Reference()
      : m_pBody (NULL__null)
  {}


  /** Constructor...
   */
  Reference (reference_type * pBody, __sal_NoAcquire)
      : m_pBody (pBody)
  {
  }

  /** Constructor...
   */
  Reference (reference_type * pBody)
      : m_pBody (pBody)
  {
      if (m_pBody)
          m_pBody->acquire();
  }

  /** Copy constructor...
   */
  Reference (const Reference<reference_type> & handle)
      : m_pBody (handle.m_pBody)
  {
      if (m_pBody)
          m_pBody->acquire();
  }

80#ifdef LIBO_INTERNAL_ONLY1
  /** Move constructor...
   */
  Reference (Reference<reference_type> && handle) noexcept
      : m_pBody (handle.m_pBody)
  {
      handle.m_pBody = nullptr;
  }
88#endif

90#if defined LIBO_INTERNAL_ONLY1
  /** Up-casting conversion constructor: Copies interface reference.

      Does not work for up-casts to ambiguous bases.

      @param rRef another reference
  */
  template< class derived_type >
  inline Reference(
      const Reference< derived_type > & rRef,
      std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
      : m_pBody (rRef.get())
  {
      if (m_pBody)
          m_pBody->acquire();
  }
106#endif

  /** Destructor...
   */
  ~Reference() COVERITY_NOEXCEPT_FALSE
  {
      if (m_pBody)
          m_pBody->release();
  }

  /** Set...
       Similar to assignment.
   */
  Reference<reference_type> &
  SAL_CALL set (reference_type * pBody)
  {
      if (pBody23.1
'pBody' is non-null
1
'pBody' is non-null
1
'pBody' is non-null
1
'pBody' is non-null
1
'pBody' is non-null
)
24
←
Taking true branch→
          pBody->acquire();
      reference_type * const pOld = m_pBody;
      m_pBody = pBody;
      if (pOld24.1
'pOld' is non-null
1
'pOld' is non-null
1
'pOld' is non-null
1
'pOld' is non-null
1
'pOld' is non-null
)
25
←
Taking true branch→
          pOld->release();
26
←
Calling 'VclReferenceBase::release'→
30
←
Returning; memory was released→
      return *this;
  }

  /** Assignment.
       Unbinds this instance from its body (if bound) and
       bind it to the body represented by the handle.
   */
  Reference<reference_type> &
  SAL_CALL operator= (const Reference<reference_type> & handle)
  {
      return set( handle.m_pBody );
  }

141#ifdef LIBO_INTERNAL_ONLY1
  /** Assignment.
   *   Unbinds this instance from its body (if bound),
   *   bind it to the body represented by the handle, and
   *   set the body represented by the handle to nullptr.
   */
  Reference<reference_type> &
  operator= (Reference<reference_type> && handle)
  {
      // self-movement guts ourself
      if (m_pBody)
          m_pBody->release();
      m_pBody = handle.m_pBody;
      handle.m_pBody = nullptr;
      return *this;
  }
157#endif

  /** Assignment...
   */
  Reference<reference_type> &
  SAL_CALL operator= (reference_type * pBody)
  {
      return set( pBody );
  }

  /** Unbind the body from this handle.
       Note that for a handle representing a large body,
       "handle.clear().set(new body());" _might_
       perform a little bit better than "handle.set(new body());",
       since in the second case two large objects exist in memory
       (the old body and the new body).
   */
  Reference<reference_type> & SAL_CALL clear()
  {
      if (m_pBody)
      {
          reference_type * const pOld = m_pBody;
          m_pBody = NULL__null;
          pOld->release();
      }
      return *this;
  }


  /** Get the body. Can be used instead of operator->().
       I.e. handle->someBodyOp() and handle.get()->someBodyOp()
       are the same.
   */
  reference_type * SAL_CALL get() const
  {
      return m_pBody;
  }


  /** Probably most common used: handle->someBodyOp().
   */
  reference_type * SAL_CALL operator->() const
  {
      assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
 ("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__));
      return m_pBody;
  }


  /** Allows (*handle).someBodyOp().
  */
  reference_type & SAL_CALL operator*() const
  {
      assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
 ("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__));
      return *m_pBody;
  }


  /** Returns True if the handle does point to a valid body.
   */
  bool SAL_CALL is() const
  {
      return (m_pBody != NULL__null);
  }

221#if defined LIBO_INTERNAL_ONLY1
  /** Returns True if the handle does point to a valid body.
   */
  explicit operator bool() const
  {
      return is();
  }
228#endif

  /** Returns True if this points to pBody.
   */
  bool SAL_CALL operator== (const reference_type * pBody) const
  {
      return (m_pBody == pBody);
  }


  /** Returns True if handle points to the same body.
   */
  bool
  SAL_CALL operator== (const Reference<reference_type> & handle) const
  {
      return (m_pBody == handle.m_pBody);
  }


  /** Needed to place References into STL collection.
   */
  bool
  SAL_CALL operator!= (const Reference<reference_type> & handle) const
  {
      return (m_pBody != handle.m_pBody);
  }


  /** Needed to place References into STL collection.
   */
  bool
  SAL_CALL operator< (const Reference<reference_type> & handle) const
  {
      return (m_pBody < handle.m_pBody);
  }


  /** Needed to place References into STL collection.
   */
  bool
  SAL_CALL operator> (const Reference<reference_type> & handle) const
  {
      return (m_pBody > handle.m_pBody);
  }
272};

274} // namespace rtl

276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{

280/// @cond INTERNAL
281/**
Make rtl::Reference hashable by default for use in STL containers.

@since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
  std::size_t operator()(::rtl::Reference<T> const & s) const
  { return std::size_t(s.get()); }
291};
292/// @endcond

294}

296#endif

298#endif /* ! INCLUDED_RTL_REF_HXX */

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

←

/home/maarten/src/libreoffice/core/include/vcl/vclreferencebase.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_VCL_Reference_HXX
20#define INCLUDED_VCL_Reference_HXX
21 
22#include <vcl/dllapi.h>
23#include <osl/interlck.h>
24 
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27    mutable oslInterlockedCount mnRefCnt;
28 
29    template<typename T> friend class VclPtr;
30 
31public:
32    void acquire() const
33    {
34        osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1);
35    }
36 
37    void release() const
38    {
39        if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0)
27
←
Assuming the condition is true→
28
←
Taking true branch→
40            delete this;
29
←
Memory is released→
41    }
42#ifdef DBG_UTIL
43#ifndef _WIN32
44    sal_Int32 getRefCount() const { return mnRefCnt; }
45#endif
46#endif
47 
48 
49private:
50    VclReferenceBase(const VclReferenceBase&) = delete;
51    VclReferenceBase& operator=(const VclReferenceBase&) = delete;
52 
53    bool                        mbDisposed : 1;
54 
55protected:
56                                VclReferenceBase();
57protected:
58    virtual                     ~VclReferenceBase();
59 
60protected:
61    virtual void                dispose();
62 
63public:
64    void                        disposeOnce();
65    bool                        isDisposed() const { return mbDisposed; }
66 
67};
68#endif