summaryrefslogtreecommitdiff
path: root/lib/gvariant.nix
diff options
context:
space:
mode:
authorSilvan Mosberger <silvan.mosberger@tweag.io>2024-12-10 20:26:33 +0100
committerSilvan Mosberger <silvan.mosberger@tweag.io>2024-12-10 20:26:33 +0100
commit4f0dadbf38ee4cf4cc38cbc232b7708fddf965bc (patch)
tree1ff84f90d76da8505f195a3e063ae9afd94e270b /lib/gvariant.nix
parentvimPlugins.avante-nvim: move out to separate directory (#364001) (diff)
downloadnixpkgs-4f0dadbf38ee4cf4cc38cbc232b7708fddf965bc.tar.gz
treewide: format all inactive Nix files
After final improvements to the official formatter implementation, this commit now performs the first treewide reformat of Nix files using it. This is part of the implementation of RFC 166. Only "inactive" files are reformatted, meaning only files that aren't being touched by any PR with activity in the past 2 months. This is to avoid conflicts for PRs that might soon be merged. Later we can do a full treewide reformat to get the rest, which should not cause as many conflicts. A CI check has already been running for some time to ensure that new and already-formatted files are formatted, so the files being reformatted here should also stay formatted. This commit was automatically created and can be verified using nix-build https://github.com/infinisil/treewide-nixpkgs-reformat-script/archive/a08b3a4d199c6124ac5b36a889d9099b4383463f.tar.gz \ --argstr baseRev b32a0943687d2a5094a6d92f25a4b6e16a76b5b7 result/bin/apply-formatting $NIXPKGS_PATH
Diffstat (limited to 'lib/gvariant.nix')
-rw-r--r--lib/gvariant.nix137
1 files changed, 78 insertions, 59 deletions
diff --git a/lib/gvariant.nix b/lib/gvariant.nix
index d542df4d7b9a..d316a3254a25 100644
--- a/lib/gvariant.nix
+++ b/lib/gvariant.nix
@@ -14,7 +14,12 @@
let
inherit (lib)
- concatMapStringsSep concatStrings escape head replaceStrings;
+ concatMapStringsSep
+ concatStrings
+ escape
+ head
+ replaceStrings
+ ;
mkPrimitive = t: v: {
_type = "gvariant";
@@ -49,7 +54,6 @@ rec {
/**
Check if a value is a GVariant value
-
# Inputs
`v`
@@ -115,7 +119,6 @@ rec {
Returns the GVariant value that most closely matches the given Nix value.
If no GVariant value can be found unambiguously then error is thrown.
-
# Inputs
`v`
@@ -128,7 +131,8 @@ rec {
mkValue :: Any -> gvariant
```
*/
- mkValue = v:
+ mkValue =
+ v:
if builtins.isBool v then
mkBoolean v
else if builtins.isFloat v then
@@ -141,13 +145,17 @@ rec {
v
else if builtins.isInt v then
let
- validConstructors = builtins.filter ({ min, max, ... }: (min == null || min <= v) && (max == null || v <= max)) intConstructors;
+ validConstructors = builtins.filter (
+ { min, max, ... }: (min == null || min <= v) && (max == null || v <= max)
+ ) intConstructors;
in
throw ''
The GVariant type for number “${builtins.toString v}” is unclear.
Please wrap the value with one of the following, depending on the value type in GSettings schema:
- ${lib.concatMapStringsSep "\n" ({ name, type, ...}: "- `lib.gvariant.${name}` for `${type}`") validConstructors}
+ ${lib.concatMapStringsSep "\n" (
+ { name, type, ... }: "- `lib.gvariant.${name}` for `${type}`"
+ ) validConstructors}
''
else if builtins.isAttrs v then
throw "Cannot construct GVariant value from an attribute set. If you want to construct a dictionary, you will need to create an array containing items constructed with `lib.gvariant.mkDictionaryEntry`."
@@ -157,7 +165,6 @@ rec {
/**
Returns the GVariant array from the given type of the elements and a Nix list.
-
# Inputs
`elems`
@@ -181,22 +188,22 @@ rec {
:::
*/
- mkArray = elems:
+ mkArray =
+ elems:
let
vs = map mkValue (lib.throwIf (elems == [ ]) "Please create empty array with mkEmptyArray." elems);
- elemType = lib.throwIfNot (lib.all (t: (head vs).type == t) (map (v: v.type) vs))
- "Elements in a list should have same type."
- (head vs).type;
+ elemType = lib.throwIfNot (lib.all (t: (head vs).type == t) (
+ map (v: v.type) vs
+ )) "Elements in a list should have same type." (head vs).type;
in
- mkPrimitive (type.arrayOf elemType) vs // {
- __toString = self:
- "@${self.type} [${concatMapStringsSep "," toString self.value}]";
+ mkPrimitive (type.arrayOf elemType) vs
+ // {
+ __toString = self: "@${self.type} [${concatMapStringsSep "," toString self.value}]";
};
/**
Returns the GVariant array from the given empty Nix list.
-
# Inputs
`elemType`
@@ -220,16 +227,17 @@ rec {
:::
*/
- mkEmptyArray = elemType: mkPrimitive (type.arrayOf elemType) [ ] // {
- __toString = self: "@${self.type} []";
- };
-
+ mkEmptyArray =
+ elemType:
+ mkPrimitive (type.arrayOf elemType) [ ]
+ // {
+ __toString = self: "@${self.type} []";
+ };
/**
Returns the GVariant variant from the given Nix value. Variants are containers
of different GVariant type.
-
# Inputs
`elem`
@@ -255,16 +263,19 @@ rec {
:::
*/
- mkVariant = elem:
- let gvarElem = mkValue elem;
- in mkPrimitive type.variant gvarElem // {
+ mkVariant =
+ elem:
+ let
+ gvarElem = mkValue elem;
+ in
+ mkPrimitive type.variant gvarElem
+ // {
__toString = self: "<${toString self.value}>";
};
/**
Returns the GVariant dictionary entry from the given key and value.
-
# Inputs
`name`
@@ -297,21 +308,20 @@ rec {
:::
*/
mkDictionaryEntry =
- name:
- value:
+ name: value:
let
name' = mkValue name;
value' = mkValue value;
dictionaryType = type.dictionaryEntryOf name'.type value'.type;
in
- mkPrimitive dictionaryType { inherit name value; } // {
+ mkPrimitive dictionaryType { inherit name value; }
+ // {
__toString = self: "@${self.type} {${name'},${value'}}";
};
/**
Returns the GVariant maybe from the given element type.
-
# Inputs
`elemType`
@@ -328,19 +338,17 @@ rec {
mkMaybe :: gvariant.type -> Any -> gvariant
```
*/
- mkMaybe = elemType: elem:
- mkPrimitive (type.maybeOf elemType) elem // {
- __toString = self:
- if self.value == null then
- "@${self.type} nothing"
- else
- "just ${toString self.value}";
+ mkMaybe =
+ elemType: elem:
+ mkPrimitive (type.maybeOf elemType) elem
+ // {
+ __toString =
+ self: if self.value == null then "@${self.type} nothing" else "just ${toString self.value}";
};
/**
Returns the GVariant nothing from the given element type.
-
# Inputs
`elemType`
@@ -358,7 +366,6 @@ rec {
/**
Returns the GVariant just from the given Nix value.
-
# Inputs
`elem`
@@ -371,12 +378,16 @@ rec {
mkJust :: Any -> gvariant
```
*/
- mkJust = elem: let gvarElem = mkValue elem; in mkMaybe gvarElem.type gvarElem;
+ mkJust =
+ elem:
+ let
+ gvarElem = mkValue elem;
+ in
+ mkMaybe gvarElem.type gvarElem;
/**
Returns the GVariant tuple from the given Nix list.
-
# Inputs
`elems`
@@ -389,20 +400,20 @@ rec {
mkTuple :: [Any] -> gvariant
```
*/
- mkTuple = elems:
+ mkTuple =
+ elems:
let
gvarElems = map mkValue elems;
tupleType = type.tupleOf (map (e: e.type) gvarElems);
in
- mkPrimitive tupleType gvarElems // {
- __toString = self:
- "@${self.type} (${concatMapStringsSep "," toString self.value})";
+ mkPrimitive tupleType gvarElems
+ // {
+ __toString = self: "@${self.type} (${concatMapStringsSep "," toString self.value})";
};
/**
Returns the GVariant boolean from the given Nix bool value.
-
# Inputs
`v`
@@ -415,15 +426,16 @@ rec {
mkBoolean :: Bool -> gvariant
```
*/
- mkBoolean = v:
- mkPrimitive type.boolean v // {
+ mkBoolean =
+ v:
+ mkPrimitive type.boolean v
+ // {
__toString = self: if self.value then "true" else "false";
};
/**
Returns the GVariant string from the given Nix string value.
-
# Inputs
`v`
@@ -436,16 +448,19 @@ rec {
mkString :: String -> gvariant
```
*/
- mkString = v:
- let sanitize = s: replaceStrings [ "\n" ] [ "\\n" ] (escape [ "'" "\\" ] s);
- in mkPrimitive type.string v // {
+ mkString =
+ v:
+ let
+ sanitize = s: replaceStrings [ "\n" ] [ "\\n" ] (escape [ "'" "\\" ] s);
+ in
+ mkPrimitive type.string v
+ // {
__toString = self: "'${sanitize self.value}'";
};
/**
Returns the GVariant object path from the given Nix string value.
-
# Inputs
`v`
@@ -458,8 +473,10 @@ rec {
mkObjectpath :: String -> gvariant
```
*/
- mkObjectpath = v:
- mkPrimitive type.string v // {
+ mkObjectpath =
+ v:
+ mkPrimitive type.string v
+ // {
__toString = self: "objectpath '${escape [ "'" ] self.value}'";
};
@@ -499,7 +516,6 @@ rec {
/**
Returns the GVariant int32 from the given Nix int value.
-
# Inputs
`v`
@@ -512,8 +528,10 @@ rec {
mkInt32 :: Int -> gvariant
```
*/
- mkInt32 = v:
- mkPrimitive type.int32 v // {
+ mkInt32 =
+ v:
+ mkPrimitive type.int32 v
+ // {
__toString = self: toString self.value;
};
@@ -553,7 +571,6 @@ rec {
/**
Returns the GVariant double from the given Nix float value.
-
# Inputs
`v`
@@ -566,8 +583,10 @@ rec {
mkDouble :: Float -> gvariant
```
*/
- mkDouble = v:
- mkPrimitive type.double v // {
+ mkDouble =
+ v:
+ mkPrimitive type.double v
+ // {
__toString = self: toString self.value;
};
}