wangxin/loongoffice
1
0
Fork 0
forked from amazingfate/loongoffice
Code Pull Requests Activity
Files
67cba3af55e94debe8eb6392bc8d0b2f00a7a199
loongoffice/vcl/source/gdi/textlayout.cxx
Noel Grandin 794d5ac4ac vcl: use enum for complex text layout constants 
Since these constants are bitfield flags, we define some methods to make
working with them reasonably type safe.

Move the definitions to outdevstate.hxx, since we need the values there,
and that appears to be the "root most" header file.

Also dump TEXT_LAYOUT_BIDI_LTR constant, since it means the same thing
as TEXT_LAYOUT_DEFAULT (ie. 0), and leaving it in causes people to write
weird code thinking that it's a real flag.

Change-Id: Iddab86cd6c78181ceb8caa48e77e1f5a8e526343
Reviewed-on: https://gerrit.libreoffice.org/10676
Reviewed-by: Caolán McNamara <caolanm@redhat.com>
Tested-by: Caolán McNamara <caolanm@redhat.com>
2014-08-20 09:01:26 -05:00

328 lines
14 KiB
C++
Raw Blame History

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* 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 .
*/
#include "vcl/ctrl.hxx"
#include "vcl/outdev.hxx"
#include "outfont.hxx"
#include "textlayout.hxx"
#include <com/sun/star/i18n/ScriptDirection.hpp>
#include <tools/diagnose_ex.h>
#if OSL_DEBUG_LEVEL > 1
#include <rtl/strbuf.hxx>
#endif
#include <boost/scoped_array.hpp>
namespace vcl
{
using ::com::sun::star::uno::Reference;
using ::com::sun::star::uno::Exception;
namespace ScriptDirection = ::com::sun::star::i18n::ScriptDirection;
DefaultTextLayout::~DefaultTextLayout()
{
}
long DefaultTextLayout::GetTextWidth( const OUString& _rText, sal_Int32 _nStartIndex, sal_Int32 _nLength ) const
{
return m_rTargetDevice.GetTextWidth( _rText, _nStartIndex, _nLength );
}
void DefaultTextLayout::DrawText( const Point& _rStartPoint, const OUString& _rText, sal_Int32 _nStartIndex,
sal_Int32 _nLength, MetricVector* _pVector, OUString* _pDisplayText )
{
m_rTargetDevice.DrawText( _rStartPoint, _rText, _nStartIndex, _nLength, _pVector, _pDisplayText );
}
bool DefaultTextLayout::GetCaretPositions( const OUString& _rText, long* _pCaretXArray,
sal_Int32 _nStartIndex, sal_Int32 _nLength ) const
{
return m_rTargetDevice.GetCaretPositions( _rText, _pCaretXArray, _nStartIndex, _nLength );
}
sal_Int32 DefaultTextLayout::GetTextBreak( const OUString& _rText, long _nMaxTextWidth, sal_Int32 _nStartIndex, sal_Int32 _nLength ) const
{
return m_rTargetDevice.GetTextBreak( _rText, _nMaxTextWidth, _nStartIndex, _nLength );
}
bool DefaultTextLayout::DecomposeTextRectAction() const
{
return false;
}
class ReferenceDeviceTextLayout : public ITextLayout
{
public:
ReferenceDeviceTextLayout( const Control& _rControl, OutputDevice& _rTargetDevice, OutputDevice& _rReferenceDevice );
virtual ~ReferenceDeviceTextLayout();
// ITextLayout
virtual long GetTextWidth( const OUString& rStr, sal_Int32 nIndex, sal_Int32 nLen ) const SAL_OVERRIDE;
virtual void DrawText( const Point& _rStartPoint, const OUString& _rText, sal_Int32 _nStartIndex, sal_Int32 _nLength, MetricVector* _pVector, OUString* _pDisplayText ) SAL_OVERRIDE;
virtual bool GetCaretPositions( const OUString& _rText, long* _pCaretXArray, sal_Int32 _nStartIndex, sal_Int32 _nLength ) const SAL_OVERRIDE;
virtual sal_Int32 GetTextBreak(const OUString& _rText, long _nMaxTextWidth, sal_Int32 _nStartIndex, sal_Int32 _nLength) const SAL_OVERRIDE;
virtual bool DecomposeTextRectAction() const SAL_OVERRIDE;
public:
// equivalents to the respective OutputDevice methods, which take the reference device into account
long GetTextArray( const OUString& _rText, long* _pDXAry, sal_Int32 _nStartIndex, sal_Int32 _nLength ) const;
Rectangle DrawText( const Rectangle& _rRect, const OUString& _rText, sal_uInt16 _nStyle, MetricVector* _pVector, OUString* _pDisplayText );
protected:
void onBeginDrawText()
{
m_aCompleteTextRect.SetEmpty();
}
Rectangle onEndDrawText()
{
return m_aCompleteTextRect;
}
private:
OutputDevice& m_rTargetDevice;
OutputDevice& m_rReferenceDevice;
Font m_aUnzoomedPointFont;
const Fraction m_aZoom;
const bool m_bRTLEnabled;
Rectangle m_aCompleteTextRect;
};
ReferenceDeviceTextLayout::ReferenceDeviceTextLayout( const Control& _rControl, OutputDevice& _rTargetDevice,
OutputDevice& _rReferenceDevice )
:m_rTargetDevice( _rTargetDevice )
,m_rReferenceDevice( _rReferenceDevice )
,m_aUnzoomedPointFont( _rControl.GetUnzoomedControlPointFont() )
,m_aZoom( _rControl.GetZoom() )
,m_bRTLEnabled( _rControl.IsRTLEnabled() )
{
m_rTargetDevice.Push( PUSH_MAPMODE | PUSH_FONT | PUSH_TEXTLAYOUTMODE );
MapMode aTargetMapMode( m_rTargetDevice.GetMapMode() );
OSL_ENSURE( aTargetMapMode.GetOrigin() == Point(), "ReferenceDeviceTextLayout::ReferenceDeviceTextLayout: uhm, the code below won't work here ..." );
// normally, controls simulate "zoom" by "zooming" the font. This is responsible for (part of) the discrepancies
// between text in Writer and text in controls in Writer, though both have the same font.
// So, if we have a zoom set at the control, then we do not scale the font, but instead modify the map mode
// to accommodate for the zoom.
aTargetMapMode.SetScaleX( m_aZoom ); // TODO: shouldn't this be "current_scale * zoom"?
aTargetMapMode.SetScaleY( m_aZoom );
// also, use a higher-resolution map unit than "pixels", which should save us some rounding errors when
// translating coordinates between the reference device and the target device.
OSL_ENSURE( aTargetMapMode.GetMapUnit() == MAP_PIXEL,
"ReferenceDeviceTextLayout::ReferenceDeviceTextLayout: this class is not expected to work with such target devices!" );
// we *could* adjust all the code in this class to handle this case, but at the moment, it's not necessary
const MapUnit eTargetMapUnit = m_rReferenceDevice.GetMapMode().GetMapUnit();
aTargetMapMode.SetMapUnit( eTargetMapUnit );
OSL_ENSURE( aTargetMapMode.GetMapUnit() != MAP_PIXEL,
"ReferenceDeviceTextLayout::ReferenceDeviceTextLayout: a reference device which has map mode PIXEL?!" );
m_rTargetDevice.SetMapMode( aTargetMapMode );
// now that the Zoom is part of the map mode, reset the target device's font to the "unzoomed" version
Font aDrawFont( m_aUnzoomedPointFont );
aDrawFont.SetSize( OutputDevice::LogicToLogic( aDrawFont.GetSize(), MAP_POINT, eTargetMapUnit ) );
_rTargetDevice.SetFont( aDrawFont );
// transfer font to the reference device
m_rReferenceDevice.Push( PUSH_FONT | PUSH_TEXTLAYOUTMODE );
Font aRefFont( m_aUnzoomedPointFont );
aRefFont.SetSize( OutputDevice::LogicToLogic(
aRefFont.GetSize(), MAP_POINT, m_rReferenceDevice.GetMapMode().GetMapUnit() ) );
m_rReferenceDevice.SetFont( aRefFont );
}
ReferenceDeviceTextLayout::~ReferenceDeviceTextLayout()
{
m_rReferenceDevice.Pop();
m_rTargetDevice.Pop();
}
namespace
{
bool lcl_normalizeLength( const OUString& _rText, const sal_Int32 _nStartIndex, sal_Int32& _io_nLength )
{
sal_Int32 nTextLength = _rText.getLength();
if ( _nStartIndex > nTextLength )
return false;
if ( _nStartIndex + _io_nLength > nTextLength )
_io_nLength = nTextLength - _nStartIndex;
return true;
}
}
long ReferenceDeviceTextLayout::GetTextArray( const OUString& _rText, long* _pDXAry, sal_Int32 _nStartIndex, sal_Int32 _nLength ) const
{
if ( !lcl_normalizeLength( _rText, _nStartIndex, _nLength ) )
return 0;
// retrieve the character widths from the reference device
long nTextWidth = m_rReferenceDevice.GetTextArray( _rText, _pDXAry, _nStartIndex, _nLength );
#if OSL_DEBUG_LEVEL > 1
if ( _pDXAry )
{
OStringBuffer aTrace;
aTrace.append( "ReferenceDeviceTextLayout::GetTextArray( " );
aTrace.append( OUStringToOString( _rText, RTL_TEXTENCODING_UTF8 ) );
aTrace.append( " ): " );
aTrace.append( nTextWidth );
aTrace.append( " = ( " );
for ( sal_Int32 i=0; i<_nLength; )
{
aTrace.append( _pDXAry[i] );
if ( ++i < _nLength )
aTrace.append( ", " );
}
aTrace.append( ")" );
OSL_TRACE( "%s", aTrace.makeStringAndClear().getStr() );
}
#endif
return nTextWidth;
}
long ReferenceDeviceTextLayout::GetTextWidth( const OUString& _rText, sal_Int32 _nStartIndex, sal_Int32 _nLength ) const
{
return GetTextArray( _rText, NULL, _nStartIndex, _nLength );
}
void ReferenceDeviceTextLayout::DrawText( const Point& _rStartPoint, const OUString& _rText, sal_Int32 _nStartIndex, sal_Int32 _nLength, MetricVector* _pVector, OUString* _pDisplayText )
{
if ( !lcl_normalizeLength( _rText, _nStartIndex, _nLength ) )
return;
if ( _pVector && _pDisplayText )
{
MetricVector aGlyphBounds;
m_rReferenceDevice.GetGlyphBoundRects( _rStartPoint, _rText, _nStartIndex, _nLength, _nStartIndex, aGlyphBounds );
::std::copy(
aGlyphBounds.begin(), aGlyphBounds.end(),
::std::insert_iterator< MetricVector > ( *_pVector, _pVector->end() ) );
*_pDisplayText += _rText.copy( _nStartIndex, _nLength );
return;
}
boost::scoped_array<long> pCharWidths(new long[ _nLength ]);
long nTextWidth = GetTextArray( _rText, pCharWidths.get(), _nStartIndex, _nLength );
m_rTargetDevice.DrawTextArray( _rStartPoint, _rText, pCharWidths.get(), _nStartIndex, _nLength );
pCharWidths.reset();
m_aCompleteTextRect.Union( Rectangle( _rStartPoint, Size( nTextWidth, m_rTargetDevice.GetTextHeight() ) ) );
}
bool ReferenceDeviceTextLayout::GetCaretPositions( const OUString& _rText, long* _pCaretXArray,
sal_Int32 _nStartIndex, sal_Int32 _nLength ) const
{
if ( !lcl_normalizeLength( _rText, _nStartIndex, _nLength ) )
return false;
// retrieve the caret positions from the reference device
if ( !m_rReferenceDevice.GetCaretPositions( _rText, _pCaretXArray, _nStartIndex, _nLength ) )
return false;
return true;
}
sal_Int32 ReferenceDeviceTextLayout::GetTextBreak( const OUString& _rText, long _nMaxTextWidth, sal_Int32 _nStartIndex, sal_Int32 _nLength ) const
{
if ( !lcl_normalizeLength( _rText, _nStartIndex, _nLength ) )
return 0;
return m_rReferenceDevice.GetTextBreak( _rText, _nMaxTextWidth, _nStartIndex, _nLength );
}
bool ReferenceDeviceTextLayout::DecomposeTextRectAction() const
{
return true;
}
Rectangle ReferenceDeviceTextLayout::DrawText( const Rectangle& _rRect, const OUString& _rText, sal_uInt16 _nStyle, MetricVector* _pVector, OUString* _pDisplayText )
{
if ( _rText.isEmpty() )
return Rectangle();
// determine text layout mode from the RTL-ness of the control whose text we render
ComplexTextLayoutMode nTextLayoutMode = m_bRTLEnabled ? TEXT_LAYOUT_BIDI_RTL : TEXT_LAYOUT_DEFAULT;
m_rReferenceDevice.SetLayoutMode( nTextLayoutMode );
m_rTargetDevice.SetLayoutMode( nTextLayoutMode | TEXT_LAYOUT_TEXTORIGIN_LEFT );
// TEXT_LAYOUT_TEXTORIGIN_LEFT is because when we do actually draw the text (in DrawText( Point, ... )), then
// our caller gives us the left border of the draw position, regardless of script type, text layout,
// and the like in our ctor, we set the map mode of the target device from pixel to twip, but our caller doesn't know this,
// but passed pixel coordinates. So, adjust the rect.
Rectangle aRect( m_rTargetDevice.PixelToLogic( _rRect ) );
onBeginDrawText();
m_rTargetDevice.DrawText( aRect, _rText, _nStyle, _pVector, _pDisplayText, this );
Rectangle aTextRect = onEndDrawText();
if ( aTextRect.IsEmpty() && !aRect.IsEmpty() )
{
// this happens for instance if we're in a PaintToDevice call, where only a MetaFile is recorded,
// but no actual painting happens, so our "DrawText( Point, ... )" is never called
// In this case, calculate the rect from what OutputDevice::GetTextRect would give us. This has
// the disadvantage of less accuracy, compared with the approach to calculate the rect from the
// single "DrawText( Point, ... )" calls, since more intermediate arithmetics will translate
// from ref- to target-units.
aTextRect = m_rTargetDevice.GetTextRect( aRect, _rText, _nStyle, NULL, this );
}
// similar to above, the text rect now contains TWIPs (or whatever unit the ref device has), but the caller
// expects pixel coordinates
aTextRect = m_rTargetDevice.LogicToPixel( aTextRect );
// convert the metric vector
if ( _pVector )
{
for ( MetricVector::iterator charRect = _pVector->begin();
charRect != _pVector->end();
++charRect
)
{
*charRect = m_rTargetDevice.LogicToPixel( *charRect );
}
}
return aTextRect;
}
ControlTextRenderer::ControlTextRenderer( const Control& _rControl, OutputDevice& _rTargetDevice, OutputDevice& _rReferenceDevice )
:m_pImpl( new ReferenceDeviceTextLayout( _rControl, _rTargetDevice, _rReferenceDevice ) )
{
}
ControlTextRenderer::~ControlTextRenderer()
{
}
Rectangle ControlTextRenderer::DrawText( const Rectangle& _rRect, const OUString& _rText, sal_uInt16 _nStyle,
MetricVector* _pVector, OUString* _pDisplayText )
{
return m_pImpl->DrawText( _rRect, _rText, _nStyle, _pVector, _pDisplayText );
}
} // namespace vcl
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
View Git Blame Copy Permalink