modules/libjar/nsIJARURI.idl
author David Major <dmajor@mozilla.com>
Wed, 03 Sep 2014 10:34:05 +1200
changeset 203292 d45a41039ece71eaafb0e2cdbbf385b80369e884
parent 94475 f4157e8c410708d76703f19e4dfb61859bfe32d8
child 258288 75ba313634f34e4b5e7fd9e5e6862680c1f69ddd
permissions -rw-r--r--
Bug 1061335 - Part 2: Add in-tree mozconfigs for VS2013 (these are not yet active) r=glandium

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsIURL.idl"

/**
 * JAR URLs have the following syntax
 *
 * jar:<jar-file-uri>!/<jar-entry>
 *
 * EXAMPLE: jar:http://www.big.com/blue.jar!/ocean.html
 *
 * The nsIURL methods operate on the <jar-entry> part of the spec.
 */
[scriptable, uuid(1ee60719-c056-43b3-8f54-6a6e7ba0ca6c)]
interface nsIJARURI : nsIURL {

    /**
     * Returns the root URI (the one for the actual JAR file) for this JAR
     * (e.g., http://www.big.com/blue.jar).
     */
    readonly attribute nsIURI JARFile;

    /**
     * Returns the entry specified for this JAR URI (e.g., "ocean.html").  This
     * value may contain %-escaped byte sequences.
     */
    attribute AUTF8String JAREntry;

    /**
     * Create a clone of the JAR URI with a new root URI (the URI for the
     * actual JAR file).
     */
    nsIJARURI cloneWithJARFile(in nsIURI jarFile);
};