gecko-dev/xpcom/io/nsIFastLoadFileControl.idl
brendan%mozilla.org 6d895baf1d Bit checkin for bug 68045, r/sr=waterson&shaver, second attempt. It all works
for me on optimized and debug gcc2.96, rh7.1.

- Better failure codes from nsXULPrototypeScript::Deserialize.

- Call nsXULDocument::AbortFastLoads after nsXULPrototypeScript::Serialize
  failure, instead of just nulling the FastLoad service's output stream.

- Expose nsXULDocument::AbortFastLoads via nsIXULPrototypeCache, for use from
  nsChromeProtocolHandler.cpp.  AbortFastLoads flushes the XUL cache now, for
  good measure.

- The needless "Current" adjective in nsIFastLoadService attribute and method
  names is no more.

- Add a do_GetFastLoadService() helper, to use CID instead of contractid, and
  to let the compiler consolidate the static inline CID.

- Add "nglayout.debug.checksum_xul_fastload_file" pref so people can do without
  the checksum verification step when reading a FastLoad file.

- Verify the FastLoad file checksum, by default.  Also, cache it in the FastLoad
  service so we don't recompute it when re-opening the FastLoad file as mailnews
  and other top-levels start up.  Fill the checksum cache in EndFastLoad, when
  the last pseudo-concurrent top-level finishes loading.

  My hope to compute the checksum while writing the FastLoad file ran afoul of
  misordered writes.  The old code to checksum the in-memory nsFastLoadHeader
  also was broken on little endian platforms.  Now all checksumming is done via
  a separate read pass over the complete file, save for the header's checksum
  field, which is summed as if it contained zero.

- Track and check FastLoad file dependencies.  This required groveling with a
  bunch of Necko interfaces in nsChromeProtocolHandler::NewChannel -- read it
  and weep.  Dependency checking, as well as checksum access and computation,
  use better-factored nsIFastLoad{File,Read,Write}Control interfaces.

- nsBufferedStream::Seek wasn't flushing the buffer when seeking backward
  within the buffer, but it must, because mCursor bounds the amount to write
  if the buffer contains the end of file.

- Add an unbufferedStream readonly attribute to nsIStreamBufferAccess, so we
  don't have to screw around with the bufferying layer when checksumming. Also
  implement nsIStreamBufferAccess in nsBufferedOutputStream.

- nsISeekableOutputStream was bogus, based on a bad state I had put the
  nsBufferedOutputStream code in on its way from being completely broken when
  you seek backwards outside of the buffer.  Removing this interface required
  using nsIFastLoadFileIO in nsFastLoadFileWriter, and it also required careful
  ordering of Close calls (the Reader must close after the Writer or Updater,
  so that the Reader's underlying, unbuffered input stream can be read by
  nsFastLoadFileWriter::Close to compute the checksum.

- Miscellaneous tab/indentation, comment typo, bracing, if( => if ( style,
  nsnull vs. 0, useless variable elimination, tortured control flow,
  AutoString instead of String, and gratuitous ; after nsISupportsUtils.h
  macro call cleanups.
2001-08-21 20:51:34 +00:00

96 lines
3.8 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
* The contents of this file are subject to the Netscape 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/NPL/
*
* 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 FastLoad code.
*
* The Initial Developer of the Original Code is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 2001 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
* Brendan Eich <brendan@mozilla.org> (original author)
*/
#include "nsISupports.idl"
#include "nsrootidl.idl"
interface nsIFile;
interface nsISimpleEnumerator;
/**
* The nsIFastLoadFileControl interface and its subinterfaces are mix-ins for
* classes implementing nsIObjectInputStream and nsIObjectOutputStream, so that
* those stream types can be used with nsIFastLoadService to access and compute
* FastLoad file checksums, update and check FastLoad file dependencies, and
* multiplex documents loaded via non-blocking i/o.
*
* If an nsIObjectInputStream class doesn't support nsIFastLoadReadControl, or
* an nsIObjectOutputStream class doesn't support nsIFastLoadWriteControl, that
* implementation may still be useful for object serialization, but it can't be
* used to read or write a Mozilla FastLoad file.
*/
[scriptable, uuid(8a1e2c63-af50-4147-af7e-26289dc180dd)]
interface nsIFastLoadFileControl : nsISupports
{
/**
* Get and set the recorded checksum value from the FastLoad file header.
*/
attribute PRUint32 checksum;
/**
* Multiplexed document control methods. A FastLoad file may contain
* multiple interleaved documents identified by a URI specifier string,
* and indexed for fast multiplexor select by an opaque URI object key.
* You StartMuxedDocument when initiating a document load, then Select
* before every batch of calls to (de)serialize document data, and End
* when the load completes.
*
* Document multiplexing is necessary to support incremental FastLoad
* development in a non-blocking i/o architecture such as Mozilla, where
* some (but not all, at first, or for a while during development) of the
* results of parsing and compiling various inputs can be multiplexed to
* or from a FastLoad file.
*/
void startMuxedDocument(in nsISupports aURI, in string aURISpec);
void selectMuxedDocument(in nsISupports aURI);
void endMuxedDocument(in nsISupports aURI);
};
[scriptable, uuid(652ecec6-d40b-45b6-afef-641d6c63a35b)]
interface nsIFastLoadReadControl : nsIFastLoadFileControl
{
/**
* Computes the correct checksum of the FastLoad file, independent of the
* header's checksum value. The header checksum field is treated as zero
* when computing the checksum.
*/
PRUint32 computeChecksum();
/**
* Get the collection of dependency nsIFile instances recorded during the
* FastLoad file write or read/update process, and checked during the read
* process to invalidate the FastLoad file if any dependencies are newer.
*/
readonly attribute nsISimpleEnumerator dependencies;
};
[scriptable, uuid(2ad6e9e6-1379-4e45-a899-a54b27ff915c)]
interface nsIFastLoadWriteControl : nsIFastLoadFileControl
{
/**
* Add a file dependency of the FastLoad file (e.g., a .jar file) to the
* set of dependencies that trigger regeneration if any dependency has a
* last-modified-time greater than the FastLoad file's mtime.
*/
void addDependency(in nsIFile aFile);
};