зеркало из https://github.com/mozilla/gecko-dev.git
80 строки
2.9 KiB
Plaintext
80 строки
2.9 KiB
Plaintext
/* -*- 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(552a23bb-c1b2-426e-a801-d346c6a98f1d)]
|
|
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;
|
|
|
|
/**
|
|
* Use UTF-8 to encode the URI instead of platform charset.
|
|
*/
|
|
const unsigned long FIXUP_FLAG_USE_UTF8 = 4;
|
|
|
|
/**
|
|
* 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);
|
|
};
|
|
|