vcl/inc/PhysicalFontCollection.hxx

   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_VCL_INC_PHYSICALFONTCOLLECTION_HXX
  21 #define INCLUDED_VCL_INC_PHYSICALFONTCOLLECTION_HXX
  22
  23 #include <vcl/dllapi.h>
  24
  25 #include "fontinstance.hxx"
  26 #include "PhysicalFontFamily.hxx"
  27 #include <array>
  28
  29 #define MAX_GLYPHFALLBACK 16
  30
  31 class ImplGlyphFallbackFontSubstitution;
  32 class ImplPreMatchFontSubstitution;
  33
  34
  35 // TODO: merge with ImplFontCache
  36 // TODO: rename to LogicalFontManager
  37
  38 class VCL_PLUGIN_PUBLIC PhysicalFontCollection final
  39 {
  40 public:
  41     explicit                PhysicalFontCollection();
  42                             ~PhysicalFontCollection();
  43
  44     // fill the list with device font faces
  45     void                    Add( PhysicalFontFace* );
  46     void                    Clear();
  47     int                     Count() const { return maPhysicalFontFamilies.size(); }
  48
  49     // find the device font family
  50     PhysicalFontFamily*     FindFontFamily( const OUString& rFontName ) const;
  51     PhysicalFontFamily*     FindOrCreateFontFamily( const OUString &rFamilyName );
  52     PhysicalFontFamily*     FindFontFamily( FontSelectPattern& ) const;
  53     PhysicalFontFamily*     FindFontFamilyByTokenNames(const OUString& rTokenStr) const;
  54     PhysicalFontFamily*     FindFontFamilyByAttributes(ImplFontAttrs nSearchType, FontWeight, FontWidth,
  55                                              FontItalic, const OUString& rSearchFamily) const;
  56
  57     // suggest fonts for glyph fallback
  58     PhysicalFontFamily*     GetGlyphFallbackFont( FontSelectPattern&,
  59                                                   OUString& rMissingCodes, int nFallbackLevel ) const;
  60
  61     // prepare platform specific font substitutions
  62     void                    SetPreMatchHook( ImplPreMatchFontSubstitution* );
  63     void                    SetFallbackHook( ImplGlyphFallbackFontSubstitution* );
  64
  65     // misc utilities
  66     PhysicalFontCollection* Clone() const;
  67     std::unique_ptr<ImplDeviceFontList> GetDeviceFontList() const;
  68     std::unique_ptr<ImplDeviceFontSizeList> GetDeviceFontSizeList( const OUString& rFontName ) const;
  69
  70 private:
  71     mutable bool            mbMatchData;    // true if matching attributes are initialized
  72
  73     typedef std::unordered_map<OUString, PhysicalFontFamily*> PhysicalFontFamilies;
  74     PhysicalFontFamilies    maPhysicalFontFamilies;
  75
  76     ImplPreMatchFontSubstitution* mpPreMatchHook;       // device specific prematch substitution
  77     ImplGlyphFallbackFontSubstitution* mpFallbackHook;  // device specific glyph fallback substitution
  78
  79     mutable std::unique_ptr<std::array<PhysicalFontFamily*,MAX_GLYPHFALLBACK>>  mpFallbackList;
  80     mutable int             mnFallbackCount;
  81
  82     void                    ImplInitMatchData() const;
  83     void                    ImplInitGenericGlyphFallback() const;
  84
  85     PhysicalFontFamily*     ImplFindFontFamilyBySearchName( const OUString& ) const;
  86     PhysicalFontFamily*     ImplFindFontFamilyBySubstFontAttr( const utl::FontNameAttr& ) const;
  87
  88     PhysicalFontFamily*     ImplFindFontFamilyOfDefaultFont() const;
  89
  90 };
  91
  92 #endif // INCLUDED_VCL_INC_PHYSICALFONTCOLLECTION_HXX
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */