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