bump product version to 6.3.0.0.beta1
[LibreOffice.git] / include / unotools / fontcfg.hxx
blobd98d1308004028b714199873bbc72c580be7c919
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
19 #ifndef INCLUDED_UNOTOOLS_FONTCFG_HXX
20 #define INCLUDED_UNOTOOLS_FONTCFG_HXX
22 #include <unotools/unotoolsdllapi.h>
23 #include <tools/solar.h>
24 #include <tools/fontenum.hxx>
25 #include <com/sun/star/uno/Reference.hxx>
26 #include <o3tl/typed_flags_set.hxx>
28 #include <unordered_map>
29 #include <unordered_set>
30 #include <vector>
32 namespace com { namespace sun { namespace star { namespace container { class XNameAccess; } } } }
33 namespace com { namespace sun { namespace star { namespace lang { class XMultiServiceFactory; } } } }
35 class LanguageTag;
37 enum class DefaultFontType;
39 // If you think the below concept of classifying a font (typeface) as possibly being one or several
40 // of "Default", "Standard", and "Normal", etc, is madness, you are probably right. On the other
41 // hand we have in officecfg/registry/data/org/openoffice/VCL.xcu carefully (or not) assigned to
42 // each font mentioned in that file what its attributes are, so it is quite possible that touching
43 // this would cause a regression that nobody would notice until after many years.
45 // Note that the bit flags must match the entries in the pAttribNames array in
46 // unotools/source/config/fontcfg.cxx.
48 enum class ImplFontAttrs : sal_uLong
50 None = 0x00000000,
51 Default = 0x00000001, ///< Default-Font like Andale Sans UI, Palace Script, Albany, Thorndale, Cumberland, ...
52 Standard = 0x00000002, ///< Standard-Font like Arial, Times, Courier, ...
53 Normal = 0x00000004, ///< Normal Font for writing text like Arial, Verdana, Arial Narrow, Trebuchet, Times, Courier, ...
54 Symbol = 0x00000008, ///< Font with symbols
55 Fixed = 0x00000010,
56 SansSerif = 0x00000020,
57 Serif = 0x00000040,
58 Decorative = 0x00000080, ///< Readable and normally used for drawings
59 Special = 0x00000100, ///< Very special design
60 Italic = 0x00000200,
61 Titling = 0x00000400, ///< Only uppercase characters
62 Capitals = 0x00000800, ///< Only uppercase characters, but lowercase characters smaller as the uppercase characters
63 CJK = 0x00001000,
64 CJK_JP = 0x00002000,
65 CJK_SC = 0x00004000,
66 CJK_TC = 0x00008000,
67 CJK_KR = 0x00010000,
68 CTL = 0x00020000,
69 NoneLatin = 0x00040000,
70 Full = 0x00080000, ///< Font with normally all characters
71 Outline = 0x00100000,
72 Shadow = 0x00200000,
73 Rounded = 0x00400000,
74 Typewriter = 0x00800000, ///< Like a typewriter: Courier, ...
75 Script = 0x01000000, ///< Handwriting or Script
76 Handwriting = 0x02000000, ///< More Handwriting with normal letters
77 Chancery = 0x04000000, ///< Like Zapf Chancery
78 Comic = 0x08000000, ///< Like Comic Sans MS
79 BrushScript = 0x10000000, ///< More Script
80 Gothic = 0x20000000,
81 Schoolbook = 0x40000000,
82 OtherStyle = 0x80000000, ///< OldStyle, ... so negative points
83 CJK_AllLang = CJK_JP | CJK_SC | CJK_TC | CJK_KR,
84 AllScript = Script | Handwriting | Chancery | Comic | BrushScript,
85 AllSubscript = Handwriting | Chancery | Comic | BrushScript,
86 AllSerifStyle = AllScript | SansSerif | Serif | Fixed | Italic | Gothic | Schoolbook | Shadow | Outline,
88 namespace o3tl
90 template<> struct typed_flags<ImplFontAttrs> : is_typed_flags<ImplFontAttrs, 0xffffffff> {};
94 namespace utl
97 class UNOTOOLS_DLLPUBLIC DefaultFontConfiguration
99 css::uno::Reference< css::lang::XMultiServiceFactory >
100 m_xConfigProvider;
101 css::uno::Reference< css::container::XNameAccess >
102 m_xConfigAccess;
104 struct LocaleAccess
106 // the real string used in the configuration
107 // used to get rid of upper/lower case problems
108 OUString aConfigLocaleString;
109 // xAccess is mutable to be able to be filled on demand
110 mutable css::uno::Reference< css::container::XNameAccess > xAccess;
113 std::unordered_map< OUString, LocaleAccess > m_aConfig;
115 OUString tryLocale( const OUString& rBcp47, const OUString& rType ) const;
117 public:
118 DefaultFontConfiguration();
119 ~DefaultFontConfiguration();
121 static DefaultFontConfiguration& get();
123 OUString getDefaultFont( const LanguageTag& rLanguageTag, DefaultFontType nType ) const;
124 OUString getUserInterfaceFont( const LanguageTag& rLanguageTag ) const;
127 struct UNOTOOLS_DLLPUBLIC FontNameAttr
129 OUString Name;
130 ::std::vector< OUString > Substitutions;
131 ::std::vector< OUString > MSSubstitutions;
132 FontWeight Weight;
133 FontWidth Width;
134 ImplFontAttrs Type;
137 class UNOTOOLS_DLLPUBLIC FontSubstConfiguration
139 private:
140 css::uno::Reference< css::lang::XMultiServiceFactory >
141 m_xConfigProvider;
142 css::uno::Reference< css::container::XNameAccess >
143 m_xConfigAccess;
144 struct LocaleSubst
146 OUString aConfigLocaleString;
147 mutable bool bConfigRead;
148 // note: aSubstAttributes must be sorted alphabetically by Name
149 // searches on the substitutes are done with Name as key, where
150 // a minimal match is sufficient (that is e.g. "Thorndale" will match
151 // "Thorndale BlaBlub"). Also names must be lower case.
152 mutable std::vector< FontNameAttr > aSubstAttributes;
154 LocaleSubst() : bConfigRead( false ) {}
156 std::unordered_map< OUString, LocaleSubst > m_aSubst;
157 typedef std::unordered_set< OUString > UniqueSubstHash;
158 mutable UniqueSubstHash maSubstHash;
160 void fillSubstVector( const css::uno::Reference< css::container::XNameAccess >& rFont,
161 const OUString& rType,
162 std::vector< OUString >& rSubstVector ) const;
163 FontWeight getSubstWeight( const css::uno::Reference< css::container::XNameAccess >& rFont,
164 const OUString& rType ) const;
165 FontWidth getSubstWidth( const css::uno::Reference< css::container::XNameAccess >& rFont,
166 const OUString& rType ) const;
167 ImplFontAttrs getSubstType( const css::uno::Reference< css::container::XNameAccess >& rFont,
168 const OUString& rType ) const;
169 void readLocaleSubst( const OUString& rBcp47 ) const;
170 public:
171 FontSubstConfiguration();
172 ~FontSubstConfiguration();
174 static FontSubstConfiguration& get();
176 const FontNameAttr* getSubstInfo( const OUString& rFontName ) const;
177 static void getMapName( const OUString& rOrgName, OUString& rShortName, OUString& rFamilyName, FontWeight& rWeight, FontWidth& rWidth, ImplFontAttrs& rType );
180 } // namespace utl
182 #endif // INCLUDED_UNOTOOLS_FONTCFG_HXX
184 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */