pjs/modules/libjar/nsIZipReader.idl

154 строки
5.2 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* 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.
*
* The Original Code is Mozilla Communicator client code, released
* March 31, 1998.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Daniel Veditz <dveditz@netscape.com>
* Don Bragg <dbragg@netscape.com>
* Samir Gehani <sgehani@netscape.com>
* Mitch Stoltz <mstoltz@netscape.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsISimpleEnumerator;
interface nsIInputStream;
interface nsIFile;
[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.
*/
void init(in nsIFile zipFile);
readonly attribute nsIFile file;
/**
* Opens a zip reader.
*/
void open();
/**
* 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);
/**
* Extracts a zip entry into a local file specified by outFile.
*/
void extract(in string zipEntry, in nsIFile outFile);
/**
* 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);
/**
* 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
{
/**
* 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);
/**
* Returns a (possibly shared) nsIZipReader for an nsIFile.
*/
nsIZipReader getZip(in nsIFile zipFile);
};
////////////////////////////////////////////////////////////////////////////////
%{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} \
}
%}
////////////////////////////////////////////////////////////////////////////////