michael@0: /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: 
michael@0: 
michael@0: %{C++
michael@0: // {8B042E22-6F87-11d3-B3C8-00805F8A6670}
michael@0: #define NS_TEXTTOSUBURI_CID { 0x8b042e22, 0x6f87, 0x11d3, { 0xb3, 0xc8, 0x0, 0x80, 0x5f, 0x8a, 0x66, 0x70 } }
michael@0: #define NS_ITEXTTOSUBURI_CONTRACTID "@mozilla.org/intl/texttosuburi;1"
michael@0: %}
michael@0: 
michael@0: [scriptable, uuid(8B042E24-6F87-11d3-B3C8-00805F8A6670)]
michael@0: interface nsITextToSubURI : nsISupports
michael@0: {
michael@0: 	string ConvertAndEscape(in string charset, in wstring text);
michael@0: 	wstring UnEscapeAndConvert(in string charset, in string text);
michael@0: 
michael@0:   /**
michael@0:    * Unescapes the given URI fragment (for UI purpose only)
michael@0:    * Note: 
michael@0:    * <ul>
michael@0:    *  <li> escaping back the result (unescaped string) is not guaranteed to 
michael@0:    *       give the original escaped string
michael@0:    *  <li> In case of a conversion error, the URI fragment (escaped) is 
michael@0:    *       assumed to be in UTF-8 and converted to AString (UTF-16)
michael@0:    *  <li> Always succeeeds (callers don't need to do error checking)
michael@0:    * </ul>
michael@0:    *
michael@0:    * @param aCharset the charset to convert from
michael@0:    * @param aURIFragment the URI (or URI fragment) to unescape
michael@0:    * @return Unescaped aURIFragment  converted to unicode
michael@0:    */
michael@0:   AString unEscapeURIForUI(in ACString aCharset, in AUTF8String aURIFragment);
michael@0: 
michael@0:   /**
michael@0:    * Unescapes only non ASCII characters in the given URI fragment 
michael@0:    * note: this method assumes the URI as UTF-8 and fallbacks to the given 
michael@0:    * charset if the charset is an ASCII superset 
michael@0:    *
michael@0:    * @param aCharset the charset to convert from
michael@0:    * @param aURIFragment the URI (or URI fragment) to unescape
michael@0:    * @return Unescaped aURIFragment  converted to unicode
michael@0:    * @throws NS_ERROR_UCONV_NOCONV when there is no decoder for aCharset
michael@0:    *         or error code of nsIUnicodeDecoder in case of conversion failure
michael@0:    */
michael@0:   AString unEscapeNonAsciiURI(in ACString aCharset, in AUTF8String aURIFragment);
michael@0: };