/usr/share/gtk-doc/html/libgwyapp/libgwyapp-file-module-utils.html is in libgwyddion20-doc 2.26-1ubuntu1.
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 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>file module utils</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="prev" href="libgwyapp-module-utils.html" title="module utils">
<link rel="next" href="libgwyapp-Validate.html" title="Validate">
<meta name="generator" content="GTK-Doc V1.8 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libgwyapp-module-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gwyddion Application Library Reference Manual</th>
<td><a accesskey="n" href="libgwyapp-Validate.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwyapp-file-module-utils.synopsis" class="shortcut">Top</a>
|
<a href="#libgwyapp-file-module-utils.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwyapp-file-module-utils"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyapp-file-module-utils.top_of_page"></a>file module utils</span></h2>
<p>file module utils — Utility functions for file modules</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyapp-file-module-utils.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <app/gwymoduleutils-file.h>
#define <a class="link" href="libgwyapp-file-module-utils.html#GWY-TEXT-HEADER-ERROR:CAPS" title="GWY_TEXT_HEADER_ERROR">GWY_TEXT_HEADER_ERROR</a>
<a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderContext" title="GwyTextHeaderContext">GwyTextHeaderContext</a>;
enum <a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderError" title="enum GwyTextHeaderError">GwyTextHeaderError</a>;
<a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderParser" title="GwyTextHeaderParser">GwyTextHeaderParser</a>;
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-app-channel-check-nonsquare" title="gwy_app_channel_check_nonsquare ()">gwy_app_channel_check_nonsquare</a> (<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> *data</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-app-channel-remove-bad-data" title="gwy_app_channel_remove_bad_data ()">gwy_app_channel_remove_bad_data</a> (<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> *mfield</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-app-channel-title-fall-back" title="gwy_app_channel_title_fall_back ()">gwy_app_channel_title_fall_back</a> (<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> *data</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gboolean8" title="gwy_get_gboolean8 ()">gwy_get_gboolean8</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gdouble-be" title="gwy_get_gdouble_be ()">gwy_get_gdouble_be</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gdouble-le" title="gwy_get_gdouble_le ()">gwy_get_gdouble_le</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gfloat-be" title="gwy_get_gfloat_be ()">gwy_get_gfloat_be</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gfloat-le" title="gwy_get_gfloat_le ()">gwy_get_gfloat_le</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint16"><span class="returnvalue">gint16</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gint16-be" title="gwy_get_gint16_be ()">gwy_get_gint16_be</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint16"><span class="returnvalue">gint16</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gint16-le" title="gwy_get_gint16_le ()">gwy_get_gint16_le</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gint32-be" title="gwy_get_gint32_be ()">gwy_get_gint32_be</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gint32-le" title="gwy_get_gint32_le ()">gwy_get_gint32_le</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gint64-be" title="gwy_get_gint64_be ()">gwy_get_gint64_be</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gint64-le" title="gwy_get_gint64_le ()">gwy_get_gint64_le</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-guint16-be" title="gwy_get_guint16_be ()">gwy_get_guint16_be</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-guint16-le" title="gwy_get_guint16_le ()">gwy_get_guint16_le</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-guint32-be" title="gwy_get_guint32_be ()">gwy_get_guint32_be</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-guint32-le" title="gwy_get_guint32_le ()">gwy_get_guint32_le</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-guint64-be" title="gwy_get_guint64_be ()">gwy_get_guint64_be</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-guint64-le" title="gwy_get_guint64_le ()">gwy_get_guint64_le</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-pascal-real-be" title="gwy_get_pascal_real_be ()">gwy_get_pascal_real_be</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-pascal-real-le" title="gwy_get_pascal_real_le ()">gwy_get_pascal_real_le</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-text-header-context-get-lineno" title="gwy_text_header_context_get_lineno ()">gwy_text_header_context_get_lineno</a> (<em class="parameter"><code>const <a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderContext" title="GwyTextHeaderContext"><span class="type">GwyTextHeaderContext</span></a> *context</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgwyapp-file-module-utils.html#gwy-text-header-context-get-section" title="gwy_text_header_context_get_section ()">gwy_text_header_context_get_section</a> (<em class="parameter"><code>const <a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderContext" title="GwyTextHeaderContext"><span class="type">GwyTextHeaderContext</span></a> *context</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="libgwyapp-file-module-utils.html#gwy-text-header-error-quark" title="gwy_text_header_error_quark ()">gwy_text_header_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="libgwyapp-file-module-utils.html#gwy-text-header-parse" title="gwy_text_header_parse ()">gwy_text_header_parse</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *header</code></em>,
<em class="parameter"><code>const <a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderParser" title="GwyTextHeaderParser"><span class="type">GwyTextHeaderParser</span></a> *parser</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyapp-file-module-utils.description"></a><h2>Description</h2>
<p>
Functions <a class="link" href="libgwyapp-file-module-utils.html#gwy-app-channel-check-nonsquare" title="gwy_app_channel_check_nonsquare ()"><code class="function">gwy_app_channel_check_nonsquare()</code></a> and
<a class="link" href="libgwyapp-file-module-utils.html#gwy-app-channel-title-fall-back" title="gwy_app_channel_title_fall_back ()"><code class="function">gwy_app_channel_title_fall_back()</code></a> perform common tasks improving the
imported of channels from foreign data files. Typically one calls them on
all imported channel ids after storing the data fields the the container,
if they are useful for a given file type.
</p>
<p>
The group of functions <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gint16-le" title="gwy_get_gint16_le ()"><code class="function">gwy_get_gint16_le()</code></a>, <a class="link" href="libgwyapp-file-module-utils.html#gwy-get-gint16-be" title="gwy_get_gint16_be ()"><code class="function">gwy_get_gint16_be()</code></a>, etc.
is intended to portably read packed binary data structures that are commonly
found in SPM files. They all work identically: the binary data value is
read from the buffer, converted if necessary, and the provided
buffer pointer is moved to point after the value to faciliate sequential
reading.
</p>
<p>
As no buffer size is passed, obviously no buffer size checking is performed.
The caller has to ensure the buffer is large enough -- it is expected the
caller checks the total buffer size before starting to parse it.
</p>
<p>
For example to portably read the following packed struct stored
in big-endian byte order:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="keyword">struct</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="usertype">guint16</span><span class="normal"> xres</span><span class="symbol">;</span>
<span class="normal"> </span><span class="usertype">guint16</span><span class="normal"> yres</span><span class="symbol">;</span>
<span class="normal"> </span><span class="usertype">gfloat</span><span class="normal"> measure</span><span class="symbol">;</span>
<span class="cbracket">}</span><span class="normal"> header</span><span class="symbol">;</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
one can do (after checking the buffer size):
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="keyword">const</span><span class="normal"> </span><span class="usertype">guchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">p </span><span class="symbol">=</span><span class="normal"> buffer</span><span class="symbol">;</span>
<span class="normal">header</span><span class="symbol">.</span><span class="normal">xres </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="#gwy-get-guint16-be">gwy_get_guint16_be</a></span><span class="symbol">(&</span><span class="normal">p</span><span class="symbol">);</span>
<span class="normal">header</span><span class="symbol">.</span><span class="normal">yres </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="#gwy-get-guint16-be">gwy_get_guint16_be</a></span><span class="symbol">(&</span><span class="normal">p</span><span class="symbol">);</span>
<span class="normal">header</span><span class="symbol">.</span><span class="normal">measure </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="#gwy-get-gfloat-be">gwy_get_gfloat_be</a></span><span class="symbol">(&</span><span class="normal">p</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
and <em class="parameter"><code>p</code></em> will point after <em class="parameter"><code>measure</code></em> in <em class="parameter"><code>buffer</code></em> after this snippet is finished.
</p>
<p>
The data types used in <em class="parameter"><code>header</code></em> do not matter (provided they are large
enough to hold the values), the exact types are determined by the functions
used. Therefore the reading would work identically if <em class="parameter"><code>header</code></em> was defined
using common types:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="keyword">struct</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="usertype">gint</span><span class="normal"> xres</span><span class="symbol">;</span>
<span class="normal"> </span><span class="usertype">gint</span><span class="normal"> yres</span><span class="symbol">;</span>
<span class="normal"> </span><span class="usertype">gdouble</span><span class="normal"> measure</span><span class="symbol">;</span>
<span class="cbracket">}</span><span class="normal"> header</span><span class="symbol">;</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="libgwyapp-file-module-utils.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GWY-TEXT-HEADER-ERROR:CAPS"></a><h3>GWY_TEXT_HEADER_ERROR</h3>
<pre class="programlisting">#define GWY_TEXT_HEADER_ERROR gwy_text_header_error_quark()
</pre>
<p>
Error domain for text header parsing. Errors in this domain will be from the
<a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderError" title="enum GwyTextHeaderError"><span class="type">GwyTextHeaderError</span></a> enumeration. See <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for information on error
domains.
</p>
<p class="since">Since 2.18</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyTextHeaderContext"></a><h3>GwyTextHeaderContext</h3>
<pre class="programlisting">typedef struct _GwyTextHeaderContext GwyTextHeaderContext;</pre>
<p>
<a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderContext" title="GwyTextHeaderContext"><span class="type">GwyTextHeaderContext</span></a> represents the parsing state. It is an opaque data
structure and should be only manipulated with the functions below.
</p>
<p class="since">Since 2.18</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyTextHeaderError"></a><h3>enum GwyTextHeaderError</h3>
<pre class="programlisting">typedef enum {
GWY_TEXT_HEADER_ERROR_SECTION_NAME,
GWY_TEXT_HEADER_ERROR_SECTION_END,
GWY_TEXT_HEADER_ERROR_SECTION_START,
GWY_TEXT_HEADER_ERROR_PREFIX,
GWY_TEXT_HEADER_ERROR_GARBAGE,
GWY_TEXT_HEADER_ERROR_KEY,
GWY_TEXT_HEADER_ERROR_VALUE,
GWY_TEXT_HEADER_ERROR_TERMINATOR,
} GwyTextHeaderError;
</pre>
<p>
Error codes returned by text header parsing.
</p>
<p>
Some errors, in particular <a class="link" href="libgwyapp-file-module-utils.html#GWY-TEXT-HEADER-ERROR-KEY:CAPS"><code class="literal">GWY_TEXT_HEADER_ERROR_KEY</code></a> and
<a class="link" href="libgwyapp-file-module-utils.html#GWY-TEXT-HEADER-ERROR-VALUE:CAPS"><code class="literal">GWY_TEXT_HEADER_ERROR_VALUE</code></a> are expected to be raised by user callbacks
(they are not restricted to these codes though).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GWY-TEXT-HEADER-ERROR-SECTION-NAME:CAPS"></a><span class="term"><code class="literal">GWY_TEXT_HEADER_ERROR_SECTION_NAME</code></span></p></td>
<td>Section name is invalid. It is raised
by the parser only for an empty section
name.
</td>
</tr>
<tr>
<td><p><a name="GWY-TEXT-HEADER-ERROR-SECTION-END:CAPS"></a><span class="term"><code class="literal">GWY_TEXT_HEADER_ERROR_SECTION_END</code></span></p></td>
<td>Section ended when a different section
or no section was open. Note that
<a class="link" href="libgwyapp-file-module-utils.html#gwy-text-header-context-get-section" title="gwy_text_header_context_get_section ()"><code class="function">gwy_text_header_context_get_section()</code></a>
returns the section being closed at the
time this error is raised.
</td>
</tr>
<tr>
<td><p><a name="GWY-TEXT-HEADER-ERROR-SECTION-START:CAPS"></a><span class="term"><code class="literal">GWY_TEXT_HEADER_ERROR_SECTION_START</code></span></p></td>
<td>Section started before the previous
ended. This is raised only if
<em class="parameter"><code>endsection_template</code></em> is set.
</td>
</tr>
<tr>
<td><p><a name="GWY-TEXT-HEADER-ERROR-PREFIX:CAPS"></a><span class="term"><code class="literal">GWY_TEXT_HEADER_ERROR_PREFIX</code></span></p></td>
<td>Line lacks the mandatory prefix.
</td>
</tr>
<tr>
<td><p><a name="GWY-TEXT-HEADER-ERROR-GARBAGE:CAPS"></a><span class="term"><code class="literal">GWY_TEXT_HEADER_ERROR_GARBAGE</code></span></p></td>
<td>Line cannot be parsed into a key-value pair.
</td>
</tr>
<tr>
<td><p><a name="GWY-TEXT-HEADER-ERROR-KEY:CAPS"></a><span class="term"><code class="literal">GWY_TEXT_HEADER_ERROR_KEY</code></span></p></td>
<td>Key name is invalid, namely empty.
</td>
</tr>
<tr>
<td><p><a name="GWY-TEXT-HEADER-ERROR-VALUE:CAPS"></a><span class="term"><code class="literal">GWY_TEXT_HEADER_ERROR_VALUE</code></span></p></td>
<td>Value is invalid. This is never raised by
the parser.
</td>
</tr>
<tr>
<td><p><a name="GWY-TEXT-HEADER-ERROR-TERMINATOR:CAPS"></a><span class="term"><code class="literal">GWY_TEXT_HEADER_ERROR_TERMINATOR</code></span></p></td>
<td>The text header has ended without being
terminated by specified terminator.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.18</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyTextHeaderParser"></a><h3>GwyTextHeaderParser</h3>
<pre class="programlisting">typedef struct {
const gchar *comment_prefix;
const gchar *section_template;
const gchar *endsection_template;
const gchar *section_accessor;
const gchar *line_prefix;
const gchar *key_value_separator;
const gchar *terminator;
gboolean (*item)(const GwyTextHeaderContext *context,
GHashTable *hash,
gchar *key,
gchar *value,
gpointer user_data,
GError **error);
gboolean (*section)(const GwyTextHeaderContext *context,
const gchar *name,
gpointer user_data,
GError **error);
gboolean (*endsection)(const GwyTextHeaderContext *context,
const gchar *name,
gpointer user_data,
GError **error);
void (*end)(const GwyTextHeaderContext *context,
gsize length,
gpointer user_data);
gboolean (*error)(const GwyTextHeaderContext *context,
GError *error,
gpointer user_data);
GDestroyNotify destroy_key;
GDestroyNotify destroy_value;
} GwyTextHeaderParser;
</pre>
<p>
Text header parser specification.
</p>
<p>
Memory considerations: In general, the parser attempts to reuse the contents
of <em class="parameter"><code>header</code></em> directly for the hash keys and values. There are two cases when
it cannot: sectioning implies that keys must be constructed dynamically
and the use of <em class="parameter"><code>item</code></em> callback means the parser has no control on what is
inserted into the hash table.
</p>
<p>
This means that the <em class="parameter"><code>item</code></em> callback must free <em class="parameter"><code>key</code></em> if sectioning is used and
it is not going to actually use it as the hash table key. And, of course,
suitable <em class="parameter"><code>destroy_key</code></em> and <em class="parameter"><code>destroy_value</code></em> functions must be set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyTextHeaderParser.comment-prefix"></a>comment_prefix</code></em>;</span></p></td>
<td>Prefix denoting comment lines. It is possible to specify
multiple prefixes by separating them with newline ("\n").</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyTextHeaderParser.section-template"></a>section_template</code></em>;</span></p></td>
<td>Section start template. It must contain the character
"\x1a" in the place where the section name apprears.
Example: "[Section \x1a]".</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyTextHeaderParser.endsection-template"></a>endsection_template</code></em>;</span></p></td>
<td>Section end template. It may or may not contain the
substitute character "\x1a" depending on whether the
section end markers contain the section name. It is
invalid to set <em class="parameter"><code>endsection_template</code></em> without setting
<em class="parameter"><code>section_template</code></em>. Example: "[Section \x1a End]".</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyTextHeaderParser.section-accessor"></a>section_accessor</code></em>;</span></p></td>
<td>Glue to put between the section name and key when
constructing hash table keys. It is invalid to set
<em class="parameter"><code>section_accessor</code></em> without setting <em class="parameter"><code>section_template</code></em>.
Typically, "::" is used.</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyTextHeaderParser.line-prefix"></a>line_prefix</code></em>;</span></p></td>
<td>Mandatory prefix of each line. Note this applies only to
key-value lines. The templates, such comments, sections and
terminators, must still include <em class="parameter"><code>line_prefix</code></em> if they start
with it.</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyTextHeaderParser.key-value-separator"></a>key_value_separator</code></em>;</span></p></td>
<td>The string separating keys and values on each line.
Typically, "=" or ":" is used. When left <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,
whitespace plays the role of the separator. Of
course, keys cannot contain whitespace then.</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyTextHeaderParser.terminator"></a>terminator</code></em>;</span></p></td>
<td>Line that marks end of the header. It is mandatory if
specified, <em class="parameter"><code>GWY_TEXT_HEADER_ERROR_TERMINATOR</code></em> is raised when
the header ends sooner than <em class="parameter"><code>terminator</code></em> is found.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyTextHeaderParser.item"></a>item</code></em> ()</span></p></td>
<td>Callback called when a key-value pair is found. If set it is
responsible for inserting the pair to the hash table with
<a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#g-hash-table-replace"><code class="function">g_hash_table_replace()</code></a>. It is free to insert a different pair or
nothing. It must return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it raises an error.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyTextHeaderParser.section"></a>section</code></em> ()</span></p></td>
<td>Callback called when a section starts. It must return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if
it raises an error.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyTextHeaderParser.endsection"></a>endsection</code></em> ()</span></p></td>
<td>Callback called when a section end. It must return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if
it raises an error.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyTextHeaderParser.end"></a>end</code></em> ()</span></p></td>
<td>Callback called when the parsing finishes successfully, <em class="parameter"><code>length</code></em>
contains the length of parsed text in bytes.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyTextHeaderParser.error"></a>error</code></em> ()</span></p></td>
<td>Callback called when an error occurs, including errors raised by
other user callbacks. If it returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> the error is considered
fatal and the parsing terminates immediately. If it is left unset
no errors are fatal hence no errors are reported to the caller.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> <em class="structfield"><code><a name="GwyTextHeaderParser.destroy-key"></a>destroy_key</code></em>;</span></p></td>
<td>Function to destroy keys, passed to <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#g-hash-table-new-full"><code class="function">g_hash_table_new_full()</code></a>.
It is invalid to set <em class="parameter"><code>destroy_key</code></em> if <em class="parameter"><code>item</code></em> callback is not
set.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> <em class="structfield"><code><a name="GwyTextHeaderParser.destroy-value"></a>destroy_value</code></em>;</span></p></td>
<td>Function to destroy values, passed to
<a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#g-hash-table-new-full"><code class="function">g_hash_table_new_full()</code></a>. It is invalid to set
<em class="parameter"><code>destroy_value</code></em> if <em class="parameter"><code>item</code></em> callback is not set.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.18</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-channel-check-nonsquare"></a><h3>gwy_app_channel_check_nonsquare ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_app_channel_check_nonsquare (<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> *data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>);</pre>
<p>
Sets `realsquare' for a channel highly non-square pixels.
</p>
<p>
The threshold for highly non-square is somewhat arbitrary.
Fortunately, most files encoutered in practice have the measure ratio either
very close to 1, larger or equal than 2.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>A data container.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>Data channel id.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the channel was found to have highly non-square pixels
and `realsquare' was set (otherwise it was unset).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-channel-remove-bad-data"></a><h3>gwy_app_channel_remove_bad_data ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gwy_app_channel_remove_bad_data (<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> *mfield</code></em>);</pre>
<p>
Replaces bad data points with some neutral values.
</p>
<p>
Since Gwyddion has no concept of bad data points, they are usually marked
with a mask and replaced with some neutral values upon import, leaving the
user to decide how to proceed further. This helper function performs such
replacement, using the average of all good points as the neutral replacement
value (at this moment).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dfield</code></em> :</span></p></td>
<td>A data field. The values of bad data points are ignored and might
be even left uninitialized.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mfield</code></em> :</span></p></td>
<td>A mask field containing 1.0 in place of good data points, 0.0 in
place of bad points. It will be inverted to become the mask of
bad points.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of bad data points replaced. If zero is returned, all
points are good and there is no need for masking.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-channel-title-fall-back"></a><h3>gwy_app_channel_title_fall_back ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_app_channel_title_fall_back (<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> *data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>);</pre>
<p>
Adds a channel title based on data field units.
</p>
<p>
The guess is very simple, but probably better than `Unknown channel' in
most cases. If there already is a title it is left intact, making use of
this function as a fall-back easier.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>A data container.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>Data channel id.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the title was set (either by this function or before).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gboolean8"></a><h3>gwy_get_gboolean8 ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_get_gboolean8 (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a boolean value stored as a signle byte from a
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to boolean (stored as a signle byte)
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gdouble-be"></a><h3>gwy_get_gdouble_be ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_get_gdouble_be (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a double-precision IEEE float value from a big-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a big-endian double-precision IEEE float
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gdouble-le"></a><h3>gwy_get_gdouble_le ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_get_gdouble_le (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a double-precision IEEE float value from a little-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a little-endian double-precision IEEE float
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gfloat-be"></a><h3>gwy_get_gfloat_be ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> gwy_get_gfloat_be (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a single-precision IEEE float value from a big-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a big-endian single-precision IEEE float
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gfloat-le"></a><h3>gwy_get_gfloat_le ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> gwy_get_gfloat_le (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a single-precision IEEE float value from a little-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a little-endian single-precision IEEE float
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gint16-be"></a><h3>gwy_get_gint16_be ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint16"><span class="returnvalue">gint16</span></a> gwy_get_gint16_be (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a signed 16bit integer value from a big-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a big-endian signed 16bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint16"><span class="type">gint16</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gint16-le"></a><h3>gwy_get_gint16_le ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint16"><span class="returnvalue">gint16</span></a> gwy_get_gint16_le (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a signed 16bit integer value from a little-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a little-endian signed 16bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint16"><span class="type">gint16</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gint32-be"></a><h3>gwy_get_gint32_be ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> gwy_get_gint32_be (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a signed 32bit integer value from a big-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a big-endian signed 32bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gint32-le"></a><h3>gwy_get_gint32_le ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> gwy_get_gint32_le (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a signed 32bit integer value from a little-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a little-endian signed 32bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gint64-be"></a><h3>gwy_get_gint64_be ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> gwy_get_gint64_be (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a signed 64bit integer value from a big-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a big-endian signed 64bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-gint64-le"></a><h3>gwy_get_gint64_le ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> gwy_get_gint64_le (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a signed 64bit integer value from a little-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a little-endian signed 64bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-guint16-be"></a><h3>gwy_get_guint16_be ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> gwy_get_guint16_be (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads an unsigned 16bit integer value from a big-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a big-endian unsigned 16bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-guint16-le"></a><h3>gwy_get_guint16_le ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> gwy_get_guint16_le (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads an unsigned 16bit integer value from a little-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a little-endian unsigned 16bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-guint32-be"></a><h3>gwy_get_guint32_be ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> gwy_get_guint32_be (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads an unsigned 32bit integer value from a big-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a big-endian unsigned 32bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-guint32-le"></a><h3>gwy_get_guint32_le ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> gwy_get_guint32_le (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads an unsigned 32bit integer value from a little-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a little-endian unsigned 32bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-guint64-be"></a><h3>gwy_get_guint64_be ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> gwy_get_guint64_be (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads an unsigned 64bit integer value from a big-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a big-endian unsigned 64bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-guint64-le"></a><h3>gwy_get_guint64_le ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> gwy_get_guint64_le (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads an unsigned 64bit integer value from a little-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a little-endian unsigned 64bit integer
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> value read from the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-pascal-real-be"></a><h3>gwy_get_pascal_real_be ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_get_pascal_real_be (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a six-byte Pascale Real value from a big-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a big-endian six-byte Pascal Real
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The floating point value read from the buffer as a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-get-pascal-real-le"></a><h3>gwy_get_pascal_real_le ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_get_pascal_real_le (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ppv</code></em>);</pre>
<p>
Reads a six-byte Pascale Real value from a little-endian
binary data buffer, moving the buffer pointer to point just after the value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ppv</code></em> :</span></p></td>
<td>Pointer to a pointer to a little-endian six-byte Pascal Real
in a memory buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The floating point value read from the buffer as a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-text-header-context-get-lineno"></a><h3>gwy_text_header_context_get_lineno ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gwy_text_header_context_get_lineno (<em class="parameter"><code>const <a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderContext" title="GwyTextHeaderContext"><span class="type">GwyTextHeaderContext</span></a> *context</code></em>);</pre>
<p>
Gets the current header line.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>Header parsing context.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The current line number, starting from zero.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.18</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-text-header-context-get-section"></a><h3>gwy_text_header_context_get_section ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_text_header_context_get_section (<em class="parameter"><code>const <a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderContext" title="GwyTextHeaderContext"><span class="type">GwyTextHeaderContext</span></a> *context</code></em>);</pre>
<p>
Gets the currently open section.
</p>
<p>
This function may be called if no sectioning is defined. It simply
returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>Header parsing context.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the currently open section, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is none.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.18</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-text-header-error-quark"></a><h3>gwy_text_header_error_quark ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> gwy_text_header_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns error domain for expression parsin and evaluation.
</p>
<p>
See and use <a class="link" href="libgwyapp-file-module-utils.html#GWY-TEXT-HEADER-ERROR:CAPS" title="GWY_TEXT_HEADER_ERROR"><code class="literal">GWY_TEXT_HEADER_ERROR</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The error domain.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.18</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-text-header-parse"></a><h3>gwy_text_header_parse ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * gwy_text_header_parse (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *header</code></em>,
<em class="parameter"><code>const <a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderParser" title="GwyTextHeaderParser"><span class="type">GwyTextHeaderParser</span></a> *parser</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Parses a line-oriented text header into a hash table.
</p>
<p>
See <a class="link" href="libgwyapp-file-module-utils.html#GwyTextHeaderParser" title="GwyTextHeaderParser"><span class="type">GwyTextHeaderParser</span></a> for details of memory and error handling.
</p>
<p>
Lines consisting only of whitespace are ignored.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
<td>Text header to parse. It must be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated and writable.
Its contents will be modified to directly embed the hash keys
and/or values. It must not be freed while the returned hash
table is in use.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>Parser specification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data passed to parser callbacks.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Error to set on fatal errors.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly created hash table with values indexed by they keys found
in the header.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.18</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|