nixpkgs/pkgs/build-support/make-pkgconfigitem/default.nix
piegames 68927918d0 treewide: Fix indentation in strings
The indentation stripping semantics of strings are fairly bad and have a
few gotchas where the resulting string has not the intended indentation.
This commit fixes most if not all such instances in Nixpkgs.

I tried to strive a balance between keeping the diff small and
reformatting/refactoring the code to look better. In general,
reformatting should be left to Nixfmt.

Note that this causes a lot of rebuilds by design. All changes need to
be thoroughly vetted and reviewed for correctness. There is no automatic
way to prove correctness.

List of files to fix generated by running
https://gerrit.lix.systems/c/lix/+/2092 on Nixpkgs and looking at the
warnings.
2024-10-22 21:36:42 +02:00

68 lines
2.3 KiB
Nix

{ lib, writeTextFile, buildPackages }:
# See https://people.freedesktop.org/~dbn/pkg-config-guide.html#concepts
{ name # The name of the pc file
# keywords
# provide a default description for convenience. it's not important but still required by pkg-config.
, description ? "Pkg-config file for ${name}"
, url ? ""
, version ? ""
, requires ? [ ]
, requiresPrivate ? [ ]
, conflicts ? [ ]
, cflags ? [ ]
, libs ? [ ]
, libsPrivate ? [ ]
, variables ? { }
}:
let
# only 'out' has to be changed, otherwise it would be replaced by the out of the writeTextFile
placeholderToSubstVar = builtins.replaceStrings [ "${placeholder "out"}" ] [ "@out@" ];
replacePlaceholderAndListToString = x:
if builtins.isList x
then placeholderToSubstVar (builtins.concatStringsSep " " x)
else placeholderToSubstVar x;
keywordsSection =
let
mustBeAList = attr: attrName: lib.throwIfNot (lib.isList attr) "'${attrName}' must be a list" attr;
in
{
"Name" = name;
"Description" = description;
"URL" = url;
"Version" = version;
"Requires" = mustBeAList requires "requires";
"Requires.private" = mustBeAList requiresPrivate "requiresPrivate";
"Conflicts" = mustBeAList conflicts "conflicts";
"Cflags" = mustBeAList cflags "cflags";
"Libs" = mustBeAList libs "libs";
"Libs.private" = mustBeAList libsPrivate "libsPrivate";
};
renderVariable = name: value:
lib.optionalString (value != "" && value != [ ]) "${name}=${replacePlaceholderAndListToString value}";
renderKeyword = name: value:
lib.optionalString (value != "" && value != [ ]) "${name}: ${replacePlaceholderAndListToString value}";
renderSomething = renderFunc: attrs:
lib.pipe attrs [
(lib.mapAttrsToList renderFunc)
(builtins.filter (v: v != ""))
(lib.concatLines)
];
variablesSectionRendered = renderSomething renderVariable variables;
keywordsSectionRendered = renderSomething renderKeyword keywordsSection;
content = [ variablesSectionRendered keywordsSectionRendered ];
in
writeTextFile {
name = "${name}.pc";
destination = "/lib/pkgconfig/${name}.pc";
text = builtins.concatStringsSep "\n" content;
checkPhase = ''${buildPackages.pkg-config}/bin/${buildPackages.pkg-config.targetPrefix}pkg-config --validate "$target"'';
}