File: litest.h

package info (click to toggle)
libinput 1.30.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,404 kB
  • sloc: ansic: 104,881; python: 3,570; sh: 183; makefile: 37; cpp: 7
file content (1812 lines) | stat: -rw-r--r-- 51,606 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
/*
 * Copyright © 2013 Red Hat, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#include "config.h"

#include "litest-config.h"

#ifndef LITEST_H
#define LITEST_H

#include <libevdev/libevdev-uinput.h>
#include <libevdev/libevdev.h>
#include <libinput.h>
#include <math.h>
#include <stdarg.h>
#include <stdbool.h>

#include "libinput-private-config.h"
#include "libinput-util.h"
#include "litest-runner.h"
#include "quirks.h"

#define START_TEST(func_)  \
   static enum litest_runner_result func_(const struct litest_runner_test_env *test_env) { \
	int _i _unused_ = test_env->rangeval;

#define END_TEST \
	return LITEST_PASS; \
   }

struct test_device {
	const char *name;
	struct litest_test_device *device;
} __attribute__((aligned(16)));

#define TEST_DEVICE(which, ...) \
	static struct litest_test_device _device; \
	\
	static void _setup(void) { \
		struct litest_device *d = litest_create_device(_device.type); \
		litest_set_current_device(d); \
	} \
	\
	static const struct test_device _test_device \
		__attribute__ ((used)) \
		__attribute__ ((section ("test_device_section"))) = { \
		#which, &_device \
	}; \
	static struct litest_test_device _device = { \
		.setup = _setup, \
		.shortname = #which, \
		.type = which, \
		__VA_ARGS__ \
	};

struct test_collection {
	const char *name;
	void (*setup)(void);
} __attribute__((aligned(16)));

#define TEST_COLLECTION(name_) \
	static void (CONCAT(name_ , __LINE__))(void); \
	static const struct test_collection CONCAT(_test_collection_, __LINE__) \
	__attribute__ ((used)) \
	__attribute__ ((section ("test_collection_section"))) = { \
		#name_, CONCAT(name_, __LINE__) \
	}; \
	static void (CONCAT(name_, __LINE__))(void)

#define litest_mark_test_start() \
	litest_checkpoint("==================== BOILERPLATE END. TEST CONTENT STARTING NOW ====================");

__attribute__((format(printf, 3, 0))) void
_litest_checkpoint(const char *func,
		   int line,
		   const char *color,
		   const char *format,
		   ...);
#define litest_checkpoint(...) \
	_litest_checkpoint(__func__, __LINE__, ANSI_GREEN, __VA_ARGS__)

#define litest_log_group(...) \
	for (bool i_ = ({ \
			litest_checkpoint("🭋🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂 %s:%3d 🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🬂🭀", __func__, __LINE__); \
			litest_checkpoint(" " __VA_ARGS__); true; }); \
		i_; \
		i_ = ({litest_checkpoint("🭦🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭 %s:%3d 🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🬭🭛", __func__, __LINE__);  \
			  false; }))

/**
 * litest itself needs the user_data to store some test-suite-specific
 * information. Tests must not override this pointer, any data they need
 * they can hang off the private pointer in this struct.
 */
struct litest_user_data {
	void *private;
};

void
litest_fail_condition(const char *file,
		      int line,
		      const char *func,
		      const char *condition,
		      const char *message,
		      ...);
void
litest_fail_comparison_int(const char *file,
			   int line,
			   const char *func,
			   const char *operator,
			   int a,
			   int b,
			   const char *astr,
			   const char *bstr);
void
litest_fail_comparison_double(const char *file,
			      int line,
			      const char *func,
			      const char *operator,
			      double a,
			      double b,
			      const char *astr,
			      const char *bstr);
void
litest_fail_comparison_ptr(const char *file,
			   int line,
			   const char *func,
			   const char *comparison);

void
litest_fail_comparison_str(const char *file,
			   int line,
			   const char *func,
			   const char *comparison,
			   const char *operator,
			   const char * astr,
			   const char *bstr);

#define litest_assert(cond) \
	do { \
		if (!(cond)) \
			litest_fail_condition(__FILE__, __LINE__, __func__, \
					      #cond, NULL); \
	} while(0)

#define litest_assert_msg(cond, ...) \
	do { \
		if (!(cond)) \
			litest_fail_condition(__FILE__, __LINE__, __func__, \
					      #cond, __VA_ARGS__); \
	} while(0)

#define litest_assert_not_reached() \
	litest_abort_msg("Triggered unreachable code\n")

#define _litest_abort_msg(file_, line_, func_, ...) do {\
	litest_fail_condition(file_, line_, func_, \
			      "aborting", __VA_ARGS__); \
	abort(); \
} while (0)

#define litest_abort_msg(...) \
	_litest_abort_msg(__FILE__, __LINE__, __func__, __VA_ARGS__)

#define litest_assert_notnull(cond) \
	do { \
		if ((cond) == NULL) \
			litest_fail_condition(__FILE__, __LINE__, __func__, \
					      #cond " != NULL", "\n"); \
	} while(0)

#define litest_assert_comparison_int_(a_, op_, b_) \
	do { \
		__typeof__(a_) _a = a_; \
		__typeof__(b_) _b = b_; \
		if (trunc(_a) != _a || trunc(_b) != _b) \
			litest_abort_msg("litest_assert_int_* used for non-integer value\n"); \
		if (!((_a) op_ (_b))) \
			litest_fail_comparison_int(__FILE__, __LINE__, __func__,\
						   #op_, _a, _b, \
						   #a_, #b_); \
	} while(0)

#define litest_assert_neg_errno_success(a_) \
	do { \
		__typeof__(a_) _a = a_; \
		if (_a < 0) \
			litest_abort_msg("Unexpected negative errno: %d (%s)", _a, strerror(-_a)); \
	} while(0);

#define litest_assert_errno_success(a_) \
	do { \
		__typeof__(a_) _a = a_; \
		__typeof__(a_) _e = errno; \
		if (_a < 0) \
			litest_abort_msg("Unexpected errno: %d (%s)", _e, strerror(_e)); \
	} while(0);

#define litest_assert_comparison_enum_(a_, op_, b_) \
	do { \
		__typeof__(a_) _a = a_; \
		__typeof__(a_) _b = b_; \
		if (!((_a) op_ (_b))) \
			litest_fail_comparison_int(__FILE__, __LINE__, __func__,\
						   #op_, (int)_a, (int)_b, \
						   #a_, #b_); \
	} while(0)

#define litest_assert_enum_eq(a_, b_) \
	litest_assert_comparison_enum_(a_, ==, b_)

#define litest_assert_enum_ne(a_, b_) \
	litest_assert_comparison_enum_(a_, !=, b_)

#define litest_assert_int_eq(a_, b_) \
	litest_assert_comparison_int_(a_, ==, b_)

#define litest_assert_int_ne(a_, b_) \
	litest_assert_comparison_int_(a_, !=, b_)

#define litest_assert_int_lt(a_, b_) \
	litest_assert_comparison_int_(a_, <, b_)

#define litest_assert_int_le(a_, b_) \
	litest_assert_comparison_int_(a_, <=, b_)

#define litest_assert_int_ge(a_, b_) \
	litest_assert_comparison_int_(a_, >=, b_)

#define litest_assert_int_gt(a_, b_) \
	litest_assert_comparison_int_(a_, >, b_)

#define litest_assert_comparison_ptr_(a_, op_, b_) \
	do { \
		__typeof__(a_) _a = a_; \
		__typeof__(b_) _b = b_; \
		if (!((_a) op_ (_b))) \
			litest_fail_comparison_ptr(__FILE__, __LINE__, __func__,\
						   #a_ " " #op_ " " #b_); \
	} while(0)

#define litest_assert_ptr_eq(a_, b_) \
	litest_assert_comparison_ptr_(a_, ==, b_)

#define litest_assert_ptr_ne(a_, b_) \
	litest_assert_comparison_ptr_(a_, !=, b_)

#define litest_assert_ptr_null(a_) \
	litest_assert_comparison_ptr_(a_, ==, NULL)

#define litest_assert_ptr_notnull(a_) \
	litest_assert_comparison_ptr_(a_, !=, NULL)

#define litest_assert_str_eq(a_, b_) \
	do { \
		const char *_a = a_; \
		const char *_b = b_; \
		if (!streq(_a, _b)) \
			litest_fail_comparison_str(__FILE__, __LINE__, __func__,\
						   #a_ " == " #b_, \
						   "==", \
						   _a, _b); \
	} while(0)

#define litest_assert_str_ne(a_, b_) \
	do { \
		const char *_a = a_; \
		const char *_b = b_; \
		if (streq(_a, _b)) \
			litest_fail_comparison_str(__FILE__, __LINE__, __func__,\
						   #a_ " != " #b_, \
						   "!=", \
						   _a, _b); \
	} while(0)

#define litest_assert_str_in(needle_, haystack_) \
	do { \
		const char *_needle = needle_; \
		const char *_haystack = haystack_; \
		if (!strstr(_haystack, _needle)) \
			litest_fail_comparison_str(__FILE__, __LINE__, __func__,\
						   "'" #needle_ "' in: '" #haystack_ "'", \
						   "in", \
						   _needle, _haystack); \
	} while(0)

#define litest_assert_str_not_in(needle_, haystack_) \
	do { \
		const char *_needle = needle_; \
		const char *_haystack = haystack_; \
		if (strstr(_haystack, _needle)) \
			litest_fail_comparison_str(__FILE__, __LINE__, __func__,\
						   "'" #needle_ "' not in: '" #haystack_ "'", \
						   "not in", \
						   _needle, _haystack); \
	} while(0)

#define LITEST_DEFAULT_EPSILON  0.001

#define litest_assert_double_eq_epsilon(a_, b_, epsilon_)\
	do { \
		__typeof__(a_) _a = a_; \
		__typeof__(b_) _b = b_; \
		if (!(fabs((_a) - (_b)) < epsilon_))  \
			litest_fail_comparison_double(__FILE__, __LINE__, __func__,\
						      "==", _a, _b, \
						      #a_, #b_); \
	} while(0)

#define litest_assert_double_ne_epsilon(a_, b_, epsilon_)\
	do { \
		__typeof__(a_) _a = a_; \
		__typeof__(b_) _b = b_; \
		if (!(fabs((_a) - (_b)) > epsilon_))  \
			litest_fail_comparison_double(__FILE__, __LINE__, __func__,\
						      "!=", _a, _b, \
						      #a_, #b_); \
	} while(0)

#define litest_assert_double_gt_epsilon(a_, b_, epsilon_)\
	do { \
		__typeof__(a_) _a = a_; \
		__typeof__(b_) _b = b_; \
		if (!(_a - (epsilon_) > _b))  \
			litest_fail_comparison_double(__FILE__, __LINE__, __func__,\
						      ">", _a, _b, \
						      #a_, #b_); \
	} while(0)

#define litest_assert_double_ge_epsilon(a_, b_, epsilon_)\
	do { \
		__typeof__(a_) _a = a_; \
		__typeof__(b_) _b = b_; \
		if (!(_a > _b || fabs((_a) - (_b)) < epsilon_))  \
			litest_fail_comparison_double(__FILE__, __LINE__, __func__,\
						      ">=", _a, _b, \
						      #a_, #b_); \
	} while(0)

#define litest_assert_double_lt_epsilon(a_, b_, epsilon_)\
	do { \
		__typeof__(a_) _a = a_; \
		__typeof__(b_) _b = b_; \
		if (!(_a < _b - (epsilon_)))  \
			litest_fail_comparison_double(__FILE__, __LINE__, __func__,\
						      "<", _a, _b, \
						      #a_, #b_); \
	} while(0)

#define litest_assert_double_le_epsilon(a_, b_, epsilon_)\
	do { \
		__typeof__(a_) _a = a_; \
		__typeof__(b_) _b = b_; \
		if (!(_a < _b || fabs((_a) - (_b)) < epsilon_))  \
			litest_fail_comparison_double(__FILE__, __LINE__, __func__,\
						      "<=", _a, _b, \
						      #a_, #b_); \
	} while(0)

#define litest_assert_comparison_double_(a_, op_, b_) \
	litest_assert_comparison_double_epsilon_(a_, op_, b_, LITEST_DEFAULT_EPSILON)

#define litest_assert_double_eq(a_, b_)\
	litest_assert_double_eq_epsilon((a_), (b_), LITEST_DEFAULT_EPSILON)

#define litest_assert_double_ne(a_, b_)\
	litest_assert_double_ne_epsilon((a_), (b_),LITEST_DEFAULT_EPSILON)

#define litest_assert_double_lt(a_, b_)\
	litest_assert_double_lt_epsilon((a_), (b_),LITEST_DEFAULT_EPSILON)

#define litest_assert_double_le(a_, b_)\
	litest_assert_double_le_epsilon((a_), (b_),LITEST_DEFAULT_EPSILON)

#define litest_assert_double_gt(a_, b_)\
	litest_assert_double_gt_epsilon((a_), (b_),LITEST_DEFAULT_EPSILON)

#define litest_assert_double_ge(a_, b_)\
	litest_assert_double_ge_epsilon((a_), (b_),LITEST_DEFAULT_EPSILON)

void
_litest_assert_strv_substring(char **strv,
			      char *substring,
			      const char *file,
			      const char *func,
			      int line);

#define litest_assert_strv_substring(strv_, substring_) \
	_litest_assert_strv_substring(strv_, substring_, __FILE__, __func__, __LINE__)

void
_litest_assert_strv_no_substring(char **strv,
				 char *substring,
				 const char *file,
				 const char *func,
				 int line);

#define litest_assert_strv_no_substring(strv_, substring_) \
	_litest_assert_strv_no_substring(strv_, substring_, __FILE__, __func__, __LINE__)

void
litest_backtrace(const char *func);

enum litest_device_type {
	LITEST_NO_DEVICE = -1,
	/* Touchpads and associated devices */
	LITEST_ACER_HAWAII_TOUCHPAD = -1000,
	LITEST_AIPTEK,
	LITEST_ALPS_3FG,
	LITEST_ALPS_DUALPOINT,
	LITEST_ALPS_SEMI_MT,
	LITEST_APPLETOUCH,
	LITEST_ATMEL_HOVER,
	LITEST_BCM5974,
	LITEST_ELANTECH_TOUCHPAD,
	LITEST_GENERIC_PRESSUREPAD,
	LITEST_MAGIC_TRACKPAD,
	LITEST_SYNAPTICS_CLICKPAD_X220,
	LITEST_SYNAPTICS_HOVER_SEMI_MT,
	LITEST_SYNAPTICS_I2C,
	LITEST_SYNAPTICS_PHANTOMCLICKS,
	LITEST_SYNAPTICS_PRESSUREPAD,
	LITEST_SYNAPTICS_RMI4,
	LITEST_SYNAPTICS_TOPBUTTONPAD,
	LITEST_SYNAPTICS_TOUCHPAD,
	LITEST_TOUCHPAD_PALMPRESSURE_ZERO,
	LITEST_WACOM_INTUOS5_FINGER,

	/* Touchscreens */
	LITEST_CALIBRATED_TOUCHSCREEN,
	LITEST_GENERIC_MULTITOUCH_SCREEN,
	LITEST_GENERIC_SINGLETOUCH,
	LITEST_MS_SURFACE_COVER,
	LITEST_MULTITOUCH_FUZZ_SCREEN,
	LITEST_NEXUS4_TOUCH_SCREEN,
	LITEST_PROTOCOL_A_SCREEN,
	LITEST_TOUCHSCREEN_INVALID_RANGE,
	LITEST_TOUCHSCREEN_MT_TOOL_TYPE,
	LITEST_WACOM_ISDV4_E6_FINGER,

	/* Pointing devices and keyboards */
	LITEST_MOUSE,
	LITEST_MOUSE_PS2,
	LITEST_KEYBOARD,
	LITEST_TRACKPOINT,
	LITEST_ABSINFO_OVERRIDE,
	LITEST_ACER_HAWAII_KEYBOARD,
	LITEST_ANKER_MOUSE_KBD,
	LITEST_APPLE_KEYBOARD,
	LITEST_CYBORG_RAT,
	LITEST_HP_WMI_HOTKEYS,
	LITEST_IGNORED_MOUSE,
	LITEST_KEYBOARD_ALL_CODES,
	LITEST_KEYBOARD_BLACKWIDOW,
	LITEST_KEYBOARD_BLADE_STEALTH,
	LITEST_KEYBOARD_BLADE_STEALTH_VIDEOSWITCH,
	LITEST_KEYBOARD_LOGITECH_MEDIA_KEYBOARD_ELITE,
	LITEST_KEYBOARD_QUIRKED,
	LITEST_LENOVO_SCROLLPOINT,
	LITEST_LOGITECH_TRACKBALL,
	LITEST_MAGICMOUSE,
	LITEST_MOUSE_FORMAT_STRING,
	LITEST_MOUSE_GLADIUS,
	LITEST_MOUSE_LOW_DPI,
	LITEST_MOUSE_ROCCAT,
	LITEST_MOUSE_VIRTUAL,
	LITEST_MOUSE_WHEEL_CLICK_ANGLE,
	LITEST_MOUSE_WHEEL_CLICK_COUNT,
	LITEST_MOUSE_WHEEL_TILT,
	LITEST_MOUSE_WHEEL_HIRES_DISABLED,
	LITEST_MS_NANO_TRANSCEIVER_MOUSE,
	LITEST_SONY_VAIO_KEYS,
	LITEST_SYNAPTICS_TRACKPOINT_BUTTONS,
	LITEST_THINKPAD_EXTRABUTTONS,
	LITEST_VMWARE_VIRTMOUSE,
	LITEST_WHEEL_ONLY,
	LITEST_XEN_VIRTUAL_POINTER,

	/* Switches */
	LITEST_LID_SWITCH,
	LITEST_LID_SWITCH_SURFACE3,
	LITEST_TABLET_MODE_UNRELIABLE,

	/* Special devices */
	LITEST_DELL_CANVAS_TOTEM,
	LITEST_DELL_CANVAS_TOTEM_TOUCH,
	LITEST_GPIO_KEYS,
	LITEST_YUBIKEY,

	/* Tablets */
	LITEST_ELAN_TABLET,
	LITEST_HUION_TABLET,
	LITEST_HUION_Q620M_DIAL,
	LITEST_PLOOPY_PAVONIS_STYLUS,
	LITEST_QEMU_TABLET,
	LITEST_TABLET_DOUBLEDIAL_PAD,
	LITEST_TABLET_REL_DIAL_PAD,
	LITEST_UCLOGIC_TABLET,
	LITEST_WACOM_BAMBOO_16FG_PEN,
	LITEST_WACOM_BAMBOO_2FG_FINGER,
	LITEST_WACOM_BAMBOO_2FG_PAD,
	LITEST_WACOM_BAMBOO_2FG_PEN,
	LITEST_WACOM_CALIBRATED_TABLET_PEN,
	LITEST_WACOM_CINTIQ_12WX_PEN,
	LITEST_WACOM_CINTIQ_13HDT_FINGER,
	LITEST_WACOM_CINTIQ_13HDT_PAD,
	LITEST_WACOM_CINTIQ_13HDT_PEN,
	LITEST_WACOM_CINTIQ_24HDT_PAD,
	LITEST_WACOM_CINTIQ_24HD_PEN,
	LITEST_WACOM_CINTIQ_PRO16_FINGER,
	LITEST_WACOM_CINTIQ_PRO16_PAD,
	LITEST_WACOM_CINTIQ_PRO16_PEN,
	LITEST_WACOM_EKR,
	LITEST_WACOM_HID4800_PEN,
	LITEST_WACOM_INTUOS3_PAD,
	LITEST_WACOM_INTUOS5_PAD,
	LITEST_WACOM_INTUOS5_PEN,
	LITEST_WACOM_ISDV4_4200_PEN,
	LITEST_WACOM_ISDV4_524C_PEN,
	LITEST_WACOM_ISDV4_E6_PEN,
	LITEST_WACOM_MOBILESTUDIO_PRO_16_PAD,
	LITEST_WALTOP,
};

#define LITEST_DEVICELESS	-2
#define LITEST_DISABLE_DEVICE	-1
#define LITEST_ANY		0
#define LITEST_TOUCHPAD		bit(0)
#define LITEST_CLICKPAD		bit(1)
#define LITEST_BUTTON		bit(2)
#define LITEST_KEYS		bit(3)
#define LITEST_RELATIVE		bit(4)
#define LITEST_WHEEL		bit(5)
#define LITEST_TOUCH		bit(6)
#define LITEST_SINGLE_TOUCH	bit(7)
#define LITEST_APPLE_CLICKPAD	bit(8)
#define LITEST_TOPBUTTONPAD	bit(9)
#define LITEST_SEMI_MT		bit(10)
#define LITEST_POINTINGSTICK	bit(11)
#define LITEST_FAKE_MT		bit(12)
#define LITEST_ABSOLUTE		bit(13)
#define LITEST_PROTOCOL_A	bit(14)
#define LITEST_HOVER		bit(15)
#define LITEST_ELLIPSE		bit(16)
#define LITEST_TABLET		bit(17)
#define LITEST_DISTANCE		bit(18)
#define LITEST_TOOL_SERIAL	bit(19)
#define LITEST_TILT		bit(20)
#define LITEST_TABLET_PAD	bit(21)
#define LITEST_RING		bit(22)
#define LITEST_STRIP		bit(23)
#define LITEST_TRACKBALL	bit(24)
#define LITEST_LEDS		bit(25)
#define LITEST_SWITCH		bit(26)
#define LITEST_IGNORED		bit(27)
#define LITEST_NO_DEBOUNCE	bit(28)
#define LITEST_TOOL_MOUSE	bit(29)
#define LITEST_DIRECT		bit(30)
#define LITEST_TOTEM		bit(31)
#define LITEST_FORCED_PROXOUT	bit(32)
#define LITEST_PRECALIBRATED	bit(33)
#define LITEST_DIAL		bit(34)

/* this is a semi-mt device, so we keep track of the touches that the tests
 * send and modify them so that the first touch is always slot 0 and sends
 * the top-left of the bounding box, the second is always slot 1 and sends
 * the bottom-right of the bounding box.
 * Lifting any of two fingers terminates slot 1
 */
struct litest_semi_mt {
	bool is_semi_mt;

	int tracking_id;
	/* The actual touches requested by the test for the two slots
	 * in the 0..100 range used by litest */
	struct {
		double x, y;
	} touches[2];
};

struct litest_device {
	enum litest_device_type which;
	struct libevdev *evdev;
	struct libevdev_uinput *uinput;
	struct libinput *libinput;
	struct quirks *quirks;
	bool owns_context;
	struct libinput_device *libinput_device;
	struct litest_device_interface *interface;

	struct {
		struct input_event events[64];
		size_t nevents;
	} frame;

	int ntouches_down;
	int skip_ev_syn;
	struct litest_semi_mt semi_mt; /** only used for semi-mt device */

	void *private; /* device-specific data */
};

struct axis_replacement {
	int32_t evcode;
	double value;
};

/**
 * Same as litest_axis_set_value but allows for ranges outside 0..100%
 */
static inline void
litest_axis_set_value_unchecked(struct axis_replacement *axes, int code, double value)
{
	while (axes->evcode != -1) { /* NOLINT(clang-analyzer-security.ArrayBound) */
		if (axes->evcode == code) {
			axes->value = value;
			return;
		}
		axes++;
	}

	litest_abort_msg("Missing axis code %d\n", code);
}

/**
 * Takes a value in percent and sets the given axis to that code.
 */
static inline void
litest_axis_set_value(struct axis_replacement *axes, int code, double value)
{
	litest_assert_double_ge(value, 0.0);
	litest_assert_double_le(value, 100.0);

	litest_axis_set_value_unchecked(axes, code, value);
}

struct libinput *
litest_create_context(void);

/* Adds the given plugin dir to the context but does *not* initialize
 * the plugins */
struct libinput *
litest_create_context_with_plugindir(const char *plugindir);

void
litest_destroy_context(struct libinput *li);
DEFINE_TRIVIAL_CLEANUP_FUNC(struct libinput *, litest_destroy_context);

#define _litest_context_destroy_ _cleanup_(litest_destroy_contextp)

void
litest_context_set_user_data(struct libinput *li, void *data);
void *
litest_context_get_user_data(struct libinput *li);

void
litest_disable_log_handler(struct libinput *libinput);
void
litest_restore_log_handler(struct libinput *libinput);
void
litest_set_log_handler_bug(struct libinput *libinput);

struct litest_parameters;

/**
 * Create a new set of parameters for a test case.
 *
 * This function takes a variable set of arguments in the format
 * [name, type, count, arg1, arg2, arg3, ..], for example:
 *
 *  litest_parameter_new("axis", 'u', 2, ABS_X, ABS_Y,
 *                       "direction", 's', 4, "north", "south", "east", "west",
 *                       NULL);
 *
 * Parsing stops at the first null name argument.
 */
struct litest_parameters *
_litest_parameters_new(const char *name, ...);

/* Helper to ensure it's always null-terminated */
#define litest_parameters_new(name_, ...) \
	_litest_parameters_new(name_, __VA_ARGS__, NULL)

#define litest_with_parameters(params_, ...) \
	for (struct litest_parameters *params_ = litest_parameters_new(__VA_ARGS__); \
	     params_; \
	     params_ = litest_parameters_unref(params_))

#define _LITEST_NAMED_I32(v_, n_, ...) (struct litest_named_i32){ .value = v_, .name = n_ }
/* Helper to default second argument to stringification of first argument.
 * This allows for two uses of this macro:
 * - litest_named_i32(0) expands to { 0, "0" }
 * - litest_named_i32(0, "zero") expands to (effectively) { 0, "zero" }
 */
#define litest_named_i32(...) _LITEST_NAMED_I32(__VA_ARGS__, #__VA_ARGS__)

struct litest_named_i32 {
	int32_t value;
	const char *name;
};

struct litest_parameters_permutation_value {
	struct list link;
	char name[128];
	const struct multivalue value;
};

/**
 * Argument for the callback function to litest_parameters_permutations().
 * This is simple wrapper around a linked list that contains all elements
 * of the current permutation.
 */
struct litest_parameters_permutation {
	struct list values; /* struct litest_parameters_permutation_value */
};

/**
 * Callback function invoked for each permutation of a struct litest_parameters.
 */
typedef int (*litest_parameters_permutation_func_t)(
	struct litest_parameters_permutation *permutation,
	void *userdata);

/**
 * Permutates the given parameters and calls func for every possible
 * permutation. If func returns a nonzero status, permutation stops
 * and that nonzero status is returned to the caller.
 *
 * Userdata is passed through as-is.
 */
int
litest_parameters_permutations(struct litest_parameters *params,
			       litest_parameters_permutation_func_t func,
			       void *userdata);

struct litest_parameters *
litest_parameters_ref(struct litest_parameters *p);

struct litest_parameters *
litest_parameters_unref(struct litest_parameters *params);

#define litest_add(func_, ...) \
	_litest_add(__FILE__, #func_, func_, __VA_ARGS__)
#define litest_add_ranged(func_, ...) \
	_litest_add_ranged(__FILE__, #func_, func_, __VA_ARGS__)
#define litest_add_parametrized(func_, ...) \
	_litest_add_parametrized(__FILE__, #func_, func_, __VA_ARGS__)
#define litest_add_for_device(func_, ...) \
	_litest_add_for_device(__FILE__, #func_, func_, __VA_ARGS__)
#define litest_add_ranged_for_device(func_, ...) \
	_litest_add_ranged_for_device(__FILE__, #func_, func_, __VA_ARGS__)
#define litest_add_parametrized_for_device(func_, ...) \
	_litest_add_parametrized_for_device(__FILE__, #func_, func_, __VA_ARGS__)
#define litest_add_no_device(func_) \
	_litest_add_no_device(__FILE__, #func_, func_)
#define litest_add_parametrized_no_device(func_, ...) \
	_litest_add_parametrized_no_device(__FILE__, #func_, func_, __VA_ARGS__)
#define litest_add_ranged_no_device(func_, ...) \
	_litest_add_ranged_no_device(__FILE__, #func_, func_, __VA_ARGS__)
#define litest_add_deviceless(func_) \
	_litest_add_deviceless(__FILE__, #func_, func_)
#define litest_add_parametrized_deviceless(func_, params) \
	_litest_add_parametrize_deviceless(__FILE__, #func_, func_, params)

void
_litest_add(const char *name,
	    const char *funcname,
	    const void *func,
	    int64_t required_feature,
	    int64_t excluded_feature);
void
_litest_add_ranged(const char *name,
		   const char *funcname,
		   const void *func,
		   int64_t required,
		   int64_t excluded,
		   const struct range *range);
void
_litest_add_parametrized(const char *name,
			 const char *funcname,
			 const void *func,
			 int64_t required,
			 int64_t excluded,
			 struct litest_parameters *params);
void
_litest_add_for_device(const char *name,
		       const char *funcname,
		       const void *func,
		       enum litest_device_type type);
void
_litest_add_ranged_for_device(const char *name,
			      const char *funcname,
			      const void *func,
			      enum litest_device_type type,
			      const struct range *range);
void
_litest_add_parametrized_for_device(const char *name,
				    const char *funcname,
				    const void *func,
				    enum litest_device_type type,
				    struct litest_parameters *params);
void
_litest_add_no_device(const char *name, const char *funcname, const void *func);
void
_litest_add_parametrized_no_device(const char *name,
				   const char *funcname,
				   const void *func,
				   struct litest_parameters *params);
void
_litest_add_ranged_no_device(const char *name,
			     const char *funcname,
			     const void *func,
			     const struct range *range);
void
_litest_add_deviceless(const char *name, const char *funcname, const void *func);
void
_litest_add_parametrized_deviceless(const char *name,
				    const char *funcname,
				    const void *func,
				    struct litest_parameters *params);

struct litest_device *
litest_create_device(enum litest_device_type which);

struct litest_device *
litest_add_device(struct libinput *libinput, enum litest_device_type which);
struct libevdev_uinput *
litest_create_uinput_device_from_description(const char *name,
					     const struct input_id *id,
					     const struct input_absinfo *abs,
					     const int *events);
struct litest_device *
litest_create(enum litest_device_type which,
	      const char *name_override,
	      struct input_id *id_override,
	      const struct input_absinfo *abs_override,
	      const int *events_override);

struct litest_device *
litest_create_device_with_overrides(enum litest_device_type which,
				    const char *name_override,
				    struct input_id *id_override,
				    const struct input_absinfo *abs_override,
				    const int *events_override);
struct litest_device *
litest_add_device_with_overrides(struct libinput *libinput,
				 enum litest_device_type which,
				 const char *name_override,
				 struct input_id *id_override,
				 const struct input_absinfo *abs_override,
				 const int *events_override);

struct litest_device *
litest_current_device(void);

void
litest_grab_device(struct litest_device *d);

void
litest_ungrab_device(struct litest_device *d);

void
litest_device_destroy(struct litest_device *d);

DEFINE_DESTROY_CLEANUP_FUNC(litest_device);

const char *
litest_event_type_str(enum libinput_event_type type);

int
_litest_dispatch(struct libinput *li, const char *func, int line);

#define litest_dispatch(li_) \
	_litest_dispatch(li_, __func__, __LINE__)

void
litest_event(struct litest_device *t, unsigned int type, unsigned int code, int value);

void
litest_event_unchecked(struct litest_device *d,
		       unsigned int type,
		       unsigned int code,
		       int value);

int
litest_auto_assign_value(struct litest_device *d,
			 const struct input_event *ev,
			 int slot,
			 double x,
			 double y,
			 struct axis_replacement *axes,
			 bool touching);
void
litest_touch_up(struct litest_device *d, unsigned int slot);

void
litest_touch_move(struct litest_device *d, unsigned int slot, double x, double y);

void
litest_touch_move_extended(struct litest_device *d,
			   unsigned int slot,
			   double x,
			   double y,
			   struct axis_replacement *axes);

void
litest_touch_sequence(struct litest_device *d,
		      unsigned int slot,
		      double x1,
		      double y1,
		      double x2,
		      double y2,
		      int steps);

void
litest_touch_down(struct litest_device *d, unsigned int slot, double x, double y);

void
litest_touch_down_extended(struct litest_device *d,
			   unsigned int slot,
			   double x,
			   double y,
			   struct axis_replacement *axes);

void
litest_touch_move_to(struct litest_device *d,
		     unsigned int slot,
		     double x_from,
		     double y_from,
		     double x_to,
		     double y_to,
		     int steps);

void
litest_touch_move_to_extended(struct litest_device *d,
			      unsigned int slot,
			      double x_from,
			      double y_from,
			      double x_to,
			      double y_to,
			      struct axis_replacement *axes,
			      int steps);

void
litest_touch_move_two_touches(struct litest_device *d,
			      double x0,
			      double y0,
			      double x1,
			      double y1,
			      double dx,
			      double dy,
			      int steps);

void
litest_touch_move_three_touches(struct litest_device *d,
				double x0,
				double y0,
				double x1,
				double y1,
				double x2,
				double y2,
				double dx,
				double dy,
				int steps);

void
litest_tablet_set_tool_type(struct litest_device *d, unsigned int code);

void
litest_tablet_proximity_in(struct litest_device *d,
			   double x,
			   double y,
			   struct axis_replacement *axes);

void
litest_tablet_proximity_out(struct litest_device *d);

void
litest_tablet_tip_down(struct litest_device *d,
		       double x,
		       double y,
		       struct axis_replacement *axes);

void
litest_tablet_tip_up(struct litest_device *d,
		     double x,
		     double y,
		     struct axis_replacement *axes);

void
litest_tablet_motion(struct litest_device *d,
		     double x,
		     double y,
		     struct axis_replacement *axes);

void
litest_pad_ring_start(struct litest_device *d, double value);

void
litest_pad_ring_change(struct litest_device *d, double value);

void
litest_pad_ring_end(struct litest_device *d);

void
litest_pad_strip_start(struct litest_device *d, double value);

void
litest_pad_strip_change(struct litest_device *d, double value);

void
litest_pad_strip_end(struct litest_device *d);

void
litest_hover_start(struct litest_device *d, unsigned int slot, double x, double y);

void
litest_hover_end(struct litest_device *d, unsigned int slot);

void
litest_hover_move(struct litest_device *d, unsigned int slot, double x, double y);

void
litest_hover_move_to(struct litest_device *d,
		     unsigned int slot,
		     double x_from,
		     double y_from,
		     double x_to,
		     double y_to,
		     int steps);

void
litest_hover_move_two_touches(struct litest_device *d,
			      double x0,
			      double y0,
			      double x1,
			      double y1,
			      double dx,
			      double dy,
			      int steps);

void
litest_button_click_debounced(struct litest_device *d,
			      struct libinput *li,
			      unsigned int button,
			      bool is_press);

void
litest_button_click(struct litest_device *d, unsigned int button, bool is_press);

void
litest_button_scroll(struct litest_device *d,
		     unsigned int button,
		     double dx,
		     double dy);
void
litest_button_scroll_locked(struct litest_device *d,
			    unsigned int button,
			    double dx,
			    double dy);

void
litest_keyboard_key(struct litest_device *d, unsigned int key, bool is_press);

void
litest_switch_action(struct litest_device *d,
		     enum libinput_switch sw,
		     enum libinput_switch_state state);

void
litest_wait_for_event(struct libinput *li);

void
_litest_wait_for_event_of_type(struct libinput *li, const char *func, int lineno, ...);

#define litest_wait_for_event_of_type(li_, ...) \
	_litest_wait_for_event_of_type(li_, __func__, __LINE__, __VA_ARGS__, -1)

void
litest_drain_events(struct libinput *li);

void
_litest_drain_events_of_type(struct libinput *li, ...);

#define litest_drain_events_of_type(li_, ...) \
	_litest_drain_events_of_type(li_, __VA_ARGS__, -1)

#define litest_assert_event_type(e_, want_) \
	_litest_assert_event_type(e_, want_, __func__, __LINE__)
void
_litest_assert_event_type(struct libinput_event *event,
			  enum libinput_event_type want,
			  const char *func,
			  int lineno);

#define litest_assert_event_type_is_one_of(ev_, ...) \
    _litest_assert_event_type_is_one_of(ev_, __func__, __LINE__, __VA_ARGS__, -1)
void
_litest_assert_event_type_is_one_of(struct libinput_event *event,
				    const char *func,
				    int lineno,
				    ...);

#define litest_assert_event_type_not_one_of(ev_, ...) \
    _litest_assert_event_type_not_one_of(ev_, __func__, __LINE__, __VA_ARGS__, -1)

void
_litest_assert_event_type_not_one_of(struct libinput_event *event,
				     const char *func,
				     int lineno,
				     ...);

#define litest_assert_empty_queue(li_) \
	_litest_assert_empty_queue(li_, __func__, __LINE__)

void
_litest_assert_empty_queue(struct libinput *li, const char *func, int line);

void
litest_assert_touch_sequence(struct libinput *li);

void
litest_assert_touch_motion_frame(struct libinput *li);
void
litest_assert_touch_down_frame(struct libinput *li);
void
litest_assert_touch_up_frame(struct libinput *li);
void
litest_assert_touch_cancel(struct libinput *li);

struct libinput_event_pointer *
litest_is_button_event(struct libinput_event *event,
		       unsigned int button,
		       enum libinput_button_state state);

struct libinput_event_pointer *
litest_is_axis_event(struct libinput_event *event,
		     enum libinput_event_type axis_type,
		     enum libinput_pointer_axis axis,
		     enum libinput_pointer_axis_source source);

bool
litest_is_high_res_axis_event(struct libinput_event *event);

struct libinput_event_pointer *
litest_is_motion_event(struct libinput_event *event);

struct libinput_event_touch *
litest_is_touch_event(struct libinput_event *event, enum libinput_event_type type);

struct libinput_event_keyboard *
litest_is_keyboard_event(struct libinput_event *event,
			 unsigned int key,
			 enum libinput_key_state state);

struct libinput_event_gesture *
litest_is_gesture_event(struct libinput_event *event,
			enum libinput_event_type type,
			int nfingers);

struct libinput_event_tablet_tool *
litest_is_tablet_event(struct libinput_event *event, enum libinput_event_type type);

struct libinput_event_tablet_pad *
litest_is_pad_button_event(struct libinput_event *event,
			   unsigned int button,
			   enum libinput_button_state state);
struct libinput_event_tablet_pad *
litest_is_pad_dial_event(struct libinput_event *event, unsigned int number);
struct libinput_event_tablet_pad *
litest_is_pad_ring_event(struct libinput_event *event,
			 unsigned int number,
			 enum libinput_tablet_pad_ring_axis_source source);
struct libinput_event_tablet_pad *
litest_is_pad_strip_event(struct libinput_event *event,
			  unsigned int number,
			  enum libinput_tablet_pad_strip_axis_source source);
struct libinput_event_tablet_pad *
litest_is_pad_key_event(struct libinput_event *event,
			unsigned int key,
			enum libinput_key_state state);

struct libinput_event_switch *
litest_is_switch_event(struct libinput_event *event,
		       enum libinput_switch sw,
		       enum libinput_switch_state state);

struct libinput_event_tablet_tool *
litest_is_proximity_event(struct libinput_event *event,
			  enum libinput_tablet_tool_proximity_state state);

double
litest_event_pointer_get_value(struct libinput_event_pointer *ptrev,
			       enum libinput_pointer_axis axis);

enum libinput_pointer_axis_source
litest_event_pointer_get_axis_source(struct libinput_event_pointer *event);

#define litest_assert_key_event(li_, key_, state_) \
	_litest_assert_key_event(li_, key_, state_, __func__, __LINE__)

void
_litest_assert_key_event(struct libinput *li,
			 unsigned int key,
			 enum libinput_key_state state,
			 const char *func,
			 int lineno);

#define litest_assert_button_event(li_, button_, state_) \
	_litest_assert_button_event(li_, button_, state_, __func__, __LINE__)

void
_litest_assert_button_event(struct libinput *li,
			    unsigned int button,
			    enum libinput_button_state state,
			    const char *func,
			    int line);

#define litest_assert_switch_event(li_, sw_, state_)  \
	_litest_assert_switch_event(li_, sw_, state_, __func__, __LINE__)

void
_litest_assert_switch_event(struct libinput *li,
			    enum libinput_switch sw,
			    enum libinput_switch_state state,
			    const char *func,
			    int lineno);

void
litest_assert_scroll(struct libinput *li,
		     enum libinput_event_type axis_type,
		     enum libinput_pointer_axis axis,
		     int minimum_movement);

void
litest_assert_axis_end_sequence(struct libinput *li,
				enum libinput_event_type axis_type,
				enum libinput_pointer_axis axis,
				enum libinput_pointer_axis_source source);

#define litest_assert_only_typed_events(...) \
	_litest_assert_only_typed_events(__VA_ARGS__, __func__, __LINE__)
void
_litest_assert_only_typed_events(struct libinput *li,
				 enum libinput_event_type type,
				 const char *func,
				 int line);

void
litest_assert_only_axis_events(struct libinput *li, enum libinput_event_type axis_type);

void
litest_assert_no_typed_events(struct libinput *li, enum libinput_event_type type);

#define litest_assert_tablet_button_event(li_, button_, state_) \
	_litest_assert_tablet_button_event(li_, button_, state_, __func__, __LINE__)

void
_litest_assert_tablet_button_event(struct libinput *li,
				   unsigned int button,
				   enum libinput_button_state state,
				   const char *func,
				   int lineno);

#define litest_assert_tablet_axis_event(li_) \
	_litest_assert_tablet_axis_event(li_, __func__, __LINE__)

void
_litest_assert_tablet_axis_event(struct libinput *li, const char *func, int lineno);

#define litest_assert_tablet_proximity_event(li_, state_) \
	_litest_assert_tablet_proximity_event(li_, state_, __func__, __LINE__)

void
_litest_assert_tablet_proximity_event(struct libinput *li,
				      enum libinput_tablet_tool_proximity_state state,
				      const char *func,
				      int lineno);

#define litest_assert_tablet_tip_event(li_, state_) \
	_litest_assert_tablet_tip_event(li_, state_, __func__, __LINE__)

void
_litest_assert_tablet_tip_event(struct libinput *li,
				enum libinput_tablet_tool_tip_state state,
				const char *func,
				int lineno);

#define litest_assert_pad_button_event(li_, button_, state_) \
	_litest_assert_pad_button_event(li_, button_, state_, __func__, __LINE__)

void
_litest_assert_pad_button_event(struct libinput *li,
				unsigned int button,
				enum libinput_button_state state,
				const char *func,
				int lineno);

#define litest_assert_pad_key_event(li_, key_, state_) \
	_litest_assert_pad_key_event(li_, key_, state_, __func__, __LINE__)

void
_litest_assert_pad_key_event(struct libinput *li,
			     unsigned int key,
			     enum libinput_key_state state,
			     const char *func,
			     int lineno);

#define litest_assert_gesture_event(...) \
	_litest_assert_gesture_event(__VA_ARGS__, __func__, __LINE__)

void
_litest_assert_gesture_event(struct libinput *li,
			     enum libinput_event_type type,
			     int nfingers,
			     const char *func,
			     int line);

struct libevdev_uinput *
litest_create_uinput_device(const char *name, struct input_id *id, ...);

struct libevdev_uinput *
litest_create_uinput_abs_device(const char *name,
				struct input_id *id,
				const struct input_absinfo *abs,
				...);

void
_litest_timeout(struct libinput *li, const char *func, int lineno, int millis);

#define litest_timeout(li_, millis) \
	_litest_timeout(li_, __func__, __LINE__, millis)

#define litest_timeout_tap(li_) litest_timeout(li_, 300)
#define litest_timeout_tapndrag(li_) litest_timeout(li_, 520)
#define litest_timeout_debounce(li_) litest_timeout(li_, 30)
#define litest_timeout_softbuttons(li_) litest_timeout(li_, 300)
#define litest_timeout_buttonscroll(li_) litest_timeout(li_, 300)
#define litest_timeout_wheel_scroll(li_) litest_timeout(li_, 600)
#define litest_timeout_edgescroll(li_) litest_timeout(li_, 300)
#define litest_timeout_finger_switch(li_) litest_timeout(li_, 140)
#define litest_timeout_middlebutton(li_) litest_timeout(li_, 70)
#define litest_timeout_dwt_short(li_) litest_timeout(li_, 220)
#define litest_timeout_dwt_long(li_) litest_timeout(li_, 520)
#define litest_timeout_gesture(li_) litest_timeout(li_, 120)
#define litest_timeout_gesture_scroll(li_) litest_timeout(li_, 180)
#define litest_timeout_gesture_hold(li_) litest_timeout(li_, 300)
#define litest_timeout_gesture_quick_hold(li_) litest_timeout(li_, 60)
#define litest_timeout_trackpoint(li_) litest_timeout(li_, 320)
#define litest_timeout_tablet_proxout(li_) litest_timeout(li_, 170)
#define litest_timeout_touch_arbitration(li_) litest_timeout(li_, 100)
#define litest_timeout_hysteresis(li_) litest_timeout(li_, 90)
#define litest_timeout_3fg_drag(li_) litest_timeout(li_, 800)
#define litest_timeout_eraser_button(li_) litest_timeout(li_, 50)

struct litest_logcapture {
	char **errors;
	char **infos;
	char **debugs;
	char **bugs;
};

void
litest_logcapture_destroy(struct litest_logcapture *c);

DEFINE_DESTROY_CLEANUP_FUNC(litest_logcapture);

struct litest_logcapture *
litest_logcapture_setup(struct libinput *li);

struct litest_logcapture *
litest_logcapture_remove(struct libinput *li, struct litest_logcapture *capture);

#define litest_with_logcapture(li_, capture_) \
	for (struct litest_logcapture *capture_ = litest_logcapture_setup(li_); \
	     capture_ != NULL; \
	     capture_ = litest_logcapture_remove(li_, capture_))

void
_litest_assert_logcapture_no_errors(struct litest_logcapture *c,
				    const char *file,
				    const char *func,
				    int lineno);

#define litest_assert_logcapture_no_errors(c_) \
	_litest_assert_logcapture_no_errors(c_, __FILE__, __func__, __LINE__)

#define litest_with_event_frame(dev_) \
	for (bool _i = ({litest_push_event_frame(dev_); true; }); \
	     _i; \
	     ({ litest_pop_event_frame(dev_); _i = false; }))

void
litest_push_event_frame(struct litest_device *dev);

void
litest_pop_event_frame(struct litest_device *dev);

void
litest_filter_event(struct litest_device *dev, unsigned int type, unsigned int code);

void
litest_unfilter_event(struct litest_device *dev, unsigned int type, unsigned int code);
void
litest_semi_mt_touch_down(struct litest_device *d,
			  struct litest_semi_mt *semi_mt,
			  unsigned int slot,
			  double x,
			  double y);

void
litest_semi_mt_touch_move(struct litest_device *d,
			  struct litest_semi_mt *semi_mt,
			  unsigned int slot,
			  double x,
			  double y);

void
litest_semi_mt_touch_up(struct litest_device *d,
			struct litest_semi_mt *semi_mt,
			unsigned int slot);

static inline void
litest_enable_3fg_drag(struct libinput_device *device, unsigned int nfingers)
{
	enum libinput_config_3fg_drag_state enabled;

	switch (nfingers) {
	case 3:
		enabled = LIBINPUT_CONFIG_3FG_DRAG_ENABLED_3FG;
		break;
	case 4:
		enabled = LIBINPUT_CONFIG_3FG_DRAG_ENABLED_4FG;
		break;
	default:
		litest_abort_msg("Invalid finger count");
		break;
	}

	enum libinput_config_status status =
		libinput_device_config_3fg_drag_set_enabled(device, enabled);
	litest_assert_enum_eq(status, LIBINPUT_CONFIG_STATUS_SUCCESS);
}

static inline void
litest_enable_tap(struct libinput_device *device)
{
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_tap_set_enabled(device,
							LIBINPUT_CONFIG_TAP_ENABLED);

	litest_assert_int_eq(status, expected);
}

static inline void
litest_disable_tap(struct libinput_device *device)
{
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_tap_set_enabled(device,
							LIBINPUT_CONFIG_TAP_DISABLED);

	litest_assert_int_eq(status, expected);
}

static inline void
litest_set_tap_map(struct libinput_device *device,
		   enum libinput_config_tap_button_map map)
{
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_tap_set_button_map(device, map);
	litest_assert_int_eq(status, expected);
}

static inline void
litest_enable_tap_drag(struct libinput_device *device)
{
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_tap_set_drag_enabled(
		device,
		LIBINPUT_CONFIG_DRAG_ENABLED);

	litest_assert_int_eq(status, expected);
}

static inline void
litest_disable_tap_drag(struct libinput_device *device)
{
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_tap_set_drag_enabled(
		device,
		LIBINPUT_CONFIG_DRAG_DISABLED);

	litest_assert_int_eq(status, expected);
}

static inline bool
litest_has_2fg_scroll(struct litest_device *dev)
{
	struct libinput_device *device = dev->libinput_device;

	return !!(libinput_device_config_scroll_get_methods(device) &
		  LIBINPUT_CONFIG_SCROLL_2FG);
}

static inline void
litest_enable_2fg_scroll(struct litest_device *dev)
{
	enum libinput_config_status status, expected;
	struct libinput_device *device = dev->libinput_device;

	status = libinput_device_config_scroll_set_method(device,
							  LIBINPUT_CONFIG_SCROLL_2FG);

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	litest_assert_int_eq(status, expected);

	libinput_device_config_scroll_set_natural_scroll_enabled(device, 0);
}

static inline void
litest_enable_edge_scroll(struct litest_device *dev)
{
	enum libinput_config_status status, expected;
	struct libinput_device *device = dev->libinput_device;

	status = libinput_device_config_scroll_set_method(device,
							  LIBINPUT_CONFIG_SCROLL_EDGE);

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	litest_assert_int_eq(status, expected);

	libinput_device_config_scroll_set_natural_scroll_enabled(device, 0);
}

static inline bool
litest_has_clickfinger(struct litest_device *dev)
{
	struct libinput_device *device = dev->libinput_device;
	uint32_t methods = libinput_device_config_click_get_methods(device);

	return methods & LIBINPUT_CONFIG_CLICK_METHOD_CLICKFINGER;
}

static inline bool
litest_has_btnareas(struct litest_device *dev)
{
	struct libinput_device *device = dev->libinput_device;
	uint32_t methods = libinput_device_config_click_get_methods(device);

	return methods & LIBINPUT_CONFIG_CLICK_METHOD_BUTTON_AREAS;
}

static inline void
litest_enable_clickfinger(struct litest_device *dev)
{
	enum libinput_config_status status, expected;
	struct libinput_device *device = dev->libinput_device;

	status = libinput_device_config_click_set_method(
		device,
		LIBINPUT_CONFIG_CLICK_METHOD_CLICKFINGER);
	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	litest_assert_int_eq(status, expected);
}

static inline void
litest_set_clickfinger_map(struct litest_device *dev,
			   enum libinput_config_clickfinger_button_map map)
{
	enum libinput_config_status status, expected;
	struct libinput_device *device = dev->libinput_device;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_click_set_clickfinger_button_map(device, map);
	litest_assert_int_eq(status, expected);
}

static inline void
litest_enable_buttonareas(struct litest_device *dev)
{
	enum libinput_config_status status, expected;
	struct libinput_device *device = dev->libinput_device;

	status = libinput_device_config_click_set_method(
		device,
		LIBINPUT_CONFIG_CLICK_METHOD_BUTTON_AREAS);
	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	litest_assert_int_eq(status, expected);
}

static inline void
litest_enable_drag_lock_sticky(struct libinput_device *device)
{
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_tap_set_drag_lock_enabled(
		device,
		LIBINPUT_CONFIG_DRAG_LOCK_ENABLED_STICKY);

	litest_assert_int_eq(status, expected);
}

static inline void
litest_enable_drag_lock(struct libinput_device *device)
{
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_tap_set_drag_lock_enabled(
		device,
		LIBINPUT_CONFIG_DRAG_LOCK_ENABLED_TIMEOUT);

	litest_assert_int_eq(status, expected);
}

static inline void
litest_disable_drag_lock(struct libinput_device *device)
{
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_tap_set_drag_lock_enabled(
		device,
		LIBINPUT_CONFIG_DRAG_LOCK_DISABLED);

	litest_assert_int_eq(status, expected);
}

static inline void
litest_enable_middleemu(struct litest_device *dev)
{
	struct libinput_device *device = dev->libinput_device;
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_middle_emulation_set_enabled(
		device,
		LIBINPUT_CONFIG_MIDDLE_EMULATION_ENABLED);

	litest_assert_int_eq(status, expected);
}

static inline void
litest_disable_middleemu(struct litest_device *dev)
{
	struct libinput_device *device = dev->libinput_device;
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_middle_emulation_set_enabled(
		device,
		LIBINPUT_CONFIG_MIDDLE_EMULATION_DISABLED);

	litest_assert_int_eq(status, expected);
}

static inline void
litest_sendevents_off(struct litest_device *dev)
{
	struct libinput_device *device = dev->libinput_device;
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_send_events_set_mode(
		device,
		LIBINPUT_CONFIG_SEND_EVENTS_DISABLED);
	litest_assert_int_eq(status, expected);
}

static inline void
litest_sendevents_on(struct litest_device *dev)
{
	struct libinput_device *device = dev->libinput_device;
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_send_events_set_mode(
		device,
		LIBINPUT_CONFIG_SEND_EVENTS_ENABLED);
	litest_assert_int_eq(status, expected);
}

static inline void
litest_sendevents_ext_mouse(struct litest_device *dev)
{
	struct libinput_device *device = dev->libinput_device;
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_send_events_set_mode(
		device,
		LIBINPUT_CONFIG_SEND_EVENTS_DISABLED_ON_EXTERNAL_MOUSE);
	litest_assert_int_eq(status, expected);
}

static inline void
litest_enable_hold_gestures(struct libinput_device *device)
{
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_gesture_set_hold_enabled(
		device,
		LIBINPUT_CONFIG_HOLD_ENABLED);

	litest_assert_int_eq(status, expected);
}

static inline void
litest_disable_hold_gestures(struct libinput_device *device)
{
	enum libinput_config_status status, expected;

	expected = LIBINPUT_CONFIG_STATUS_SUCCESS;
	status = libinput_device_config_gesture_set_hold_enabled(
		device,
		LIBINPUT_CONFIG_HOLD_DISABLED);

	litest_assert_int_eq(status, expected);
}

static inline bool
litest_touchpad_is_external(struct litest_device *dev)
{
	struct udev_device *udev_device;
	const char *prop;
	bool is_external;

	if (libinput_device_get_id_vendor(dev->libinput_device) == VENDOR_ID_WACOM)
		return true;

	udev_device = libinput_device_get_udev_device(dev->libinput_device);
	prop = udev_device_get_property_value(udev_device,
					      "ID_INPUT_TOUCHPAD_INTEGRATION");
	is_external = prop && streq(prop, "external");
	udev_device_unref(udev_device);

	return is_external;
}

static inline int
litest_send_file(int sock, int fd)
{
	char buf[40960];
	int n = read(fd, buf, 40960);
	litest_assert_int_gt(n, 0);
	return write(sock, buf, n);
}

static inline int
litest_slot_count(struct litest_device *dev)
{
	if (dev->which == LITEST_ALPS_3FG)
		return 2;

	return libevdev_get_num_slots(dev->evdev);
}

static inline bool
litest_has_palm_detect_size(struct litest_device *dev)
{
	double width, height;
	unsigned int vendor;
	unsigned int bustype;
	int rc;

	vendor = libinput_device_get_id_vendor(dev->libinput_device);
	bustype = libevdev_get_id_bustype(dev->evdev);
	if (vendor == VENDOR_ID_WACOM)
		return 0;
	if (bustype == BUS_BLUETOOTH)
		return 0;
	if (vendor == VENDOR_ID_APPLE)
		return 0;

	rc = libinput_device_get_size(dev->libinput_device, &width, &height);

	return rc == 0 && width >= 70;
}

#endif /* LITEST_H */