| /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
| /* ***** BEGIN LICENSE BLOCK ***** |
| * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
| * |
| * The contents of this file are subject to the Mozilla Public License Version |
| * 1.1 (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS IS" basis, |
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
| * for the specific language governing rights and limitations under the |
| * License. |
| * |
| * The Original Code is mozilla.org code. |
| * |
| * The Initial Developer of the Original Code is |
| * Andreas Otte. |
| * Portions created by the Initial Developer are Copyright (C) 2000 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * Darin Fisher <darin@netscape.com> |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either the GNU General Public License Version 2 or later (the "GPL"), or |
| * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
| * in which case the provisions of the GPL or the LGPL are applicable instead |
| * of those above. If you wish to allow use of your version of this file only |
| * under the terms of either the GPL or the LGPL, and not to allow others to |
| * use your version of this file under the terms of the MPL, indicate your |
| * decision by deleting the provisions above and replace them with the notice |
| * and other provisions required by the GPL or the LGPL. If you do not delete |
| * the provisions above, a recipient may use your version of this file under |
| * the terms of any one of the MPL, the GPL or the LGPL. |
| * |
| * ***** END LICENSE BLOCK ***** */ |
| |
| #include "nsISupports.idl" |
| |
| /** |
| * nsIURLParser specifies the interface to an URL parser that attempts to |
| * follow the definitions of RFC 2396. |
| */ |
| [scriptable, uuid(7281076d-cf37-464a-815e-698235802604)] |
| interface nsIURLParser : nsISupports |
| { |
| /** |
| * The string to parse in the following methods may be given as a null |
| * terminated string, in which case the length argument should be -1. |
| * |
| * Out parameters of the following methods are all optional (ie. the caller |
| * may pass-in a NULL value if the corresponding results are not needed). |
| * Signed out parameters may hold a value of -1 if the corresponding result |
| * is not part of the string being parsed. |
| * |
| * The parsing routines attempt to be as forgiving as possible. |
| */ |
| |
| /** |
| * ParseSpec breaks the URL string up into its 3 major components: a scheme, |
| * an authority section (hostname, etc.), and a path. |
| * |
| * spec = <scheme>://<authority><path> |
| */ |
| void parseURL (in string spec, in long specLen, |
| out unsigned long schemePos, out long schemeLen, |
| out unsigned long authorityPos, out long authorityLen, |
| out unsigned long pathPos, out long pathLen); |
| |
| /** |
| * ParseAuthority breaks the authority string up into its 4 components: |
| * username, password, hostname, and hostport. |
| * |
| * auth = <username>:<password>@<hostname>:<port> |
| */ |
| void parseAuthority (in string authority, in long authorityLen, |
| out unsigned long usernamePos, out long usernameLen, |
| out unsigned long passwordPos, out long passwordLen, |
| out unsigned long hostnamePos, out long hostnameLen, |
| out long port); |
| |
| /** |
| * userinfo = <username>:<password> |
| */ |
| void parseUserInfo (in string userinfo, in long userinfoLen, |
| out unsigned long usernamePos, out long usernameLen, |
| out unsigned long passwordPos, out long passwordLen); |
| |
| /** |
| * serverinfo = <hostname>:<port> |
| */ |
| void parseServerInfo (in string serverinfo, in long serverinfoLen, |
| out unsigned long hostnamePos, out long hostnameLen, |
| out long port); |
| |
| /** |
| * ParsePath breaks the path string up into its 4 major components: a file path, |
| * a param string, a query string, and a reference string. |
| * |
| * path = <filepath>;<param>?<query>#<ref> |
| */ |
| void parsePath (in string path, in long pathLen, |
| out unsigned long filepathPos, out long filepathLen, |
| out unsigned long paramPos, out long paramLen, |
| out unsigned long queryPos, out long queryLen, |
| out unsigned long refPos, out long refLen); |
| |
| /** |
| * ParseFilePath breaks the file path string up into: the directory portion, |
| * file base name, and file extension. |
| * |
| * filepath = <directory><basename>.<extension> |
| */ |
| void parseFilePath (in string filepath, in long filepathLen, |
| out unsigned long directoryPos, out long directoryLen, |
| out unsigned long basenamePos, out long basenameLen, |
| out unsigned long extensionPos, out long extensionLen); |
| |
| /** |
| * filename = <basename>.<extension> |
| */ |
| void parseFileName (in string filename, in long filenameLen, |
| out unsigned long basenamePos, out long basenameLen, |
| out unsigned long extensionPos, out long extensionLen); |
| }; |
| |
| %{C++ |
| // url parser key for use with the category manager |
| // mapping from scheme to url parser. |
| #define NS_IURLPARSER_KEY "@mozilla.org/urlparser;1" |
| %} |