File: params.c

package info (click to toggle)
gwyddion 2.62-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 51,952 kB
  • sloc: ansic: 398,486; python: 7,877; sh: 5,492; makefile: 4,723; xml: 3,883; cpp: 1,969; pascal: 418; perl: 154; ruby: 130
file content (2407 lines) | stat: -rw-r--r-- 75,682 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
/*
 *  $Id: params.c 25038 2022-09-22 12:26:38Z yeti-dn $
 *  Copyright (C) 2021-2022 David Necas (Yeti).
 *  E-mail: yeti@gwyddion.net.
 *
 *  This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
 *  License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any
 *  later version.
 *
 *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 *  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 *  details.
 *
 *  You should have received a copy of the GNU General Public License along with this program; if not, write to the
 *  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#include "config.h"
#include <stdlib.h>
#include "libgwyddion/gwymacros.h"
#include "libprocess/gwyprocesstypes.h"
#include "libprocess/gwyprocessenums.h"
#include "settings.h"
#include "data-browser.h"
#include "gwymoduleutils.h"
#include "params.h"
#include "param-internal.h"

typedef struct _GwyParamsPrivate GwyParamsPrivate;

typedef struct {
    gchar *s;
    GwySIUnit *cached_unit;
    gint cached_power10;
    gboolean cached_valid;
} GwyParamValueUnit;

typedef struct {
    gchar *s;
    gint i;
    gboolean use_string;
} GwyParamValueCurve;

typedef union {
    gboolean b;
    gint i;
    guint u;
    gdouble d;
    gchar *s;
    GwyRGBA c;
    GwyAppDataId di;
    GwyResultsReportType rt;
    GwyParamValueUnit si;
    GwyParamValueCurve cu;
} GwyParamValue;

struct _GwyParamsPrivate {
    GwyParamDef *def;
    GwyParamValue *values;
    guint nvalues;
};

static void        gwy_params_finalize   (GObject *gobject);
static gboolean    set_boolean_value     (GwyParamValue *pvalue,
                                          gboolean value);
static gboolean    set_int_value         (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          gint value);
static gboolean    set_random_seed_value (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          gint value);
static gboolean    set_double_value      (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          gdouble value);
static gboolean    set_enum_value        (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          gint value);
static gboolean    set_flags_value       (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          guint value);
static gboolean    set_report_type_value (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          GwyResultsReportType value);
static gboolean    set_string_value      (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          const gchar *value);
static gboolean    set_curve_string_value(GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          const gchar *value);
static gboolean    set_curve_int_value   (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          const gint value);
static gboolean    set_unit_value        (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          const gchar *value);
static gboolean    set_color_value       (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          GwyRGBA value);
static gboolean    set_data_id_value     (GwyParamValue *pvalue,
                                          GwyAppDataId value);
static gboolean    set_resource_value    (GwyParamValue *pvalue,
                                          const GwyParamDefItem *def,
                                          const gchar *value);
static gint        get_enum_internal     (GwyParams *params,
                                          gint id,
                                          GType type,
                                          gint fallback_value);
static guint       get_flags_internal    (GwyParams *params,
                                          gint id,
                                          GType type);
static gboolean    reset_param_value     (GwyParams *params,
                                          guint i);
static gboolean    assign_parameter_value(GwyParamValue *value,
                                          const GwyParamDefItem *def,
                                          GwyParamValue *src);
static gpointer    get_data_object       (GwyParams *params,
                                          gint id,
                                          GwyParamType param_type,
                                          GQuark (*get_key_func)(gint id),
                                          GType object_type);
static gpointer    get_data_object_for_id(GwyAppDataId dataid,
                                          GQuark (*get_key_func)(gint id),
                                          GType object_type);
static gboolean    param_find_common     (GwyParams *params,
                                          gint id,
                                          gint *i,
                                          const GwyParamDefItem **def,
                                          GwyParamType want_type);
static GHashTable* ensure_data_ids       (void);

G_LOCK_DEFINE_STATIC(data_ids);

static const GwyAppDataId noid = GWY_APP_DATA_ID_NONE;

G_DEFINE_TYPE(GwyParams, gwy_params, G_TYPE_OBJECT);

static void
gwy_params_class_init(GwyParamsClass *klass)
{
    GObjectClass *gobject_class = G_OBJECT_CLASS(klass);

    gobject_class->finalize = gwy_params_finalize;

    g_type_class_add_private(klass, sizeof(GwyParamsPrivate));
}

static void
gwy_params_init(GwyParams *params)
{
    params->priv = G_TYPE_INSTANCE_GET_PRIVATE(params, GWY_TYPE_PARAMS, GwyParamsPrivate);
}

static void
gwy_params_finalize(GObject *gobject)
{
    GwyParams *params = (GwyParams*)gobject;
    GwyParamsPrivate *priv = params->priv;
    GwyParamValue *values = priv->values;
    guint i, n = priv->nvalues;

    for (i = 0; i < n; i++) {
        GwyParamType type = _gwy_param_def_item(priv->def, i)->type;

        if (type == GWY_PARAM_STRING || type == GWY_PARAM_RESOURCE)
            g_free(values[i].s);
        else if (param_type_is_curve_no(type))
            g_free(values[i].cu.s);
        else if (type == GWY_PARAM_UNIT) {
            GWY_OBJECT_UNREF(values[i].si.cached_unit);
            g_free(values[i].si.s);
        }
    }
    g_free(priv->values);

    GWY_OBJECT_UNREF(priv->def);
    G_OBJECT_CLASS(gwy_params_parent_class)->finalize(gobject);
}

/**
 * gwy_params_new:
 *
 * Creates a new empty parameter value set.
 *
 * The created object is empty (and useless) until parameter definitions are set with gwy_params_set_def().  However,
 * in modules the parameters are normally instantiated using gwy_params_new_from_settings().
 *
 * Returns: A new empty parameter value set.
 *
 * Since: 2.59
 **/
GwyParams*
gwy_params_new(void)
{
    return g_object_new(GWY_TYPE_PARAMS, NULL);
}

/**
 * gwy_params_duplicate:
 * @params: A set of parameter values.
 *
 * Creates a duplicate of a set of parameter values.
 *
 * Returns: A new empty parameter value set.
 *
 * Since: 2.59
 **/
GwyParams*
gwy_params_duplicate(GwyParams *params)
{
    GwyParamsPrivate *priv;
    GwyParamValue *values;
    GwyParams *copy;
    guint i, n;

    g_return_val_if_fail(GWY_IS_PARAMS(params), NULL);
    priv = params->priv;
    copy = gwy_params_new();
    /* This is a bit silly, but we can duplicate an unset object so why not. */
    if (!priv->def)
        return copy;

    gwy_params_set_def(copy, priv->def);

    priv = params->priv;
    n = priv->nvalues;
    values = copy->priv->values;

    /* Allocated values must be handled specially, but everything else can be just a bitwise copy. */
    gwy_assign(values, priv->values, n);
    for (i = 0; i < n; i++) {
        GwyParamType type = _gwy_param_def_item(priv->def, i)->type;

        if (type == GWY_PARAM_STRING || type == GWY_PARAM_RESOURCE)
            values[i].s = g_strdup(values[i].s);
        else if (param_type_is_curve_no(type))
            values[i].cu.s = g_strdup(values[i].cu.s);
        else if (type == GWY_PARAM_UNIT) {
            values[i].si.s = g_strdup(values[i].si.s);
            if (values[i].si.cached_unit)
                values[i].si.cached_unit = gwy_si_unit_duplicate(values[i].si.cached_unit);
        }
    }

    return copy;
}

/**
 * gwy_params_assign:
 * @params: A set of parameter values.
 * @source: A set of parameter values.
 *
 * Assigns values to a set of parameter values from another one.
 *
 * The parameter sets must have compatible definitions. Usually, the #GwyParamDef of @source is the same as the one of
 * @params, a subset, or a superset. In other words, parameters existing only in one objects are ignored. Usually
 * a #GwyParamDef superset is created by defining one parameter set, then defining another one exactly the same way
 * and adding a few more parameters.
 *
 * Parameters are identified by id. Both parameter ids and names must match. However, a %NULL name is considered to
 * match any name – if the ids are equal. Of course, parameter types must also match.
 *
 * Since: 2.62
 **/
void
gwy_params_assign(GwyParams *params,
                  GwyParams *source)
{
    GwyParamsPrivate *priv, *spriv;
    GwyParamValue *values, *svalues;
    guint k, sn;

    g_return_if_fail(GWY_IS_PARAMS(params));
    g_return_if_fail(GWY_IS_PARAMS(source));

    priv = params->priv;
    spriv = source->priv;
    values = priv->values;
    svalues = spriv->values;
    sn = spriv->nvalues;
    g_return_if_fail(priv->def);
    g_return_if_fail(spriv->def);

    for (k = 0; k < sn; k++) {
        /* Look up the parameter by id. There may be a use case for a more loose function identfying parameters by
         * name, but it would probably be a different function. */
        const GwyParamDefItem *def, *srcdef = _gwy_param_def_item(spriv->def, k);
        gint id = srcdef->id;
        gint i = _gwy_param_def_index(priv->def, id);

        if (i < 0) {
            //g_warning("Destination GwyParams has no parameter with id %d.", id);
            continue;
        }
        def = _gwy_param_def_item(priv->def, i);
        if (srcdef->type != def->type) {
            g_warning("Destination parameter %d type is %d, but source's is %d.", id, def->type, srcdef->type);
            continue;
        }
        if (srcdef->name && def->name && !gwy_strequal(srcdef->name, def->name)) {
            g_warning("Destination parameter %d is called %s, but source's is %s.", id, def->name, srcdef->name);
            continue;
        }
        /* We do not check if the parameter definitions match exactly. The set-parameter function will still spit out
         * a warning if the value is not valid. So we currently just ignore the return value. */
        assign_parameter_value(values + i, def, svalues + k);
    }
}

/**
 * gwy_params_set_def:
 * @params: A parameter value set.
 * @pardef: Set of parameter definitions.
 *
 * Sets the definitions of parameters a #GwyParams should use.
 *
 * Once set, the definitions are fixed.  One #GwyParams object cannot be used with multiple definitions.
 *
 * Since: 2.59
 **/
void
gwy_params_set_def(GwyParams *params,
                   GwyParamDef *pardef)
{
    GwyParamsPrivate *priv;
    GwyParamValue *values;

    g_return_if_fail(GWY_IS_PARAMS(params));
    g_return_if_fail(GWY_IS_PARAM_DEF(pardef));
    priv = params->priv;
    if (priv->def) {
        g_critical("GwyParams definition can only be set upon construction.");
        return;
    }
    priv->def = g_object_ref(pardef);
    _gwy_param_def_use(pardef, params);
    priv->nvalues = _gwy_param_def_size(pardef);
    priv->values = values = g_new0(GwyParamValue, priv->nvalues);
    gwy_params_reset_all(params, NULL);
}

/**
 * gwy_params_get_def:
 * @params: A parameter value set.
 *
 * Gets the definitions object for a parameter set.
 *
 * Returns: The set of parameter definitions.
 *
 * Since: 2.59
 **/
GwyParamDef*
gwy_params_get_def(GwyParams *params)
{
    g_return_val_if_fail(GWY_IS_PARAMS(params), NULL);
    return params->priv->def;
}

/**
 * gwy_params_reset:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Resets a single parameter in a parameter value set to the default value.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_reset(GwyParams *params,
                 gint id)
{
    GwyParamsPrivate *priv;
    gint i;

    g_return_val_if_fail(GWY_IS_PARAMS(params), FALSE);
    priv = params->priv;
    i = _gwy_param_def_index(priv->def, id);
    g_return_val_if_fail(i >= 0 && i < priv->nvalues, FALSE);
    return reset_param_value(params, i);
}

/**
 * gwy_params_reset_all:
 * @params: A parameter value set.
 * @prefix: The prefix (leading path component) limiting parameters to reset.  Pass empty string or %NULL to reset all
 *          parameters.
 *
 * Resets all parameters in a parameter value set to default values.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * Since: 2.59
 **/
void
gwy_params_reset_all(GwyParams *params,
                     const gchar *prefix)
{
    GwyParamsPrivate *priv;
    guint i, n, pfxlen;

    g_return_if_fail(GWY_IS_PARAMS(params));
    priv = params->priv;
    n = priv->nvalues;
    pfxlen = (prefix ? strlen(prefix) : 0);
    while (pfxlen && prefix[pfxlen-1] == '/')
        pfxlen--;
    for (i = 0; i < n; i++) {
        if (pfxlen) {
            const GwyParamDefItem *def = _gwy_param_def_item(priv->def, i);
            const gchar *name = def->name;
            if (name && (strncmp(name, prefix, pfxlen) || name[pfxlen] != '/'))
                continue;
        }
        reset_param_value(params, i);
    }
}

/**
 * gwy_params_new_from_settings:
 * @pardef: Set of parameter definitions.
 *
 * Creates a new parameter value set with given definition and loads values from settings.
 *
 * The definitions @pardef must have function name set.
 *
 * Returns: A new parameter value set.
 *
 * Since: 2.59
 **/
GwyParams*
gwy_params_new_from_settings(GwyParamDef *pardef)
{
    GwyParams *params;

    params = gwy_params_new();
    gwy_params_set_def(params, pardef);
    gwy_params_load_from_settings(params);

    return params;
}

/**
 * gwy_params_load_from_settings:
 * @params: A set of parameter values.
 *
 * Loads a parameter value set from settings.
 *
 * The corresponding definitions must have function name set.  It is usually more convenient to create and load the
 * parameters at the same time using gwy_params_new_from_settings().
 *
 * Since: 2.59
 **/
void
gwy_params_load_from_settings(GwyParams *params)
{
    GwyParamsPrivate *priv;
    GwyParamValue *values;
    GwyContainer *settings;
    const gchar *modname;
    GString *str;
    GHashTable *data_ids;
    guint i, n, pfxlen;

    g_return_if_fail(GWY_IS_PARAMS(params));
    priv = params->priv;
    modname = gwy_param_def_get_function_name(priv->def);
    if (!modname) {
        g_critical("NULL function name when trying to load parameters from settings.");
        return;
    }
    settings = gwy_app_settings_get();
    G_LOCK(data_ids);
    data_ids = ensure_data_ids();

    n = priv->nvalues;
    values = priv->values;

    str = g_string_new("/module/");
    g_string_append(str, modname);
    g_string_append_c(str, '/');
    pfxlen = str->len;

    for (i = 0; i < n; i++) {
        GwyParamValue *value = values + i;
        const GwyParamDefItem *def = _gwy_param_def_item(priv->def, i);
        GwyParamType type = def->type;
        GQuark quark;

        /* Load default mask colour from global settings. */
        if (type == GWY_PARAM_COLOR && def->def.c.is_mask) {
            GwyRGBA v;
            if (gwy_rgba_get_from_container(&v, settings, "/mask"))
                set_color_value(value, def, v);
        }

        if (!def->name)
            continue;

        g_string_truncate(str, pfxlen);
        g_string_append(str, def->name);
        quark = g_quark_from_string(str->str);
        if (type == GWY_PARAM_BOOLEAN)
            gwy_container_gis_boolean(settings, quark, &value->b);
        else if (type == GWY_PARAM_INT || type == GWY_PARAM_ACTIVE_PAGE) {
            gint32 v;
            if (gwy_container_gis_int32(settings, quark, &v))
                set_int_value(value, def, v);
        }
        else if (type == GWY_PARAM_RANDOM_SEED) {
            gint32 v;
            if (gwy_container_gis_int32(settings, quark, &v))
                set_random_seed_value(value, def, v);
            /* Do not randomize here.  We may not know yet whether or not.  But remember we may have to. */
        }
        else if (type == GWY_PARAM_ENUM) {
            gint32 v;
            if (gwy_container_gis_int32(settings, quark, &v))
                set_enum_value(value, def, v);
        }
        else if (type == GWY_PARAM_FLAGS) {
            guint v;
            if (gwy_container_gis_enum(settings, quark, &v))
                set_flags_value(value, def, v);
        }
        else if (type == GWY_PARAM_REPORT_TYPE) {
            guint v;
            if (gwy_container_gis_enum(settings, quark, &v))
                set_report_type_value(value, def, v);
        }
        else if (type == GWY_PARAM_DOUBLE) {
            gdouble v;
            if (gwy_container_gis_double(settings, quark, &v))
                set_double_value(value, def, v);
        }
        else if (type == GWY_PARAM_STRING) {
            const guchar *v;
            if (gwy_container_gis_string(settings, quark, &v))
                set_string_value(value, def, v);
        }
        else if (param_type_is_curve_no(type)) {
            const guchar *v;
            if (gwy_container_gis_string(settings, quark, &v))
                set_curve_string_value(value, def, v);
        }
        else if (type == GWY_PARAM_UNIT) {
            const guchar *v;
            if (gwy_container_gis_string(settings, quark, &v))
                set_unit_value(value, def, v);
        }
        else if (type == GWY_PARAM_RESOURCE) {
            const guchar *v;
            if (gwy_container_gis_string(settings, quark, &v))
                set_resource_value(value, def, v);
        }
        else if (type == GWY_PARAM_COLOR) {
            GwyRGBA v;
            if (gwy_rgba_get_from_container(&v, settings, str->str))
                set_color_value(value, def, v);
        }
        else if (param_type_is_data_id(type)) {
            GwyAppDataId *dataid = g_hash_table_lookup(data_ids, GUINT_TO_POINTER(quark));

            if (dataid) {
                value->di = *dataid;
                gwy_debug("restoring data id { %d, %d } for %s", dataid->datano, dataid->id, str->str);
                if (type == GWY_PARAM_IMAGE_ID)
                    gwy_app_data_id_verify_channel(&value->di);
                else if (type == GWY_PARAM_GRAPH_ID)
                    gwy_app_data_id_verify_graph(&value->di);
                else if (type == GWY_PARAM_VOLUME_ID)
                    gwy_app_data_id_verify_volume(&value->di);
                else if (type == GWY_PARAM_XYZ_ID)
                    gwy_app_data_id_verify_xyz(&value->di);
                else if (type == GWY_PARAM_CURVE_MAP_ID)
                    gwy_app_data_id_verify_curve_map(&value->di);
            }
        }
        else {
            g_assert_not_reached();
        }
    }
    /* Post-loading setup. */
    for (i = 0; i < n; i++) {
        const GwyParamDefItem *def = _gwy_param_def_item(priv->def, i);
        GwyParamType type = def->type;

        if (type == GWY_PARAM_RANDOM_SEED) {
            gint randomize_id = def->def.rs.randomize_id;

            if (randomize_id >= 0 && gwy_params_get_boolean(params, randomize_id))
                gwy_params_randomize_seed(params, def->id);
        }
    }
    G_UNLOCK(data_ids);
    g_string_free(str, TRUE);
}

/**
 * gwy_params_save_to_settings:
 * @params: A parameter value set.
 *
 * Saves a parameter value set to settings.
 *
 * The associated definitions must have function name set.
 *
 * Since: 2.59
 **/
void
gwy_params_save_to_settings(GwyParams *params)
{
    GwyParamsPrivate *priv;
    GwyParamValue *values;
    GwyContainer *settings;
    const gchar *modname;
    GString *str;
    guint i, n, pfxlen;
    GHashTable *data_ids;

    g_return_if_fail(GWY_IS_PARAMS(params));
    priv = params->priv;
    n = priv->nvalues;
    values = priv->values;

    g_return_if_fail(priv->def);
    modname = gwy_param_def_get_function_name(priv->def);
    if (!modname) {
        g_critical("NULL function name when trying to save parameters to settings.");
        return;
    }
    settings = gwy_app_settings_get();

    str = g_string_new("/module/");
    g_string_append(str, modname);
    g_string_append_c(str, '/');
    pfxlen = str->len;
    G_LOCK(data_ids);
    data_ids = ensure_data_ids();
    for (i = 0; i < n; i++) {
        GwyParamValue *value = values + i;
        const GwyParamDefItem *def = _gwy_param_def_item(priv->def, i);
        GwyParamType type = def->type;
        GQuark quark;

        if (!def->name)
            continue;

        g_string_truncate(str, pfxlen);
        g_string_append(str, def->name);
        quark = g_quark_from_string(str->str);
        if (type == GWY_PARAM_BOOLEAN)
            gwy_container_set_boolean(settings, quark, value->b);
        else if (type == GWY_PARAM_INT || type == GWY_PARAM_ACTIVE_PAGE)
            gwy_container_set_int32(settings, quark, value->i);
        else if (type == GWY_PARAM_ENUM)
            gwy_container_set_int32(settings, quark, value->i);
        else if (type == GWY_PARAM_FLAGS)
            gwy_container_set_enum(settings, quark, value->u);
        else if (type == GWY_PARAM_REPORT_TYPE)
            gwy_container_set_enum(settings, quark, value->rt);
        else if (type == GWY_PARAM_RANDOM_SEED)
            gwy_container_set_int32(settings, quark, value->i);
        else if (type == GWY_PARAM_DOUBLE)
            gwy_container_set_double(settings, quark, value->d);
        else if (type == GWY_PARAM_STRING)
            gwy_container_set_const_string(settings, quark, value->s ? value->s : "");
        else if (param_type_is_curve_no(type))
            gwy_container_set_const_string(settings, quark, value->cu.s ? value->cu.s : "");
        else if (type == GWY_PARAM_UNIT)
            gwy_container_set_const_string(settings, quark, value->si.s ? value->si.s : "");
        else if (type == GWY_PARAM_RESOURCE) {
            if (value->s)
                gwy_container_set_const_string(settings, quark, value->s);
            else
                gwy_container_remove(settings, quark);
        }
        else if (type == GWY_PARAM_COLOR)
            gwy_rgba_store_to_container(&value->c, settings, str->str);
        else if (param_type_is_data_id(type)) {
            GwyAppDataId *dataid = g_hash_table_lookup(data_ids, GUINT_TO_POINTER(quark));

            if (dataid)
                *dataid = value->di;
            else {
                dataid = g_slice_dup(GwyAppDataId, &value->di);
                g_hash_table_insert(data_ids, GUINT_TO_POINTER(quark), dataid);
            }
            gwy_debug("remembering data id { %d, %d } for %s", dataid->datano, dataid->id, str->str);
        }
        else {
            g_assert_not_reached();
        }
    }
    G_UNLOCK(data_ids);
    g_string_free(str, TRUE);
}

/**
 * gwy_params_get_boolean:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the value of a boolean parameter.
 *
 * This function can be used with any boolean-valued parameter, even if it is more complex/specific than a plain
 * boolean.
 *
 * Returns: The boolean parameter value.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_get_boolean(GwyParams *params,
                       gint id)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_BOOLEAN))
        return FALSE;
    return params->priv->values[i].b;
}

/**
 * gwy_params_set_boolean:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a plain boolean parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * This function can only be used with plain boolean parameters defined by gwy_param_def_add_boolean().  More
 * complex/specific parameters need to be set using dedicated setters.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_boolean(GwyParams *params,
                       gint id,
                       gboolean value)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_BOOLEAN))
        return FALSE;
    return set_boolean_value(params->priv->values + i, value);
}

/**
 * gwy_params_get_int:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the value of a plain integer parameter.
 *
 * This function can be used with any integer-valued parameter, even if it is more complex/specific than a plain
 * integer.
 *
 * It can also be used to get a random seed parameter value.  The seed value does not change between calls unless
 * gwy_params_randomize_seed() has been called.
 *
 * Returns: The integer parameter value.
 *
 * Since: 2.59
 **/
gint
gwy_params_get_int(GwyParams *params,
                   gint id)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_NONE))
        return 0;
    if (def->type == GWY_PARAM_INT
        || def->type == GWY_PARAM_ENUM
        || def->type == GWY_PARAM_RANDOM_SEED
        || def->type == GWY_PARAM_ACTIVE_PAGE)
        return params->priv->values[i].i;
    if (param_type_is_curve_no(def->type))
        return params->priv->values[i].cu.i;
    if (def->type == GWY_PARAM_FLAGS)
        return params->priv->values[i].u;
    if (def->type == GWY_PARAM_REPORT_TYPE)
        return params->priv->values[i].rt;
    g_return_val_if_reached(0);
}

/**
 * gwy_params_set_int:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a integer parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * This function can only be used with plain integer parameters defined by gwy_param_def_add_int() and random seeds
 * created with gwy_param_def_add_seed().  More complex/specific parameters need to be set using dedicated setters.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_int(GwyParams *params,
                   gint id,
                   gint value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_NONE))
        return FALSE;
    if (def->type == GWY_PARAM_INT || def->type == GWY_PARAM_ACTIVE_PAGE)
        return set_int_value(params->priv->values + i, def, value);
    if (param_type_is_curve_no(def->type))
        return set_curve_int_value(params->priv->values + i, def, value);
    if (def->type == GWY_PARAM_RANDOM_SEED)
        return set_random_seed_value(params->priv->values + i, def, value);
    g_return_val_if_reached(0);
}

/**
 * gwy_params_get_enum:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the value of a enum parameter.
 *
 * This function can be used with any enum-valued parameter, even if it is more complex/specific than a plain
 * enum.
 *
 * Returns: The enum parameter value.
 *
 * Since: 2.59
 **/
gint
gwy_params_get_enum(GwyParams *params,
                    gint id)
{
    return get_enum_internal(params, id, 0, 0);
}

/**
 * gwy_params_get_masking:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 * @mask: Pointer to mask data field to update (can also be %NULL).
 *
 * Gets the value of a masking type enum parameter, consistently with a mask field.
 *
 * If @mask is %NULL the returned value is simply the parameter value.
 *
 * If @mask is a pointer then @mask and the return value can be modified.  The function will set @mask to %NULL if
 * masking is %GWY_MASK_IGNORE.  Conversely, it will return %GWY_MASK_IGNORE if @mask is a pointer to %NULL data
 * field.  In short, if a @mask argument is passed a non-ignore masking mode is guaranteed to coincide with non-%NULL
 * mask.
 *
 * Returns: The masking enum parameter value.
 *
 * Since: 2.59
 **/
GwyMaskingType
gwy_params_get_masking(GwyParams *params,
                       gint id,
                       GwyDataField **mask)
{
    GwyMaskingType masking;

    masking = get_enum_internal(params, id, GWY_TYPE_MASKING_TYPE, GWY_MASK_IGNORE);
    if (!mask)
        return masking;

    if (*mask && masking == GWY_MASK_IGNORE)
        *mask = NULL;
    else if (!*mask)
        masking = GWY_MASK_IGNORE;

    return masking;
}

/**
 * gwy_params_set_enum:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a generic enum parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * This function can only be used with plain enum parameters defined by gwy_param_def_add_gwyenum() or
 * gwy_param_def_add_enum().  More complex/specific parameters need to be set using dedicated setters.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_enum(GwyParams *params,
                    gint id,
                    gint value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_ENUM))
        return FALSE;
    return set_enum_value(params->priv->values + i, def, value);
}

/**
 * gwy_params_get_flags:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the value of a flags parameter.
 *
 * This function can be used with any flags-valued parameter, even if it is more complex/specific than a plain
 * flag set.
 *
 * Returns: The fags parameter value.
 *
 * Since: 2.59
 **/
guint
gwy_params_get_flags(GwyParams *params,
                     gint id)
{
    return get_flags_internal(params, id, 0);
}

/**
 * gwy_params_set_flags:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a generic flags parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * This function can only be used with plain flags parameters defined by gwy_param_def_add_gwyflags().  More
 * complex/specific parameters need to be set using dedicated setters.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_flags(GwyParams *params,
                     gint id,
                     guint value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_FLAGS))
        return FALSE;
    return set_flags_value(params->priv->values + i, def, value);
}

/**
 * gwy_params_set_flag:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 * @flag: The flag bit to set or unset (it can be actually a flag combination).
 * @value: %TRUE to set the flag, %FALSE to unset the flag.
 *
 * Modifies the value of a generic flags parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * This function can only be used with plain flags parameters defined by gwy_param_def_add_gwyflags().  More
 * complex/specific parameters need to be set using dedicated setters.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_flag(GwyParams *params,
                    gint id,
                    guint flag,
                    gboolean value)
{
    const GwyParamDefItem *def;
    guint u;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_FLAGS))
        return FALSE;
    u = params->priv->values[i].u;
    if (value)
        u |= flag;
    else
        u &= ~flag;

    return set_flags_value(params->priv->values + i, def, u);
}

/**
 * gwy_params_get_report_type:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the value of a report type parameter.
 *
 * This function can only be used with a parameter defined by gwy_param_def_add_report_type().
 *
 * Returns: The report type parameter value.
 *
 * Since: 2.59
 **/
GwyResultsReportType
gwy_params_get_report_type(GwyParams *params,
                           gint id)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_REPORT_TYPE))
        return GWY_RESULTS_REPORT_COLON | GWY_RESULTS_REPORT_MACHINE;
    return params->priv->values[i].rt;
}

/**
 * gwy_params_set_report_type:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a report type parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * This function can only be used with parameters defined by gwy_param_def_add_report_type().
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_report_type(GwyParams *params,
                           gint id,
                           GwyResultsReportType value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_REPORT_TYPE))
        return FALSE;
    return set_report_type_value(params->priv->values + i, def, value);
}

/**
 * gwy_params_get_double:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the value of a floating point parameter.
 *
 * This function can be used with any double-valued parameter, even if it is more complex/specific than a plain
 * double.
 *
 * Returns: The floating point parameter value.
 *
 * Since: 2.59
 **/
gdouble
gwy_params_get_double(GwyParams *params,
                      gint id)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_DOUBLE))
        return 0.0;
    return params->priv->values[i].d;
}

/**
 * gwy_params_set_double:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a plain floating point parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * This function can only be used with plain floating point parameters defined by gwy_param_def_add_double() and
 * simple transformed parameters such as gwy_param_def_add_angle() or gwy_param_def_add_percentage().  More
 * complex/specific parameters need to be set using dedicated setters.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_double(GwyParams *params,
                      gint id,
                      gdouble value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_DOUBLE))
        return FALSE;
    return set_double_value(params->priv->values + i, def, value);
}

/**
 * gwy_params_get_string:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the value of a string parameter.
 *
 * This function can be used with any string-valued parameter (for instance units and resource names), even if it is
 * more complex/specific than a plain string.
 *
 * Returns: The string parameter value.  It is owned by @params and it is only guaranteed to be valid until the
 *          parameter change (or the object is destroyed).
 *
 * Since: 2.59
 **/
const gchar*
gwy_params_get_string(GwyParams *params,
                      gint id)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_NONE))
        return "";
    if (def->type == GWY_PARAM_STRING || def->type == GWY_PARAM_RESOURCE)
        return params->priv->values[i].s;
    if (def->type == GWY_PARAM_UNIT)
        return params->priv->values[i].si.s;
    if (param_type_is_curve_no(def->type))
        return params->priv->values[i].cu.s;
    g_return_val_if_reached("");
}

/**
 * gwy_params_set_string:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a string parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_string(GwyParams *params,
                      gint id,
                      const gchar *value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_NONE))
        return FALSE;
    if (def->type == GWY_PARAM_STRING)
        return set_string_value(params->priv->values + i, def, value);
    if (param_type_is_curve_no(def->type))
        return set_curve_string_value(params->priv->values + i, def, value);
    g_assert_not_reached();
    return FALSE;
}

/**
 * gwy_params_set_unit:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a unit parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_unit(GwyParams *params,
                    gint id,
                    const gchar *value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_UNIT))
        return FALSE;
    return set_unit_value(params->priv->values + i, def, value);
}

/**
 * gwy_params_get_unit:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @power10: Location where to store the power of 10 (or %NULL).
 *
 * Gets an SI unit object for a unit parameter.
 *
 * Use gwy_params_get_string() if you simply want the unit string.
 *
 * The returned object is not guaranteed to be updated automatically when the parameter changes.  It must not be
 * assumed it will persist past the destruction of @params.  Briefly, do not keep it around.
 *
 * Returns: An SI unit, owned by @params.  It must not be modified nor freed.
 *
 * Since: 2.59
 **/
GwySIUnit*
gwy_params_get_unit(GwyParams *params,
                    gint id,
                    gint *power10)
{
    GwyParamValueUnit *si;
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_UNIT)) {
        if (power10)
            *power10 = 10;
        /* This is a leak.  On a failed assertion, we do not care. */
        return gwy_si_unit_new(NULL);
    }

    si = &params->priv->values[i].si;
    if (!si->cached_valid) {
        if (!si->cached_unit)
            si->cached_unit = gwy_si_unit_new(NULL);
        gwy_si_unit_set_from_string_parse(si->cached_unit, si->s, &si->cached_power10);
        si->cached_valid = TRUE;
    }
    if (power10)
        *power10 = si->cached_power10;
    return si->cached_unit;
}

/**
 * gwy_params_get_color:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 *
 * Gets the value of a colour parameter.
 *
 * Returns: The colour parameter value.
 *
 * Since: 2.59
 **/
GwyRGBA
gwy_params_get_color(GwyParams *params,
                     gint id)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_COLOR)) {
        GwyRGBA color = gwy_param_fallback_color;
        return color;
    }
    return params->priv->values[i].c;
}

/**
 * gwy_params_set_color:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a colour parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_color(GwyParams *params,
                     gint id,
                     GwyRGBA value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_COLOR))
        return FALSE;
    return set_color_value(params->priv->values + i, def, value);
}

/**
 * gwy_params_get_data_id:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the value of a data identifier parameter.
 *
 * This function can be used with any specific identifier-valued parameter, even though they have dedicated creators
 * and setters.
 *
 * Returns: The data identifier parameter value.
 *
 * Since: 2.59
 **/
GwyAppDataId
gwy_params_get_data_id(GwyParams *params,
                       gint id)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_NONE))
        return noid;
    g_return_val_if_fail(param_type_is_data_id(def->type), noid);
    return params->priv->values[i].di;
}

/**
 * gwy_params_data_id_is_none:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Checks if data identifier parameter is set to no-data.
 *
 * This convenience function can be used with any specific identifier-valued parameter.
 *
 * Returns: %TRUE if the data identifier parameter is no-data and gwy_params_get_data_id() would return
 *          %GWY_APP_DATA_ID_NONE; %FALSE otherwise if some real data object is selected.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_data_id_is_none(GwyParams *params,
                           gint id)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_NONE))
        return TRUE;
    g_return_val_if_fail(param_type_is_data_id(def->type), TRUE);
    return params->priv->values[i].di.datano < 1 || params->priv->values[i].di.id < 0;
}

/**
 * gwy_params_get_image:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the data field object for an image identifier parameter.
 *
 * This is a more convenient alternative to gwy_params_get_data_id() since it fetches and checks the object.
 *
 * Returns: The image data field, or %NULL if the parameter is none (or the image no longer exists).
 *
 * Since: 2.59
 **/
GwyDataField*
gwy_params_get_image(GwyParams *params,
                     gint id)
{
    return get_data_object(params, id, GWY_PARAM_IMAGE_ID, gwy_app_get_data_key_for_id, GWY_TYPE_DATA_FIELD);
}

/**
 * gwy_params_get_mask:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the data field object for an mask identifier parameter.
 *
 * This is a more convenient alternative to gwy_params_get_data_id() since it fetches and checks the object.
 *
 * Returns: The mask data field, or %NULL if the parameter is none (or the image no longer exists).
 *
 * Since: 2.59
 **/
GwyDataField*
gwy_params_get_mask(GwyParams *params,
                    gint id)
{
    return get_data_object(params, id, GWY_PARAM_IMAGE_ID, gwy_app_get_mask_key_for_id, GWY_TYPE_DATA_FIELD);
}

/**
 * gwy_params_get_graph:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the graph model object for a graph identifier parameter.
 *
 * This is a more convenient alternative to gwy_params_get_data_id() since it fetches and checks the object.
 *
 * Returns: The graph model of the graph, or %NULL if the parameter is none (or the graph no longer exists).
 *
 * Since: 2.59
 **/
GwyGraphModel*
gwy_params_get_graph(GwyParams *params,
                     gint id)
{
    return get_data_object(params, id, GWY_PARAM_GRAPH_ID, gwy_app_get_graph_key_for_id, GWY_TYPE_GRAPH_MODEL);
}

/**
 * gwy_params_get_volume:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the brick object for a volume data identifier parameter.
 *
 * This is a more convenient alternative to gwy_params_get_data_id() since it fetches and checks the object.
 *
 * Returns: The volume data brick, or %NULL if the parameter is none (or the volume data no longer exist).
 *
 * Since: 2.59
 **/
GwyBrick*
gwy_params_get_volume(GwyParams *params,
                      gint id)
{
    return get_data_object(params, id, GWY_PARAM_VOLUME_ID, gwy_app_get_brick_key_for_id, GWY_TYPE_BRICK);
}

/**
 * gwy_params_get_xyz:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the surface object for a xyz data identifier parameter.
 *
 * This is a more convenient alternative to gwy_params_get_data_id() since it fetches and checks the object.
 *
 * Returns: The xyz data surface, or %NULL if the parameter is none (or the xyz data no longer exist).
 *
 * Since: 2.59
 **/
GwySurface*
gwy_params_get_xyz(GwyParams *params,
                   gint id)
{
    return get_data_object(params, id, GWY_PARAM_XYZ_ID, gwy_app_get_surface_key_for_id, GWY_TYPE_SURFACE);
}

/**
 * gwy_params_get_curve_map:
 * @params: A parameter value set.
 * @id: Parameter identifier.
 *
 * Gets the lawn object for a curve map data identifier parameter.
 *
 * This is a more convenient alternative to gwy_params_get_data_id() since it fetches and checks the object.
 *
 * Returns: The curve map data lawn, or %NULL if the parameter is none (or the curve map data no longer exist).
 *
 * Since: 2.60
 **/
GwyLawn*
gwy_params_get_curve_map(GwyParams *params,
                         gint id)
{
    return get_data_object(params, id, GWY_PARAM_CURVE_MAP_ID, gwy_app_get_lawn_key_for_id, GWY_TYPE_LAWN);
}

/**
 * gwy_params_set_image_id:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of an image identifier parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * If @value is not %GWY_APP_DATA_ID_NONE then the image identified by @value must currently exist.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_image_id(GwyParams *params,
                        gint id,
                        GwyAppDataId value)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_IMAGE_ID))
        return FALSE;
    g_return_val_if_fail((value.datano == 0 && value.id == -1) || gwy_app_data_id_verify_channel(&value), FALSE);
    return set_data_id_value(params->priv->values + i, value);
}

/**
 * gwy_params_set_graph_id:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a graph identifier parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * If @value is not %GWY_APP_DATA_ID_NONE then the graph identified by @value must currently exist.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_graph_id(GwyParams *params,
                        gint id,
                        GwyAppDataId value)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_GRAPH_ID))
        return FALSE;
    g_return_val_if_fail((value.datano == 0 && value.id == -1) || gwy_app_data_id_verify_graph(&value), FALSE);
    return set_data_id_value(params->priv->values + i, value);
}

/**
 * gwy_params_set_volume_id:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a volume data identifier parameter.
 *
 * If @value is not %GWY_APP_DATA_ID_NONE then the volume data identified by @value must currently exist.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_volume_id(GwyParams *params,
                         gint id,
                         GwyAppDataId value)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_VOLUME_ID))
        return FALSE;
    g_return_val_if_fail((value.datano == 0 && value.id == -1) || gwy_app_data_id_verify_volume(&value), FALSE);
    return set_data_id_value(params->priv->values + i, value);
}

/**
 * gwy_params_set_xyz_id:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of an xyz data identifier parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * If @value is not %GWY_APP_DATA_ID_NONE then the XYZ data identified by @value must currently exist.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_xyz_id(GwyParams *params,
                      gint id,
                      GwyAppDataId value)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_XYZ_ID))
        return FALSE;
    g_return_val_if_fail((value.datano == 0 && value.id == -1) || gwy_app_data_id_verify_xyz(&value), FALSE);
    return set_data_id_value(params->priv->values + i, value);
}

/**
 * gwy_params_set_curve_map_id:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a curve map data identifier parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * If @value is not %GWY_APP_DATA_ID_NONE then the curve map data identified by @value must currently exist.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.60
 **/
gboolean
gwy_params_set_curve_map_id(GwyParams *params,
                            gint id,
                            GwyAppDataId value)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, GWY_PARAM_CURVE_MAP_ID))
        return FALSE;
    g_return_val_if_fail((value.datano == 0 && value.id == -1) || gwy_app_data_id_verify_curve_map(&value), FALSE);
    return set_data_id_value(params->priv->values + i, value);
}

/**
 * gwy_params_set_curve:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @value: Value to set (a non-negative integer or -1).
 *
 * Sets the value of a graph or lawn curve number parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.60
 **/
gboolean
gwy_params_set_curve(GwyParams *params,
                     gint id,
                     gint value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_NONE))
        return FALSE;
    g_return_val_if_fail(param_type_is_curve_no(def->type), FALSE);
    return set_curve_int_value(params->priv->values + i, def, value);
}

/**
 * gwy_params_randomize_seed:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 *
 * Randomizes the value of a random seed parameter.
 *
 * You can use gwy_params_get_int() any number of times afterwards and obtain the same value.
 *
 * This function is seldom needed.  See the introduction for discussion.  In the usual setup the seed is randomised
 * when loaded from settings if the controlling randomization boolean is %TRUE.  Furthermore, #GwyParamTable knows to
 * randomize the seed when the randomization button is pressed.
 *
 * Returns: The new random seed value (for convenience).
 *
 * Since: 2.59
 **/
gint
gwy_params_randomize_seed(GwyParams *params,
                          gint id)
{
    const GwyParamDefItem *def;
    gint i, seed;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_RANDOM_SEED))
        return 42;
    seed = g_random_int() & 0x7fffffff;
    set_random_seed_value(params->priv->values + i, def, seed);
    return seed;
}

/**
 * gwy_params_set_resource:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 * @value: Value to set.
 *
 * Sets the value of a resource name parameter.
 *
 * This function is seldom needed.  See the introduction for discussion.
 *
 * Returns: %TRUE if parameter value has changed.
 *
 * Since: 2.59
 **/
gboolean
gwy_params_set_resource(GwyParams *params,
                        gint id,
                        const gchar *value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_RESOURCE))
        return FALSE;
    return set_resource_value(params->priv->values + i, def, value);
}

/**
 * gwy_params_get_resource:
 * @params: A set of parameter values.
 * @id: Parameter identifier.
 *
 * Gets the resource object of a resource name parameter.
 *
 * Use gwy_params_get_string() to get the resource name instead of the object.
 *
 * Returns: The resource object corresponding to the parameter value.  A default value is returned if the resource
 *          does not exist.
 *
 * Since: 2.61
 **/
GwyResource*
gwy_params_get_resource(GwyParams *params,
                        gint id)
{
    const GwyParamDefItem *def;
    gpointer item;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_RESOURCE))
        return NULL;
    /* Fall back first to the parameter default, then to rhe resource default. */
    if (!(item = gwy_inventory_get_item(def->def.res.inventory, params->priv->values[i].s)))
        item = gwy_inventory_get_item_or_default(def->def.res.inventory, def->def.res.default_value);
    return item;
}

static gboolean
set_boolean_value(GwyParamValue *pvalue, gboolean value)
{
    if (!pvalue->b ^ !value) {
        pvalue->b = !!value;
        return TRUE;
    }
    return FALSE;
}

static gboolean
set_int_value(GwyParamValue *pvalue, const GwyParamDefItem *def, gint value)
{
    gint goodvalue = _gwy_param_def_rectify_int(def, value);

    if (value != goodvalue) {
        g_warning("Value %d is not in the range of int id=%d.", value, def->id);
    }
    if (pvalue->i == goodvalue)
        return FALSE;
    pvalue->i = goodvalue;
    return TRUE;
}

static gboolean
set_random_seed_value(GwyParamValue *pvalue, const GwyParamDefItem *def, gint value)
{
    gint goodvalue = _gwy_param_def_rectify_random_seed(def, value);

    if (value != goodvalue) {
        g_warning("Value %d is not in the range of random seed id=%d.", value, def->id);
    }
    if (pvalue->i == goodvalue)
        return FALSE;
    pvalue->i = goodvalue;
    return TRUE;
}

static gboolean
set_double_value(GwyParamValue *pvalue, const GwyParamDefItem *def, gdouble value)
{
    gdouble goodvalue = _gwy_param_def_rectify_double(def, value);

    if (fabs(value - goodvalue) > 1e-14*(fabs(value) + fabs(goodvalue))) {
        g_warning("Value %.14g is not in the range of double id=%d.", value, def->id);
    }
    if (pvalue->d == goodvalue)
        return FALSE;
    pvalue->d = goodvalue;
    return TRUE;
}

static gboolean
set_enum_value(GwyParamValue *pvalue, const GwyParamDefItem *def, gint value)
{
    gint goodvalue;

    goodvalue = _gwy_param_def_rectify_enum(def, value);
    if (value != goodvalue) {
        g_warning("Value %d is not in enum id=%d.", value, def->id);
    }
    if (pvalue->i == goodvalue)
        return FALSE;
    pvalue->i = goodvalue;
    return TRUE;
}

static gboolean
set_flags_value(GwyParamValue *pvalue, const GwyParamDefItem *def, guint value)
{
    gint goodvalue;

    goodvalue = _gwy_param_def_rectify_flags(def, value);
    if (value != goodvalue) {
        g_warning("Value %u is not in flags id=%d.", value, def->id);
    }
    if (pvalue->u == goodvalue)
        return FALSE;
    pvalue->u = goodvalue;
    return TRUE;
}

static gboolean
set_report_type_value(GwyParamValue *pvalue, const GwyParamDefItem *def, GwyResultsReportType value)
{
    GwyResultsReportType goodvalue;

    goodvalue = _gwy_param_def_rectify_report_type(def, value);
    if (value != goodvalue) {
        g_warning("Value %u is not in report type id=%d.", value, def->id);
    }
    if (pvalue->rt == goodvalue)
        return FALSE;
    pvalue->rt = goodvalue;
    return TRUE;
}

static gboolean
set_string_value(GwyParamValue *pvalue, const GwyParamDefItem *def, const gchar *value)
{
    gchar *rectified = _gwy_param_def_rectify_string(def, value);

    if (!g_strcmp0(pvalue->s, rectified)) {
        g_free(rectified);
        return FALSE;
    }
    g_free(pvalue->s);
    pvalue->s = rectified;
    return TRUE;
}

static gboolean
set_curve_string_value(GwyParamValue *pvalue, const GwyParamDefItem *def, const gchar *value)
{
    g_return_val_if_fail(param_type_is_curve_no(def->type), FALSE);
    pvalue->cu.use_string = TRUE;
    return gwy_assign_string(&pvalue->cu.s, value);
}

static gboolean
set_curve_int_value(GwyParamValue *pvalue, const GwyParamDefItem *def, gint value)
{
    gint goodvalue = MAX(value, 0);
    if (value != goodvalue) {
        g_warning("Value %d is not a valid curve number in id=%d.", value, def->id);
        return FALSE;
    }
    pvalue->cu.use_string = FALSE;
    if (pvalue->cu.i == value)
        return FALSE;
    pvalue->cu.i = value;
    return TRUE;
}

gboolean
_gwy_params_curve_get_use_string(GwyParams *params, gint id)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_NONE))
        return 0;
    g_return_val_if_fail(param_type_is_curve_no(def->type), FALSE);
    return params->priv->values[i].cu.use_string;
}

static gboolean
set_unit_value(GwyParamValue *pvalue, const GwyParamDefItem *def, const gchar *value)
{
    gchar *rectified = _gwy_param_def_rectify_unit(def, value);

    if (!g_strcmp0(pvalue->si.s, rectified)) {
        g_free(rectified);
        return FALSE;
    }
    g_free(pvalue->s);
    pvalue->si.s = rectified;
    pvalue->si.cached_valid = FALSE;
    return TRUE;
}

static gboolean
set_color_value(GwyParamValue *pvalue, const GwyParamDefItem *def, GwyRGBA value)
{
    GwyRGBA goodvalue = _gwy_param_def_rectify_color(def, value);
    GwyRGBA *rgba;

    if (value.r != goodvalue.r || value.g != goodvalue.g || value.b != goodvalue.b) {
        g_warning("Color component values are not in the allowed range of color id=%d.", def->id);
    }
    if (def->def.c.has_alpha && value.a != goodvalue.a) {
        g_warning("Alpha value is not in the allowed range of color id=%d.", def->id);
    }
    rgba = &pvalue->c;
    if (rgba->r == goodvalue.r && rgba->g == goodvalue.b && rgba->b == goodvalue.b && rgba->a == goodvalue.a)
        return FALSE;
    pvalue->c = goodvalue;
    return TRUE;
}

static gboolean
set_data_id_value(GwyParamValue *pvalue, GwyAppDataId value)
{
    /* Caller verifies.  Just check if the value has changed. */
    if (pvalue->di.datano == value.datano && pvalue->di.id == value.id)
        return FALSE;
    pvalue->di = value;
    return TRUE;
}

static gboolean
set_resource_value(GwyParamValue *pvalue, const GwyParamDefItem *def, const gchar *value)
{
    const gchar *goodvalue = _gwy_param_def_rectify_resource(def, value);

    if (g_strcmp0(goodvalue, value)) {
        g_warning("Resource name does not correspond to any item in the inventory for id=%d.", def->id);
    }
    /* The empty inventory case is odd and should not normally happen. */
    return gwy_assign_string(&pvalue->s, goodvalue);
}

static gint
get_enum_internal(GwyParams *params,
                  gint id,
                  GType type,
                  gint fallback_value)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_ENUM))
        return fallback_value;
    if (type) {
        g_return_val_if_fail(def->def.e.gtype == type, fallback_value);
    }
    return params->priv->values[i].i;
}

static guint
get_flags_internal(GwyParams *params,
                   gint id,
                   GType type)
{
    const GwyParamDefItem *def;
    gint i;

    if (!param_find_common(params, id, &i, &def, GWY_PARAM_FLAGS))
        return 0;
    if (type) {
        g_return_val_if_fail(def->def.f.gtype == type, 0);
    }
    return params->priv->values[i].u;
}

static gboolean
reset_param_value(GwyParams *params, guint i)
{
    GwyParamsPrivate *priv = params->priv;
    const GwyParamDefItem *def = _gwy_param_def_item(priv->def, i);
    GwyParamValue *value = priv->values + i;
    GwyParamType type = def->type;

    /* Here we check again the validity of default values which should not be necessary.  But well… */
    if (type == GWY_PARAM_BOOLEAN)
        return set_boolean_value(value, def->def.b.default_value);
    if (type == GWY_PARAM_INT)
        return set_int_value(value, def, def->def.i.default_value);
    if (type == GWY_PARAM_ENUM)
        return set_enum_value(value, def, def->def.e.table[def->def.e.default_value_index].value);
    if (type == GWY_PARAM_FLAGS)
        return set_flags_value(value, def, def->def.f.default_value);
    if (type == GWY_PARAM_REPORT_TYPE)
        return set_report_type_value(value, def, def->def.rt.default_value);
    if (type == GWY_PARAM_RANDOM_SEED) {
        gwy_params_randomize_seed(params, def->id);
        return TRUE;
    }
    if (type == GWY_PARAM_ACTIVE_PAGE)
        return set_int_value(value, def, 0);
    if (type == GWY_PARAM_DOUBLE)
        return set_double_value(value, def, def->def.d.default_value);
    if (type == GWY_PARAM_STRING)
        return set_string_value(value, def, def->def.s.default_value);
    if (type == GWY_PARAM_UNIT)
        return set_unit_value(value, def, def->def.si.default_value);
    if (type == GWY_PARAM_RESOURCE)
        return set_resource_value(value, def, def->def.res.default_value);
    if (type == GWY_PARAM_COLOR)
        return set_color_value(value, def, def->def.c.default_value);
    if (param_type_is_data_id(type))
        return set_data_id_value(value, noid);
    if (param_type_is_curve_no(type))
        return set_curve_int_value(value, def, def->def.i.default_value);
    g_return_val_if_reached(FALSE);
}

static gboolean
assign_parameter_value(GwyParamValue *value, const GwyParamDefItem *def, GwyParamValue *src)
{
    GwyParamType type = def->type;

    if (type == GWY_PARAM_BOOLEAN)
        return set_boolean_value(value, src->b);
    if (type == GWY_PARAM_INT)
        return set_int_value(value, def, src->i);
    if (type == GWY_PARAM_ENUM)
        return set_enum_value(value, def, src->i);
    if (type == GWY_PARAM_FLAGS)
        return set_flags_value(value, def, src->u);
    if (type == GWY_PARAM_REPORT_TYPE)
        return set_report_type_value(value, def, src->u);
    if (type == GWY_PARAM_RANDOM_SEED)
        return set_random_seed_value(value, def, src->i);
    if (type == GWY_PARAM_ACTIVE_PAGE)
        return set_int_value(value, def, src->i);
    if (type == GWY_PARAM_DOUBLE)
        return set_double_value(value, def, src->d);
    if (type == GWY_PARAM_STRING)
        return set_string_value(value, def, src->s);
    if (type == GWY_PARAM_UNIT)
        return set_unit_value(value, def, src->si.s);
    if (type == GWY_PARAM_RESOURCE)
        return set_resource_value(value, def, src->s);
    if (type == GWY_PARAM_COLOR)
        return set_color_value(value, def, src->c);
    if (param_type_is_data_id(type))
        return set_data_id_value(value, src->di);
    if (param_type_is_curve_no(type)) {
        if (src->cu.use_string)
            return set_curve_string_value(value, def, src->cu.s);
        return set_curve_int_value(value, def, src->cu.i);
    }
    g_return_val_if_reached(FALSE);
}

/* This also works for curve parameters, by getting the parent object. */
static gpointer
get_data_object(GwyParams *params, gint id,
                GwyParamType param_type, GQuark (*get_key_func)(gint id), GType object_type)
{
    gint i;

    if (!param_find_common(params, id, &i, NULL, param_type))
        return NULL;
    return get_data_object_for_id(params->priv->values[i].di, get_key_func, object_type);
}

static gpointer
get_data_object_for_id(GwyAppDataId dataid, GQuark (*get_key_func)(gint id), GType object_type)
{
    GwyContainer *container;
    GObject *object;

    if (dataid.datano < 1
        || dataid.id < 0
        || !(container = gwy_app_data_browser_get(dataid.datano))
        || !gwy_container_gis_object(container, get_key_func(dataid.id), &object)
        || !g_type_is_a(G_TYPE_FROM_INSTANCE(object), object_type))
        return NULL;
    return object;
}

/* Only called when it should not fail.  So make assertions on behalf of the caller. */
static inline gboolean
param_find_common(GwyParams *params, gint id, gint *i, const GwyParamDefItem **def,
                  GwyParamType want_type)
{
    const GwyParamDefItem *mydef;
    GwyParamsPrivate *priv;

    g_return_val_if_fail(GWY_IS_PARAMS(params), FALSE);
    priv = params->priv;
    *i = _gwy_param_def_index(priv->def, id);
    g_return_val_if_fail(*i >= 0 && *i < priv->nvalues, FALSE);
    mydef = _gwy_param_def_item(priv->def, *i);
    if (want_type != GWY_PARAM_NONE && mydef->type != want_type) {
        g_warning("Parameter with id %u has type %d, not %d.", id, mydef->type, want_type);
        return FALSE;
    }
    if (def)
        *def = mydef;
    return TRUE;
}

/* NB: This keeps both data id and curve id parameter values.  This is OK as long as modules do not try something
 * silly.  Then we can get mixed DataId and CurveId params – and probably crash. */
static GHashTable*
ensure_data_ids(void)
{
    static GHashTable* data_ids = NULL;          /* Threads: protected by lock */

    if (!data_ids)
        data_ids = g_hash_table_new(g_direct_hash, g_direct_equal);

    return data_ids;
}

static void
append_escaped_string(GString *str, const gchar *s)
{
    gchar *escaped = gwy_utf8_strescape(s, NULL);

    g_string_append_c(str, '"');
    g_string_append(str, escaped);
    g_string_append_c(str, '"');
    g_free(escaped);
}

static void
append_double(GString *str, gdouble d)
{
    gchar dbuf[G_ASCII_DTOSTR_BUF_SIZE];

    g_ascii_dtostr(dbuf, sizeof(dbuf), d);
    g_string_append(str, dbuf);
}

static gchar*
replace_suffix(const gchar *s, const gchar *suffix, const gchar *newsuffix)
{
    guint len = strlen(s), slen = strlen(suffix), nlen;
    gchar *t;

    if (slen > len || strcmp(s + len - slen, suffix))
        return NULL;

    nlen = strlen(newsuffix);
    t = g_new(gchar, len+1 + nlen - slen);
    memcpy(t, s, len-slen);
    memcpy(t + len-slen, newsuffix, nlen+1);
    return t;
}

void
_gwy_params_dump_to_string(GwyParams *params, GString *str)
{
    GwyParamsPrivate *priv;
    guint i;

    g_return_if_fail(GWY_IS_PARAMS(params));
    priv = params->priv;
    g_assert(priv->nvalues == _gwy_param_def_size(priv->def));
    for (i = 0; i < priv->nvalues; i++) {
        const GwyParamDefItem *def = _gwy_param_def_item(priv->def, i);
        const GwyParamValue *value = priv->values + i;
        const gchar *name = def->name;
        GwyParamType type = def->type;
        gchar *t;

        /* Silent skips. Parameters without name are not meant to be stored. Data id parameters are not mean to be
         * stored either – but there is nothing wrong with having them. */
        if (!name || param_type_is_data_id(type))
            continue;

        /* Warninigs. */
        if (!gwy_strisident(name, "-_/", NULL)) {
            g_warning("Parameter %s has non-identifier name.", name);
            continue;
        }

        g_string_append(str, name);
        g_string_append_c(str, ' ');

        if (type == GWY_PARAM_BOOLEAN)
            g_string_append_printf(str, "%d", value->b);
        else if (type == GWY_PARAM_INT || type == GWY_PARAM_ENUM
                 || type == GWY_PARAM_RANDOM_SEED || type == GWY_PARAM_ACTIVE_PAGE)
            g_string_append_printf(str, "%d", value->i);
        else if (type == GWY_PARAM_FLAGS)
            g_string_append_printf(str, "%u", value->u);
        else if (type == GWY_PARAM_REPORT_TYPE)
            g_string_append_printf(str, "%u", value->rt);
        else if (param_type_is_curve_no(type)) {
            if (value->cu.use_string)
                append_escaped_string(str, value->cu.s);
            else
                g_string_append_printf(str, "%d", value->cu.i);
        }
        else if (type == GWY_PARAM_DOUBLE)
            append_double(str, value->d);
        else if (type == GWY_PARAM_STRING || type == GWY_PARAM_RESOURCE)
            append_escaped_string(str, value->s);
        else if (type == GWY_PARAM_UNIT)
            append_escaped_string(str, value->si.s);
        else if (type == GWY_PARAM_COLOR) {
            append_double(str, value->c.r);
            g_string_append_c(str, ' ');
            append_double(str, value->c.g);
            g_string_append_c(str, ' ');
            append_double(str, value->c.b);

            /* XXX: This is how we historically did it. */
            if (def->def.c.has_alpha) {
                if ((t = replace_suffix(name, "_color", "_opacity"))) {
                    g_string_append_printf(str, "\n%s ", t);
                    append_double(str, value->c.a);
                    g_free(t);
                }
                else {
                    g_warning("Cannot figure out corresponding opacity name for %s.", name);
                }
            }
        }
        else {
            g_assert_not_reached();
            g_string_append(str, "0");
        }
        g_string_append_c(str, '\n');
    }
}

static gboolean
unescape_string(gchar *s, gchar **target)
{
    guint len = (s ? strlen(s) : 0);
    gchar *unescaped;

    if (len < 2 || s[0] != '"' || s[len-1] != '"')
        return FALSE;

    s[len-1] = '\0';
    unescaped = g_strcompress(s+1);
    gwy_assign_string(target, unescaped);
    g_free(unescaped);

    return TRUE;
}

void
_gwy_params_parse_string(GwyParams *params, const gchar *text, GHashTable *parmap)
{
    gchar *s, *line, *p;
    guint i, n;
    GwyParamsPrivate *priv;

    g_return_if_fail(GWY_IS_PARAMS(params));
    priv = params->priv;
    g_assert(priv->nvalues == _gwy_param_def_size(priv->def));

    p = s = g_strdup(text);
    n = priv->nvalues;
    while ((line = gwy_str_next_line(&p))) {
        gchar *key, *val, *end, *altkey = NULL, *ustr = NULL;
        const GwyParamDefItem *def;
        GwyParamValue *parvalue;
        GwyParamType type;

        g_strstrip(line);
        key = line;
        if (!*key)
            continue;
        val = strchr(key, ' ');
        if (val) {
            *val = '\0';
            val++;
            g_strstrip(val);
        }
        if (!val || !*val) {
            g_warning("Missing val for `%s'.", key);
            continue;
        }

        i = GPOINTER_TO_UINT(g_hash_table_lookup(parmap, (gpointer)key));
        if (!i) {
            if ((altkey = replace_suffix(key, "_opacity", "_color")))
                i = GPOINTER_TO_UINT(g_hash_table_lookup(parmap, (gpointer)altkey));
            if (!i) {
                g_warning("Unknown parameter `%s'.", key);
                GWY_FREE(altkey);
                continue;
            }
        }
        i--;
        g_return_if_fail(i < n);

        def = _gwy_param_def_item(priv->def, i);
        parvalue = priv->values + i;
        type = def->type;

        if (type == GWY_PARAM_BOOLEAN)
            set_boolean_value(parvalue, !!atoi(val));
        else if (type == GWY_PARAM_INT || type == GWY_PARAM_ACTIVE_PAGE)
            set_int_value(parvalue, def, atoi(val));
        else if (type == GWY_PARAM_ENUM)
            set_enum_value(parvalue, def, atoi(val));
        else if (type == GWY_PARAM_RANDOM_SEED)
            set_random_seed_value(parvalue, def, atoi(val));
        else if (type == GWY_PARAM_FLAGS) {
            guint u;
            if (sscanf(val, "%u", &u))
                set_flags_value(parvalue, def, u);
        }
        else if (type == GWY_PARAM_REPORT_TYPE)
            set_report_type_value(parvalue, def, atoi(val));
        else if (param_type_is_data_id(type)) {
            g_warning("Trying to restore a data id type parameter %s.", def->name);
        }
        else if (param_type_is_curve_no(type)) {
            if (unescape_string(val, &ustr)) {
                set_curve_string_value(parvalue, def, ustr);
                GWY_FREE(ustr);
            }
            else
                set_curve_int_value(parvalue, def, atoi(val));
        }
        else if (type == GWY_PARAM_DOUBLE)
            set_double_value(parvalue, def, g_ascii_strtod(val, NULL));
        else if (type == GWY_PARAM_STRING || type == GWY_PARAM_RESOURCE || type == GWY_PARAM_UNIT) {
            if (unescape_string(val, &ustr)) {
                if (type == GWY_PARAM_STRING)
                    set_string_value(parvalue, def, ustr);
                else if (type == GWY_PARAM_RESOURCE)
                    set_resource_value(parvalue, def, ustr);
                else if (type == GWY_PARAM_UNIT)
                    set_unit_value(parvalue, def, ustr);
            }
            GWY_FREE(ustr);
        }
        else if (type == GWY_PARAM_COLOR) {
            GwyRGBA rgba = parvalue->c;

            if (altkey)
                rgba.a = g_ascii_strtod(val, NULL);
            else {
                rgba.r = g_ascii_strtod(val, &end);
                while (g_ascii_isspace(*end))
                    end++;
                val = end;
                rgba.g = g_ascii_strtod(val, &end);
                while (g_ascii_isspace(*end))
                    end++;
                val = end;
                rgba.b = g_ascii_strtod(val, &end);
            }
            set_color_value(parvalue, def, rgba);
        }
        else {
            g_assert_not_reached();
        }

        GWY_FREE(altkey);
    }

    g_free(s);
}

/**
 * SECTION:params
 * @title: GwyParams
 * @short_description: Module parameter value sets
 *
 * #GwyParams represents a set of module parameter values.  Usually it is created by loading the values from settings
 * using gwy_params_new_from_settings().  It can also be created as empty – it is necessary to tie it to a definition
 * set using gwy_params_set_def() then.  In any case, the tie to the definitions is permanent.  If you need parameter
 * value set for different definitions create a new object.
 *
 * #GwyParams is a “dumb” object, replacing a plain C struct holding the parameter values.  Beside making sure
 * parameter values stay in defined ranges, it does not do much.  In particular it does not emit any singals.
 *
 * Each parameter type has its own getters and setters, such as gwy_params_get_boolean() and gwy_params_set_boolean().
 * For a few parameter types there may also be dedicated helper functions such as gwy_params_get_masking() which
 * encapsulate common logic when dealing with these parameter.
 *
 * The setters and reset functions should be seldom needed.  When running module GUI, parameter values should be set
 * by #GwyParamTable functions to ensure the updates cascade as expected.  #GwyParamTable also has a reset function.
 * Setters do not cause any GUI response and, hence, has no place in most modules as they would lead to an
 * inconsistent state.  Sometimes, however, setting parameter values directly can be useful in non-GUI paths which
 * perform extra validation or ensure complex invariants.
 **/

/**
 * GwyParams:
 *
 * Object representing a set of parameter values.
 *
 * The #GwyParams struct contains no public fields.
 *
 * Since: 2.59
 **/

/**
 * GwyParamsClass:
 *
 * Class of parameter value sets.
 *
 * Since: 2.59
 **/

/* vim: set cin columns=120 tw=118 et ts=4 sw=4 cino=>1s,e0,n0,f0,{0,}0,^0,\:1s,=0,g1s,h0,t0,+1s,c3,(0,u0 : */