offapi/com/sun/star/packages/zip/ZipConstants.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_packages_zip_ZipConstants_idl__
  20 #define __com_sun_star_packages_zip_ZipConstants_idl__
  21
  22
  23
  24
  25 module com {  module sun {  module star {   module packages {  module zip {
  26
  27
  28 /** defines the constants used by the ZIP interfaces.
  29  */
  30 published constants ZipConstants
  31 {
  32     /** Compression method for the deflate algorithm (the only one currently
  33        supported).
  34      */
  35     const short DEFLATED = 8;
  36
  37     /** Compression level for no compression.
  38      */
  39     const short NO_COMPRESSION = 0;
  40
  41     /** Compression level for fastest compression
  42      */
  43     const short BEST_SPEED = 1;
  44
  45     /** Compression level for best compression
  46      */
  47     const short BEST_COMPRESSION = 9;
  48
  49     /** Default compression level.
  50      */
  51     const short DEFAULT_COMPRESSION = -1;
  52
  53     /** Compression strategy best used for data consisting mostly of small
  54       values with a somewhat random distribution. Forces more Huffman
  55       coding and less string matching.
  56      */
  57     const short FILTERED = 1;
  58
  59     /** Compression strategy for Huffman coding only.
  60      */
  61     const short HUFFMAN_ONLY = 2;
  62
  63     /** Default compression strategy
  64      */
  65     const short DEFAULT_STRATEGY = 0;
  66
  67     /** entry is uncompressed
  68      */
  69     const short STORED = 0;
  70
  71     /** entry is uncompressed
  72      */
  73     const short DEF_MEM_LEVEL = 8;
  74
  75     /** Header Signature: "PK\003\004"
  76      */
  77     const long LOCSIG  = 0x04034b50;
  78
  79     /** Header Signature: "PK\007\008"
  80      */
  81     const long EXTSIG  = 0x08074b50;
  82
  83     /** Header Signature: "PK\001\002"
  84      */
  85     const long CENSIG  = 0x02014b50;
  86
  87     /** Header Signature: "PK\005\006"
  88      */
  89     const long ENDSIG  = 0x06054b50;
  90
  91     /** Header Signature: "PK\007\008"
  92      */
  93     const long SPANSIG = 0x08074b50;
  94
  95     /** LOC header size in bytes (including signatures)
  96      */
  97     const short LOCHDR = 30;
  98
  99     /** EXT header size in bytes (including signatures)
 100      */
 101     const short EXTHDR = 16;
 102
 103     /** CEN header size in bytes (including signatures)
 104      */
 105     const short CENHDR = 46;
 106
 107     /** END header size in bytes (including signatures)
 108      */
 109     const short ENDHDR = 22;
 110
 111     /// LOC LOC LOC
 112     /** LOC header field "version needed to extract" offset
 113      */
 114     const short LOCVER = 4;
 115
 116     /** LOC header field "general purpose bit flags" offset
 117      */
 118     const short LOCFLG = 6;
 119
 120     /** LOC header field "compression method" offset
 121      */
 122     const short LOCHOW = 8;
 123
 124     /** LOC header field "modification time" offset
 125      */
 126     const short LOCTIM = 10;
 127
 128     /** LOC header field "CRC of uncompressed data" offset
 129      */
 130     const short LOCCRC = 14;
 131
 132     /** LOC header field "compressed data size" offset
 133      */
 134     const short LOCSIZ = 18;
 135
 136     /** LOC header field "uncompressed data size" offset
 137      */
 138     const short LOCLEN = 22;
 139
 140     /** LOC header field "filename length" offset
 141      */
 142     const short LOCNAM = 26;
 143
 144     /** LOC header field "extra field length" offset
 145      */
 146     const short LOCEXT = 28;
 147
 148     /** EXT header field "CRC of uncompressed data" offsets
 149      */
 150     const short EXTCRC = 4;
 151
 152     /** EXT header field "compressed size" offsets
 153      */
 154     const short EXTSIZ = 8;
 155
 156     /** EXT header field "uncompressed size" offsets
 157      */
 158     const short EXTLEN = 12;
 159
 160     /** CEN header field "version made by" offset
 161      */
 162     const short CENVEM = 4;
 163
 164     /** CEN header field "version needed to extract" offset
 165      */
 166     const short CENVER = 6;
 167
 168     /** CEN header field "general purpose bit flags" offset
 169      */
 170     const short CENFLG = 8;
 171
 172     /** CEN header field "compression method" offset
 173      */
 174     const short CENHOW = 10;
 175
 176     /** CEN header field "modification time" offset
 177      */
 178     const short CENTIM = 12;
 179
 180     /** CEN header field "modification time" offset
 181      */
 182     const short CENDAT = 14;
 183
 184     /** CEN header field "CRC of uncompressed data" offset
 185      */
 186     const short CENCRC = 16;
 187
 188     /** CEN header field "compressed size" offset
 189      */
 190     const short CENSIZ = 20;
 191
 192     /** CEN header field "uncompressed size" offset
 193      */
 194     const short CENLEN = 24;
 195
 196     /** CEN header field "length of filename" offset
 197      */
 198     const short CENNAM = 28;
 199
 200     /** CEN header field "length of extra field" offset
 201      */
 202     const short CENEXT = 30;
 203
 204     /** CEN header field "file comment length" offset
 205      */
 206     const short CENCOM = 32;
 207
 208     /** CEN header field "disk number start" offset
 209      */
 210     const short CENDSK = 34;
 211
 212     /** CEN header field "internal file attributes" offset
 213      */
 214     const short CENATT = 36;
 215
 216     /** CEN header field "external file attributes" offset
 217      */
 218     const short CENATX = 38;
 219
 220     /** CEN header field "offset of local header" offset
 221      */
 222     const short CENOFF = 42;
 223
 224     /** END header field "number of entries on this disk" offset
 225      */
 226     const short ENDSUB = 8;
 227
 228     /** END header field "total number of entries" offset
 229      */
 230     const short ENDTOT = 10;
 231
 232     /** END header field "central directory size" offset
 233      */
 234     const short ENDSIZ = 12;
 235
 236     /** END header field "central directory offset" offset
 237      */
 238     const short ENDOFF = 16;
 239
 240     /** END header field "size of zip file comment" offset
 241      */
 242     const short ENDCOM = 20;
 243
 244 };
 245
 246 }; }; }; }; };
 247
 248 #endif
 249
 250 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */