intl/unicharutil/nsISaveAsCharset.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7 #include "nsIEntityConverter.idl"
   8
   9 %{C++
  10 #define NS_SAVEASCHARSET_CID { 0xcd233e0, 0x7a86, 0x11d3, { 0x91, 0x5c, 0x0, 0x60, 0x8, 0xa6, 0xed, 0xf6 } }
  11 #define NS_SAVEASCHARSET_CONTRACTID "@mozilla.org/intl/saveascharset;1"
  12 %}
  13
  14 [scriptable, uuid(33B87F70-7A9C-11d3-915C-006008A6EDF6)]
  15 interface nsISaveAsCharset : nsISupports
  16 {
  17   // attributes
  18   const unsigned long mask_Fallback                = 0x000000FF; // mask for fallback (8bits)
  19   const unsigned long mask_Entity                  = 0x00000300; // mask for entity (2bits)
  20   const unsigned long mask_CharsetFallback         = 0x00000400; // mask for charset fallback (1bit)
  21
  22   const unsigned long attr_FallbackNone = 0;                   // no fall back for unconverted chars (skipped)
  23   const unsigned long attr_FallbackQuestionMark = 1;           // unconverted chars are replaced by '?'
  24   const unsigned long attr_FallbackEscapeU = 2;                // unconverted chars are escaped as \uxxxx
  25   const unsigned long attr_FallbackDecimalNCR = 3;             // unconverted chars are replaced by decimal NCR
  26   const unsigned long attr_FallbackHexNCR = 4;                 // unconverted chars are replaced by hex NCR
  27
  28   const unsigned long attr_EntityNone = 0;                       // generate no Named Entity
  29   const unsigned long attr_EntityBeforeCharsetConv = 0x00000100; // generate Named Entity before charset conversion
  30   const unsigned long attr_EntityAfterCharsetConv =  0x00000200; // generate Named Entity after charset conversion
  31
  32   const unsigned long attr_CharsetFallback        =  0x00000400; // fallback to other charset and restart the convesion
  33
  34
  35                                                                // default attribute for plain text
  36   const unsigned long attr_plainTextDefault = attr_FallbackNone + attr_EntityNone;
  37
  38                                                                // default attribute for html text
  39                                                                // generate entity before charset conversion, use decimal NCR
  40   const unsigned long attr_htmlTextDefault = attr_FallbackDecimalNCR + attr_EntityBeforeCharsetConv;
  41
  42   readonly attribute string charset;                           // charset used for the conversion
  43
  44   // set up charset, attribute and entity version
  45   // see nsIEntityConverter.idl for possible value of entityVersion (entityNone for plain text).
  46   void Init(in string charset, in unsigned long attr, in unsigned long entityVersion);
  47
  48   // convert UCS-2 html to target charset
  49   // may return the result code of the unicode converter (NS_ERROR_UENC_NOMAPPING)
  50   // if the attribute does not specify any fall back (e.g. attrPlainTextDefault)
  51         string Convert(in wstring inString);
  52 };