michael@0: /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
michael@0:  *
michael@0:  * This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsIURL.idl"
michael@0: 
michael@0: /**
michael@0:  * JAR URLs have the following syntax
michael@0:  *
michael@0:  * jar:<jar-file-uri>!/<jar-entry>
michael@0:  *
michael@0:  * EXAMPLE: jar:http://www.big.com/blue.jar!/ocean.html
michael@0:  *
michael@0:  * The nsIURL methods operate on the <jar-entry> part of the spec.
michael@0:  */
michael@0: [scriptable, uuid(1ee60719-c056-43b3-8f54-6a6e7ba0ca6c)]
michael@0: interface nsIJARURI : nsIURL {
michael@0: 
michael@0:     /**
michael@0:      * Returns the root URI (the one for the actual JAR file) for this JAR
michael@0:      * (e.g., http://www.big.com/blue.jar).
michael@0:      */
michael@0:     readonly attribute nsIURI JARFile;
michael@0: 
michael@0:     /**
michael@0:      * Returns the entry specified for this JAR URI (e.g., "ocean.html").  This
michael@0:      * value may contain %-escaped byte sequences.
michael@0:      */
michael@0:     attribute AUTF8String JAREntry;
michael@0: 
michael@0:     /**
michael@0:      * Create a clone of the JAR URI with a new root URI (the URI for the
michael@0:      * actual JAR file).
michael@0:      */
michael@0:     nsIJARURI cloneWithJARFile(in nsIURI jarFile);
michael@0: };