/usr/share/gir-1.0/GnomeAutoar-0.1.gir is in libgnome-autoar-0-dev 0.2.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 | <?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="GLib" version="2.0"/>
<include name="GObject" version="2.0"/>
<include name="Gio" version="2.0"/>
<c:include name="gnome-autoar/gnome-autoar.h"/>
<namespace name="GnomeAutoar"
version="0.1"
shared-library="libgnome-autoar-0.so.0"
c:identifier-prefixes="Autoar"
c:symbol-prefixes="autoar">
<class name="Compressor"
c:symbol-prefix="compressor"
c:type="AutoarCompressor"
parent="GObject.Object"
glib:type-name="AutoarCompressor"
glib:get-type="autoar_compressor_get_type"
glib:type-struct="CompressorClass">
<constructor name="new"
c:identifier="autoar_compressor_new"
introspectable="0">
<doc xml:space="preserve">Create a new #AutoarCompressor object.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #AutoarCompressor object</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</return-value>
<parameters>
<parameter name="source_files" transfer-ownership="none">
<doc xml:space="preserve">a #GList of source #GFiles to be archived</doc>
<type name="GLib.List" c:type="GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</parameter>
<parameter name="output_file" transfer-ownership="none">
<doc xml:space="preserve">output directory of the new archive, or the file name of the
new archive if you set #AutoarCompressor:output-is-dest on the returned object</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the compression format</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">the compression filter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
<parameter name="create_top_level_directory"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</constructor>
<function name="quark" c:identifier="autoar_compressor_quark">
<doc xml:space="preserve">Gets the #AutoarCompressor Error Quark.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GQuark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<method name="get_completed_files"
c:identifier="autoar_compressor_get_completed_files">
<doc xml:space="preserve">Gets the number of files has been read</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">number of files has been read</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_completed_size"
c:identifier="autoar_compressor_get_completed_size">
<doc xml:space="preserve">Gets the size in bytes has been read from the source files and directories.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">file size in bytes has been read</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_create_top_level_directory"
c:identifier="autoar_compressor_get_create_top_level_directory">
<doc xml:space="preserve">Gets whether a top level directory will be created in the new archive.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether a top level directory will be created</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_files" c:identifier="autoar_compressor_get_files">
<doc xml:space="preserve">Gets the number of files will be read when the operation is completed. This
value is currently unset, so calling this function is useless.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">total number of files</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_filter" c:identifier="autoar_compressor_get_filter">
<doc xml:space="preserve">Gets the compression filter</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the compression filter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_format" c:identifier="autoar_compressor_get_format">
<doc xml:space="preserve">Gets the compression format</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the compression format</doc>
<type name="Format" c:type="AutoarFormat"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_notify_interval"
c:identifier="autoar_compressor_get_notify_interval">
<doc xml:space="preserve">See autoar_compressor_set_notify_interval().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the minimal interval in microseconds between the emission of the
#AutoarCompressor::progress signal.</doc>
<type name="gint64" c:type="gint64"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_output_file"
c:identifier="autoar_compressor_get_output_file">
<doc xml:space="preserve">If #AutoarCompressor:output_is_dest is %FALSE, gets the directory which
contains the new archive. Otherwise, gets the the new archive. See
autoar_compressor_set_output_is_dest().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GFile</doc>
<type name="Gio.File" c:type="GFile*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_output_is_dest"
c:identifier="autoar_compressor_get_output_is_dest">
<doc xml:space="preserve">See autoar_compressor_set_output_is_dest().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if #AutoarCompressor:output is the location of the new
archive.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_size" c:identifier="autoar_compressor_get_size">
<doc xml:space="preserve">Gets the size in bytes will be read when the operation is completed. This
value is currently unset, so calling this function is useless.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">total file size in bytes</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_source_files"
c:identifier="autoar_compressor_get_source_files"
introspectable="0">
<doc xml:space="preserve">Gets the list of source files.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GList with the source files</doc>
<type name="GLib.List" c:type="GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_notify_interval"
c:identifier="autoar_compressor_set_notify_interval">
<doc xml:space="preserve">Sets the minimal interval between emission of #AutoarCompressor::progress
signal. This prevent too frequent signal emission, which may cause
performance impact. If you do not want this feature, you can set the
interval to 0, so you will receive every progress update.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
<parameter name="notify_interval" transfer-ownership="none">
<doc xml:space="preserve">the minimal interval in microseconds</doc>
<type name="gint64" c:type="gint64"/>
</parameter>
</parameters>
</method>
<method name="set_output_is_dest"
c:identifier="autoar_compressor_set_output_is_dest">
<doc xml:space="preserve">By default #AutoarCompressor:output-is-dest is set to %FALSE, which means
the new archive will be created as a regular file under
#AutoarCompressor:output directory. The name of the new archive will be
automatically generated and you will be notified via
#AutoarCompressor::decide-dest when the name is decided. If you have already
decided the location of the new archive, and you do not want
#AutoarCompressor to decide it for you, you can set
#AutoarCompressor:output-is-dest to %TRUE. #AutoarCompressor will use
#AutoarCompressor:output as the location of the new archive, and it will
neither check whether the file exists nor create the necessary
directories for you. This function should only be called before calling
autoar_compressor_start() or autoar_compressor_start_async().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
<parameter name="output_is_dest" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the location of the new archive has been already
decided</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="start" c:identifier="autoar_compressor_start">
<doc xml:space="preserve">Runs the archive creating work. All callbacks will be called in the same
thread as the caller of this functions.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor object</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, or %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="start_async" c:identifier="autoar_compressor_start_async">
<doc xml:space="preserve">Asynchronously runs the archive creating work. You should connect to
#AutoarCompressor::cancelled, #AutoarCompressor::error, and
#AutoarCompressor::completed signal to get notification when the work is
terminated. All callbacks will be called in the main thread, so you can
safely manipulate GTK+ widgets in the callbacks.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarCompressor object</doc>
<type name="Compressor" c:type="AutoarCompressor*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, or %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<property name="completed-files" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="completed-size" transfer-ownership="none">
<type name="guint64" c:type="guint64"/>
</property>
<property name="create-top-level-directory"
writable="1"
construct="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="files" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="filter"
introspectable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type/>
</property>
<property name="format"
introspectable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type/>
</property>
<property name="notify-interval"
writable="1"
construct="1"
transfer-ownership="none">
<type name="gint64" c:type="gint64"/>
</property>
<property name="output-file"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Gio.File"/>
</property>
<property name="output-is-dest"
writable="1"
construct="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="size" transfer-ownership="none">
<type name="guint64" c:type="guint64"/>
</property>
<property name="source-files"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<glib:signal name="cancelled" when="last">
<doc xml:space="preserve">This signal is emitted after archive creating job is cancelled by the
#GCancellable.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="completed" when="last">
<doc xml:space="preserve">This signal is emitted after the archive creating job is successfully
completed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="decide-dest" when="last">
<doc xml:space="preserve">This signal is emitted when the location of the new archive is determined.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="destination" transfer-ownership="none">
<doc xml:space="preserve">the location of the new archive</doc>
<type name="Gio.File"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="error" when="last">
<doc xml:space="preserve">This signal is emitted when error occurs and all jobs should be terminated.
Possible error domains are %AUTOAR_COMPRESSOR_ERROR, %G_IO_ERROR, and
%AUTOAR_LIBARCHIVE_ERROR, which represent error occurs in #AutoarCompressor,
GIO, and libarchive, respectively. The #GError is owned by #AutoarCompressor
and should not be freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="error" transfer-ownership="none">
<doc xml:space="preserve">the #GError</doc>
<type name="GLib.Error"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="progress" when="last">
<doc xml:space="preserve">This signal is used to report progress of creating archives. The value of
@completed_size and @completed_files are the same as the
#AutoarCompressor:completed_size and #AutoarCompressor:completed_files properties,
respectively.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="completed_size" transfer-ownership="none">
<doc xml:space="preserve">bytes has been read from source files and directories</doc>
<type name="guint64" c:type="guint64"/>
</parameter>
<parameter name="completed_files" transfer-ownership="none">
<doc xml:space="preserve">number of files and directories has been read</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="CompressorClass"
c:type="AutoarCompressorClass"
glib:is-gtype-struct-for="Compressor">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<enumeration name="ConflictAction" c:type="AutoarConflictAction">
<member name="skip" value="0" c:identifier="AUTOAR_CONFLICT_SKIP">
</member>
<member name="overwrite"
value="1"
c:identifier="AUTOAR_CONFLICT_OVERWRITE">
</member>
<member name="change_destination"
value="2"
c:identifier="AUTOAR_CONFLICT_CHANGE_DESTINATION">
</member>
</enumeration>
<class name="Extractor"
c:symbol-prefix="extractor"
c:type="AutoarExtractor"
parent="GObject.Object"
glib:type-name="AutoarExtractor"
glib:get-type="autoar_extractor_get_type"
glib:type-struct="ExtractorClass">
<constructor name="new" c:identifier="autoar_extractor_new">
<doc xml:space="preserve">Create a new #AutoarExtractor object.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #AutoarExtractor object</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</return-value>
<parameters>
<parameter name="source_file" transfer-ownership="none">
<doc xml:space="preserve">source archive</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
<parameter name="output_file" transfer-ownership="none">
<doc xml:space="preserve">output directory of extracted file or directory, or the
file name of the extracted file or directory itself if you set
#AutoarExtractor:output-is-dest on the returned object</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
</parameters>
</constructor>
<function name="quark" c:identifier="autoar_extractor_quark">
<doc xml:space="preserve">Gets the #AutoarExtractor Error Quark.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GQuark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<method name="get_completed_files"
c:identifier="autoar_extractor_get_completed_files">
<doc xml:space="preserve">Gets the number of files has been written to disk.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">number of files has been written to disk</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_completed_size"
c:identifier="autoar_extractor_get_completed_size">
<doc xml:space="preserve">Gets the size in bytes has been written to disk.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">size in bytes has been written</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_delete_after_extraction"
c:identifier="autoar_extractor_get_delete_after_extraction">
<doc xml:space="preserve">Whether the source archive will be deleted after a successful extraction.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the source archive will be deleted after a succesful
extraction</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_notify_interval"
c:identifier="autoar_extractor_get_notify_interval">
<doc xml:space="preserve">See autoar_extractor_set_notify_interval().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the minimal interval in microseconds between the emission of the
#AutoarExtractor::progress signal.</doc>
<type name="gint64" c:type="gint64"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_output_file"
c:identifier="autoar_extractor_get_output_file">
<doc xml:space="preserve">This function is similar to autoar_extractor_get_output(), except for the
return value is a #GFile.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GFile</doc>
<type name="Gio.File" c:type="GFile*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_output_is_dest"
c:identifier="autoar_extractor_get_output_is_dest">
<doc xml:space="preserve">See autoar_extractor_set_output_is_dest().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if #AutoarExtractor:output is the location of extracted file
or directory</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_source_file"
c:identifier="autoar_extractor_get_source_file">
<doc xml:space="preserve">Gets the #GFile object which represents the source archive that will be
extracted for this object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GFile</doc>
<type name="Gio.File" c:type="GFile*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_total_files"
c:identifier="autoar_extractor_get_total_files">
<doc xml:space="preserve">Gets the total number of files will be written when the operation is
completed.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">total number of extracted files</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_total_size"
c:identifier="autoar_extractor_get_total_size">
<doc xml:space="preserve">Gets the size in bytes will be written when the operation is completed.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">total size of extracted files in bytes</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_delete_after_extraction"
c:identifier="autoar_extractor_set_delete_after_extraction">
<doc xml:space="preserve">By default #AutoarExtractor:delete-after-extraction is set to %FALSE so the
source archive will not be automatically deleted if extraction succeeds.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
<parameter name="delete_if_succeed" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_notify_interval"
c:identifier="autoar_extractor_set_notify_interval">
<doc xml:space="preserve">Sets the minimal interval between emission of #AutoarExtractor::progress
signal. This prevent too frequent signal emission, which may cause
performance impact. If you do not want this feature, you can set the interval
to 0, so you will receive every progress update.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
<parameter name="notify_interval" transfer-ownership="none">
<doc xml:space="preserve">the minimal interval in microseconds</doc>
<type name="gint64" c:type="gint64"/>
</parameter>
</parameters>
</method>
<method name="set_output_is_dest"
c:identifier="autoar_extractor_set_output_is_dest">
<doc xml:space="preserve">By default #AutoarExtractor:output-is-dest is set to %FALSE, which means
only one file or directory will be generated. The destination is internally
determined by analyzing the contents of the archive. If this is not wanted,
#AutoarExtractor:output-is-dest can be set to %TRUE, which will make
#AutoarExtractor:output the destination for extracted files. In any case, the
destination will be notified via #AutoarExtractor::decide-destination, when
it is possible to set a new destination.
#AutoarExtractor will attempt to create the destination regardless to whether
its path was internally decided or not.
This function should only be called before calling autoar_extractor_start() or
autoar_extractor_start_async().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
<parameter name="output_is_dest" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the location of the extracted directory or file
has been already decided</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="start" c:identifier="autoar_extractor_start">
<doc xml:space="preserve">Runs the archive extracting work. All callbacks will be called in the same
thread as the caller of this functions.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor object</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, or %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="start_async" c:identifier="autoar_extractor_start_async">
<doc xml:space="preserve">Asynchronously runs the archive extracting work. You should connect to
#AutoarExtractor::cancelled, #AutoarExtractor::error, and
#AutoarExtractor::completed signal to get notification when the work is
terminated. All callbacks will be called in the main thread, so you can
safely manipulate GTK+ widgets in the callbacks.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarExtractor object</doc>
<type name="Extractor" c:type="AutoarExtractor*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, or %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<property name="completed-files" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="completed-size" transfer-ownership="none">
<type name="guint64" c:type="guint64"/>
</property>
<property name="delete-after-extraction"
writable="1"
construct="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="notify-interval"
writable="1"
construct="1"
transfer-ownership="none">
<type name="gint64" c:type="gint64"/>
</property>
<property name="output-file"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Gio.File"/>
</property>
<property name="output-is-dest"
writable="1"
construct="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="source-file"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Gio.File"/>
</property>
<property name="total-files" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="total-size" transfer-ownership="none">
<type name="guint64" c:type="guint64"/>
</property>
<glib:signal name="cancelled" when="last">
<doc xml:space="preserve">This signal is emitted after archive extracting job is cancelled by the
#GCancellable.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="completed" when="last">
<doc xml:space="preserve">This signal is emitted after the archive extracting job is successfully
completed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="conflict" when="last">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the action to be performed by #AutoarExtractor
This signal is used to report and offer the possibility to solve name
conflicts when extracting files.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="file" transfer-ownership="none">
<doc xml:space="preserve">the file that caused a conflict</doc>
<type name="Gio.File"/>
</parameter>
<parameter name="new_file"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">an address to store the new destination for a conflict file</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="decide-destination" when="last">
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new destination that will overwrite the previous
one, or %NULL if this is not wanted
This signal is emitted when the path of the destination is determined. It is
useful for solving name conflicts or for setting a new destination, based on
the contents of the archive.</doc>
<type name="GObject.Object"/>
</return-value>
<parameters>
<parameter name="destination" transfer-ownership="none">
<doc xml:space="preserve">the location where files will be extracted</doc>
<type name="Gio.File"/>
</parameter>
<parameter name="files"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the list of files to be extracted. All have @destination as their
common prefix</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="error" when="last">
<doc xml:space="preserve">This signal is emitted when error occurs and all jobs should be terminated.
Possible error domains are %AUTOAR_EXTRACTOR_ERROR, %G_IO_ERROR, and
%AUTOAR_LIBARCHIVE_ERROR, which represent error occurs in #AutoarExtractor,
GIO, and libarchive, respectively. The #GError is owned by #AutoarExtractor
and should not be freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="error" transfer-ownership="none">
<doc xml:space="preserve">the #GError</doc>
<type name="GLib.Error"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="progress" when="last">
<doc xml:space="preserve">This signal is used to report progress of creating archives.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="completed_size" transfer-ownership="none">
<doc xml:space="preserve">bytes has been written to disk</doc>
<type name="guint64" c:type="guint64"/>
</parameter>
<parameter name="completed_files" transfer-ownership="none">
<doc xml:space="preserve">number of files have been written to disk</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="scanned" when="last">
<doc xml:space="preserve">This signal is emitted when #AutoarExtractor finish scanning filename entries
in the source archive.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="files" transfer-ownership="none">
<doc xml:space="preserve">the number of files will be extracted from the source archive</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="ExtractorClass"
c:type="AutoarExtractorClass"
glib:is-gtype-struct-for="Extractor">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<enumeration name="Filter" c:type="AutoarFilter">
<doc xml:space="preserve">This is a non-negative number which represents filters supported by
libarchive. A libarchive filter is a filter which can convert a
regular file into a compressed file.</doc>
<member name="none" value="1" c:identifier="AUTOAR_FILTER_NONE">
<doc xml:space="preserve">%ARCHIVE_FILTER_NONE: No filter</doc>
</member>
<member name="compress" value="2" c:identifier="AUTOAR_FILTER_COMPRESS">
<doc xml:space="preserve">%ARCHIVE_FILTER_COMPRESS: UNIX-compressed</doc>
</member>
<member name="gzip" value="3" c:identifier="AUTOAR_FILTER_GZIP">
<doc xml:space="preserve">%ARCHIVE_FILTER_GZIP: Gzip</doc>
</member>
<member name="bzip2" value="4" c:identifier="AUTOAR_FILTER_BZIP2">
<doc xml:space="preserve">%ARCHIVE_FILTER_BZIP2: Bzip2</doc>
</member>
<member name="xz" value="5" c:identifier="AUTOAR_FILTER_XZ">
<doc xml:space="preserve">%ARCHIVE_FILTER_XZ: XZ</doc>
</member>
<member name="lzma" value="6" c:identifier="AUTOAR_FILTER_LZMA">
<doc xml:space="preserve">%ARCHIVE_FILTER_LZMA: LZMA</doc>
</member>
<member name="lzip" value="7" c:identifier="AUTOAR_FILTER_LZIP">
<doc xml:space="preserve">%ARCHIVE_FILTER_LZIP: Lzip</doc>
</member>
<member name="lzop" value="8" c:identifier="AUTOAR_FILTER_LZOP">
<doc xml:space="preserve">%ARCHIVE_FILTER_LZOP: LZO</doc>
</member>
<member name="grzip" value="9" c:identifier="AUTOAR_FILTER_GRZIP">
<doc xml:space="preserve">%ARCHIVE_FILTER_GRZIP: GRZip</doc>
</member>
<member name="lrzip" value="10" c:identifier="AUTOAR_FILTER_LRZIP">
<doc xml:space="preserve">%ARCHIVE_FILTER_LRZIP: Long Range ZIP (lrzip)</doc>
</member>
</enumeration>
<callback name="FilterFunc" c:type="AutoarFilterFunc">
<return-value transfer-ownership="none">
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="a"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="gpointer" c:type="archive*"/>
</parameter>
</parameters>
</callback>
<enumeration name="Format" c:type="AutoarFormat">
<doc xml:space="preserve">This is a non-negative number which represents formats supported by
libarchive. A libarchive format is a file format which can store many
files as a archive file.</doc>
<member name="zip" value="1" c:identifier="AUTOAR_FORMAT_ZIP">
<doc xml:space="preserve">%ARCHIVE_FORMAT_ZIP: Zip archive</doc>
</member>
<member name="tar" value="2" c:identifier="AUTOAR_FORMAT_TAR">
<doc xml:space="preserve">%ARCHIVE_FORMAT_TAR_PAX_RESTRICTED: Tar archive, use
ustar format is possible. If there are extended headers which cannot be
represented in the ustar format, libarchive will use pax interchage format
instead.</doc>
</member>
<member name="cpio" value="3" c:identifier="AUTOAR_FORMAT_CPIO">
<doc xml:space="preserve">%ARCHIVE_FORMAT_CPIO_POSIX: CPIO archive, POSIX
standard cpio interchage format.</doc>
</member>
<member name="7zip" value="4" c:identifier="AUTOAR_FORMAT_7ZIP">
<doc xml:space="preserve">%ARCHIVE_FORMAT_7ZIP: 7-zip archive</doc>
</member>
<member name="ar_bsd" value="5" c:identifier="AUTOAR_FORMAT_AR_BSD">
<doc xml:space="preserve">%ARCHIVE_FORMAT_AR_BSD: BSD variant of Unix archive
format. This format does not support storing directories.</doc>
</member>
<member name="ar_svr4" value="6" c:identifier="AUTOAR_FORMAT_AR_SVR4">
<doc xml:space="preserve">%ARCHIVE_FORMAT_AR_GNU: GNU/SVR4 variant of Unix
archive format. This format does not support storing directories.</doc>
</member>
<member name="cpio_newc"
value="7"
c:identifier="AUTOAR_FORMAT_CPIO_NEWC">
<doc xml:space="preserve">%ARCHIVE_FORMAT_CPIO_SVR4_NOCRC: CPIO archive,
SVR4 non-CRC variant</doc>
</member>
<member name="gnutar" value="8" c:identifier="AUTOAR_FORMAT_GNUTAR">
<doc xml:space="preserve">%ARCHIVE_FORMAT_TAR_GNUTAR: Tar archive, support
most popular GNU extensions.</doc>
</member>
<member name="iso9660" value="9" c:identifier="AUTOAR_FORMAT_ISO9660">
<doc xml:space="preserve">%ARCHIVE_FORMAT_ISO9660: Raw CD image</doc>
</member>
<member name="pax" value="10" c:identifier="AUTOAR_FORMAT_PAX">
<doc xml:space="preserve">%ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE: Tar archive, use
pax interchage format</doc>
</member>
<member name="ustar" value="11" c:identifier="AUTOAR_FORMAT_USTAR">
<doc xml:space="preserve">%ARCHIVE_FORMAT_TAR_USTAR: Tar archive, use old
ustar format</doc>
</member>
<member name="xar" value="12" c:identifier="AUTOAR_FORMAT_XAR">
<doc xml:space="preserve">%ARCHIVE_FORMAT_XAR: Xar archive</doc>
</member>
</enumeration>
<callback name="FormatFunc" c:type="AutoarFormatFunc">
<return-value transfer-ownership="none">
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="a"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="gpointer" c:type="archive*"/>
</parameter>
</parameters>
</callback>
<function name="check_mime_type_supported"
c:identifier="autoar_check_mime_type_supported">
<doc xml:space="preserve">Checks whether a mime type is supported by autoar. This function does no
blocking IO.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="mime_type" transfer-ownership="none">
<doc xml:space="preserve">a string representing the mime type</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="filter_get_description"
c:identifier="autoar_filter_get_description">
<doc xml:space="preserve">Gets description of the filter from the internal static data.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">description about the filter</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="filter_get_description_libarchive"
c:identifier="autoar_filter_get_description_libarchive">
<doc xml:space="preserve">Gets description of the filter from libarchive. This function creates
and destroys an archive object in order to get the description string.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">description about the filter. Free the returned
string with g_free().</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="filter_get_extension"
c:identifier="autoar_filter_get_extension">
<doc xml:space="preserve">Gets the file name extension of the filter from the internal static data.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a file name extension</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="filter_get_filter_libarchive"
c:identifier="autoar_filter_get_filter_libarchive">
<doc xml:space="preserve">Gets the filter code used by libarchive. You can use the return value
as the argument for archive_write_add_filter().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">an integer</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="filter_get_libarchive_read"
c:identifier="autoar_filter_get_libarchive_read"
introspectable="0">
<doc xml:space="preserve">Gets the function used to add filter on the object returned by
archive_read_new().</doc>
<return-value>
<doc xml:space="preserve">function pointer to the setter function provided by libarchive</doc>
<type name="FilterFunc" c:type="AutoarFilterFunc"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="filter_get_libarchive_write"
c:identifier="autoar_filter_get_libarchive_write"
introspectable="0">
<doc xml:space="preserve">Gets the function used to add filter on the object returned by
archive_write_new().</doc>
<return-value>
<doc xml:space="preserve">function pointer to the setter function provided by libarchive</doc>
<type name="FilterFunc" c:type="AutoarFilterFunc"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="filter_get_mime_type"
c:identifier="autoar_filter_get_mime_type">
<doc xml:space="preserve">Gets the MIME type of the filter from the internal static data.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">an MIME type</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="filter_is_valid" c:identifier="autoar_filter_is_valid">
<doc xml:space="preserve">Checks whether an #AutoarFilter is valid.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the value of @filter is valid</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="filter_last" c:identifier="autoar_filter_last">
<doc xml:space="preserve">Gets the maximal allowed values of #AutoarFilter</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">maximal allowed values of #AutoarFilter</doc>
<type name="gint" c:type="int"/>
</return-value>
</function>
<function name="format_filter_get_description"
c:identifier="autoar_format_filter_get_description">
<doc xml:space="preserve">Gets the description for an archive @format compressed by
@filter using #GContentType and autoar_format_filter_get_mime_type().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">description about the archive. Free the returned
string with g_free().</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="format_filter_get_extension"
c:identifier="autoar_format_filter_get_extension">
<doc xml:space="preserve">Gets the file name extension for an archive @format compressed by
@filter. The first character of the returned string is always '.'</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a file name extension. Free the returned string
with g_free().</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="format_filter_get_mime_type"
c:identifier="autoar_format_filter_get_mime_type">
<doc xml:space="preserve">Gets the MIME type for an archive @format compressed by
@filter. This function always succeed, but it is not guaranteed
that the returned MIME type exists and can be recognized by applications.
Some combination of format and filter seldom exists in application,
so this function can only generate the string based on some
non-standard rules.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">an MIME type. Free the returned
string with g_free().</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="Filter" c:type="AutoarFilter"/>
</parameter>
</parameters>
</function>
<function name="format_get_description"
c:identifier="autoar_format_get_description">
<doc xml:space="preserve">Gets description of the format from the internal static data.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">description about the format</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
</parameters>
</function>
<function name="format_get_description_libarchive"
c:identifier="autoar_format_get_description_libarchive">
<doc xml:space="preserve">Gets description of the format from libarchive. This function creates
and destroys an archive object in order to get the description string.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">description about the format. Free the returned
string with g_free().</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
</parameters>
</function>
<function name="format_get_extension"
c:identifier="autoar_format_get_extension">
<doc xml:space="preserve">Gets the file name extension of the format from the internal static data.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a file name extension</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
</parameters>
</function>
<function name="format_get_format_libarchive"
c:identifier="autoar_format_get_format_libarchive">
<doc xml:space="preserve">Gets the format code used by libarchive. You can use the return value
as the argument for archive_read_support_format_by_code() and
archive_write_set_format(). However, some format cannot be set using
these two functions because of problems inside libarchive. Use
autoar_format_get_libarchive_read() and
autoar_format_get_libarchive_write() to get the function pointer
is the more reliable way to set format on the archive object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">an integer</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
</parameters>
</function>
<function name="format_get_libarchive_read"
c:identifier="autoar_format_get_libarchive_read"
introspectable="0">
<doc xml:space="preserve">Gets the function used to set format on the object returned by
archive_read_new().</doc>
<return-value>
<doc xml:space="preserve">function pointer to the setter function provided by libarchive</doc>
<type name="FormatFunc" c:type="AutoarFormatFunc"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
</parameters>
</function>
<function name="format_get_libarchive_write"
c:identifier="autoar_format_get_libarchive_write"
introspectable="0">
<doc xml:space="preserve">Gets the function used to set format on the object returned by
archive_write_new().</doc>
<return-value>
<doc xml:space="preserve">function pointer to the setter function provided by libarchive</doc>
<type name="FormatFunc" c:type="AutoarFormatFunc"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
</parameters>
</function>
<function name="format_get_mime_type"
c:identifier="autoar_format_get_mime_type">
<doc xml:space="preserve">Gets the MIME type of the format from the internal static data.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">an MIME type</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
</parameters>
</function>
<function name="format_is_valid" c:identifier="autoar_format_is_valid">
<doc xml:space="preserve">Checks whether an #AutoarFormat is valid.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the value of @format is valid</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFormat</doc>
<type name="Format" c:type="AutoarFormat"/>
</parameter>
</parameters>
</function>
<function name="format_last" c:identifier="autoar_format_last">
<doc xml:space="preserve">Gets the maximal allowed values of #AutoarFormat</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">maximal allowed values of #AutoarFormat</doc>
<type name="gint" c:type="int"/>
</return-value>
</function>
<function name="libarchive_quark" c:identifier="autoar_libarchive_quark">
<doc xml:space="preserve">Gets the libarchive Error Quark.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GQuark.</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="query_mime_type_supported"
c:identifier="autoar_query_mime_type_supported">
<doc xml:space="preserve">This function will query the file's mime type and then call
autoar_check_mime_type_supported(), so it does blocking IO.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">an #AutoarFilter</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="file" transfer-ownership="none">
<doc xml:space="preserve">a #GFile to check if its mime type is supported</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>
|