/usr/include/deal.II/base/smartpointer.h is in libdeal.ii-dev 6.3.1-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 | //---------------------------------------------------------------------------
// $Id: smartpointer.h 19894 2009-10-15 22:19:51Z kanschat $
// Version: $Name$
//
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2009 by the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__smartpointer_h
#define __deal2__smartpointer_h
#include <base/config.h>
#include <base/subscriptor.h>
DEAL_II_NAMESPACE_OPEN
/**
* Smart pointers avoid destruction of an object in use. They can be used just
* like a pointer (i.e. using the <tt>*</tt> and <tt>-></tt> operators and through casting)
* but make sure that the object pointed to is not deleted in the course of
* use of the pointer by signalling the pointee its use.
*
* Objects pointed to, that is ,the class T, should inherit
* Subscriptor or must implement the same functionality. Null pointers
* are an exception from this rule and are allowed, too.
*
* The second template argument P only serves a single purpose: if a
* constructor without a debug string is used, then the name of P is
* used as the debug string.
*
* SmartPointer does NOT implement any memory handling! Especially,
* deleting a SmartPointer does not delete the object. Writing
* @code
* SmartPointer<T,P> dont_do_this = new T;
* @endcode
* is a sure way to program a memory leak! The secure version is
* @code
* T* p = new T;
* {
* SmartPointer<T,P> t(p);
* ...
* }
* delete p;
* @endcode
*
* Note that a smart pointer can handle <tt>const</tt>ness of an object, i.e.
* a <tt>SmartPointer<const ABC></tt> really behaves as if it were a pointer to
* a constant object (disallowing write access when dereferenced), while
* <tt>SmartPointer<ABC></tt> is a mutable pointer.
*
* @ingroup memory
* @author Guido Kanschat, Wolfgang Bangerth, 1998 - 2009
*/
template<typename T, typename P = void>
class SmartPointer
{
public:
/**
* Standard constructor for null
* pointer. The id of this
* pointer is set to the name of
* the class P.
*/
SmartPointer ();
/*
* Copy constructor for
* SmartPointer. We do now
* copy the object subscribed to
* from <tt>tt</tt>, but subscribe
* ourselves to it again.
*/
template <class Q>
SmartPointer (const SmartPointer<T,Q> &tt);
/*
* Copy constructor for
* SmartPointer. We do now
* copy the object subscribed to
* from <tt>tt</tt>, but subscribe
* ourselves to it again.
*/
SmartPointer (const SmartPointer<T,P> &tt);
/**
* Constructor taking a normal
* pointer. If possible, i.e. if
* the pointer is not a null
* pointer, the constructor
* subscribes to the given object
* to lock it, i.e. to prevent
* its destruction before the end
* of its use.
*
* The <tt>id</tt> is used in the
* call to
* Subscriptor::subscribe(id) and
* by ~SmartPointer() in the call
* to Subscriptor::unsubscribe().
*/
SmartPointer (T *t, const char* id);
/**
* Constructor taking a normal
* pointer. If possible, i.e. if
* the pointer is not a null
* pointer, the constructor
* subscribes to the given object
* to lock it, i.e. to prevent
* its destruction before the end
* of its use. The id of this
* pointer is set to the name of
* the class P.
*/
SmartPointer (T *t);
/**
* Destructor, removing the
* subscription.
*/
~SmartPointer();
/**
* Assignment operator for normal
* pointers. The pointer
* subscribes to the new object
* automatically and unsubscribes
* to an old one if it exists. It
* will not try to subscribe to a
* null-pointer, but stilll
* delete the old subscription.
*/
SmartPointer<T,P> & operator= (T *tt);
/**
* Assignment operator for
* SmartPointer. The pointer
* subscribes to the new object
* automatically and unsubscribes
* to an old one if it exists.
*/
template <class Q>
SmartPointer<T,P> & operator= (const SmartPointer<T,Q> &tt);
/**
* Assignment operator for
* SmartPointer. The pointer
* subscribes to the new object
* automatically and unsubscribes
* to an old one if it exists.
*/
SmartPointer<T,P> & operator= (const SmartPointer<T,P> &tt);
/**
* Conversion to normal pointer.
*/
operator T* () const;
/**
* Dereferencing operator. This
* operator throws an
* ExcNotInitialized if the
* pointer is a null pointer.
*/
T& operator * () const;
/**
* Dereferencing operator. This
* operator throws an
* ExcNotInitialized if the
* pointer is a null pointer.
*/
T * operator -> () const;
/**
* Exchange the pointers of this
* object and the argument. Since
* both the objects to which is
* pointed are subscribed to
* before and after, we do not
* have to change their
* subscription counters.
*
* Note that this function (with
* two arguments) and the
* respective functions where one
* of the arguments is a pointer
* and the other one is a C-style
* pointer are implemented in
* global namespace.
*/
template <class Q>
void swap (SmartPointer<T,Q> &tt);
/**
* Swap pointers between this
* object and the pointer
* given. As this releases the
* object pointed to presently,
* we reduce its subscription
* count by one, and increase it
* at the object which we will
* point to in the future.
*
* Note that we indeed need a
* reference of a pointer, as we
* want to change the pointer
* variable which we are given.
*/
void swap (T *&tt);
/**
* Return an estimate of the
* amount of memory (in bytes)
* used by this class. Note in
* particular, that this only
* includes the amount of memory
* used by <b>this</b> object, not
* by the object pointed to.
*/
unsigned int memory_consumption () const;
private:
/**
* Pointer to the object we want
* to subscribt to. Since it is
* often necessary to follow this
* pointer when debugging, we
* have deliberately chosen a
* short name.
*/
T * t;
/**
* The identification for the
* subscriptor.
*/
const char* const id;
};
/* --------------------------- inline Template functions ------------------------------*/
template <typename T, typename P>
inline
SmartPointer<T,P>::SmartPointer ()
:
t (0), id(typeid(P).name())
{}
template <typename T, typename P>
inline
SmartPointer<T,P>::SmartPointer (T *t)
:
t (t), id(typeid(P).name())
{
if (t != 0)
t->subscribe(id);
}
template <typename T, typename P>
inline
SmartPointer<T,P>::SmartPointer (T *t, const char* id)
:
t (t), id(id)
{
if (t != 0)
t->subscribe(id);
}
template <typename T, typename P>
template <class Q>
inline
SmartPointer<T,P>::SmartPointer (const SmartPointer<T,Q> &tt)
:
t (tt.t), id(tt.id)
{
if (t != 0)
t->subscribe(id);
}
template <typename T, typename P>
inline
SmartPointer<T,P>::SmartPointer (const SmartPointer<T,P> &tt)
:
t (tt.t), id(tt.id)
{
if (t != 0)
t->subscribe(id);
}
template <typename T, typename P>
inline
SmartPointer<T,P>::~SmartPointer ()
{
if (t != 0)
t->unsubscribe(id);
}
template <typename T, typename P>
inline
SmartPointer<T,P> & SmartPointer<T,P>::operator = (T *tt)
{
// optimize if no real action is
// requested
if (t == tt)
return *this;
if (t != 0)
t->unsubscribe(id);
t = tt;
if (tt != 0)
tt->subscribe(id);
return *this;
}
template <typename T, typename P>
template <class Q>
inline
SmartPointer<T,P> &
SmartPointer<T,P>::operator = (const SmartPointer<T,Q>& tt)
{
// if objects on the left and right
// hand side of the operator= are
// the same, then this is a no-op
if (&tt == this)
return *this;
if (t != 0)
t->unsubscribe(id);
t = static_cast<T*>(tt);
if (tt != 0)
tt->subscribe(id);
return *this;
}
template <typename T, typename P>
inline
SmartPointer<T,P> &
SmartPointer<T,P>::operator = (const SmartPointer<T,P>& tt)
{
// if objects on the left and right
// hand side of the operator= are
// the same, then this is a no-op
if (&tt == this)
return *this;
if (t != 0)
t->unsubscribe(id);
t = static_cast<T*>(tt);
if (tt != 0)
tt->subscribe(id);
return *this;
}
template <typename T, typename P>
inline
SmartPointer<T,P>::operator T* () const
{
return t;
}
template <typename T, typename P>
inline
T & SmartPointer<T,P>::operator * () const
{
Assert(t != 0, ExcNotInitialized());
return *t;
}
template <typename T, typename P>
inline
T * SmartPointer<T,P>::operator -> () const
{
Assert(t != 0, ExcNotInitialized());
return t;
}
template <typename T, typename P>
template <class Q>
inline
void SmartPointer<T,P>::swap (SmartPointer<T,Q> &tt)
{
#ifdef DEBUG
SmartPointer<T,P> aux(t,id);
*this = tt;
tt = aux;
#else
std::swap (t, tt.t);
#endif
}
template <typename T, typename P>
inline
void SmartPointer<T,P>::swap (T *&tt)
{
if (t != 0)
t->unsubscribe (id);
std::swap (t, tt);
if (t != 0)
t->subscribe (id);
}
template <typename T, typename P>
inline
unsigned int SmartPointer<T,P>::memory_consumption () const
{
return sizeof(SmartPointer<T,P>);
}
/**
* Global function to swap the contents of two smart pointers. As both
* objects to which the pointers point retain to be subscribed to, we
* do not have to change their subscription count.
*/
template <typename T, typename P, class Q>
inline
void swap (SmartPointer<T,P> &t1, SmartPointer<T,Q> &t2)
{
t1.swap (t2);
}
/**
* Global function to swap the contents of a smart pointer and a
* C-style pointer.
*
* Note that we indeed need a reference of a pointer, as we want to
* change the pointer variable which we are given.
*/
template <typename T, typename P>
inline
void swap (SmartPointer<T,P> &t1, T *&t2)
{
t1.swap (t2);
}
/**
* Global function to swap the contents of a C-style pointer and a
* smart pointer.
*
* Note that we indeed need a reference of a pointer, as we want to
* change the pointer variable which we are given.
*/
template <typename T, typename P>
inline
void swap (T *&t1, SmartPointer<T,P> &t2)
{
t2.swap (t1);
}
DEAL_II_NAMESPACE_CLOSE
#endif
|