vcl/generic/fontmanager/fontsubst.cxx

   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 #include "generic/geninst.h"
  21 #include "generic/genpspgraphics.h"
  22 #include "generic/glyphcache.hxx"
  23
  24 #include "vcl/sysdata.hxx"
  25 #include "outfont.hxx"
  26
  27 #include "generic/printergfx.hxx"
  28 #include "salbmp.hxx"
  29 #include "impfont.hxx"
  30 #include "outfont.hxx"
  31 #include "outdev.h"
  32 #include "fontsubset.hxx"
  33 #include "salprn.hxx"
  34 #include "region.h"
  35
  36 #include <unotools/fontdefs.hxx>
  37 #include <list>
  38
  39 // ===========================================================================
  40 // platform specific font substitution hooks
  41 // ===========================================================================
  42
  43 struct FontSelectPatternAttributesHash
  44 {
  45     size_t operator()(const FontSelectPatternAttributes& rAttributes) const
  46         { return rAttributes.hashCode(); }
  47 };
  48
  49 class FcPreMatchSubstititution
  50 :   public ImplPreMatchFontSubstitution
  51 {
  52 public:
  53     bool FindFontSubstitute( FontSelectPattern& ) const;
  54     typedef ::std::pair<FontSelectPatternAttributes, FontSelectPatternAttributes> value_type;
  55 private:
  56     typedef ::std::list<value_type> CachedFontMapType;
  57     mutable CachedFontMapType maCachedFontMap;
  58 };
  59
  60 class FcGlyphFallbackSubstititution
  61 :    public ImplGlyphFallbackFontSubstitution
  62 {
  63     // TODO: add a cache
  64 public:
  65     bool FindFontSubstitute( FontSelectPattern&, rtl::OUString& rMissingCodes ) const;
  66 };
  67
  68 int SalGenericInstance::FetchFontSubstitutionFlags()
  69 {
  70     // init font substitution defaults
  71     int nDisableBits = 0;
  72 #ifdef SOLARIS
  73     nDisableBits = 1; // disable "font fallback" here on default
  74 #endif
  75     // apply the environment variable if any
  76     const char* pEnvStr = ::getenv( "SAL_DISABLE_FC_SUBST" );
  77     if( pEnvStr )
  78     {
  79         if( (*pEnvStr >= '0') && (*pEnvStr <= '9') )
  80             nDisableBits = (*pEnvStr - '0');
  81         else
  82             nDisableBits = ~0U; // no specific bits set: disable all
  83     }
  84     return nDisableBits;
  85 }
  86
  87 void SalGenericInstance::RegisterFontSubstitutors( ImplDevFontList* pList )
  88 {
  89     // init font substitution defaults
  90     int nDisableBits = 0;
  91 #ifdef SOLARIS
  92     nDisableBits = 1; // disable "font fallback" here on default
  93 #endif
  94     // apply the environment variable if any
  95     const char* pEnvStr = ::getenv( "SAL_DISABLE_FC_SUBST" );
  96     if( pEnvStr )
  97     {
  98         if( (*pEnvStr >= '0') && (*pEnvStr <= '9') )
  99             nDisableBits = (*pEnvStr - '0');
 100         else
 101             nDisableBits = ~0U; // no specific bits set: disable all
 102     }
 103
 104     // register font fallback substitutions (unless disabled by bit0)
 105     if( (nDisableBits & 1) == 0 )
 106     {
 107         static FcPreMatchSubstititution aSubstPreMatch;
 108         pList->SetPreMatchHook( &aSubstPreMatch );
 109     }
 110
 111     // register glyph fallback substitutions (unless disabled by bit1)
 112     if( (nDisableBits & 2) == 0 )
 113     {
 114         static FcGlyphFallbackSubstititution aSubstFallback;
 115         pList->SetFallbackHook( &aSubstFallback );
 116     }
 117 }
 118
 119 // -----------------------------------------------------------------------
 120
 121 static FontSelectPattern GetFcSubstitute(const FontSelectPattern &rFontSelData, rtl::OUString& rMissingCodes )
 122 {
 123     FontSelectPattern aSubstituted(rFontSelData);
 124     psp::PrintFontManager& rMgr = psp::PrintFontManager::get();
 125     rMgr.Substitute(aSubstituted, rMissingCodes);
 126     return aSubstituted;
 127 }
 128
 129 namespace
 130 {
 131     bool uselessmatch(const FontSelectPattern &rOrig, const FontSelectPattern &rNew)
 132     {
 133         return
 134           (
 135             rOrig.maTargetName == rNew.maSearchName &&
 136             rOrig.meWeight == rNew.meWeight &&
 137             rOrig.meItalic == rNew.meItalic &&
 138             rOrig.mePitch == rNew.mePitch &&
 139             rOrig.meWidthType == rNew.meWidthType
 140           );
 141     }
 142
 143     class equal
 144     {
 145     private:
 146         const FontSelectPatternAttributes& mrAttributes;
 147     public:
 148         equal(const FontSelectPatternAttributes& rAttributes)
 149             : mrAttributes(rAttributes)
 150         {
 151         }
 152         bool operator()(const FcPreMatchSubstititution::value_type& rOther) const
 153             { return rOther.first == mrAttributes; }
 154     };
 155 }
 156
 157 //--------------------------------------------------------------------------
 158
 159 bool FcPreMatchSubstititution::FindFontSubstitute( FontSelectPattern &rFontSelData ) const
 160 {
 161     // We dont' actually want to talk to Fontconfig at all for symbol fonts
 162     if( rFontSelData.IsSymbolFont() )
 163         return false;
 164     // StarSymbol is a unicode font, but it still deserves the symbol flag
 165     if ( IsStarSymbol(rFontSelData.maSearchName) )
 166         return false;
 167
 168     //see fdo#41556 and fdo#47636
 169     //fontconfig can return e.g. an italic font for a non-italic input and/or
 170     //different fonts depending on fontsize, bold, etc settings so don't cache
 171     //just on the name, cache map all the input and all the output not just map
 172     //from original selection to output fontname
 173     FontSelectPatternAttributes& rPatternAttributes = rFontSelData;
 174     CachedFontMapType &rCachedFontMap = const_cast<CachedFontMapType &>(maCachedFontMap);
 175     CachedFontMapType::iterator itr = std::find_if(rCachedFontMap.begin(), rCachedFontMap.end(), equal(rPatternAttributes));
 176     if (itr != rCachedFontMap.end())
 177     {
 178         // Cached substitution
 179         rFontSelData.copyAttributes(itr->second);
 180         if (itr != rCachedFontMap.begin())
 181         {
 182             // MRU, move it to the front
 183             rCachedFontMap.splice(rCachedFontMap.begin(), rCachedFontMap, itr);
 184         }
 185         return true;
 186     }
 187
 188     rtl::OUString aDummy;
 189     const FontSelectPattern aOut = GetFcSubstitute( rFontSelData, aDummy );
 190
 191     if( !aOut.maSearchName.Len() )
 192         return false;
 193
 194     const bool bHaveSubstitute = !uselessmatch( rFontSelData, aOut );
 195
 196 #ifdef DEBUG
 197     const rtl::OString aOrigName(rtl::OUStringToOString(rFontSelData.maTargetName,
 198         RTL_TEXTENCODING_UTF8));
 199     const rtl::OString aSubstName(rtl::OUStringToOString(aOut.maSearchName,
 200         RTL_TEXTENCODING_UTF8));
 201     printf( "FcPreMatchSubstititution \"%s\" bipw=%d%d%d%d -> ",
 202         aOrigName.getStr(), rFontSelData.meWeight, rFontSelData.meItalic,
 203         rFontSelData.mePitch, rFontSelData.meWidthType );
 204     if( !bHaveSubstitute )
 205         printf( "no substitute available\n" );
 206     else
 207         printf( "\"%s\" bipw=%d%d%d%d\n", aSubstName.getStr(),
 208         aOut.meWeight, aOut.meItalic, aOut.mePitch, aOut.meWidthType );
 209 #endif
 210
 211     if( bHaveSubstitute )
 212     {
 213         rCachedFontMap.push_front(value_type(rFontSelData, aOut));
 214         //fairly arbitrary limit in this case, but I recall measuring max 8
 215         //fonts as the typical max amount of fonts in medium sized documents
 216         if (rCachedFontMap.size() > 8)
 217             rCachedFontMap.pop_back();
 218         rFontSelData = aOut;
 219     }
 220
 221     return bHaveSubstitute;
 222 }
 223
 224 // -----------------------------------------------------------------------
 225
 226 bool FcGlyphFallbackSubstititution::FindFontSubstitute( FontSelectPattern& rFontSelData,
 227     rtl::OUString& rMissingCodes ) const
 228 {
 229     // We dont' actually want to talk to Fontconfig at all for symbol fonts
 230     if( rFontSelData.IsSymbolFont() )
 231         return false;
 232     // StarSymbol is a unicode font, but it still deserves the symbol flag
 233     if ( IsStarSymbol(rFontSelData.maSearchName) )
 234         return false;
 235
 236     const FontSelectPattern aOut = GetFcSubstitute( rFontSelData, rMissingCodes );
 237     // TODO: cache the unicode + srcfont specific result
 238     // FC doing it would be preferable because it knows the invariables
 239     // e.g. FC knows the FC rule that all Arial gets replaced by LiberationSans
 240     // whereas we would have to check for every size or attribute
 241     if( !aOut.maSearchName.Len() )
 242         return false;
 243
 244     const bool bHaveSubstitute = !uselessmatch( rFontSelData, aOut );
 245
 246 #ifdef DEBUG
 247     const rtl::OString aOrigName(rtl::OUStringToOString(rFontSelData.maTargetName,
 248         RTL_TEXTENCODING_UTF8));
 249     const rtl::OString aSubstName(rtl::OUStringToOString(aOut.maSearchName,
 250         RTL_TEXTENCODING_UTF8));
 251     printf( "FcGFSubstititution \"%s\" bipw=%d%d%d%d ->",
 252         aOrigName.getStr(), rFontSelData.meWeight, rFontSelData.meItalic,
 253         rFontSelData.mePitch, rFontSelData.meWidthType );
 254     if( !bHaveSubstitute )
 255         printf( "no substitute available\n" );
 256     else
 257         printf( "\"%s\" bipw=%d%d%d%d\n", aSubstName.getStr(),
 258         aOut.meWeight, aOut.meItalic, aOut.mePitch, aOut.meWidthType );
 259 #endif
 260
 261     if( bHaveSubstitute )
 262         rFontSelData = aOut;
 263
 264     return bHaveSubstitute;
 265 }
 266
 267 // ===========================================================================
 268
 269
 270 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */