LibreOffice Module sw (master)  1
fntcache.hxx
Go to the documentation of this file.
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 
20 #ifndef INCLUDED_SW_SOURCE_CORE_INC_FNTCACHE_HXX
21 #define INCLUDED_SW_SOURCE_CORE_INC_FNTCACHE_HXX
22 
23 #include <sal/config.h>
24 
25 #include <cstdint>
26 #include <map>
27 
28 #include <vcl/font.hxx>
29 #include <vcl/vclptr.hxx>
30 #include <vcl/vcllayout.hxx>
31 #include <vcl/outdev.hxx>
32 #include "swcache.hxx"
33 #include "TextFrameIndex.hxx"
34 
35 class FontMetric;
36 class SwFntObj;
37 class SwDrawTextInfo;
38 class SwViewShell;
39 class SwSubFont;
40 class MapMode;
41 
42 class SwFntCache : public SwCache
43 {
44 public:
46 #ifdef DBG_UTIL
47  , OString(RTL_CONSTASCII_STRINGPARAM("Global Font-Cache pFntCache"))
48 #endif
49  ) {}
50 
51  inline SwFntObj *First( );
52  static inline SwFntObj *Next( SwFntObj *pFntObj);
53  void Flush();
54 };
55 
58 
59 // Font cache, global variable, created/destroyed in txtinit.cxx
60 extern SwFntCache *pFntCache;
61 extern SwFntObj *pLastFont;
62 
68 {
70  OUString m_aText;
71  sal_Int32 m_nIndex;
72  sal_Int32 m_nLength;
73 
74 };
75 bool operator<(const SwTextGlyphsKey& l, const SwTextGlyphsKey& r);
76 
77 class SwFntObj : public SwCacheObj
78 {
79  friend class SwFntAccess;
80  friend void InitCore();
81  friend void FinitCore();
82 
87  sal_uInt16 m_nGuessedLeading;
88  sal_uInt16 m_nExtLeading;
89  sal_uInt16 m_nScrAscent;
90  sal_uInt16 m_nPrtAscent;
91  sal_uInt16 m_nScrHeight;
92  sal_uInt16 m_nPrtHeight;
93  sal_uInt16 const m_nPropWidth;
94  sal_uInt16 m_nZoom;
95  bool m_bSymbol : 1;
96  bool m_bPaintBlank : 1;
97 
99  std::map<SwTextGlyphsKey, SalLayoutGlyphs> m_aTextGlyphs;
100 
101  static long nPixWidth;
102  static MapMode *pPixMap;
103 
104 public:
105  SwFntObj( const SwSubFont &rFont, std::uintptr_t nFontCacheId,
106  SwViewShell const *pSh );
107 
108  virtual ~SwFntObj() override;
109 
111  vcl::Font& GetFont() { return m_aFont; }
112  const vcl::Font& GetFont() const { return m_aFont; }
113 
114  sal_uInt16 GetGuessedLeading() const { return m_nGuessedLeading; }
115  sal_uInt16 GetExternalLeading() const { return m_nExtLeading; }
116 
117  sal_uInt16 GetFontAscent( const SwViewShell *pSh, const OutputDevice& rOut );
118  sal_uInt16 GetFontHeight( const SwViewShell *pSh, const OutputDevice& rOut );
119  sal_uInt16 GetFontLeading( const SwViewShell *pSh, const OutputDevice& rOut );
120 
121  void GuessLeading( const SwViewShell& rSh, const FontMetric& rMet );
122 
123  void SetDevFont( const SwViewShell *pSh, OutputDevice& rOut );
124  OutputDevice* GetPrt() const { return m_pPrinter; }
125  sal_uInt16 GetZoom() const { return m_nZoom; }
126  sal_uInt16 GetPropWidth() const { return m_nPropWidth; }
127  bool IsSymbol() const { return m_bSymbol; }
128  std::map<SwTextGlyphsKey, SalLayoutGlyphs>& GetTextGlyphs() { return m_aTextGlyphs; }
129 
130  void DrawText( SwDrawTextInfo &rInf );
134 
135  void CreateScrFont( const SwViewShell& rSh, const OutputDevice& rOut );
136  void CreatePrtFont( const OutputDevice& rOut );
137 };
138 
140 {
141  return static_cast<SwFntObj *>(SwCache::First());
142 }
143 
145 {
146  return static_cast<SwFntObj *>(SwCache::Next( pFntObj ));
147 }
148 
150 {
152 protected:
153  virtual SwCacheObj *NewObj( ) override;
154 
155 public:
156  SwFntAccess( const void*& rnFontCacheId, sal_uInt16 &rIndex, const void *pOwner,
157  SwViewShell const *pShell,
158  bool bCheck = false );
159  SwFntObj* Get() { return static_cast<SwFntObj*>( SwCacheAccess::Get() ); }
160 };
161 
162 #endif
163 
164 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
OutputDevice * GetPrt() const
Definition: fntcache.hxx:124
SwFntObj * pLastFont
Definition: fntcache.cxx:70
sal_uInt16 m_nExtLeading
Definition: fntcache.hxx:88
void SwClearFntCacheTextGlyphs()
Clears the pre-calculated text glyphs in all SwFntObj instances.
Definition: fntcache.cxx:2706
bool operator<(const SwTextGlyphsKey &l, const SwTextGlyphsKey &r)
Definition: fntcache.cxx:132
void CreateScrFont(const SwViewShell &rSh, const OutputDevice &rOut)
Definition: fntcache.cxx:470
virtual SwCacheObj * NewObj() override
Can be use in NewObj.
Definition: fntcache.cxx:2374
SwFntAccess(const void *&rnFontCacheId, sal_uInt16 &rIndex, const void *pOwner, SwViewShell const *pShell, bool bCheck=false)
Definition: fntcache.cxx:2270
bool m_bPaintBlank
Definition: fntcache.hxx:96
std::map< SwTextGlyphsKey, SalLayoutGlyphs > m_aTextGlyphs
Cache of already calculated layout glyphs.
Definition: fntcache.hxx:99
SwCacheObj * First()
Definition: swcache.hxx:114
sal_uInt16 GetFontHeight(const SwViewShell *pSh, const OutputDevice &rOut)
Definition: fntcache.cxx:379
bool m_bSymbol
Definition: fntcache.hxx:95
static SwCacheObj * Next(SwCacheObj *pCacheObj)
Definition: swcache.hxx:221
sal_uInt16 GetFontAscent(const SwViewShell *pSh, const OutputDevice &rOut)
Definition: fntcache.cxx:342
sal_uInt16 m_nScrHeight
Definition: fntcache.hxx:91
sal_uInt16 GetGuessedLeading() const
Definition: fntcache.hxx:114
std::map< SwTextGlyphsKey, SalLayoutGlyphs > & GetTextGlyphs()
Definition: fntcache.hxx:128
VclPtr< OutputDevice > m_pOutputDevice
Definition: fntcache.hxx:69
sal_uInt16 GetZoom() const
Definition: fntcache.hxx:125
VclPtr< OutputDevice > m_pPrinter
Definition: fntcache.hxx:86
SwCacheObj * Get(bool isDuplicateOwnerAllowed)
Definition: swcache.hxx:248
vcl::Font & GetFont()
Definition: fntcache.hxx:111
static SwFntObj * Next(SwFntObj *pFntObj)
Definition: fntcache.hxx:144
sal_uInt16 GetFontLeading(const SwViewShell *pSh, const OutputDevice &rOut)
Definition: fntcache.cxx:418
TextFrameIndex GetCursorOfst(SwDrawTextInfo &rInf)
Definition: fntcache.cxx:2084
void Flush()
Definition: fntcache.cxx:165
bool IsSymbol() const
Definition: fntcache.hxx:127
Defines a substring on a given output device, to be used as an std::map<> key.
Definition: fntcache.hxx:67
OUString m_aText
Definition: fntcache.hxx:70
vcl::Font * m_pScrFont
Definition: fntcache.hxx:84
void CreatePrtFont(const OutputDevice &rOut)
Definition: fntcache.cxx:206
vcl::Font * m_pPrtFont
Definition: fntcache.hxx:85
void GuessLeading(const SwViewShell &rSh, const FontMetric &rMet)
Definition: fntcache.cxx:562
SwViewShell const * m_pShell
Definition: fntcache.hxx:151
sal_uInt16 m_nZoom
Definition: fntcache.hxx:94
sal_uInt16 GetPropWidth() const
Definition: fntcache.hxx:126
sal_uInt16 const m_nPropWidth
Definition: fntcache.hxx:93
SwFntCache * pFntCache
Definition: fntcache.cxx:68
friend void FinitCore()
Definition: init.cxx:672
sal_Int32 m_nIndex
Definition: fntcache.hxx:71
vcl::Font * GetScrFont()
Definition: fntcache.hxx:110
void SetDevFont(const SwViewShell *pSh, OutputDevice &rOut)
Definition: fntcache.cxx:642
static long nPixWidth
Definition: fntcache.hxx:101
SwFntObj * Get()
Definition: fntcache.hxx:159
sal_Int32 m_nLength
Definition: fntcache.hxx:72
virtual ~SwFntObj() override
Definition: fntcache.cxx:198
The Cache object base class Users of the Cache must derive a class from the SwCacheObj and store thei...
Definition: swcache.hxx:133
static MapMode * pPixMap
Definition: fntcache.hxx:102
sal_uInt16 m_nPrtAscent
Definition: fntcache.hxx:90
SwFntObj * First()
Definition: fntcache.hxx:139
SwFntObj(const SwSubFont &rFont, std::uintptr_t nFontCacheId, SwViewShell const *pSh)
Definition: fntcache.cxx:175
friend void InitCore()
Definition: init.cxx:455
void DrawText(SwDrawTextInfo &rInf)
Definition: fntcache.cxx:838
Access class for the Cache.
Definition: swcache.hxx:194
sal_uInt16 m_nGuessedLeading
Definition: fntcache.hxx:87
vcl::Font m_aFont
Definition: fntcache.hxx:83
sal_uInt16 GetExternalLeading() const
Definition: fntcache.hxx:115
const vcl::Font & GetFont() const
Definition: fntcache.hxx:112
sal_uInt16 m_nScrAscent
Definition: fntcache.hxx:89
Size GetTextSize(SwDrawTextInfo &rInf)
determine the TextSize (of the printer)
Definition: fntcache.cxx:1882
sal_uInt16 m_nPrtHeight
Definition: fntcache.hxx:92