sbIStringTransform.idl

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

#include "nsISupports.idl"

[scriptable, uuid(4b9a60a0-76e8-47ed-b701-b297d45ab95e)]
interface sbIStringTransform : nsISupports
{
  const unsigned long TRANSFORM_MAP_HIRAGANA = 1;
  const unsigned long TRANSFORM_MAP_KATAKANA = 1 << 1;

  const unsigned long TRANSFORM_LOWERCASE = 1 << 4;
  const unsigned long TRANSFORM_UPPERCASE = 1 << 5;

  const unsigned long TRANSFORM_SIMPLIFIED_CHINESE = 1 << 6;
  const unsigned long TRANSFORM_TRADITIONAL_CHINESE = 1 << 7;

  const unsigned long TRANSFORM_IGNORE_SYMBOLS = 1 << 8;

  const unsigned long TRANSFORM_IGNORE_NONSPACE = 1 << 9;

  const unsigned long TRANSFORM_REVERSE_BYTES = 1 << 11; 

  const unsigned long TRANSFORM_IGNORE_NONALPHANUM = 1 << 12;
  const unsigned long TRANSFORM_IGNORE_NONALPHANUM_IGNORE_SPACE = 1 << 13;

  const unsigned long TRANSFORM_IGNORE_LEADING = 1 << 14;

  const unsigned long TRANSFORM_IGNORE_KEEPNUMBERSYMBOLS = 1 << 15;

  AString normalizeString(in AString aCharset,
                          in unsigned long aTransformFlags,
                          in AString aInput);

  AString convertToCharset(in AString aDestCharset,
                           in AString aInput);

  AString guessCharset(in AString aInput);
  
  AString removeArticles(in AString aInput, [optional] in AString aLanguage);
};

%{C++

#define SB_STRINGTRANSFORM_DESCRIPTION    \
  "Songbird String Transform"
#define SB_STRINGTRANSFORM_CONTRACTID     \
  "@songbirdnest.com/Songbird/Intl/StringTransform;1"
#define SB_STRINGTRANSFORM_CLASSNAME      \
  "sbStringTransform"
#define SB_STRINGTRANSFORM_CID            \
{ /*{0a8d2a48-2947-4ee4-bf36-32e7777358db}*/ \
  0xa8d2a48,                                 \
  0x2947,                                    \
  0x4ee4,                                    \
  { 0xbf, 0x36, 0x32, 0xe7, 0x77, 0x73, 0x58, 0xdb } \
}

%}