/usr/share/doc/libgutenprint-doc/reference/html/group__list.html is in libgutenprint-doc 5.2.11-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>libgutenprint API Reference: list</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libgutenprint API Reference
 <span id="projectnumber">5.2.11</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">list</div> </div>
</div><!--header-->
<div class="contents">
<p>The list data type implements a fast generic doubly-linked list.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga67b4fafe1ab6ead5be7500f88874bdb0"><td class="memItemLeft" align="right" valign="top">typedef struct stp_list_item </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a></td></tr>
<tr class="memdesc:ga67b4fafe1ab6ead5be7500f88874bdb0"><td class="mdescLeft"> </td><td class="mdescRight">The list item opaque data type. <a href="#ga67b4fafe1ab6ead5be7500f88874bdb0">More...</a><br /></td></tr>
<tr class="separator:ga67b4fafe1ab6ead5be7500f88874bdb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga53cf4f01ab7d712f771cb5fb479d2ba7"><td class="memItemLeft" align="right" valign="top">typedef struct stp_list </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a></td></tr>
<tr class="memdesc:ga53cf4f01ab7d712f771cb5fb479d2ba7"><td class="mdescLeft"> </td><td class="mdescRight">The list opaque data type. <a href="#ga53cf4f01ab7d712f771cb5fb479d2ba7">More...</a><br /></td></tr>
<tr class="separator:ga53cf4f01ab7d712f771cb5fb479d2ba7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf19545bca0101fe4bfe4533cbd03e750"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gaf19545bca0101fe4bfe4533cbd03e750">stp_node_freefunc</a>) (void *)</td></tr>
<tr class="memdesc:gaf19545bca0101fe4bfe4533cbd03e750"><td class="mdescLeft"> </td><td class="mdescRight">A callback function to free the data a node contains. <a href="#gaf19545bca0101fe4bfe4533cbd03e750">More...</a><br /></td></tr>
<tr class="separator:gaf19545bca0101fe4bfe4533cbd03e750"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacc52db9cbfb5090120e0ee8a24c396f2"><td class="memItemLeft" align="right" valign="top">typedef void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gacc52db9cbfb5090120e0ee8a24c396f2">stp_node_copyfunc</a>) (const void *)</td></tr>
<tr class="memdesc:gacc52db9cbfb5090120e0ee8a24c396f2"><td class="mdescLeft"> </td><td class="mdescRight">A callback function to copy the data a node contains. <a href="#gacc52db9cbfb5090120e0ee8a24c396f2">More...</a><br /></td></tr>
<tr class="separator:gacc52db9cbfb5090120e0ee8a24c396f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga278b6a7d80911974bba5fb3db5bd0146"><td class="memItemLeft" align="right" valign="top">typedef const char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga278b6a7d80911974bba5fb3db5bd0146">stp_node_namefunc</a>) (const void *)</td></tr>
<tr class="memdesc:ga278b6a7d80911974bba5fb3db5bd0146"><td class="mdescLeft"> </td><td class="mdescRight">A callback function to get the name of a node. <a href="#ga278b6a7d80911974bba5fb3db5bd0146">More...</a><br /></td></tr>
<tr class="separator:ga278b6a7d80911974bba5fb3db5bd0146"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacef5292212b80a50b7659578d8128c02"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gacef5292212b80a50b7659578d8128c02">stp_node_sortfunc</a>) (const void *, const void *)</td></tr>
<tr class="memdesc:gacef5292212b80a50b7659578d8128c02"><td class="mdescLeft"> </td><td class="mdescRight">A callback function to compare two nodes. <a href="#gacef5292212b80a50b7659578d8128c02">More...</a><br /></td></tr>
<tr class="separator:gacef5292212b80a50b7659578d8128c02"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga55fbb8f7a3920b783b02183c5ea57624"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga55fbb8f7a3920b783b02183c5ea57624">stp_list_node_free_data</a> (void *item)</td></tr>
<tr class="memdesc:ga55fbb8f7a3920b783b02183c5ea57624"><td class="mdescLeft"> </td><td class="mdescRight">Free node data allocated with stp_malloc. <a href="#ga55fbb8f7a3920b783b02183c5ea57624">More...</a><br /></td></tr>
<tr class="separator:ga55fbb8f7a3920b783b02183c5ea57624"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3cfea94cd07f50d7d9b4ce384d349fca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga3cfea94cd07f50d7d9b4ce384d349fca">stp_list_create</a> (void)</td></tr>
<tr class="memdesc:ga3cfea94cd07f50d7d9b4ce384d349fca"><td class="mdescLeft"> </td><td class="mdescRight">Create a new list object. <a href="#ga3cfea94cd07f50d7d9b4ce384d349fca">More...</a><br /></td></tr>
<tr class="separator:ga3cfea94cd07f50d7d9b4ce384d349fca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ba249dd06efbf5c0af8511ceab671e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga0ba249dd06efbf5c0af8511ceab671e8">stp_list_copy</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr>
<tr class="memdesc:ga0ba249dd06efbf5c0af8511ceab671e8"><td class="mdescLeft"> </td><td class="mdescRight">Copy and allocate a list object. <a href="#ga0ba249dd06efbf5c0af8511ceab671e8">More...</a><br /></td></tr>
<tr class="separator:ga0ba249dd06efbf5c0af8511ceab671e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae23ef06175b27dd6772d4d4c098999b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae23ef06175b27dd6772d4d4c098999b1">stp_list_destroy</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr>
<tr class="memdesc:gae23ef06175b27dd6772d4d4c098999b1"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a list object. <a href="#gae23ef06175b27dd6772d4d4c098999b1">More...</a><br /></td></tr>
<tr class="separator:gae23ef06175b27dd6772d4d4c098999b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad185100e8d7969a473e9d42bc8084572"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gad185100e8d7969a473e9d42bc8084572">stp_list_get_start</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr>
<tr class="memdesc:gad185100e8d7969a473e9d42bc8084572"><td class="mdescLeft"> </td><td class="mdescRight">Find the first item in a list. <a href="#gad185100e8d7969a473e9d42bc8084572">More...</a><br /></td></tr>
<tr class="separator:gad185100e8d7969a473e9d42bc8084572"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae939f15ee1a6e4c0aaad7a7be7f40b74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae939f15ee1a6e4c0aaad7a7be7f40b74">stp_list_get_end</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr>
<tr class="memdesc:gae939f15ee1a6e4c0aaad7a7be7f40b74"><td class="mdescLeft"> </td><td class="mdescRight">Find the last item in a list. <a href="#gae939f15ee1a6e4c0aaad7a7be7f40b74">More...</a><br /></td></tr>
<tr class="separator:gae939f15ee1a6e4c0aaad7a7be7f40b74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad377973e8b13d02c9c111d970f491993"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gad377973e8b13d02c9c111d970f491993">stp_list_get_item_by_index</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, int idx)</td></tr>
<tr class="memdesc:gad377973e8b13d02c9c111d970f491993"><td class="mdescLeft"> </td><td class="mdescRight">Find an item in a list by its index. <a href="#gad377973e8b13d02c9c111d970f491993">More...</a><br /></td></tr>
<tr class="separator:gad377973e8b13d02c9c111d970f491993"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga729867c847dd8282f74806968c708f28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga729867c847dd8282f74806968c708f28">stp_list_get_item_by_name</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, const char *name)</td></tr>
<tr class="memdesc:ga729867c847dd8282f74806968c708f28"><td class="mdescLeft"> </td><td class="mdescRight">Find an item in a list by its name. <a href="#ga729867c847dd8282f74806968c708f28">More...</a><br /></td></tr>
<tr class="separator:ga729867c847dd8282f74806968c708f28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacc9140df3f4311cd750ba10a1cbf37d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gacc9140df3f4311cd750ba10a1cbf37d1">stp_list_get_item_by_long_name</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, const char *long_name)</td></tr>
<tr class="memdesc:gacc9140df3f4311cd750ba10a1cbf37d1"><td class="mdescLeft"> </td><td class="mdescRight">Find an item in a list by its long name. <a href="#gacc9140df3f4311cd750ba10a1cbf37d1">More...</a><br /></td></tr>
<tr class="separator:gacc9140df3f4311cd750ba10a1cbf37d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae22741060734c9cbc47656c5ea35c3f3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae22741060734c9cbc47656c5ea35c3f3">stp_list_get_length</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr>
<tr class="memdesc:gae22741060734c9cbc47656c5ea35c3f3"><td class="mdescLeft"> </td><td class="mdescRight">Get the length of a list. <a href="#gae22741060734c9cbc47656c5ea35c3f3">More...</a><br /></td></tr>
<tr class="separator:gae22741060734c9cbc47656c5ea35c3f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae3300d7971c393d119d6fd62e2b578ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae3300d7971c393d119d6fd62e2b578ec">stp_list_set_freefunc</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#gaf19545bca0101fe4bfe4533cbd03e750">stp_node_freefunc</a> freefunc)</td></tr>
<tr class="memdesc:gae3300d7971c393d119d6fd62e2b578ec"><td class="mdescLeft"> </td><td class="mdescRight">Set a list node free function. <a href="#gae3300d7971c393d119d6fd62e2b578ec">More...</a><br /></td></tr>
<tr class="separator:gae3300d7971c393d119d6fd62e2b578ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabfc1ef258084a3e1ad959aa3d2f053f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#gaf19545bca0101fe4bfe4533cbd03e750">stp_node_freefunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gabfc1ef258084a3e1ad959aa3d2f053f4">stp_list_get_freefunc</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr>
<tr class="memdesc:gabfc1ef258084a3e1ad959aa3d2f053f4"><td class="mdescLeft"> </td><td class="mdescRight">Get a list node free function. <a href="#gabfc1ef258084a3e1ad959aa3d2f053f4">More...</a><br /></td></tr>
<tr class="separator:gabfc1ef258084a3e1ad959aa3d2f053f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7e002ed25bbfbad236c1c619841f1ac6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga7e002ed25bbfbad236c1c619841f1ac6">stp_list_set_copyfunc</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#gacc52db9cbfb5090120e0ee8a24c396f2">stp_node_copyfunc</a> copyfunc)</td></tr>
<tr class="memdesc:ga7e002ed25bbfbad236c1c619841f1ac6"><td class="mdescLeft"> </td><td class="mdescRight">Set a list node copy function. <a href="#ga7e002ed25bbfbad236c1c619841f1ac6">More...</a><br /></td></tr>
<tr class="separator:ga7e002ed25bbfbad236c1c619841f1ac6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga686e92ee802147171e5fc723d0079b8d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#gacc52db9cbfb5090120e0ee8a24c396f2">stp_node_copyfunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga686e92ee802147171e5fc723d0079b8d">stp_list_get_copyfunc</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr>
<tr class="memdesc:ga686e92ee802147171e5fc723d0079b8d"><td class="mdescLeft"> </td><td class="mdescRight">Get a list node copy function. <a href="#ga686e92ee802147171e5fc723d0079b8d">More...</a><br /></td></tr>
<tr class="separator:ga686e92ee802147171e5fc723d0079b8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga889af512d87a00d696acc0b6b3fafe78"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga889af512d87a00d696acc0b6b3fafe78">stp_list_set_namefunc</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#ga278b6a7d80911974bba5fb3db5bd0146">stp_node_namefunc</a> namefunc)</td></tr>
<tr class="memdesc:ga889af512d87a00d696acc0b6b3fafe78"><td class="mdescLeft"> </td><td class="mdescRight">Set a list node name function. <a href="#ga889af512d87a00d696acc0b6b3fafe78">More...</a><br /></td></tr>
<tr class="separator:ga889af512d87a00d696acc0b6b3fafe78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga50b1ab3c3b6b0ba7c0cf2128e2024369"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga278b6a7d80911974bba5fb3db5bd0146">stp_node_namefunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga50b1ab3c3b6b0ba7c0cf2128e2024369">stp_list_get_namefunc</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr>
<tr class="memdesc:ga50b1ab3c3b6b0ba7c0cf2128e2024369"><td class="mdescLeft"> </td><td class="mdescRight">Get a list node name function. <a href="#ga50b1ab3c3b6b0ba7c0cf2128e2024369">More...</a><br /></td></tr>
<tr class="separator:ga50b1ab3c3b6b0ba7c0cf2128e2024369"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5be91978431b0ed48ea7919807bdcb73"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga5be91978431b0ed48ea7919807bdcb73">stp_list_set_long_namefunc</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#ga278b6a7d80911974bba5fb3db5bd0146">stp_node_namefunc</a> long_namefunc)</td></tr>
<tr class="memdesc:ga5be91978431b0ed48ea7919807bdcb73"><td class="mdescLeft"> </td><td class="mdescRight">Set a list node long name function. <a href="#ga5be91978431b0ed48ea7919807bdcb73">More...</a><br /></td></tr>
<tr class="separator:ga5be91978431b0ed48ea7919807bdcb73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab99b3ed6da1ea739eed3f2c04fbb7fa7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga278b6a7d80911974bba5fb3db5bd0146">stp_node_namefunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gab99b3ed6da1ea739eed3f2c04fbb7fa7">stp_list_get_long_namefunc</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr>
<tr class="memdesc:gab99b3ed6da1ea739eed3f2c04fbb7fa7"><td class="mdescLeft"> </td><td class="mdescRight">Get a list node long name function. <a href="#gab99b3ed6da1ea739eed3f2c04fbb7fa7">More...</a><br /></td></tr>
<tr class="separator:gab99b3ed6da1ea739eed3f2c04fbb7fa7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab1d2486542b858b44b299cfcdf7d8784"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gab1d2486542b858b44b299cfcdf7d8784">stp_list_set_sortfunc</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#gacef5292212b80a50b7659578d8128c02">stp_node_sortfunc</a> sortfunc)</td></tr>
<tr class="memdesc:gab1d2486542b858b44b299cfcdf7d8784"><td class="mdescLeft"> </td><td class="mdescRight">Set a list node sort function. <a href="#gab1d2486542b858b44b299cfcdf7d8784">More...</a><br /></td></tr>
<tr class="separator:gab1d2486542b858b44b299cfcdf7d8784"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4b32e315d3fd23eabeffcc8d931ea454"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#gacef5292212b80a50b7659578d8128c02">stp_node_sortfunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga4b32e315d3fd23eabeffcc8d931ea454">stp_list_get_sortfunc</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr>
<tr class="memdesc:ga4b32e315d3fd23eabeffcc8d931ea454"><td class="mdescLeft"> </td><td class="mdescRight">Get a list node sort function. <a href="#ga4b32e315d3fd23eabeffcc8d931ea454">More...</a><br /></td></tr>
<tr class="separator:ga4b32e315d3fd23eabeffcc8d931ea454"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae726297a82e140672a018e135ffc6a0e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae726297a82e140672a018e135ffc6a0e">stp_list_item_create</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *next, const void *data)</td></tr>
<tr class="memdesc:gae726297a82e140672a018e135ffc6a0e"><td class="mdescLeft"> </td><td class="mdescRight">Create a new list item. <a href="#gae726297a82e140672a018e135ffc6a0e">More...</a><br /></td></tr>
<tr class="separator:gae726297a82e140672a018e135ffc6a0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5e36d4f61e00cb3e4c4a759f5e7e9f4b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga5e36d4f61e00cb3e4c4a759f5e7e9f4b">stp_list_item_destroy</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *item)</td></tr>
<tr class="memdesc:ga5e36d4f61e00cb3e4c4a759f5e7e9f4b"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a list item. <a href="#ga5e36d4f61e00cb3e4c4a759f5e7e9f4b">More...</a><br /></td></tr>
<tr class="separator:ga5e36d4f61e00cb3e4c4a759f5e7e9f4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabaa2a241055402438a0cae6f40cf6a78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gabaa2a241055402438a0cae6f40cf6a78">stp_list_item_prev</a> (const <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *item)</td></tr>
<tr class="memdesc:gabaa2a241055402438a0cae6f40cf6a78"><td class="mdescLeft"> </td><td class="mdescRight">Get the previous item in the list. <a href="#gabaa2a241055402438a0cae6f40cf6a78">More...</a><br /></td></tr>
<tr class="separator:gabaa2a241055402438a0cae6f40cf6a78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga81ab310caf6432ce1e492eaafdb6c0d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga81ab310caf6432ce1e492eaafdb6c0d7">stp_list_item_next</a> (const <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *item)</td></tr>
<tr class="memdesc:ga81ab310caf6432ce1e492eaafdb6c0d7"><td class="mdescLeft"> </td><td class="mdescRight">Get the next item in the list. <a href="#ga81ab310caf6432ce1e492eaafdb6c0d7">More...</a><br /></td></tr>
<tr class="separator:ga81ab310caf6432ce1e492eaafdb6c0d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad6f6b303b40fa75f22a86391785178cb"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gad6f6b303b40fa75f22a86391785178cb">stp_list_item_get_data</a> (const <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *item)</td></tr>
<tr class="memdesc:gad6f6b303b40fa75f22a86391785178cb"><td class="mdescLeft"> </td><td class="mdescRight">Get the data associated with a list item. <a href="#gad6f6b303b40fa75f22a86391785178cb">More...</a><br /></td></tr>
<tr class="separator:gad6f6b303b40fa75f22a86391785178cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac1e34edcd47ffdc119cdcaf5ad38e1c4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gac1e34edcd47ffdc119cdcaf5ad38e1c4">stp_list_item_set_data</a> (<a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *item, void *data)</td></tr>
<tr class="memdesc:gac1e34edcd47ffdc119cdcaf5ad38e1c4"><td class="mdescLeft"> </td><td class="mdescRight">Set the data associated with a list item. <a href="#gac1e34edcd47ffdc119cdcaf5ad38e1c4">More...</a><br /></td></tr>
<tr class="separator:gac1e34edcd47ffdc119cdcaf5ad38e1c4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The list data type implements a fast generic doubly-linked list. </p>
<p>It supports all of the operations you might want in a list (insert, remove, iterate over the list, copy whole lists), plus some (optional) less common features: finding items by index, name or long name, and sorting. These should also be fairly fast, due to caching in the list head. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga67b4fafe1ab6ead5be7500f88874bdb0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct stp_list_item <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The list item opaque data type. </p>
<p>This object is a node in the list. </p>
</div>
</div>
<a class="anchor" id="ga53cf4f01ab7d712f771cb5fb479d2ba7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct stp_list <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The list opaque data type. </p>
<p>This object represents the list as a whole. </p>
</div>
</div>
<a class="anchor" id="gacc52db9cbfb5090120e0ee8a24c396f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void*(* stp_node_copyfunc) (const void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A callback function to copy the data a node contains. </p>
<p>The parameter is a pointer to the node data. The return value is a pointer to the new copy of the data. </p>
</div>
</div>
<a class="anchor" id="gaf19545bca0101fe4bfe4533cbd03e750"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* stp_node_freefunc) (void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A callback function to free the data a node contains. </p>
<p>The parameter is a pointer to the node data. </p>
</div>
</div>
<a class="anchor" id="ga278b6a7d80911974bba5fb3db5bd0146"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef const char*(* stp_node_namefunc) (const void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A callback function to get the name of a node. </p>
<p>The parameter is a pointer to the node data. The return value is a pointer to the name of the node, or NULL if there is no name. </p>
</div>
</div>
<a class="anchor" id="gacef5292212b80a50b7659578d8128c02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* stp_node_sortfunc) (const void *, const void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A callback function to compare two nodes. </p>
<p>The two parameters are pointers to node data. The return value is <0 if the first sorts before the second, 0 if they sort identically, and >0 if the first sorts after the second. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga0ba249dd06efbf5c0af8511ceab671e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a>* stp_list_copy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy and allocate a list object. </p>
<p>list must be a valid list object previously created with <a class="el" href="group__list.html#ga3cfea94cd07f50d7d9b4ce384d349fca" title="Create a new list object. ">stp_list_create()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to copy. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the new copy of the list. </dd></dl>
</div>
</div>
<a class="anchor" id="ga3cfea94cd07f50d7d9b4ce384d349fca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a>* stp_list_create </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new list object. </p>
<dl class="section return"><dt>Returns</dt><dd>the newly created list object. </dd></dl>
</div>
</div>
<a class="anchor" id="gae23ef06175b27dd6772d4d4c098999b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_list_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a list object. </p>
<p>It is an error to destroy the list more than once. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to destroy. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ga686e92ee802147171e5fc723d0079b8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#gacc52db9cbfb5090120e0ee8a24c396f2">stp_node_copyfunc</a> stp_list_get_copyfunc </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list node copy function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the function previously set with stp_list_set_copyfunc, or NULL if no function has been set. </dd></dl>
</div>
</div>
<a class="anchor" id="gae939f15ee1a6e4c0aaad7a7be7f40b74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a>* stp_list_get_end </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the last item in a list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the last list item, or NULL if the list is empty. </dd></dl>
</div>
</div>
<a class="anchor" id="gabfc1ef258084a3e1ad959aa3d2f053f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#gaf19545bca0101fe4bfe4533cbd03e750">stp_node_freefunc</a> stp_list_get_freefunc </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list node free function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the function previously set with stp_list_set_freefunc, or NULL if no function has been set. </dd></dl>
</div>
</div>
<a class="anchor" id="gad377973e8b13d02c9c111d970f491993"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a>* stp_list_get_item_by_index </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>idx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find an item in a list by its index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
<tr><td class="paramname">idx</td><td>the index to find. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the list item, or NULL if the index is invalid or the list is empty. </dd></dl>
</div>
</div>
<a class="anchor" id="gacc9140df3f4311cd750ba10a1cbf37d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a>* stp_list_get_item_by_long_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>long_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find an item in a list by its long name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
<tr><td class="paramname">long_name</td><td>the long name to find. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the list item, or NULL if the long name is invalid or the list is empty. </dd></dl>
</div>
</div>
<a class="anchor" id="ga729867c847dd8282f74806968c708f28"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a>* stp_list_get_item_by_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find an item in a list by its name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
<tr><td class="paramname">name</td><td>the name to find. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the list item, or NULL if the name is invalid or the list is empty. </dd></dl>
</div>
</div>
<a class="anchor" id="gae22741060734c9cbc47656c5ea35c3f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_list_get_length </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the length of a list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the list length (number of list items). </dd></dl>
</div>
</div>
<a class="anchor" id="gab99b3ed6da1ea739eed3f2c04fbb7fa7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga278b6a7d80911974bba5fb3db5bd0146">stp_node_namefunc</a> stp_list_get_long_namefunc </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list node long name function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the function previously set with stp_list_set_long_namefunc, or NULL if no function has been set. </dd></dl>
</div>
</div>
<a class="anchor" id="ga50b1ab3c3b6b0ba7c0cf2128e2024369"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga278b6a7d80911974bba5fb3db5bd0146">stp_node_namefunc</a> stp_list_get_namefunc </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list node name function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the function previously set with stp_list_set_namefunc, or NULL if no function has been set. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4b32e315d3fd23eabeffcc8d931ea454"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#gacef5292212b80a50b7659578d8128c02">stp_node_sortfunc</a> stp_list_get_sortfunc </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list node sort function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the function previously set with stp_list_set_sortfunc, or NULL if no function has been set. </dd></dl>
</div>
</div>
<a class="anchor" id="gad185100e8d7969a473e9d42bc8084572"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a>* stp_list_get_start </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the first item in a list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the first list item, or NULL if the list is empty. </dd></dl>
</div>
</div>
<a class="anchor" id="gae726297a82e140672a018e135ffc6a0e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_list_item_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td>
<td class="paramname"><em>next</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new list item. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
<tr><td class="paramname">next</td><td>the next item in the list, or NULL to insert at the end of the list. </td></tr>
<tr><td class="paramname">data</td><td>the data the list item will contain. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure (if data is NULL, for example). </dd></dl>
</div>
</div>
<a class="anchor" id="ga5e36d4f61e00cb3e4c4a759f5e7e9f4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_list_item_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td>
<td class="paramname"><em>item</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a list item. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
<tr><td class="paramname">item</td><td>the item to destroy. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="gad6f6b303b40fa75f22a86391785178cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* stp_list_item_get_data </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the data associated with a list item. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>the list item to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the data associated with item. </dd></dl>
</div>
</div>
<a class="anchor" id="ga81ab310caf6432ce1e492eaafdb6c0d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a>* stp_list_item_next </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the next item in the list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>the item to start from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the list item following from item, or NULL if item is the end of the list. </dd></dl>
</div>
</div>
<a class="anchor" id="gabaa2a241055402438a0cae6f40cf6a78"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a>* stp_list_item_prev </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the previous item in the list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>the item to start from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the list item prior to item, or NULL if item is the start of the list. </dd></dl>
</div>
</div>
<a class="anchor" id="gac1e34edcd47ffdc119cdcaf5ad38e1c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_list_item_set_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td>
<td class="paramname"><em>item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the data associated with a list item. </p>
<dl class="section warning"><dt>Warning</dt><dd>Note that if a sortfunc is in use, changing the data will NOT re-sort the list! </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>the list item to use. </td></tr>
<tr><td class="paramname">data</td><td>the data to set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure (if data is NULL). </dd></dl>
</div>
</div>
<a class="anchor" id="ga55fbb8f7a3920b783b02183c5ea57624"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_list_node_free_data </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free node data allocated with stp_malloc. </p>
<p>This function is indended for use as an stp_node_freefunc, which uses stp_free to free the node data. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>the node data to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga7e002ed25bbfbad236c1c619841f1ac6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_list_set_copyfunc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__list.html#gacc52db9cbfb5090120e0ee8a24c396f2">stp_node_copyfunc</a> </td>
<td class="paramname"><em>copyfunc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a list node copy function. </p>
<p>This callback function will be called whenever a list item is copied. Its intended use is for automatic object copying (since C lacks a copy constructor). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
<tr><td class="paramname">copyfunc</td><td>the function to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae3300d7971c393d119d6fd62e2b578ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_list_set_freefunc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__list.html#gaf19545bca0101fe4bfe4533cbd03e750">stp_node_freefunc</a> </td>
<td class="paramname"><em>freefunc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a list node free function. </p>
<p>This callback function will be called whenever a list item is destroyed. Its intended use is for automatic object destruction and any other cleanup required. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
<tr><td class="paramname">freefunc</td><td>the function to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga5be91978431b0ed48ea7919807bdcb73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_list_set_long_namefunc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__list.html#ga278b6a7d80911974bba5fb3db5bd0146">stp_node_namefunc</a> </td>
<td class="paramname"><em>long_namefunc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a list node long name function. </p>
<p>This callback function will be called whenever the long name of a list item needs to be determined. This is used to find list items by long name. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
<tr><td class="paramname">long_namefunc</td><td>the function to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga889af512d87a00d696acc0b6b3fafe78"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_list_set_namefunc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__list.html#ga278b6a7d80911974bba5fb3db5bd0146">stp_node_namefunc</a> </td>
<td class="paramname"><em>namefunc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a list node name function. </p>
<p>This callback function will be called whenever the name of a list item needs to be determined. This is used to find list items by name. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
<tr><td class="paramname">namefunc</td><td>the function to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab1d2486542b858b44b299cfcdf7d8784"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_list_set_sortfunc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__list.html#gacef5292212b80a50b7659578d8128c02">stp_node_sortfunc</a> </td>
<td class="paramname"><em>sortfunc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a list node sort function. </p>
<p>This callback function will be called to determine the sort order for list items in sorted lists. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>the list to use. </td></tr>
<tr><td class="paramname">sortfunc</td><td>the function to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|