intl/chardet/public/nsICharsetResolver.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is the Character Set Resolver interface
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corp.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Alec Flett <alecf@flett.org>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIWebNavigation;
  42 interface nsIChannel;
  43
  44 [scriptable, uuid(d143a084-b626-4614-845f-41f3ca43a674)]
  45 interface nsICharsetResolver : nsISupports
  46 {
  47     /**
  48      * Called to resolve the charset that should be used for parsing the
  49      * document being loaded from aChannel.
  50      *
  51      * If the charset cannot be resolved, but the implementation of
  52      * nsICharsetResolver wants to be notified of the final resolved charset
  53      * when one is available, it can set wantCharset to true.  If this is done,
  54      * the caller of requestCharset is responsible for calling
  55      * notifyResovedCharset and passing it the final resolved charset and the
  56      * closure that requestCharset set.
  57      *
  58      * @param aWebNavigation the nsIWebNavigation the document is being loaded
  59      *                       in.  May be null.
  60      * @param aChannel the channel the document is coming in from.
  61      * @param aWantCharset gets set to true if notifyResolvedCharset should be
  62      *                     called with the given closure object.
  63      * @param aClosure a resulting object which should be passed
  64      *                 to notifyResolvedCharset if wantCharset is set to
  65      *                 true.
  66      * @returns the resolved charset, or the empty string if no
  67      *          charset could be determined.
  68      */
  69     ACString requestCharset(in nsIWebNavigation aWebNavigation,
  70                             in nsIChannel aChannel,
  71                             out boolean aWantCharset,
  72                             out nsISupports aClosure);
  73
  74     /**
  75      * notifyResolvedCharset
  76      *
  77      * some implementations may request that they be notified when the
  78      * charset is actually detected.
  79      *
  80      * @param charset the detected charset
  81      * @param closure the closre returned by detectCharset() above
  82      */
  83     void notifyResolvedCharset(in ACString charset, in nsISupports closure);
  84 };