~ubuntu-branches/ubuntu/intrepid/xulrunner-1.9/intrepid

« back to all changes in this revision

Viewing changes to mozilla/xpcom/ds/nsIAtom.idl

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Sack, Alexander Sack, Fabien Tassin
  • Date: 2008-02-13 11:47:21 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080213114721-7om0mgzngvuk9czv
Tags: 1.9~b3+nobinonly-0ubuntu1
* release FIREFOX_3_0b3_RELEASE

[ Alexander Sack ]
* submit patch that ships xpcshell to bugzilla
  - rename debian/patches/ship_xpcshell.patch =>
           debian/patches/bz410617_att295212_ship_xpcshell.patch
  - update debian/patches/series
* fix tooltip in epiphany: previously displayed out of screen bounds
  (LP: #37507)
  - add debian/patches/bz233371_att297343_fix_outofscreen_embed_tooltip.patch
  - update debian/patches/series
* use default upstream gcc tweaks for improved performance - especially of the
  javascript engine
  - update debian/rules
* update global extension/plugin patch to apply cleanly against latest code
  - update debian/patches/bzXXX_gre_extension_plugin_support.patch
* fix pyxpcom build failure introduced by recent commit
  - add debian/patches/bzXXX_fix_pyxpcom_build_failure.patch
  - update debian/patches/series
* add distro independent global install locations for extensions,
  /usr/lib/mozilla/extensions and /usr/share/mozilla/extensions
  - update debian/xulrunner-1.9.dirs
* support embedded tarball layout when either there is a *.tar.bz2 in orig tarball
  or if DEBIAN_MOZCLIENT_EMBEDDED is not unset (you will need this to produce embedded
  tarballs during |get-orig-source|
  - update debian/rules
* bump minimum libnss3-dev build requirements to >= 3.12.0~1.9b3
  - update debian/control
* bump minimum libnspr4-dev build requirements to >= 4.7.0~1.9b3
  - update debian/control

[ Fabien Tassin ]
* Drop patches applied upstream
  - drop debian/patches/bz410617_att295212_ship_xpcshell.patch
  - drop debian/patches/bz404634_att294921.patch
  - drop debian/patches/bz386610_python2.5_ftbfs_amd64.patch
  - drop debian/patches/bz373918_att295042.patch
  - drop debian/patches/bz408062_unstable_pc.patch
  - drop debian/patches/bz384304_fix_recursive_symlinks.patch
  - update debian/patches/series
* Refresh diverged patches:
  - update debian/patches/bzXXX_pc_honour_system_nspr_nss.patch
  - update debian/patches/rename_venkman_addon.patch
  - update debian/patches/bz344818_cairo_xrender.patch
* Install links for all .so libs in the -dev package
  - update debian/patches/dont_install_so_in_dev.patch
* Bump gtk requirement to 2.12 as per Mozilla bug 412432
  - update debian/control
* Add #DEBHELPER# token to postinst/prerm scripts
  - update debian/xulrunner-1.9.{postinst,prerm}
* Install previously missed libdbusservice.so
  - update debian/xulrunner-1.9.install
* Update venkman patch to also rename locales
  - update debian/patches/rename_venkman_addon.patch
* Bump requirement for system cairo to >= 1.5.8 as we now need
  the newly added cairo_path_extents()
  - update debian/rules
* Include mozilla-devscripts file using -include so ifneq could be omitted
  - update debian/rules
* Fix missing .so symlinks regression
  - update debian/patches/dont_install_so_in_dev.patch

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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 Communicator client code, released
16
 
 * March 31, 1998.
17
 
 *
18
 
 * The Initial Developer of the Original Code is
19
 
 * Netscape Communications Corporation.
20
 
 * Portions created by the Initial Developer are Copyright (C) 1998-1999
21
 
 * the Initial Developer. All Rights Reserved.
22
 
 *
23
 
 * Contributor(s):
24
 
 *
25
 
 * Alternatively, the contents of this file may be used under the terms of
26
 
 * either of the GNU General Public License Version 2 or later (the "GPL"),
27
 
 * or 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
 
#include "nsISupports.idl"
39
 
 
40
 
%{C++
41
 
#include "nsStringGlue.h"
42
 
#include "nsCOMPtr.h"
43
 
%}
44
 
 
45
 
/*
46
 
 * Should this really be scriptable?  Using atoms from script or proxies
47
 
 * could be dangerous since double-wrapping could lead to loss of
48
 
 * pointer identity.
49
 
 */
50
 
 
51
 
[scriptable, uuid(3d1b15b0-93b4-11d1-895b-006008911b81)]
52
 
interface nsIAtom : nsISupports
53
 
{
54
 
  /**
55
 
   * Get the Unicode or UTF8 value for the string
56
 
   */
57
 
  AString toString(); 
58
 
  AUTF8String toUTF8String();
59
 
  
60
 
  /**
61
 
   * Return a pointer to a zero terminated UTF8 string.
62
 
   */
63
 
  [noscript] void getUTF8String([shared, retval] out string aResult);
64
 
 
65
 
  /**
66
 
   * Compare the atom to a specific string value
67
 
   * Note that this will NEVER return/throw an error condition.
68
 
   */
69
 
  boolean equals(in AString aString);
70
 
  
71
 
  boolean equalsUTF8(in AUTF8String aString);
72
 
 
73
 
%{C++
74
 
  // note this is NOT virtual so this won't muck with the vtable!
75
 
  inline PRBool Equals(const nsAString& s) {
76
 
    PRBool result;
77
 
    Equals(s, &result);
78
 
    return result;
79
 
  }
80
 
 
81
 
  inline PRBool EqualsUTF8(const nsACString& s) {
82
 
    PRBool result;
83
 
    EqualsUTF8(s, &result);
84
 
    return result;
85
 
  }
86
 
%}
87
 
  
88
 
};
89
 
 
90
 
 
91
 
%{C++
92
 
/*
93
 
 * The three forms of NS_NewAtom and do_GetAtom (for use with
94
 
 * |nsCOMPtr<nsIAtom>|) return the atom for the string given.  At any
95
 
 * given time there will always be one atom representing a given string.
96
 
 * Atoms are intended to make string comparison cheaper by simplifying
97
 
 * it to pointer equality.  A pointer to the atom that does not own a
98
 
 * reference is not guaranteed to be valid.
99
 
 *
100
 
 * The three forms of NS_NewPermanentAtom and do_GetPermanentAtom return
101
 
 * the atom for the given string and ensure that the atom is permanent.
102
 
 * An atom that is permanent will exist (occupy space at a specific
103
 
 * location in memory) until XPCOM is shut down.  The advantage of
104
 
 * permanent atoms is that they do not need to maintain a reference
105
 
 * count, which requires locking and hurts performance.
106
 
 */
107
 
 
108
 
 
109
 
/**
110
 
 * Find an atom that matches the given UTF-8 string.
111
 
 * The string is assumed to be zero terminated.
112
 
 */
113
 
extern NS_COM nsIAtom* NS_NewAtom(const char* aUTF8String);
114
 
extern NS_COM nsIAtom* NS_NewPermanentAtom(const char* aUTF8String);
115
 
 
116
 
inline already_AddRefed<nsIAtom> do_GetAtom(const char* aUTF8String)
117
 
    { return NS_NewAtom(aUTF8String); }
118
 
inline already_AddRefed<nsIAtom> do_GetPermanentAtom(const char* aUTF8String)
119
 
    { return NS_NewPermanentAtom(aUTF8String); }
120
 
 
121
 
/**
122
 
 * Find an atom that matches the given UTF-8 string.
123
 
 */
124
 
extern NS_COM nsIAtom* NS_NewAtom(const nsACString& aUTF8String);
125
 
extern NS_COM nsIAtom* NS_NewPermanentAtom(const nsACString& aUTF8String);
126
 
 
127
 
inline already_AddRefed<nsIAtom> do_GetAtom(const nsACString& aUTF8String)
128
 
    { return NS_NewAtom(aUTF8String); }
129
 
inline already_AddRefed<nsIAtom> do_GetPermanentAtom(const nsACString& aUTF8String)
130
 
    { return NS_NewPermanentAtom(aUTF8String); }
131
 
 
132
 
/**
133
 
 * Find an atom that matches the given UTF-16 string.
134
 
 * The string is assumed to be zero terminated.
135
 
 */
136
 
extern NS_COM nsIAtom* NS_NewAtom(const PRUnichar* aUTF16String);
137
 
extern NS_COM nsIAtom* NS_NewPermanentAtom(const PRUnichar* aUTF16String);
138
 
 
139
 
inline already_AddRefed<nsIAtom> do_GetAtom(const PRUnichar* aUTF16String)
140
 
    { return NS_NewAtom(aUTF16String); }
141
 
inline already_AddRefed<nsIAtom> do_GetPermanentAtom(const PRUnichar* aUTF16String)
142
 
    { return NS_NewPermanentAtom(aUTF16String); }
143
 
 
144
 
/**
145
 
 * Find an atom that matches the given UTF-16 string.
146
 
 */
147
 
extern NS_COM nsIAtom* NS_NewAtom(const nsAString& aUTF16String);
148
 
extern NS_COM nsIAtom* NS_NewPermanentAtom(const nsAString& aUTF16String);
149
 
 
150
 
inline already_AddRefed<nsIAtom> do_GetAtom(const nsAString& aUTF16String)
151
 
    { return NS_NewAtom(aUTF16String); }
152
 
inline already_AddRefed<nsIAtom> do_GetPermanentAtom(const nsAString& aUTF16String)
153
 
    { return NS_NewPermanentAtom(aUTF16String); }
154
 
 
155
 
/**
156
 
 * Return a count of the total number of atoms currently
157
 
 * alive in the system.
158
 
 */
159
 
extern NS_COM nsrefcnt NS_GetNumberOfAtoms(void);
160
 
 
161
 
%}