offline_items_collection : Added helper class to determine progress

components/offline_items_collection/core/offline_item.h

 // Copyright 2017 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 COMPONENTS_OFFLINE_ITEMS_COLLECTION_CORE_OFFLINE_ITEM_H_
 #define COMPONENTS_OFFLINE_ITEMS_COLLECTION_CORE_OFFLINE_ITEM_H_
 
 #include <string>
 
+#include "base/optional.h"
 #include "base/time/time.h"
 #include "components/offline_items_collection/core/offline_item_filter.h"
 #include "components/offline_items_collection/core/offline_item_state.h"
 #include "ui/gfx/image/image.h"
 #include "url/gurl.h"
 
 namespace offline_items_collection {
 
 // An id that uniquely represents a piece of offline content.
 struct ContentId {
@@ skipping 11 matching lines @@
   ContentId(const ContentId& other);
   ContentId(const std::string& name_space, const std::string& id);
 
   ~ContentId();
 
   bool operator==(const ContentId& content_id) const;
 
   bool operator<(const ContentId& content_id) const;
 };
 
+// A Java counterpart will be generated for this enum.
+// GENERATED_JAVA_ENUM_PACKAGE: org.chromium.components.offline_items_collection
+enum class OfflineItemProgressUnit {
+  BYTES,
+  FILES,
+  PERCENTAGE,
+};
+
 // This struct holds the relevant pieces of information to represent an abstract
 // offline item to the front end.  This is meant to be backed by components that
 // need to both show content being offlined (downloading, saving, etc.) as well
 // as content that should be exposed as available offline (downloads, pages,
 // etc.).
 //
 // A new feature should expose these OfflineItems via an OfflineContentProvider.
 struct OfflineItem {
+  // This struct holds the essential pieces of information to compute the
+  // download progress for an offline item to display in the UI.
+  struct Progress {
+    Progress();
+    Progress(const Progress& other);
+    ~Progress();
+
+    bool operator==(const Progress& progress) const;
+
+    // Current value of the download progress.
+    int64_t value;
+
+    // The maximum value of the download progress. Absence of the value implies
+    // indeterminate progress.
+    base::Optional<int64_t> max;
+
+    // The unit of progress to be displayed in the UI.
+    OfflineItemProgressUnit unit;
+  };
+
   OfflineItem();
   OfflineItem(const OfflineItem& other);
   explicit OfflineItem(const ContentId& id);
 
   ~OfflineItem();
 
   bool operator==(const OfflineItem& offline_item) const;
 
   // The id of this OfflineItem.  Used to identify this item across all relevant
   // systems.
@@ skipping 56 matching lines @@
   bool is_resumable;
 
   // Whether or not this OfflineItem can be downloaded using a metered
   // connection.
   bool allow_metered;
 
   // The current amount of bytes received for this item.  This field is not used
   // if |state| is COMPLETE.
   int64_t received_bytes;
 
-  // How complete (from 0 to 100) the offlining process is for this item.  -1
-  // represents that progress cannot be determined for this item and an
-  // indeterminate progress bar should be used.  This field is not used if
+  // Represents the current progress of this item. This field is not used if
   // |state| is COMPLETE.
-  int percent_completed;
+  Progress progress;
 
   // The estimated time remaining for the download in milliseconds.  -1
   // represents an unknown time remaining.  This field is not used if |state| is
   // COMPLETE.
   int64_t time_remaining_ms;
 };
 
 // This struct holds any potentially expensive visuals for an OfflineItem.  If
 // the front end requires the visuals it will ask for them through the
 // OfflineContentProvider interface asynchronously to give the backend time to
@@ skipping 11 matching lines @@
 
   // The icon to use for displaying this item.  The icon should be 64dp x 64dp.
   // TODO(dtrainor): Suggest icon size based on the icon size supported by the
   // current OS.
   gfx::Image icon;
 };
 
 }  // namespace offline_items_collection
 
 #endif  // COMPONENTS_OFFLINE_ITEMS_COLLECTION_OFFLINE_ITEM_H_