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
|
/*
** ClanLib SDK
** Copyright (c) 1997-2005 The ClanLib Team
**
** This software is provided 'as-is', without any express or implied
** warranty. In no event will the authors be held liable for any damages
** arising from the use of this software.
**
** Permission is granted to anyone to use this software for any purpose,
** including commercial applications, and to alter it and redistribute it
** freely, subject to the following restrictions:
**
** 1. The origin of this software must not be misrepresented; you must not
** claim that you wrote the original software. If you use this software
** in a product, an acknowledgment in the product documentation would be
** appreciated but is not required.
** 2. Altered source versions must be plainly marked as such, and must not be
** misrepresented as being the original software.
** 3. This notice may not be removed or altered from any source distribution.
**
** Note: Some of the libraries ClanLib may link to may have additional
** requirements or restrictions.
**
** File Author(s):
**
** Magnus Norddahl
** (if your name is missing here, please add it)
*/
//! clanCore="System"
//! header=core.h
#ifndef clanlib_lazycopyptr_header
#define clanlib_lazycopyptr_header
#include "sharedptr.h"
//: Copy-on-write pointer class (acts like CL_OwningPtr, except holds off actual copy until non-const dereference).
//- !group=Core/System!
//- !header=core.h!
//- <p> Use CL_LazyCopyPtr when you want stack-instance-like semantics for your data, but want to avoid
//- doing an actual copy of the data until it's neccessary, if ever. This is often useful for classes
//- containing implementation pointers with mutable data; the class might just be copied and the copy
//- destroyed without any actual change of the copy's data. If that were the case and the class was
//- using CL_LazyCopyPtr for its implementation pointer, an unneccessary copy would've been saved. </p>
//- <p> The way to take advantage of CL_LazyCopyPtr's lazy copying is to prefer const dereferences whenever
//- possible. If the CL_LazyCopyPtr is a member of a class, and the dereference is within a const method
//- of that class, then the const version of operator* or operator-> is automatically used. To dereference
//- the CL_LazyCopyPtr constly when not in a const method of a class owning the CL_LazyCopyPtr, use the cd() method. </p>
template <typename T, typename U = T> class CL_LazyCopyPtr
{
//! Construction:
public:
//: Constructs a CL_LazyCopyPtr.
//param t: A pointer which was the return value of a 'new' call.
//- <p> Once the assignment statement is finished when assigning a passed pointer,
//- the CL_OwningPtr takes full control over that data. The original pointer shouldn't
//- be used to access or delete the data anymore; instead, use the CL_OwningPtr. </p>
CL_LazyCopyPtr() {}
CL_LazyCopyPtr(T* t) : ptr(t) {}
//! Attributes:
public:
//: Returns true if this CL_LazyCopyPtr is not dereferencable.
bool is_null() const {return ptr.is_null();}
//: Returns number of references (including this one) to the data cache.
//- <p> Returns 0 if this pointer is null. </p>
//- <p> If your code depends on this, it may not be using LazyCopyPtr correctly.
//- The idea is that the user code shouldn't concern itself with whether or
//- not a copy has taken place, just trust that LazyCopyPtr will copy it if
//- neccessary. </p>
int get_ref_count() const {return ptr.ptr_ref_count();}
//: Gives access to the pointer itself.
//- <p> Be careful not to keep the returned pointer around after doing any
//- non-const operations on the CL_LazyCopyPtr; it could be invalid
//- after that.</p>
U* get() {return ptr.get();}
const U* get() const {return ptr.get();}
//! Operations:
public:
//: Copy assignment operator.
//param t: A pointer which was the return value of a 'new' call.
//- <p> Once the assignment statement is finished when assigning a passed pointer,
//- the CL_LazyCopyPtr takes full control over that data. The original pointer shouldn't
//- be used to access or delete the data anymore; instead, use the CL_LazyCopyPtr. </p>
CL_LazyCopyPtr<T, U>& operator=(T* t) {ptr = t; return *this; }
//: Dereferencing operator.
U& operator*() {uniquify(); return *ptr;}
U const& operator*() const {return *ptr;}
//: Forces a const dereference.
//- <p> Like operator*, but forces a const dereference even if in non-const context. </p>
U const& cd() const {return *ptr;}
//: Indirect member access operator.
U* operator->() {uniquify(); return ptr.operator->();}
U const* operator->() const {return ptr.operator->();}
//! Implementation:
private:
CL_SharedPtr<T, U> ptr;
//: Ensures that we are the only user of this data
void uniquify() {if (ptr.get_ref_count() > 1) ptr = CL_SharedPtr<T, U>((T*)(ptr->clone()));}
//Not to be called, this just ensures that T is derived from CL_Clonable
void dummy() {ptr->must_be_derived_from_cl_clonable();}
};
#endif
|
