Back to index

lightning-sunbird  0.9+nobinonly
nsIURLParser.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Andreas Otte.
00019  * Portions created by the Initial Developer are Copyright (C) 2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Darin Fisher <darin@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00045 [scriptable, uuid(7281076d-cf37-464a-815e-698235802604)]
00046 interface nsIURLParser : nsISupports
00047 {
00066     void parseURL        (in string spec,                  in long specLen,
00067                           out unsigned long schemePos,    out long schemeLen,
00068                           out unsigned long authorityPos, out long authorityLen,
00069                           out unsigned long pathPos,      out long pathLen);
00070 
00077     void parseAuthority  (in string authority,             in long authorityLen,
00078                           out unsigned long usernamePos,  out long usernameLen,
00079                           out unsigned long passwordPos,  out long passwordLen,
00080                           out unsigned long hostnamePos,  out long hostnameLen,
00081                           out long port);
00082 
00086     void parseUserInfo   (in string userinfo,              in long userinfoLen,
00087                           out unsigned long usernamePos,  out long usernameLen,
00088                           out unsigned long passwordPos,  out long passwordLen);
00089 
00093     void parseServerInfo (in string serverinfo,            in long serverinfoLen,
00094                           out unsigned long hostnamePos,  out long hostnameLen,
00095                           out long port);
00096 
00103     void parsePath       (in string path,                  in long pathLen,
00104                           out unsigned long filepathPos,  out long filepathLen,
00105                           out unsigned long paramPos,     out long paramLen,
00106                           out unsigned long queryPos,     out long queryLen,
00107                           out unsigned long refPos,       out long refLen);
00108 
00115     void parseFilePath   (in string filepath,              in long filepathLen,
00116                           out unsigned long directoryPos, out long directoryLen,
00117                           out unsigned long basenamePos,  out long basenameLen,
00118                           out unsigned long extensionPos, out long extensionLen);
00119 
00123     void parseFileName   (in string filename,              in long filenameLen,
00124                           out unsigned long basenamePos,  out long basenameLen,
00125                           out unsigned long extensionPos, out long extensionLen);
00126 };
00127 
00128 %{C++
00129 // url parser key for use with the category manager
00130 // mapping from scheme to url parser.
00131 #define NS_IURLPARSER_KEY "@mozilla.org/urlparser;1"
00132 %}