xdg_shell_client_protocol/xdg_shell_client_protocol.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492
// GENERATED FILE -- DO NOT EDIT
//
// Copyright © 2008-2013 Kristian Høgsberg
// Copyright © 2013 Rafael Antognolli
// Copyright © 2013 Jasper St. Pierre
// Copyright © 2010-2013 Intel Corporation
// Copyright © 2015-2017 Samsung Electronics Co., Ltd
// Copyright © 2015-2017 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.
#![allow(warnings)]
#![allow(clippy::all)]
use anyhow;
#[allow(unused_imports)]
use fuchsia_wayland_core::{Array, Enum, Fixed, NewId, NewObject};
use fuchsia_wayland_core::{ArgKind, Arg, FromArgs, IntoMessage, Message,
MessageGroupSpec, MessageHeader, MessageSpec, MessageType,
ObjectId, EncodeError, DecodeError, Interface};
pub mod xdg_wm_base {
use super::*;
/// create desktop-style surfaces
///
/// The xdg_wm_base interface is exposed as a global object enabling clients
/// to turn their wl_surfaces into windows in a desktop environment. It
/// defines the basic functionality needed for clients and the compositor to
/// create windows that can be dragged, resized, maximized, etc, as well as
/// creating transient windows such as popup menus.
#[derive(Debug)]
pub struct XdgWmBase;
impl Interface for XdgWmBase {
const NAME: &'static str = "xdg_wm_base";
const VERSION: u32 = 3;
const REQUESTS: MessageGroupSpec = MessageGroupSpec(&[
// destroy
MessageSpec(&[
]),
// create_positioner
MessageSpec(&[
ArgKind::NewId,
]),
// get_xdg_surface
MessageSpec(&[
ArgKind::NewId,
ArgKind::Object,
]),
// pong
MessageSpec(&[
ArgKind::Uint,
]),
]);
const EVENTS: MessageGroupSpec = MessageGroupSpec(&[
// ping
MessageSpec(&[
ArgKind::Uint,
]),
]);
type Incoming = Event;
type Outgoing = Request;
}
#[derive(Debug)]
pub enum Request {
/// destroy xdg_wm_base
///
/// Destroy this xdg_wm_base object.
///
/// Destroying a bound xdg_wm_base object while there are surfaces
/// still alive created by this xdg_wm_base object instance is illegal
/// and will result in a protocol error.
Destroy,
/// create a positioner object
///
/// Create a positioner object. A positioner object is used to position
/// surfaces relative to some parent surface. See the interface description
/// and xdg_surface.get_popup for details.
CreatePositioner {
id: NewId,
},
/// create a shell surface from a surface
///
/// This creates an xdg_surface for the given surface. While xdg_surface
/// itself is not a role, the corresponding surface may only be assigned
/// a role extending xdg_surface, such as xdg_toplevel or xdg_popup.
///
/// This creates an xdg_surface for the given surface. An xdg_surface is
/// used as basis to define a role to a given surface, such as xdg_toplevel
/// or xdg_popup. It also manages functionality shared between xdg_surface
/// based surface roles.
///
/// See the documentation of xdg_surface for more details about what an
/// xdg_surface is and how it is used.
GetXdgSurface {
id: NewId,
surface: ObjectId,
},
/// respond to a ping event
///
/// A client must respond to a ping event with a pong request or
/// the client may be deemed unresponsive. See xdg_wm_base.ping.
Pong {
/// serial of the ping event
serial: u32,
},
}
impl MessageType for Request {
fn log(&self, this: ObjectId) -> String {
match *self {
Request::Destroy {
} => {
format!("xdg_wm_base@{:?}::destroy()", this)
}
Request::CreatePositioner {
ref id,
} => {
format!("xdg_wm_base@{:?}::create_positioner(id: {:?})", this, id)
}
Request::GetXdgSurface {
ref id,
ref surface,
} => {
format!("xdg_wm_base@{:?}::get_xdg_surface(id: {:?}, surface: {:?})", this, id, surface)
}
Request::Pong {
ref serial,
} => {
format!("xdg_wm_base@{:?}::pong(serial: {:?})", this, serial)
}
}
}
fn message_name(&self) -> &'static std::ffi::CStr{
match *self {
Request::Destroy { .. } => c"xdg_wm_base::destroy",
Request::CreatePositioner { .. } => c"xdg_wm_base::create_positioner",
Request::GetXdgSurface { .. } => c"xdg_wm_base::get_xdg_surface",
Request::Pong { .. } => c"xdg_wm_base::pong",
}
}
}
#[derive(Debug)]
pub enum Event {
/// check if the client is alive
///
/// The ping event asks the client if it's still alive. Pass the
/// serial specified in the event back to the compositor by sending
/// a "pong" request back with the specified serial. See xdg_wm_base.pong.
///
/// Compositors can use this to determine if the client is still
/// alive. It's unspecified what will happen if the client doesn't
/// respond to the ping request, or in what timeframe. Clients should
/// try to respond in a reasonable amount of time.
///
/// A compositor is free to ping in any way it wants, but a client must
/// always respond to any xdg_wm_base object it created.
Ping {
/// pass this to the pong request
serial: u32,
},
}
impl MessageType for Event {
fn log(&self, this: ObjectId) -> String {
match *self {
Event::Ping {
ref serial,
} => {
format!("xdg_wm_base@{:?}::ping(serial: {:?})", this, serial)
}
}
}
fn message_name(&self) -> &'static std::ffi::CStr{
match *self {
Event::Ping { .. } => c"xdg_wm_base::ping",
}
}
}
impl IntoMessage for Request {
type Error = EncodeError;
fn into_message(self, id: u32) -> Result<Message, <Self as IntoMessage>::Error> {
let mut header = MessageHeader {
sender: id,
opcode: 0,
length: 0,
};
let mut msg = Message::new();
msg.write_header(&header)?;
match self {
Request::Destroy {
} => {
header.opcode = 0;
},
Request::CreatePositioner {
id,
} => {
msg.write_arg(Arg::NewId(id))?;
header.opcode = 1;
},
Request::GetXdgSurface {
id,
surface,
} => {
msg.write_arg(Arg::NewId(id))?;
msg.write_arg(Arg::Object(surface))?;
header.opcode = 2;
},
Request::Pong {
serial,
} => {
msg.write_arg(Arg::Uint(serial))?;
header.opcode = 3;
},
}
header.length = msg.bytes().len() as u16;
msg.rewind();
msg.write_header(&header)?;
Ok(msg)
}
}
impl FromArgs for Event {
fn from_args(op: u16, mut args: Vec<Arg>) -> Result<Self, anyhow::Error> {
match op {
0 /* ping */ => {
let mut iter = args.into_iter();
Ok(Event::Ping {
serial: iter.next()
.ok_or(DecodeError::InsufficientArgs)?
.as_uint()?,
})
},
_ => {
Err(DecodeError::InvalidOpcode(op).into())
},
}
}
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum Error {
/// given wl_surface has another role,
Role = 0,
/// xdg_wm_base was destroyed before children,
DefunctSurfaces = 1,
/// the client tried to map or destroy a non-topmost popup,
NotTheTopmostPopup = 2,
/// the client specified an invalid popup parent surface,
InvalidPopupParent = 3,
/// the client provided an invalid surface state,
InvalidSurfaceState = 4,
/// the client provided an invalid positioner,
InvalidPositioner = 5,
}
impl Error {
pub fn from_bits(v: u32) -> Option<Self> {
match v {
0 => Some(Error::Role),
1 => Some(Error::DefunctSurfaces),
2 => Some(Error::NotTheTopmostPopup),
3 => Some(Error::InvalidPopupParent),
4 => Some(Error::InvalidSurfaceState),
5 => Some(Error::InvalidPositioner),
_ => None,
}
}
pub fn bits(&self) -> u32 {
*self as u32
}
}
impl Into<Arg> for Error {
fn into(self) -> Arg {
Arg::Uint(self.bits())
}
}
} // mod xdg_wm_base
pub use crate::xdg_wm_base::XdgWmBase;
pub use crate::xdg_wm_base::Request as XdgWmBaseRequest;
pub use crate::xdg_wm_base::Event as XdgWmBaseEvent;
pub mod xdg_positioner {
use super::*;
/// child surface positioner
///
/// The xdg_positioner provides a collection of rules for the placement of a
/// child surface relative to a parent surface. Rules can be defined to ensure
/// the child surface remains within the visible area's borders, and to
/// specify how the child surface changes its position, such as sliding along
/// an axis, or flipping around a rectangle. These positioner-created rules are
/// constrained by the requirement that a child surface must intersect with or
/// be at least partially adjacent to its parent surface.
///
/// See the various requests for details about possible rules.
///
/// At the time of the request, the compositor makes a copy of the rules
/// specified by the xdg_positioner. Thus, after the request is complete the
/// xdg_positioner object can be destroyed or reused; further changes to the
/// object will have no effect on previous usages.
///
/// For an xdg_positioner object to be considered complete, it must have a
/// non-zero size set by set_size, and a non-zero anchor rectangle set by
/// set_anchor_rect. Passing an incomplete xdg_positioner object when
/// positioning a surface raises an error.
#[derive(Debug)]
pub struct XdgPositioner;
impl Interface for XdgPositioner {
const NAME: &'static str = "xdg_positioner";
const VERSION: u32 = 3;
const REQUESTS: MessageGroupSpec = MessageGroupSpec(&[
// destroy
MessageSpec(&[
]),
// set_size
MessageSpec(&[
ArgKind::Int,
ArgKind::Int,
]),
// set_anchor_rect
MessageSpec(&[
ArgKind::Int,
ArgKind::Int,
ArgKind::Int,
ArgKind::Int,
]),
// set_anchor
MessageSpec(&[
ArgKind::Uint,
]),
// set_gravity
MessageSpec(&[
ArgKind::Uint,
]),
// set_constraint_adjustment
MessageSpec(&[
ArgKind::Uint,
]),
// set_offset
MessageSpec(&[
ArgKind::Int,
ArgKind::Int,
]),
// set_reactive
MessageSpec(&[
]),
// set_parent_size
MessageSpec(&[
ArgKind::Int,
ArgKind::Int,
]),
// set_parent_configure
MessageSpec(&[
ArgKind::Uint,
]),
]);
const EVENTS: MessageGroupSpec = MessageGroupSpec(&[
]);
type Incoming = Event;
type Outgoing = Request;
}
#[derive(Debug)]
pub enum Request {
/// destroy the xdg_positioner object
///
/// Notify the compositor that the xdg_positioner will no longer be used.
Destroy,
/// set the size of the to-be positioned rectangle
///
/// Set the size of the surface that is to be positioned with the positioner
/// object. The size is in surface-local coordinates and corresponds to the
/// window geometry. See xdg_surface.set_window_geometry.
///
/// If a zero or negative size is set the invalid_input error is raised.
SetSize {
/// width of positioned rectangle
width: i32,
/// height of positioned rectangle
height: i32,
},
/// set the anchor rectangle within the parent surface
///
/// Specify the anchor rectangle within the parent surface that the child
/// surface will be placed relative to. The rectangle is relative to the
/// window geometry as defined by xdg_surface.set_window_geometry of the
/// parent surface.
///
/// When the xdg_positioner object is used to position a child surface, the
/// anchor rectangle may not extend outside the window geometry of the
/// positioned child's parent surface.
///
/// If a negative size is set the invalid_input error is raised.
SetAnchorRect {
/// x position of anchor rectangle
x: i32,
/// y position of anchor rectangle
y: i32,
/// width of anchor rectangle
width: i32,
/// height of anchor rectangle
height: i32,
},
/// set anchor rectangle anchor
///
/// Defines the anchor point for the anchor rectangle. The specified anchor
/// is used derive an anchor point that the child surface will be
/// positioned relative to. If a corner anchor is set (e.g. 'top_left' or
/// 'bottom_right'), the anchor point will be at the specified corner;
/// otherwise, the derived anchor point will be centered on the specified
/// edge, or in the center of the anchor rectangle if no edge is specified.
SetAnchor {
/// anchor
anchor: Anchor,
},
/// set child surface gravity
///
/// Defines in what direction a surface should be positioned, relative to
/// the anchor point of the parent surface. If a corner gravity is
/// specified (e.g. 'bottom_right' or 'top_left'), then the child surface
/// will be placed towards the specified gravity; otherwise, the child
/// surface will be centered over the anchor point on any axis that had no
/// gravity specified.
SetGravity {
/// gravity direction
gravity: Gravity,
},
/// set the adjustment to be done when constrained
///
/// Specify how the window should be positioned if the originally intended
/// position caused the surface to be constrained, meaning at least
/// partially outside positioning boundaries set by the compositor. The
/// adjustment is set by constructing a bitmask describing the adjustment to
/// be made when the surface is constrained on that axis.
///
/// If no bit for one axis is set, the compositor will assume that the child
/// surface should not change its position on that axis when constrained.
///
/// If more than one bit for one axis is set, the order of how adjustments
/// are applied is specified in the corresponding adjustment descriptions.
///
/// The default adjustment is none.
SetConstraintAdjustment {
/// bit mask of constraint adjustments
constraint_adjustment: u32,
},
/// set surface position offset
///
/// Specify the surface position offset relative to the position of the
/// anchor on the anchor rectangle and the anchor on the surface. For
/// example if the anchor of the anchor rectangle is at (x, y), the surface
/// has the gravity bottom|right, and the offset is (ox, oy), the calculated
/// surface position will be (x + ox, y + oy). The offset position of the
/// surface is the one used for constraint testing. See
/// set_constraint_adjustment.
///
/// An example use case is placing a popup menu on top of a user interface
/// element, while aligning the user interface element of the parent surface
/// with some user interface element placed somewhere in the popup surface.
SetOffset {
/// surface position x offset
x: i32,
/// surface position y offset
y: i32,
},
/// continuously reconstrain the surface
///
/// When set reactive, the surface is reconstrained if the conditions used
/// for constraining changed, e.g. the parent window moved.
///
/// If the conditions changed and the popup was reconstrained, an
/// xdg_popup.configure event is sent with updated geometry, followed by an
/// xdg_surface.configure event.
SetReactive,
///
/// Set the parent window geometry the compositor should use when
/// positioning the popup. The compositor may use this information to
/// determine the future state the popup should be constrained using. If
/// this doesn't match the dimension of the parent the popup is eventually
/// positioned against, the behavior is undefined.
///
/// The arguments are given in the surface-local coordinate space.
SetParentSize {
/// future window geometry width of parent
parent_width: i32,
/// future window geometry height of parent
parent_height: i32,
},
/// set parent configure this is a response to
///
/// Set the serial of an xdg_surface.configure event this positioner will be
/// used in response to. The compositor may use this information together
/// with set_parent_size to determine what future state the popup should be
/// constrained using.
SetParentConfigure {
/// serial of parent configure event
serial: u32,
},
}
impl MessageType for Request {
fn log(&self, this: ObjectId) -> String {
match *self {
Request::Destroy {
} => {
format!("xdg_positioner@{:?}::destroy()", this)
}
Request::SetSize {
ref width,
ref height,
} => {
format!("xdg_positioner@{:?}::set_size(width: {:?}, height: {:?})", this, width, height)
}
Request::SetAnchorRect {
ref x,
ref y,
ref width,
ref height,
} => {
format!("xdg_positioner@{:?}::set_anchor_rect(x: {:?}, y: {:?}, width: {:?}, height: {:?})", this, x, y, width, height)
}
Request::SetAnchor {
ref anchor,
} => {
format!("xdg_positioner@{:?}::set_anchor(anchor: {:?})", this, anchor)
}
Request::SetGravity {
ref gravity,
} => {
format!("xdg_positioner@{:?}::set_gravity(gravity: {:?})", this, gravity)
}
Request::SetConstraintAdjustment {
ref constraint_adjustment,
} => {
format!("xdg_positioner@{:?}::set_constraint_adjustment(constraint_adjustment: {:?})", this, constraint_adjustment)
}
Request::SetOffset {
ref x,
ref y,
} => {
format!("xdg_positioner@{:?}::set_offset(x: {:?}, y: {:?})", this, x, y)
}
Request::SetReactive {
} => {
format!("xdg_positioner@{:?}::set_reactive()", this)
}
Request::SetParentSize {
ref parent_width,
ref parent_height,
} => {
format!("xdg_positioner@{:?}::set_parent_size(parent_width: {:?}, parent_height: {:?})", this, parent_width, parent_height)
}
Request::SetParentConfigure {
ref serial,
} => {
format!("xdg_positioner@{:?}::set_parent_configure(serial: {:?})", this, serial)
}
}
}
fn message_name(&self) -> &'static std::ffi::CStr{
match *self {
Request::Destroy { .. } => c"xdg_positioner::destroy",
Request::SetSize { .. } => c"xdg_positioner::set_size",
Request::SetAnchorRect { .. } => c"xdg_positioner::set_anchor_rect",
Request::SetAnchor { .. } => c"xdg_positioner::set_anchor",
Request::SetGravity { .. } => c"xdg_positioner::set_gravity",
Request::SetConstraintAdjustment { .. } => c"xdg_positioner::set_constraint_adjustment",
Request::SetOffset { .. } => c"xdg_positioner::set_offset",
Request::SetReactive { .. } => c"xdg_positioner::set_reactive",
Request::SetParentSize { .. } => c"xdg_positioner::set_parent_size",
Request::SetParentConfigure { .. } => c"xdg_positioner::set_parent_configure",
}
}
}
#[derive(Debug)]
pub enum Event {
}
impl MessageType for Event {
fn log(&self, this: ObjectId) -> String {
match *self {
}
}
fn message_name(&self) -> &'static std::ffi::CStr{
match *self {
}
}
}
impl IntoMessage for Request {
type Error = EncodeError;
fn into_message(self, id: u32) -> Result<Message, <Self as IntoMessage>::Error> {
let mut header = MessageHeader {
sender: id,
opcode: 0,
length: 0,
};
let mut msg = Message::new();
msg.write_header(&header)?;
match self {
Request::Destroy {
} => {
header.opcode = 0;
},
Request::SetSize {
width,
height,
} => {
msg.write_arg(Arg::Int(width))?;
msg.write_arg(Arg::Int(height))?;
header.opcode = 1;
},
Request::SetAnchorRect {
x,
y,
width,
height,
} => {
msg.write_arg(Arg::Int(x))?;
msg.write_arg(Arg::Int(y))?;
msg.write_arg(Arg::Int(width))?;
msg.write_arg(Arg::Int(height))?;
header.opcode = 2;
},
Request::SetAnchor {
anchor,
} => {
msg.write_arg(Arg::Uint(anchor.bits()))?;
header.opcode = 3;
},
Request::SetGravity {
gravity,
} => {
msg.write_arg(Arg::Uint(gravity.bits()))?;
header.opcode = 4;
},
Request::SetConstraintAdjustment {
constraint_adjustment,
} => {
msg.write_arg(Arg::Uint(constraint_adjustment))?;
header.opcode = 5;
},
Request::SetOffset {
x,
y,
} => {
msg.write_arg(Arg::Int(x))?;
msg.write_arg(Arg::Int(y))?;
header.opcode = 6;
},
Request::SetReactive {
} => {
header.opcode = 7;
},
Request::SetParentSize {
parent_width,
parent_height,
} => {
msg.write_arg(Arg::Int(parent_width))?;
msg.write_arg(Arg::Int(parent_height))?;
header.opcode = 8;
},
Request::SetParentConfigure {
serial,
} => {
msg.write_arg(Arg::Uint(serial))?;
header.opcode = 9;
},
}
header.length = msg.bytes().len() as u16;
msg.rewind();
msg.write_header(&header)?;
Ok(msg)
}
}
impl FromArgs for Event {
fn from_args(op: u16, mut args: Vec<Arg>) -> Result<Self, anyhow::Error> {
match op {
_ => {
Err(DecodeError::InvalidOpcode(op).into())
},
}
}
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum Error {
/// invalid input provided,
InvalidInput = 0,
}
impl Error {
pub fn from_bits(v: u32) -> Option<Self> {
match v {
0 => Some(Error::InvalidInput),
_ => None,
}
}
pub fn bits(&self) -> u32 {
*self as u32
}
}
impl Into<Arg> for Error {
fn into(self) -> Arg {
Arg::Uint(self.bits())
}
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum Anchor {
None = 0,
Top = 1,
Bottom = 2,
Left = 3,
Right = 4,
TopLeft = 5,
BottomLeft = 6,
TopRight = 7,
BottomRight = 8,
}
impl Anchor {
pub fn from_bits(v: u32) -> Option<Self> {
match v {
0 => Some(Anchor::None),
1 => Some(Anchor::Top),
2 => Some(Anchor::Bottom),
3 => Some(Anchor::Left),
4 => Some(Anchor::Right),
5 => Some(Anchor::TopLeft),
6 => Some(Anchor::BottomLeft),
7 => Some(Anchor::TopRight),
8 => Some(Anchor::BottomRight),
_ => None,
}
}
pub fn bits(&self) -> u32 {
*self as u32
}
}
impl Into<Arg> for Anchor {
fn into(self) -> Arg {
Arg::Uint(self.bits())
}
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum Gravity {
None = 0,
Top = 1,
Bottom = 2,
Left = 3,
Right = 4,
TopLeft = 5,
BottomLeft = 6,
TopRight = 7,
BottomRight = 8,
}
impl Gravity {
pub fn from_bits(v: u32) -> Option<Self> {
match v {
0 => Some(Gravity::None),
1 => Some(Gravity::Top),
2 => Some(Gravity::Bottom),
3 => Some(Gravity::Left),
4 => Some(Gravity::Right),
5 => Some(Gravity::TopLeft),
6 => Some(Gravity::BottomLeft),
7 => Some(Gravity::TopRight),
8 => Some(Gravity::BottomRight),
_ => None,
}
}
pub fn bits(&self) -> u32 {
*self as u32
}
}
impl Into<Arg> for Gravity {
fn into(self) -> Arg {
Arg::Uint(self.bits())
}
}
::bitflags::bitflags! {
/// constraint adjustments
///
/// The constraint adjustment value define ways the compositor will adjust
/// the position of the surface, if the unadjusted position would result
/// in the surface being partly constrained.
///
/// Whether a surface is considered 'constrained' is left to the compositor
/// to determine. For example, the surface may be partly outside the
/// compositor's defined 'work area', thus necessitating the child surface's
/// position be adjusted until it is entirely inside the work area.
///
/// The adjustments can be combined, according to a defined precedence: 1)
/// Flip, 2) Slide, 3) Resize.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ConstraintAdjustment: u32 {
const None = 0;
const SlideX = 1;
const SlideY = 2;
const FlipX = 4;
const FlipY = 8;
const ResizeX = 16;
const ResizeY = 32;
}
}
impl Into<Arg> for ConstraintAdjustment {
fn into(self) -> Arg {
Arg::Uint(self.bits())
}
}
} // mod xdg_positioner
pub use crate::xdg_positioner::XdgPositioner;
pub use crate::xdg_positioner::Request as XdgPositionerRequest;
pub use crate::xdg_positioner::Event as XdgPositionerEvent;
pub mod xdg_surface {
use super::*;
/// desktop user interface surface base interface
///
/// An interface that may be implemented by a wl_surface, for
/// implementations that provide a desktop-style user interface.
///
/// It provides a base set of functionality required to construct user
/// interface elements requiring management by the compositor, such as
/// toplevel windows, menus, etc. The types of functionality are split into
/// xdg_surface roles.
///
/// Creating an xdg_surface does not set the role for a wl_surface. In order
/// to map an xdg_surface, the client must create a role-specific object
/// using, e.g., get_toplevel, get_popup. The wl_surface for any given
/// xdg_surface can have at most one role, and may not be assigned any role
/// not based on xdg_surface.
///
/// A role must be assigned before any other requests are made to the
/// xdg_surface object.
///
/// The client must call wl_surface.commit on the corresponding wl_surface
/// for the xdg_surface state to take effect.
///
/// Creating an xdg_surface from a wl_surface which has a buffer attached or
/// committed is a client error, and any attempts by a client to attach or
/// manipulate a buffer prior to the first xdg_surface.configure call must
/// also be treated as errors.
///
/// After creating a role-specific object and setting it up, the client must
/// perform an initial commit without any buffer attached. The compositor
/// will reply with an xdg_surface.configure event. The client must
/// acknowledge it and is then allowed to attach a buffer to map the surface.
///
/// Mapping an xdg_surface-based role surface is defined as making it
/// possible for the surface to be shown by the compositor. Note that
/// a mapped surface is not guaranteed to be visible once it is mapped.
///
/// For an xdg_surface to be mapped by the compositor, the following
/// conditions must be met:
/// (1) the client has assigned an xdg_surface-based role to the surface
/// (2) the client has set and committed the xdg_surface state and the
/// role-dependent state to the surface
/// (3) the client has committed a buffer to the surface
///
/// A newly-unmapped surface is considered to have met condition (1) out
/// of the 3 required conditions for mapping a surface if its role surface
/// has not been destroyed.
#[derive(Debug)]
pub struct XdgSurface;
impl Interface for XdgSurface {
const NAME: &'static str = "xdg_surface";
const VERSION: u32 = 3;
const REQUESTS: MessageGroupSpec = MessageGroupSpec(&[
// destroy
MessageSpec(&[
]),
// get_toplevel
MessageSpec(&[
ArgKind::NewId,
]),
// get_popup
MessageSpec(&[
ArgKind::NewId,
ArgKind::Object,
ArgKind::Object,
]),
// set_window_geometry
MessageSpec(&[
ArgKind::Int,
ArgKind::Int,
ArgKind::Int,
ArgKind::Int,
]),
// ack_configure
MessageSpec(&[
ArgKind::Uint,
]),
]);
const EVENTS: MessageGroupSpec = MessageGroupSpec(&[
// configure
MessageSpec(&[
ArgKind::Uint,
]),
]);
type Incoming = Event;
type Outgoing = Request;
}
#[derive(Debug)]
pub enum Request {
/// destroy the xdg_surface
///
/// Destroy the xdg_surface object. An xdg_surface must only be destroyed
/// after its role object has been destroyed.
Destroy,
/// assign the xdg_toplevel surface role
///
/// This creates an xdg_toplevel object for the given xdg_surface and gives
/// the associated wl_surface the xdg_toplevel role.
///
/// See the documentation of xdg_toplevel for more details about what an
/// xdg_toplevel is and how it is used.
GetToplevel {
id: NewId,
},
/// assign the xdg_popup surface role
///
/// This creates an xdg_popup object for the given xdg_surface and gives
/// the associated wl_surface the xdg_popup role.
///
/// If null is passed as a parent, a parent surface must be specified using
/// some other protocol, before committing the initial state.
///
/// See the documentation of xdg_popup for more details about what an
/// xdg_popup is and how it is used.
GetPopup {
id: NewId,
parent: ObjectId,
positioner: ObjectId,
},
/// set the new window geometry
///
/// The window geometry of a surface is its "visible bounds" from the
/// user's perspective. Client-side decorations often have invisible
/// portions like drop-shadows which should be ignored for the
/// purposes of aligning, placing and constraining windows.
///
/// The window geometry is double buffered, and will be applied at the
/// time wl_surface.commit of the corresponding wl_surface is called.
///
/// When maintaining a position, the compositor should treat the (x, y)
/// coordinate of the window geometry as the top left corner of the window.
/// A client changing the (x, y) window geometry coordinate should in
/// general not alter the position of the window.
///
/// Once the window geometry of the surface is set, it is not possible to
/// unset it, and it will remain the same until set_window_geometry is
/// called again, even if a new subsurface or buffer is attached.
///
/// If never set, the value is the full bounds of the surface,
/// including any subsurfaces. This updates dynamically on every
/// commit. This unset is meant for extremely simple clients.
///
/// The arguments are given in the surface-local coordinate space of
/// the wl_surface associated with this xdg_surface.
///
/// The width and height must be greater than zero. Setting an invalid size
/// will raise an error. When applied, the effective window geometry will be
/// the set window geometry clamped to the bounding rectangle of the
/// combined geometry of the surface of the xdg_surface and the associated
/// subsurfaces.
SetWindowGeometry {
x: i32,
y: i32,
width: i32,
height: i32,
},
/// ack a configure event
///
/// When a configure event is received, if a client commits the
/// surface in response to the configure event, then the client
/// must make an ack_configure request sometime before the commit
/// request, passing along the serial of the configure event.
///
/// For instance, for toplevel surfaces the compositor might use this
/// information to move a surface to the top left only when the client has
/// drawn itself for the maximized or fullscreen state.
///
/// If the client receives multiple configure events before it
/// can respond to one, it only has to ack the last configure event.
///
/// A client is not required to commit immediately after sending
/// an ack_configure request - it may even ack_configure several times
/// before its next surface commit.
///
/// A client may send multiple ack_configure requests before committing, but
/// only the last request sent before a commit indicates which configure
/// event the client really is responding to.
AckConfigure {
/// the serial from the configure event
serial: u32,
},
}
impl MessageType for Request {
fn log(&self, this: ObjectId) -> String {
match *self {
Request::Destroy {
} => {
format!("xdg_surface@{:?}::destroy()", this)
}
Request::GetToplevel {
ref id,
} => {
format!("xdg_surface@{:?}::get_toplevel(id: {:?})", this, id)
}
Request::GetPopup {
ref id,
ref parent,
ref positioner,
} => {
format!("xdg_surface@{:?}::get_popup(id: {:?}, parent: {:?}, positioner: {:?})", this, id, parent, positioner)
}
Request::SetWindowGeometry {
ref x,
ref y,
ref width,
ref height,
} => {
format!("xdg_surface@{:?}::set_window_geometry(x: {:?}, y: {:?}, width: {:?}, height: {:?})", this, x, y, width, height)
}
Request::AckConfigure {
ref serial,
} => {
format!("xdg_surface@{:?}::ack_configure(serial: {:?})", this, serial)
}
}
}
fn message_name(&self) -> &'static std::ffi::CStr{
match *self {
Request::Destroy { .. } => c"xdg_surface::destroy",
Request::GetToplevel { .. } => c"xdg_surface::get_toplevel",
Request::GetPopup { .. } => c"xdg_surface::get_popup",
Request::SetWindowGeometry { .. } => c"xdg_surface::set_window_geometry",
Request::AckConfigure { .. } => c"xdg_surface::ack_configure",
}
}
}
#[derive(Debug)]
pub enum Event {
/// suggest a surface change
///
/// The configure event marks the end of a configure sequence. A configure
/// sequence is a set of one or more events configuring the state of the
/// xdg_surface, including the final xdg_surface.configure event.
///
/// Where applicable, xdg_surface surface roles will during a configure
/// sequence extend this event as a latched state sent as events before the
/// xdg_surface.configure event. Such events should be considered to make up
/// a set of atomically applied configuration states, where the
/// xdg_surface.configure commits the accumulated state.
///
/// Clients should arrange their surface for the new states, and then send
/// an ack_configure request with the serial sent in this configure event at
/// some point before committing the new surface.
///
/// If the client receives multiple configure events before it can respond
/// to one, it is free to discard all but the last event it received.
Configure {
/// serial of the configure event
serial: u32,
},
}
impl MessageType for Event {
fn log(&self, this: ObjectId) -> String {
match *self {
Event::Configure {
ref serial,
} => {
format!("xdg_surface@{:?}::configure(serial: {:?})", this, serial)
}
}
}
fn message_name(&self) -> &'static std::ffi::CStr{
match *self {
Event::Configure { .. } => c"xdg_surface::configure",
}
}
}
impl IntoMessage for Request {
type Error = EncodeError;
fn into_message(self, id: u32) -> Result<Message, <Self as IntoMessage>::Error> {
let mut header = MessageHeader {
sender: id,
opcode: 0,
length: 0,
};
let mut msg = Message::new();
msg.write_header(&header)?;
match self {
Request::Destroy {
} => {
header.opcode = 0;
},
Request::GetToplevel {
id,
} => {
msg.write_arg(Arg::NewId(id))?;
header.opcode = 1;
},
Request::GetPopup {
id,
parent,
positioner,
} => {
msg.write_arg(Arg::NewId(id))?;
msg.write_arg(Arg::Object(parent))?;
msg.write_arg(Arg::Object(positioner))?;
header.opcode = 2;
},
Request::SetWindowGeometry {
x,
y,
width,
height,
} => {
msg.write_arg(Arg::Int(x))?;
msg.write_arg(Arg::Int(y))?;
msg.write_arg(Arg::Int(width))?;
msg.write_arg(Arg::Int(height))?;
header.opcode = 3;
},
Request::AckConfigure {
serial,
} => {
msg.write_arg(Arg::Uint(serial))?;
header.opcode = 4;
},
}
header.length = msg.bytes().len() as u16;
msg.rewind();
msg.write_header(&header)?;
Ok(msg)
}
}
impl FromArgs for Event {
fn from_args(op: u16, mut args: Vec<Arg>) -> Result<Self, anyhow::Error> {
match op {
0 /* configure */ => {
let mut iter = args.into_iter();
Ok(Event::Configure {
serial: iter.next()
.ok_or(DecodeError::InsufficientArgs)?
.as_uint()?,
})
},
_ => {
Err(DecodeError::InvalidOpcode(op).into())
},
}
}
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum Error {
NotConstructed = 1,
AlreadyConstructed = 2,
UnconfiguredBuffer = 3,
}
impl Error {
pub fn from_bits(v: u32) -> Option<Self> {
match v {
1 => Some(Error::NotConstructed),
2 => Some(Error::AlreadyConstructed),
3 => Some(Error::UnconfiguredBuffer),
_ => None,
}
}
pub fn bits(&self) -> u32 {
*self as u32
}
}
impl Into<Arg> for Error {
fn into(self) -> Arg {
Arg::Uint(self.bits())
}
}
} // mod xdg_surface
pub use crate::xdg_surface::XdgSurface;
pub use crate::xdg_surface::Request as XdgSurfaceRequest;
pub use crate::xdg_surface::Event as XdgSurfaceEvent;
pub mod xdg_toplevel {
use super::*;
/// toplevel surface
///
/// This interface defines an xdg_surface role which allows a surface to,
/// among other things, set window-like properties such as maximize,
/// fullscreen, and minimize, set application-specific metadata like title and
/// id, and well as trigger user interactive operations such as interactive
/// resize and move.
///
/// Unmapping an xdg_toplevel means that the surface cannot be shown
/// by the compositor until it is explicitly mapped again.
/// All active operations (e.g., move, resize) are canceled and all
/// attributes (e.g. title, state, stacking, ...) are discarded for
/// an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to
/// the state it had right after xdg_surface.get_toplevel. The client
/// can re-map the toplevel by perfoming a commit without any buffer
/// attached, waiting for a configure event and handling it as usual (see
/// xdg_surface description).
///
/// Attaching a null buffer to a toplevel unmaps the surface.
#[derive(Debug)]
pub struct XdgToplevel;
impl Interface for XdgToplevel {
const NAME: &'static str = "xdg_toplevel";
const VERSION: u32 = 3;
const REQUESTS: MessageGroupSpec = MessageGroupSpec(&[
// destroy
MessageSpec(&[
]),
// set_parent
MessageSpec(&[
ArgKind::Object,
]),
// set_title
MessageSpec(&[
ArgKind::String,
]),
// set_app_id
MessageSpec(&[
ArgKind::String,
]),
// show_window_menu
MessageSpec(&[
ArgKind::Object,
ArgKind::Uint,
ArgKind::Int,
ArgKind::Int,
]),
// move
MessageSpec(&[
ArgKind::Object,
ArgKind::Uint,
]),
// resize
MessageSpec(&[
ArgKind::Object,
ArgKind::Uint,
ArgKind::Uint,
]),
// set_max_size
MessageSpec(&[
ArgKind::Int,
ArgKind::Int,
]),
// set_min_size
MessageSpec(&[
ArgKind::Int,
ArgKind::Int,
]),
// set_maximized
MessageSpec(&[
]),
// unset_maximized
MessageSpec(&[
]),
// set_fullscreen
MessageSpec(&[
ArgKind::Object,
]),
// unset_fullscreen
MessageSpec(&[
]),
// set_minimized
MessageSpec(&[
]),
]);
const EVENTS: MessageGroupSpec = MessageGroupSpec(&[
// configure
MessageSpec(&[
ArgKind::Int,
ArgKind::Int,
ArgKind::Array,
]),
// close
MessageSpec(&[
]),
]);
type Incoming = Event;
type Outgoing = Request;
}
#[derive(Debug)]
pub enum Request {
/// destroy the xdg_toplevel
///
/// This request destroys the role surface and unmaps the surface;
/// see "Unmapping" behavior in interface section for details.
Destroy,
/// set the parent of this surface
///
/// Set the "parent" of this surface. This surface should be stacked
/// above the parent surface and all other ancestor surfaces.
///
/// Parent windows should be set on dialogs, toolboxes, or other
/// "auxiliary" surfaces, so that the parent is raised when the dialog
/// is raised.
///
/// Setting a null parent for a child window removes any parent-child
/// relationship for the child. Setting a null parent for a window which
/// currently has no parent is a no-op.
///
/// If the parent is unmapped then its children are managed as
/// though the parent of the now-unmapped parent has become the
/// parent of this surface. If no parent exists for the now-unmapped
/// parent then the children are managed as though they have no
/// parent surface.
SetParent {
parent: ObjectId,
},
/// set surface title
///
/// Set a short title for the surface.
///
/// This string may be used to identify the surface in a task bar,
/// window list, or other user interface elements provided by the
/// compositor.
///
/// The string must be encoded in UTF-8.
SetTitle {
title: String,
},
/// set application ID
///
/// Set an application identifier for the surface.
///
/// The app ID identifies the general class of applications to which
/// the surface belongs. The compositor can use this to group multiple
/// surfaces together, or to determine how to launch a new application.
///
/// For D-Bus activatable applications, the app ID is used as the D-Bus
/// service name.
///
/// The compositor shell will try to group application surfaces together
/// by their app ID. As a best practice, it is suggested to select app
/// ID's that match the basename of the application's .desktop file.
/// For example, "org.freedesktop.FooViewer" where the .desktop file is
/// "org.freedesktop.FooViewer.desktop".
///
/// Like other properties, a set_app_id request can be sent after the
/// xdg_toplevel has been mapped to update the property.
///
/// See the desktop-entry specification [0] for more details on
/// application identifiers and how they relate to well-known D-Bus
/// names and .desktop files.
///
/// [0] http://standards.freedesktop.org/desktop-entry-spec/
SetAppId {
app_id: String,
},
/// show the window menu
///
/// Clients implementing client-side decorations might want to show
/// a context menu when right-clicking on the decorations, giving the
/// user a menu that they can use to maximize or minimize the window.
///
/// This request asks the compositor to pop up such a window menu at
/// the given position, relative to the local surface coordinates of
/// the parent surface. There are no guarantees as to what menu items
/// the window menu contains.
///
/// This request must be used in response to some sort of user action
/// like a button press, key press, or touch down event.
ShowWindowMenu {
/// the wl_seat of the user event
seat: ObjectId,
/// the serial of the user event
serial: u32,
/// the x position to pop up the window menu at
x: i32,
/// the y position to pop up the window menu at
y: i32,
},
/// start an interactive move
///
/// Start an interactive, user-driven move of the surface.
///
/// This request must be used in response to some sort of user action
/// like a button press, key press, or touch down event. The passed
/// serial is used to determine the type of interactive move (touch,
/// pointer, etc).
///
/// The server may ignore move requests depending on the state of
/// the surface (e.g. fullscreen or maximized), or if the passed serial
/// is no longer valid.
///
/// If triggered, the surface will lose the focus of the device
/// (wl_pointer, wl_touch, etc) used for the move. It is up to the
/// compositor to visually indicate that the move is taking place, such as
/// updating a pointer cursor, during the move. There is no guarantee
/// that the device focus will return when the move is completed.
Move {
/// the wl_seat of the user event
seat: ObjectId,
/// the serial of the user event
serial: u32,
},
/// start an interactive resize
///
/// Start a user-driven, interactive resize of the surface.
///
/// This request must be used in response to some sort of user action
/// like a button press, key press, or touch down event. The passed
/// serial is used to determine the type of interactive resize (touch,
/// pointer, etc).
///
/// The server may ignore resize requests depending on the state of
/// the surface (e.g. fullscreen or maximized).
///
/// If triggered, the client will receive configure events with the
/// "resize" state enum value and the expected sizes. See the "resize"
/// enum value for more details about what is required. The client
/// must also acknowledge configure events using "ack_configure". After
/// the resize is completed, the client will receive another "configure"
/// event without the resize state.
///
/// If triggered, the surface also will lose the focus of the device
/// (wl_pointer, wl_touch, etc) used for the resize. It is up to the
/// compositor to visually indicate that the resize is taking place,
/// such as updating a pointer cursor, during the resize. There is no
/// guarantee that the device focus will return when the resize is
/// completed.
///
/// The edges parameter specifies how the surface should be resized,
/// and is one of the values of the resize_edge enum. The compositor
/// may use this information to update the surface position for
/// example when dragging the top left corner. The compositor may also
/// use this information to adapt its behavior, e.g. choose an
/// appropriate cursor image.
Resize {
/// the wl_seat of the user event
seat: ObjectId,
/// the serial of the user event
serial: u32,
/// which edge or corner is being dragged
edges: ResizeEdge,
},
/// set the maximum size
///
/// Set a maximum size for the window.
///
/// The client can specify a maximum size so that the compositor does
/// not try to configure the window beyond this size.
///
/// The width and height arguments are in window geometry coordinates.
/// See xdg_surface.set_window_geometry.
///
/// Values set in this way are double-buffered. They will get applied
/// on the next commit.
///
/// The compositor can use this information to allow or disallow
/// different states like maximize or fullscreen and draw accurate
/// animations.
///
/// Similarly, a tiling window manager may use this information to
/// place and resize client windows in a more effective way.
///
/// The client should not rely on the compositor to obey the maximum
/// size. The compositor may decide to ignore the values set by the
/// client and request a larger size.
///
/// If never set, or a value of zero in the request, means that the
/// client has no expected maximum size in the given dimension.
/// As a result, a client wishing to reset the maximum size
/// to an unspecified state can use zero for width and height in the
/// request.
///
/// Requesting a maximum size to be smaller than the minimum size of
/// a surface is illegal and will result in a protocol error.
///
/// The width and height must be greater than or equal to zero. Using
/// strictly negative values for width and height will result in a
/// protocol error.
SetMaxSize {
width: i32,
height: i32,
},
/// set the minimum size
///
/// Set a minimum size for the window.
///
/// The client can specify a minimum size so that the compositor does
/// not try to configure the window below this size.
///
/// The width and height arguments are in window geometry coordinates.
/// See xdg_surface.set_window_geometry.
///
/// Values set in this way are double-buffered. They will get applied
/// on the next commit.
///
/// The compositor can use this information to allow or disallow
/// different states like maximize or fullscreen and draw accurate
/// animations.
///
/// Similarly, a tiling window manager may use this information to
/// place and resize client windows in a more effective way.
///
/// The client should not rely on the compositor to obey the minimum
/// size. The compositor may decide to ignore the values set by the
/// client and request a smaller size.
///
/// If never set, or a value of zero in the request, means that the
/// client has no expected minimum size in the given dimension.
/// As a result, a client wishing to reset the minimum size
/// to an unspecified state can use zero for width and height in the
/// request.
///
/// Requesting a minimum size to be larger than the maximum size of
/// a surface is illegal and will result in a protocol error.
///
/// The width and height must be greater than or equal to zero. Using
/// strictly negative values for width and height will result in a
/// protocol error.
SetMinSize {
width: i32,
height: i32,
},
/// maximize the window
///
/// Maximize the surface.
///
/// After requesting that the surface should be maximized, the compositor
/// will respond by emitting a configure event. Whether this configure
/// actually sets the window maximized is subject to compositor policies.
/// The client must then update its content, drawing in the configured
/// state. The client must also acknowledge the configure when committing
/// the new content (see ack_configure).
///
/// It is up to the compositor to decide how and where to maximize the
/// surface, for example which output and what region of the screen should
/// be used.
///
/// If the surface was already maximized, the compositor will still emit
/// a configure event with the "maximized" state.
///
/// If the surface is in a fullscreen state, this request has no direct
/// effect. It may alter the state the surface is returned to when
/// unmaximized unless overridden by the compositor.
SetMaximized,
/// unmaximize the window
///
/// Unmaximize the surface.
///
/// After requesting that the surface should be unmaximized, the compositor
/// will respond by emitting a configure event. Whether this actually
/// un-maximizes the window is subject to compositor policies.
/// If available and applicable, the compositor will include the window
/// geometry dimensions the window had prior to being maximized in the
/// configure event. The client must then update its content, drawing it in
/// the configured state. The client must also acknowledge the configure
/// when committing the new content (see ack_configure).
///
/// It is up to the compositor to position the surface after it was
/// unmaximized; usually the position the surface had before maximizing, if
/// applicable.
///
/// If the surface was already not maximized, the compositor will still
/// emit a configure event without the "maximized" state.
///
/// If the surface is in a fullscreen state, this request has no direct
/// effect. It may alter the state the surface is returned to when
/// unmaximized unless overridden by the compositor.
UnsetMaximized,
/// set the window as fullscreen on an output
///
/// Make the surface fullscreen.
///
/// After requesting that the surface should be fullscreened, the
/// compositor will respond by emitting a configure event. Whether the
/// client is actually put into a fullscreen state is subject to compositor
/// policies. The client must also acknowledge the configure when
/// committing the new content (see ack_configure).
///
/// The output passed by the request indicates the client's preference as
/// to which display it should be set fullscreen on. If this value is NULL,
/// it's up to the compositor to choose which display will be used to map
/// this surface.
///
/// If the surface doesn't cover the whole output, the compositor will
/// position the surface in the center of the output and compensate with
/// with border fill covering the rest of the output. The content of the
/// border fill is undefined, but should be assumed to be in some way that
/// attempts to blend into the surrounding area (e.g. solid black).
///
/// If the fullscreened surface is not opaque, the compositor must make
/// sure that other screen content not part of the same surface tree (made
/// up of subsurfaces, popups or similarly coupled surfaces) are not
/// visible below the fullscreened surface.
SetFullscreen {
output: ObjectId,
},
/// unset the window as fullscreen
///
/// Make the surface no longer fullscreen.
///
/// After requesting that the surface should be unfullscreened, the
/// compositor will respond by emitting a configure event.
/// Whether this actually removes the fullscreen state of the client is
/// subject to compositor policies.
///
/// Making a surface unfullscreen sets states for the surface based on the following:
/// * the state(s) it may have had before becoming fullscreen
/// * any state(s) decided by the compositor
/// * any state(s) requested by the client while the surface was fullscreen
///
/// The compositor may include the previous window geometry dimensions in
/// the configure event, if applicable.
///
/// The client must also acknowledge the configure when committing the new
/// content (see ack_configure).
UnsetFullscreen,
/// set the window as minimized
///
/// Request that the compositor minimize your surface. There is no
/// way to know if the surface is currently minimized, nor is there
/// any way to unset minimization on this surface.
///
/// If you are looking to throttle redrawing when minimized, please
/// instead use the wl_surface.frame event for this, as this will
/// also work with live previews on windows in Alt-Tab, Expose or
/// similar compositor features.
SetMinimized,
}
impl MessageType for Request {
fn log(&self, this: ObjectId) -> String {
match *self {
Request::Destroy {
} => {
format!("xdg_toplevel@{:?}::destroy()", this)
}
Request::SetParent {
ref parent,
} => {
format!("xdg_toplevel@{:?}::set_parent(parent: {:?})", this, parent)
}
Request::SetTitle {
ref title,
} => {
format!("xdg_toplevel@{:?}::set_title(title: {:?})", this, title)
}
Request::SetAppId {
ref app_id,
} => {
format!("xdg_toplevel@{:?}::set_app_id(app_id: {:?})", this, app_id)
}
Request::ShowWindowMenu {
ref seat,
ref serial,
ref x,
ref y,
} => {
format!("xdg_toplevel@{:?}::show_window_menu(seat: {:?}, serial: {:?}, x: {:?}, y: {:?})", this, seat, serial, x, y)
}
Request::Move {
ref seat,
ref serial,
} => {
format!("xdg_toplevel@{:?}::move(seat: {:?}, serial: {:?})", this, seat, serial)
}
Request::Resize {
ref seat,
ref serial,
ref edges,
} => {
format!("xdg_toplevel@{:?}::resize(seat: {:?}, serial: {:?}, edges: {:?})", this, seat, serial, edges)
}
Request::SetMaxSize {
ref width,
ref height,
} => {
format!("xdg_toplevel@{:?}::set_max_size(width: {:?}, height: {:?})", this, width, height)
}
Request::SetMinSize {
ref width,
ref height,
} => {
format!("xdg_toplevel@{:?}::set_min_size(width: {:?}, height: {:?})", this, width, height)
}
Request::SetMaximized {
} => {
format!("xdg_toplevel@{:?}::set_maximized()", this)
}
Request::UnsetMaximized {
} => {
format!("xdg_toplevel@{:?}::unset_maximized()", this)
}
Request::SetFullscreen {
ref output,
} => {
format!("xdg_toplevel@{:?}::set_fullscreen(output: {:?})", this, output)
}
Request::UnsetFullscreen {
} => {
format!("xdg_toplevel@{:?}::unset_fullscreen()", this)
}
Request::SetMinimized {
} => {
format!("xdg_toplevel@{:?}::set_minimized()", this)
}
}
}
fn message_name(&self) -> &'static std::ffi::CStr{
match *self {
Request::Destroy { .. } => c"xdg_toplevel::destroy",
Request::SetParent { .. } => c"xdg_toplevel::set_parent",
Request::SetTitle { .. } => c"xdg_toplevel::set_title",
Request::SetAppId { .. } => c"xdg_toplevel::set_app_id",
Request::ShowWindowMenu { .. } => c"xdg_toplevel::show_window_menu",
Request::Move { .. } => c"xdg_toplevel::move",
Request::Resize { .. } => c"xdg_toplevel::resize",
Request::SetMaxSize { .. } => c"xdg_toplevel::set_max_size",
Request::SetMinSize { .. } => c"xdg_toplevel::set_min_size",
Request::SetMaximized { .. } => c"xdg_toplevel::set_maximized",
Request::UnsetMaximized { .. } => c"xdg_toplevel::unset_maximized",
Request::SetFullscreen { .. } => c"xdg_toplevel::set_fullscreen",
Request::UnsetFullscreen { .. } => c"xdg_toplevel::unset_fullscreen",
Request::SetMinimized { .. } => c"xdg_toplevel::set_minimized",
}
}
}
#[derive(Debug)]
pub enum Event {
/// suggest a surface change
///
/// This configure event asks the client to resize its toplevel surface or
/// to change its state. The configured state should not be applied
/// immediately. See xdg_surface.configure for details.
///
/// The width and height arguments specify a hint to the window
/// about how its surface should be resized in window geometry
/// coordinates. See set_window_geometry.
///
/// If the width or height arguments are zero, it means the client
/// should decide its own window dimension. This may happen when the
/// compositor needs to configure the state of the surface but doesn't
/// have any information about any previous or expected dimension.
///
/// The states listed in the event specify how the width/height
/// arguments should be interpreted, and possibly how it should be
/// drawn.
///
/// Clients must send an ack_configure in response to this event. See
/// xdg_surface.configure and xdg_surface.ack_configure for details.
Configure {
width: i32,
height: i32,
states: Array,
},
/// surface wants to be closed
///
/// The close event is sent by the compositor when the user
/// wants the surface to be closed. This should be equivalent to
/// the user clicking the close button in client-side decorations,
/// if your application has any.
///
/// This is only a request that the user intends to close the
/// window. The client may choose to ignore this request, or show
/// a dialog to ask the user to save their data, etc.
Close,
}
impl MessageType for Event {
fn log(&self, this: ObjectId) -> String {
match *self {
Event::Configure {
ref width,
ref height,
ref states,
} => {
format!("xdg_toplevel@{:?}::configure(width: {:?}, height: {:?}, states: Array[{}])", this, width, height, states.len())
}
Event::Close {
} => {
format!("xdg_toplevel@{:?}::close()", this)
}
}
}
fn message_name(&self) -> &'static std::ffi::CStr{
match *self {
Event::Configure { .. } => c"xdg_toplevel::configure",
Event::Close { .. } => c"xdg_toplevel::close",
}
}
}
impl IntoMessage for Request {
type Error = EncodeError;
fn into_message(self, id: u32) -> Result<Message, <Self as IntoMessage>::Error> {
let mut header = MessageHeader {
sender: id,
opcode: 0,
length: 0,
};
let mut msg = Message::new();
msg.write_header(&header)?;
match self {
Request::Destroy {
} => {
header.opcode = 0;
},
Request::SetParent {
parent,
} => {
msg.write_arg(Arg::Object(parent))?;
header.opcode = 1;
},
Request::SetTitle {
title,
} => {
msg.write_arg(Arg::String(title))?;
header.opcode = 2;
},
Request::SetAppId {
app_id,
} => {
msg.write_arg(Arg::String(app_id))?;
header.opcode = 3;
},
Request::ShowWindowMenu {
seat,
serial,
x,
y,
} => {
msg.write_arg(Arg::Object(seat))?;
msg.write_arg(Arg::Uint(serial))?;
msg.write_arg(Arg::Int(x))?;
msg.write_arg(Arg::Int(y))?;
header.opcode = 4;
},
Request::Move {
seat,
serial,
} => {
msg.write_arg(Arg::Object(seat))?;
msg.write_arg(Arg::Uint(serial))?;
header.opcode = 5;
},
Request::Resize {
seat,
serial,
edges,
} => {
msg.write_arg(Arg::Object(seat))?;
msg.write_arg(Arg::Uint(serial))?;
msg.write_arg(Arg::Uint(edges.bits()))?;
header.opcode = 6;
},
Request::SetMaxSize {
width,
height,
} => {
msg.write_arg(Arg::Int(width))?;
msg.write_arg(Arg::Int(height))?;
header.opcode = 7;
},
Request::SetMinSize {
width,
height,
} => {
msg.write_arg(Arg::Int(width))?;
msg.write_arg(Arg::Int(height))?;
header.opcode = 8;
},
Request::SetMaximized {
} => {
header.opcode = 9;
},
Request::UnsetMaximized {
} => {
header.opcode = 10;
},
Request::SetFullscreen {
output,
} => {
msg.write_arg(Arg::Object(output))?;
header.opcode = 11;
},
Request::UnsetFullscreen {
} => {
header.opcode = 12;
},
Request::SetMinimized {
} => {
header.opcode = 13;
},
}
header.length = msg.bytes().len() as u16;
msg.rewind();
msg.write_header(&header)?;
Ok(msg)
}
}
impl FromArgs for Event {
fn from_args(op: u16, mut args: Vec<Arg>) -> Result<Self, anyhow::Error> {
match op {
0 /* configure */ => {
let mut iter = args.into_iter();
Ok(Event::Configure {
width: iter.next()
.ok_or(DecodeError::InsufficientArgs)?
.as_int()?,
height: iter.next()
.ok_or(DecodeError::InsufficientArgs)?
.as_int()?,
states: iter.next()
.ok_or(DecodeError::InsufficientArgs)?
.as_array()?,
})
},
1 /* close */ => {
let mut iter = args.into_iter();
Ok(Event::Close {
})
},
_ => {
Err(DecodeError::InvalidOpcode(op).into())
},
}
}
}
/// edge values for resizing
///
/// These values are used to indicate which edge of a surface
/// is being dragged in a resize operation.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum ResizeEdge {
None = 0,
Top = 1,
Bottom = 2,
Left = 4,
TopLeft = 5,
BottomLeft = 6,
Right = 8,
TopRight = 9,
BottomRight = 10,
}
impl ResizeEdge {
pub fn from_bits(v: u32) -> Option<Self> {
match v {
0 => Some(ResizeEdge::None),
1 => Some(ResizeEdge::Top),
2 => Some(ResizeEdge::Bottom),
4 => Some(ResizeEdge::Left),
5 => Some(ResizeEdge::TopLeft),
6 => Some(ResizeEdge::BottomLeft),
8 => Some(ResizeEdge::Right),
9 => Some(ResizeEdge::TopRight),
10 => Some(ResizeEdge::BottomRight),
_ => None,
}
}
pub fn bits(&self) -> u32 {
*self as u32
}
}
impl Into<Arg> for ResizeEdge {
fn into(self) -> Arg {
Arg::Uint(self.bits())
}
}
/// types of state on the surface
///
/// The different state values used on the surface. This is designed for
/// state values like maximized, fullscreen. It is paired with the
/// configure event to ensure that both the client and the compositor
/// setting the state can be synchronized.
///
/// States set in this way are double-buffered. They will get applied on
/// the next commit.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum State {
/// the surface is maximized,
Maximized = 1,
/// the surface is fullscreen,
Fullscreen = 2,
/// the surface is being resized,
Resizing = 3,
/// the surface is now activated,
Activated = 4,
TiledLeft = 5,
TiledRight = 6,
TiledTop = 7,
TiledBottom = 8,
}
impl State {
pub fn from_bits(v: u32) -> Option<Self> {
match v {
1 => Some(State::Maximized),
2 => Some(State::Fullscreen),
3 => Some(State::Resizing),
4 => Some(State::Activated),
5 => Some(State::TiledLeft),
6 => Some(State::TiledRight),
7 => Some(State::TiledTop),
8 => Some(State::TiledBottom),
_ => None,
}
}
pub fn bits(&self) -> u32 {
*self as u32
}
}
impl Into<Arg> for State {
fn into(self) -> Arg {
Arg::Uint(self.bits())
}
}
} // mod xdg_toplevel
pub use crate::xdg_toplevel::XdgToplevel;
pub use crate::xdg_toplevel::Request as XdgToplevelRequest;
pub use crate::xdg_toplevel::Event as XdgToplevelEvent;
pub mod xdg_popup {
use super::*;
/// short-lived, popup surfaces for menus
///
/// A popup surface is a short-lived, temporary surface. It can be used to
/// implement for example menus, popovers, tooltips and other similar user
/// interface concepts.
///
/// A popup can be made to take an explicit grab. See xdg_popup.grab for
/// details.
///
/// When the popup is dismissed, a popup_done event will be sent out, and at
/// the same time the surface will be unmapped. See the xdg_popup.popup_done
/// event for details.
///
/// Explicitly destroying the xdg_popup object will also dismiss the popup and
/// unmap the surface. Clients that want to dismiss the popup when another
/// surface of their own is clicked should dismiss the popup using the destroy
/// request.
///
/// A newly created xdg_popup will be stacked on top of all previously created
/// xdg_popup surfaces associated with the same xdg_toplevel.
///
/// The parent of an xdg_popup must be mapped (see the xdg_surface
/// description) before the xdg_popup itself.
///
/// The client must call wl_surface.commit on the corresponding wl_surface
/// for the xdg_popup state to take effect.
#[derive(Debug)]
pub struct XdgPopup;
impl Interface for XdgPopup {
const NAME: &'static str = "xdg_popup";
const VERSION: u32 = 3;
const REQUESTS: MessageGroupSpec = MessageGroupSpec(&[
// destroy
MessageSpec(&[
]),
// grab
MessageSpec(&[
ArgKind::Object,
ArgKind::Uint,
]),
// reposition
MessageSpec(&[
ArgKind::Object,
ArgKind::Uint,
]),
]);
const EVENTS: MessageGroupSpec = MessageGroupSpec(&[
// configure
MessageSpec(&[
ArgKind::Int,
ArgKind::Int,
ArgKind::Int,
ArgKind::Int,
]),
// popup_done
MessageSpec(&[
]),
// repositioned
MessageSpec(&[
ArgKind::Uint,
]),
]);
type Incoming = Event;
type Outgoing = Request;
}
#[derive(Debug)]
pub enum Request {
/// remove xdg_popup interface
///
/// This destroys the popup. Explicitly destroying the xdg_popup
/// object will also dismiss the popup, and unmap the surface.
///
/// If this xdg_popup is not the "topmost" popup, a protocol error
/// will be sent.
Destroy,
/// make the popup take an explicit grab
///
/// This request makes the created popup take an explicit grab. An explicit
/// grab will be dismissed when the user dismisses the popup, or when the
/// client destroys the xdg_popup. This can be done by the user clicking
/// outside the surface, using the keyboard, or even locking the screen
/// through closing the lid or a timeout.
///
/// If the compositor denies the grab, the popup will be immediately
/// dismissed.
///
/// This request must be used in response to some sort of user action like a
/// button press, key press, or touch down event. The serial number of the
/// event should be passed as 'serial'.
///
/// The parent of a grabbing popup must either be an xdg_toplevel surface or
/// another xdg_popup with an explicit grab. If the parent is another
/// xdg_popup it means that the popups are nested, with this popup now being
/// the topmost popup.
///
/// Nested popups must be destroyed in the reverse order they were created
/// in, e.g. the only popup you are allowed to destroy at all times is the
/// topmost one.
///
/// When compositors choose to dismiss a popup, they may dismiss every
/// nested grabbing popup as well. When a compositor dismisses popups, it
/// will follow the same dismissing order as required from the client.
///
/// The parent of a grabbing popup must either be another xdg_popup with an
/// active explicit grab, or an xdg_popup or xdg_toplevel, if there are no
/// explicit grabs already taken.
///
/// If the topmost grabbing popup is destroyed, the grab will be returned to
/// the parent of the popup, if that parent previously had an explicit grab.
///
/// If the parent is a grabbing popup which has already been dismissed, this
/// popup will be immediately dismissed. If the parent is a popup that did
/// not take an explicit grab, an error will be raised.
///
/// During a popup grab, the client owning the grab will receive pointer
/// and touch events for all their surfaces as normal (similar to an
/// "owner-events" grab in X11 parlance), while the top most grabbing popup
/// will always have keyboard focus.
Grab {
/// the wl_seat of the user event
seat: ObjectId,
/// the serial of the user event
serial: u32,
},
/// recalculate the popup's location
///
/// Reposition an already-mapped popup. The popup will be placed given the
/// details in the passed xdg_positioner object, and a
/// xdg_popup.repositioned followed by xdg_popup.configure and
/// xdg_surface.configure will be emitted in response. Any parameters set
/// by the previous positioner will be discarded.
///
/// The passed token will be sent in the corresponding
/// xdg_popup.repositioned event. The new popup position will not take
/// effect until the corresponding configure event is acknowledged by the
/// client. See xdg_popup.repositioned for details. The token itself is
/// opaque, and has no other special meaning.
///
/// If multiple reposition requests are sent, the compositor may skip all
/// but the last one.
///
/// If the popup is repositioned in response to a configure event for its
/// parent, the client should send an xdg_positioner.set_parent_configure
/// and possibly an xdg_positioner.set_parent_size request to allow the
/// compositor to properly constrain the popup.
///
/// If the popup is repositioned together with a parent that is being
/// resized, but not in response to a configure event, the client should
/// send an xdg_positioner.set_parent_size request.
Reposition {
positioner: ObjectId,
/// reposition request token
token: u32,
},
}
impl MessageType for Request {
fn log(&self, this: ObjectId) -> String {
match *self {
Request::Destroy {
} => {
format!("xdg_popup@{:?}::destroy()", this)
}
Request::Grab {
ref seat,
ref serial,
} => {
format!("xdg_popup@{:?}::grab(seat: {:?}, serial: {:?})", this, seat, serial)
}
Request::Reposition {
ref positioner,
ref token,
} => {
format!("xdg_popup@{:?}::reposition(positioner: {:?}, token: {:?})", this, positioner, token)
}
}
}
fn message_name(&self) -> &'static std::ffi::CStr{
match *self {
Request::Destroy { .. } => c"xdg_popup::destroy",
Request::Grab { .. } => c"xdg_popup::grab",
Request::Reposition { .. } => c"xdg_popup::reposition",
}
}
}
#[derive(Debug)]
pub enum Event {
/// configure the popup surface
///
/// This event asks the popup surface to configure itself given the
/// configuration. The configured state should not be applied immediately.
/// See xdg_surface.configure for details.
///
/// The x and y arguments represent the position the popup was placed at
/// given the xdg_positioner rule, relative to the upper left corner of the
/// window geometry of the parent surface.
///
/// For version 2 or older, the configure event for an xdg_popup is only
/// ever sent once for the initial configuration. Starting with version 3,
/// it may be sent again if the popup is setup with an xdg_positioner with
/// set_reactive requested, or in response to xdg_popup.reposition requests.
Configure {
/// x position relative to parent surface window geometry
x: i32,
/// y position relative to parent surface window geometry
y: i32,
/// window geometry width
width: i32,
/// window geometry height
height: i32,
},
/// popup interaction is done
///
/// The popup_done event is sent out when a popup is dismissed by the
/// compositor. The client should destroy the xdg_popup object at this
/// point.
PopupDone,
/// signal the completion of a repositioned request
///
/// The repositioned event is sent as part of a popup configuration
/// sequence, together with xdg_popup.configure and lastly
/// xdg_surface.configure to notify the completion of a reposition request.
///
/// The repositioned event is to notify about the completion of a
/// xdg_popup.reposition request. The token argument is the token passed
/// in the xdg_popup.reposition request.
///
/// Immediately after this event is emitted, xdg_popup.configure and
/// xdg_surface.configure will be sent with the updated size and position,
/// as well as a new configure serial.
///
/// The client should optionally update the content of the popup, but must
/// acknowledge the new popup configuration for the new position to take
/// effect. See xdg_surface.ack_configure for details.
Repositioned {
/// reposition request token
token: u32,
},
}
impl MessageType for Event {
fn log(&self, this: ObjectId) -> String {
match *self {
Event::Configure {
ref x,
ref y,
ref width,
ref height,
} => {
format!("xdg_popup@{:?}::configure(x: {:?}, y: {:?}, width: {:?}, height: {:?})", this, x, y, width, height)
}
Event::PopupDone {
} => {
format!("xdg_popup@{:?}::popup_done()", this)
}
Event::Repositioned {
ref token,
} => {
format!("xdg_popup@{:?}::repositioned(token: {:?})", this, token)
}
}
}
fn message_name(&self) -> &'static std::ffi::CStr{
match *self {
Event::Configure { .. } => c"xdg_popup::configure",
Event::PopupDone { .. } => c"xdg_popup::popup_done",
Event::Repositioned { .. } => c"xdg_popup::repositioned",
}
}
}
impl IntoMessage for Request {
type Error = EncodeError;
fn into_message(self, id: u32) -> Result<Message, <Self as IntoMessage>::Error> {
let mut header = MessageHeader {
sender: id,
opcode: 0,
length: 0,
};
let mut msg = Message::new();
msg.write_header(&header)?;
match self {
Request::Destroy {
} => {
header.opcode = 0;
},
Request::Grab {
seat,
serial,
} => {
msg.write_arg(Arg::Object(seat))?;
msg.write_arg(Arg::Uint(serial))?;
header.opcode = 1;
},
Request::Reposition {
positioner,
token,
} => {
msg.write_arg(Arg::Object(positioner))?;
msg.write_arg(Arg::Uint(token))?;
header.opcode = 2;
},
}
header.length = msg.bytes().len() as u16;
msg.rewind();
msg.write_header(&header)?;
Ok(msg)
}
}
impl FromArgs for Event {
fn from_args(op: u16, mut args: Vec<Arg>) -> Result<Self, anyhow::Error> {
match op {
0 /* configure */ => {
let mut iter = args.into_iter();
Ok(Event::Configure {
x: iter.next()
.ok_or(DecodeError::InsufficientArgs)?
.as_int()?,
y: iter.next()
.ok_or(DecodeError::InsufficientArgs)?
.as_int()?,
width: iter.next()
.ok_or(DecodeError::InsufficientArgs)?
.as_int()?,
height: iter.next()
.ok_or(DecodeError::InsufficientArgs)?
.as_int()?,
})
},
1 /* popup_done */ => {
let mut iter = args.into_iter();
Ok(Event::PopupDone {
})
},
2 /* repositioned */ => {
let mut iter = args.into_iter();
Ok(Event::Repositioned {
token: iter.next()
.ok_or(DecodeError::InsufficientArgs)?
.as_uint()?,
})
},
_ => {
Err(DecodeError::InvalidOpcode(op).into())
},
}
}
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum Error {
/// tried to grab after being mapped,
InvalidGrab = 0,
}
impl Error {
pub fn from_bits(v: u32) -> Option<Self> {
match v {
0 => Some(Error::InvalidGrab),
_ => None,
}
}
pub fn bits(&self) -> u32 {
*self as u32
}
}
impl Into<Arg> for Error {
fn into(self) -> Arg {
Arg::Uint(self.bits())
}
}
} // mod xdg_popup
pub use crate::xdg_popup::XdgPopup;
pub use crate::xdg_popup::Request as XdgPopupRequest;
pub use crate::xdg_popup::Event as XdgPopupEvent;