gecko-dev/modules/libjar/nsIZipReader.idl

138 lines
4.3 KiB
Plaintext
Raw Normal View History

2001-09-20 00:02:59 +00:00
/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
1999-11-11 05:21:38 +00:00
*
2001-09-20 00:02:59 +00:00
* The contents of this file are subject to the Netscape Public
1999-11-11 05:21:38 +00:00
* License Version 1.1 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
2001-09-20 00:02:59 +00:00
* the License at http://www.mozilla.org/NPL/
1999-11-11 05:21:38 +00:00
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
2001-09-20 00:02:59 +00:00
* The Original Code is Mozilla Communicator client code,
* released March 31, 1998.
1999-11-11 05:21:38 +00:00
*
2001-09-20 00:02:59 +00:00
* The Initial Developer of the Original Code is Netscape Communications
* Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
1999-11-11 05:21:38 +00:00
* Rights Reserved.
*
2001-09-20 00:02:59 +00:00
* Contributor(s):
1999-11-11 05:21:38 +00:00
* Daniel Veditz <dveditz@netscape.com>
* Don Bragg <dbragg@netscape.com>
* Samir Gehani <sgehani@netscape.com>
* Mitch Stoltz <mstoltz@netscape.com>
2001-09-20 00:02:59 +00:00
*/
1999-11-11 05:21:38 +00:00
#include "nsISupports.idl"
interface nsISimpleEnumerator;
interface nsIInputStream;
2000-01-24 21:28:28 +00:00
interface nsIFile;
1999-11-11 05:21:38 +00:00
[scriptable, uuid(6ca5e43e-9632-11d3-8cd9-0060b0fc14a3)]
interface nsIZipEntry : nsISupports
{
readonly attribute string name;
readonly attribute unsigned short compression;
readonly attribute unsigned long size;
readonly attribute unsigned long realSize;
readonly attribute unsigned long CRC32;
};
[scriptable, uuid(6ff6a966-9632-11d3-8cd9-0060b0fc14a3)]
interface nsIZipReader : nsISupports
{
/**
* Initializes a zip reader after construction.
*/
2000-01-24 21:28:28 +00:00
void init(in nsIFile zipFile);
1999-11-11 05:21:38 +00:00
readonly attribute nsIFile file;
1999-11-11 05:21:38 +00:00
/**
* Opens a zip reader.
*/
void open();
1999-11-11 05:21:38 +00:00
/**
* Closes a zip reader. Subsequent attempts to extract files or read from
* its input stream will result in an error.
*/
void close();
/**
* Tests the integrity of the archive by performing a CRC check
* on each item expanded into memory. If an entry is specified
* the integrity of only that item is tested. If NULL is passed
* in the inetgrity of all items in the archive are tested.
*/
void test(in string aEntryName);
1999-11-11 05:21:38 +00:00
/**
* Extracts a zip entry into a local file specified by outFile.
*/
2000-01-24 21:28:28 +00:00
void extract(in string zipEntry, in nsIFile outFile);
1999-11-11 05:21:38 +00:00
/**
* Returns a nsIZipEntry describing a specified zip entry.
*/
nsIZipEntry getEntry(in string zipEntry);
/**
* Returns a simple enumerator whose elements are of type nsIZipEntry.
*/
nsISimpleEnumerator/*<nsIZipEntry>*/ findEntries(in string aPattern);
1999-11-11 05:21:38 +00:00
/**
* Returns an input stream containing the contents of the specified zip entry.
*/
nsIInputStream getInputStream(in string zipEntry);
};
////////////////////////////////////////////////////////////////////////////////
// nsIZipReaderCache
[scriptable, uuid(52c45d86-0cc3-11d4-986e-00c04fa0cf4a)]
interface nsIZipReaderCache : nsISupports
{
2000-08-23 03:18:53 +00:00
/**
* Initializes a new zip reader cache.
* @param cacheSize - the number of released entries to maintain before
* beginning to throw some out (note that the number of outstanding
* entries can be much greater than this number -- this is the count
* for those otherwise unused entries)
*/
void init(in unsigned long cacheSize);
2000-08-23 03:18:53 +00:00
/**
* Returns a (possibly shared) nsIZipReader for an nsIFile.
*/
nsIZipReader getZip(in nsIFile zipFile);
};
////////////////////////////////////////////////////////////////////////////////
1999-11-11 05:21:38 +00:00
%{C++
#define NS_ZIPREADER_CID \
{ /* 7526a738-9632-11d3-8cd9-0060b0fc14a3 */ \
0x7526a738, \
0x9632, \
0x11d3, \
{0x8c, 0xd9, 0x00, 0x60, 0xb0, 0xfc, 0x14, 0xa3} \
}
#define NS_ZIPREADERCACHE_CID \
{ /* 1b117e16-0cad-11d4-986e-00c04fa0cf4a */ \
0x1b117e16, \
0x0cad, \
0x11d4, \
{0x98, 0x6e, 0x00, 0xc0, 0x4f, 0xa0, 0xcf, 0x4a} \
}
1999-11-11 05:21:38 +00:00
%}
////////////////////////////////////////////////////////////////////////////////