blob: 8c4c98f335052b19761cec478f4e6b302deb0779 (
plain)
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
|
// Copyright 2016 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 IOS_CHROME_BROWSER_READING_LIST_READING_LIST_MODEL_H_
#define IOS_CHROME_BROWSER_READING_LIST_READING_LIST_MODEL_H_
#include <memory>
#include <string>
#include <vector>
#include "base/observer_list.h"
#include "ios/chrome/browser/reading_list/reading_list_model_observer.h"
class GURL;
class ReadingListEntry;
class ReadingListModel;
namespace ios {
class ChromeBrowserState;
}
// The reading list model contains two list of entries: one of unread urls, the
// other of read ones. This object should only be accessed from one thread
// (Usually the main thread). The observers callbacks are also sent on the main
// thread.
class ReadingListModel {
public:
class ScopedReadingListBatchUpdate;
// Returns true if the model finished loading. Until this returns true the
// reading list is not ready for use.
virtual bool loaded() const = 0;
// Returns true if the model is performing batch updates right now.
bool IsPerformingBatchUpdates() const;
// Tells model to prepare for batch updates.
// This method is reentrant, i.e. several batch updates may take place at the
// same time.
// Returns a scoped batch update object that should be retained while the
// batch update is performed. Deallocating this object will inform model that
// the batch update has completed.
std::unique_ptr<ScopedReadingListBatchUpdate> BeginBatchUpdates();
// Returns the size of read and unread entries.
virtual size_t unread_size() const = 0;
virtual size_t read_size() const = 0;
// Returns true if there are entries in the model that were not seen by the
// user yet. Reset to true when new unread entries are added. Reset to false
// when ResetUnseenEntries is called.
virtual bool HasUnseenEntries() const = 0;
virtual void ResetUnseenEntries() = 0;
// Returns a specific entry.
virtual const ReadingListEntry& GetUnreadEntryAtIndex(size_t index) const = 0;
virtual const ReadingListEntry& GetReadEntryAtIndex(size_t index) const = 0;
// Adds |url| at the top of the unread entries, and removes entries with the
// same |url| from everywhere else if they exist. The addition may be
// asynchronous, and the data will be available only once the observers are
// notified.
virtual const ReadingListEntry& AddEntry(const GURL& url,
const std::string& title) = 0;
// Removes an entry. The removal may be asynchronous, and not happen
// immediately.
virtual void RemoveEntryByUrl(const GURL& url) = 0;
// If the |url| is in the reading list and unread, mark it read. If it is in
// the reading list and read, move it to the top of unread if it is not here
// already. This may trigger deletion of old read entries.
virtual void MarkReadByURL(const GURL& url) = 0;
// Observer registration methods.
void AddObserver(ReadingListModelObserver* observer);
void RemoveObserver(ReadingListModelObserver* observer);
// Helper class that is used to scope batch updates.
class ScopedReadingListBatchUpdate {
public:
explicit ScopedReadingListBatchUpdate(ReadingListModel* model)
: model_(model) {}
~ScopedReadingListBatchUpdate() { model_->EndBatchUpdates(); }
private:
ReadingListModel* model_;
DISALLOW_COPY_AND_ASSIGN(ScopedReadingListBatchUpdate);
};
protected:
ReadingListModel();
virtual ~ReadingListModel();
// The observers.
base::ObserverList<ReadingListModelObserver> observers_;
// Tells model that batch updates have completed. Called from
// ReadingListBatchUpdateToken dtor.
virtual void EndBatchUpdates();
private:
unsigned int current_batch_updates_count_;
DISALLOW_COPY_AND_ASSIGN(ReadingListModel);
};
#endif // IOS_CHROME_BROWSER_READING_LIST_READING_LIST_MODEL_H_
|
