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
|
// Copyright 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef SYNC_SYNCABLE_ENTRY_H_
#define SYNC_SYNCABLE_ENTRY_H_
#include "sync/base/sync_export.h"
#include "sync/syncable/entry_kernel.h"
namespace syncer {
class Cryptographer;
class ReadNode;
namespace syncable {
class Directory;
class BaseTransaction;
// A read-only meta entry
// Instead of:
// Entry e = transaction.GetById(id);
// use:
// Entry e(transaction, GET_BY_ID, id);
//
// Why? The former would require a copy constructor, and it would be difficult
// to enforce that an entry never outlived its transaction if there were a copy
// constructor.
enum GetById {
GET_BY_ID
};
enum GetByClientTag {
GET_BY_CLIENT_TAG
};
enum GetByServerTag {
GET_BY_SERVER_TAG
};
enum GetByHandle {
GET_BY_HANDLE
};
class SYNC_EXPORT Entry {
public:
// After constructing, you must check good() to test whether the Get
// succeeded.
Entry(BaseTransaction* trans, GetByHandle, int64 handle);
Entry(BaseTransaction* trans, GetById, const Id& id);
Entry(BaseTransaction* trans, GetByServerTag, const std::string& tag);
Entry(BaseTransaction* trans, GetByClientTag, const std::string& tag);
bool good() const { return 0 != kernel_; }
BaseTransaction* trans() const { return basetrans_; }
// Field accessors.
inline int64 Get(MetahandleField field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
inline Id Get(IdField field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
inline int64 Get(Int64Field field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
inline const base::Time& Get(TimeField field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
inline int64 Get(BaseVersion field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
inline bool Get(IndexedBitField field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
inline bool Get(IsDelField field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
inline bool Get(BitField field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
const std::string& Get(StringField field) const;
inline const sync_pb::EntitySpecifics& Get(ProtoField field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
inline const UniquePosition& Get(UniquePositionField field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
inline bool Get(BitTemp field) const {
DCHECK(kernel_);
return kernel_->ref(field);
}
ModelType GetServerModelType() const;
ModelType GetModelType() const;
Id GetPredecessorId() const;
Id GetSuccessorId() const;
Id GetFirstChildId() const;
// Returns a vector of this node's children's handles.
// Clears |result| if there are no children. If this node is of a type that
// supports user-defined ordering then the resulting vector will be in the
// proper order.
void GetChildHandles(std::vector<int64>* result) const;
inline bool ExistsOnClientBecauseNameIsNonEmpty() const {
DCHECK(kernel_);
return !kernel_->ref(NON_UNIQUE_NAME).empty();
}
inline bool IsRoot() const {
DCHECK(kernel_);
return kernel_->ref(ID).IsRoot();
}
// Returns true if this is an entry that is expected to maintain a certain
// sort ordering relative to its siblings under the same parent.
bool ShouldMaintainPosition() const;
Directory* dir() const;
const EntryKernel GetKernelCopy() const {
return *kernel_;
}
// Dumps all entry info into a DictionaryValue and returns it.
// Transfers ownership of the DictionaryValue to the caller.
base::DictionaryValue* ToValue(Cryptographer* cryptographer) const;
protected: // Don't allow creation on heap, except by sync API wrappers.
void* operator new(size_t size) { return (::operator new)(size); }
inline explicit Entry(BaseTransaction* trans)
: basetrans_(trans),
kernel_(NULL) { }
protected:
BaseTransaction* const basetrans_;
EntryKernel* kernel_;
private:
friend class Directory;
friend class syncer::ReadNode;
friend std::ostream& operator << (std::ostream& s, const Entry& e);
DISALLOW_COPY_AND_ASSIGN(Entry);
};
std::ostream& operator<<(std::ostream& os, const Entry& entry);
} // namespace syncable
} // namespace syncer
#endif // SYNC_SYNCABLE_ENTRY_H_
|
