/usr/include/libratbag.h is in libratbag-dev 0.9-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* Copyright © 2015 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.
*/
#pragma once
#ifdef __cplusplus
extern "C" {
#endif
#include <stdlib.h>
#include <stdarg.h>
#include <stdbool.h>
#include <libudev.h>
#define LIBRATBAG_ATTRIBUTE_PRINTF(_format, _args) \
__attribute__ ((format (printf, _format, _args)))
#define LIBRATBAG_ATTRIBUTE_DEPRECATED __attribute__ ((deprecated))
/**
* @defgroup base Initialization and manipulation of ratbag contexts
* @defgroup device Querying and manipulating devices
*
* Device configuration is managed by "profiles" (see @ref profile).
* In the simplest case, a device has a single profile that can be fetched,
* queried and manipulated and then re-applied to the device. Other devices
* may have multiple profiles, each of which can be queried and managed
* independently.
*
* @defgroup profile Device profiles
*
* A profile on a device consists of a set of button functions and, where
* applicable, a range of resolution settings, one of which is currently
* active.
*
* @defgroup button Button configuration
*
* @defgroup led LED configuration
*
* @defgroup resolution Resolution and frequency mappings
*
* A device's sensor resolution and report rate can be configured per
* profile, with each profile reporting a number of resolution modes (see
* @ref ratbag_resolution). The number depends on the hardware, but at least
* one is provided by libratbag.
*
* Each resolution mode is a tuple of a resolution and report rate and
* represents the modes that the mouse can switch through, usually with the
* use of a button on the mouse to cycle through the preconfigured
* resolutions.
*
* The resolutions have a default resolution and a currently active
* resolution. The currently active one is the one used by the device now
* and only applies if the profile is currently active too. The default
* resolution is the one the device will chose when the profile is selected
* next.
*/
/**
* @ingroup base
* @struct ratbag
*
* A handle for accessing ratbag contexts. This struct is refcounted, use
* ratbag_ref() and ratbag_unref().
*/
struct ratbag;
/**
* @ingroup device
* @struct ratbag_device
*
* A ratbag context represents one single device. This struct is
* refcounted, use ratbag_device_ref() and ratbag_device_unref().
*/
struct ratbag_device;
/**
* @ingroup profile
* @struct ratbag_profile
*
* A handle to a profile context on devices with the @ref
* RATBAG_DEVICE_CAP_SWITCHABLE_PROFILE capability.
* This struct is refcounted, use ratbag_profile_ref() and
* ratbag_profile_unref().
*/
struct ratbag_profile;
/**
* @ingroup button
* @struct ratbag_button
*
* Represents a button on the device.
*
* This struct is refcounted, use ratbag_button_ref() and
* ratbag_button_unref().
*/
struct ratbag_button;
/**
* @ingroup resolution
* @struct ratbag_resolution
*
* Represents a resolution setting on the device. Most devices have multiple
* resolutions per profile, one of which is active at a time.
*
* This struct is refcounted, use ratbag_resolution_ref() and
* ratbag_resolution_unref().
*/
struct ratbag_resolution;
/**
* @ingroup led
* @struct ratbag_color
*
* Represents LED color in RGB format.
* each color component is integer 0 - 255
*/
struct ratbag_color {
unsigned int red;
unsigned int green;
unsigned int blue;
};
/**
* @ingroup led
* @struct ratbag_led
*
* Represents a led on the device.
*/
struct ratbag_led;
/**
* @ingroup button
* @struct ratbag_macro
*
* Represents a macro that can be assigned to a button.
*
* This struct is refcounted, use ratbag_button_macro_ref() and
* ratbag_button_macro_unref().
*/
struct ratbag_button_macro;
/**
* @ingroup base
*
* Error codes used by libratbag.
*/
enum ratbag_error_code {
RATBAG_SUCCESS = 0,
/**
* An error occured on the device. Either the device is not a
* libratbag device or communication with the device failed.
*/
RATBAG_ERROR_DEVICE = -1000,
/**
* Insufficient capabilities. This error occurs when a requested change is
* beyond the device's capabilities.
*/
RATBAG_ERROR_CAPABILITY = -1001,
/**
* Invalid value or value range. The provided value or value range
* is outside of the legal or supported range.
*/
RATBAG_ERROR_VALUE = -1002,
/**
* A low-level system error has occured, e.g. a failure to access
* files that should be there. This error is usually unrecoverable
* and libratbag will print a log message with details about the
* error.
*/
RATBAG_ERROR_SYSTEM = -1003,
/**
* Implementation bug, either in libratbag or in the caller. This
* error is usually unrecoverable and libratbag will print a log
* message with details about the
* error.
*/
RATBAG_ERROR_IMPLEMENTATION = -1004,
};
/**
* @ingroup base
*
* Log priority for internal logging messages.
*/
enum ratbag_log_priority {
/**
* Raw protocol messages. Using this log level results in *a lot* of
* output.
*/
RATBAG_LOG_PRIORITY_RAW = 10,
RATBAG_LOG_PRIORITY_DEBUG = 20,
RATBAG_LOG_PRIORITY_INFO = 30,
RATBAG_LOG_PRIORITY_ERROR = 40,
};
/**
* @ingroup base
*
* Log handler type for custom logging.
*
* @param ratbag The ratbag context
* @param priority The priority of the current message
* @param format Message format in printf-style
* @param args Message arguments
*
* @see ratbag_log_set_priority
* @see ratbag_log_get_priority
* @see ratbag_log_set_handler
*/
typedef void (*ratbag_log_handler)(struct ratbag *ratbag,
enum ratbag_log_priority priority,
const char *format, va_list args)
LIBRATBAG_ATTRIBUTE_PRINTF(3, 0);
/**
* @ingroup base
*
* Set the log priority for the ratbag context. Messages with priorities
* equal to or higher than the argument will be printed to the context's
* log handler.
*
* The default log priority is @ref RATBAG_LOG_PRIORITY_ERROR.
*
* @param ratbag A previously initialized ratbag context
* @param priority The minimum priority of log messages to print.
*
* @see ratbag_log_set_handler
* @see ratbag_log_get_priority
*/
void
ratbag_log_set_priority(struct ratbag *ratbag,
enum ratbag_log_priority priority);
/**
* @ingroup base
*
* Get the context's log priority. Messages with priorities equal to or
* higher than the argument will be printed to the current log handler.
*
* The default log priority is @ref RATBAG_LOG_PRIORITY_ERROR.
*
* @param ratbag A previously initialized ratbag context
* @return The minimum priority of log messages to print.
*
* @see ratbag_log_set_handler
* @see ratbag_log_set_priority
*/
enum ratbag_log_priority
ratbag_log_get_priority(const struct ratbag *ratbag);
/**
* @ingroup base
*
* Set the context's log handler. Messages with priorities equal to or
* higher than the context's log priority will be passed to the given
* log handler.
*
* The default log handler prints to stderr.
*
* @param ratbag A previously initialized ratbag context
* @param log_handler The log handler for library messages.
*
* @see ratbag_log_set_priority
* @see ratbag_log_get_priority
*/
void
ratbag_log_set_handler(struct ratbag *ratbag,
ratbag_log_handler log_handler);
/**
* @ingroup base
* @struct ratbag_interface
*
* libratbag does not open file descriptors to devices directly, instead
* open_restricted() and close_restricted() are called for each path that
* must be opened.
*
* @see ratbag_create_context
*/
struct ratbag_interface {
/**
* Open the device at the given path with the flags provided and
* return the fd.
*
* @param path The device path to open
* @param flags Flags as defined by open(2)
* @param user_data The user_data provided in
* ratbag_create_context()
*
* @return The file descriptor, or a negative errno on failure.
*/
int (*open_restricted)(const char *path, int flags, void *user_data);
/**
* Close the file descriptor.
*
* @param fd The file descriptor to close
* @param user_data The user_data provided in
* ratbag_create_context()
*/
void (*close_restricted)(int fd, void *user_data);
};
/**
* @ingroup base
*
* Create a new ratbag context.
*
* The context is refcounted with an initial value of at least 1.
* Use ratbag_unref() to release the context.
*
* @return An initialized ratbag context or NULL on error
*/
struct ratbag *
ratbag_create_context(const struct ratbag_interface *interface,
void *userdata);
/**
* @ingroup base
*
* Set caller-specific data associated with this context. libratbag does
* not manage, look at, or modify this data. The caller must ensure the
* data is valid.
*
* Setting userdata overrides the one provided to ratbag_create_context().
*
* @param ratbag A previously initialized ratbag context
* @param userdata Caller-specific data passed to the various callback
* interfaces.
*/
void
ratbag_set_user_data(struct ratbag *ratbag, void *userdata);
/**
* @ingroup base
*
* Get the caller-specific data associated with this context, if any.
*
* @param ratbag A previously initialized ratbag context
* @return The caller-specific data previously assigned in
* ratbag_create_context (or ratbag_set_user_data()).
*/
void*
ratbag_get_user_data(const struct ratbag *ratbag);
/**
* @ingroup base
*
* Add a reference to the context. A context is destroyed whenever the
* reference count reaches 0. See @ref ratbag_unref.
*
* @param ratbag A previously initialized valid ratbag context
* @return The passed ratbag context
*/
struct ratbag *
ratbag_ref(struct ratbag *ratbag);
/**
* @ingroup base
*
* Dereference the ratbag context. After this, the context may have been
* destroyed, if the last reference was dereferenced. If so, the context is
* invalid and may not be interacted with.
*
* @param ratbag A previously initialized ratbag context
* @return Always NULL
*/
struct ratbag *
ratbag_unref(struct ratbag *ratbag);
/**
* @ingroup base
*
* Create a new ratbag context from the given udev device.
*
* The device is refcounted with an initial value of at least 1.
* Use ratbag_device_unref() to release the device.
*
* @param ratbag A previously initialized ratbag context
* @param udev_device The udev device that points at the device
* @param device Set to a new device based on the udev device.
*
* @return 0 on success or the error.
* @retval RATBAG_ERROR_DEVICE The given device does not exist or is not
* supported by libratbag.
*/
enum ratbag_error_code
ratbag_device_new_from_udev_device(struct ratbag *ratbag,
struct udev_device *udev_device,
struct ratbag_device **device);
/**
* @ingroup device
*
* Add a reference to the device. A device is destroyed whenever the
* reference count reaches 0. See @ref ratbag_device_unref.
*
* @param device A previously initialized valid ratbag device
* @return The passed ratbag device
*/
struct ratbag_device *
ratbag_device_ref(struct ratbag_device *device);
/**
* @ingroup device
*
* Dereference the ratbag device. When the internal refcount reaches
* zero, all resources associated with this object are released. The object
* must be considered invalid once unref is called.
*
* @param device A previously initialized ratbag device
* @return Always NULL
*/
struct ratbag_device *
ratbag_device_unref(struct ratbag_device *device);
/**
* @ingroup device
*
* Set caller-specific data associated with this device. libratbag does
* not manage, look at, or modify this data. The caller must ensure the
* data is valid.
*
* @param device A previously initialized device
* @param userdata Caller-specific data passed to the various callback
* interfaces.
*/
void
ratbag_device_set_user_data(struct ratbag_device *device, void *userdata);
/**
* @ingroup device
*
* Get the caller-specific data associated with this device, if any.
*
* @param device A previously initialized ratbag device
* @return The caller-specific data previously assigned in
* ratbag_device_set_user_data().
*/
void*
ratbag_device_get_user_data(const struct ratbag_device *device);
/**
* @ingroup device
*
* @param device A previously initialized ratbag device
* @return The name of the device associated with the given ratbag.
*/
const char *
ratbag_device_get_name(const struct ratbag_device* device);
/**
* @ingroup device
*
* @param device A previously initialized ratbag device
* @return The file name of the svg drawing associated with the given ratbag.
* If there is no file associated to the device, NULL is returned.
*/
const char *
ratbag_device_get_svg_name(const struct ratbag_device* device);
/**
* @ingroup device
*/
enum ratbag_device_capability {
RATBAG_DEVICE_CAP_NONE = 0,
/**
* The device can change resolution, either software-controlled or
* by a hardware button.
*
* FIXME: what about devices that only have hw buttons? can we
* query that, even if we can't switch it ourselves? Maybe better to
* have a separate cap for that then.
*/
RATBAG_DEVICE_CAP_SWITCHABLE_RESOLUTION,
/**
* The device can switch between hardware profiles.
* A device with this capability can store multiple profiles in the
* hardware and provides the ability to switch between the profiles,
* possibly with a button.
* Devices without this capability will only have a single profile.
*/
RATBAG_DEVICE_CAP_SWITCHABLE_PROFILE,
/**
* The device supports assigning button numbers, key events or key +
* modifier combinations.
*/
RATBAG_DEVICE_CAP_BUTTON_KEY,
/**
* The device supports assigning LED colors and effects
*/
RATBAG_DEVICE_CAP_LED,
/**
* The device supports user-defined key or button sequences.
*/
RATBAG_DEVICE_CAP_BUTTON_MACROS,
/**
* The device can have one profile assigned as a default profile.
* A default profile is the profile that is selected when the device
* is plugged in. Devices without this capability may select the
* last-used profile or a specific profile (usually the first).
*/
RATBAG_DEVICE_CAP_DEFAULT_PROFILE,
/**
* The device has the capability to query the current hardware
* configuration. If this capability is missing, libratbag cannot
* query the device for its current configuration and the
* configured resolutions and button mappings are unknown.
* libratbag will still provide information about the structure of
* the device such as the number of buttons and resolutions.
* Clients that encounter a device without this resolution are
* encouraged to upload a configuration stored on-disk to the
* device to reset the device to a known state.
*
* Any changes uploaded to the device will be cached in libratbag,
* once a client has sent a full configuration to the device
* libratbag can be used to query the device as normal.
*/
RATBAG_DEVICE_CAP_QUERY_CONFIGURATION,
/**
* The device has the capability to disable and enable profiles. While
* profiles are not immediately deleted after being disabled, it is not
* guaranteed that the device will remember any disabled profiles the
* next time ratbag runs. Furthermore, the order of profiles may get
* changed the next time ratbag runs if profiles are disabled.
*/
RATBAG_DEVICE_CAP_DISABLE_PROFILE,
};
/**
* @ingroup device
*
* Note that a device may not support any of the capabilities but still
* initialize fine otherwise. This is the case for devices that have no
* configurable options set, or for devices that have some configuration
* options but none that are currently exposed by libratbag. A client is
* expected to handle this situation.
*
* @retval 1 The device has the capability
* @retval 0 The device does not have the capability
*/
int
ratbag_device_has_capability(const struct ratbag_device *device,
enum ratbag_device_capability cap);
/**
* @ingroup device
*
* Write any changes to the device. Depending on the device, this may take
* a couple of seconds.
*
* @param device A previously initialized ratbag device
* @return 0 on success or an error code otherwise
*/
enum ratbag_error_code
ratbag_device_commit(struct ratbag_device *device);
/**
* @ingroup device
*
* Return the number of profiles supported by this device.
*
* Note that the number of profiles available may be different to the number
* of profiles currently active. This function returns the maximum number of
* profiles available and is static for the lifetime of the device.
*
* A device that does not support profiles in hardware provides a single
* profile that reflects the current settings of the device.
*
* @param device A previously initialized ratbag device
* @return The number of profiles available on this device.
*/
unsigned int
ratbag_device_get_num_profiles(struct ratbag_device *device);
/**
* @ingroup device
*
* Return the number of buttons available on this device.
*
* @param device A previously initialized ratbag device
* @return The number of buttons available on this device.
*/
unsigned int
ratbag_device_get_num_buttons(struct ratbag_device *device);
/**
* @ingroup device
*
* Return the number of LEDs available on this device.
*
* @param device A previously initialized ratbag device
* @return The number of LEDs available on this device.
*/
unsigned int
ratbag_device_get_num_leds(struct ratbag_device *device);
/**
* @ingroup profile
*
* Add a reference to the profile. A profile is destroyed whenever the
* reference count reaches 0. See @ref ratbag_profile_unref.
*
* @param profile A previously initialized valid ratbag profile
* @return The passed ratbag profile
*/
struct ratbag_profile *
ratbag_profile_ref(struct ratbag_profile *profile);
/**
* @ingroup profile
*
* Dereference the ratbag profile. When the internal refcount reaches
* zero, all resources associated with this object are released. The object
* must be considered invalid once unref is called.
*
* @param profile A previously initialized ratbag profile
* @return Always NULL
*/
struct ratbag_profile *
ratbag_profile_unref(struct ratbag_profile *profile);
/**
* @ingroup profile
*
* Enable/disable the ratbag profile. For this to work, the device must support
* @ref RATBAG_DEVICE_CAP_DISABLE_PROFILE.
*
* @param profile A previously initialized ratbag profile
* @param enabled Whether to enable or disable the profile
*
* @return 0 on success or an error code otherwise
*/
enum ratbag_error_code
ratbag_profile_set_enabled(struct ratbag_profile *profile, bool enabled);
/**
* @ingroup profile
*
* Check whether the ratbag profile is enabled or not. For devices that don't
* support @ref RATBAG_DEVICE_CAP_DISABLE_PROFILE the profile will always be
* set to enabled.
*
* @param profile A previously initialized ratbag profile
*
* @return Whether the profile is enabled or not.
*/
bool
ratbag_profile_is_enabled(const struct ratbag_profile *profile);
/**
* @ingroup profile
*
* Set caller-specific data associated with this profile. libratbag does
* not manage, look at, or modify this data. The caller must ensure the
* data is valid.
*
* @param profile A previously initialized profile
* @param userdata Caller-specific data passed to the various callback
* interfaces.
*/
void
ratbag_profile_set_user_data(struct ratbag_profile *profile, void *userdata);
/**
* @ingroup profile
*
* Get the caller-specific data associated with this profile, if any.
*
* @param profile A previously initialized ratbag profile
* @return The caller-specific data previously assigned in
* ratbag_profile_set_user_data().
*/
void*
ratbag_profile_get_user_data(const struct ratbag_profile *profile);
/**
* @ingroup profile
*
* This function creates if necessary and returns a profile for the given
* index. The index must be less than the number returned by
* ratbag_get_num_profiles().
*
* The profile is refcounted with an initial value of at least 1.
* Use ratbag_profile_unref() to release the profile.
*
* @param device A previously initialized ratbag device
* @param index The index of the profile
*
* @return The profile at the given index, or NULL if the profile does not
* exist.
*
* @see ratbag_get_num_profiles
*/
struct ratbag_profile *
ratbag_device_get_profile(struct ratbag_device *device, unsigned int index);
/**
* @ingroup profile
*
* Check if the given profile is the currently active one. Note that some
* devices allow switching profiles with hardware buttons thus making the
* use of this function racy.
*
* @param profile A previously initialized ratbag profile
*
* @return non-zero if the profile is currently active, zero otherwise
*/
int
ratbag_profile_is_active(struct ratbag_profile *profile);
/**
* @ingroup profile
*
* Make the given profile the currently active profile
*
* @param profile The profile to make the active profile.
*
* @return 0 on success or an error code otherwise
*/
enum ratbag_error_code
ratbag_profile_set_active(struct ratbag_profile *profile);
/**
* @ingroup profile
*
* Get the number of @ref ratbag_resolution available in this profile. A
* resolution mode is a tuple of (resolution, report rate), each mode can be
* fetched with ratbag_profile_get_resolution_by_idx().
*
* The returned value is the maximum number of modes available and thus
* identical for all profiles. However, some of the modes may not be
* configured.
*
* @param profile A previously initialized ratbag profile
*
* @return The number of resolutions available.
*/
unsigned int
ratbag_profile_get_num_resolutions(struct ratbag_profile *profile);
/**
* @ingroup profile
*
* Return the resolution in DPI and the report rate in Hz for the resolution
* mode identified by the given index. The index must be between 0 and
* ratbag_profile_get_num_resolution_modes().
*
* See ratbag_profile_get_num_resolution_modes() for a description of
* resolution_modes.
*
* Profiles available but not currently configured on the device return
* success but set dpi and hz to 0.
*
* The returned struct has a refcount of at least 1, use
* ratbag_resolution_unref() to release the resources associated.
*
* @param profile A previously initialized ratbag profile
* @param idx The index of the resolution mode to get
*
* @return zero on success, non-zero otherwise. On error, dpi and hz are
* unmodified.
*/
struct ratbag_resolution *
ratbag_profile_get_resolution(struct ratbag_profile *profile, unsigned int idx);
/**
* @ingroup resolution
*
* Add a reference to the resolution. A resolution is destroyed whenever the
* reference count reaches 0. See @ref ratbag_resolution_unref.
*
* @param resolution A previously initialized valid ratbag resolution
* @return The passed ratbag resolution
*/
struct ratbag_resolution *
ratbag_resolution_ref(struct ratbag_resolution *resolution);
/**
* @ingroup resolution
*
* Dereference the ratbag resolution. When the internal refcount reaches
* zero, all resources associated with this object are released. The object
* must be considered invalid once unref is called.
*
* @param resolution A previously initialized ratbag resolution
* @return Always NULL
*/
struct ratbag_resolution *
ratbag_resolution_unref(struct ratbag_resolution *resolution);
/**
* @ingroup resolution
*
* Set caller-specific data associated with this resolution. libratbag does
* not manage, look at, or modify this data. The caller must ensure the
* data is valid.
*
* @param resolution A previously initialized resolution
* @param userdata Caller-specific data passed to the various callback
* interfaces.
*/
void
ratbag_resolution_set_user_data(struct ratbag_resolution *resolution, void *userdata);
/**
* @ingroup resolution
*
* Get the caller-specific data associated with this resolution, if any.
*
* @param resolution A previously initialized ratbag resolution
* @return The caller-specific data previously assigned in
* ratbag_resolution_set_user_data().
*/
void*
ratbag_resolution_get_user_data(const struct ratbag_resolution *resolution);
enum ratbag_resolution_capability {
/**
* The report rate can be set per resolution mode. If this property
* is not available, all resolutions within the same profile have
* the same report rate and changing one changes the others.
*/
RATBAG_RESOLUTION_CAP_INDIVIDUAL_REPORT_RATE = 1,
/**
* The resolution can be set for x and y separately.
*/
RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION,
};
/**
* @ingroup resolution
*
* Check if a resolution has a specific capability.
*
* @return non-zero if the capability is available, zero otherwise.
*/
int
ratbag_resolution_has_capability(struct ratbag_resolution *resolution,
enum ratbag_resolution_capability cap);
/**
* @ingroup resolution
*
* Set the resolution in DPI for the resolution mode.
* If the resolution has the @ref
* RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION capability, this function
* sets both x and y resolution to the given value.
*
* A value of 0 for dpi disables the mode.
*
* If the resolution mode is the currently active mode and the profile is
* the currently active profile, the change takes effect immediately.
*
* @param resolution A previously initialized ratbag resolution
* @param dpi Set to the resolution in dpi, 0 to disable
*
* @return zero on success or an error code on failure
*/
enum ratbag_error_code
ratbag_resolution_set_dpi(struct ratbag_resolution *resolution,
unsigned int dpi);
/**
* @ingroup resolution
*
* Set the x and y resolution in DPI for the resolution mode.
* If the resolution does not have the @ref
* RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION capability, this function
* returns an error and does nothing.
*
* A value of 0 for both x and y disables the mode. If either value is 0 and
* the other value is non-zero, this function returns an error and does
* nothing.
*
* If the resolution mode is the currently active mode and the profile is
* the currently active profile, the change takes effect immediately.
*
* @param resolution A previously initialized ratbag resolution with the
* @ref RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION capability
* @param x The x resolution in dpi
* @param y The y resolution in dpi
*
* @return zero on success or an error code on failure
*/
enum ratbag_error_code
ratbag_resolution_set_dpi_xy(struct ratbag_resolution *resolution,
unsigned int x, unsigned int y);
/**
* @ingroup resolution
*
* Get the resolution in DPI for the resolution mode.
* If the resolution has the @ref
* RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION capability, this function
* returns the x resolution, see ratbag_resolution_get_dpi_x().
*
* A value of 0 for dpi indicates the mode is disabled.
*
* @param resolution A previously initialized ratbag resolution
*
* @return The resolution in dpi
*/
int
ratbag_resolution_get_dpi(struct ratbag_resolution *resolution);
/**
* @ingroup resolution
*
* Get the x resolution in DPI for the resolution mode. If the resolution
* does not have the @ref RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION
* capability, this function is identical to ratbag_resolution_get_dpi().
*
* A value of 0 for dpi indicates the mode is disabled.
*
* @param resolution A previously initialized ratbag resolution with the
* @ref RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION capability
*
* @return The resolution in dpi
*/
int
ratbag_resolution_get_dpi_x(struct ratbag_resolution *resolution);
/**
* @ingroup resolution
*
* Get the y resolution in DPI for the resolution mode. If the resolution
* does not have the @ref RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION
* capability, this function is identical to ratbag_resolution_get_dpi().
*
* A value of 0 for dpi indicates the mode is disabled.
*
* @param resolution A previously initialized ratbag resolution with the
* @ref RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION capability
*
* @return The resolution in dpi
*/
int
ratbag_resolution_get_dpi_y(struct ratbag_resolution *resolution);
/**
* @ingroup resolution
*
* Set the report rate in Hz for the resolution mode.
*
* A value of 0 hz disables the mode.
*
* If the resolution mode is the currently active mode and the profile is
* the currently active profile, the change takes effect immediately.
*
* If the resolution does not have the @ref
* RATBAG_RESOLUTION_CAP_INDIVIDUAL_REPORT_RATE capability, changing the
* report rate on one resolution changes the report rate for all resolutions
* in this profile.
*
* @param resolution A previously initialized ratbag resolution
* @param hz Set to the report rate in Hz, may be 0
*
* @return zero on success or an error code on failure
*/
enum ratbag_error_code
ratbag_resolution_set_report_rate(struct ratbag_resolution *resolution,
unsigned int hz);
/**
* @ingroup resolution
*
* Get the report rate in Hz for the resolution mode.
*
* A value of 0 hz indicates the mode is disabled.
*
* @param resolution A previously initialized ratbag resolution
*
* @return The report rate for this resolution in Hz
*/
int
ratbag_resolution_get_report_rate(struct ratbag_resolution *resolution);
/**
* @ingroup resolution
*
* Activate the given resolution mode. If the mode is not configured, this
* function returns an error and the result is undefined.
*
* The mode must be one of the current profile, otherwise an error is
* returned.
*
* @param resolution A previously initialized ratbag resolution
*
* @return zero on success or an error code on failure
*/
enum ratbag_error_code
ratbag_resolution_set_active(struct ratbag_resolution *resolution);
/**
* @ingroup resolution
*
* Check if the resolution mode is the currently active one.
*
* If the profile is the currently active profile, the mode is the one
* currently active. For profiles not currently active, this always returns 0.
*
* @param resolution A previously initialized ratbag resolution
*
* @return Non-zero if the resolution mode is the active one, zero
* otherwise.
*/
int
ratbag_resolution_is_active(const struct ratbag_resolution *resolution);
/**
* @ingroup resolution
*
* Set the default resolution mode for the associated profile. When the
* device switches to the profile next, this mode will be the active
* resolution. If the mode is not configured, this function returns an error
* and the result is undefined.
*
* This only switches the default resolution, not the currently active
* resolution. Use ratbag_resolution_set_active() instead.
*
* @param resolution A previously initialized ratbag resolution
*
* @return zero on success or an error code on failure
*/
enum ratbag_error_code
ratbag_resolution_set_default(struct ratbag_resolution *resolution);
/**
* @ingroup resolution
*
* Check if the resolution mode is the default one in this profile.
*
* The default resolution is the one the device selects when switching to
* the corresponding profile. It may not be the currently active resolution,
* use ratbag_resolution_is_active() instead.
*
* @param resolution A previously initialized ratbag resolution
*
* @return Non-zero if the resolution mode is the default one, zero
* otherwise.
*/
int
ratbag_resolution_is_default(const struct ratbag_resolution *resolution);
/**
* @ingroup profile
*
* Return a reference to the button given by the index. The order of the
* buttons is device-specific though indices 0, 1 and 2 should always refer
* to left, middle, right buttons. Use ratbag_button_get_type() to get the
* physical type of the button.
*
* The button is refcounted with an initial value of at least 1.
* Use ratbag_button_unref() to release the button.
*
* @param profile A previously initialized ratbag profile
* @param index The index of the button
*
* @return A button context, or NULL if the button does not exist.
*
* @see ratbag_device_get_num_buttons
*/
struct ratbag_button*
ratbag_profile_get_button(struct ratbag_profile *profile, unsigned int index);
/**
* @ingroup button
*
* Set caller-specific data associated with this button. libratbag does
* not manage, look at, or modify this data. The caller must ensure the
* data is valid.
*
* @param button A previously initialized button
* @param userdata Caller-specific data passed to the various callback
* interfaces.
*/
void
ratbag_button_set_user_data(struct ratbag_button *button, void *userdata);
/**
* @ingroup button
*
* Get the caller-specific data associated with this button, if any.
*
* @param button A previously initialized ratbag button
* @return The caller-specific data previously assigned in
* ratbag_button_set_user_data().
*/
void*
ratbag_button_get_user_data(const struct ratbag_button *button);
/**
* @ingroup button
*
* Button types describing the physical button.
*/
enum ratbag_button_type {
RATBAG_BUTTON_TYPE_UNKNOWN = 0,
/* mouse buttons */
RATBAG_BUTTON_TYPE_LEFT,
RATBAG_BUTTON_TYPE_MIDDLE,
RATBAG_BUTTON_TYPE_RIGHT,
RATBAG_BUTTON_TYPE_THUMB,
RATBAG_BUTTON_TYPE_THUMB2,
RATBAG_BUTTON_TYPE_THUMB3,
RATBAG_BUTTON_TYPE_THUMB4,
RATBAG_BUTTON_TYPE_WHEEL_LEFT,
RATBAG_BUTTON_TYPE_WHEEL_RIGHT,
RATBAG_BUTTON_TYPE_WHEEL_CLICK,
RATBAG_BUTTON_TYPE_WHEEL_UP,
RATBAG_BUTTON_TYPE_WHEEL_DOWN,
/**
* A button to toggle the wheel from free-spinning to click-based.
*/
RATBAG_BUTTON_TYPE_WHEEL_RATCHET_MODE_SHIFT,
RATBAG_BUTTON_TYPE_EXTRA,
RATBAG_BUTTON_TYPE_SIDE,
RATBAG_BUTTON_TYPE_PINKIE,
RATBAG_BUTTON_TYPE_PINKIE2,
/* DPI switch */
RATBAG_BUTTON_TYPE_RESOLUTION_CYCLE_UP,
RATBAG_BUTTON_TYPE_RESOLUTION_UP,
RATBAG_BUTTON_TYPE_RESOLUTION_DOWN,
/* Profile */
RATBAG_BUTTON_TYPE_PROFILE_CYCLE_UP,
RATBAG_BUTTON_TYPE_PROFILE_UP,
RATBAG_BUTTON_TYPE_PROFILE_DOWN,
};
/**
* @ingroup button
*
* Return the type of the physical button. This function is intended to be
* used by configuration tools to provide a generic list of button names or
* handles to configure devices. The type describes the physical location of
* the button and remains constant for the lifetime of the device.
* For example, a button of type @ref RATBAG_BUTTON_TYPE_WHEEL_CLICK may be
* mapped to a logical middle button, but the physical description is that
* of a wheel click.
*
* For the button currently mapped to this physical button, see
* ratbag_button_get_button()
*
* @return The type of the button
*/
enum ratbag_button_type
ratbag_button_get_type(struct ratbag_button *button);
/**
* @ingroup button
*
* The type assigned to a button.
*/
enum ratbag_button_action_type {
/**
* Button action is unknown
*/
RATBAG_BUTTON_ACTION_TYPE_UNKNOWN = -1,
/**
* Button is disabled
*/
RATBAG_BUTTON_ACTION_TYPE_NONE = 0,
/**
* Button sends numeric button events
*/
RATBAG_BUTTON_ACTION_TYPE_BUTTON,
/**
* Button triggers a mouse-specific special function. This includes
* resolution changes and profile changes.
*/
RATBAG_BUTTON_ACTION_TYPE_SPECIAL,
/**
* Button sends a key or key + modifier combination
*/
RATBAG_BUTTON_ACTION_TYPE_KEY,
/**
* Button sends a user-defined key or button sequence
*/
RATBAG_BUTTON_ACTION_TYPE_MACRO,
};
/**
* @ingroup button
*
* @return The type of the action currently configured for this button
*/
enum ratbag_button_action_type
ratbag_button_get_action_type(struct ratbag_button *button);
/**
* @ingroup button
*
* Check if a button supports a specific action type. Not all devices allow
* all buttons to be assigned any action. Ability to change a button to a
* given action type does not guarantee that any specific action can be
* configured.
*
* @note It is a client bug to pass in @ref
* RATBAG_BUTTON_ACTION_TYPE_UNKNOWN or @ref
* RATBAG_BUTTON_ACTION_TYPE_NONE.
*
* @param button A previously initialized button
* @param action_type An action type
*
* @return non-zero if the action type is supported, zero otherwise.
*/
int
ratbag_button_has_action_type(struct ratbag_button *button,
enum ratbag_button_action_type action_type);
/**
* @ingroup button
*/
enum ratbag_button_action_special {
/**
* This button is not set up for a special action
*/
RATBAG_BUTTON_ACTION_SPECIAL_INVALID = -1,
RATBAG_BUTTON_ACTION_SPECIAL_UNKNOWN = (1 << 30),
RATBAG_BUTTON_ACTION_SPECIAL_DOUBLECLICK,
/* Wheel mappings */
RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_LEFT,
RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_RIGHT,
RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_UP,
RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_DOWN,
RATBAG_BUTTON_ACTION_SPECIAL_RATCHET_MODE_SWITCH,
/* DPI switch */
RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_UP,
RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_DOWN,
RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_UP,
RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DOWN,
RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_ALTERNATE,
RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DEFAULT,
/* Profile */
RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_UP,
RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_DOWN,
RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_UP,
RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_DOWN,
/* second mode for buttons */
RATBAG_BUTTON_ACTION_SPECIAL_SECOND_MODE,
/* battery level */
RATBAG_BUTTON_ACTION_SPECIAL_BATTERY_LEVEL,
};
/**
* @ingroup button
*
* If a button's action is @ref RATBAG_BUTTON_ACTION_TYPE_BUTTON,
* this function returns the logical button number this button is mapped to,
* starting at 1. The button numbers are in sequence and do not correspond
* to any meaning other than its numeric value. It is up to the input stack
* how to map that logical button number, but usually buttons 1, 2 and 3 are
* mapped into left, middle, right.
*
* If the button's action type is not @ref RATBAG_BUTTON_ACTION_TYPE_BUTTON,
* this function returns 0.
*
* @return The logical button number this button sends.
* @retval 0 This button is disabled or its action type is not @ref
* RATBAG_BUTTON_ACTION_TYPE_BUTTON.
*
* @see ratbag_button_set_button
*/
unsigned int
ratbag_button_get_button(struct ratbag_button *button);
/**
* @ingroup button
*
* See ratbag_button_get_button() for a description of the button number.
*
* @param button A previously initialized ratbag button
* @param btn The logical button number to assign to this button.
* @return 0 on success or an error code otherwise. On success, the button's
* action is set to @ref RATBAG_BUTTON_ACTION_TYPE_BUTTON.
*
* @see ratbag_button_get_button
*/
enum ratbag_error_code
ratbag_button_set_button(struct ratbag_button *button,
unsigned int btn);
/**
* @ingroup button
*
* If a button's action is @ref RATBAG_BUTTON_ACTION_TYPE_SPECIAL,
* this function returns the special function assigned to this button.
*
* If the button's action type is not @ref RATBAG_BUTTON_ACTION_TYPE_SPECIAL,
* this function returns @ref RATBAG_BUTTON_ACTION_SPECIAL_INVALID.
*
* @return The special function assigned to this button
*
* @see ratbag_button_set_button
*/
enum ratbag_button_action_special
ratbag_button_get_special(struct ratbag_button *button);
/**
* @ingroup led
*
* RATBAG_LED_OFF - led is now off,
* RATBAG_LED_ON - led is on with static color,
* RATBAG_LED_CYCLE - led is cycling between all colors.
* RATBAG_LED_BREATHING - led is pulsating with static color
*
* Each LED mode has different properties, e.g. the brightness and rate are only
* available in modes @ref RATBAG_LED_CYCLE and @ref RATBAG_LED_BREATHING modes
*/
enum ratbag_led_mode {
RATBAG_LED_OFF = 0,
RATBAG_LED_ON,
RATBAG_LED_CYCLE,
RATBAG_LED_BREATHING,
};
/**
* @ingroup led
*
* LED types, usually based on their physical location
*/
enum ratbag_led_type {
RATBAG_LED_TYPE_UNKNOWN = -1,
RATBAG_LED_TYPE_LOGO = 0,
RATBAG_LED_TYPE_SIDE
};
/**
* @ingroup led
*
* Return a reference to the LED given by the index. The order of the
* LEDs is device-specific though.
*
* The LED is refcounted with an initial value of at least 1.
* Use ratbag_led_unref() to release the LED.
*
* @param profile A previously initialized ratbag profile
* @param index The index of the LED
*
* @return A LED context, or NULL if the LED does not exist.
*
* @see ratbag_device_get_profile
*/
struct ratbag_led *
ratbag_profile_get_led(struct ratbag_profile *profile, unsigned int index);
/**
* @ingroup led
*
* This function returns the type for ratbag_led.
*
* @param led A previously initialized ratbag LED
* @return The LED type @ref ratbag_led_type
*
* @see ratbag_led_set_mode
*/
enum ratbag_led_type
ratbag_led_get_type(struct ratbag_led *led);
/**
* @ingroup led
*
* This function returns the mode for ratbag_led.
*
* @param led A previously initialized ratbag LED
* @return The LED mod @ref ratbag_led_mode
*
* @see ratbag_led_set_mode
*/
enum ratbag_led_mode
ratbag_led_get_mode(struct ratbag_led *led);
/**
* @ingroup led
*
* This function returns the led color.
*
* @param led A previously initialized ratbag LED
* @return The LED color in @ref ratbag_led_mode
*
* @see ratbag_led_set_color
*/
struct ratbag_color
ratbag_led_get_color(struct ratbag_led *led);
/**
* @ingroup led
*
* This function returns the LED effect rate.
*
* @param led A previously initialized ratbag LED
* @return The LED rate in Hz, can be 100 - 20000
*
* @see ratbag_led_set_effect_rate
*/
int
ratbag_led_get_effect_rate(struct ratbag_led *led);
/**
* @ingroup led
*
* This function returns the LED brightness.
*
* @param led A previously initialized ratbag LED
* @return The LED brightness 0 - 255
*
* @see ratbag_led_get_brightness
*/
unsigned int
ratbag_led_get_brightness(struct ratbag_led *led);
/**
* @ingroup led
*
* this function sets the LED mode.
*
* @param led A previously initialized ratbag LED
* @param mode LED mode @ref ratbag_led_mode.
* @return 0 on success or an error code otherwise.
*
* @see ratbag_led_get_mode
*/
enum ratbag_error_code
ratbag_led_set_mode(struct ratbag_led *led, enum ratbag_led_mode mode);
/**
* @ingroup led
*
* If the LED's mode is @ref RATBAG_LED_ON or @ref RATBAG_LED_BREATHING
* then this function sets the LED color, otherwise it has no effect.
*
* @param led A previously initialized ratbag LED
* @param color A LED color.
* @return 0 on success or an error code otherwise.
*
* @see ratbag_led_get_color
*/
enum ratbag_error_code
ratbag_led_set_color(struct ratbag_led *led, struct ratbag_color color);
/**
* @ingroup led
*
* If the LED's mode is @ref RATBAG_LED_CYCLE or @ref RATBAG_LED_BREATHING
* then this function sets the LED rate in Hz
*
* @param led A previously initialized ratbag LED
* @param rate Effect rate in hz, 100 - 20000
* @return 0 on success or an error code otherwise.
*
* @see ratbag_led_get_effect_rate
*/
enum ratbag_error_code
ratbag_led_set_effect_rate(struct ratbag_led *led, unsigned int rate);
/**
* @ingroup led
*
* If the LED's mode is @ref RATBAG_LED_CYCLE or @ref RATBAG_LED_BREATHING
* then this function sets the LED brightness, otherwise it has no effect.
*
* @param led A previously initialized ratbag LED
* @param brightness Effect brightness 0 - 255
* @return 0 on success or an error code otherwise.
*
* @see ratbag_led_get_brightness
*/
enum ratbag_error_code
ratbag_led_set_brightness(struct ratbag_led *led, unsigned int brightness);
/**
* @ingroup button
*
* This function sets the special function assigned to this button.
*
* @param button A previously initialized ratbag button
* @param action The special action to assign to this button.
* @return 0 on success or an error code otherwise. On success, the button's
* action is set to @ref RATBAG_BUTTON_ACTION_TYPE_SPECIAL.
*
* @see ratbag_button_get_button
*/
enum ratbag_error_code
ratbag_button_set_special(struct ratbag_button *button,
enum ratbag_button_action_special action);
/**
* @ingroup button
*
* If a button's action is @ref RATBAG_BUTTON_ACTION_TYPE_KEY,
* this function returns the key or button configured for this button.
*
* If the button's action type is not @ref RATBAG_BUTTON_ACTION_TYPE_KEY,
* this function returns 0 and leaves modifiers and sz untouched.
*
* @param button A previously initialized ratbag button
* @param[out] modifiers Will be filled with the modifiers required for this
* action. The modifiers are as defined in linux/input.h.
* @param[in,out] sz Takes the size of the modifiers array and returns the
* number of modifiers filled in. sz may be 0 if no modifiers are required.
*
* @note The caller must ensure that modifiers is large enough to accomodate
* for the key combination.
*
* @return The button number
*/
unsigned int
ratbag_button_get_key(struct ratbag_button *button,
unsigned int *modifiers,
size_t *sz);
/**
* @ingroup button
*
* @param button A previously initialized ratbag button
* @param key The button number to assign to this button, one of BTN_* as
* defined in linux/input.h
* @param modifiers The modifiers required for this action. The
* modifiers are as defined in linux/input.h, in the order they should be
* pressed.
* @param sz The size of the modifiers array. sz may be 0 if no modifiers
* are required.
*
* @return 0 on success or an error code otherwise. On success, the button's
* action is set to @ref RATBAG_BUTTON_ACTION_TYPE_KEY.
*/
enum ratbag_error_code
ratbag_button_set_key(struct ratbag_button *button,
unsigned int key,
unsigned int *modifiers,
size_t sz);
/**
* @ingroup button
*
* @param button A previously initialized ratbag button
*
* @return 0 on success or an error code otherwise. On success, the button's
* action is set to @ref RATBAG_BUTTON_ACTION_TYPE_NONE.
*/
enum ratbag_error_code
ratbag_button_disable(struct ratbag_button *button);
/**
* @ingroup button
*
* Macro event types describing the event.
*/
enum ratbag_macro_event_type {
RATBAG_MACRO_EVENT_INVALID = -1,
RATBAG_MACRO_EVENT_NONE = 0,
RATBAG_MACRO_EVENT_KEY_PRESSED,
RATBAG_MACRO_EVENT_KEY_RELEASED,
RATBAG_MACRO_EVENT_WAIT,
};
/**
* @ingroup button
*
* @param macro A previously initialized ratbag button macro
*
* @return The name of the macro
*/
const char *
ratbag_button_macro_get_name(struct ratbag_button_macro *macro);
/**
* @ingroup button
*
* @param macro A previously initialized ratbag button macro
*
* @return The maximum number of events that can be assigned to this macro
*/
unsigned int
ratbag_button_macro_get_num_events(struct ratbag_button_macro *macro);
/**
* @ingroup button
*
* Returns the macro event type configured for the event at the
* given index.
*
* The behavior of this function for an index equal to or greater than the
* return value of ratbag_button_macro_get_num_events() is undefined.
*
* @param macro A previously initialized ratbag button macro
* @param index An index of the event within the macro we are interested in.
*
* @return The type of the event at the given index
*/
enum ratbag_macro_event_type
ratbag_button_macro_get_event_type(struct ratbag_button_macro *macro,
unsigned int index);
/**
* @ingroup button
*
* If the event stored at the given index is @ref
* RATBAG_MACRO_EVENT_KEY_PRESSED or @ref RATBAG_MACRO_EVENT_KEY_RELEASED,
* this function returns the key code configured for the event at the given
* index.
*
* The behavior of this function for an index equal to or greater than the
* return value of ratbag_button_macro_get_num_events() is undefined.
*
* @param macro A previously initialized ratbag button macro
* @param index An index of the event within the macro we are interested in.
*
* @return The key of the event at the given index
*/
int
ratbag_button_macro_get_event_key(struct ratbag_button_macro*macro,
unsigned int index);
/**
* @ingroup button
*
* If the event stored at the given index is @ref RATBAG_MACRO_EVENT_WAIT,
* this function returns the timeout configured for the event at the given
* index.
*
* The behavior of this function for an index equal to or greater than the
* return value of ratbag_button_macro_get_num_events() is undefined.
*
* @param macro A previously initialized ratbag button macro
* @param index An index of the event within the macro we are interested in.
*
* @return The timeout of the event at the given index
*/
int
ratbag_button_macro_get_event_timeout(struct ratbag_button_macro *macro,
unsigned int index);
/**
* @ingroup button
*
* Sets the button's action to @ref RATBAG_BUTTON_ACTION_TYPE_MACRO and
* assigns the given macro to this button.
*
* libratbag does not use the macro struct passed in, it extracts the
* required information from the struct. Changes to the macro after a call
* to ratbag_button_set_macro() are not reflected in the device until a
* subsequent call to ratbag_button_set_macro().
*
* @param button A previously intialized ratbag button
* @param macro A fully initialized macro
*
* @return 0 on success or nonzero otherwise
*/
enum ratbag_error_code
ratbag_button_set_macro(struct ratbag_button *button,
const struct ratbag_button_macro *macro);
/**
* @ingroup button
*
* Initialize a new button macro.
*
* The macro is refcounted with an initial value of at least 1.
* Use ratbag_button_macro_unref() to release the macro.
*
* Note that some devices have limited storage for the macro names.
* libratbag silently shortens macro names to the longest string the device
* is capable of storing.
*
* @param name The name to assign to this macro.
*
* @return An "empty" button macro
*/
struct ratbag_button_macro *
ratbag_button_macro_new(const char *name);
/**
* @ingroup button
*
* If a button's action is @ref RATBAG_BUTTON_ACTION_TYPE_MACRO,
* this function returns the current button macro. The macro is a copy of
* the one used on the device, changes to the macro are not reflected on the
* device until a subsequent call to ratbag_button_set_macro().
*
* If a button's action is not @ref RATBAG_BUTTON_ACTION_TYPE_MACRO,
* this function returns NULL.
*
* @param button A previously initialized ratbag button
*/
struct ratbag_button_macro *
ratbag_button_get_macro(struct ratbag_button *button);
/**
* @ingroup button
*
* Sets the macro's event at the given index to the given type with the
* key code or timeout given.
*
* The behavior of this function for an index equal to or greater than the
* return value of ratbag_button_macro_get_num_events() is undefined.
*/
enum ratbag_error_code
ratbag_button_macro_set_event(struct ratbag_button_macro *macro,
unsigned int index,
enum ratbag_macro_event_type type,
unsigned int data);
/**
* @ingroup button
*
* Add a reference to the macro. A macro is destroyed whenever the
* reference count reaches 0. See @ref ratbag_button_macro_unref.
*
* @param macro A previously initialized valid ratbag button macro
* @return The passed ratbag macro
*/
struct ratbag_button_macro *
ratbag_button_macro_ref(struct ratbag_button_macro *macro);
/**
* @ingroup button
*
* Dereference the ratbag button macro. When the internal refcount reaches
* zero, all resources associated with this object are released. The object
* must be considered invalid once unref is called.
*
* @param macro A previously initialized ratbag button macro
* @return Always NULL
*/
struct ratbag_button_macro *
ratbag_button_macro_unref(struct ratbag_button_macro *macro);
/**
* @ingroup button
*
* Add a reference to the button. A button is destroyed whenever the
* reference count reaches 0. See @ref ratbag_button_unref.
*
* @param button A previously initialized valid ratbag button
* @return The passed ratbag button
*/
struct ratbag_button *
ratbag_button_ref(struct ratbag_button *button);
/**
* @ingroup button
*
* Dereference the ratbag button. When the internal refcount reaches
* zero, all resources associated with this object are released. The object
* must be considered invalid once unref is called.
*
* @param button A previously initialized ratbag button
* @return Always NULL
*/
struct ratbag_button *
ratbag_button_unref(struct ratbag_button *button);
/**
* @ingroup led
*
* Add a reference to the led. A led is destroyed whenever the
* reference count reaches 0. See @ref ratbag_led_unref.
*
* @param led A previously initialized valid ratbag led
* @return The passed ratbag led
*/
struct ratbag_led *
ratbag_led_ref(struct ratbag_led *led);
/**
* @ingroup led
*
* Dereference the ratbag led. When the internal refcount reaches
* zero, all resources associated with this object are released. The object
* must be considered invalid once unref is called.
*
* @param led A previously initialized ratbag led
* @return Always NULL
*/
struct ratbag_led *
ratbag_led_unref(struct ratbag_led *led);
#ifdef __cplusplus
}
#endif
|