1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
|
<?xml version="1.0" encoding="utf-8"?>
<fpdoc-descriptions>
<package name="LazDebuggerIntf">
<!--
====================================================================
LazDebuggerIntf
====================================================================
-->
<module name="LazDebuggerIntf">
<short/>
<descr/>
<!-- uses unit Visibility: default -->
<!-- uses unit Visibility: default -->
<!-- uses unit Visibility: default -->
<!-- uses unit Visibility: default -->
<!-- uses unit Visibility: default -->
<!-- alias type Visibility: default -->
<!-- interface Visibility: default -->
<element name="TInternalDbgMonitorIntfType">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- interface Visibility: default -->
<element name="TInternalDbgSupplierIntfType">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- generic type Visibility: default -->
<element name="TInternalDbgMonitorIntf._SUPPLIER_INTF">
<short/>
<descr/>
<seealso/>
</element>
<!-- interface Visibility: default -->
<element name="TInternalDbgMonitorIntf">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TInternalDbgMonitorIntf.GetSupplier">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TInternalDbgMonitorIntf.SetSupplier">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TInternalDbgMonitorIntf.DoStateChange">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TInternalDbgMonitorIntf.Supplier">
<short/>
<descr/>
<seealso/>
</element>
<!-- generic type Visibility: default -->
<element name="TInternalDbgSupplierIntf._MONITOR_INTF">
<short/>
<descr/>
<seealso/>
</element>
<!-- interface Visibility: default -->
<element name="TInternalDbgSupplierIntf">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TInternalDbgSupplierIntf.SetMonitor">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TInternalDbgSupplierIntf.DoStateChange">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TDebuggerDataState">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TDebuggerDataState.ddsUnknown">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TDebuggerDataState.ddsRequested">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TDebuggerDataState.ddsEvaluating">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TDebuggerDataState.ddsValid">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TDebuggerDataState.ddsInvalid">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TDebuggerDataState.ddsError">
<short/>
</element>
<!-- interface Visibility: default -->
<element name="TDbgDataRequestIntf">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TDbgDataRequestIntf.AddFreeNotification">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TDbgDataRequestIntf.RemoveFreeNotification">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TWatchDisplayFormat">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfDefault">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfStructure">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfChar">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfString">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfDecimal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfUnsigned">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfFloat">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfHex">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfPointer">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfMemDump">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatchDisplayFormat.wdfBinary">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TWatcheEvaluateFlag">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatcheEvaluateFlag.defClassAutoCast">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatcheEvaluateFlag.defAllowFunctionCall">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatcheEvaluateFlag.defExtraDepth">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatcheEvaluateFlag.defSkipValConv">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatcheEvaluateFlag.defNoTypeInfo">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatcheEvaluateFlag.defSimpleTypeInfo">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatcheEvaluateFlag.defFullTypeInfo">
<short/>
</element>
<!-- set type Visibility: default -->
<element name="TWatcheEvaluateFlags">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TWatcheEvaluateEvent">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWatcheEvaluateEvent.weeCancel">
<short/>
</element>
<!-- class Visibility: default -->
<!-- alias type Visibility: default -->
<element name="TLzDbgToken">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TLzDbgFloatPrecission">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFloatPrecission.dfpSingle">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFloatPrecission.dfpDouble">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFloatPrecission.dfpExtended">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TLzDbgStructType">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgStructType.dstUnknown">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgStructType.dstRecord">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgStructType.dstObject">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgStructType.dstClass">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgStructType.dstInterface">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgStructType.dstInternal">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TLzDbgArrayType">
<short>Enumeration of array types</short>
<descr>
<p>Select the type of array when creating an array result value with
<link id="TLzDbgWatchDataIntf.CreateArrayValue">TLzDbgWatchDataIntf.CreateArrayValue</link>.
</p>
<p>
<u>Each type also has some different properties:</u>
</p>
<ul>
<li>
<p>
<b>Dynamic Array</b>
</p>
<ol>
<li>Does <b>not </b>have a <var>LowBound</var>, LowBound is always zero</li>
<li>
<var>Length</var> is part of the data</li>
<li>Does have a <var>DataAddress</var>
</li>
</ol>
<p/>
</li>
<li>
<p>
<b>Static Array</b>
</p>
<ol>
<li>Does have a <var>LowBound</var>. LowBound is part of the type.
</li>
<li>
<var>Length</var> is part of the type</li>
<li>Does <b>not </b>have a <var>DataAddress</var>
</li>
</ol>
<p/>
</li>
<li>
<p>
<b>Unknown Array type</b>
</p>
<ol>
<li>Does have a <var>LowBound</var>, LowBound is part of the data</li>
<li>
<var>Length</var> is part of the data</li>
<li>Does <b>not </b>have a <var>DataAddress</var>
</li>
</ol>
<p/>
</li>
</ul>
<p/>
<p>"part of the data" vs "part of the type": If arrays are nested, then as all nested values, each array that is an element of an outer array must have identical types.<br/>
Like in Pascal, for an <var>array of array [1..3] of </var> the inner arrays all have the same Length and LowBound. But for <var>array of array of </var> the length of the inner array can vary.
</p>
</descr>
<seealso>
<link id="TLzDbgWatchDataIntf.CreateArrayValue">TLzDbgWatchDataIntf.CreateArrayValue</link>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgArrayType.datUnknown">
<short>Unknown array type</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgArrayType.datDynArray">
<short>Dynamic array</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgArrayType.datStatArray">
<short>Static array</short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TLzDbgFieldVisibility">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldVisibility.dfvUnknown">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldVisibility.dfvPrivate">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldVisibility.dfvProtected">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldVisibility.dfvPublic">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldVisibility.dfvPublished">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TLzDbgFieldFlag">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldFlag.dffClass">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldFlag.dffAbstract">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldFlag.dffVirtual">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldFlag.dffOverwritten">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldFlag.dffConstructor">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldFlag.dffDestructor">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLzDbgFieldFlag.dffVariant">
<short/>
</element>
<!-- set type Visibility: default -->
<element name="TLzDbgFieldFlags">
<short/>
<descr/>
<seealso/>
</element>
<!-- interface Visibility: default -->
<element name="TLzDbgWatchDataIntf">
<short>Result data for a Watch</short>
<descr>
<p>This interface is provide by the IDE (Debugger frontend) via
<link id="TWatchValueIntf.ResData">TWatchValueIntf.ResData</link>. The backend must use it to describe the "watch result" to the frontend.
</p>
<p>The IDE can then apply different formatting to the result.
For example, if a watch yields an Int64 result of "24" the backend will call
<var>CreateNumValue(24, True, 8)</var> instead of delivering a pre-formated text result. This way the IDE knows the value, the signedness and the byte-size of the result. This allows the IDE to format the value in Hex, Decimal, Binary without having to make further queries to the backend.
</p>
<p>The interface is designed for use in the Lazarus IDE, and therefore Pascal specific. The methods represent the types as defined in Pascal.<br/>
If the interface does not provide a method for a specific value, then the backend can provide a preformated result using
<var>CreatePrePrinted(text)</var>
</p>
<p>
<p>
<u>Restrictions</u>
</p>
<ul>
<li>The backend must first call one of the <var>Create...</var> methods.
Only after that, can it add further info such as <var>SetTypeName</var>
</li>
<li>Once the backend has created a value, it must not change the result. That is the backend can not create a new different value to overwrite the result. The exception here is CreateError.
If the backend encounters an error while working on a value, it can change the entire result to be an error.</li>
<li>For methods that return an interface for a nested value, the backend must check if nil was returned. The frontend may return nil, if it does not require the information</li>
<li>In an array all elements must be of the same type. That is, each element must be created with the same <var>Create...</var> method. Any parameters affecting the type rather than the value, must be kept the same too. E.g. for a <var>CreateNumValue</var> call only the num-value can change, the signedness and byte-size must be identical for all elements</li>
</ul>
</p>
</descr>
<seealso>
<link id="TWatchValueIntf.ResData">Method providing TLzDbgWatchDataIntf</link>
</seealso>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreatePrePrinted">
<short>Create result as pre-formatted text</short>
<descr>
<p>Create a result for any data, that is pre-formatted by the backend. The IDE will display this as is. The IDE can not change formatting, or any other operation (such as extending nested values).</p>
<ul>
<li>
<p>
<var>AVal: String</var>
</p>
<p>The text to be displayed</p>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateString">
<short>Create result for a string type</short>
<descr>
<ul>
<li>
<p>
<var>AVal: String</var>
</p>
<p>The UTF8 encoded result</p>
</li>
</ul>
<remark>More parameters may still be added</remark>
<p>
<u>Supported methods to add info to a string value:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetTypeName">TLzDbgWatchDataIntf.SetTypeName</link>
</li>
<li>
<link id="TLzDbgWatchDataIntf.SetDataAddress">TLzDbgWatchDataIntf.SetDataAddress</link>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateWideString">
<short>Create result for a widestring</short>
<descr>
<ul>
<li>
<p>
<var>AVal: WideString</var>
</p>
<p>The text</p>
</li>
</ul>
<p>
<u>Supported methods to add info to a widestring value:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetTypeName">TLzDbgWatchDataIntf.SetTypeName</link>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateCharValue">
<short>Create result for Char or WideChar</short>
<descr>
<ul>
<li>
<p>
<var>ACharValue: QWord</var>
</p>
<p>Ordinal value of the char</p>
</li>
<li>
<p>
<var>AByteSize: Integer = 0</var>
</p>
<p>A size of 1 represents a pascal "char". And a size of 2 a widechar. Other values will be printed as "#12345". There is currently no encoding for the type "char". (it is a singel byte char, not utf-8)</p>
</li>
</ul>
<p>
<u>Supported methods to add info to a char value:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetTypeName">TLzDbgWatchDataIntf.SetTypeName</link>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateNumValue">
<short>Create result for an ordinal number</short>
<descr>
<ul>
<li>
<p>
<var>ANumValue: QWord</var>
</p>
<p>The numerical value typecast to QWord. If the value is signed, it should be fully sign extended.</p>
</li>
<li>
<p>
<var>ASigned: Boolean</var>
</p>
<p>Indicate if the value is signed</p>
</li>
<li>
<p>
<var>AByteSize: Integer = 0</var>
</p>
<p>Should be 0,1,2,4 or 8. Zero indicates unknow size.</p>
</li>
</ul>
<p>
<u>Supported methods to add info to a numeric value:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetTypeName">TLzDbgWatchDataIntf.SetTypeName</link>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreatePointerValue">
<short>Create result for a pointer</short>
<descr>
<ul>
<li>
<p>
<var>AnAddrValue: TDbgPtr</var>
</p>
<p>The address stored in the pointer </p>
</li>
</ul>
<p>
<u>Supported methods to add info to a pointer value:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetTypeName">TLzDbgWatchDataIntf.SetTypeName</link>
</li>
<li>
<link id="TLzDbgWatchDataIntf.SetDerefData">TLzDbgWatchDataIntf.SetDerefData</link>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateFloatValue">
<short>Create result for a floating number</short>
<descr>
<ul>
<li>
<p>
<var>ANumValue: QWord</var>
</p>
<p>The numerical value typecast to QWord. If the value is signed, it should be fully sign extended.</p>
</li>
<li>
<p>
<var>ASigned: Boolean</var>
</p>
<p>Indicate if the value is signed</p>
</li>
<li>
<p>
<var>AByteSize: Integer = 0</var>
</p>
<p>Should be 0,1,2,4 or 8. Zero indicates unknow size.</p>
</li>
</ul>
<p>
<u>Supported methods to add info to a numeric value:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetTypeName">TLzDbgWatchDataIntf.SetTypeName</link>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateBoolValue">
<short>Create result for a boolean value</short>
<descr>
<ul>
<li>
<p>
<var>AnOrdBoolValue: QWord</var>
</p>
<p>Ordinal value of the char. This can be any numerical value (within the range of the byte-size) as the value may hold non conform data</p>
</li>
<li>
<p>
<var>AByteSize: Integer = 0</var>
</p>
<p>Size of the underlaying type. In case the IDE is asked to dispaly the numerical value.<br/>
A value of 0 represents an unknown size. This can currently also be used for bitpacked values.</p>
</li>
</ul>
<p>
<u>Supported methods to add info to a char value:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetTypeName">TLzDbgWatchDataIntf.SetTypeName</link>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateEnumValue">
<short>Create result for an enumerated value.</short>
<descr>
<ul>
<li>
<p>
<var>ANumValue: QWord</var>
</p>
<p>The ordinal value of the enum. For example "1" (as result of "ord(alTop)")</p>
</li>
<li>
<p>
<var>AName: String</var>
</p>
<p>The identifier representing the value. For example "alTop"</p>
</li>
<li>
<p>
<var>AByteSize: Integer = 0</var>
</p>
<p>The byte size of the variable.</p>
</li>
<li>
<p>
<var>AnIsEnumIdent: Boolean = False</var>
</p>
<ul>
<li>
<p>False: The value was read from a variable (or constant) of an enum type. E.g.: Form1.FAlign</p>
</li>
<li>
<p>True: The value was the identifier representing that enum value. E.g., the watch actually contained the term: "alTop"</p>
</li>
</ul>
</li>
</ul>
<p>
<u>Supported methods to add info to a enum value:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetTypeName">TLzDbgWatchDataIntf.SetTypeName</link>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateSetValue">
<short>Create a result for a set of enum</short>
<descr>
<remark>Subject to change</remark>
<ul>
<li>
<p>
<var>const ANames: TStringDynArray</var>
</p>
<p>A list of all enum identifiers that are included in the set value</p>
</li>
</ul>
</descr>
</element>
<!-- function Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateVariantValue">
<short>Create / Add variant fields</short>
<descr>
<p>This is used to create fields for the variant part(s) of any record "<var>record ... case ... end</var>". Included but not limited to the type "variant" itself.</p>
</descr>
</element>
<!-- function Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateProcedure">
<short>Create a result for a function</short>
<descr>This is if the user entered the name of a function (without setting function-eval).
<remark>Subject to change</remark>
</descr>
</element>
<!-- function Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateProcedureRef">
<short>Create a result for a function reference (variable containing a function)</short>
<descr>
<remark>Subject to change</remark>
</descr>
</element>
<!-- function Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateArrayValue">
<short>Create result for Arrays</short>
<descr>
<ul>
<li>
<p>
<var>AnArrayType: TLzDbgArrayType</var>
</p>
<p>See <link id="TLzDbgWatchDataIntf.TLzDbgArrayType">TLzDbgWatchDataIntf.TLzDbgArrayType</link>
</p>
</li>
<li>
<p>
<var>ATotalCount: Integer = 0</var>
</p>
<p>The declared length of the array. In case of dynamic array the length set with SetLength().<br/>
The amount of actually evaluated elements may differ.
</p>
</li>
<li>
<p>
<var>ALowIdx: Integer = 0</var>
</p>
The lower bound of the array.
<br/>
Only for static arrays, or arrays of unknown type.
</li>
</ul>
<p>
<u>Supported methods to add info to an array value:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetTypeName">TLzDbgWatchDataIntf.SetTypeName</link>
</li>
<li>
<link id="TLzDbgWatchDataIntf.SetDataAddress">TLzDbgWatchDataIntf.SetDataAddress</link>
</li>
<li>
<link id="TLzDbgWatchDataIntf.SetNextArrayData">TLzDbgWatchDataIntf.SetNextArrayData</link>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateStructure">
<short>Create result for an object, record or other structure</short>
<descr>
<ul>
<li>
<p>
<var>AStructType: TLzDbgStructType</var>
</p>
<p>See
<link id="TLzDbgWatchDataIntf.TLzDbgStructType">TLzDbgWatchDataIntf.TLzDbgStructType</link>
</p>
</li>
<li>
<p>
<var>ADataAddress: TDBGPtr = 0</var>
</p>
<p>DataAddress, if applicable (SetDataAddress does not work)</p>
</li>
</ul>
<p>
<u>Supported methods to add info to a structure value:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetTypeName">TLzDbgWatchDataIntf.SetTypeName</link>
</li>
<li>
<link id="TLzDbgWatchDataIntf.SetAnchestor">TLzDbgWatchDataIntf.SetAnchestor</link>
</li>
<li>
<link id="TLzDbgWatchDataIntf.AddField">TLzDbgWatchDataIntf.AddField</link>
</li>
</ul>
</descr>
</element>
<!-- function Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateValueHandlerResult">
<short>Create extra storage for value converter result</short>
<descr>
<p>When storing a result from a value converter, the result (which must be created using any of the other "Create..." methods) should be encapsulated by this.</p>
<p>This will allow storing the value converter's result and the result the backend would otherwise have created. Should the value handler create an error, the original data is available to be shown</p>
<p>The call to <var>CreateValueHandlerResult</var>returns a new <var>TLzDbgWatchDataIntf</var> which should be used to create the result of the value converter. <br/>
To add the non converted result use <var>SetDerefData</var>, which will alse returns a <var>TLzDbgWatchDataIntf</var>.
</p>
<p>
<u>Supported methods to add info to a converter's result wrapper:</u>
</p>
<ul>
<li>
<link id="TLzDbgWatchDataIntf.SetDerefData">TLzDbgWatchDataIntf.SetDerefData</link>
</li>
</ul>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.CreateError">
<short>Create an error</short>
<descr>
<ul>
<li>
<p>
<var>AVal: String</var>
</p>
<p>The error text to be displayed</p>
</li>
</ul>
<remark>The interface may still change</remark>
<p/>
<p>CreateError can be called immediately, without need to create any other value first. Or it can be called on a result that already had a value created. If the existing result had nested values they will all be dropped.</p>
</descr>
</element>
<!-- function Visibility: default -->
<element name="TLzDbgWatchDataIntf.SetPCharShouldBeStringValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.SetTypeName">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TLzDbgWatchDataIntf.SetDataAddress">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TLzDbgWatchDataIntf.SetDerefData">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TLzDbgWatchDataIntf.SetNextArrayData">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TLzDbgWatchDataIntf.SetAnchestor">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TLzDbgWatchDataIntf.AddField">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- interface Visibility: default -->
<element name="TWatchValueIntf">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TWatchValueIntf.BeginUpdate">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TWatchValueIntf.EndUpdate">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TWatchValueIntf.AddNotification">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TWatchValueIntf.RemoveNotification">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.ResData">
<short>Provides the interface for building the watch-result.</short>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.GetDisplayFormat">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.GetEvaluateFlags">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.GetDbgValConverter">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.GetExpression">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.GetFirstIndexOffs">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.GetRepeatCount">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.GetStackFrame">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.GetThreadId">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.GetValidity">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TWatchValueIntf.SetTypeInfo">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="TWatchValueIntf.GetValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TWatchValueIntf.SetValidity">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TWatchValueIntf.SetValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TWatchValueIntf.DisplayFormat">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TWatchValueIntf.EvaluateFlags">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TWatchValueIntf.FirstIndexOffs">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TWatchValueIntf.RepeatCount">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TWatchValueIntf.ThreadId">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TWatchValueIntf.StackFrame">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TWatchValueIntf.Expression">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TWatchValueIntf.Validity">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TWatchValueIntf.Value">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: default -->
<element name="TWatchValueIntf.TypeInfo">
<short/>
<descr/>
<seealso/>
</element>
<!-- interface Visibility: default -->
<element name="TWatchesSupplierIntf">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- interface Visibility: default -->
<element name="TWatchesMonitorIntf">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TWatchesMonitorIntf.InvalidateWatchValues">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TWatchesSupplierIntf.RequestData">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="TWatchesSupplierIntf.TriggerInvalidateWatchValues">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
</module>
<!-- LazDebuggerIntf -->
</package>
</fpdoc-descriptions>
|