font_render_params_linux_unittest.cc 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459
  1. // Copyright 2014 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "ui/gfx/font_render_params.h"
  5. #include <fontconfig/fontconfig.h>
  6. #include "base/check_op.h"
  7. #include "base/files/file_util.h"
  8. #include "base/files/scoped_temp_dir.h"
  9. #include "base/memory/raw_ptr.h"
  10. #include "base/notreached.h"
  11. #include "base/strings/stringprintf.h"
  12. #include "build/build_config.h"
  13. #include "build/chromeos_buildflags.h"
  14. #include "testing/gtest/include/gtest/gtest.h"
  15. #include "third_party/test_fonts/fontconfig/fontconfig_util_linux.h"
  16. #include "ui/gfx/font.h"
  17. #include "ui/gfx/linux/fontconfig_util.h"
  18. #include "ui/linux/fake_linux_ui.h"
  19. namespace gfx {
  20. namespace {
  21. // Strings appearing at the beginning and end of Fontconfig XML files.
  22. const char kFontconfigFileHeader[] =
  23. "<?xml version=\"1.0\"?>\n"
  24. "<!DOCTYPE fontconfig SYSTEM \"fonts.dtd\">\n"
  25. "<fontconfig>\n";
  26. const char kFontconfigFileFooter[] = "</fontconfig>";
  27. // Strings appearing at the beginning and end of Fontconfig <match> stanzas.
  28. const char kFontconfigMatchFontHeader[] = " <match target=\"font\">\n";
  29. const char kFontconfigMatchPatternHeader[] = " <match target=\"pattern\">\n";
  30. const char kFontconfigMatchFooter[] = " </match>\n";
  31. // Implementation of LinuxUi that returns a canned FontRenderParams
  32. // struct. This is used to isolate tests from the system's local configuration.
  33. class TestFontDelegate : public ui::FakeLinuxUi {
  34. public:
  35. TestFontDelegate() = default;
  36. TestFontDelegate(const TestFontDelegate&) = delete;
  37. TestFontDelegate& operator=(const TestFontDelegate&) = delete;
  38. ~TestFontDelegate() override = default;
  39. void set_params(const FontRenderParams& params) { params_ = params; }
  40. FontRenderParams GetDefaultFontRenderParams() const override {
  41. return params_;
  42. }
  43. void GetDefaultFontDescription(std::string* family_out,
  44. int* size_pixels_out,
  45. int* style_out,
  46. int* weight_out,
  47. FontRenderParams* params_out) const override {
  48. NOTIMPLEMENTED();
  49. }
  50. private:
  51. FontRenderParams params_;
  52. };
  53. // Loads XML-formatted |data| into the current font configuration.
  54. bool LoadConfigDataIntoFontconfig(const std::string& data) {
  55. FcConfig* config = GetGlobalFontConfig();
  56. constexpr FcBool kComplain = FcTrue;
  57. return FcConfigParseAndLoadFromMemory(
  58. config, reinterpret_cast<const FcChar8*>(data.c_str()), kComplain);
  59. }
  60. // Returns a Fontconfig <edit> stanza.
  61. std::string CreateFontconfigEditStanza(const std::string& name,
  62. const std::string& type,
  63. const std::string& value) {
  64. return base::StringPrintf(
  65. " <edit name=\"%s\" mode=\"assign\">\n"
  66. " <%s>%s</%s>\n"
  67. " </edit>\n",
  68. name.c_str(), type.c_str(), value.c_str(), type.c_str());
  69. }
  70. // Returns a Fontconfig <test> stanza.
  71. std::string CreateFontconfigTestStanza(const std::string& name,
  72. const std::string& op,
  73. const std::string& type,
  74. const std::string& value) {
  75. return base::StringPrintf(
  76. " <test name=\"%s\" compare=\"%s\" qual=\"any\">\n"
  77. " <%s>%s</%s>\n"
  78. " </test>\n",
  79. name.c_str(), op.c_str(), type.c_str(), value.c_str(), type.c_str());
  80. }
  81. // Returns a Fontconfig <alias> stanza.
  82. std::string CreateFontconfigAliasStanza(const std::string& original_family,
  83. const std::string& preferred_family) {
  84. return base::StringPrintf(
  85. " <alias>\n"
  86. " <family>%s</family>\n"
  87. " <prefer><family>%s</family></prefer>\n"
  88. " </alias>\n",
  89. original_family.c_str(), preferred_family.c_str());
  90. }
  91. } // namespace
  92. class FontRenderParamsTest : public testing::Test {
  93. public:
  94. FontRenderParamsTest() {
  95. auto test_font_delegate = std::make_unique<TestFontDelegate>();
  96. test_font_delegate_ = test_font_delegate.get();
  97. ui::LinuxUi::SetInstance(std::move(test_font_delegate));
  98. ClearFontRenderParamsCacheForTest();
  99. // Create a new fontconfig configuration and load the default fonts
  100. // configuration. The default test config file is produced in the build
  101. // folder under <build_dir>/etc/fonts/fonts.conf and the loaded tests fonts
  102. // are under <build_dir>/test_fonts.
  103. override_config_ = FcConfigCreate();
  104. FcBool parse_success =
  105. FcConfigParseAndLoad(override_config_, nullptr, FcTrue);
  106. DCHECK_NE(parse_success, FcFalse);
  107. FcBool load_success = FcConfigBuildFonts(override_config_);
  108. DCHECK_NE(load_success, FcFalse);
  109. original_config_ = GetGlobalFontConfig();
  110. OverrideGlobalFontConfigForTesting(override_config_);
  111. }
  112. FontRenderParamsTest(const FontRenderParamsTest&) = delete;
  113. FontRenderParamsTest& operator=(const FontRenderParamsTest&) = delete;
  114. ~FontRenderParamsTest() override {
  115. OverrideGlobalFontConfigForTesting(original_config_);
  116. FcConfigDestroy(override_config_);
  117. ui::LinuxUi::SetInstance(nullptr);
  118. test_font_delegate_ = nullptr;
  119. }
  120. protected:
  121. raw_ptr<TestFontDelegate> test_font_delegate_;
  122. raw_ptr<FcConfig> override_config_ = nullptr;
  123. raw_ptr<FcConfig> original_config_ = nullptr;
  124. };
  125. TEST_F(FontRenderParamsTest, Default) {
  126. ASSERT_TRUE(LoadConfigDataIntoFontconfig(
  127. std::string(kFontconfigFileHeader) +
  128. // Specify the desired defaults via a font match rather than a pattern
  129. // match (since this is the style generally used in
  130. // /etc/fonts/conf.d).
  131. kFontconfigMatchFontHeader +
  132. CreateFontconfigEditStanza("antialias", "bool", "true") +
  133. CreateFontconfigEditStanza("autohint", "bool", "true") +
  134. CreateFontconfigEditStanza("hinting", "bool", "true") +
  135. CreateFontconfigEditStanza("hintstyle", "const", "hintslight") +
  136. CreateFontconfigEditStanza("rgba", "const", "rgb") +
  137. kFontconfigMatchFooter +
  138. // Add a font match for Arimo. Since it specifies a family, it
  139. // shouldn't take effect when querying default settings.
  140. kFontconfigMatchFontHeader +
  141. CreateFontconfigTestStanza("family", "eq", "string", "Arimo") +
  142. CreateFontconfigEditStanza("antialias", "bool", "true") +
  143. CreateFontconfigEditStanza("autohint", "bool", "false") +
  144. CreateFontconfigEditStanza("hinting", "bool", "true") +
  145. CreateFontconfigEditStanza("hintstyle", "const", "hintfull") +
  146. CreateFontconfigEditStanza("rgba", "const", "none") +
  147. kFontconfigMatchFooter +
  148. // Add font matches for fonts between 10 and 20 points or pixels.
  149. // Since they specify sizes, they also should not affect the defaults.
  150. kFontconfigMatchFontHeader +
  151. CreateFontconfigTestStanza("size", "more_eq", "double", "10.0") +
  152. CreateFontconfigTestStanza("size", "less_eq", "double", "20.0") +
  153. CreateFontconfigEditStanza("antialias", "bool", "false") +
  154. kFontconfigMatchFooter + kFontconfigMatchFontHeader +
  155. CreateFontconfigTestStanza("pixel_size", "more_eq", "double", "10.0") +
  156. CreateFontconfigTestStanza("pixel_size", "less_eq", "double", "20.0") +
  157. CreateFontconfigEditStanza("antialias", "bool", "false") +
  158. kFontconfigMatchFooter + kFontconfigFileFooter));
  159. FontRenderParams params =
  160. GetFontRenderParams(FontRenderParamsQuery(), nullptr);
  161. EXPECT_TRUE(params.antialiasing);
  162. EXPECT_TRUE(params.autohinter);
  163. EXPECT_TRUE(params.use_bitmaps);
  164. EXPECT_EQ(FontRenderParams::HINTING_SLIGHT, params.hinting);
  165. EXPECT_FALSE(params.subpixel_positioning);
  166. EXPECT_EQ(FontRenderParams::SUBPIXEL_RENDERING_RGB,
  167. params.subpixel_rendering);
  168. }
  169. TEST_F(FontRenderParamsTest, Size) {
  170. ASSERT_TRUE(LoadConfigDataIntoFontconfig(
  171. std::string(kFontconfigFileHeader) + kFontconfigMatchPatternHeader +
  172. CreateFontconfigEditStanza("antialias", "bool", "true") +
  173. CreateFontconfigEditStanza("hinting", "bool", "true") +
  174. CreateFontconfigEditStanza("hintstyle", "const", "hintfull") +
  175. CreateFontconfigEditStanza("rgba", "const", "none") +
  176. kFontconfigMatchFooter + kFontconfigMatchPatternHeader +
  177. CreateFontconfigTestStanza("pixelsize", "less_eq", "double", "10") +
  178. CreateFontconfigEditStanza("antialias", "bool", "false") +
  179. kFontconfigMatchFooter + kFontconfigMatchPatternHeader +
  180. CreateFontconfigTestStanza("size", "more_eq", "double", "20") +
  181. CreateFontconfigEditStanza("hintstyle", "const", "hintslight") +
  182. CreateFontconfigEditStanza("rgba", "const", "rgb") +
  183. kFontconfigMatchFooter + kFontconfigFileFooter));
  184. // The defaults should be used when the supplied size isn't matched by the
  185. // second or third blocks.
  186. FontRenderParamsQuery query;
  187. query.pixel_size = 12;
  188. FontRenderParams params = GetFontRenderParams(query, nullptr);
  189. EXPECT_TRUE(params.antialiasing);
  190. EXPECT_EQ(FontRenderParams::HINTING_FULL, params.hinting);
  191. EXPECT_EQ(FontRenderParams::SUBPIXEL_RENDERING_NONE,
  192. params.subpixel_rendering);
  193. query.pixel_size = 10;
  194. params = GetFontRenderParams(query, nullptr);
  195. EXPECT_FALSE(params.antialiasing);
  196. EXPECT_EQ(FontRenderParams::HINTING_FULL, params.hinting);
  197. EXPECT_EQ(FontRenderParams::SUBPIXEL_RENDERING_NONE,
  198. params.subpixel_rendering);
  199. query.pixel_size = 0;
  200. query.point_size = 20;
  201. params = GetFontRenderParams(query, nullptr);
  202. EXPECT_TRUE(params.antialiasing);
  203. EXPECT_EQ(FontRenderParams::HINTING_SLIGHT, params.hinting);
  204. EXPECT_EQ(FontRenderParams::SUBPIXEL_RENDERING_RGB,
  205. params.subpixel_rendering);
  206. }
  207. TEST_F(FontRenderParamsTest, Style) {
  208. // Load a config that disables subpixel rendering for bold text and disables
  209. // hinting for italic text.
  210. ASSERT_TRUE(LoadConfigDataIntoFontconfig(
  211. std::string(kFontconfigFileHeader) + kFontconfigMatchPatternHeader +
  212. CreateFontconfigEditStanza("antialias", "bool", "true") +
  213. CreateFontconfigEditStanza("hinting", "bool", "true") +
  214. CreateFontconfigEditStanza("hintstyle", "const", "hintslight") +
  215. CreateFontconfigEditStanza("rgba", "const", "rgb") +
  216. kFontconfigMatchFooter + kFontconfigMatchPatternHeader +
  217. CreateFontconfigTestStanza("weight", "eq", "const", "bold") +
  218. CreateFontconfigEditStanza("rgba", "const", "none") +
  219. kFontconfigMatchFooter + kFontconfigMatchPatternHeader +
  220. CreateFontconfigTestStanza("slant", "eq", "const", "italic") +
  221. CreateFontconfigEditStanza("hinting", "bool", "false") +
  222. kFontconfigMatchFooter + kFontconfigFileFooter));
  223. FontRenderParamsQuery query;
  224. query.style = Font::NORMAL;
  225. FontRenderParams params = GetFontRenderParams(query, nullptr);
  226. EXPECT_EQ(FontRenderParams::HINTING_SLIGHT, params.hinting);
  227. EXPECT_EQ(FontRenderParams::SUBPIXEL_RENDERING_RGB,
  228. params.subpixel_rendering);
  229. query.weight = Font::Weight::BOLD;
  230. params = GetFontRenderParams(query, nullptr);
  231. EXPECT_EQ(FontRenderParams::HINTING_SLIGHT, params.hinting);
  232. EXPECT_EQ(FontRenderParams::SUBPIXEL_RENDERING_NONE,
  233. params.subpixel_rendering);
  234. query.weight = Font::Weight::NORMAL;
  235. query.style = Font::ITALIC;
  236. params = GetFontRenderParams(query, nullptr);
  237. EXPECT_EQ(FontRenderParams::HINTING_NONE, params.hinting);
  238. EXPECT_EQ(FontRenderParams::SUBPIXEL_RENDERING_RGB,
  239. params.subpixel_rendering);
  240. query.weight = Font::Weight::BOLD;
  241. query.style = Font::ITALIC;
  242. params = GetFontRenderParams(query, nullptr);
  243. EXPECT_EQ(FontRenderParams::HINTING_NONE, params.hinting);
  244. EXPECT_EQ(FontRenderParams::SUBPIXEL_RENDERING_NONE,
  245. params.subpixel_rendering);
  246. }
  247. TEST_F(FontRenderParamsTest, Scalable) {
  248. // Load a config that only enables antialiasing for scalable fonts.
  249. ASSERT_TRUE(LoadConfigDataIntoFontconfig(
  250. std::string(kFontconfigFileHeader) + kFontconfigMatchPatternHeader +
  251. CreateFontconfigEditStanza("antialias", "bool", "false") +
  252. kFontconfigMatchFooter + kFontconfigMatchPatternHeader +
  253. CreateFontconfigTestStanza("scalable", "eq", "bool", "true") +
  254. CreateFontconfigEditStanza("antialias", "bool", "true") +
  255. kFontconfigMatchFooter + kFontconfigFileFooter));
  256. // Check that we specifically ask how scalable fonts should be rendered.
  257. FontRenderParams params =
  258. GetFontRenderParams(FontRenderParamsQuery(), nullptr);
  259. EXPECT_TRUE(params.antialiasing);
  260. }
  261. TEST_F(FontRenderParamsTest, UseBitmaps) {
  262. // Load a config that enables embedded bitmaps for fonts <= 10 pixels.
  263. ASSERT_TRUE(LoadConfigDataIntoFontconfig(
  264. std::string(kFontconfigFileHeader) + kFontconfigMatchPatternHeader +
  265. CreateFontconfigEditStanza("embeddedbitmap", "bool", "false") +
  266. kFontconfigMatchFooter + kFontconfigMatchPatternHeader +
  267. CreateFontconfigTestStanza("pixelsize", "less_eq", "double", "10") +
  268. CreateFontconfigEditStanza("embeddedbitmap", "bool", "true") +
  269. kFontconfigMatchFooter + kFontconfigFileFooter));
  270. FontRenderParamsQuery query;
  271. FontRenderParams params = GetFontRenderParams(query, nullptr);
  272. EXPECT_FALSE(params.use_bitmaps);
  273. query.pixel_size = 5;
  274. params = GetFontRenderParams(query, nullptr);
  275. EXPECT_TRUE(params.use_bitmaps);
  276. }
  277. TEST_F(FontRenderParamsTest, ForceFullHintingWhenAntialiasingIsDisabled) {
  278. // Load a config that disables antialiasing and hinting while requesting
  279. // subpixel rendering.
  280. ASSERT_TRUE(LoadConfigDataIntoFontconfig(
  281. std::string(kFontconfigFileHeader) + kFontconfigMatchPatternHeader +
  282. CreateFontconfigEditStanza("antialias", "bool", "false") +
  283. CreateFontconfigEditStanza("hinting", "bool", "false") +
  284. CreateFontconfigEditStanza("hintstyle", "const", "hintnone") +
  285. CreateFontconfigEditStanza("rgba", "const", "rgb") +
  286. kFontconfigMatchFooter + kFontconfigFileFooter));
  287. // Full hinting should be forced. See the comment in GetFontRenderParams() for
  288. // more information.
  289. FontRenderParams params =
  290. GetFontRenderParams(FontRenderParamsQuery(), nullptr);
  291. EXPECT_FALSE(params.antialiasing);
  292. EXPECT_EQ(FontRenderParams::HINTING_FULL, params.hinting);
  293. EXPECT_EQ(FontRenderParams::SUBPIXEL_RENDERING_NONE,
  294. params.subpixel_rendering);
  295. EXPECT_FALSE(params.subpixel_positioning);
  296. }
  297. TEST_F(FontRenderParamsTest, ForceSubpixelPositioning) {
  298. {
  299. FontRenderParams params =
  300. GetFontRenderParams(FontRenderParamsQuery(), nullptr);
  301. EXPECT_TRUE(params.antialiasing);
  302. EXPECT_FALSE(params.subpixel_positioning);
  303. SetFontRenderParamsDeviceScaleFactor(1.0f);
  304. }
  305. ClearFontRenderParamsCacheForTest();
  306. SetFontRenderParamsDeviceScaleFactor(1.25f);
  307. // Subpixel positioning should be forced.
  308. {
  309. FontRenderParams params =
  310. GetFontRenderParams(FontRenderParamsQuery(), nullptr);
  311. EXPECT_TRUE(params.antialiasing);
  312. EXPECT_TRUE(params.subpixel_positioning);
  313. SetFontRenderParamsDeviceScaleFactor(1.0f);
  314. }
  315. ClearFontRenderParamsCacheForTest();
  316. SetFontRenderParamsDeviceScaleFactor(2.f);
  317. // Subpixel positioning should be forced on non-Chrome-OS.
  318. {
  319. FontRenderParams params =
  320. GetFontRenderParams(FontRenderParamsQuery(), nullptr);
  321. EXPECT_TRUE(params.antialiasing);
  322. #if !BUILDFLAG(IS_CHROMEOS_ASH)
  323. EXPECT_TRUE(params.subpixel_positioning);
  324. #else
  325. // Integral scale factor does not require subpixel positioning.
  326. EXPECT_FALSE(params.subpixel_positioning);
  327. #endif // !BUILDFLAG(IS_CHROMEOS_ASH)
  328. SetFontRenderParamsDeviceScaleFactor(1.0f);
  329. }
  330. }
  331. TEST_F(FontRenderParamsTest, OnlySetConfiguredValues) {
  332. // Configure the LinuxUi to request subpixel rendering.
  333. FontRenderParams system_params;
  334. system_params.subpixel_rendering = FontRenderParams::SUBPIXEL_RENDERING_RGB;
  335. test_font_delegate_->set_params(system_params);
  336. // Load a Fontconfig config that enables antialiasing but doesn't say anything
  337. // about subpixel rendering.
  338. ASSERT_TRUE(LoadConfigDataIntoFontconfig(
  339. std::string(kFontconfigFileHeader) + kFontconfigMatchPatternHeader +
  340. CreateFontconfigEditStanza("antialias", "bool", "true") +
  341. kFontconfigMatchFooter + kFontconfigFileFooter));
  342. // The subpixel rendering setting from the delegate should make it through.
  343. FontRenderParams params =
  344. GetFontRenderParams(FontRenderParamsQuery(), nullptr);
  345. EXPECT_EQ(system_params.subpixel_rendering, params.subpixel_rendering);
  346. }
  347. TEST_F(FontRenderParamsTest, NoFontconfigMatch) {
  348. // A default configuration was set up globally. Reset it to a blank config.
  349. FcConfig* blank = FcConfigCreate();
  350. OverrideGlobalFontConfigForTesting(blank);
  351. FontRenderParams system_params;
  352. system_params.antialiasing = true;
  353. system_params.hinting = FontRenderParams::HINTING_MEDIUM;
  354. system_params.subpixel_rendering = FontRenderParams::SUBPIXEL_RENDERING_RGB;
  355. test_font_delegate_->set_params(system_params);
  356. FontRenderParamsQuery query;
  357. query.families.push_back("Arimo");
  358. query.families.push_back("Times New Roman");
  359. query.pixel_size = 10;
  360. std::string suggested_family;
  361. FontRenderParams params = GetFontRenderParams(query, &suggested_family);
  362. // The system params and the first requested family should be returned.
  363. EXPECT_EQ(system_params.antialiasing, params.antialiasing);
  364. EXPECT_EQ(system_params.hinting, params.hinting);
  365. EXPECT_EQ(system_params.subpixel_rendering, params.subpixel_rendering);
  366. EXPECT_EQ(query.families[0], suggested_family);
  367. OverrideGlobalFontConfigForTesting(override_config_);
  368. FcConfigDestroy(blank);
  369. }
  370. TEST_F(FontRenderParamsTest, MissingFamily) {
  371. // With Arimo and Verdana installed, request (in order) Helvetica, Arimo, and
  372. // Verdana and check that Arimo is returned.
  373. FontRenderParamsQuery query;
  374. query.families.push_back("Helvetica");
  375. query.families.push_back("Arimo");
  376. query.families.push_back("Verdana");
  377. std::string suggested_family;
  378. GetFontRenderParams(query, &suggested_family);
  379. EXPECT_EQ("Arimo", suggested_family);
  380. }
  381. TEST_F(FontRenderParamsTest, SubstituteFamily) {
  382. // Configure Fontconfig to use Tinos for both Helvetica and Arimo.
  383. ASSERT_TRUE(LoadConfigDataIntoFontconfig(
  384. std::string(kFontconfigFileHeader) +
  385. CreateFontconfigAliasStanza("Helvetica", "Tinos") +
  386. kFontconfigMatchPatternHeader +
  387. CreateFontconfigTestStanza("family", "eq", "string", "Arimo") +
  388. CreateFontconfigEditStanza("family", "string", "Tinos") +
  389. kFontconfigMatchFooter + kFontconfigFileFooter));
  390. FontRenderParamsQuery query;
  391. query.families.push_back("Helvetica");
  392. std::string suggested_family;
  393. GetFontRenderParams(query, &suggested_family);
  394. EXPECT_EQ("Tinos", suggested_family);
  395. query.families.clear();
  396. query.families.push_back("Arimo");
  397. suggested_family.clear();
  398. GetFontRenderParams(query, &suggested_family);
  399. EXPECT_EQ("Tinos", suggested_family);
  400. }
  401. } // namespace gfx