| OLD | NEW |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 // | 4 // |
| 5 // Class for finding and caching Windows explorer icons. The IconManager | 5 // Class for finding and caching Windows explorer icons. The IconManager |
| 6 // lives on the UI thread but performs icon extraction work on the file thread | 6 // lives on the UI thread but performs icon extraction work on the file thread |
| 7 // to avoid blocking the UI thread with potentially expensive COM and disk | 7 // to avoid blocking the UI thread with potentially expensive COM and disk |
| 8 // operations. | 8 // operations. |
| 9 // | 9 // |
| 10 // Terminology | 10 // Terminology |
| (...skipping 16 matching lines...) Expand all Loading... |
| 27 // | 27 // |
| 28 // POSIX files don't have associated icons. We query the OS by the file's | 28 // POSIX files don't have associated icons. We query the OS by the file's |
| 29 // mime type. | 29 // mime type. |
| 30 // | 30 // |
| 31 // The IconManager can be queried in two ways: | 31 // The IconManager can be queried in two ways: |
| 32 // 1. A quick, synchronous check of its caches which does not touch the disk: | 32 // 1. A quick, synchronous check of its caches which does not touch the disk: |
| 33 // IconManager::LookupIcon() | 33 // IconManager::LookupIcon() |
| 34 // 2. An asynchronous icon load from a file on the file thread: | 34 // 2. An asynchronous icon load from a file on the file thread: |
| 35 // IconManager::LoadIcon() | 35 // IconManager::LoadIcon() |
| 36 // | 36 // |
| 37 // When using the second (asychronous) method, callers must supply a callback | 37 // When using the second (asynchronous) method, callers must supply a callback |
| 38 // which will be run once the icon has been extracted. The icon manager will | 38 // which will be run once the icon has been extracted. The icon manager will |
| 39 // cache the results of the icon extraction so that subsequent lookups will be | 39 // cache the results of the icon extraction so that subsequent lookups will be |
| 40 // fast. | 40 // fast. |
| 41 // | 41 // |
| 42 // Icon bitmaps returned should be treated as const since they may be referenced | 42 // Icon bitmaps returned should be treated as const since they may be referenced |
| 43 // by other clients. Make a copy of the icon if you need to modify it. | 43 // by other clients. Make a copy of the icon if you need to modify it. |
| 44 | 44 |
| 45 #ifndef CHROME_BROWSER_ICON_MANAGER_H_ | 45 #ifndef CHROME_BROWSER_ICON_MANAGER_H_ |
| 46 #define CHROME_BROWSER_ICON_MANAGER_H_ | 46 #define CHROME_BROWSER_ICON_MANAGER_H_ |
| 47 | 47 |
| 48 #include <map> | 48 #include <map> |
| 49 | 49 |
| 50 #include "base/files/file_path.h" | 50 #include "base/files/file_path.h" |
| 51 #include "base/macros.h" | 51 #include "base/macros.h" |
| 52 #include "base/task/cancelable_task_tracker.h" | 52 #include "base/task/cancelable_task_tracker.h" |
| 53 #include "chrome/browser/icon_loader.h" | 53 #include "chrome/browser/icon_loader.h" |
| 54 #include "ui/gfx/image/image.h" | 54 #include "ui/gfx/image/image.h" |
| 55 | 55 |
| 56 class IconManager : public IconLoader::Delegate { | 56 class IconManager : public IconLoader::Delegate { |
| 57 public: | 57 public: |
| 58 IconManager(); | 58 IconManager(); |
| 59 ~IconManager() override; | 59 ~IconManager() override; |
| 60 | 60 |
| 61 // Synchronous call to examine the internal caches for the icon. Returns the | 61 // Synchronous call to examine the internal caches for the icon. Returns the |
| 62 // icon if we have already loaded it, NULL if we don't have it and must load | 62 // icon if we have already loaded it, null if we don't have it and must load |
| 63 // it via 'LoadIcon'. The returned bitmap is owned by the IconManager and must | 63 // it via 'LoadIcon'. The returned bitmap is owned by the IconManager and must |
| 64 // not be free'd by the caller. If the caller needs to modify the icon, it | 64 // not be free'd by the caller. If the caller needs to modify the icon, it |
| 65 // must make a copy and modify the copy. | 65 // must make a copy and modify the copy. |
| 66 gfx::Image* LookupIconFromFilepath(const base::FilePath& file_name, | 66 gfx::Image* LookupIconFromFilepath(const base::FilePath& file_path, |
| 67 IconLoader::IconSize size); | 67 IconLoader::IconSize size); |
| 68 | 68 |
| 69 typedef base::Callback<void(gfx::Image*)> IconRequestCallback; | 69 using IconRequestCallback = base::Callback<void(gfx::Image*)>; |
| 70 | 70 |
| 71 // Asynchronous call to lookup and return the icon associated with file. The | 71 // Asynchronous call to lookup and return the icon associated with file. The |
| 72 // work is done on the file thread, with the callbacks running on the thread | 72 // work is done on the file thread, with the callbacks running on the thread |
| 73 // this function is called. | 73 // this function is called. |
| 74 // | 74 // |
| 75 // Note: | 75 // Note: |
| 76 // 1. This does *not* check the cache. | 76 // 1. This does *not* check the cache. |
| 77 // 2. The returned bitmap pointer is *not* owned by callback. So callback | 77 // 2. The returned bitmap pointer is *not* owned by callback. So callback |
| 78 // should never keep it or delete it. | 78 // should never keep it or delete it. |
| 79 // 3. The gfx::Image pointer passed to the callback may be NULL if decoding | 79 // 3. The gfx::Image pointer passed to the callback may be null if decoding |
| 80 // failed. | 80 // failed. |
| 81 base::CancelableTaskTracker::TaskId LoadIcon( | 81 base::CancelableTaskTracker::TaskId LoadIcon( |
| 82 const base::FilePath& file_name, | 82 const base::FilePath& file_name, |
| 83 IconLoader::IconSize size, | 83 IconLoader::IconSize size, |
| 84 const IconRequestCallback& callback, | 84 const IconRequestCallback& callback, |
| 85 base::CancelableTaskTracker* tracker); | 85 base::CancelableTaskTracker* tracker); |
| 86 | 86 |
| 87 // IconLoader::Delegate interface. | 87 // IconLoader::Delegate interface. |
| 88 bool OnGroupLoaded(IconLoader* loader, const IconGroupID& group) override; | 88 void OnImageLoaded(IconLoader* loader, |
| 89 bool OnImageLoaded(IconLoader* loader, | 89 std::unique_ptr<gfx::Image> result, |
| 90 gfx::Image* result, | 90 const IconLoader::IconGroup& group) override; |
| 91 const IconGroupID& group) override; | |
| 92 | 91 |
| 93 private: | 92 private: |
| 94 struct CacheKey { | 93 struct CacheKey { |
| 95 CacheKey(const IconGroupID& group, IconLoader::IconSize size); | 94 CacheKey(const IconLoader::IconGroup& group, IconLoader::IconSize size); |
| 96 | 95 |
| 97 // Used as a key in the map below, so we need this comparator. | 96 // Used as a key in the map below, so we need this comparator. |
| 98 bool operator<(const CacheKey &other) const; | 97 bool operator<(const CacheKey &other) const; |
| 99 | 98 |
| 100 IconGroupID group; | 99 IconLoader::IconGroup group; |
| 101 IconLoader::IconSize size; | 100 IconLoader::IconSize size; |
| 102 }; | 101 }; |
| 103 | 102 |
| 104 gfx::Image* LookupIconFromGroup(const IconGroupID& group, | 103 std::map<CacheKey, std::unique_ptr<gfx::Image>> icon_cache_; |
| 105 IconLoader::IconSize size); | |
| 106 | |
| 107 typedef std::map<CacheKey, gfx::Image*> IconMap; | |
| 108 IconMap icon_cache_; | |
| 109 | |
| 110 typedef std::map<base::FilePath, IconGroupID> GroupMap; | |
| 111 GroupMap group_cache_; | |
| 112 | 104 |
| 113 // Asynchronous requests that have not yet been completed. | 105 // Asynchronous requests that have not yet been completed. |
| 114 struct ClientRequest; | 106 struct ClientRequest; |
| 115 typedef std::map<IconLoader*, ClientRequest> ClientRequests; | 107 std::map<IconLoader*, ClientRequest> requests_; |
| 116 ClientRequests requests_; | |
| 117 | 108 |
| 118 DISALLOW_COPY_AND_ASSIGN(IconManager); | 109 DISALLOW_COPY_AND_ASSIGN(IconManager); |
| 119 }; | 110 }; |
| 120 | 111 |
| 121 #endif // CHROME_BROWSER_ICON_MANAGER_H_ | 112 #endif // CHROME_BROWSER_ICON_MANAGER_H_ |
| OLD | NEW |