vcl/source/glyphs/gcach_ftyp.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef _SV_GCACHFTYP_HXX
  29 #define _SV_GCACHFTYP_HXX
  30
  31 #include <vcl/glyphcache.hxx>
  32 #include <rtl/textcvt.h>
  33
  34 #include <ft2build.h>
  35 #include FT_FREETYPE_H
  36 class FreetypeServerFont;
  37 struct FT_GlyphRec_;
  38
  39 // -----------------------------------------------------------------------
  40
  41 // FtFontFile has the responsibility that a font file is only mapped once.
  42 // (#86621#) the old directly ft-managed solution caused it to be mapped
  43 // in up to nTTC*nSizes*nOrientation*nSynthetic times
  44 class FtFontFile
  45 {
  46 public:
  47     static FtFontFile*      FindFontFile( const ::rtl::OString& rNativeFileName );
  48
  49     bool                    Map();
  50     void                    Unmap();
  51
  52     const unsigned char*    GetBuffer() const { return mpFileMap; }
  53     int                     GetFileSize() const { return mnFileSize; }
  54     const ::rtl::OString*   GetFileName() const { return &maNativeFileName; }
  55     int                     GetLangBoost() const { return mnLangBoost; }
  56
  57 private:
  58                             FtFontFile( const ::rtl::OString& rNativeFileName );
  59
  60     const ::rtl::OString    maNativeFileName;
  61     const unsigned char*    mpFileMap;
  62     int                     mnFileSize;
  63     int                     mnRefCount;
  64     int                     mnLangBoost;
  65 };
  66
  67 // -----------------------------------------------------------------------
  68
  69 // FtFontInfo corresponds to an unscaled font face
  70 class FtFontInfo
  71 {
  72 public:
  73                            FtFontInfo( const ImplDevFontAttributes&,
  74                                const ::rtl::OString& rNativeFileName,
  75                                int nFaceNum, sal_IntPtr nFontId, int nSynthetic,
  76                                 const ExtraKernInfo* );
  77                           ~FtFontInfo();
  78
  79     const unsigned char*  GetTable( const char*, ULONG* pLength=0 ) const;
  80
  81     FT_FaceRec_*          GetFaceFT();
  82     void                  ReleaseFaceFT( FT_FaceRec_* );
  83
  84     const ::rtl::OString* GetFontFileName() const   { return mpFontFile->GetFileName(); }
  85     int                   GetFaceNum() const        { return mnFaceNum; }
  86     int                   GetSynthetic() const      { return mnSynthetic; }
  87     sal_IntPtr            GetFontId() const         { return mnFontId; }
  88     bool                  DontUseAntiAlias() const
  89         { return maDevFontAttributes.UseAntiAlias() == ANTIALIAS_FALSE; }
  90     bool                  DontUseEmbeddedBitmaps() const
  91         { return maDevFontAttributes.UseEmbeddedBitmap() == EMBEDDEDBITMAP_FALSE; }
  92     bool                  IsSymbolFont() const      { return maDevFontAttributes.IsSymbolFont(); }
  93     const ImplFontAttributes& GetFontAttributes() const { return maDevFontAttributes; }
  94
  95     void                  AnnounceFont( ImplDevFontList* );
  96
  97     int                   GetGlyphIndex( sal_UCS4 cChar ) const;
  98     void                  CacheGlyphIndex( sal_UCS4 cChar, int nGI ) const;
  99
 100     bool                  HasExtraKerning() const;
 101     int                   GetExtraKernPairs( ImplKernPairData** ) const;
 102     int                   GetExtraGlyphKernValue( int nLeftGlyph, int nRightGlyph ) const;
 103
 104 private:
 105     FT_FaceRec_*    maFaceFT;
 106     FtFontFile*     mpFontFile;
 107     const int       mnFaceNum;
 108     int             mnRefCount;
 109     const int       mnSynthetic;
 110
 111     sal_IntPtr      mnFontId;
 112     ImplDevFontAttributes maDevFontAttributes;
 113
 114     // cache unicode->glyphid mapping because looking it up is expensive
 115     // TODO: change to hash_multimap when a use case requires a m:n mapping
 116     typedef ::std::hash_map<int,int> Int2IntMap;
 117     mutable Int2IntMap* mpChar2Glyph;
 118     mutable Int2IntMap* mpGlyph2Char;
 119     void InitHashes() const;
 120
 121     const ExtraKernInfo* mpExtraKernInfo;
 122 };
 123
 124 // these two inlines are very important for performance
 125
 126 inline int FtFontInfo::GetGlyphIndex( sal_UCS4 cChar ) const
 127 {
 128     if( !mpChar2Glyph )
 129         return -1;
 130     Int2IntMap::const_iterator it = mpChar2Glyph->find( cChar );
 131     if( it == mpChar2Glyph->end() )
 132         return -1;
 133     return it->second;
 134 }
 135
 136 inline void FtFontInfo::CacheGlyphIndex( sal_UCS4 cChar, int nIndex ) const
 137 {
 138     if( !mpChar2Glyph )
 139         InitHashes();
 140     (*mpChar2Glyph)[ cChar ] = nIndex;
 141     (*mpGlyph2Char)[ nIndex ] = cChar;
 142 }
 143
 144 // -----------------------------------------------------------------------
 145
 146 class FreetypeManager
 147 {
 148 public:
 149                         FreetypeManager();
 150                         ~FreetypeManager();
 151
 152     long                AddFontDir( const String& rUrlName );
 153     void                AddFontFile( const rtl::OString& rNormalizedName,
 154                             int nFaceNum, sal_IntPtr nFontId, const ImplDevFontAttributes&,
 155                             const ExtraKernInfo* );
 156     void                AnnounceFonts( ImplDevFontList* ) const;
 157     void                ClearFontList();
 158
 159     FreetypeServerFont* CreateFont( const ImplFontSelectData& );
 160
 161 private:
 162     typedef ::std::hash_map<sal_IntPtr,FtFontInfo*> FontList;
 163     FontList            maFontList;
 164
 165     sal_IntPtr          mnMaxFontId;
 166     sal_IntPtr          mnNextFontId;
 167 };
 168
 169 // -----------------------------------------------------------------------
 170
 171 class FreetypeServerFont : public ServerFont
 172 {
 173 public:
 174                                 FreetypeServerFont( const ImplFontSelectData&, FtFontInfo* );
 175     virtual                     ~FreetypeServerFont();
 176
 177     virtual const ::rtl::OString* GetFontFileName() const { return mpFontInfo->GetFontFileName(); }
 178     virtual int                 GetFontFaceNum() const { return mpFontInfo->GetFaceNum(); }
 179     virtual bool                TestFont() const;
 180     virtual void*               GetFtFace() const;
 181     virtual int                 GetLoadFlags() const { return (mnLoadFlags & ~FT_LOAD_IGNORE_TRANSFORM); }
 182     virtual bool                NeedsArtificialBold() const { return mbArtBold; }
 183     virtual bool                NeedsArtificialItalic() const { return mbArtItalic; }
 184
 185     virtual void                FetchFontMetric( ImplFontMetricData&, long& rFactor ) const;
 186
 187     virtual int                 GetGlyphIndex( sal_UCS4 ) const;
 188     int                         GetRawGlyphIndex( sal_UCS4 ) const;
 189     int                         FixupGlyphIndex( int nGlyphIndex, sal_UCS4 ) const;
 190
 191     virtual bool                GetAntialiasAdvice( void ) const;
 192     virtual bool                GetGlyphBitmap1( int nGlyphIndex, RawBitmap& ) const;
 193     virtual bool                GetGlyphBitmap8( int nGlyphIndex, RawBitmap& ) const;
 194     virtual bool                GetGlyphOutline( int nGlyphIndex, ::basegfx::B2DPolyPolygon& ) const;
 195     virtual int                 GetGlyphKernValue( int nLeftGlyph, int nRightGlyph ) const;
 196     virtual ULONG               GetKernPairs( ImplKernPairData** ) const;
 197
 198     const unsigned char*        GetTable( const char* pName, ULONG* pLength )
 199                                 { return mpFontInfo->GetTable( pName, pLength ); }
 200     int                         GetEmUnits() const;
 201     const FT_Size_Metrics&      GetMetricsFT() const { return maSizeFT->metrics; }
 202
 203 protected:
 204     friend class GlyphCache;
 205
 206     int                         ApplyGlyphTransform( int nGlyphFlags, FT_GlyphRec_*, bool ) const;
 207     virtual void                InitGlyphData( int nGlyphIndex, GlyphData& ) const;
 208     virtual bool                GetFontCodeRanges( CmapResult& ) const;
 209     bool                        ApplyGSUB( const ImplFontSelectData& );
 210     virtual ServerFontLayoutEngine* GetLayoutEngine();
 211
 212 private:
 213     int                         mnWidth;
 214     int                         mnPrioEmbedded;
 215     int                         mnPrioAntiAlias;
 216     FtFontInfo*                 mpFontInfo;
 217     FT_Int                      mnLoadFlags;
 218     double                      mfStretch;
 219     FT_FaceRec_*                maFaceFT;
 220     FT_SizeRec_*                maSizeFT;
 221
 222     bool                        mbFaceOk;
 223     bool                        mbArtItalic;
 224     bool                        mbArtBold;
 225     bool                        mbUseGamma;
 226
 227     typedef ::std::hash_map<int,int> GlyphSubstitution;
 228     GlyphSubstitution           maGlyphSubstitution;
 229     rtl_UnicodeToTextConverter  maRecodeConverter;
 230
 231     ServerFontLayoutEngine*     mpLayoutEngine;
 232 };
 233
 234 // -----------------------------------------------------------------------
 235
 236 class ImplFTSFontData : public ImplFontData
 237 {
 238 private:
 239     FtFontInfo*             mpFtFontInfo;
 240     enum { IFTSFONT_MAGIC = 0x1F150A1C };
 241
 242 public:
 243                             ImplFTSFontData( FtFontInfo*, const ImplDevFontAttributes& );
 244
 245     FtFontInfo*             GetFtFontInfo() const { return mpFtFontInfo; }
 246
 247     virtual ImplFontEntry*  CreateFontInstance( ImplFontSelectData& ) const;
 248     virtual ImplFontData*   Clone() const   { return new ImplFTSFontData( *this ); }
 249     virtual sal_IntPtr      GetFontId() const { return mpFtFontInfo->GetFontId(); }
 250
 251     static bool             CheckFontData( const ImplFontData& r ) { return r.CheckMagic( IFTSFONT_MAGIC ); }
 252 };
 253
 254 // -----------------------------------------------------------------------
 255
 256 #endif // _SV_GCACHFTYP_HXX