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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ZipConstants.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_package_zip_ZipConstants_idl__
  31 #define __com_sun_star_package_zip_ZipConstants_idl__
  32
  33
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {   module packages {  module zip {
  38
  39 //=============================================================================
  40
  41 /** defines the constants used by the ZIP interfaces.
  42  */
  43 published constants ZipConstants
  44 {
  45     //-------------------------------------------------------------------------
  46     /** Compression method for the deflate algorithm (the only one currently
  47        supported).
  48      */
  49     const short DEFLATED = 8;
  50
  51     //-------------------------------------------------------------------------
  52     /** Compression level for no compression.
  53      */
  54     const short NO_COMPRESSION = 0;
  55
  56     //-------------------------------------------------------------------------
  57     /** Compression level for fastest compression
  58      */
  59     const short BEST_SPEED = 1;
  60
  61     //-------------------------------------------------------------------------
  62     /** Compression level for best compression
  63      */
  64     const short BEST_COMPRESSION = 9;
  65
  66     //-------------------------------------------------------------------------
  67     /** Default compression level.
  68      */
  69     const short DEFAULT_COMPRESSION = -1;
  70
  71     //-------------------------------------------------------------------------
  72     /** Compression strategy best used for data consisting mostly of small
  73       values with a somewhat random distribution. Forces more Huffman
  74       coding and less string matching.
  75      */
  76     const short FILTERED = 1;
  77
  78     //-------------------------------------------------------------------------
  79     /** Compression strategy for Huffman coding only.
  80      */
  81     const short HUFFMAN_ONLY = 2;
  82
  83     //-------------------------------------------------------------------------
  84     /** Default compression strategy
  85      */
  86     const short DEFAULT_STRATEGY = 0;
  87
  88     //-------------------------------------------------------------------------
  89     /** entry is uncompressed
  90      */
  91     const short STORED = 0;
  92
  93     //-------------------------------------------------------------------------
  94     /** entry is uncompressed
  95      */
  96     const short DEF_MEM_LEVEL = 8;
  97
  98     //-------------------------------------------------------------------------
  99     /** Header Signature: "PK\003\004"
 100      */
 101     const long LOCSIG  = 0x04034b50;
 102
 103     //-------------------------------------------------------------------------
 104     /** Header Signature: "PK\007\008"
 105      */
 106     const long EXTSIG  = 0x08074b50;
 107
 108     //-------------------------------------------------------------------------
 109     /** Header Signature: "PK\001\002"
 110      */
 111     const long CENSIG  = 0x02014b50;
 112
 113     //-------------------------------------------------------------------------
 114     /** Header Signature: "PK\005\006"
 115      */
 116     const long ENDSIG  = 0x06054b50;
 117
 118     //-------------------------------------------------------------------------
 119     /** Header Signature: "PK\007\008"
 120      */
 121     const long SPANSIG = 0x08074b50;
 122
 123     //-------------------------------------------------------------------------
 124     /** LOC header size in bytes (including signatures)
 125      */
 126     const short LOCHDR = 30;
 127
 128     //-------------------------------------------------------------------------
 129     /** EXT header size in bytes (including signatures)
 130      */
 131     const short EXTHDR = 16;
 132
 133     //-------------------------------------------------------------------------
 134     /** CEN header size in bytes (including signatures)
 135      */
 136     const short CENHDR = 46;
 137
 138     //-------------------------------------------------------------------------
 139     /** END header size in bytes (including signatures)
 140      */
 141     const short ENDHDR = 22;
 142
 143     //-------------------------------------------------------------------------
 144     /// LOC LOC LOC
 145     /** LOC header field "version needed to extract" offset
 146      */
 147     const short LOCVER = 4;
 148
 149     //-------------------------------------------------------------------------
 150     /** LOC header field "general purpose bit flags" offset
 151      */
 152     const short LOCFLG = 6;
 153
 154     //-------------------------------------------------------------------------
 155     /** LOC header field "compression method" offset
 156      */
 157     const short LOCHOW = 8;
 158
 159     //-------------------------------------------------------------------------
 160     /** LOC header field "modification time" offset
 161      */
 162     const short LOCTIM = 10;
 163
 164     //-------------------------------------------------------------------------
 165     /** LOC header field "crc of uncompressed data" offset
 166      */
 167     const short LOCCRC = 14;
 168
 169     //-------------------------------------------------------------------------
 170     /** LOC header field "compressed data size" offset
 171      */
 172     const short LOCSIZ = 18;
 173
 174     //-------------------------------------------------------------------------
 175     /** LOC header field "uncompressed data size" offset
 176      */
 177     const short LOCLEN = 22;
 178
 179     //-------------------------------------------------------------------------
 180     /** LOC header field "filename length" offset
 181      */
 182     const short LOCNAM = 26;
 183
 184     //-------------------------------------------------------------------------
 185     /** LOC header field "extra field length" offset
 186      */
 187     const short LOCEXT = 28;
 188
 189     //-------------------------------------------------------------------------
 190     /** EXT header field "crc of uncompressed data" offsets
 191      */
 192     const short EXTCRC = 4;
 193
 194     //-------------------------------------------------------------------------
 195     /** EXT header field "compressed size" offsets
 196      */
 197     const short EXTSIZ = 8;
 198
 199     //-------------------------------------------------------------------------
 200     /** EXT header field "uncompressed size" offsets
 201      */
 202     const short EXTLEN = 12;
 203
 204     //-------------------------------------------------------------------------
 205     /** CEN header field "version made by" offset
 206      */
 207     const short CENVEM = 4;
 208
 209     //-------------------------------------------------------------------------
 210     /** CEN header field "version needed to extract" offset
 211      */
 212     const short CENVER = 6;
 213
 214     //-------------------------------------------------------------------------
 215     /** CEN header field "general purpose bit flags" offset
 216      */
 217     const short CENFLG = 8;
 218
 219     //-------------------------------------------------------------------------
 220     /** CEN header field "compression method" offset
 221      */
 222     const short CENHOW = 10;
 223
 224     //-------------------------------------------------------------------------
 225     /** CEN header field "modification time" offset
 226      */
 227     const short CENTIM = 12;
 228
 229     //-------------------------------------------------------------------------
 230     /** CEN header field "modification time" offset
 231      */
 232     const short CENDAT = 14;
 233
 234     //-------------------------------------------------------------------------
 235     /** CEN header field "crc of uncompressed data" offset
 236      */
 237     const short CENCRC = 16;
 238
 239     //-------------------------------------------------------------------------
 240     /** CEN header field "compressed size" offset
 241      */
 242     const short CENSIZ = 20;
 243
 244     //-------------------------------------------------------------------------
 245     /** CEN header field "uncompressed size" offset
 246      */
 247     const short CENLEN = 24;
 248
 249     //-------------------------------------------------------------------------
 250     /** CEN header field "length of filename" offset
 251      */
 252     const short CENNAM = 28;
 253
 254     //-------------------------------------------------------------------------
 255     /** CEN header field "length of extra field" offset
 256      */
 257     const short CENEXT = 30;
 258
 259     //-------------------------------------------------------------------------
 260     /** CEN header field "file comment length" offset
 261      */
 262     const short CENCOM = 32;
 263
 264     //-------------------------------------------------------------------------
 265     /** CEN header field "disk number start" offset
 266      */
 267     const short CENDSK = 34;
 268
 269     //-------------------------------------------------------------------------
 270     /** CEN header field "internal file attributes" offset
 271      */
 272     const short CENATT = 36;
 273
 274     //-------------------------------------------------------------------------
 275     /** CEN header field "external file attributes" offset
 276      */
 277     const short CENATX = 38;
 278
 279     //-------------------------------------------------------------------------
 280     /** CEN header field "offset of local header" offset
 281      */
 282     const short CENOFF = 42;
 283
 284     //-------------------------------------------------------------------------
 285     /** END header field "number of entries on this disk" offset
 286      */
 287     const short ENDSUB = 8;
 288
 289     //-------------------------------------------------------------------------
 290     /** END header field "total number of entries" offset
 291      */
 292     const short ENDTOT = 10;
 293
 294     //-------------------------------------------------------------------------
 295     /** END header field "central directory size" offset
 296      */
 297     const short ENDSIZ = 12;
 298
 299     //-------------------------------------------------------------------------
 300     /** END header field "central directory offset" offset
 301      */
 302     const short ENDOFF = 16;
 303
 304     //-------------------------------------------------------------------------
 305     /** END header field "size of zip file comment" offset
 306      */
 307     const short ENDCOM = 20;
 308
 309 };
 310 //=============================================================================
 311
 312 }; }; }; }; };
 313
 314 #endif