nsIURL.idl
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:7k
源码类别:

PlugIns编程

开发平台:

Visual C++

  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Gagan Saksena <gagan@netscape.com> (original author)
  24.  *   Darin Fisher <darin@netscape.com>
  25.  *
  26.  * Alternatively, the contents of this file may be used under the terms of
  27.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29.  * in which case the provisions of the GPL or the LGPL are applicable instead
  30.  * of those above. If you wish to allow use of your version of this file only
  31.  * under the terms of either the GPL or the LGPL, and not to allow others to
  32.  * use your version of this file under the terms of the MPL, indicate your
  33.  * decision by deleting the provisions above and replace them with the notice
  34.  * and other provisions required by the GPL or the LGPL. If you do not delete
  35.  * the provisions above, a recipient may use your version of this file under
  36.  * the terms of any one of the MPL, the GPL or the LGPL.
  37.  *
  38.  * ***** END LICENSE BLOCK ***** */
  39. #include "nsIURI.idl"
  40. /**
  41.  * The nsIURL interface provides convenience methods that further
  42.  * break down the path portion of nsIURI:
  43.  *
  44.  * http://directory/fileBaseName.fileExtension?query
  45.  * http://directory/fileBaseName.fileExtension#ref
  46.  * http://directory/fileBaseName.fileExtension;param
  47.  *                                        /
  48.  *                  -----------------------
  49.  *                            |          /
  50.  *                         fileName     /
  51.  *           ----------------------------
  52.  *                       |
  53.  *                   filePath
  54.  *
  55.  * @status FROZEN
  56.  */
  57. [scriptable, uuid(d6116970-8034-11d3-9399-00104ba0fd40)]
  58. interface nsIURL : nsIURI
  59. {
  60.     /*************************************************************************
  61.      * The URL path is broken down into the following principal components:
  62.      */
  63.     /**
  64.      * Returns a path including the directory and file portions of a
  65.      * URL.  For example, the filePath of "http://foo/bar.html#baz" is
  66.      * "/foo/bar.html".
  67.      *
  68.      * Some characters may be escaped.
  69.      */
  70.     attribute AUTF8String filePath;
  71.     /**
  72.      * Returns the parameters specified after the ; in the URL. 
  73.      *
  74.      * Some characters may be escaped.
  75.      */
  76.     attribute AUTF8String param;
  77.     /**
  78.      * Returns the query portion (the part after the "?") of the URL.
  79.      * If there isn't one, an empty string is returned.
  80.      *
  81.      * Some characters may be escaped.
  82.      */
  83.     attribute AUTF8String query;
  84.     /**
  85.      * Returns the reference portion (the part after the "#") of the URL.
  86.      * If there isn't one, an empty string is returned.
  87.      *
  88.      * Some characters may be escaped.
  89.      */
  90.     attribute AUTF8String ref;
  91.     /*************************************************************************
  92.      * The URL filepath is broken down into the following sub-components:
  93.      */
  94.     /**
  95.      * Returns the directory portion of a URL. 
  96.      * If the URL denotes a path to a directory and not a file,
  97.      * e.g. http://foo/bar/, then the Directory attribute accesses
  98.      * the complete /foo/bar/ portion, and the FileName is the 
  99.      * empty string. If the trailing slash is omitted, then the
  100.      * Directory is /foo/ and the file is bar (i.e. this is a 
  101.      * syntactic, not a semantic breakdown of the Path).
  102.      * And hence dont rely on this for something to be a definitely 
  103.      * be a file. But you can get just the leading directory portion 
  104.      * for sure.
  105.      *
  106.      * Some characters may be escaped.
  107.      */
  108.     attribute AUTF8String directory;
  109.     /**
  110.      * Returns the file name portion of a URL.
  111.      * If the URL denotes a path to a directory and not a file,
  112.      * e.g. http://foo/bar/, then the Directory attribute accesses
  113.      * the complete /foo/bar/ portion, and the FileName is the 
  114.      * empty string. Note that this is purely based on searching 
  115.      * for the last trailing slash. And hence dont rely on this to 
  116.      * be a definite file. 
  117.      *
  118.      * Some characters may be escaped.
  119.      */
  120.     attribute AUTF8String fileName;
  121.     /*************************************************************************
  122.      * The URL filename is broken down even further:
  123.      */
  124.     /**
  125.      * Returns the file basename portion of a filename in a url.
  126.      *
  127.      * Some characters may be escaped.
  128.      */
  129.     attribute AUTF8String fileBaseName;
  130.     /**
  131.      * Returns the file extension portion of a filename in a url.  If a file
  132.      * extension does not exist, the empty string is returned.
  133.      *
  134.      * Some characters may be escaped.
  135.      */
  136.     attribute AUTF8String fileExtension;
  137.     /**
  138.      * This method takes a uri and compares the two.  The common uri portion
  139.      * is returned as a string.  The minimum common uri portion is the 
  140.      * protocol, and any of these if present:  login, password, host and port
  141.      * If no commonality is found, "" is returned.  If they are identical, the
  142.      * whole path with file/ref/etc. is returned.  For file uris, it is
  143.      * expected that the common spec would be at least "file:///" since '/' is
  144.      * a shared common root.
  145.      *
  146.      * Examples:
  147.      *    this.spec               aURIToCompare.spec        result
  148.      * 1) http://mozilla.org/     http://www.mozilla.org/   ""
  149.      * 2) http://foo.com/bar/     ftp://foo.com/bar/        ""
  150.      * 3) http://foo.com:8080/    http://foo.com/bar/       ""
  151.      * 4) ftp://user@foo.com/     ftp://user:pw@foo.com/    ""
  152.      * 5) ftp://foo.com/bar/      ftp://foo.com/bar         ftp://foo.com/
  153.      * 6) ftp://foo.com/bar/      ftp://foo.com/bar/b.html  ftp://foo.com/bar/
  154.      * 7) http://foo.com/a.htm#i  http://foo.com/b.htm      http://foo.com/
  155.      * 8) ftp://foo.com/c.htm#i   ftp://foo.com/c.htm       ftp://foo.com/c.htm
  156.      * 9) file:///a/b/c.html      file:///d/e/c.html        file:///
  157.      */
  158.     AUTF8String getCommonBaseSpec(in nsIURI aURIToCompare);
  159.     /**
  160.      * This method takes a uri and returns a substring of this if it can be
  161.      * made relative to the uri passed in.  If no commonality is found, the
  162.      * entire uri spec is returned.  If they are identical, "" is returned.
  163.      * Filename, query, etc are always returned except when uris are identical.
  164.      */
  165.     AUTF8String getRelativeSpec(in nsIURI aURIToCompare);
  166. };