<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.8: uobject.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<h1>uobject.h</h1><a href="uobject_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">******************************************************************************</span>
<a name="l00003"></a>00003 <span class="comment">*</span>
<a name="l00004"></a>00004 <span class="comment">* Copyright (C) 2002-2007, International Business Machines</span>
<a name="l00005"></a>00005 <span class="comment">* Corporation and others. All Rights Reserved.</span>
<a name="l00006"></a>00006 <span class="comment">*</span>
<a name="l00007"></a>00007 <span class="comment">******************************************************************************</span>
<a name="l00008"></a>00008 <span class="comment">* file name: uobject.h</span>
<a name="l00009"></a>00009 <span class="comment">* encoding: US-ASCII</span>
<a name="l00010"></a>00010 <span class="comment">* tab size: 8 (not used)</span>
<a name="l00011"></a>00011 <span class="comment">* indentation:4</span>
<a name="l00012"></a>00012 <span class="comment">*</span>
<a name="l00013"></a>00013 <span class="comment">* created on: 2002jun26</span>
<a name="l00014"></a>00014 <span class="comment">* created by: Markus W. Scherer</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef __UOBJECT_H__</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __UOBJECT_H__</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="utypes_8h.html">unicode/utypes.h</a>"</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <a class="code" href="uversion_8h.html#7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a>
<a name="l00023"></a>00023
<a name="l00039"></a>00039 <span class="preprocessor">#ifndef U_OVERRIDE_CXX_ALLOCATION</span>
<a name="l00040"></a><a class="code" href="uobject_8h.html#9ebf67ac651933234388f16add656f75">00040</a> <span class="preprocessor"></span><span class="preprocessor">#define U_OVERRIDE_CXX_ALLOCATION 1</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span>
<a name="l00048"></a>00048 <span class="preprocessor">#ifndef U_HAVE_PLACEMENT_NEW</span>
<a name="l00049"></a><a class="code" href="uobject_8h.html#0f8af19e82b45be1de86ad402c164541">00049</a> <span class="preprocessor"></span><span class="preprocessor">#define U_HAVE_PLACEMENT_NEW 1</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span>
<a name="l00052"></a>00052
<a name="l00058"></a>00058 <span class="preprocessor">#ifndef U_HAVE_DEBUG_LOCATION_NEW</span>
<a name="l00059"></a><a class="code" href="uobject_8h.html#80b308fe1f841cb450772f58197ef018">00059</a> <span class="preprocessor"></span><span class="preprocessor">#define U_HAVE_DEBUG_LOCATION_NEW 0</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span>
<a name="l00077"></a><a class="code" href="classUMemory.html">00077</a> <span class="keyword">class </span><a class="code" href="utypes_8h.html#559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a> <a class="code" href="classUMemory.html">UMemory</a> {
<a name="l00078"></a>00078 <span class="keyword">public</span>:
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="preprocessor">#if U_OVERRIDE_CXX_ALLOCATION</span>
<a name="l00081"></a>00081 <span class="preprocessor"></span>
<a name="l00089"></a>00089 <span class="keyword">static</span> <span class="keywordtype">void</span> * <a class="code" href="platform_8h.html#72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> operator new(size_t size);
<a name="l00090"></a>00090
<a name="l00096"></a>00096 <span class="keyword">static</span> <span class="keywordtype">void</span> * <a class="code" href="platform_8h.html#72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> operator new[](size_t size);
<a name="l00097"></a>00097
<a name="l00106"></a>00106 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> operator delete(<span class="keywordtype">void</span> *p);
<a name="l00107"></a>00107
<a name="l00113"></a>00113 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> operator delete[](<span class="keywordtype">void</span> *p);
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="preprocessor">#if U_HAVE_PLACEMENT_NEW</span>
<a name="l00116"></a>00116 <span class="preprocessor"></span>
<a name="l00121"></a><a class="code" href="classUMemory.html#43b5221fe429f77230b2040f8724c154">00121</a> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> * <a class="code" href="platform_8h.html#72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> operator new(size_t, <span class="keywordtype">void</span> *ptr) { <span class="keywordflow">return</span> ptr; }
<a name="l00122"></a>00122
<a name="l00128"></a><a class="code" href="classUMemory.html#9b746b0cdb49c8f8907773002ea5c4ea">00128</a> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> operator delete(<span class="keywordtype">void</span> *, <span class="keywordtype">void</span> *) {}
<a name="l00129"></a>00129 <span class="preprocessor">#endif </span><span class="comment">/* U_HAVE_PLACEMENT_NEW */</span>
<a name="l00130"></a>00130 <span class="preprocessor">#if U_HAVE_DEBUG_LOCATION_NEW</span>
<a name="l00131"></a>00131 <span class="preprocessor"></span>
<a name="l00138"></a>00138 <span class="keyword">static</span> <span class="keywordtype">void</span> * <a class="code" href="platform_8h.html#72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> operator new(size_t size, <span class="keyword">const</span> <span class="keywordtype">char</span>* file, <span class="keywordtype">int</span> line);
<a name="l00146"></a>00146 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> operator delete(<span class="keywordtype">void</span>* p, <span class="keyword">const</span> <span class="keywordtype">char</span>* file, <span class="keywordtype">int</span> line);
<a name="l00147"></a>00147 <span class="preprocessor">#endif </span><span class="comment">/* U_HAVE_DEBUG_LOCATION_NEW */</span>
<a name="l00148"></a>00148 <span class="preprocessor">#endif </span><span class="comment">/* U_OVERRIDE_CXX_ALLOCATION */</span>
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="comment">/*</span>
<a name="l00151"></a>00151 <span class="comment"> * Assignment operator not declared. The compiler will provide one</span>
<a name="l00152"></a>00152 <span class="comment"> * which does nothing since this class does not contain any data members.</span>
<a name="l00153"></a>00153 <span class="comment"> * API/code coverage may show the assignment operator as present and</span>
<a name="l00154"></a>00154 <span class="comment"> * untested - ignore.</span>
<a name="l00155"></a>00155 <span class="comment"> * Subclasses need this assignment operator if they use compiler-provided</span>
<a name="l00156"></a>00156 <span class="comment"> * assignment operators of their own. An alternative to not declaring one</span>
<a name="l00157"></a>00157 <span class="comment"> * here would be to declare and empty-implement a protected or public one.</span>
<a name="l00158"></a>00158 <span class="comment"> UMemory &UMemory::operator=(const UMemory &);</span>
<a name="l00159"></a>00159 <span class="comment"> */</span>
<a name="l00160"></a>00160 };
<a name="l00161"></a>00161
<a name="l00184"></a><a class="code" href="classUObject.html">00184</a> <span class="keyword">class </span><a class="code" href="utypes_8h.html#559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a> UObject : <span class="keyword">public</span> <a class="code" href="classUMemory.html">UMemory</a> {
<a name="l00185"></a>00185 <span class="keyword">public</span>:
<a name="l00191"></a>00191 <span class="keyword">virtual</span> ~UObject();
<a name="l00192"></a>00192
<a name="l00198"></a>00198 <span class="keyword">virtual</span> <a class="code" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> getDynamicClassID() <span class="keyword">const </span>= 0;
<a name="l00199"></a>00199
<a name="l00200"></a>00200 <span class="keyword">protected</span>:
<a name="l00201"></a>00201 <span class="comment">// the following functions are protected to prevent instantiation and</span>
<a name="l00202"></a>00202 <span class="comment">// direct use of UObject itself</span>
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <span class="comment">// default constructor</span>
<a name="l00205"></a>00205 <span class="comment">// commented out because UObject is abstract (see getDynamicClassID)</span>
<a name="l00206"></a>00206 <span class="comment">// inline UObject() {}</span>
<a name="l00207"></a>00207
<a name="l00208"></a>00208 <span class="comment">// copy constructor</span>
<a name="l00209"></a>00209 <span class="comment">// commented out because UObject is abstract (see getDynamicClassID)</span>
<a name="l00210"></a>00210 <span class="comment">// inline UObject(const UObject &other) {}</span>
<a name="l00211"></a>00211
<a name="l00212"></a>00212 <span class="preprocessor">#if 0</span>
<a name="l00213"></a>00213 <span class="preprocessor"></span> <span class="comment">// TODO Sometime in the future. Implement operator==().</span>
<a name="l00214"></a>00214 <span class="comment">// (This comment inserted in 2.2)</span>
<a name="l00215"></a>00215 <span class="comment">// some or all of the following "boilerplate" functions may be made public</span>
<a name="l00216"></a>00216 <span class="comment">// in a future ICU4C release when all subclasses implement them</span>
<a name="l00217"></a>00217
<a name="l00218"></a>00218 <span class="comment">// assignment operator</span>
<a name="l00219"></a>00219 <span class="comment">// (not virtual, see "Taligent's Guide to Designing Programs" pp.73..74)</span>
<a name="l00220"></a>00220 <span class="comment">// commented out because the implementation is the same as a compiler's default</span>
<a name="l00221"></a>00221 <span class="comment">// UObject &operator=(const UObject &other) { return *this; }</span>
<a name="l00222"></a>00222
<a name="l00223"></a>00223 <span class="comment">// comparison operators</span>
<a name="l00224"></a>00224 <span class="keyword">virtual</span> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> operator==(<span class="keyword">const</span> UObject &other)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">this</span>==&other; }
<a name="l00225"></a>00225 <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> operator!=(<span class="keyword">const</span> UObject &other)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !operator==(other); }
<a name="l00226"></a>00226
<a name="l00227"></a>00227 <span class="comment">// clone() commented out from the base class:</span>
<a name="l00228"></a>00228 <span class="comment">// some compilers do not support co-variant return types</span>
<a name="l00229"></a>00229 <span class="comment">// (i.e., subclasses would have to return UObject * as well, instead of SubClass *)</span>
<a name="l00230"></a>00230 <span class="comment">// see also UObject class documentation.</span>
<a name="l00231"></a>00231 <span class="comment">// virtual UObject *clone() const;</span>
<a name="l00232"></a>00232 <span class="preprocessor">#endif</span>
<a name="l00233"></a>00233 <span class="preprocessor"></span>
<a name="l00234"></a>00234 <span class="comment">/*</span>
<a name="l00235"></a>00235 <span class="comment"> * Assignment operator not declared. The compiler will provide one</span>
<a name="l00236"></a>00236 <span class="comment"> * which does nothing since this class does not contain any data members.</span>
<a name="l00237"></a>00237 <span class="comment"> * API/code coverage may show the assignment operator as present and</span>
<a name="l00238"></a>00238 <span class="comment"> * untested - ignore.</span>
<a name="l00239"></a>00239 <span class="comment"> * Subclasses need this assignment operator if they use compiler-provided</span>
<a name="l00240"></a>00240 <span class="comment"> * assignment operators of their own. An alternative to not declaring one</span>
<a name="l00241"></a>00241 <span class="comment"> * here would be to declare and empty-implement a protected or public one.</span>
<a name="l00242"></a>00242 <span class="comment"> UObject &UObject::operator=(const UObject &);</span>
<a name="l00243"></a>00243 <span class="comment"> */</span>
<a name="l00244"></a>00244
<a name="l00245"></a>00245 <span class="comment">// Future implementation for RTTI that support subtyping. [alan]</span>
<a name="l00246"></a>00246 <span class="comment">// </span>
<a name="l00247"></a>00247 <span class="comment">// public:</span>
<a name="l00248"></a>00248 <span class="comment">// /**</span>
<a name="l00249"></a>00249 <span class="comment">// * @internal</span>
<a name="l00250"></a>00250 <span class="comment">// */</span>
<a name="l00251"></a>00251 <span class="comment">// static UClassID getStaticClassID();</span>
<a name="l00252"></a>00252 <span class="comment">// </span>
<a name="l00253"></a>00253 <span class="comment">// /**</span>
<a name="l00254"></a>00254 <span class="comment">// * @internal</span>
<a name="l00255"></a>00255 <span class="comment">// */</span>
<a name="l00256"></a>00256 <span class="comment">// UBool instanceOf(UClassID type) const;</span>
<a name="l00257"></a>00257 };
<a name="l00258"></a>00258
<a name="l00266"></a><a class="code" href="uobject_8h.html#0415b3e188980bcb82e31c091265f34b">00266</a> <span class="preprocessor">#define UOBJECT_DEFINE_RTTI_IMPLEMENTATION(myClass) \</span>
<a name="l00267"></a>00267 <span class="preprocessor"> UClassID U_EXPORT2 myClass::getStaticClassID() { \</span>
<a name="l00268"></a>00268 <span class="preprocessor"> static char classID = 0; \</span>
<a name="l00269"></a>00269 <span class="preprocessor"> return (UClassID)&classID; \</span>
<a name="l00270"></a>00270 <span class="preprocessor"> } \</span>
<a name="l00271"></a>00271 <span class="preprocessor"> UClassID myClass::getDynamicClassID() const \</span>
<a name="l00272"></a>00272 <span class="preprocessor"> { return myClass::getStaticClassID(); }</span>
<a name="l00273"></a>00273 <span class="preprocessor"></span>
<a name="l00274"></a>00274
<a name="l00283"></a><a class="code" href="uobject_8h.html#a53bdd883d784e4c951b051faffc29d0">00283</a> <span class="preprocessor">#define UOBJECT_DEFINE_ABSTRACT_RTTI_IMPLEMENTATION(myClass) \</span>
<a name="l00284"></a>00284 <span class="preprocessor"> UClassID U_EXPORT2 myClass::getStaticClassID() { \</span>
<a name="l00285"></a>00285 <span class="preprocessor"> static char classID = 0; \</span>
<a name="l00286"></a>00286 <span class="preprocessor"> return (UClassID)&classID; \</span>
<a name="l00287"></a>00287 <span class="preprocessor"> }</span>
<a name="l00288"></a>00288 <span class="preprocessor"></span>
<a name="l00289"></a>00289 <span class="comment">// /**</span>
<a name="l00290"></a>00290 <span class="comment">// * This macro adds ICU RTTI to an ICU concrete class implementation.</span>
<a name="l00291"></a>00291 <span class="comment">// * This macro should be invoked in *.cpp files. The corresponding</span>
<a name="l00292"></a>00292 <span class="comment">// * header should declare getDynamicClassID and getStaticClassID.</span>
<a name="l00293"></a>00293 <span class="comment">// *</span>
<a name="l00294"></a>00294 <span class="comment">// * @param myClass The name of the class that needs RTTI defined.</span>
<a name="l00295"></a>00295 <span class="comment">// * @param myParent The name of the myClass's parent.</span>
<a name="l00296"></a>00296 <span class="comment">// * @internal</span>
<a name="l00297"></a>00297 <span class="comment">// */</span>
<a name="l00298"></a>00298 <span class="comment">/*#define UOBJECT_DEFINE_RTTI_IMPLEMENTATION(myClass, myParent) \</span>
<a name="l00299"></a>00299 <span class="comment"> UOBJECT_DEFINE_ABSTRACT_RTTI_IMPLEMENTATION(myClass, myParent) \</span>
<a name="l00300"></a>00300 <span class="comment"> UClassID myClass::getDynamicClassID() const { \</span>
<a name="l00301"></a>00301 <span class="comment"> return myClass::getStaticClassID(); \</span>
<a name="l00302"></a>00302 <span class="comment"> }</span>
<a name="l00303"></a>00303 <span class="comment">*/</span>
<a name="l00304"></a>00304
<a name="l00305"></a>00305
<a name="l00306"></a>00306 <a class="code" href="uversion_8h.html#3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a>
<a name="l00307"></a>00307
<a name="l00308"></a>00308 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 12:59:21 2007 for ICU 3.8 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
