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
// // DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/nsIBrowserSearchService.idl // /// `interface nsISearchSubmission : nsISupports` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsISearchSubmission { vtable: *const nsISearchSubmissionVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsISearchSubmission. unsafe impl XpCom for nsISearchSubmission { const IID: nsIID = nsID(0x5799251f, 0x5b55, 0x4df7, [0xa9, 0xe7, 0x0c, 0x27, 0x81, 0x2c, 0x46, 0x9a]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsISearchSubmission { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsISearchSubmission. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsISearchSubmissionCoerce { /// Cheaply cast a value of this type from a `nsISearchSubmission`. fn coerce_from(v: &nsISearchSubmission) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsISearchSubmissionCoerce for nsISearchSubmission { #[inline] fn coerce_from(v: &nsISearchSubmission) -> &Self { v } } impl nsISearchSubmission { /// Cast this `nsISearchSubmission` to one of its base interfaces. #[inline] pub fn coerce<T: nsISearchSubmissionCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsISearchSubmission { type Target = nsISupports; #[inline] fn deref(&self) -> &nsISupports { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsISupportsCoerce> nsISearchSubmissionCoerce for T { #[inline] fn coerce_from(v: &nsISearchSubmission) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsISearchSubmission // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsISearchSubmissionVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* readonly attribute nsIInputStream postData; */ pub GetPostData: unsafe extern "system" fn (this: *const nsISearchSubmission, aPostData: *mut *const nsIInputStream) -> nsresult, /* readonly attribute nsIURI uri; */ pub GetUri: unsafe extern "system" fn (this: *const nsISearchSubmission, aUri: *mut *const nsIURI) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsISearchSubmission { /// ```text /// /** /// * The POST data associated with a search submission, wrapped in a MIME /// * input stream. May be null. /// */ /// ``` /// /// `readonly attribute nsIInputStream postData;` #[inline] pub unsafe fn GetPostData(&self, aPostData: *mut *const nsIInputStream) -> nsresult { ((*self.vtable).GetPostData)(self, aPostData) } /// ```text /// /** /// * The URI to submit a search to. /// */ /// ``` /// /// `readonly attribute nsIURI uri;` #[inline] pub unsafe fn GetUri(&self, aUri: *mut *const nsIURI) -> nsresult { ((*self.vtable).GetUri)(self, aUri) } } /// `interface nsISearchEngine : nsISupports` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsISearchEngine { vtable: *const nsISearchEngineVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsISearchEngine. unsafe impl XpCom for nsISearchEngine { const IID: nsIID = nsID(0x620bd920, 0x0491, 0x48c8, [0x99, 0xa8, 0xd6, 0x04, 0x7e, 0x64, 0x80, 0x2d]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsISearchEngine { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsISearchEngine. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsISearchEngineCoerce { /// Cheaply cast a value of this type from a `nsISearchEngine`. fn coerce_from(v: &nsISearchEngine) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsISearchEngineCoerce for nsISearchEngine { #[inline] fn coerce_from(v: &nsISearchEngine) -> &Self { v } } impl nsISearchEngine { /// Cast this `nsISearchEngine` to one of its base interfaces. #[inline] pub fn coerce<T: nsISearchEngineCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsISearchEngine { type Target = nsISupports; #[inline] fn deref(&self) -> &nsISupports { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsISupportsCoerce> nsISearchEngineCoerce for T { #[inline] fn coerce_from(v: &nsISearchEngine) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsISearchEngine // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsISearchEngineVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* nsISearchSubmission getSubmission (in AString data, [optional] in AString responseType, [optional] in AString purpose); */ pub GetSubmission: unsafe extern "system" fn (this: *const nsISearchEngine, data: &::nsstring::nsAString, responseType: &::nsstring::nsAString, purpose: &::nsstring::nsAString, _retval: *mut *const nsISearchSubmission) -> nsresult, /* void addParam (in AString name, in AString value, in AString responseType); */ pub AddParam: unsafe extern "system" fn (this: *const nsISearchEngine, name: &::nsstring::nsAString, value: &::nsstring::nsAString, responseType: &::nsstring::nsAString) -> nsresult, /* boolean supportsResponseType (in AString responseType); */ pub SupportsResponseType: unsafe extern "system" fn (this: *const nsISearchEngine, responseType: &::nsstring::nsAString, _retval: *mut bool) -> nsresult, /* AString getIconURLBySize (in long width, in long height); */ pub GetIconURLBySize: unsafe extern "system" fn (this: *const nsISearchEngine, width: libc::int32_t, height: libc::int32_t, _retval: &mut ::nsstring::nsAString) -> nsresult, /* jsval getIcons (); */ /// Unable to generate binding because `native type JS::Value is unsupported` pub GetIcons: *const ::libc::c_void, /* void speculativeConnect (in jsval options); */ /// Unable to generate binding because `native type JS::Value is unsupported` pub SpeculativeConnect: *const ::libc::c_void, /* attribute AString alias; */ pub GetAlias: unsafe extern "system" fn (this: *const nsISearchEngine, aAlias: &mut ::nsstring::nsAString) -> nsresult, /* attribute AString alias; */ pub SetAlias: unsafe extern "system" fn (this: *const nsISearchEngine, aAlias: &::nsstring::nsAString) -> nsresult, /* readonly attribute AString description; */ pub GetDescription: unsafe extern "system" fn (this: *const nsISearchEngine, aDescription: &mut ::nsstring::nsAString) -> nsresult, /* attribute boolean hidden; */ pub GetHidden: unsafe extern "system" fn (this: *const nsISearchEngine, aHidden: *mut bool) -> nsresult, /* attribute boolean hidden; */ pub SetHidden: unsafe extern "system" fn (this: *const nsISearchEngine, aHidden: bool) -> nsresult, /* readonly attribute nsIURI iconURI; */ pub GetIconURI: unsafe extern "system" fn (this: *const nsISearchEngine, aIconURI: *mut *const nsIURI) -> nsresult, /* readonly attribute AString name; */ pub GetName: unsafe extern "system" fn (this: *const nsISearchEngine, aName: &mut ::nsstring::nsAString) -> nsresult, /* readonly attribute AString searchForm; */ pub GetSearchForm: unsafe extern "system" fn (this: *const nsISearchEngine, aSearchForm: &mut ::nsstring::nsAString) -> nsresult, /* readonly attribute AString identifier; */ pub GetIdentifier: unsafe extern "system" fn (this: *const nsISearchEngine, aIdentifier: &mut ::nsstring::nsAString) -> nsresult, /* AString getResultDomain ([optional] in AString responseType); */ pub GetResultDomain: unsafe extern "system" fn (this: *const nsISearchEngine, responseType: &::nsstring::nsAString, _retval: &mut ::nsstring::nsAString) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsISearchEngine { /// ```text /// /** /// * Gets a nsISearchSubmission object that contains information about what to /// * send to the search engine, including the URI and postData, if applicable. /// * /// * @param data /// * Data to add to the submission object. /// * i.e. the search terms. /// * /// * @param responseType [optional] /// * The MIME type that we'd like to receive in response /// * to this submission. If null, will default to "text/html". /// * /// * @param purpose [optional] /// * A string meant to indicate the context of the search request. This /// * allows the search service to provide a different nsISearchSubmission /// * depending on e.g. where the search is triggered in the UI. /// * /// * @returns A nsISearchSubmission object that contains information about what /// * to send to the search engine. If no submission can be /// * obtained for the given responseType, returns null. /// */ /// ``` /// /// `nsISearchSubmission getSubmission (in AString data, [optional] in AString responseType, [optional] in AString purpose);` #[inline] pub unsafe fn GetSubmission(&self, data: &::nsstring::nsAString, responseType: &::nsstring::nsAString, purpose: &::nsstring::nsAString, _retval: *mut *const nsISearchSubmission) -> nsresult { ((*self.vtable).GetSubmission)(self, data, responseType, purpose, _retval) } /// ```text /// /** /// * Adds a parameter to the search engine's submission data. This should only /// * be called on engines created via addEngineWithDetails. /// * /// * @param name /// * The parameter's name. Must not be null. /// * /// * @param value /// * The value to pass. If value is "{searchTerms}", it will be /// * substituted with the user-entered data when retrieving the /// * submission. Must not be null. /// * /// * @param responseType /// * Since an engine can have several different request URLs, /// * differentiated by response types, this parameter selects /// * a request to add parameters to. If null, will default /// * to "text/html" /// * /// * @throws NS_ERROR_FAILURE if the search engine is read-only. /// * @throws NS_ERROR_INVALID_ARG if name or value are null. /// */ /// ``` /// /// `void addParam (in AString name, in AString value, in AString responseType);` #[inline] pub unsafe fn AddParam(&self, name: &::nsstring::nsAString, value: &::nsstring::nsAString, responseType: &::nsstring::nsAString) -> nsresult { ((*self.vtable).AddParam)(self, name, value, responseType) } /// ```text /// /** /// * Determines whether the engine can return responses in the given /// * MIME type. Returns true if the engine spec has a URL with the /// * given responseType, false otherwise. /// * /// * @param responseType /// * The MIME type to check for /// */ /// ``` /// /// `boolean supportsResponseType (in AString responseType);` #[inline] pub unsafe fn SupportsResponseType(&self, responseType: &::nsstring::nsAString, _retval: *mut bool) -> nsresult { ((*self.vtable).SupportsResponseType)(self, responseType, _retval) } /// ```text /// /** /// * Returns a string with the URL to an engine's icon matching both width and /// * height. Returns null if icon with specified dimensions is not found. /// * /// * @param width /// * Width of the requested icon. /// * @param height /// * Height of the requested icon. /// */ /// ``` /// /// `AString getIconURLBySize (in long width, in long height);` #[inline] pub unsafe fn GetIconURLBySize(&self, width: libc::int32_t, height: libc::int32_t, _retval: &mut ::nsstring::nsAString) -> nsresult { ((*self.vtable).GetIconURLBySize)(self, width, height, _retval) } /// ```text /// /** /// * Gets an array of all available icons. Each entry is an object with /// * width, height and url properties. width and height are numeric and /// * represent the icon's dimensions. url is a string with the URL for /// * the icon. /// */ /// ``` /// /// `jsval getIcons ();` const _GetIcons: () = (); /// ```text /// /** /// * Opens a speculative connection to the engine's search URI /// * (and suggest URI, if different) to reduce request latency /// * /// * @param options /// * An object that must contain the following fields: /// * {window} the content window for the window performing the search /// * {originAttributes} the originAttributes for performing the search /// * /// * @throws NS_ERROR_INVALID_ARG if options is omitted or lacks required /// * elemeents /// */ /// ``` /// /// `void speculativeConnect (in jsval options);` const _SpeculativeConnect: () = (); /// ```text /// /** /// * An optional shortcut alias for the engine. /// * When non-null, this is a unique identifier. /// */ /// ``` /// /// `attribute AString alias;` #[inline] pub unsafe fn GetAlias(&self, aAlias: &mut ::nsstring::nsAString) -> nsresult { ((*self.vtable).GetAlias)(self, aAlias) } /// ```text /// /** /// * An optional shortcut alias for the engine. /// * When non-null, this is a unique identifier. /// */ /// ``` /// /// `attribute AString alias;` #[inline] pub unsafe fn SetAlias(&self, aAlias: &::nsstring::nsAString) -> nsresult { ((*self.vtable).SetAlias)(self, aAlias) } /// ```text /// /** /// * A text description describing the engine. /// */ /// ``` /// /// `readonly attribute AString description;` #[inline] pub unsafe fn GetDescription(&self, aDescription: &mut ::nsstring::nsAString) -> nsresult { ((*self.vtable).GetDescription)(self, aDescription) } /// ```text /// /** /// * Whether the engine should be hidden from the user. /// */ /// ``` /// /// `attribute boolean hidden;` #[inline] pub unsafe fn GetHidden(&self, aHidden: *mut bool) -> nsresult { ((*self.vtable).GetHidden)(self, aHidden) } /// ```text /// /** /// * Whether the engine should be hidden from the user. /// */ /// ``` /// /// `attribute boolean hidden;` #[inline] pub unsafe fn SetHidden(&self, aHidden: bool) -> nsresult { ((*self.vtable).SetHidden)(self, aHidden) } /// ```text /// /** /// * A nsIURI corresponding to the engine's icon, stored locally. May be null. /// */ /// ``` /// /// `readonly attribute nsIURI iconURI;` #[inline] pub unsafe fn GetIconURI(&self, aIconURI: *mut *const nsIURI) -> nsresult { ((*self.vtable).GetIconURI)(self, aIconURI) } /// ```text /// /** /// * The display name of the search engine. This is a unique identifier. /// */ /// ``` /// /// `readonly attribute AString name;` #[inline] pub unsafe fn GetName(&self, aName: &mut ::nsstring::nsAString) -> nsresult { ((*self.vtable).GetName)(self, aName) } /// ```text /// /** /// * A URL string pointing to the engine's search form. /// */ /// ``` /// /// `readonly attribute AString searchForm;` #[inline] pub unsafe fn GetSearchForm(&self, aSearchForm: &mut ::nsstring::nsAString) -> nsresult { ((*self.vtable).GetSearchForm)(self, aSearchForm) } /// ```text /// /** /// * An optional unique identifier for this search engine within the context of /// * the distribution, as provided by the distributing entity. /// */ /// ``` /// /// `readonly attribute AString identifier;` #[inline] pub unsafe fn GetIdentifier(&self, aIdentifier: &mut ::nsstring::nsAString) -> nsresult { ((*self.vtable).GetIdentifier)(self, aIdentifier) } /// ```text /// /** /// * Gets a string representing the hostname from which search results for a /// * given responseType are returned, minus the leading "www." (if present). /// * This can be specified as an url attribute in the engine description file, /// * but will default to host from the <Url>'s template otherwise. /// * /// * @param responseType [optional] /// * The MIME type to get resultDomain for. Defaults to "text/html". /// * /// * @return the resultDomain for the given responseType. /// */ /// ``` /// /// `AString getResultDomain ([optional] in AString responseType);` #[inline] pub unsafe fn GetResultDomain(&self, responseType: &::nsstring::nsAString, _retval: &mut ::nsstring::nsAString) -> nsresult { ((*self.vtable).GetResultDomain)(self, responseType, _retval) } } /// `interface nsISearchParseSubmissionResult : nsISupports` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsISearchParseSubmissionResult { vtable: *const nsISearchParseSubmissionResultVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsISearchParseSubmissionResult. unsafe impl XpCom for nsISearchParseSubmissionResult { const IID: nsIID = nsID(0x0dc93e51, 0xa7bf, 0x4a16, [0x86, 0x2d, 0x4b, 0x34, 0x69, 0xff, 0x62, 0x06]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsISearchParseSubmissionResult { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsISearchParseSubmissionResult. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsISearchParseSubmissionResultCoerce { /// Cheaply cast a value of this type from a `nsISearchParseSubmissionResult`. fn coerce_from(v: &nsISearchParseSubmissionResult) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsISearchParseSubmissionResultCoerce for nsISearchParseSubmissionResult { #[inline] fn coerce_from(v: &nsISearchParseSubmissionResult) -> &Self { v } } impl nsISearchParseSubmissionResult { /// Cast this `nsISearchParseSubmissionResult` to one of its base interfaces. #[inline] pub fn coerce<T: nsISearchParseSubmissionResultCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsISearchParseSubmissionResult { type Target = nsISupports; #[inline] fn deref(&self) -> &nsISupports { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsISupportsCoerce> nsISearchParseSubmissionResultCoerce for T { #[inline] fn coerce_from(v: &nsISearchParseSubmissionResult) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsISearchParseSubmissionResult // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsISearchParseSubmissionResultVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* readonly attribute nsISearchEngine engine; */ pub GetEngine: unsafe extern "system" fn (this: *const nsISearchParseSubmissionResult, aEngine: *mut *const nsISearchEngine) -> nsresult, /* readonly attribute AString terms; */ pub GetTerms: unsafe extern "system" fn (this: *const nsISearchParseSubmissionResult, aTerms: &mut ::nsstring::nsAString) -> nsresult, /* readonly attribute long termsOffset; */ pub GetTermsOffset: unsafe extern "system" fn (this: *const nsISearchParseSubmissionResult, aTermsOffset: *mut libc::int32_t) -> nsresult, /* readonly attribute long termsLength; */ pub GetTermsLength: unsafe extern "system" fn (this: *const nsISearchParseSubmissionResult, aTermsLength: *mut libc::int32_t) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsISearchParseSubmissionResult { /// ```text /// /** /// * The search engine associated with the URL passed in to /// * nsISearchEngine::parseSubmissionURL, or null if the URL does not represent /// * a search submission. /// */ /// ``` /// /// `readonly attribute nsISearchEngine engine;` #[inline] pub unsafe fn GetEngine(&self, aEngine: *mut *const nsISearchEngine) -> nsresult { ((*self.vtable).GetEngine)(self, aEngine) } /// ```text /// /** /// * String containing the sought terms. This can be an empty string in case no /// * terms were specified or the URL does not represent a search submission. /// */ /// ``` /// /// `readonly attribute AString terms;` #[inline] pub unsafe fn GetTerms(&self, aTerms: &mut ::nsstring::nsAString) -> nsresult { ((*self.vtable).GetTerms)(self, aTerms) } /// ```text /// /** /// * The offset of the string |terms| in the URL passed in to /// * nsISearchEngine::parseSubmissionURL, or -1 if the URL does not represent /// * a search submission. /// */ /// ``` /// /// `readonly attribute long termsOffset;` #[inline] pub unsafe fn GetTermsOffset(&self, aTermsOffset: *mut libc::int32_t) -> nsresult { ((*self.vtable).GetTermsOffset)(self, aTermsOffset) } /// ```text /// /** /// * The length of the |terms| in the original encoding of the URL passed in to /// * nsISearchEngine::parseSubmissionURL. If the search term in the original /// * URL is encoded then this will be bigger than |terms.length|. /// */ /// ``` /// /// `readonly attribute long termsLength;` #[inline] pub unsafe fn GetTermsLength(&self, aTermsLength: *mut libc::int32_t) -> nsresult { ((*self.vtable).GetTermsLength)(self, aTermsLength) } } /// `interface nsISearchInstallCallback : nsISupports` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsISearchInstallCallback { vtable: *const nsISearchInstallCallbackVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsISearchInstallCallback. unsafe impl XpCom for nsISearchInstallCallback { const IID: nsIID = nsID(0x9fc39136, 0xf08b, 0x46d3, [0xb2, 0x32, 0x96, 0xf4, 0xb7, 0xb0, 0xe2, 0x35]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsISearchInstallCallback { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsISearchInstallCallback. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsISearchInstallCallbackCoerce { /// Cheaply cast a value of this type from a `nsISearchInstallCallback`. fn coerce_from(v: &nsISearchInstallCallback) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsISearchInstallCallbackCoerce for nsISearchInstallCallback { #[inline] fn coerce_from(v: &nsISearchInstallCallback) -> &Self { v } } impl nsISearchInstallCallback { /// Cast this `nsISearchInstallCallback` to one of its base interfaces. #[inline] pub fn coerce<T: nsISearchInstallCallbackCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsISearchInstallCallback { type Target = nsISupports; #[inline] fn deref(&self) -> &nsISupports { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsISupportsCoerce> nsISearchInstallCallbackCoerce for T { #[inline] fn coerce_from(v: &nsISearchInstallCallback) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsISearchInstallCallback // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsISearchInstallCallbackVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* void onSuccess (in nsISearchEngine engine); */ pub OnSuccess: unsafe extern "system" fn (this: *const nsISearchInstallCallback, engine: *const nsISearchEngine) -> nsresult, /* void onError (in unsigned long errorCode); */ pub OnError: unsafe extern "system" fn (this: *const nsISearchInstallCallback, errorCode: libc::uint32_t) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsISearchInstallCallback { pub const ERROR_UNKNOWN_FAILURE: i64 = 1; pub const ERROR_DUPLICATE_ENGINE: i64 = 2; /// ```text /// /** /// * Called to indicate that the engine addition process succeeded. /// * /// * @param engine /// * The nsISearchEngine object that was added (will not be null). /// */ /// ``` /// /// `void onSuccess (in nsISearchEngine engine);` #[inline] pub unsafe fn OnSuccess(&self, engine: *const nsISearchEngine) -> nsresult { ((*self.vtable).OnSuccess)(self, engine) } /// ```text /// /** /// * Called to indicate that the engine addition process failed. /// * /// * @param errorCode /// * One of the ERROR_* values described above indicating the cause of /// * the failure. /// */ /// ``` /// /// `void onError (in unsigned long errorCode);` #[inline] pub unsafe fn OnError(&self, errorCode: libc::uint32_t) -> nsresult { ((*self.vtable).OnError)(self, errorCode) } } /// `interface nsIBrowserSearchInitObserver : nsISupports` /// /// ```text /// /** /// * Callback for asynchronous initialization of nsIBrowserSearchService /// */ /// ``` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsIBrowserSearchInitObserver { vtable: *const nsIBrowserSearchInitObserverVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsIBrowserSearchInitObserver. unsafe impl XpCom for nsIBrowserSearchInitObserver { const IID: nsIID = nsID(0x02256156, 0x16e4, 0x47f1, [0x99, 0x79, 0x76, 0xff, 0x98, 0xce, 0xb5, 0x90]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsIBrowserSearchInitObserver { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsIBrowserSearchInitObserver. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsIBrowserSearchInitObserverCoerce { /// Cheaply cast a value of this type from a `nsIBrowserSearchInitObserver`. fn coerce_from(v: &nsIBrowserSearchInitObserver) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsIBrowserSearchInitObserverCoerce for nsIBrowserSearchInitObserver { #[inline] fn coerce_from(v: &nsIBrowserSearchInitObserver) -> &Self { v } } impl nsIBrowserSearchInitObserver { /// Cast this `nsIBrowserSearchInitObserver` to one of its base interfaces. #[inline] pub fn coerce<T: nsIBrowserSearchInitObserverCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsIBrowserSearchInitObserver { type Target = nsISupports; #[inline] fn deref(&self) -> &nsISupports { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsISupportsCoerce> nsIBrowserSearchInitObserverCoerce for T { #[inline] fn coerce_from(v: &nsIBrowserSearchInitObserver) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsIBrowserSearchInitObserver // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsIBrowserSearchInitObserverVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* void onInitComplete (in nsresult aStatus); */ pub OnInitComplete: unsafe extern "system" fn (this: *const nsIBrowserSearchInitObserver, aStatus: nsresult) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsIBrowserSearchInitObserver { /// ```text /// /** /// * Called once initialization of the browser search service is complete. /// * /// * @param aStatus The status of that service. /// */ /// ``` /// /// `void onInitComplete (in nsresult aStatus);` #[inline] pub unsafe fn OnInitComplete(&self, aStatus: nsresult) -> nsresult { ((*self.vtable).OnInitComplete)(self, aStatus) } } /// `interface nsIBrowserSearchService : nsISupports` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsIBrowserSearchService { vtable: *const nsIBrowserSearchServiceVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsIBrowserSearchService. unsafe impl XpCom for nsIBrowserSearchService { const IID: nsIID = nsID(0x150ef720, 0xbbe2, 0x4169, [0xb9, 0xf3, 0xef, 0x7e, 0xc0, 0x65, 0x4c, 0xed]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsIBrowserSearchService { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsIBrowserSearchService. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsIBrowserSearchServiceCoerce { /// Cheaply cast a value of this type from a `nsIBrowserSearchService`. fn coerce_from(v: &nsIBrowserSearchService) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsIBrowserSearchServiceCoerce for nsIBrowserSearchService { #[inline] fn coerce_from(v: &nsIBrowserSearchService) -> &Self { v } } impl nsIBrowserSearchService { /// Cast this `nsIBrowserSearchService` to one of its base interfaces. #[inline] pub fn coerce<T: nsIBrowserSearchServiceCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsIBrowserSearchService { type Target = nsISupports; #[inline] fn deref(&self) -> &nsISupports { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsISupportsCoerce> nsIBrowserSearchServiceCoerce for T { #[inline] fn coerce_from(v: &nsIBrowserSearchService) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsIBrowserSearchService // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsIBrowserSearchServiceVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* void init ([optional] in nsIBrowserSearchInitObserver aObserver); */ pub Init: unsafe extern "system" fn (this: *const nsIBrowserSearchService, aObserver: *const nsIBrowserSearchInitObserver) -> nsresult, /* readonly attribute bool isInitialized; */ pub GetIsInitialized: unsafe extern "system" fn (this: *const nsIBrowserSearchService, aIsInitialized: *mut bool) -> nsresult, /* void resetToOriginalDefaultEngine (); */ pub ResetToOriginalDefaultEngine: unsafe extern "system" fn (this: *const nsIBrowserSearchService) -> nsresult, /* boolean hasEngineWithURL (in AString method, in AString url, in jsval formData); */ /// Unable to generate binding because `native type JS::Value is unsupported` pub HasEngineWithURL: *const ::libc::c_void, /* void addEngine (in AString engineURL, in long dataType, in AString iconURL, in boolean confirm, [optional] in nsISearchInstallCallback callback, [optional] in AString extensionID); */ pub AddEngine: unsafe extern "system" fn (this: *const nsIBrowserSearchService, engineURL: &::nsstring::nsAString, dataType: libc::int32_t, iconURL: &::nsstring::nsAString, confirm: bool, callback: *const nsISearchInstallCallback, extensionID: &::nsstring::nsAString) -> nsresult, /* void addEngineWithDetails (in AString name, in jsval iconURL, [optional] in AString alias, [optional] in AString description, [optional] in AString method, [optional] in AString url, [optional] in AString extensionID); */ /// Unable to generate binding because `native type JS::Value is unsupported` pub AddEngineWithDetails: *const ::libc::c_void, /* void restoreDefaultEngines (); */ pub RestoreDefaultEngines: unsafe extern "system" fn (this: *const nsIBrowserSearchService) -> nsresult, /* nsISearchEngine getEngineByAlias (in AString alias); */ pub GetEngineByAlias: unsafe extern "system" fn (this: *const nsIBrowserSearchService, alias: &::nsstring::nsAString, _retval: *mut *const nsISearchEngine) -> nsresult, /* nsISearchEngine getEngineByName (in AString aEngineName); */ pub GetEngineByName: unsafe extern "system" fn (this: *const nsIBrowserSearchService, aEngineName: &::nsstring::nsAString, _retval: *mut *const nsISearchEngine) -> nsresult, /* void getEngines ([optional] out unsigned long engineCount, [array, size_is (engineCount), retval] out nsISearchEngine engines); */ pub GetEngines: unsafe extern "system" fn (this: *const nsIBrowserSearchService, engineCount: *mut libc::uint32_t, engines: *mut *mut *const nsISearchEngine) -> nsresult, /* void getVisibleEngines ([optional] out unsigned long engineCount, [array, size_is (engineCount), retval] out nsISearchEngine engines); */ pub GetVisibleEngines: unsafe extern "system" fn (this: *const nsIBrowserSearchService, engineCount: *mut libc::uint32_t, engines: *mut *mut *const nsISearchEngine) -> nsresult, /* void getDefaultEngines ([optional] out unsigned long engineCount, [array, size_is (engineCount), retval] out nsISearchEngine engines); */ pub GetDefaultEngines: unsafe extern "system" fn (this: *const nsIBrowserSearchService, engineCount: *mut libc::uint32_t, engines: *mut *mut *const nsISearchEngine) -> nsresult, /* void getEnginesByExtensionID (in AString extensionID, [optional] out unsigned long engineCount, [array, size_is (engineCount), retval] out nsISearchEngine engines); */ pub GetEnginesByExtensionID: unsafe extern "system" fn (this: *const nsIBrowserSearchService, extensionID: &::nsstring::nsAString, engineCount: *mut libc::uint32_t, engines: *mut *mut *const nsISearchEngine) -> nsresult, /* void moveEngine (in nsISearchEngine engine, in long newIndex); */ pub MoveEngine: unsafe extern "system" fn (this: *const nsIBrowserSearchService, engine: *const nsISearchEngine, newIndex: libc::int32_t) -> nsresult, /* void removeEngine (in nsISearchEngine engine); */ pub RemoveEngine: unsafe extern "system" fn (this: *const nsIBrowserSearchService, engine: *const nsISearchEngine) -> nsresult, /* readonly attribute nsISearchEngine originalDefaultEngine; */ pub GetOriginalDefaultEngine: unsafe extern "system" fn (this: *const nsIBrowserSearchService, aOriginalDefaultEngine: *mut *const nsISearchEngine) -> nsresult, /* attribute nsISearchEngine defaultEngine; */ pub GetDefaultEngine: unsafe extern "system" fn (this: *const nsIBrowserSearchService, aDefaultEngine: *mut *const nsISearchEngine) -> nsresult, /* attribute nsISearchEngine defaultEngine; */ pub SetDefaultEngine: unsafe extern "system" fn (this: *const nsIBrowserSearchService, aDefaultEngine: *const nsISearchEngine) -> nsresult, /* attribute nsISearchEngine currentEngine; */ pub GetCurrentEngine: unsafe extern "system" fn (this: *const nsIBrowserSearchService, aCurrentEngine: *mut *const nsISearchEngine) -> nsresult, /* attribute nsISearchEngine currentEngine; */ pub SetCurrentEngine: unsafe extern "system" fn (this: *const nsIBrowserSearchService, aCurrentEngine: *const nsISearchEngine) -> nsresult, /* jsval getDefaultEngineInfo (); */ /// Unable to generate binding because `native type JS::Value is unsupported` pub GetDefaultEngineInfo: *const ::libc::c_void, /* nsISearchParseSubmissionResult parseSubmissionURL (in AString url); */ pub ParseSubmissionURL: unsafe extern "system" fn (this: *const nsIBrowserSearchService, url: &::nsstring::nsAString, _retval: *mut *const nsISearchParseSubmissionResult) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsIBrowserSearchService { /// ```text /// /** /// * Start asynchronous initialization. /// * /// * The callback is triggered once initialization is complete, which may be /// * immediately, if initialization has already been completed by some previous /// * call to this method. The callback is always invoked asynchronously. /// * /// * @param aObserver An optional object observing the end of initialization. /// */ /// ``` /// /// `void init ([optional] in nsIBrowserSearchInitObserver aObserver);` #[inline] pub unsafe fn Init(&self, aObserver: *const nsIBrowserSearchInitObserver) -> nsresult { ((*self.vtable).Init)(self, aObserver) } /// ```text /// /** /// * Determine whether initialization has been completed. /// * /// * Clients of the service can use this attribute to quickly determine whether /// * initialization is complete, and decide to trigger some immediate treatment, /// * to launch asynchronous initialization or to bailout. /// * /// * Note that this attribute does not indicate that initialization has succeeded. /// * /// * @return |true| if the search service is now initialized, |false| if /// * initialization has not been triggered yet. /// */ /// ``` /// /// `readonly attribute bool isInitialized;` #[inline] pub unsafe fn GetIsInitialized(&self, aIsInitialized: *mut bool) -> nsresult { ((*self.vtable).GetIsInitialized)(self, aIsInitialized) } /// ```text /// /** /// * Resets the default engine to its original value. /// */ /// ``` /// /// `void resetToOriginalDefaultEngine ();` #[inline] pub unsafe fn ResetToOriginalDefaultEngine(&self, ) -> nsresult { ((*self.vtable).ResetToOriginalDefaultEngine)(self, ) } /// ```text /// /** /// * Checks if an EngineURL of type URLTYPE_SEARCH_HTML exists for /// * any engine, with a matching method, template URL, and query params. /// * /// * @param method /// * The HTTP request method used when submitting a search query. /// * Must be a case insensitive value of either "get" or "post". /// * /// * @param url /// * The URL to which search queries should be sent. /// * Must not be null. /// * /// * @param formData /// * The un-sorted form data used as query params. /// */ /// ``` /// /// `boolean hasEngineWithURL (in AString method, in AString url, in jsval formData);` const _HasEngineWithURL: () = (); /// ```text /// /** /// * Adds a new search engine from the file at the supplied URI, optionally /// * asking the user for confirmation first. If a confirmation dialog is /// * shown, it will offer the option to begin using the newly added engine /// * right away. /// * /// * @param engineURL /// * The URL to the search engine's description file. /// * /// * @param dataType /// * Obsolete, the value is ignored. /// * /// * @param iconURL /// * A URL string to an icon file to be used as the search engine's /// * icon. This value may be overridden by an icon specified in the /// * engine description file. /// * /// * @param confirm /// * A boolean value indicating whether the user should be asked for /// * confirmation before this engine is added to the list. If this /// * value is false, the engine will be added to the list upon successful /// * load, but it will not be selected as the current engine. /// * /// * @param callback /// * A nsISearchInstallCallback that will be notified when the /// * addition is complete, or if the addition fails. It will not be /// * called if addEngine throws an exception. /// * /// * @param extensionID [optional] /// * Optional: The correct extensionID if called by an add-on. /// * /// * @throws NS_ERROR_FAILURE if the description file cannot be successfully /// * loaded. /// */ /// ``` /// /// `void addEngine (in AString engineURL, in long dataType, in AString iconURL, in boolean confirm, [optional] in nsISearchInstallCallback callback, [optional] in AString extensionID);` #[inline] pub unsafe fn AddEngine(&self, engineURL: &::nsstring::nsAString, dataType: libc::int32_t, iconURL: &::nsstring::nsAString, confirm: bool, callback: *const nsISearchInstallCallback, extensionID: &::nsstring::nsAString) -> nsresult { ((*self.vtable).AddEngine)(self, engineURL, dataType, iconURL, confirm, callback, extensionID) } /// ```text /// /** /// * Adds a new search engine, without asking the user for confirmation and /// * without starting to use it right away. /// * /// * @param name /// * The search engine's name. Must be unique. Must not be null. /// * /// * @param iconURL /// * Optional: A URL string pointing to the icon to be used to represent /// * the engine. /// * This is a jsval so that an object can be passed to replace the /// * parameters below. /// * /// * @param alias /// * Optional: A unique shortcut that can be used to retrieve the /// * search engine. /// * /// * @param description /// * Optional: a description of the search engine. /// * /// * @param method /// * Optional: The HTTP request method used when submitting a search query. /// * Case insensitive value of either "get" or "post". /// * Defaults to "get". /// * /// * @param url /// * The URL to which search queries should be sent. /// * Must not be null. /// * /// * @param extensionID [optional] /// * Optional: The correct extensionID if called by an add-on. /// * /// * Alternatively, all of these parameters except for name can be /// * passed as an object in place of parameter two. /// * /// * Services.search.addEngineWithDetails("Example engine", { /// * template: "http://example.com/?search={searchTerms}", /// * description: "Example search engine description", /// * suggestURL: http://example.com/?suggest={searchTerms}, /// * }); /// * /// * Using this method, you can use a new parameter, suggestURL: /// * /// * @param suggestURL [optional] /// * Optional: The URL to which search suggestion requests /// * should be sent. /// * /// */ /// ``` /// /// `void addEngineWithDetails (in AString name, in jsval iconURL, [optional] in AString alias, [optional] in AString description, [optional] in AString method, [optional] in AString url, [optional] in AString extensionID);` const _AddEngineWithDetails: () = (); /// ```text /// /** /// * Un-hides all engines in the set of engines returned by getDefaultEngines. /// */ /// ``` /// /// `void restoreDefaultEngines ();` #[inline] pub unsafe fn RestoreDefaultEngines(&self, ) -> nsresult { ((*self.vtable).RestoreDefaultEngines)(self, ) } /// ```text /// /** /// * Returns an engine with the specified alias. /// * /// * @param alias /// * The search engine's alias. /// * @returns The corresponding nsISearchEngine object, or null if it doesn't /// * exist. /// */ /// ``` /// /// `nsISearchEngine getEngineByAlias (in AString alias);` #[inline] pub unsafe fn GetEngineByAlias(&self, alias: &::nsstring::nsAString, _retval: *mut *const nsISearchEngine) -> nsresult { ((*self.vtable).GetEngineByAlias)(self, alias, _retval) } /// ```text /// /** /// * Returns an engine with the specified name. /// * /// * @param aEngineName /// * The name of the engine. /// * @returns The corresponding nsISearchEngine object, or null if it doesn't /// * exist. /// */ /// ``` /// /// `nsISearchEngine getEngineByName (in AString aEngineName);` #[inline] pub unsafe fn GetEngineByName(&self, aEngineName: &::nsstring::nsAString, _retval: *mut *const nsISearchEngine) -> nsresult { ((*self.vtable).GetEngineByName)(self, aEngineName, _retval) } /// ```text /// /** /// * Returns an array of all installed search engines. /// * /// * @returns an array of nsISearchEngine objects. /// */ /// ``` /// /// `void getEngines ([optional] out unsigned long engineCount, [array, size_is (engineCount), retval] out nsISearchEngine engines);` #[inline] pub unsafe fn GetEngines(&self, engineCount: *mut libc::uint32_t, engines: *mut *mut *const nsISearchEngine) -> nsresult { ((*self.vtable).GetEngines)(self, engineCount, engines) } /// ```text /// /** /// * Returns an array of all installed search engines whose hidden attribute is /// * false. /// * /// * @returns an array of nsISearchEngine objects. /// */ /// ``` /// /// `void getVisibleEngines ([optional] out unsigned long engineCount, [array, size_is (engineCount), retval] out nsISearchEngine engines);` #[inline] pub unsafe fn GetVisibleEngines(&self, engineCount: *mut libc::uint32_t, engines: *mut *mut *const nsISearchEngine) -> nsresult { ((*self.vtable).GetVisibleEngines)(self, engineCount, engines) } /// ```text /// /** /// * Returns an array of all default search engines. This includes all loaded /// * engines that aren't in the user's profile directory /// * (NS_APP_USER_SEARCH_DIR). /// * /// * @returns an array of nsISearchEngine objects. /// */ /// ``` /// /// `void getDefaultEngines ([optional] out unsigned long engineCount, [array, size_is (engineCount), retval] out nsISearchEngine engines);` #[inline] pub unsafe fn GetDefaultEngines(&self, engineCount: *mut libc::uint32_t, engines: *mut *mut *const nsISearchEngine) -> nsresult { ((*self.vtable).GetDefaultEngines)(self, engineCount, engines) } /// ```text /// /** /// * Returns an array of search engines installed by a given extension. /// * /// * @returns an array of nsISearchEngine objects. /// */ /// ``` /// /// `void getEnginesByExtensionID (in AString extensionID, [optional] out unsigned long engineCount, [array, size_is (engineCount), retval] out nsISearchEngine engines);` #[inline] pub unsafe fn GetEnginesByExtensionID(&self, extensionID: &::nsstring::nsAString, engineCount: *mut libc::uint32_t, engines: *mut *mut *const nsISearchEngine) -> nsresult { ((*self.vtable).GetEnginesByExtensionID)(self, extensionID, engineCount, engines) } /// ```text /// /** /// * Moves a visible search engine. /// * /// * @param engine /// * The engine to move. /// * @param newIndex /// * The engine's new index in the set of visible engines. /// * /// * @throws NS_ERROR_FAILURE if newIndex is out of bounds, or if engine is /// * hidden. /// */ /// ``` /// /// `void moveEngine (in nsISearchEngine engine, in long newIndex);` #[inline] pub unsafe fn MoveEngine(&self, engine: *const nsISearchEngine, newIndex: libc::int32_t) -> nsresult { ((*self.vtable).MoveEngine)(self, engine, newIndex) } /// ```text /// /** /// * Removes the search engine. If the search engine is installed in a global /// * location, this will just hide the engine. If the engine is in the user's /// * profile directory, it will be removed from disk. /// * /// * @param engine /// * The engine to remove. /// */ /// ``` /// /// `void removeEngine (in nsISearchEngine engine);` #[inline] pub unsafe fn RemoveEngine(&self, engine: *const nsISearchEngine) -> nsresult { ((*self.vtable).RemoveEngine)(self, engine) } /// ```text /// /** /// * The original Engine object that is the default for this region, /// * ignoring changes the user may have subsequently made. /// */ /// ``` /// /// `readonly attribute nsISearchEngine originalDefaultEngine;` #[inline] pub unsafe fn GetOriginalDefaultEngine(&self, aOriginalDefaultEngine: *mut *const nsISearchEngine) -> nsresult { ((*self.vtable).GetOriginalDefaultEngine)(self, aOriginalDefaultEngine) } /// ```text /// /** /// * Alias for the currentEngine attribute, kept for add-on compatibility. /// */ /// ``` /// /// `attribute nsISearchEngine defaultEngine;` #[inline] pub unsafe fn GetDefaultEngine(&self, aDefaultEngine: *mut *const nsISearchEngine) -> nsresult { ((*self.vtable).GetDefaultEngine)(self, aDefaultEngine) } /// ```text /// /** /// * Alias for the currentEngine attribute, kept for add-on compatibility. /// */ /// ``` /// /// `attribute nsISearchEngine defaultEngine;` #[inline] pub unsafe fn SetDefaultEngine(&self, aDefaultEngine: *const nsISearchEngine) -> nsresult { ((*self.vtable).SetDefaultEngine)(self, aDefaultEngine) } /// ```text /// /** /// * The currently active search engine. /// * Unless the application doesn't ship any search plugin, this should never /// * be null. If the currently active engine is removed, this attribute will /// * fallback first to the original default engine if it's not hidden, then to /// * the first visible engine, and as a last resort it will unhide the original /// * default engine. /// */ /// ``` /// /// `attribute nsISearchEngine currentEngine;` #[inline] pub unsafe fn GetCurrentEngine(&self, aCurrentEngine: *mut *const nsISearchEngine) -> nsresult { ((*self.vtable).GetCurrentEngine)(self, aCurrentEngine) } /// ```text /// /** /// * The currently active search engine. /// * Unless the application doesn't ship any search plugin, this should never /// * be null. If the currently active engine is removed, this attribute will /// * fallback first to the original default engine if it's not hidden, then to /// * the first visible engine, and as a last resort it will unhide the original /// * default engine. /// */ /// ``` /// /// `attribute nsISearchEngine currentEngine;` #[inline] pub unsafe fn SetCurrentEngine(&self, aCurrentEngine: *const nsISearchEngine) -> nsresult { ((*self.vtable).SetCurrentEngine)(self, aCurrentEngine) } /// ```text /// /** /// * Gets a representation of the default engine in an anonymized JSON /// * string suitable for recording in the Telemetry environment. /// * /// * @return an object containing anonymized info about the default engine: /// * name, loadPath, submissionURL (for default engines). /// */ /// ``` /// /// `jsval getDefaultEngineInfo ();` const _GetDefaultEngineInfo: () = (); /// ```text /// /** /// * Determines if the provided URL represents results from a search engine, and /// * provides details about the match. /// * /// * The lookup mechanism checks whether the domain name and path of the /// * provided HTTP or HTTPS URL matches one of the known values for the visible /// * search engines. The match does not depend on which of the schemes is used. /// * The expected URI parameter for the search terms must exist in the query /// * string, but other parameters are ignored. /// * /// * @param url /// * String containing the URL to parse, for example /// * "https://www.google.com/search?q=terms". /// */ /// ``` /// /// `nsISearchParseSubmissionResult parseSubmissionURL (in AString url);` #[inline] pub unsafe fn ParseSubmissionURL(&self, url: &::nsstring::nsAString, _retval: *mut *const nsISearchParseSubmissionResult) -> nsresult { ((*self.vtable).ParseSubmissionURL)(self, url, _retval) } }