Find reading list entry state in model from url

ios/chrome/browser/reading_list/reading_list_model.h

 // 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>
@@ skipping 10 matching lines @@
 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;
+
+  // The entry is either NOT_PRESENT in the model, in the READ part or in the
+  // UNREAD part of the model.
+  enum EntryState { NOT_PRESENT, READ, UNREAD };
+
   // 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.
@@ skipping 32 matching lines @@
 
   // 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;
 
+  // Return the state of the entry in the model (not present, read or unread).
+  virtual EntryState EntryStateByURL(const GURL& url) = 0;

[Olivier, 2016/09/27 08:55:33]

How will this be used differently from CallbackEntryURL ?

[gambard, 2016/09/27 15:59:34]

This is just to know if it exists an entry with this URL and if it does, if it
is read or unread.

[noyau (Ping after 24h), 2016/10/04 09:13:26]

There is no reason to have two methods doing the same thing. What you need is
one API returning the state (READ/UNREAD) and the entry itself. The simplest way
to do this is to change CallbackEntryURL (which could have a better name like
FindEntryByURL) to pass another argument to the callback to denote if it is in
the read or the unread list.

+
   // Methods to mutate an entry. Will locate the relevant entry by URL. Does
   // nothing if the entry is not found.
   virtual void SetEntryTitle(const GURL& url, const std::string& title) = 0;
   virtual void SetEntryDistilledURL(const GURL& url,
                                     const GURL& distilled_url) = 0;
   virtual void SetEntryDistilledState(
       const GURL& url,
       ReadingListEntry::DistillationState state) = 0;
 
   // Observer registration methods.
@@ skipping 25 matching lines @@
   // 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_