michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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 "nsISupports.idl"
michael@0: 
michael@0: interface nsIURI;
michael@0: 
michael@0: /**
michael@0:  * nsINestedURI is an interface that must be implemented by any nsIURI
michael@0:  * implementation which has an "inner" URI that it actually gets data
michael@0:  * from.
michael@0:  *
michael@0:  * For example, if URIs for the scheme "sanitize" have the structure:
michael@0:  *
michael@0:  *   sanitize:http://example.com
michael@0:  *
michael@0:  * and opening a channel on such a sanitize: URI gets the data from
michael@0:  * http://example.com, sanitizes it, and returns it, then the sanitize: URI
michael@0:  * should implement nsINestedURI and return the http://example.com URI as its
michael@0:  * inner URI.
michael@0:  */
michael@0: [scriptable, uuid(6de2c874-796c-46bf-b57f-0d7bd7d6cab0)]
michael@0: interface nsINestedURI : nsISupports
michael@0: {
michael@0:   /**
michael@0:    * The inner URI for this nested URI.  This must not return null if the
michael@0:    * getter succeeds; URIs that have no inner must not QI to this interface.
michael@0:    * Dynamically changing whether there is an inner URI is not allowed.
michael@0:    *
michael@0:    * Modifying the returned URI must not in any way modify the nested URI; this
michael@0:    * means the returned URI must be either immutable or a clone.
michael@0:    */
michael@0:   readonly attribute nsIURI innerURI;
michael@0: 
michael@0:   /**
michael@0:    * The innermost URI for this nested URI.  This must not return null if the
michael@0:    * getter succeeds.  This is equivalent to repeatedly calling innerURI while
michael@0:    * the returned URI QIs to nsINestedURI.
michael@0:    *
michael@0:    * Modifying the returned URI must not in any way modify the nested URI; this
michael@0:    * means the returned URI must be either immutable or a clone.   
michael@0:    */
michael@0:   readonly attribute nsIURI innermostURI;
michael@0: };