diff -r 000000000000 -r 6474c204b198 docshell/base/nsIURIFixup.idl --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docshell/base/nsIURIFixup.idl Wed Dec 31 06:09:35 2014 +0100 @@ -0,0 +1,81 @@ +/* -*- 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 "nsISupports.idl" + +interface nsIURI; +interface nsIInputStream; + +/** + * Interface implemented by objects capable of fixing up strings into URIs + */ +[scriptable, uuid(731877f8-973b-414c-b772-9ca1f3fffb7e)] +interface nsIURIFixup : nsISupports +{ + /** No fixup flags. */ + const unsigned long FIXUP_FLAG_NONE = 0; + + /** + * Allow the fixup to use a keyword lookup service to complete the URI. + * The fixup object implementer should honour this flag and only perform + * any lengthy keyword (or search) operation if it is set. + */ + const unsigned long FIXUP_FLAG_ALLOW_KEYWORD_LOOKUP = 1; + + /** + * Tell the fixup to make an alternate URI from the input URI, for example + * to turn foo into www.foo.com. + */ + const unsigned long FIXUP_FLAGS_MAKE_ALTERNATE_URI = 2; + + /** + * Fix common scheme typos. + */ + const unsigned long FIXUP_FLAG_FIX_SCHEME_TYPOS = 8; + + /* Note that flag 4 is available. */ + + /** + * Converts an internal URI (e.g. a wyciwyg URI) into one which we can + * expose to the user, for example on the URL bar. + * + * @param aURI The URI to be converted + * @return nsIURI The converted, exposable URI + * @throws NS_ERROR_MALFORMED_URI when the exposable portion of aURI is malformed + * @throws NS_ERROR_UNKNOWN_PROTOCOL when we can't get a protocol handler service + * for the URI scheme. + */ + nsIURI createExposableURI(in nsIURI aURI); + + /** + * Converts the specified string into a URI, first attempting + * to correct any errors in the syntax or other vagaries. Returns + * a wellformed URI or nullptr if it can't. + * + * @param aURIText Candidate URI. + * @param aFixupFlags Flags that govern ways the URI may be fixed up. + * @param aPostData The POST data to submit with the returned + * URI (see nsISearchSubmission). + */ + nsIURI createFixupURI(in AUTF8String aURIText, in unsigned long aFixupFlags, + [optional] out nsIInputStream aPostData); + + /** + * Converts the specified keyword string into a URI. Note that it's the + * caller's responsibility to check whether keywords are enabled and + * whether aKeyword is a sensible keyword. + * + * @param aKeyword The keyword string to convert into a URI + * @param aPostData The POST data to submit to the returned URI + * (see nsISearchSubmission). + * + * @throws NS_ERROR_FAILURE if the resulting URI requires submission of POST + * data and aPostData is null. + */ + nsIURI keywordToURI(in AUTF8String aKeyword, + [optional] out nsIInputStream aPostData); +}; +