xpcom/ds/nsIAtomService.idl

   1 /* -*- Mode: C++; 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 mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Alec Flett <alecf@netscape.com>
  24  *   Benjamin Smedberg <benjamin@smedbergs.us>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsIAtom.idl"
  41
  42 %{C++
  43 #define NS_ATOMSERVICE_CID \
  44 { /* ed3db3fc-0168-4cab-8818-98f5475a490c */ \
  45     0xed3db3fc,                              \
  46     0x0168,                                  \
  47     0x4cab,                                  \
  48     {0x88, 0x18, 0x98, 0xf5, 0x47, 0x5a, 0x49, 0x0c} }
  49
  50 #define NS_ATOMSERVICE_CONTRACTID "@mozilla.org/atom-service;1"
  51 #define NS_ATOMSERVICE_CLASSNAME "Atom Service"
  52 %}
  53
  54 /*
  55  * Should this really be scriptable?  Using atoms from script or proxies
  56  * could be dangerous since double-wrapping could lead to loss of
  57  * pointer identity.
  58  */
  59
  60 [scriptable, uuid(9c1f50b9-f9eb-42d4-a8cb-2c7600aeb241)]
  61 interface nsIAtomService : nsISupports {
  62
  63   /**
  64    * Version of NS_NewAtom that doesn't require linking against the
  65    * XPCOM library.  See nsIAtom.idl.
  66    */
  67   nsIAtom getAtom(in AString value);
  68
  69   /**
  70    * Version of NS_NewPermanentAtom that doesn't require linking against
  71    * the XPCOM library.  See nsIAtom.idl.
  72    */
  73   nsIAtom getPermanentAtom(in AString value);
  74
  75   /**
  76    * Get an atom with a utf8 string.
  77    */
  78   [noscript] nsIAtom getAtomUTF8(in string value);
  79   [noscript] nsIAtom getPermanentAtomUTF8(in string value);
  80 };