pjs/netwerk/dns/nsIIDNService.idl

99 строки
3.7 KiB
Plaintext

/* ***** 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 i-DNS.net International, Inc. code.
*
* The Initial Developer of the Original Code is
* i-DNS.net International.
* Portions created by the Initial Developer are Copyright (C) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): bobj@netscape.com,
* brendan@mozilla.org,
* darin@netscape.com,
* ftang@netscape.com,
* gagan@netscape.com,
* nhotta@netscape.com,
* william.tan@i-dns.net
* dwitte@stanford.edu
*
*
* 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"
/**
* nsIIDNService interface.
*
* IDN (Internationalized Domain Name) support. Provides facilities
* for manipulating IDN hostnames according to the specification set
* forth by the IETF.
*
* IDN effort:
* http://www.ietf.org/html.characters/idn-charter.html
* http://www.i-dns.net
*
* IDNA specification:
* http://search.ietf.org/internet-drafts/draft-ietf-idn-idna-06.txt
*/
[scriptable, uuid(a592a60e-3621-4f19-a318-2bf233cfad3e)]
interface nsIIDNService : nsISupports
{
/**
* Prepares the input hostname according to IDNA ToASCII operation,
* the input hostname is assumed to be UTF8-encoded.
*/
ACString convertUTF8toACE(in AUTF8String input);
/**
* This is the ToUnicode operation as specified in the IDNA proposal,
* with an additional step to encode the result in UTF-8.
* It takes an ACE-encoded hostname and performs ToUnicode to it, then
* encodes the resulting string into UTF8.
*/
AUTF8String convertACEtoUTF8(in ACString input);
/**
* Checks if the input string is ACE encoded or not.
*/
boolean isACE(in ACString input);
/**
* Performs the unicode normalization needed for hostnames in IDN,
* for callers that want early normalization.
*/
AUTF8String normalize(in AUTF8String input);
/**
* Normalizes and converts a host to UTF-8 if the host is in the IDN
* whitelist, otherwise converts it to ACE. This is useful for display
* purposes and to ensure an encoding consistent with nsIURI::GetHost().
* If the result is ASCII or ACE encoded, |isASCII| will be true.
*/
AUTF8String convertToDisplayIDN(in AUTF8String input, out boolean isASCII);
};