diff --git a/include/vcl/outdev.hxx b/include/vcl/outdev.hxx index 71a73b8e0b0f..e414121d4dcd 100644 --- a/include/vcl/outdev.hxx +++ b/include/vcl/outdev.hxx @@ -1321,7 +1321,7 @@ public: SAL_DLLPRIVATE void ReMirror( vcl::Region &rRegion ) const; SAL_DLLPRIVATE bool ImplIsRecordLayout() const; virtual bool HasMirroredGraphics() const; - SAL_DLLPRIVATE std::unique_ptr + std::unique_ptr ImplLayout( const OUString&, sal_Int32 nIndex, sal_Int32 nLen, const Point& rLogicPos = Point(0,0), long nLogicWidth=0, const long* pLogicDXArray=nullptr, SalLayoutFlags flags = SalLayoutFlags::NONE, diff --git a/include/vcl/vcllayout.hxx b/include/vcl/vcllayout.hxx new file mode 100644 index 000000000000..d9d4e0c42b99 --- /dev/null +++ b/include/vcl/vcllayout.hxx @@ -0,0 +1,130 @@ +/* -*- 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 . + */ + +#ifndef INCLUDED_VCL_VCLLAYOUT_HXX +#define INCLUDED_VCL_VCLLAYOUT_HXX + +#include + +#include +#include +#include +#include + +class ImplLayoutArgs; +class PhysicalFontFace; +class SalGraphics; +struct GlyphItem; +namespace vcl +{ +class TextLayoutCache; +} + +// all positions/widths are in font units +// one exception: drawposition is in pixel units + +// Unfortunately there is little documentation to help implementors of +// new classes derived from SalLayout ("layout engines"), and the code +// and data structures are far from obvious. + +// For instance, I *think* the important virtual functions in the +// layout engines are called in this order: + +// * InitFont() +// * LayoutText() +// * AdjustLayout(), any number of times (but presumably +// usually not at all or just once) +// * Optionally, DrawText() + +// Functions that just return information like GetTexWidth() and +// FillDXArray() are called after LayoutText() and before DrawText(). + +// Another important questions is which parts of an ImplLayoutArgs can +// be changed by callers between LayoutText() and AdjustLayout() +// calls. It probably makes sense only if one assumes that the "string +// related inputs" part are not changed after LayoutText(). + +// But why use the same ImplLayoutArgs structure as parameter for both +// LayoutText() and AdjustLayout() in the first place? And why +// duplicate some of the fields in both SalLayout and ImplLayoutArgs +// (mnMinCharPos, mnEndCharPos, mnLayoutFlags==mnFlags, +// mnOrientation)? Lost in history... + +class VCL_DLLPUBLIC SalLayout +{ +public: + virtual ~SalLayout(); + // used by upper layers + Point& DrawBase() { return maDrawBase; } + const Point& DrawBase() const { return maDrawBase; } + Point& DrawOffset() { return maDrawOffset; } + const Point& DrawOffset() const { return maDrawOffset; } + Point GetDrawPosition( const Point& rRelative = Point(0,0) ) const; + + virtual bool LayoutText( ImplLayoutArgs& ) = 0; // first step of layouting + virtual void AdjustLayout( ImplLayoutArgs& ); // adjusting after fallback etc. + virtual void InitFont() const {} + virtual void DrawText( SalGraphics& ) const = 0; + + int GetUnitsPerPixel() const { return mnUnitsPerPixel; } + int GetOrientation() const { return mnOrientation; } + + // methods using string indexing + virtual sal_Int32 GetTextBreak(DeviceCoordinate nMaxWidth, DeviceCoordinate nCharExtra, int nFactor) const = 0; + virtual DeviceCoordinate FillDXArray( DeviceCoordinate* pDXArray ) const = 0; + virtual DeviceCoordinate GetTextWidth() const { return FillDXArray( nullptr ); } + virtual void GetCaretPositions( int nArraySize, long* pCaretXArray ) const = 0; + virtual bool IsKashidaPosValid ( int /*nCharPos*/ ) const { return true; } // i60594 + + // methods using glyph indexing + virtual bool GetNextGlyph(const GlyphItem** pGlyph, Point& rPos, int&, + const PhysicalFontFace** pFallbackFont = nullptr) const = 0; + virtual bool GetOutline( SalGraphics&, basegfx::B2DPolyPolygonVector& ) const; + virtual bool GetBoundRect( SalGraphics&, tools::Rectangle& ) const; + + // used by glyph+font+script fallback + virtual void MoveGlyph( int nStart, long nNewXPos ) = 0; + virtual void DropGlyph( int nStart ) = 0; + virtual void Simplify( bool bIsBase ) = 0; + + virtual std::shared_ptr + CreateTextLayoutCache(OUString const&) const; + +protected: + // used by layout engines + SalLayout(); + +private: + SalLayout( const SalLayout& ) = delete; + SalLayout& operator=( const SalLayout& ) = delete; + +protected: + int mnMinCharPos; + int mnEndCharPos; + + int mnUnitsPerPixel; + int mnOrientation; + + mutable Point maDrawOffset; + Point maDrawBase; +}; + +#endif // INCLUDED_VCL_VCLLAYOUT_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/solenv/clang-format/blacklist b/solenv/clang-format/blacklist index 312b8016ba05..2055a40fbd6a 100644 --- a/solenv/clang-format/blacklist +++ b/solenv/clang-format/blacklist @@ -8079,6 +8079,7 @@ include/vcl/unohelp2.hxx include/vcl/unowrap.hxx include/vcl/vclenum.hxx include/vcl/vclevent.hxx +include/vcl/vcllayout.hxx include/vcl/vclmain.hxx include/vcl/vclmedit.hxx include/vcl/vclptr.hxx diff --git a/vcl/inc/sallayout.hxx b/vcl/inc/sallayout.hxx index b6fc7ed75a5c..123c339b525a 100644 --- a/vcl/inc/sallayout.hxx +++ b/vcl/inc/sallayout.hxx @@ -35,6 +35,7 @@ #include #include // for typedef sal_UCS4 #include +#include #include "fontinstance.hxx" @@ -122,95 +123,6 @@ private: // For nice SAL_INFO logging of ImplLayoutArgs values std::ostream &operator <<(std::ostream& s, ImplLayoutArgs const &rArgs); -// all positions/widths are in font units -// one exception: drawposition is in pixel units - -// Unfortunately there is little documentation to help implementors of -// new classes derived from SalLayout ("layout engines"), and the code -// and data structures are far from obvious. - -// For instance, I *think* the important virtual functions in the -// layout engines are called in this order: - -// * InitFont() -// * LayoutText() -// * AdjustLayout(), any number of times (but presumably -// usually not at all or just once) -// * Optionally, DrawText() - -// Functions that just return information like GetTexWidth() and -// FillDXArray() are called after LayoutText() and before DrawText(). - -// Another important questions is which parts of an ImplLayoutArgs can -// be changed by callers between LayoutText() and AdjustLayout() -// calls. It probably makes sense only if one assumes that the "string -// related inputs" part are not changed after LayoutText(). - -// But why use the same ImplLayoutArgs structure as parameter for both -// LayoutText() and AdjustLayout() in the first place? And why -// duplicate some of the fields in both SalLayout and ImplLayoutArgs -// (mnMinCharPos, mnEndCharPos, mnLayoutFlags==mnFlags, -// mnOrientation)? Lost in history... - -class VCL_PLUGIN_PUBLIC SalLayout -{ -public: - virtual ~SalLayout(); - // used by upper layers - Point& DrawBase() { return maDrawBase; } - const Point& DrawBase() const { return maDrawBase; } - Point& DrawOffset() { return maDrawOffset; } - const Point& DrawOffset() const { return maDrawOffset; } - Point GetDrawPosition( const Point& rRelative = Point(0,0) ) const; - - virtual bool LayoutText( ImplLayoutArgs& ) = 0; // first step of layouting - virtual void AdjustLayout( ImplLayoutArgs& ); // adjusting after fallback etc. - virtual void InitFont() const {} - virtual void DrawText( SalGraphics& ) const = 0; - - int GetUnitsPerPixel() const { return mnUnitsPerPixel; } - int GetOrientation() const { return mnOrientation; } - - // methods using string indexing - virtual sal_Int32 GetTextBreak(DeviceCoordinate nMaxWidth, DeviceCoordinate nCharExtra, int nFactor) const = 0; - virtual DeviceCoordinate FillDXArray( DeviceCoordinate* pDXArray ) const = 0; - virtual DeviceCoordinate GetTextWidth() const { return FillDXArray( nullptr ); } - virtual void GetCaretPositions( int nArraySize, long* pCaretXArray ) const = 0; - virtual bool IsKashidaPosValid ( int /*nCharPos*/ ) const { return true; } // i60594 - - // methods using glyph indexing - virtual bool GetNextGlyph(const GlyphItem** pGlyph, Point& rPos, int&, - const PhysicalFontFace** pFallbackFont = nullptr) const = 0; - virtual bool GetOutline( SalGraphics&, basegfx::B2DPolyPolygonVector& ) const; - virtual bool GetBoundRect( SalGraphics&, tools::Rectangle& ) const; - - // used by glyph+font+script fallback - virtual void MoveGlyph( int nStart, long nNewXPos ) = 0; - virtual void DropGlyph( int nStart ) = 0; - virtual void Simplify( bool bIsBase ) = 0; - - virtual std::shared_ptr - CreateTextLayoutCache(OUString const&) const; - -protected: - // used by layout engines - SalLayout(); - -private: - SalLayout( const SalLayout& ) = delete; - SalLayout& operator=( const SalLayout& ) = delete; - -protected: - int mnMinCharPos; - int mnEndCharPos; - - int mnUnitsPerPixel; - int mnOrientation; - - mutable Point maDrawOffset; - Point maDrawBase; -}; - class VCL_PLUGIN_PUBLIC MultiSalLayout final : public SalLayout { public: