/usr/share/gtk-doc/html/libinfinity-0.6/InfAdoptedRequestLog.html is in libinfinity-0.6-doc 0.6.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfAdoptedRequestLog: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch03.html" title="Libinfinity's adOPTed implementation">
<link rel="prev" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm">
<link rel="next" href="InfAdoptedRequest.html" title="InfAdoptedRequest">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#InfAdoptedRequestLog.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfAdoptedRequestLog.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfAdoptedRequestLog.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfAdoptedRequestLog.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfAdoptedAlgorithm.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfAdoptedRequest.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfAdoptedRequestLog"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfAdoptedRequestLog.top_of_page"></a>InfAdoptedRequestLog</span></h2>
<p>InfAdoptedRequestLog — History of requests</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="returnvalue">InfAdoptedRequestLog</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-new" title="inf_adopted_request_log_new ()">inf_adopted_request_log_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-user-id" title="inf_adopted_request_log_get_user_id ()">inf_adopted_request_log_get_user_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-begin" title="inf_adopted_request_log_get_begin ()">inf_adopted_request_log_get_begin</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-end" title="inf_adopted_request_log_get_end ()">inf_adopted_request_log_get_end</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-is-empty" title="inf_adopted_request_log_is_empty ()">inf_adopted_request_log_is_empty</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-set-begin" title="inf_adopted_request_log_set_begin ()">inf_adopted_request_log_set_begin</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-request" title="inf_adopted_request_log_get_request ()">inf_adopted_request_log_get_request</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-add-request" title="inf_adopted_request_log_add_request ()">inf_adopted_request_log_add_request</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-remove-requests" title="inf_adopted_request_log_remove_requests ()">inf_adopted_request_log_remove_requests</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-next-associated" title="inf_adopted_request_log_next_associated ()">inf_adopted_request_log_next_associated</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-prev-associated" title="inf_adopted_request_log_prev_associated ()">inf_adopted_request_log_prev_associated</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-original-request" title="inf_adopted_request_log_original_request ()">inf_adopted_request_log_original_request</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-next-undo" title="inf_adopted_request_log_next_undo ()">inf_adopted_request_log_next_undo</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-next-redo" title="inf_adopted_request_log_next_redo ()">inf_adopted_request_log_next_redo</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-upper-related" title="inf_adopted_request_log_upper_related ()">inf_adopted_request_log_upper_related</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-lower-related" title="inf_adopted_request_log_lower_related ()">inf_adopted_request_log_lower_related</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-add-cached-request" title="inf_adopted_request_log_add_cached_request ()">inf_adopted_request_log_add_cached_request</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-lookup-cached-request" title="inf_adopted_request_log_lookup_cached_request ()">inf_adopted_request_log_lookup_cached_request</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="InfAdoptedRequestLog.html#InfAdoptedRequestLog--begin" title="The “begin” property">begin</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="InfAdoptedRequestLog.html#InfAdoptedRequestLog--end" title="The “end” property">end</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *</td>
<td class="property_name"><a class="link" href="InfAdoptedRequestLog.html#InfAdoptedRequestLog--next-redo" title="The “next-redo” property">next-redo</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *</td>
<td class="property_name"><a class="link" href="InfAdoptedRequestLog.html#InfAdoptedRequestLog--next-undo" title="The “next-undo” property">next-undo</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="InfAdoptedRequestLog.html#InfAdoptedRequestLog--user-id" title="The “user-id” property">user-id</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfAdoptedRequestLog.html#InfAdoptedRequestLog-add-request" title="The “add-request” signal">add-request</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfAdoptedRequestLog.html#InfAdoptedRequestLog-struct" title="struct InfAdoptedRequestLog">InfAdoptedRequestLog</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfAdoptedRequestLog.html#InfAdoptedRequestLogClass" title="struct InfAdoptedRequestLogClass">InfAdoptedRequestLogClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> InfAdoptedRequestLog
</pre>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/adopted/inf-adopted-request-log.h>
</pre>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.description"></a><h2>Description</h2>
<p><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> stores all requests by a particular user. These need
to be looked up by <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> to perform transformations of
older requests to the current state. It also adds relations between the
requests so that is easy to find the request that an Undo request undoes,
or the Undo request undoing a given request, if available.</p>
<p>When requests are no longer needed, then they can also be removed again
from the log, however requests can only be removed so that remaining Undo
or Redo requests do not refer to some request that is about to be removed.</p>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-adopted-request-log-new"></a><h3>inf_adopted_request_log_new ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="returnvalue">InfAdoptedRequestLog</span></a> *
inf_adopted_request_log_new (<em class="parameter"><code><span class="type">guint</span> user_id</code></em>);</pre>
<p>Creates a new <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> for the user with the given ID.</p>
<div class="refsect3">
<a name="id-1.4.7.11.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>user_id</p></td>
<td class="parameter_description"><p>The ID of the <a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> to create a request log for. The
request log only contains requests of that particular user.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.2.6"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-get-user-id"></a><h3>inf_adopted_request_log_get_user_id ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
inf_adopted_request_log_get_user_id (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>);</pre>
<p>Returns the ID of the user whose requests <em class="parameter"><code>log</code></em>
contains.</p>
<div class="refsect3">
<a name="id-1.4.7.11.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.3.6"></a><h4>Returns</h4>
<p> The log's user ID.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-get-begin"></a><h3>inf_adopted_request_log_get_begin ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
inf_adopted_request_log_get_begin (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>);</pre>
<p>Returns the first index (i.e. the index of the oldest request) in the log.</p>
<div class="refsect3">
<a name="id-1.4.7.11.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.4.6"></a><h4>Returns</h4>
<p> The first index in the log.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-get-end"></a><h3>inf_adopted_request_log_get_end ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
inf_adopted_request_log_get_end (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>);</pre>
<p>Returns the index a newly inserted request would have (i.e. one past the
index of the newest request in the log). This ensures that
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-end" title="inf_adopted_request_log_get_end ()"><code class="function">inf_adopted_request_log_get_end()</code></a> - <a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-begin" title="inf_adopted_request_log_get_begin ()"><code class="function">inf_adopted_request_log_get_begin()</code></a>
reveals the number of requests in the log.</p>
<div class="refsect3">
<a name="id-1.4.7.11.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.5.6"></a><h4>Returns</h4>
<p> The index of the next request in the log.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-is-empty"></a><h3>inf_adopted_request_log_is_empty ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_adopted_request_log_is_empty (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>);</pre>
<p>Returns whether <em class="parameter"><code>log</code></em>
is empty. A log is empty if it does not contain any
requsets.</p>
<div class="refsect3">
<a name="id-1.4.7.11.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.6.6"></a><h4>Returns</h4>
<p> Whether <em class="parameter"><code>log</code></em>
is empty.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-set-begin"></a><h3>inf_adopted_request_log_set_begin ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_request_log_set_begin (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><span class="type">guint</span> n</code></em>);</pre>
<p>This function sets the index of the first log that will be added to <em class="parameter"><code>log</code></em>
.
For a new request log, this is set to 0. If you intend to insert a request
sequence into <em class="parameter"><code>log</code></em>
that does not start with 0, then you can call this
function with the desired start index, so that
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-begin" title="inf_adopted_request_log_get_begin ()"><code class="function">inf_adopted_request_log_get_begin()</code></a> and <a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-end" title="inf_adopted_request_log_get_end ()"><code class="function">inf_adopted_request_log_get_end()</code></a>
return the correct value.</p>
<p>If you don't need <a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-begin" title="inf_adopted_request_log_get_begin ()"><code class="function">inf_adopted_request_log_get_begin()</code></a> or
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-end" title="inf_adopted_request_log_get_end ()"><code class="function">inf_adopted_request_log_get_end()</code></a> before adding the first request to the
log, then you don't need to call this function, since
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-add-request" title="inf_adopted_request_log_add_request ()"><code class="function">inf_adopted_request_log_add_request()</code></a> will do it implicitely based on the
request's vector time component for the request log's user.</p>
<p>This function can only be called if the request log is empty, see
<a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-is-empty" title="inf_adopted_request_log_is_empty ()"><code class="function">inf_adopted_request_log_is_empty()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.7.11.7.7"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>The index of the first request to be added to the log.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-get-request"></a><h3>inf_adopted_request_log_get_request ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
inf_adopted_request_log_get_request (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><span class="type">guint</span> n</code></em>);</pre>
<p>Returns the request with the given index. Such a request must exist in
<em class="parameter"><code>log</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.7.11.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>The index of a request contained in <em class="parameter"><code>log</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.8.6"></a><h4>Returns</h4>
<p> A <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a>. The request is owned by the request
log, you do not need to free it.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-add-request"></a><h3>inf_adopted_request_log_add_request ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_request_log_add_request (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *request</code></em>);</pre>
<p>Inserts <em class="parameter"><code>request</code></em>
into <em class="parameter"><code>log</code></em>
. The component represented by the log's user
of the request's state vector must match the end index of <em class="parameter"><code>log</code></em>
if <em class="parameter"><code>log</code></em>
is not empty. Also, the user that issued <em class="parameter"><code>request</code></em>
must be the same user as
the one this request log belongs to.</p>
<div class="refsect3">
<a name="id-1.4.7.11.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>request</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-remove-requests"></a><h3>inf_adopted_request_log_remove_requests ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_request_log_remove_requests
(<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><span class="type">guint</span> up_to</code></em>);</pre>
<p>Removes all requests with index lower than <em class="parameter"><code>up_to</code></em>
. This function only works
if the request before <em class="parameter"><code>up_to</code></em>
is an "upper related" request.
See <a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-upper-related" title="inf_adopted_request_log_upper_related ()"><code class="function">inf_adopted_request_log_upper_related()</code></a>. This condition guarantees
that remaining requests do not refer to removed ones.</p>
<div class="refsect3">
<a name="id-1.4.7.11.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>up_to</p></td>
<td class="parameter_description"><p>The index of the first request not to remove.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-next-associated"></a><h3>inf_adopted_request_log_next_associated ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
inf_adopted_request_log_next_associated
(<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *request</code></em>);</pre>
<p>If <em class="parameter"><code>request</code></em>
is of type <a class="link" href="InfAdoptedRequest.html#INF-ADOPTED-REQUEST-DO:CAPS"><code class="literal">INF_ADOPTED_REQUEST_DO</code></a> or
<a class="link" href="InfAdoptedRequest.html#INF-ADOPTED-REQUEST-REDO:CAPS"><code class="literal">INF_ADOPTED_REQUEST_REDO</code></a>, this returns UNDO request that undoes this
request, if any. If <em class="parameter"><code>request</code></em>
is a <code class="literal">INF_ADOPTED_REQUEST</code> UNDO request, this
returns a request that redoes <em class="parameter"><code>request</code></em>
, if any.</p>
<div class="refsect3">
<a name="id-1.4.7.11.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>request</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> contained in <em class="parameter"><code>log</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.11.6"></a><h4>Returns</h4>
<p> The next associated request of <em class="parameter"><code>request</code></em>
, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-prev-associated"></a><h3>inf_adopted_request_log_prev_associated ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
inf_adopted_request_log_prev_associated
(<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *request</code></em>);</pre>
<p>If <em class="parameter"><code>request</code></em>
is of type <a class="link" href="InfAdoptedRequest.html#INF-ADOPTED-REQUEST-REDO:CAPS"><code class="literal">INF_ADOPTED_REQUEST_REDO</code></a> or, this returns the UNDO
request that is redone by <em class="parameter"><code>request</code></em>
, if <em class="parameter"><code>request</code></em>
is a
<a class="link" href="InfAdoptedRequest.html#INF-ADOPTED-REQUEST-UNDO:CAPS"><code class="literal">INF_ADOPTED_REQUEST_UNDO</code></a> request, this returns the request that is undone
by <em class="parameter"><code>request</code></em>
.</p>
<p><em class="parameter"><code>request</code></em>
must either be contained in <em class="parameter"><code>log</code></em>
or the vector time component
of its own user must be equivalent to <a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-end" title="inf_adopted_request_log_get_end ()"><code class="function">inf_adopted_request_log_get_end()</code></a>,
in which case <em class="parameter"><code>request</code></em>
is treated as it if was the newest request in <em class="parameter"><code>log</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.7.11.12.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>request</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.12.7"></a><h4>Returns</h4>
<p> The previous associated request of <em class="parameter"><code>request</code></em>
, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-original-request"></a><h3>inf_adopted_request_log_original_request ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
inf_adopted_request_log_original_request
(<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *request</code></em>);</pre>
<p>Returns the most previous associated request for <em class="parameter"><code>request</code></em>
, that is,
the <a class="link" href="InfAdoptedRequest.html#INF-ADOPTED-REQUEST-DO:CAPS"><code class="literal">INF_ADOPTED_REQUEST_DO</code></a> request that <em class="parameter"><code>request</code></em>
undoes or redoes,
respectively. If <em class="parameter"><code>request</code></em>
itself is a <a class="link" href="InfAdoptedRequest.html#INF-ADOPTED-REQUEST-DO:CAPS"><code class="literal">INF_ADOPTED_REQUEST_DO</code></a> request,
<em class="parameter"><code>request</code></em>
itself is returned.</p>
<p><em class="parameter"><code>request</code></em>
must either be contained in <em class="parameter"><code>log</code></em>
or the vector time component
of its own user must be equivalent to <a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-get-end" title="inf_adopted_request_log_get_end ()"><code class="function">inf_adopted_request_log_get_end()</code></a>,
in which case <em class="parameter"><code>request</code></em>
is treated as it if was the newest request in <em class="parameter"><code>log</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.7.11.13.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>request</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.13.7"></a><h4>Returns</h4>
<p> The original request of <em class="parameter"><code>request</code></em>
. This function never
returns <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-next-undo"></a><h3>inf_adopted_request_log_next_undo ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
inf_adopted_request_log_next_undo (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>);</pre>
<p>Returns the request that would be undone if a undo request was added to
the request log.</p>
<div class="refsect3">
<a name="id-1.4.7.11.14.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.14.6"></a><h4>Returns</h4>
<p> The next request to be undone, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-next-redo"></a><h3>inf_adopted_request_log_next_redo ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
inf_adopted_request_log_next_redo (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>);</pre>
<p>Returns the request that would be redone if a redo request was added to
the request log.</p>
<div class="refsect3">
<a name="id-1.4.7.11.15.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.15.6"></a><h4>Returns</h4>
<p> The next request to be redone, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-upper-related"></a><h3>inf_adopted_request_log_upper_related ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
inf_adopted_request_log_upper_related (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><span class="type">guint</span> n</code></em>);</pre>
<p>Returns the newest request in <em class="parameter"><code>log</code></em>
that is related to <em class="parameter"><code>n</code></em>
th request
in log. Requests are considered related when they are enclosed by a
do/undo, an undo/redo or a redo/undo pair.</p>
<p>Note that the sets of related requests within a request log are
disjoint.</p>
<div class="refsect3">
<a name="id-1.4.7.11.16.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>Index of a request in <em class="parameter"><code>log</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.16.7"></a><h4>Returns</h4>
<p> The newest request in <em class="parameter"><code>log</code></em>
being related to the <em class="parameter"><code>n</code></em>
th
request.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-lower-related"></a><h3>inf_adopted_request_log_lower_related ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
inf_adopted_request_log_lower_related (<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><span class="type">guint</span> n</code></em>);</pre>
<p>Returns the oldest request in <em class="parameter"><code>log</code></em>
that is related to <em class="parameter"><code>n</code></em>
th request
in log. Requests are considered related when they are enclosed by a
do/undo, an undo/redo or a redo/undo pair.</p>
<p>Note that the sets of related requests within a request log are
disjoint.</p>
<div class="refsect3">
<a name="id-1.4.7.11.17.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>Index of a request in <em class="parameter"><code>log</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.17.7"></a><h4>Returns</h4>
<p> The oldest request in <em class="parameter"><code>log</code></em>
being related to the <em class="parameter"><code>n</code></em>
th
request.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-add-cached-request"></a><h3>inf_adopted_request_log_add_cached_request ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_request_log_add_cached_request
(<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *request</code></em>);</pre>
<p><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> has a cache for translated requests built in. This
can be used to store requests that have been translated to another point
in the state space, and to efficiently look them up later. The advantage
of having this functionality within <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> is that when
requests are removed from the log the cache is automatically updated
accordingly.</p>
<p>The data structure of the cache is optimized for quick lookup of entries
by the state vector and cleaning up entries in an efficient manner also
when the cache has grown very big.</p>
<p>The request cache is mainly used by <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> to efficiently
handle big transformations.</p>
<p>This function adds a request to the cache of the request log.
<em class="parameter"><code>request</code></em>
must be a translated version of a request existing in <em class="parameter"><code>log</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.7.11.18.8"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>request</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> to add to the cache.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-request-log-lookup-cached-request"></a><h3>inf_adopted_request_log_lookup_cached_request ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="returnvalue">InfAdoptedRequest</span></a> *
inf_adopted_request_log_lookup_cached_request
(<em class="parameter"><code><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *log</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector"><span class="type">InfAdoptedStateVector</span></a> *vec</code></em>);</pre>
<p>Looks up the request at <em class="parameter"><code>vec</code></em>
from the cache of the request log. If the
queried request does not exist in the cache, the function returns <code class="literal">NULL</code>.</p>
<p>See <a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-add-cached-request" title="inf_adopted_request_log_add_cached_request ()"><code class="function">inf_adopted_request_log_add_cached_request()</code></a> for an explanation of
the request cache.</p>
<div class="refsect3">
<a name="id-1.4.7.11.19.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>vec</p></td>
<td class="parameter_description"><p>The state vector at which to look up the request.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.7.11.19.7"></a><h4>Returns</h4>
<p> The cached <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> according to <em class="parameter"><code>vec</code></em>
, or <code class="literal">NULL</code>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfAdoptedRequestLog-struct"></a><h3>struct InfAdoptedRequestLog</h3>
<pre class="programlisting">struct InfAdoptedRequestLog;</pre>
<p><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> is an opaque data type. You should only access it via
the public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedRequestLogClass"></a><h3>struct InfAdoptedRequestLogClass</h3>
<pre class="programlisting">struct InfAdoptedRequestLogClass {
void(*add_request)(InfAdoptedRequestLog* request_log,
InfAdoptedRequest* request);
};
</pre>
<p>This structure contains the default signal handlers for
<a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p>
<div class="refsect3">
<a name="id-1.4.7.12.3.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfAdoptedRequestLogClass.add-request"></a>add_request</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfAdoptedRequestLog.html#InfAdoptedRequestLog-add-request" title="The “add-request” signal"><span class="type">“add-request”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfAdoptedRequestLog--begin"></a><h3>The <code class="literal">“begin”</code> property</h3>
<pre class="programlisting"> “begin” <span class="type">guint</span></pre>
<p>The first index contained in the log.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedRequestLog--end"></a><h3>The <code class="literal">“end”</code> property</h3>
<pre class="programlisting"> “end” <span class="type">guint</span></pre>
<p>The index of the next request that is inserted into the log.</p>
<p>Flags: Read</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedRequestLog--next-redo"></a><h3>The <code class="literal">“next-redo”</code> property</h3>
<pre class="programlisting"> “next-redo” <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *</pre>
<p>The request that is redone when the user issues a redo request new.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedRequestLog--next-undo"></a><h3>The <code class="literal">“next-undo”</code> property</h3>
<pre class="programlisting"> “next-undo” <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *</pre>
<p>The request that is undone when the user issues an undo request now.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedRequestLog--user-id"></a><h3>The <code class="literal">“user-id”</code> property</h3>
<pre class="programlisting"> “user-id” <span class="type">guint</span></pre>
<p>The ID of the user whose requests the log contains.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfAdoptedRequestLog-add-request"></a><h3>The <code class="literal">“add-request”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *request_log,
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *request,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted whenever a new request is added to the request log
via <a class="link" href="InfAdoptedRequestLog.html#inf-adopted-request-log-add-request" title="inf_adopted_request_log_add_request ()"><code class="function">inf_adopted_request_log_add_request()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.7.14.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>request_log</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> to which a new request is added.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>request</p></td>
<td class="parameter_description"><p>The new request being added.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedRequestLog.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a>, <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|