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
|
/*
Copyright (C) 2010 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __libpbd_property_basics_h__
#define __libpbd_property_basics_h__
#include <glib.h>
#include <set>
#include "pbd/xml++.h"
class Command;
namespace PBD {
class PropertyList;
/** A unique identifier for a property of a Stateful object */
typedef GQuark PropertyID;
template<typename T>
struct PropertyDescriptor {
PropertyDescriptor () : property_id (0) {}
PropertyDescriptor (PropertyID pid) : property_id (pid) {}
PropertyID property_id;
typedef T value_type;
};
/** A list of IDs of Properties that have changed in some situation or other */
class PropertyChange : public std::set<PropertyID>
{
public:
PropertyChange() {}
template<typename T> PropertyChange(PropertyDescriptor<T> p);
PropertyChange(const PropertyChange& other) : std::set<PropertyID> (other) {}
PropertyChange operator=(const PropertyChange& other) {
clear ();
insert (other.begin (), other.end ());
return *this;
}
template<typename T> PropertyChange operator=(PropertyDescriptor<T> p);
template<typename T> bool contains (PropertyDescriptor<T> p) const;
bool contains (const PropertyChange& other) const {
for (const_iterator x = other.begin (); x != other.end (); ++x) {
if (find (*x) != end ()) {
return true;
}
}
return false;
}
void add (PropertyID id) { insert (id); }
void add (const PropertyChange& other) { insert (other.begin (), other.end ()); }
template<typename T> void add (PropertyDescriptor<T> p);
};
/** Base (non template) part of Property */
class PropertyBase
{
public:
PropertyBase (PropertyID pid)
: _property_id (pid)
{}
virtual ~PropertyBase () {}
/** Forget about any old value for this state */
virtual void clear_history () = 0;
/** Get any change in this property as XML and add it to a node */
virtual void get_change (XMLNode *) const = 0;
/** Add information to two property lists: one that allows
* undo of the changes in this property's state betwen now and
* the last call to clear_history, and one that allows redo
* of those changes.
*/
virtual void diff (PropertyList& undo, PropertyList& redo, Command*) const = 0;
virtual PropertyBase* maybe_clone_self_if_found_in_history_node (const XMLNode&) const { return 0; }
/** Set our value from an XML node.
* @return true if the value was set.
*/
virtual bool set_value (XMLNode const &) = 0;
/** Get our value and put it into an XML node */
virtual void get_value (XMLNode& node) const = 0;
/** @return true if this property has changed in value since construction or since
* the last call to clear_history(), whichever was more recent.
*/
virtual bool changed() const = 0;
/** Apply a change contained in another Property to this one */
virtual void apply_change (PropertyBase const *) = 0;
const gchar*property_name () const { return g_quark_to_string (_property_id); }
PropertyID property_id () const { return _property_id; }
bool operator==(PropertyID pid) const {
return _property_id == pid;
}
protected:
PropertyID _property_id;
};
}
#endif /* __libpbd_property_basics_h__ */
|
