/* -*- 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_INC_GENERIC_GLYPHCACHE_HXX #define INCLUDED_VCL_INC_GENERIC_GLYPHCACHE_HXX #include #include #include FT_FREETYPE_H #include FT_GLYPH_H #include #include #include #include #include #include #include "fontattributes.hxx" #include "impfontmetricdata.hxx" #include "hb-ot.h" #include class FreetypeManager; class FreetypeFontInfo; class GlyphData; class GraphiteFaceWrapper; class FontConfigFontOptions; class PhysicalFontCollection; class FreetypeFont; class ServerFontLayout; class ServerFontLayoutEngine; class SvpGcpHelper; namespace basegfx { class B2DPolyPolygon; } namespace vcl { struct FontCapabilities; } class VCL_DLLPUBLIC GlyphCache { public: explicit GlyphCache(); virtual ~GlyphCache(); static GlyphCache& GetInstance(); void AddFontFile( const OString& rNormalizedName, int nFaceNum, sal_IntPtr nFontId, const FontAttributes&); void AnnounceFonts( PhysicalFontCollection* ) const; FreetypeFont* CacheFont( const FontSelectPattern& ); void UncacheFont( FreetypeFont& ); void ClearFontCache(); void InvalidateAllGlyphs(); private: friend class FreetypeFont; // used by FreetypeFont class only void AddedGlyph( FreetypeFont&, GlyphData& ); void RemovingGlyph(); void UsingGlyph( FreetypeFont&, GlyphData& ); private: void GarbageCollect(); // the GlyphCache's FontList matches a font request to a serverfont instance // the FontList key's mpFontData member is reinterpreted as integer font id struct IFSD_Equal{ bool operator()( const FontSelectPattern&, const FontSelectPattern& ) const; }; struct IFSD_Hash{ size_t operator()( const FontSelectPattern& ) const; }; typedef std::unordered_map FontList; FontList maFontList; sal_uLong mnMaxSize; // max overall cache size in bytes mutable sal_uLong mnBytesUsed; mutable long mnLruIndex; mutable int mnGlyphCount; FreetypeFont* mpCurrentGCFont; FreetypeManager* mpFtManager; }; class GlyphMetric { public: GlyphMetric() : mnAdvanceWidth(0) {} const Point& GetOffset() const { return maOffset; } const Size& GetSize() const { return maSize; } long GetCharWidth() const { return mnAdvanceWidth; } protected: friend class GlyphData; void SetOffset( int nX, int nY ) { maOffset = Point( nX, nY); } void SetDelta( int nX, int nY ) { maDelta = Point( nX, nY); } void SetSize( const Size& s ) { maSize = s; } void SetCharWidth( long nW ) { mnAdvanceWidth = nW; } private: long mnAdvanceWidth; Point maDelta; Point maOffset; Size maSize; }; class GlyphData { public: GlyphData() : mnLruValue(0) {} const GlyphMetric& GetMetric() const { return maGlyphMetric; } void SetSize( const Size& s) { maGlyphMetric.SetSize( s ); } void SetOffset( int nX, int nY ) { maGlyphMetric.SetOffset( nX, nY ); } void SetDelta( int nX, int nY ) { maGlyphMetric.SetDelta( nX, nY ); } void SetCharWidth( long nW ) { maGlyphMetric.SetCharWidth( nW ); } void SetLruValue( int n ) const { mnLruValue = n; } long GetLruValue() const { return mnLruValue;} private: GlyphMetric maGlyphMetric; // used by GlyphCache for cache LRU algorithm mutable long mnLruValue; }; class VCL_DLLPUBLIC FreetypeFont final { public: FreetypeFont( const FontSelectPattern&, FreetypeFontInfo* ); ~FreetypeFont(); const OString& GetFontFileName() const; bool TestFont() const { return mbFaceOk;} FT_Face GetFtFace() const; int GetLoadFlags() const { return (mnLoadFlags & ~FT_LOAD_IGNORE_TRANSFORM); } void SetFontOptions(const std::shared_ptr&); const std::shared_ptr& GetFontOptions() const; bool NeedsArtificialBold() const { return mbArtBold; } bool NeedsArtificialItalic() const { return mbArtItalic; } const FontSelectPattern& GetFontSelData() const { return maFontSelData; } void GetFontMetric( ImplFontMetricDataRef&, long& rFactor ) const; const unsigned char* GetTable( const char* pName, sal_uLong* pLength ); int GetEmUnits() const { return maFaceFT->units_per_EM;} double GetStretch() { return mfStretch; } const FontCharMapRef GetFontCharMap() const; bool GetFontCapabilities(vcl::FontCapabilities &) const; GlyphData& GetGlyphData( sal_GlyphId ); const GlyphMetric& GetGlyphMetric( sal_GlyphId aGlyphId ) { return GetGlyphData( aGlyphId ).GetMetric(); } #if ENABLE_GRAPHITE GraphiteFaceWrapper* GetGraphiteFace() const; #endif sal_GlyphId GetGlyphIndex( sal_UCS4 ) const; sal_GlyphId GetRawGlyphIndex( sal_UCS4, sal_UCS4 = 0 ) const; sal_GlyphId FixupGlyphIndex( sal_GlyphId aGlyphId, sal_UCS4 ) const; bool GetGlyphOutline( sal_GlyphId aGlyphId, basegfx::B2DPolyPolygon& ) const; bool GetAntialiasAdvice() const; hb_font_t* GetHbFont() { return mpHbFont; } void SetHbFont( hb_font_t* pHbFont ) { mpHbFont = pHbFont; } private: friend class GlyphCache; friend class ServerFontLayout; friend class FreetypeFontInstance; friend class X11SalGraphics; friend class CairoTextRender; void AddRef() const { ++mnRefCount; } long GetRefCount() const { return mnRefCount; } long Release() const; sal_uLong GetByteCount() const { return mnBytesUsed; } void InitGlyphData( sal_GlyphId, GlyphData& ) const; void GarbageCollect( long ); void ReleaseFromGarbageCollect(); void ApplyGlyphTransform( int nGlyphFlags, FT_GlyphRec_* ) const; void ApplyGSUB( const FontSelectPattern& ); ServerFontLayoutEngine* GetLayoutEngine(); typedef std::unordered_map GlyphList; mutable GlyphList maGlyphList; const FontSelectPattern maFontSelData; // used by GlyphCache for cache LRU algorithm mutable long mnRefCount; mutable sal_uLong mnBytesUsed; FreetypeFont* mpPrevGCFont; FreetypeFont* mpNextGCFont; // 16.16 fixed point values used for a rotated font long mnCos; long mnSin; int mnWidth; int mnPrioEmbedded; int mnPrioAntiAlias; int mnPrioAutoHint; FreetypeFontInfo* mpFontInfo; FT_Int mnLoadFlags; double mfStretch; FT_FaceRec_* maFaceFT; FT_SizeRec_* maSizeFT; std::shared_ptr mxFontOptions; bool mbFaceOk; bool mbArtItalic; bool mbArtBold; bool mbUseGamma; typedef std::unordered_map GlyphSubstitution; GlyphSubstitution maGlyphSubstitution; ServerFontLayoutEngine* mpLayoutEngine; hb_font_t* mpHbFont; }; // a class for cache entries for physical font instances that are based on serverfonts class VCL_DLLPUBLIC FreetypeFontInstance : public LogicalFontInstance { public: FreetypeFontInstance( FontSelectPattern& ); virtual ~FreetypeFontInstance() override; void SetFreetypeFont(FreetypeFont* p); void HandleFontOptions(); private: FreetypeFont* mpFreetypeFont; std::shared_ptr mxFontOptions; bool mbGotFontOptions; }; class VCL_DLLPUBLIC ServerFontLayout : public GenericSalLayout { public: ServerFontLayout( FreetypeFont& ); virtual bool LayoutText( ImplLayoutArgs& ) override; virtual void AdjustLayout( ImplLayoutArgs& ) override; virtual void DrawText( SalGraphics& ) const override; void SetNeedFallback( ImplLayoutArgs& rArgs, sal_Int32 nIndex, bool bRightToLeft); FreetypeFont& GetFreetypeFont() const { return mrFreetypeFont; } virtual std::shared_ptr CreateTextLayoutCache(OUString const&) const override; private: FreetypeFont& mrFreetypeFont; css::uno::Reference mxBreak; ServerFontLayout( const ServerFontLayout& ) = delete; ServerFontLayout& operator=( const ServerFontLayout& ) = delete; }; class ServerFontLayoutEngine { public: virtual ~ServerFontLayoutEngine() {} virtual bool Layout(ServerFontLayout&, ImplLayoutArgs&) = 0; }; #endif // INCLUDED_VCL_INC_GENERIC_GLYPHCACHE_HXX /* vim:set shiftwidth=4 softtabstop=4 expandtab: */