2016-07-16 21:11:42 +01:00
|
|
|
/*
|
|
|
|
|
|
|
|
NixOS support 2 fontconfig versions, "support" and "latest".
|
|
|
|
|
|
|
|
- "latest" refers to default fontconfig package (pkgs.fontconfig).
|
|
|
|
configuration files are linked to /etc/fonts/VERSION/conf.d/
|
|
|
|
- "support" refers to supportPkg (pkgs."fontconfig_${supportVersion}").
|
|
|
|
configuration files are linked to /etc/fonts/conf.d/
|
|
|
|
|
|
|
|
This module generates a package containing configuration files and link it in /etc/fonts.
|
|
|
|
|
|
|
|
Fontconfig reads files in folder name / file name order, so the number prepended to the configuration file name decide the order of parsing.
|
|
|
|
Low number means high priority.
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
2014-04-14 15:26:48 +01:00
|
|
|
{ config, lib, pkgs, ... }:
|
2013-06-27 12:12:45 +01:00
|
|
|
|
2014-04-14 15:26:48 +01:00
|
|
|
with lib;
|
2013-06-27 12:12:45 +01:00
|
|
|
|
2016-07-16 21:11:42 +01:00
|
|
|
let cfg = config.fonts.fontconfig;
|
|
|
|
|
2017-04-11 17:08:51 +01:00
|
|
|
fcBool = x: "<bool>" + (boolToString x) + "</bool>";
|
2016-07-16 21:11:42 +01:00
|
|
|
|
|
|
|
# back-supported fontconfig version and package
|
|
|
|
# version is used for font cache generation
|
|
|
|
supportVersion = "210";
|
|
|
|
supportPkg = pkgs."fontconfig_${supportVersion}";
|
|
|
|
|
|
|
|
# latest fontconfig version and package
|
|
|
|
# version is used for configuration folder name, /etc/fonts/VERSION/
|
|
|
|
# note: format differs from supportVersion and can not be used with makeCacheConf
|
|
|
|
latestVersion = pkgs.fontconfig.configVersion;
|
|
|
|
latestPkg = pkgs.fontconfig;
|
|
|
|
|
|
|
|
# supported version fonts.conf
|
|
|
|
supportFontsConf = pkgs.makeFontsConf { fontconfig = supportPkg; fontDirectories = config.fonts.fonts; };
|
|
|
|
|
|
|
|
# configuration file to read fontconfig cache
|
|
|
|
# version dependent
|
|
|
|
# priority 0
|
|
|
|
cacheConfSupport = makeCacheConf { version = supportVersion; };
|
|
|
|
cacheConfLatest = makeCacheConf {};
|
2017-03-04 17:23:34 +00:00
|
|
|
|
2016-07-16 21:11:42 +01:00
|
|
|
# generate the font cache setting file for a fontconfig version
|
|
|
|
# use latest when no version is passed
|
|
|
|
makeCacheConf = { version ? null }:
|
2017-03-04 17:23:34 +00:00
|
|
|
let
|
2016-07-16 21:11:42 +01:00
|
|
|
fcPackage = if builtins.isNull version
|
|
|
|
then "fontconfig"
|
|
|
|
else "fontconfig_${version}";
|
|
|
|
makeCache = fontconfig: pkgs.makeFontsCache { inherit fontconfig; fontDirectories = config.fonts.fonts; };
|
|
|
|
cache = makeCache pkgs."${fcPackage}";
|
|
|
|
cache32 = makeCache pkgs.pkgsi686Linux."${fcPackage}";
|
|
|
|
in
|
|
|
|
pkgs.writeText "fc-00-nixos-cache.conf" ''
|
|
|
|
<?xml version='1.0'?>
|
|
|
|
<!DOCTYPE fontconfig SYSTEM 'fonts.dtd'>
|
|
|
|
<fontconfig>
|
|
|
|
<!-- Font directories -->
|
|
|
|
${concatStringsSep "\n" (map (font: "<dir>${font}</dir>") config.fonts.fonts)}
|
|
|
|
<!-- Pre-generated font caches -->
|
|
|
|
<cachedir>${cache}</cachedir>
|
|
|
|
${optionalString (pkgs.stdenv.isx86_64 && cfg.cache32Bit) ''
|
|
|
|
<cachedir>${cache32}</cachedir>
|
|
|
|
''}
|
|
|
|
</fontconfig>
|
|
|
|
'';
|
|
|
|
|
|
|
|
# rendering settings configuration file
|
|
|
|
# priority 10
|
|
|
|
renderConf = pkgs.writeText "fc-10-nixos-rendering.conf" ''
|
|
|
|
<?xml version='1.0'?>
|
|
|
|
<!DOCTYPE fontconfig SYSTEM 'fonts.dtd'>
|
|
|
|
<fontconfig>
|
|
|
|
|
|
|
|
<!-- Default rendering settings -->
|
2017-03-12 22:08:02 +00:00
|
|
|
<match target="pattern">
|
|
|
|
<edit mode="append" name="hinting">
|
2016-07-16 21:11:42 +01:00
|
|
|
${fcBool cfg.hinting.enable}
|
|
|
|
</edit>
|
2017-03-12 22:08:02 +00:00
|
|
|
<edit mode="append" name="autohint">
|
2016-07-16 21:11:42 +01:00
|
|
|
${fcBool cfg.hinting.autohint}
|
|
|
|
</edit>
|
2017-03-12 22:08:02 +00:00
|
|
|
<edit mode="append" name="hintstyle">
|
freetype: 2.6.5 -> 2.7.1
The Infinality bytecode interpreter is removed in favor of the new v40 TrueType
interpreter. In the past, the Infinality interpreter provided support for
ClearType-style hinting instructions while the default interpreter (then v35)
provided support only for original TrueType-style instructions. The v40
interpreter corrects this deficiency, so the Infinality interpreter is no longer
necessary.
To understand why the Infinality interpreter is no longer necessary, we should
understand how ClearType differs from TrueType and how the v40 interpreter
works. The following is a summary of information available on the FreeType
website [1] mixed with my own editorializing.
TrueType instructions use horizontal and vertical hints to improve glyph
rendering. Before TrueType, fonts were only vertically hinted; horizontal hints
improved rendering by snapping stems to pixel boundaries. Horizontal hinting is
a risk because it can significantly distort glyph shapes and kerning. Extensive
testing at different resolutions is needed to perfect the TrueType
hints. Microsoft invested significant effort to do this with its "Core fonts for
the Web" project, but few other typefaces have seen this level of attention.
With the advent of subpixel rendering, the effective horizontal resolution of
most displays increased significantly. ClearType eschews horizontal hinting in
favor of horizontal supersampling. Most fonts are designed for the Microsoft
bytecode interpreter, which implements a compatibility mode with
TrueType-style (horizontal and vertical) instructions. However, applying the
full horizontal hints to subpixel-rendered fonts leads to color fringes and
inconsistent stem widths. The Infinality interpreter implements several
techniques to mitigate these problems, going so far as to embed font- and
glyph-specific hacks in the interpreter. On the other hand, the v40 interpreter
ignores the horizontal hinting instructions so that glyphs render as they are
intended to on the Microsoft interpreter. Without the horizontal hints, the
problems of glyph and kerning distortion, color fringes, and inconsistent stem
widths--the problems the Infinality interpreter was created to solve--simply
don't occur in the first place.
There are also security concerns which motivate removing the Infinality patches.
Although there is an updated version of the Infinality interpreter for FreeType
2.7, the lack of a consistent upstream maintainer is a security concern. The
interpreter is a Turing-complete virtual machine which has had security
vulnerabilities in the past. While the default interpreter is used in billions
of devices and is maintained by an active developer, the Infinality interpreter
is neither scrutinized nor maintained. We will probably never know if there are
defects in the Infinality interpreter, and if they were discovered they would
likely never be fixed. I do not think that is an acceptable situtation for a
core library like FreeType.
Dropping the Infinality patches means that font rendering will be less
customizable. I think this is an acceptable trade-off. The Infinality
interpreter made many compromises to mitigate the problems with horizontal
hinting; the main purpose of customization is to tailor these compromises to the
user's preferences. The new interpreter does not have to make these compromises
because it renders fonts as their designers intended, so this level of
customization is not necessary.
The Infinality-associated patches are also removed from cairo. These patches
only set the default rendering options in case they aren't set though
Fontconfig. On NixOS, the rendering options are always set in Fontconfig, so
these patches never actually did anything for us!
The Fontconfig test suite is patched to account for a quirk in the way PCF fonts
are named.
The fontconfig option `hintstyle` is no longer configurable in NixOS. This
option selects the TrueType interpreter; the v40 interpreter is `hintslight` and
the older v35 interpreter is `hintmedium` or `hintfull` (which have actually
always been the same thing). The setting may still be changed through the
`localConf` option or by creating a user Fontconfig file.
Users with HiDPI displays should probably disable hinting and antialiasing: at
best they have no visible effect.
The fontconfig-ultimate settings are still available in NixOS, but they are no
longer the default. They still work, but their main purpose is to set rendering
quirks which are no longer necessary and may actually be
detrimental (e.g. setting `hintfull` for some fonts). Also, the vast array of
font substitutions provided is not an appropriate default; the default setting
should be to give the user the font they asked for.
[1]. https://www.freetype.org/freetype2/docs/subpixel-hinting.html
2017-03-05 23:39:38 +00:00
|
|
|
<const>hintslight</const>
|
2016-07-16 21:11:42 +01:00
|
|
|
</edit>
|
2017-03-12 22:08:02 +00:00
|
|
|
<edit mode="append" name="antialias">
|
2016-07-16 21:11:42 +01:00
|
|
|
${fcBool cfg.antialias}
|
|
|
|
</edit>
|
2017-03-12 22:08:02 +00:00
|
|
|
<edit mode="append" name="rgba">
|
2016-07-16 21:11:42 +01:00
|
|
|
<const>${cfg.subpixel.rgba}</const>
|
|
|
|
</edit>
|
2017-03-12 22:08:02 +00:00
|
|
|
<edit mode="append" name="lcdfilter">
|
2016-07-16 21:11:42 +01:00
|
|
|
<const>lcd${cfg.subpixel.lcdfilter}</const>
|
|
|
|
</edit>
|
|
|
|
</match>
|
|
|
|
|
|
|
|
${optionalString (cfg.dpi != 0) ''
|
|
|
|
<match target="pattern">
|
|
|
|
<edit name="dpi" mode="assign">
|
|
|
|
<double>${toString cfg.dpi}</double>
|
|
|
|
</edit>
|
|
|
|
</match>
|
|
|
|
''}
|
|
|
|
|
|
|
|
</fontconfig>
|
|
|
|
'';
|
|
|
|
|
2016-08-11 00:45:43 +01:00
|
|
|
# local configuration file
|
|
|
|
# priority 51
|
|
|
|
localConf = pkgs.writeText "fc-local.conf" cfg.localConf;
|
|
|
|
|
|
|
|
# default fonts configuration file
|
|
|
|
# priority 52
|
2017-03-04 17:23:34 +00:00
|
|
|
defaultFontsConf =
|
2016-07-16 21:11:42 +01:00
|
|
|
let genDefault = fonts: name:
|
|
|
|
optionalString (fonts != []) ''
|
|
|
|
<alias>
|
|
|
|
<family>${name}</family>
|
|
|
|
<prefer>
|
|
|
|
${concatStringsSep ""
|
|
|
|
(map (font: ''
|
|
|
|
<family>${font}</family>
|
|
|
|
'') fonts)}
|
|
|
|
</prefer>
|
|
|
|
</alias>
|
|
|
|
'';
|
|
|
|
in
|
2016-08-11 00:45:43 +01:00
|
|
|
pkgs.writeText "fc-52-nixos-default-fonts.conf" ''
|
2016-07-16 21:11:42 +01:00
|
|
|
<?xml version='1.0'?>
|
|
|
|
<!DOCTYPE fontconfig SYSTEM 'fonts.dtd'>
|
|
|
|
<fontconfig>
|
|
|
|
|
|
|
|
<!-- Default fonts -->
|
|
|
|
${genDefault cfg.defaultFonts.sansSerif "sans-serif"}
|
|
|
|
|
|
|
|
${genDefault cfg.defaultFonts.serif "serif"}
|
|
|
|
|
|
|
|
${genDefault cfg.defaultFonts.monospace "monospace"}
|
|
|
|
|
|
|
|
</fontconfig>
|
|
|
|
'';
|
|
|
|
|
2017-03-04 17:23:34 +00:00
|
|
|
# bitmap font options
|
|
|
|
# priority 53
|
|
|
|
rejectBitmaps = pkgs.writeText "fc-53-nixos-bitmaps.conf" ''
|
|
|
|
<?xml version="1.0"?>
|
|
|
|
<!DOCTYPE fontconfig SYSTEM "fonts.dtd">
|
|
|
|
<fontconfig>
|
|
|
|
|
|
|
|
${optionalString (!cfg.allowBitmaps) ''
|
|
|
|
<!-- Reject bitmap fonts -->
|
|
|
|
<selectfont>
|
|
|
|
<rejectfont>
|
|
|
|
<pattern>
|
|
|
|
<patelt name="scalable"><bool>false</bool></patelt>
|
|
|
|
</pattern>
|
|
|
|
</rejectfont>
|
|
|
|
</selectfont>
|
|
|
|
''}
|
|
|
|
|
|
|
|
<!-- Use embedded bitmaps in fonts like Calibri? -->
|
|
|
|
<match target="font">
|
|
|
|
<edit name="embeddedbitmap" mode="assign">
|
|
|
|
${fcBool cfg.useEmbeddedBitmaps}
|
|
|
|
</edit>
|
|
|
|
</match>
|
|
|
|
|
|
|
|
</fontconfig>
|
|
|
|
'';
|
|
|
|
|
|
|
|
# reject Type 1 fonts
|
|
|
|
# priority 53
|
|
|
|
rejectType1 = pkgs.writeText "fc-53-nixos-reject-type1.conf" ''
|
|
|
|
<?xml version="1.0"?>
|
|
|
|
<!DOCTYPE fontconfig SYSTEM "fonts.dtd">
|
|
|
|
<fontconfig>
|
|
|
|
|
|
|
|
<!-- Reject Type 1 fonts -->
|
|
|
|
<selectfont>
|
|
|
|
<rejectfont>
|
|
|
|
<pattern>
|
|
|
|
<patelt name="fontformat"><string>Type 1</string></patelt>
|
|
|
|
</pattern>
|
|
|
|
</rejectfont>
|
|
|
|
</selectfont>
|
|
|
|
|
|
|
|
</fontconfig>
|
|
|
|
'';
|
|
|
|
|
|
|
|
# fontconfig configuration package
|
2018-11-08 10:59:03 +00:00
|
|
|
confPkg = pkgs.runCommand "fontconfig-conf" { preferLocalBuild = true; } ''
|
2016-07-16 21:11:42 +01:00
|
|
|
support_folder=$out/etc/fonts
|
|
|
|
latest_folder=$out/etc/fonts/${latestVersion}
|
|
|
|
|
|
|
|
mkdir -p $support_folder/conf.d
|
|
|
|
mkdir -p $latest_folder/conf.d
|
|
|
|
|
|
|
|
# fonts.conf
|
|
|
|
ln -s ${supportFontsConf} $support_folder/fonts.conf
|
|
|
|
ln -s ${latestPkg.out}/etc/fonts/fonts.conf \
|
|
|
|
$latest_folder/fonts.conf
|
|
|
|
|
|
|
|
# fontconfig default config files
|
|
|
|
ln -s ${supportPkg.out}/etc/fonts/conf.d/*.conf \
|
|
|
|
$support_folder/conf.d/
|
|
|
|
ln -s ${latestPkg.out}/etc/fonts/conf.d/*.conf \
|
|
|
|
$latest_folder/conf.d/
|
|
|
|
|
2016-08-11 00:45:43 +01:00
|
|
|
# update latest 51-local.conf path to look at the latest local.conf
|
|
|
|
rm $latest_folder/conf.d/51-local.conf
|
|
|
|
|
|
|
|
substitute ${latestPkg.out}/etc/fonts/conf.d/51-local.conf \
|
|
|
|
$latest_folder/conf.d/51-local.conf \
|
2017-03-04 17:23:34 +00:00
|
|
|
--replace local.conf /etc/fonts/${latestVersion}/local.conf
|
2016-08-11 00:45:43 +01:00
|
|
|
|
2016-07-16 21:11:42 +01:00
|
|
|
# 00-nixos-cache.conf
|
|
|
|
ln -s ${cacheConfSupport} \
|
|
|
|
$support_folder/conf.d/00-nixos-cache.conf
|
|
|
|
ln -s ${cacheConfLatest} $latest_folder/conf.d/00-nixos-cache.conf
|
|
|
|
|
|
|
|
# 10-nixos-rendering.conf
|
|
|
|
ln -s ${renderConf} $support_folder/conf.d/10-nixos-rendering.conf
|
|
|
|
ln -s ${renderConf} $latest_folder/conf.d/10-nixos-rendering.conf
|
|
|
|
|
2016-08-11 00:45:43 +01:00
|
|
|
# 50-user.conf
|
|
|
|
${optionalString (! cfg.includeUserConf) ''
|
|
|
|
rm $support_folder/conf.d/50-user.conf
|
|
|
|
rm $latest_folder/conf.d/50-user.conf
|
|
|
|
''}
|
2016-07-16 21:11:42 +01:00
|
|
|
|
2016-08-11 00:45:43 +01:00
|
|
|
# local.conf (indirect priority 51)
|
|
|
|
${optionalString (cfg.localConf != "") ''
|
|
|
|
ln -s ${localConf} $support_folder/local.conf
|
|
|
|
ln -s ${localConf} $latest_folder/local.conf
|
2016-07-16 21:11:42 +01:00
|
|
|
''}
|
2016-08-11 00:45:43 +01:00
|
|
|
|
|
|
|
# 52-nixos-default-fonts.conf
|
|
|
|
ln -s ${defaultFontsConf} $support_folder/conf.d/52-nixos-default-fonts.conf
|
|
|
|
ln -s ${defaultFontsConf} $latest_folder/conf.d/52-nixos-default-fonts.conf
|
2017-03-04 17:23:34 +00:00
|
|
|
|
|
|
|
# 53-nixos-bitmaps.conf
|
|
|
|
ln -s ${rejectBitmaps} $support_folder/conf.d/53-nixos-bitmaps.conf
|
|
|
|
ln -s ${rejectBitmaps} $latest_folder/conf.d/53-nixos-bitmaps.conf
|
|
|
|
|
|
|
|
${optionalString (! cfg.allowType1) ''
|
|
|
|
# 53-nixos-reject-type1.conf
|
|
|
|
ln -s ${rejectType1} $support_folder/conf.d/53-nixos-reject-type1.conf
|
|
|
|
ln -s ${rejectType1} $latest_folder/conf.d/53-nixos-reject-type1.conf
|
|
|
|
''}
|
2016-07-16 21:11:42 +01:00
|
|
|
'';
|
|
|
|
|
|
|
|
# Package with configuration files
|
|
|
|
# this merge all the packages in the fonts.fontconfig.confPackages list
|
|
|
|
fontconfigEtc = pkgs.buildEnv {
|
|
|
|
name = "fontconfig-etc";
|
|
|
|
paths = cfg.confPackages;
|
|
|
|
ignoreCollisions = true;
|
|
|
|
};
|
|
|
|
in
|
2013-06-27 12:12:45 +01:00
|
|
|
{
|
|
|
|
|
|
|
|
options = {
|
|
|
|
|
|
|
|
fonts = {
|
|
|
|
|
2014-11-30 19:36:49 +00:00
|
|
|
fontconfig = {
|
|
|
|
enable = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = true;
|
|
|
|
description = ''
|
|
|
|
If enabled, a Fontconfig configuration file will be built
|
|
|
|
pointing to a set of default fonts. If you don't care about
|
|
|
|
running X11 applications or any other program that uses
|
|
|
|
Fontconfig, you can turn this option off and prevent a
|
|
|
|
dependency on all those fonts.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2016-07-16 21:11:42 +01:00
|
|
|
confPackages = mkOption {
|
|
|
|
internal = true;
|
|
|
|
type = with types; listOf path;
|
|
|
|
default = [ ];
|
|
|
|
description = ''
|
|
|
|
Fontconfig configuration packages.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2014-11-30 19:36:49 +00:00
|
|
|
antialias = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = true;
|
freetype: 2.6.5 -> 2.7.1
The Infinality bytecode interpreter is removed in favor of the new v40 TrueType
interpreter. In the past, the Infinality interpreter provided support for
ClearType-style hinting instructions while the default interpreter (then v35)
provided support only for original TrueType-style instructions. The v40
interpreter corrects this deficiency, so the Infinality interpreter is no longer
necessary.
To understand why the Infinality interpreter is no longer necessary, we should
understand how ClearType differs from TrueType and how the v40 interpreter
works. The following is a summary of information available on the FreeType
website [1] mixed with my own editorializing.
TrueType instructions use horizontal and vertical hints to improve glyph
rendering. Before TrueType, fonts were only vertically hinted; horizontal hints
improved rendering by snapping stems to pixel boundaries. Horizontal hinting is
a risk because it can significantly distort glyph shapes and kerning. Extensive
testing at different resolutions is needed to perfect the TrueType
hints. Microsoft invested significant effort to do this with its "Core fonts for
the Web" project, but few other typefaces have seen this level of attention.
With the advent of subpixel rendering, the effective horizontal resolution of
most displays increased significantly. ClearType eschews horizontal hinting in
favor of horizontal supersampling. Most fonts are designed for the Microsoft
bytecode interpreter, which implements a compatibility mode with
TrueType-style (horizontal and vertical) instructions. However, applying the
full horizontal hints to subpixel-rendered fonts leads to color fringes and
inconsistent stem widths. The Infinality interpreter implements several
techniques to mitigate these problems, going so far as to embed font- and
glyph-specific hacks in the interpreter. On the other hand, the v40 interpreter
ignores the horizontal hinting instructions so that glyphs render as they are
intended to on the Microsoft interpreter. Without the horizontal hints, the
problems of glyph and kerning distortion, color fringes, and inconsistent stem
widths--the problems the Infinality interpreter was created to solve--simply
don't occur in the first place.
There are also security concerns which motivate removing the Infinality patches.
Although there is an updated version of the Infinality interpreter for FreeType
2.7, the lack of a consistent upstream maintainer is a security concern. The
interpreter is a Turing-complete virtual machine which has had security
vulnerabilities in the past. While the default interpreter is used in billions
of devices and is maintained by an active developer, the Infinality interpreter
is neither scrutinized nor maintained. We will probably never know if there are
defects in the Infinality interpreter, and if they were discovered they would
likely never be fixed. I do not think that is an acceptable situtation for a
core library like FreeType.
Dropping the Infinality patches means that font rendering will be less
customizable. I think this is an acceptable trade-off. The Infinality
interpreter made many compromises to mitigate the problems with horizontal
hinting; the main purpose of customization is to tailor these compromises to the
user's preferences. The new interpreter does not have to make these compromises
because it renders fonts as their designers intended, so this level of
customization is not necessary.
The Infinality-associated patches are also removed from cairo. These patches
only set the default rendering options in case they aren't set though
Fontconfig. On NixOS, the rendering options are always set in Fontconfig, so
these patches never actually did anything for us!
The Fontconfig test suite is patched to account for a quirk in the way PCF fonts
are named.
The fontconfig option `hintstyle` is no longer configurable in NixOS. This
option selects the TrueType interpreter; the v40 interpreter is `hintslight` and
the older v35 interpreter is `hintmedium` or `hintfull` (which have actually
always been the same thing). The setting may still be changed through the
`localConf` option or by creating a user Fontconfig file.
Users with HiDPI displays should probably disable hinting and antialiasing: at
best they have no visible effect.
The fontconfig-ultimate settings are still available in NixOS, but they are no
longer the default. They still work, but their main purpose is to set rendering
quirks which are no longer necessary and may actually be
detrimental (e.g. setting `hintfull` for some fonts). Also, the vast array of
font substitutions provided is not an appropriate default; the default setting
should be to give the user the font they asked for.
[1]. https://www.freetype.org/freetype2/docs/subpixel-hinting.html
2017-03-05 23:39:38 +00:00
|
|
|
description = ''
|
|
|
|
Enable font antialiasing. At high resolution (> 200 DPI),
|
|
|
|
antialiasing has no visible effect; users of such displays may want
|
|
|
|
to disable this option.
|
|
|
|
'';
|
2014-11-30 19:36:49 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
dpi = mkOption {
|
|
|
|
type = types.int;
|
|
|
|
default = 0;
|
|
|
|
description = ''
|
|
|
|
Force DPI setting. Setting to <literal>0</literal> disables DPI
|
|
|
|
forcing; the DPI detected for the display will be used.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2016-08-11 00:45:43 +01:00
|
|
|
localConf = mkOption {
|
|
|
|
type = types.lines;
|
|
|
|
default = "";
|
|
|
|
description = ''
|
freetype: 2.6.5 -> 2.7.1
The Infinality bytecode interpreter is removed in favor of the new v40 TrueType
interpreter. In the past, the Infinality interpreter provided support for
ClearType-style hinting instructions while the default interpreter (then v35)
provided support only for original TrueType-style instructions. The v40
interpreter corrects this deficiency, so the Infinality interpreter is no longer
necessary.
To understand why the Infinality interpreter is no longer necessary, we should
understand how ClearType differs from TrueType and how the v40 interpreter
works. The following is a summary of information available on the FreeType
website [1] mixed with my own editorializing.
TrueType instructions use horizontal and vertical hints to improve glyph
rendering. Before TrueType, fonts were only vertically hinted; horizontal hints
improved rendering by snapping stems to pixel boundaries. Horizontal hinting is
a risk because it can significantly distort glyph shapes and kerning. Extensive
testing at different resolutions is needed to perfect the TrueType
hints. Microsoft invested significant effort to do this with its "Core fonts for
the Web" project, but few other typefaces have seen this level of attention.
With the advent of subpixel rendering, the effective horizontal resolution of
most displays increased significantly. ClearType eschews horizontal hinting in
favor of horizontal supersampling. Most fonts are designed for the Microsoft
bytecode interpreter, which implements a compatibility mode with
TrueType-style (horizontal and vertical) instructions. However, applying the
full horizontal hints to subpixel-rendered fonts leads to color fringes and
inconsistent stem widths. The Infinality interpreter implements several
techniques to mitigate these problems, going so far as to embed font- and
glyph-specific hacks in the interpreter. On the other hand, the v40 interpreter
ignores the horizontal hinting instructions so that glyphs render as they are
intended to on the Microsoft interpreter. Without the horizontal hints, the
problems of glyph and kerning distortion, color fringes, and inconsistent stem
widths--the problems the Infinality interpreter was created to solve--simply
don't occur in the first place.
There are also security concerns which motivate removing the Infinality patches.
Although there is an updated version of the Infinality interpreter for FreeType
2.7, the lack of a consistent upstream maintainer is a security concern. The
interpreter is a Turing-complete virtual machine which has had security
vulnerabilities in the past. While the default interpreter is used in billions
of devices and is maintained by an active developer, the Infinality interpreter
is neither scrutinized nor maintained. We will probably never know if there are
defects in the Infinality interpreter, and if they were discovered they would
likely never be fixed. I do not think that is an acceptable situtation for a
core library like FreeType.
Dropping the Infinality patches means that font rendering will be less
customizable. I think this is an acceptable trade-off. The Infinality
interpreter made many compromises to mitigate the problems with horizontal
hinting; the main purpose of customization is to tailor these compromises to the
user's preferences. The new interpreter does not have to make these compromises
because it renders fonts as their designers intended, so this level of
customization is not necessary.
The Infinality-associated patches are also removed from cairo. These patches
only set the default rendering options in case they aren't set though
Fontconfig. On NixOS, the rendering options are always set in Fontconfig, so
these patches never actually did anything for us!
The Fontconfig test suite is patched to account for a quirk in the way PCF fonts
are named.
The fontconfig option `hintstyle` is no longer configurable in NixOS. This
option selects the TrueType interpreter; the v40 interpreter is `hintslight` and
the older v35 interpreter is `hintmedium` or `hintfull` (which have actually
always been the same thing). The setting may still be changed through the
`localConf` option or by creating a user Fontconfig file.
Users with HiDPI displays should probably disable hinting and antialiasing: at
best they have no visible effect.
The fontconfig-ultimate settings are still available in NixOS, but they are no
longer the default. They still work, but their main purpose is to set rendering
quirks which are no longer necessary and may actually be
detrimental (e.g. setting `hintfull` for some fonts). Also, the vast array of
font substitutions provided is not an appropriate default; the default setting
should be to give the user the font they asked for.
[1]. https://www.freetype.org/freetype2/docs/subpixel-hinting.html
2017-03-05 23:39:38 +00:00
|
|
|
System-wide customization file contents, has higher priority than
|
2016-08-11 00:45:43 +01:00
|
|
|
<literal>defaultFonts</literal> settings.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2014-11-30 19:36:49 +00:00
|
|
|
defaultFonts = {
|
|
|
|
monospace = mkOption {
|
2014-12-05 16:30:10 +00:00
|
|
|
type = types.listOf types.str;
|
|
|
|
default = ["DejaVu Sans Mono"];
|
2014-11-30 19:36:49 +00:00
|
|
|
description = ''
|
2014-12-05 16:30:10 +00:00
|
|
|
System-wide default monospace font(s). Multiple fonts may be
|
|
|
|
listed in case multiple languages must be supported.
|
2014-11-30 19:36:49 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
sansSerif = mkOption {
|
2014-12-05 16:30:10 +00:00
|
|
|
type = types.listOf types.str;
|
|
|
|
default = ["DejaVu Sans"];
|
2014-11-30 19:36:49 +00:00
|
|
|
description = ''
|
2014-12-05 16:30:10 +00:00
|
|
|
System-wide default sans serif font(s). Multiple fonts may be
|
|
|
|
listed in case multiple languages must be supported.
|
2014-11-30 19:36:49 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
serif = mkOption {
|
2014-12-05 16:30:10 +00:00
|
|
|
type = types.listOf types.str;
|
|
|
|
default = ["DejaVu Serif"];
|
2014-11-30 19:36:49 +00:00
|
|
|
description = ''
|
2014-12-05 16:30:10 +00:00
|
|
|
System-wide default serif font(s). Multiple fonts may be listed
|
|
|
|
in case multiple languages must be supported.
|
2014-11-30 19:36:49 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
hinting = {
|
|
|
|
enable = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = true;
|
freetype: 2.6.5 -> 2.7.1
The Infinality bytecode interpreter is removed in favor of the new v40 TrueType
interpreter. In the past, the Infinality interpreter provided support for
ClearType-style hinting instructions while the default interpreter (then v35)
provided support only for original TrueType-style instructions. The v40
interpreter corrects this deficiency, so the Infinality interpreter is no longer
necessary.
To understand why the Infinality interpreter is no longer necessary, we should
understand how ClearType differs from TrueType and how the v40 interpreter
works. The following is a summary of information available on the FreeType
website [1] mixed with my own editorializing.
TrueType instructions use horizontal and vertical hints to improve glyph
rendering. Before TrueType, fonts were only vertically hinted; horizontal hints
improved rendering by snapping stems to pixel boundaries. Horizontal hinting is
a risk because it can significantly distort glyph shapes and kerning. Extensive
testing at different resolutions is needed to perfect the TrueType
hints. Microsoft invested significant effort to do this with its "Core fonts for
the Web" project, but few other typefaces have seen this level of attention.
With the advent of subpixel rendering, the effective horizontal resolution of
most displays increased significantly. ClearType eschews horizontal hinting in
favor of horizontal supersampling. Most fonts are designed for the Microsoft
bytecode interpreter, which implements a compatibility mode with
TrueType-style (horizontal and vertical) instructions. However, applying the
full horizontal hints to subpixel-rendered fonts leads to color fringes and
inconsistent stem widths. The Infinality interpreter implements several
techniques to mitigate these problems, going so far as to embed font- and
glyph-specific hacks in the interpreter. On the other hand, the v40 interpreter
ignores the horizontal hinting instructions so that glyphs render as they are
intended to on the Microsoft interpreter. Without the horizontal hints, the
problems of glyph and kerning distortion, color fringes, and inconsistent stem
widths--the problems the Infinality interpreter was created to solve--simply
don't occur in the first place.
There are also security concerns which motivate removing the Infinality patches.
Although there is an updated version of the Infinality interpreter for FreeType
2.7, the lack of a consistent upstream maintainer is a security concern. The
interpreter is a Turing-complete virtual machine which has had security
vulnerabilities in the past. While the default interpreter is used in billions
of devices and is maintained by an active developer, the Infinality interpreter
is neither scrutinized nor maintained. We will probably never know if there are
defects in the Infinality interpreter, and if they were discovered they would
likely never be fixed. I do not think that is an acceptable situtation for a
core library like FreeType.
Dropping the Infinality patches means that font rendering will be less
customizable. I think this is an acceptable trade-off. The Infinality
interpreter made many compromises to mitigate the problems with horizontal
hinting; the main purpose of customization is to tailor these compromises to the
user's preferences. The new interpreter does not have to make these compromises
because it renders fonts as their designers intended, so this level of
customization is not necessary.
The Infinality-associated patches are also removed from cairo. These patches
only set the default rendering options in case they aren't set though
Fontconfig. On NixOS, the rendering options are always set in Fontconfig, so
these patches never actually did anything for us!
The Fontconfig test suite is patched to account for a quirk in the way PCF fonts
are named.
The fontconfig option `hintstyle` is no longer configurable in NixOS. This
option selects the TrueType interpreter; the v40 interpreter is `hintslight` and
the older v35 interpreter is `hintmedium` or `hintfull` (which have actually
always been the same thing). The setting may still be changed through the
`localConf` option or by creating a user Fontconfig file.
Users with HiDPI displays should probably disable hinting and antialiasing: at
best they have no visible effect.
The fontconfig-ultimate settings are still available in NixOS, but they are no
longer the default. They still work, but their main purpose is to set rendering
quirks which are no longer necessary and may actually be
detrimental (e.g. setting `hintfull` for some fonts). Also, the vast array of
font substitutions provided is not an appropriate default; the default setting
should be to give the user the font they asked for.
[1]. https://www.freetype.org/freetype2/docs/subpixel-hinting.html
2017-03-05 23:39:38 +00:00
|
|
|
description = ''
|
|
|
|
Enable font hinting. Hinting aligns glyphs to pixel boundaries to
|
|
|
|
improve rendering sharpness at low resolution. At high resolution
|
|
|
|
(> 200 dpi) hinting will do nothing (at best); users of such
|
|
|
|
displays may want to disable this option.
|
|
|
|
'';
|
2014-11-30 19:36:49 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
autohint = mkOption {
|
|
|
|
type = types.bool;
|
2017-04-03 14:22:03 +01:00
|
|
|
default = false;
|
2014-11-30 19:36:49 +00:00
|
|
|
description = ''
|
2017-04-03 14:22:03 +01:00
|
|
|
Enable the autohinter in place of the default interpreter.
|
|
|
|
The results are usually lower quality than correctly-hinted
|
|
|
|
fonts, but better than unhinted fonts.
|
2014-11-30 19:36:49 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
includeUserConf = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = true;
|
|
|
|
description = ''
|
|
|
|
Include the user configuration from
|
|
|
|
<filename>~/.config/fontconfig/fonts.conf</filename> or
|
|
|
|
<filename>~/.config/fontconfig/conf.d</filename>.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
subpixel = {
|
|
|
|
|
|
|
|
rgba = mkOption {
|
|
|
|
default = "rgb";
|
2015-08-17 18:52:45 +01:00
|
|
|
type = types.enum ["rgb" "bgr" "vrgb" "vbgr" "none"];
|
2014-11-30 19:36:49 +00:00
|
|
|
description = ''
|
freetype: 2.6.5 -> 2.7.1
The Infinality bytecode interpreter is removed in favor of the new v40 TrueType
interpreter. In the past, the Infinality interpreter provided support for
ClearType-style hinting instructions while the default interpreter (then v35)
provided support only for original TrueType-style instructions. The v40
interpreter corrects this deficiency, so the Infinality interpreter is no longer
necessary.
To understand why the Infinality interpreter is no longer necessary, we should
understand how ClearType differs from TrueType and how the v40 interpreter
works. The following is a summary of information available on the FreeType
website [1] mixed with my own editorializing.
TrueType instructions use horizontal and vertical hints to improve glyph
rendering. Before TrueType, fonts were only vertically hinted; horizontal hints
improved rendering by snapping stems to pixel boundaries. Horizontal hinting is
a risk because it can significantly distort glyph shapes and kerning. Extensive
testing at different resolutions is needed to perfect the TrueType
hints. Microsoft invested significant effort to do this with its "Core fonts for
the Web" project, but few other typefaces have seen this level of attention.
With the advent of subpixel rendering, the effective horizontal resolution of
most displays increased significantly. ClearType eschews horizontal hinting in
favor of horizontal supersampling. Most fonts are designed for the Microsoft
bytecode interpreter, which implements a compatibility mode with
TrueType-style (horizontal and vertical) instructions. However, applying the
full horizontal hints to subpixel-rendered fonts leads to color fringes and
inconsistent stem widths. The Infinality interpreter implements several
techniques to mitigate these problems, going so far as to embed font- and
glyph-specific hacks in the interpreter. On the other hand, the v40 interpreter
ignores the horizontal hinting instructions so that glyphs render as they are
intended to on the Microsoft interpreter. Without the horizontal hints, the
problems of glyph and kerning distortion, color fringes, and inconsistent stem
widths--the problems the Infinality interpreter was created to solve--simply
don't occur in the first place.
There are also security concerns which motivate removing the Infinality patches.
Although there is an updated version of the Infinality interpreter for FreeType
2.7, the lack of a consistent upstream maintainer is a security concern. The
interpreter is a Turing-complete virtual machine which has had security
vulnerabilities in the past. While the default interpreter is used in billions
of devices and is maintained by an active developer, the Infinality interpreter
is neither scrutinized nor maintained. We will probably never know if there are
defects in the Infinality interpreter, and if they were discovered they would
likely never be fixed. I do not think that is an acceptable situtation for a
core library like FreeType.
Dropping the Infinality patches means that font rendering will be less
customizable. I think this is an acceptable trade-off. The Infinality
interpreter made many compromises to mitigate the problems with horizontal
hinting; the main purpose of customization is to tailor these compromises to the
user's preferences. The new interpreter does not have to make these compromises
because it renders fonts as their designers intended, so this level of
customization is not necessary.
The Infinality-associated patches are also removed from cairo. These patches
only set the default rendering options in case they aren't set though
Fontconfig. On NixOS, the rendering options are always set in Fontconfig, so
these patches never actually did anything for us!
The Fontconfig test suite is patched to account for a quirk in the way PCF fonts
are named.
The fontconfig option `hintstyle` is no longer configurable in NixOS. This
option selects the TrueType interpreter; the v40 interpreter is `hintslight` and
the older v35 interpreter is `hintmedium` or `hintfull` (which have actually
always been the same thing). The setting may still be changed through the
`localConf` option or by creating a user Fontconfig file.
Users with HiDPI displays should probably disable hinting and antialiasing: at
best they have no visible effect.
The fontconfig-ultimate settings are still available in NixOS, but they are no
longer the default. They still work, but their main purpose is to set rendering
quirks which are no longer necessary and may actually be
detrimental (e.g. setting `hintfull` for some fonts). Also, the vast array of
font substitutions provided is not an appropriate default; the default setting
should be to give the user the font they asked for.
[1]. https://www.freetype.org/freetype2/docs/subpixel-hinting.html
2017-03-05 23:39:38 +00:00
|
|
|
Subpixel order. The overwhelming majority of displays are
|
|
|
|
<literal>rgb</literal> in their normal orientation. Select
|
|
|
|
<literal>vrgb</literal> for mounting such a display 90 degrees
|
|
|
|
clockwise from its normal orientation or <literal>vbgr</literal>
|
|
|
|
for mounting 90 degrees counter-clockwise. Select
|
|
|
|
<literal>bgr</literal> in the unlikely event of mounting 180
|
|
|
|
degrees from the normal orientation. Reverse these directions in
|
|
|
|
the improbable event that the display's native subpixel order is
|
|
|
|
<literal>bgr</literal>.
|
2014-11-30 19:36:49 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
lcdfilter = mkOption {
|
|
|
|
default = "default";
|
2015-08-17 18:52:45 +01:00
|
|
|
type = types.enum ["none" "default" "light" "legacy"];
|
2014-11-30 19:36:49 +00:00
|
|
|
description = ''
|
freetype: 2.6.5 -> 2.7.1
The Infinality bytecode interpreter is removed in favor of the new v40 TrueType
interpreter. In the past, the Infinality interpreter provided support for
ClearType-style hinting instructions while the default interpreter (then v35)
provided support only for original TrueType-style instructions. The v40
interpreter corrects this deficiency, so the Infinality interpreter is no longer
necessary.
To understand why the Infinality interpreter is no longer necessary, we should
understand how ClearType differs from TrueType and how the v40 interpreter
works. The following is a summary of information available on the FreeType
website [1] mixed with my own editorializing.
TrueType instructions use horizontal and vertical hints to improve glyph
rendering. Before TrueType, fonts were only vertically hinted; horizontal hints
improved rendering by snapping stems to pixel boundaries. Horizontal hinting is
a risk because it can significantly distort glyph shapes and kerning. Extensive
testing at different resolutions is needed to perfect the TrueType
hints. Microsoft invested significant effort to do this with its "Core fonts for
the Web" project, but few other typefaces have seen this level of attention.
With the advent of subpixel rendering, the effective horizontal resolution of
most displays increased significantly. ClearType eschews horizontal hinting in
favor of horizontal supersampling. Most fonts are designed for the Microsoft
bytecode interpreter, which implements a compatibility mode with
TrueType-style (horizontal and vertical) instructions. However, applying the
full horizontal hints to subpixel-rendered fonts leads to color fringes and
inconsistent stem widths. The Infinality interpreter implements several
techniques to mitigate these problems, going so far as to embed font- and
glyph-specific hacks in the interpreter. On the other hand, the v40 interpreter
ignores the horizontal hinting instructions so that glyphs render as they are
intended to on the Microsoft interpreter. Without the horizontal hints, the
problems of glyph and kerning distortion, color fringes, and inconsistent stem
widths--the problems the Infinality interpreter was created to solve--simply
don't occur in the first place.
There are also security concerns which motivate removing the Infinality patches.
Although there is an updated version of the Infinality interpreter for FreeType
2.7, the lack of a consistent upstream maintainer is a security concern. The
interpreter is a Turing-complete virtual machine which has had security
vulnerabilities in the past. While the default interpreter is used in billions
of devices and is maintained by an active developer, the Infinality interpreter
is neither scrutinized nor maintained. We will probably never know if there are
defects in the Infinality interpreter, and if they were discovered they would
likely never be fixed. I do not think that is an acceptable situtation for a
core library like FreeType.
Dropping the Infinality patches means that font rendering will be less
customizable. I think this is an acceptable trade-off. The Infinality
interpreter made many compromises to mitigate the problems with horizontal
hinting; the main purpose of customization is to tailor these compromises to the
user's preferences. The new interpreter does not have to make these compromises
because it renders fonts as their designers intended, so this level of
customization is not necessary.
The Infinality-associated patches are also removed from cairo. These patches
only set the default rendering options in case they aren't set though
Fontconfig. On NixOS, the rendering options are always set in Fontconfig, so
these patches never actually did anything for us!
The Fontconfig test suite is patched to account for a quirk in the way PCF fonts
are named.
The fontconfig option `hintstyle` is no longer configurable in NixOS. This
option selects the TrueType interpreter; the v40 interpreter is `hintslight` and
the older v35 interpreter is `hintmedium` or `hintfull` (which have actually
always been the same thing). The setting may still be changed through the
`localConf` option or by creating a user Fontconfig file.
Users with HiDPI displays should probably disable hinting and antialiasing: at
best they have no visible effect.
The fontconfig-ultimate settings are still available in NixOS, but they are no
longer the default. They still work, but their main purpose is to set rendering
quirks which are no longer necessary and may actually be
detrimental (e.g. setting `hintfull` for some fonts). Also, the vast array of
font substitutions provided is not an appropriate default; the default setting
should be to give the user the font they asked for.
[1]. https://www.freetype.org/freetype2/docs/subpixel-hinting.html
2017-03-05 23:39:38 +00:00
|
|
|
FreeType LCD filter. At high resolution (> 200 DPI), LCD filtering
|
|
|
|
has no visible effect; users of such displays may want to select
|
|
|
|
<literal>none</literal>.
|
2014-11-30 19:36:49 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
};
|
|
|
|
|
2016-01-29 11:40:51 +00:00
|
|
|
cache32Bit = mkOption {
|
|
|
|
default = false;
|
|
|
|
type = types.bool;
|
|
|
|
description = ''
|
|
|
|
Generate system fonts cache for 32-bit applications.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2017-03-04 17:23:34 +00:00
|
|
|
allowBitmaps = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = true;
|
|
|
|
description = ''
|
|
|
|
Allow bitmap fonts. Set to <literal>false</literal> to ban all
|
|
|
|
bitmap fonts.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
allowType1 = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
|
|
|
description = ''
|
|
|
|
Allow Type-1 fonts. Default is <literal>false</literal> because of
|
|
|
|
poor rendering.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
useEmbeddedBitmaps = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
|
|
|
description = ''Use embedded bitmaps in fonts like Calibri.'';
|
|
|
|
};
|
|
|
|
|
2013-06-27 12:12:45 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
};
|
2017-04-03 14:48:50 +01:00
|
|
|
config = mkMerge [
|
|
|
|
(mkIf cfg.enable {
|
|
|
|
environment.systemPackages = [ pkgs.fontconfig ];
|
|
|
|
environment.etc.fonts.source = "${fontconfigEtc}/etc/fonts/";
|
|
|
|
})
|
|
|
|
(mkIf (cfg.enable && !cfg.penultimate.enable) {
|
|
|
|
fonts.fontconfig.confPackages = [ confPkg ];
|
|
|
|
})
|
|
|
|
];
|
2013-06-27 12:12:45 +01:00
|
|
|
|
|
|
|
}
|